]> git.sur5r.net Git - openldap/blob - contrib/slapd-modules/passwd/sha2/sha2.h
ITS#8294 avoid symbol clash with other crypto libs
[openldap] / contrib / slapd-modules / passwd / sha2 / sha2.h
1 /* $OpenLDAP$ */
2 /*
3  * FILE:        sha2.h
4  * AUTHOR:      Aaron D. Gifford - http://www.aarongifford.com/
5  * 
6  * Copyright (c) 2000-2001, Aaron D. Gifford
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the copyright holder nor the names of contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTOR(S) ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTOR(S) BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $Id: sha2.h,v 1.1 2001/11/08 00:02:01 adg Exp adg $
34  */
35
36 #ifndef __SHA2_H__
37 #define __SHA2_H__
38
39 #include "portable.h"
40
41 #ifdef HAVE_INTTYPES_H
42 #  define SHA2_USE_INTTYPES_H 1
43 #endif
44
45 #ifndef LITTLE_ENDIAN
46 #  define LITTLE_ENDIAN 1234
47 #endif
48 #ifndef BIG_ENDIAN
49 #  define BIG_ENDIAN    4321
50 #endif
51 #ifndef BYTE_ORDER
52 #  ifdef WORDS_BIGENDIAN
53 #    define BYTE_ORDER BIG_ENDIAN
54 #  else
55 #    define BYTE_ORDER LITTLE_ENDIAN
56 #  endif
57 #endif
58
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62
63 /*
64  * Import u_intXX_t size_t type definitions from system headers.  You
65  * may need to change this, or define these things yourself in this
66  * file.
67  */
68 #include <sys/types.h>
69
70 #ifdef SHA2_USE_INTTYPES_H
71
72 #include <inttypes.h>
73
74 #endif /* SHA2_USE_INTTYPES_H */
75
76
77 /*** SHA-256/384/512 Various Length Definitions ***********************/
78 #define SHA256_BLOCK_LENGTH             64
79 #define SHA256_DIGEST_LENGTH            32
80 #define SHA256_DIGEST_STRING_LENGTH     (SHA256_DIGEST_LENGTH * 2 + 1)
81 #define SHA384_BLOCK_LENGTH             128
82 #define SHA384_DIGEST_LENGTH            48
83 #define SHA384_DIGEST_STRING_LENGTH     (SHA384_DIGEST_LENGTH * 2 + 1)
84 #define SHA512_BLOCK_LENGTH             128
85 #define SHA512_DIGEST_LENGTH            64
86 #define SHA512_DIGEST_STRING_LENGTH     (SHA512_DIGEST_LENGTH * 2 + 1)
87
88
89 /*** SHA-256/384/512 Context Structures *******************************/
90 /* NOTE: If your architecture does not define either u_intXX_t types or
91  * uintXX_t (from inttypes.h), you may need to define things by hand
92  * for your system:
93  */
94 #if 0
95 typedef unsigned char u_int8_t;         /* 1-byte  (8-bits)  */
96 typedef unsigned int u_int32_t;         /* 4-bytes (32-bits) */
97 typedef unsigned long long u_int64_t;   /* 8-bytes (64-bits) */
98 #endif
99 /*
100  * Most BSD systems already define u_intXX_t types, as does Linux.
101  * Some systems, however, like Compaq's Tru64 Unix instead can use
102  * uintXX_t types defined by very recent ANSI C standards and included
103  * in the file:
104  *
105  *   #include <inttypes.h>
106  *
107  * If you choose to use <inttypes.h> then please define: 
108  *
109  *   #define SHA2_USE_INTTYPES_H
110  *
111  * Or on the command line during compile:
112  *
113  *   cc -DSHA2_USE_INTTYPES_H ...
114  */
115 #ifdef SHA2_USE_INTTYPES_H
116
117 typedef struct _SHA256_CTX {
118         uint32_t        state[8];
119         uint64_t        bitcount;
120         uint8_t buffer[SHA256_BLOCK_LENGTH];
121 } SHA256_CTX;
122 typedef struct _SHA512_CTX {
123         uint64_t        state[8];
124         uint64_t        bitcount[2];
125         uint8_t buffer[SHA512_BLOCK_LENGTH];
126 } SHA512_CTX;
127
128 #else /* SHA2_USE_INTTYPES_H */
129
130 typedef struct _SHA256_CTX {
131         u_int32_t       state[8];
132         u_int64_t       bitcount;
133         u_int8_t        buffer[SHA256_BLOCK_LENGTH];
134 } SHA256_CTX;
135 typedef struct _SHA512_CTX {
136         u_int64_t       state[8];
137         u_int64_t       bitcount[2];
138         u_int8_t        buffer[SHA512_BLOCK_LENGTH];
139 } SHA512_CTX;
140
141 #endif /* SHA2_USE_INTTYPES_H */
142
143 typedef SHA512_CTX SHA384_CTX;
144
145
146 /*** SHA-256/384/512 Function Prototypes ******************************/
147 #define SHA256_Init             pw_SHA256_Init
148 #define SHA256_Update   pw_SHA256_Update
149 #define SHA256_Final    pw_SHA256_Final
150 #define SHA256_End              pw_SHA256_End
151 #define SHA256_Data             pw_SHA256_Data
152
153 #define SHA384_Init             pw_SHA384_Init
154 #define SHA384_Update   pw_SHA384_Update
155 #define SHA384_Final    pw_SHA384_Final
156 #define SHA384_End              pw_SHA384_End
157 #define SHA384_Data             pw_SHA384_Data
158
159 #define SHA512_Init             pw_SHA512_Init
160 #define SHA512_Update   pw_SHA512_Update
161 #define SHA512_Final    pw_SHA512_Final
162 #define SHA512_End              pw_SHA512_End
163 #define SHA512_Data             pw_SHA512_Data
164
165 #ifndef NOPROTO
166 #ifdef SHA2_USE_INTTYPES_H
167
168 void SHA256_Init(SHA256_CTX *);
169 void SHA256_Update(SHA256_CTX*, const uint8_t*, size_t);
170 void SHA256_Final(uint8_t[SHA256_DIGEST_LENGTH], SHA256_CTX*);
171 char* SHA256_End(SHA256_CTX*, char[SHA256_DIGEST_STRING_LENGTH]);
172 char* SHA256_Data(const uint8_t*, size_t, char[SHA256_DIGEST_STRING_LENGTH]);
173
174 void SHA384_Init(SHA384_CTX*);
175 void SHA384_Update(SHA384_CTX*, const uint8_t*, size_t);
176 void SHA384_Final(uint8_t[SHA384_DIGEST_LENGTH], SHA384_CTX*);
177 char* SHA384_End(SHA384_CTX*, char[SHA384_DIGEST_STRING_LENGTH]);
178 char* SHA384_Data(const uint8_t*, size_t, char[SHA384_DIGEST_STRING_LENGTH]);
179
180 void SHA512_Init(SHA512_CTX*);
181 void SHA512_Update(SHA512_CTX*, const uint8_t*, size_t);
182 void SHA512_Final(uint8_t[SHA512_DIGEST_LENGTH], SHA512_CTX*);
183 char* SHA512_End(SHA512_CTX*, char[SHA512_DIGEST_STRING_LENGTH]);
184 char* SHA512_Data(const uint8_t*, size_t, char[SHA512_DIGEST_STRING_LENGTH]);
185
186 #else /* SHA2_USE_INTTYPES_H */
187
188 void SHA256_Init(SHA256_CTX *);
189 void SHA256_Update(SHA256_CTX*, const u_int8_t*, size_t);
190 void SHA256_Final(u_int8_t[SHA256_DIGEST_LENGTH], SHA256_CTX*);
191 char* SHA256_End(SHA256_CTX*, char[SHA256_DIGEST_STRING_LENGTH]);
192 char* SHA256_Data(const u_int8_t*, size_t, char[SHA256_DIGEST_STRING_LENGTH]);
193
194 void SHA384_Init(SHA384_CTX*);
195 void SHA384_Update(SHA384_CTX*, const u_int8_t*, size_t);
196 void SHA384_Final(u_int8_t[SHA384_DIGEST_LENGTH], SHA384_CTX*);
197 char* SHA384_End(SHA384_CTX*, char[SHA384_DIGEST_STRING_LENGTH]);
198 char* SHA384_Data(const u_int8_t*, size_t, char[SHA384_DIGEST_STRING_LENGTH]);
199
200 void SHA512_Init(SHA512_CTX*);
201 void SHA512_Update(SHA512_CTX*, const u_int8_t*, size_t);
202 void SHA512_Final(u_int8_t[SHA512_DIGEST_LENGTH], SHA512_CTX*);
203 char* SHA512_End(SHA512_CTX*, char[SHA512_DIGEST_STRING_LENGTH]);
204 char* SHA512_Data(const u_int8_t*, size_t, char[SHA512_DIGEST_STRING_LENGTH]);
205
206 #endif /* SHA2_USE_INTTYPES_H */
207
208 #else /* NOPROTO */
209
210 void SHA256_Init();
211 void SHA256_Update();
212 void SHA256_Final();
213 char* SHA256_End();
214 char* SHA256_Data();
215
216 void SHA384_Init();
217 void SHA384_Update();
218 void SHA384_Final();
219 char* SHA384_End();
220 char* SHA384_Data();
221
222 void SHA512_Init();
223 void SHA512_Update();
224 void SHA512_Final();
225 char* SHA512_End();
226 char* SHA512_Data();
227
228 #endif /* NOPROTO */
229
230 #ifdef  __cplusplus
231 }
232 #endif /* __cplusplus */
233
234 #endif /* __SHA2_H__ */
235