]>
Commit | Line | Data |
---|---|---|
aa6bb135 | 1 | /* |
fecb3aae | 2 | * Copyright 1999-2022 The OpenSSL Project Authors. All Rights Reserved. |
bd3576d2 | 3 | * |
48f4ad77 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
aa6bb135 RS |
5 | * this file except in compliance with the License. You can obtain a copy |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
bd3576d2 UM |
8 | */ |
9 | ||
1d97c843 | 10 | /*- |
bd3576d2 UM |
11 | * This is a generic 32 bit "collector" for message digest algorithms. |
12 | * Whenever needed it collects input character stream into chunks of | |
13 | * 32 bit values and invokes a block function that performs actual hash | |
14 | * calculations. | |
15 | * | |
16 | * Porting guide. | |
17 | * | |
18 | * Obligatory macros: | |
19 | * | |
20 | * DATA_ORDER_IS_BIG_ENDIAN or DATA_ORDER_IS_LITTLE_ENDIAN | |
0f113f3e | 21 | * this macro defines byte order of input stream. |
bd3576d2 | 22 | * HASH_CBLOCK |
0f113f3e | 23 | * size of a unit chunk HASH_BLOCK operates on. |
bd3576d2 | 24 | * HASH_LONG |
19f05ebc | 25 | * has to be at least 32 bit wide. |
bd3576d2 | 26 | * HASH_CTX |
0f113f3e MC |
27 | * context structure that at least contains following |
28 | * members: | |
29 | * typedef struct { | |
30 | * ... | |
31 | * HASH_LONG Nl,Nh; | |
32 | * either { | |
33 | * HASH_LONG data[HASH_LBLOCK]; | |
34 | * unsigned char data[HASH_CBLOCK]; | |
35 | * }; | |
36 | * unsigned int num; | |
37 | * ... | |
38 | * } HASH_CTX; | |
39 | * data[] vector is expected to be zeroed upon first call to | |
40 | * HASH_UPDATE. | |
bd3576d2 | 41 | * HASH_UPDATE |
0f113f3e | 42 | * name of "Update" function, implemented here. |
bd3576d2 | 43 | * HASH_TRANSFORM |
0f113f3e | 44 | * name of "Transform" function, implemented here. |
bd3576d2 | 45 | * HASH_FINAL |
0f113f3e | 46 | * name of "Final" function, implemented here. |
bd3576d2 | 47 | * HASH_BLOCK_DATA_ORDER |
0f113f3e MC |
48 | * name of "block" function capable of treating *unaligned* input |
49 | * message in original (data) byte order, implemented externally. | |
1cbde6e4 | 50 | * HASH_MAKE_STRING |
19f05ebc | 51 | * macro converting context variables to an ASCII hash string. |
bd3576d2 | 52 | * |
bd3576d2 UM |
53 | * MD5 example: |
54 | * | |
0f113f3e | 55 | * #define DATA_ORDER_IS_LITTLE_ENDIAN |
bd3576d2 | 56 | * |
0f113f3e | 57 | * #define HASH_LONG MD5_LONG |
0f113f3e MC |
58 | * #define HASH_CTX MD5_CTX |
59 | * #define HASH_CBLOCK MD5_CBLOCK | |
60 | * #define HASH_UPDATE MD5_Update | |
61 | * #define HASH_TRANSFORM MD5_Transform | |
62 | * #define HASH_FINAL MD5_Final | |
63 | * #define HASH_BLOCK_DATA_ORDER md5_block_data_order | |
bd3576d2 UM |
64 | */ |
65 | ||
3d27ac8d WL |
66 | #ifndef OSSL_CRYPTO_MD32_COMMON_H |
67 | # define OSSL_CRYPTO_MD32_COMMON_H | |
68 | # pragma once | |
3ce2fdab | 69 | |
3d27ac8d | 70 | # include <openssl/crypto.h> |
bd3576d2 | 71 | |
3d27ac8d WL |
72 | # if !defined(DATA_ORDER_IS_BIG_ENDIAN) && !defined(DATA_ORDER_IS_LITTLE_ENDIAN) |
73 | # error "DATA_ORDER must be defined!" | |
74 | # endif | |
bd3576d2 | 75 | |
3d27ac8d WL |
76 | # ifndef HASH_CBLOCK |
77 | # error "HASH_CBLOCK must be defined!" | |
78 | # endif | |
79 | # ifndef HASH_LONG | |
80 | # error "HASH_LONG must be defined!" | |
81 | # endif | |
82 | # ifndef HASH_CTX | |
83 | # error "HASH_CTX must be defined!" | |
84 | # endif | |
bd3576d2 | 85 | |
3d27ac8d WL |
86 | # ifndef HASH_UPDATE |
87 | # error "HASH_UPDATE must be defined!" | |
88 | # endif | |
89 | # ifndef HASH_TRANSFORM | |
90 | # error "HASH_TRANSFORM must be defined!" | |
91 | # endif | |
92 | # ifndef HASH_FINAL | |
93 | # error "HASH_FINAL must be defined!" | |
94 | # endif | |
95 | ||
96 | # ifndef HASH_BLOCK_DATA_ORDER | |
97 | # error "HASH_BLOCK_DATA_ORDER must be defined!" | |
98 | # endif | |
bd3576d2 | 99 | |
3d27ac8d | 100 | # define ROTATE(a,n) (((a)<<(n))|(((a)&0xffffffff)>>(32-(n)))) |
bd3576d2 | 101 | |
3d27ac8d | 102 | # if defined(DATA_ORDER_IS_BIG_ENDIAN) |
bd3576d2 | 103 | |
3d27ac8d | 104 | # define HOST_c2l(c,l) (l =(((unsigned long)(*((c)++)))<<24), \ |
0f113f3e MC |
105 | l|=(((unsigned long)(*((c)++)))<<16), \ |
106 | l|=(((unsigned long)(*((c)++)))<< 8), \ | |
107 | l|=(((unsigned long)(*((c)++))) ) ) | |
3d27ac8d | 108 | # define HOST_l2c(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \ |
0f113f3e MC |
109 | *((c)++)=(unsigned char)(((l)>>16)&0xff), \ |
110 | *((c)++)=(unsigned char)(((l)>> 8)&0xff), \ | |
111 | *((c)++)=(unsigned char)(((l) )&0xff), \ | |
112 | l) | |
bd3576d2 | 113 | |
3d27ac8d | 114 | # elif defined(DATA_ORDER_IS_LITTLE_ENDIAN) |
bd3576d2 | 115 | |
3d27ac8d | 116 | # define HOST_c2l(c,l) (l =(((unsigned long)(*((c)++))) ), \ |
0f113f3e MC |
117 | l|=(((unsigned long)(*((c)++)))<< 8), \ |
118 | l|=(((unsigned long)(*((c)++)))<<16), \ | |
119 | l|=(((unsigned long)(*((c)++)))<<24) ) | |
3d27ac8d | 120 | # define HOST_l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \ |
0f113f3e MC |
121 | *((c)++)=(unsigned char)(((l)>> 8)&0xff), \ |
122 | *((c)++)=(unsigned char)(((l)>>16)&0xff), \ | |
123 | *((c)++)=(unsigned char)(((l)>>24)&0xff), \ | |
124 | l) | |
bd3576d2 | 125 | |
3d27ac8d | 126 | # endif |
bd3576d2 UM |
127 | |
128 | /* | |
19f05ebc | 129 | * Time for some action :-) |
bd3576d2 UM |
130 | */ |
131 | ||
0f113f3e MC |
132 | int HASH_UPDATE(HASH_CTX *c, const void *data_, size_t len) |
133 | { | |
134 | const unsigned char *data = data_; | |
135 | unsigned char *p; | |
136 | HASH_LONG l; | |
137 | size_t n; | |
bd3576d2 | 138 | |
0f113f3e MC |
139 | if (len == 0) |
140 | return 1; | |
bd3576d2 | 141 | |
0f113f3e | 142 | l = (c->Nl + (((HASH_LONG) len) << 3)) & 0xffffffffUL; |
0f113f3e MC |
143 | if (l < c->Nl) /* overflow */ |
144 | c->Nh++; | |
145 | c->Nh += (HASH_LONG) (len >> 29); /* might cause compiler warning on | |
146 | * 16-bit */ | |
147 | c->Nl = l; | |
148 | ||
149 | n = c->num; | |
150 | if (n != 0) { | |
151 | p = (unsigned char *)c->data; | |
152 | ||
153 | if (len >= HASH_CBLOCK || len + n >= HASH_CBLOCK) { | |
154 | memcpy(p + n, data, HASH_CBLOCK - n); | |
155 | HASH_BLOCK_DATA_ORDER(c, p, 1); | |
156 | n = HASH_CBLOCK - n; | |
157 | data += n; | |
158 | len -= n; | |
159 | c->num = 0; | |
3ce2fdab MC |
160 | /* |
161 | * We use memset rather than OPENSSL_cleanse() here deliberately. | |
162 | * Using OPENSSL_cleanse() here could be a performance issue. It | |
163 | * will get properly cleansed on finalisation so this isn't a | |
164 | * security problem. | |
165 | */ | |
0f113f3e MC |
166 | memset(p, 0, HASH_CBLOCK); /* keep it zeroed */ |
167 | } else { | |
168 | memcpy(p + n, data, len); | |
169 | c->num += (unsigned int)len; | |
170 | return 1; | |
171 | } | |
172 | } | |
173 | ||
174 | n = len / HASH_CBLOCK; | |
175 | if (n > 0) { | |
176 | HASH_BLOCK_DATA_ORDER(c, data, n); | |
177 | n *= HASH_CBLOCK; | |
178 | data += n; | |
179 | len -= n; | |
180 | } | |
181 | ||
182 | if (len != 0) { | |
183 | p = (unsigned char *)c->data; | |
184 | c->num = (unsigned int)len; | |
185 | memcpy(p, data, len); | |
186 | } | |
187 | return 1; | |
188 | } | |
189 | ||
190 | void HASH_TRANSFORM(HASH_CTX *c, const unsigned char *data) | |
191 | { | |
192 | HASH_BLOCK_DATA_ORDER(c, data, 1); | |
193 | } | |
194 | ||
195 | int HASH_FINAL(unsigned char *md, HASH_CTX *c) | |
196 | { | |
197 | unsigned char *p = (unsigned char *)c->data; | |
198 | size_t n = c->num; | |
199 | ||
200 | p[n] = 0x80; /* there is always room for one */ | |
201 | n++; | |
202 | ||
203 | if (n > (HASH_CBLOCK - 8)) { | |
204 | memset(p + n, 0, HASH_CBLOCK - n); | |
205 | n = 0; | |
206 | HASH_BLOCK_DATA_ORDER(c, p, 1); | |
207 | } | |
208 | memset(p + n, 0, HASH_CBLOCK - 8 - n); | |
209 | ||
210 | p += HASH_CBLOCK - 8; | |
3d27ac8d | 211 | # if defined(DATA_ORDER_IS_BIG_ENDIAN) |
0f113f3e MC |
212 | (void)HOST_l2c(c->Nh, p); |
213 | (void)HOST_l2c(c->Nl, p); | |
3d27ac8d | 214 | # elif defined(DATA_ORDER_IS_LITTLE_ENDIAN) |
0f113f3e MC |
215 | (void)HOST_l2c(c->Nl, p); |
216 | (void)HOST_l2c(c->Nh, p); | |
3d27ac8d | 217 | # endif |
0f113f3e MC |
218 | p -= HASH_CBLOCK; |
219 | HASH_BLOCK_DATA_ORDER(c, p, 1); | |
220 | c->num = 0; | |
3ce2fdab | 221 | OPENSSL_cleanse(p, HASH_CBLOCK); |
bd3576d2 | 222 | |
3d27ac8d WL |
223 | # ifndef HASH_MAKE_STRING |
224 | # error "HASH_MAKE_STRING must be defined!" | |
225 | # else | |
0f113f3e | 226 | HASH_MAKE_STRING(c, md); |
3d27ac8d | 227 | # endif |
bd3576d2 | 228 | |
0f113f3e MC |
229 | return 1; |
230 | } | |
2f98abbc | 231 | |
3d27ac8d WL |
232 | # ifndef MD32_REG_T |
233 | # if defined(__alpha) || defined(__sparcv9) || defined(__mips) | |
234 | # define MD32_REG_T long | |
2f98abbc | 235 | /* |
8483a003 | 236 | * This comment was originally written for MD5, which is why it |
2f98abbc AP |
237 | * discusses A-D. But it basically applies to all 32-bit digests, |
238 | * which is why it was moved to common header file. | |
239 | * | |
240 | * In case you wonder why A-D are declared as long and not | |
241 | * as MD5_LONG. Doing so results in slight performance | |
242 | * boost on LP64 architectures. The catch is we don't | |
243 | * really care if 32 MSBs of a 64-bit register get polluted | |
244 | * with eventual overflows as we *save* only 32 LSBs in | |
245 | * *either* case. Now declaring 'em long excuses the compiler | |
246 | * from keeping 32 MSBs zeroed resulting in 13% performance | |
247 | * improvement under SPARC Solaris7/64 and 5% under AlphaLinux. | |
0f113f3e | 248 | * Well, to be honest it should say that this *prevents* |
2f98abbc | 249 | * performance degradation. |
30ab7af2 | 250 | */ |
3d27ac8d | 251 | # else |
30ab7af2 AP |
252 | /* |
253 | * Above is not absolute and there are LP64 compilers that | |
254 | * generate better code if MD32_REG_T is defined int. The above | |
255 | * pre-processor condition reflects the circumstances under which | |
256 | * the conclusion was made and is subject to further extension. | |
2f98abbc | 257 | */ |
3d27ac8d WL |
258 | # define MD32_REG_T int |
259 | # endif | |
0f113f3e | 260 | # endif |
3d27ac8d | 261 | |
2f98abbc | 262 | #endif |