1 /* ====================================================================
2 * Copyright (c) 1999-2007 The OpenSSL Project. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. All advertising materials mentioning features or use of this
17 * software must display the following acknowledgment:
18 * "This product includes software developed by the OpenSSL Project
19 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20 *
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 * endorse or promote products derived from this software without
23 * prior written permission. For written permission, please contact
24 * licensing@OpenSSL.org.
25 *
26 * 5. Products derived from this software may not be called "OpenSSL"
27 * nor may "OpenSSL" appear in their names without prior written
28 * permission of the OpenSSL Project.
29 *
30 * 6. Redistributions of any form whatsoever must retain the following
31 * acknowledgment:
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34 *
35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46 * OF THE POSSIBILITY OF SUCH DAMAGE.
47 * ==================================================================== */
48
49 #ifndef OPENSSL_HEADER_MD32_COMMON_H
50 #define OPENSSL_HEADER_MD32_COMMON_H
51
52 #include <openssl/base.h>
53
54 #include <assert.h>
55
56 #include "../internal.h"
57
58 #if defined(__cplusplus)
59 extern "C" {
60 #endif
61
62
63 /* This is a generic 32-bit "collector" for message digest algorithms. It
64 * collects input character stream into chunks of 32-bit values and invokes the
65 * block function that performs the actual hash calculations. To make use of
66 * this mechanism, the following macros must be defined before including
67 * md32_common.h.
68 *
69 * One of |DATA_ORDER_IS_BIG_ENDIAN| or |DATA_ORDER_IS_LITTLE_ENDIAN| must be
70 * defined to specify the byte order of the input stream.
71 *
72 * |HASH_CBLOCK| must be defined as the integer block size, in bytes.
73 *
74 * |HASH_CTX| must be defined as the name of the context structure, which must
75 * have at least the following members:
76 *
77 * typedef struct <name>_state_st {
78 * uint32_t h[<chaining length> / sizeof(uint32_t)];
79 * uint32_t Nl, Nh;
80 * uint8_t data[HASH_CBLOCK];
81 * unsigned num;
82 * ...
83 * } <NAME>_CTX;
84 *
85 * <chaining length> is the output length of the hash in bytes, before
86 * any truncation (e.g. 64 for SHA-224 and SHA-256, 128 for SHA-384 and
87 * SHA-512).
88 *
89 * |HASH_UPDATE| must be defined as the name of the "Update" function to
90 * generate.
91 *
92 * |HASH_TRANSFORM| must be defined as the the name of the "Transform"
93 * function to generate.
94 *
95 * |HASH_FINAL| must be defined as the name of "Final" function to generate.
96 *
97 * |HASH_BLOCK_DATA_ORDER| must be defined as the name of the "Block" function.
98 * That function must be implemented manually. It must be capable of operating
99 * on *unaligned* input data in its original (data) byte order. It must have
100 * this signature:
101 *
102 * void HASH_BLOCK_DATA_ORDER(uint32_t *state, const uint8_t *data,
103 * size_t num);
104 *
105 * It must update the hash state |state| with |num| blocks of data from |data|,
106 * where each block is |HASH_CBLOCK| bytes; i.e. |data| points to a array of
107 * |HASH_CBLOCK * num| bytes. |state| points to the |h| member of a |HASH_CTX|,
108 * and so will have |<chaining length> / sizeof(uint32_t)| elements.
109 *
110 * |HASH_MAKE_STRING(c, s)| must be defined as a block statement that converts
111 * the hash state |c->h| into the output byte order, storing the result in |s|.
112 */
113
114 #if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN)
115 #error "DATA_ORDER must be defined!"
116 #endif
117
118 #ifndef HASH_CBLOCK
119 #error "HASH_CBLOCK must be defined!"
120 #endif
121 #ifndef HASH_CTX
122 #error "HASH_CTX must be defined!"
123 #endif
124
125 #ifndef HASH_UPDATE
126 #error "HASH_UPDATE must be defined!"
127 #endif
128 #ifndef HASH_TRANSFORM
129 #error "HASH_TRANSFORM must be defined!"
130 #endif
131 #ifndef HASH_FINAL
132 #error "HASH_FINAL must be defined!"
133 #endif
134
135 #ifndef HASH_BLOCK_DATA_ORDER
136 #error "HASH_BLOCK_DATA_ORDER must be defined!"
137 #endif
138
139 #ifndef HASH_MAKE_STRING
140 #error "HASH_MAKE_STRING must be defined!"
141 #endif
142
143 #if defined(DATA_ORDER_IS_BIG_ENDIAN)
144
145 #define HOST_c2l(c, l) \
146 do { \
147 (l) = (((uint32_t)(*((c)++))) << 24); \
148 (l) |= (((uint32_t)(*((c)++))) << 16); \
149 (l) |= (((uint32_t)(*((c)++))) << 8); \
150 (l) |= (((uint32_t)(*((c)++)))); \
151 } while (0)
152
153 #define HOST_l2c(l, c) \
154 do { \
155 *((c)++) = (uint8_t)(((l) >> 24) & 0xff); \
156 *((c)++) = (uint8_t)(((l) >> 16) & 0xff); \
157 *((c)++) = (uint8_t)(((l) >> 8) & 0xff); \
158 *((c)++) = (uint8_t)(((l)) & 0xff); \
159 } while (0)
160
161 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
162
163 #define HOST_c2l(c, l) \
164 do { \
165 (l) = (((uint32_t)(*((c)++)))); \
166 (l) |= (((uint32_t)(*((c)++))) << 8); \
167 (l) |= (((uint32_t)(*((c)++))) << 16); \
168 (l) |= (((uint32_t)(*((c)++))) << 24); \
169 } while (0)
170
171 #define HOST_l2c(l, c) \
172 do { \
173 *((c)++) = (uint8_t)(((l)) & 0xff); \
174 *((c)++) = (uint8_t)(((l) >> 8) & 0xff); \
175 *((c)++) = (uint8_t)(((l) >> 16) & 0xff); \
176 *((c)++) = (uint8_t)(((l) >> 24) & 0xff); \
177 } while (0)
178
179 #endif /* DATA_ORDER */
180
HASH_UPDATE(HASH_CTX * c,const void * data_,size_t len)181 int HASH_UPDATE(HASH_CTX *c, const void *data_, size_t len) {
182 const uint8_t *data = data_;
183
184 if (len == 0) {
185 return 1;
186 }
187
188 uint32_t l = c->Nl + (((uint32_t)len) << 3);
189 if (l < c->Nl) {
190 /* Handle carries. */
191 c->Nh++;
192 }
193 c->Nh += (uint32_t)(len >> 29);
194 c->Nl = l;
195
196 size_t n = c->num;
197 if (n != 0) {
198 if (len >= HASH_CBLOCK || len + n >= HASH_CBLOCK) {
199 OPENSSL_memcpy(c->data + n, data, HASH_CBLOCK - n);
200 HASH_BLOCK_DATA_ORDER(c->h, c->data, 1);
201 n = HASH_CBLOCK - n;
202 data += n;
203 len -= n;
204 c->num = 0;
205 /* Keep |c->data| zeroed when unused. */
206 OPENSSL_memset(c->data, 0, HASH_CBLOCK);
207 } else {
208 OPENSSL_memcpy(c->data + n, data, len);
209 c->num += (unsigned)len;
210 return 1;
211 }
212 }
213
214 n = len / HASH_CBLOCK;
215 if (n > 0) {
216 HASH_BLOCK_DATA_ORDER(c->h, data, n);
217 n *= HASH_CBLOCK;
218 data += n;
219 len -= n;
220 }
221
222 if (len != 0) {
223 c->num = (unsigned)len;
224 OPENSSL_memcpy(c->data, data, len);
225 }
226 return 1;
227 }
228
229
HASH_TRANSFORM(HASH_CTX * c,const uint8_t * data)230 void HASH_TRANSFORM(HASH_CTX *c, const uint8_t *data) {
231 HASH_BLOCK_DATA_ORDER(c->h, data, 1);
232 }
233
234
HASH_FINAL(uint8_t * md,HASH_CTX * c)235 int HASH_FINAL(uint8_t *md, HASH_CTX *c) {
236 /* |c->data| always has room for at least one byte. A full block would have
237 * been consumed. */
238 size_t n = c->num;
239 assert(n < HASH_CBLOCK);
240 c->data[n] = 0x80;
241 n++;
242
243 /* Fill the block with zeros if there isn't room for a 64-bit length. */
244 if (n > (HASH_CBLOCK - 8)) {
245 OPENSSL_memset(c->data + n, 0, HASH_CBLOCK - n);
246 n = 0;
247 HASH_BLOCK_DATA_ORDER(c->h, c->data, 1);
248 }
249 OPENSSL_memset(c->data + n, 0, HASH_CBLOCK - 8 - n);
250
251 /* Append a 64-bit length to the block and process it. */
252 uint8_t *p = c->data + HASH_CBLOCK - 8;
253 #if defined(DATA_ORDER_IS_BIG_ENDIAN)
254 HOST_l2c(c->Nh, p);
255 HOST_l2c(c->Nl, p);
256 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
257 HOST_l2c(c->Nl, p);
258 HOST_l2c(c->Nh, p);
259 #endif
260 assert(p == c->data + HASH_CBLOCK);
261 HASH_BLOCK_DATA_ORDER(c->h, c->data, 1);
262 c->num = 0;
263 OPENSSL_memset(c->data, 0, HASH_CBLOCK);
264
265 HASH_MAKE_STRING(c, md);
266 return 1;
267 }
268
269
270 #if defined(__cplusplus)
271 } /* extern C */
272 #endif
273
274 #endif /* OPENSSL_HEADER_MD32_COMMON_H */
275