Debian Codegraph @

external/boringssl/crypto/digest/md32_common.h

raw
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 * [email protected].
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 #if defined(__cplusplus)
57 extern "C" {
58 #endif
59
60
61 /* This is a generic 32-bit "collector" for message digest algorithms. It
62 * collects input character stream into chunks of 32-bit values and invokes the
63 * block function that performs the actual hash calculations. To make use of
64 * this mechanism, the following macros must be defined before including
65 * md32_common.h.
66 *
67 * One of |DATA_ORDER_IS_BIG_ENDIAN| or |DATA_ORDER_IS_LITTLE_ENDIAN| must be
68 * defined to specify the byte order of the input stream.
69 *
70 * |HASH_CBLOCK| must be defined as the integer block size, in bytes.
71 *
72 * |HASH_CTX| must be defined as the name of the context structure, which must
73 * have at least the following members:
74 *
75 * typedef struct <name>_state_st {
76 * uint32_t h[<chaining length> / sizeof(uint32_t)];
77 * uint32_t Nl, Nh;
78 * uint8_t data[HASH_CBLOCK];
79 * unsigned num;
80 * ...
81 * } <NAME>_CTX;
82 *
83 * <chaining length> is the output length of the hash in bytes, before
84 * any truncation (e.g. 64 for SHA-224 and SHA-256, 128 for SHA-384 and
85 * SHA-512).
86 *
87 * |HASH_UPDATE| must be defined as the name of the "Update" function to
88 * generate.
89 *
90 * |HASH_TRANSFORM| must be defined as the the name of the "Transform"
91 * function to generate.
92 *
93 * |HASH_FINAL| must be defined as the name of "Final" function to generate.
94 *
95 * |HASH_BLOCK_DATA_ORDER| must be defined as the name of the "Block" function.
96 * That function must be implemented manually. It must be capable of operating
97 * on *unaligned* input data in its original (data) byte order. It must have
98 * this signature:
99 *
100 * void HASH_BLOCK_DATA_ORDER(uint32_t *state, const uint8_t *data,
101 * size_t num);
102 *
103 * It must update the hash state |state| with |num| blocks of data from |data|,
104 * where each block is |HASH_CBLOCK| bytes; i.e. |data| points to a array of
105 * |HASH_CBLOCK * num| bytes. |state| points to the |h| member of a |HASH_CTX|,
106 * and so will have |<chaining length> / sizeof(uint32_t)| elements.
107 *
108 * |HASH_MAKE_STRING(c, s)| must be defined as a block statement that converts
109 * the hash state |c->h| into the output byte order, storing the result in |s|.
110 */
111
112 #if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN)
113 #error "DATA_ORDER must be defined!"
114 #endif
115
116 #ifndef HASH_CBLOCK
117 #error "HASH_CBLOCK must be defined!"
118 #endif
119 #ifndef HASH_CTX
120 #error "HASH_CTX must be defined!"
121 #endif
122
123 #ifndef HASH_UPDATE
124 #error "HASH_UPDATE must be defined!"
125 #endif
126 #ifndef HASH_TRANSFORM
127 #error "HASH_TRANSFORM must be defined!"
128 #endif
129 #ifndef HASH_FINAL
130 #error "HASH_FINAL must be defined!"
131 #endif
132
133 #ifndef HASH_BLOCK_DATA_ORDER
134 #error "HASH_BLOCK_DATA_ORDER must be defined!"
135 #endif
136
137 #ifndef HASH_MAKE_STRING
138 #error "HASH_MAKE_STRING must be defined!"
139 #endif
140
141 #if defined(DATA_ORDER_IS_BIG_ENDIAN)
142
143 #define HOST_c2l(c, l) \
144 (void)(l = (((uint32_t)(*((c)++))) << 24), \
145 l |= (((uint32_t)(*((c)++))) << 16), \
146 l |= (((uint32_t)(*((c)++))) << 8), l |= (((uint32_t)(*((c)++)))))
147
148 #define HOST_l2c(l, c) \
149 (void)(*((c)++) = (uint8_t)(((l) >> 24) & 0xff), \
150 *((c)++) = (uint8_t)(((l) >> 16) & 0xff), \
151 *((c)++) = (uint8_t)(((l) >> 8) & 0xff), \
152 *((c)++) = (uint8_t)(((l)) & 0xff))
153
154 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
155
156 #define HOST_c2l(c, l) \
157 (void)(l = (((uint32_t)(*((c)++)))), l |= (((uint32_t)(*((c)++))) << 8), \
158 l |= (((uint32_t)(*((c)++))) << 16), \
159 l |= (((uint32_t)(*((c)++))) << 24))
160
161 #define HOST_l2c(l, c) \
162 (void)(*((c)++) = (uint8_t)(((l)) & 0xff), \
163 *((c)++) = (uint8_t)(((l) >> 8) & 0xff), \
164 *((c)++) = (uint8_t)(((l) >> 16) & 0xff), \
165 *((c)++) = (uint8_t)(((l) >> 24) & 0xff))
166
167 #endif /* DATA_ORDER */
168
169 int HASH_UPDATE(HASH_CTX *c, const void *data_, size_t len) {
170 const uint8_t *data = data_;
171
172 if (len == 0) {
173 return 1;
174 }
175
176 uint32_t l = c->Nl + (((uint32_t)len) << 3);
177 if (l < c->Nl) {
178 /* Handle carries. */
179 c->Nh++;
180 }
181 c->Nh += (uint32_t)(len >> 29);
182 c->Nl = l;
183
184 size_t n = c->num;
185 if (n != 0) {
186 if (len >= HASH_CBLOCK || len + n >= HASH_CBLOCK) {
187 memcpy(c->data + n, data, HASH_CBLOCK - n);
188 HASH_BLOCK_DATA_ORDER(c->h, c->data, 1);
189 n = HASH_CBLOCK - n;
190 data += n;
191 len -= n;
192 c->num = 0;
193 /* Keep |c->data| zeroed when unused. */
194 memset(c->data, 0, HASH_CBLOCK);
195 } else {
196 memcpy(c->data + n, data, len);
197 c->num += (unsigned)len;
198 return 1;
199 }
200 }
201
202 n = len / HASH_CBLOCK;
203 if (n > 0) {
204 HASH_BLOCK_DATA_ORDER(c->h, data, n);
205 n *= HASH_CBLOCK;
206 data += n;
207 len -= n;
208 }
209
210 if (len != 0) {
211 c->num = (unsigned)len;
212 memcpy(c->data, data, len);
213 }
214 return 1;
215 }
216
217
218 void HASH_TRANSFORM(HASH_CTX *c, const uint8_t *data) {
219 HASH_BLOCK_DATA_ORDER(c->h, data, 1);
220 }
221
222
223 int HASH_FINAL(uint8_t *md, HASH_CTX *c) {
224 /* |c->data| always has room for at least one byte. A full block would have
225 * been consumed. */
226 size_t n = c->num;
227 assert(n < HASH_CBLOCK);
228 c->data[n] = 0x80;
229 n++;
230
231 /* Fill the block with zeros if there isn't room for a 64-bit length. */
232 if (n > (HASH_CBLOCK - 8)) {
233 memset(c->data + n, 0, HASH_CBLOCK - n);
234 n = 0;
235 HASH_BLOCK_DATA_ORDER(c->h, c->data, 1);
236 }
237 memset(c->data + n, 0, HASH_CBLOCK - 8 - n);
238
239 /* Append a 64-bit length to the block and process it. */
240 uint8_t *p = c->data + HASH_CBLOCK - 8;
241 #if defined(DATA_ORDER_IS_BIG_ENDIAN)
242 HOST_l2c(c->Nh, p);
243 HOST_l2c(c->Nl, p);
244 #elif defined(DATA_ORDER_IS_LITTLE_ENDIAN)
245 HOST_l2c(c->Nl, p);
246 HOST_l2c(c->Nh, p);
247 #endif
248 assert(p == c->data + HASH_CBLOCK);
249 HASH_BLOCK_DATA_ORDER(c->h, c->data, 1);
250 c->num = 0;
251 memset(c->data, 0, HASH_CBLOCK);
252
253 HASH_MAKE_STRING(c, md);
254 return 1;
255 }
256
257
258 #if defined(__cplusplus)
259 } /* extern C */
260 #endif
261
262 #endif /* OPENSSL_HEADER_MD32_COMMON_H */