1 /*
2 * FIPS-180-1 compliant SHA-1 implementation
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 /*
20 * The SHA-1 standard was published by NIST in 1993.
21 *
22 * http://www.itl.nist.gov/fipspubs/fip180-1.htm
23 */
24
25 #include "common.h"
26
27 #if defined(MBEDTLS_SHA1_C)
28
29 #include "mbedtls/sha1.h"
30 #include "mbedtls/platform_util.h"
31 #include "mbedtls/error.h"
32
33 #include <string.h>
34
35 #include "mbedtls/platform.h"
36
37 #if !defined(MBEDTLS_SHA1_ALT)
38
mbedtls_sha1_init(mbedtls_sha1_context * ctx)39 void mbedtls_sha1_init( mbedtls_sha1_context *ctx )
40 {
41 memset( ctx, 0, sizeof( mbedtls_sha1_context ) );
42 }
43
mbedtls_sha1_free(mbedtls_sha1_context * ctx)44 void mbedtls_sha1_free( mbedtls_sha1_context *ctx )
45 {
46 if( ctx == NULL )
47 return;
48
49 mbedtls_platform_zeroize( ctx, sizeof( mbedtls_sha1_context ) );
50 }
51
mbedtls_sha1_clone(mbedtls_sha1_context * dst,const mbedtls_sha1_context * src)52 void mbedtls_sha1_clone( mbedtls_sha1_context *dst,
53 const mbedtls_sha1_context *src )
54 {
55 *dst = *src;
56 }
57
58 /*
59 * SHA-1 context setup
60 */
mbedtls_sha1_starts(mbedtls_sha1_context * ctx)61 int mbedtls_sha1_starts( mbedtls_sha1_context *ctx )
62 {
63 ctx->total[0] = 0;
64 ctx->total[1] = 0;
65
66 ctx->state[0] = 0x67452301;
67 ctx->state[1] = 0xEFCDAB89;
68 ctx->state[2] = 0x98BADCFE;
69 ctx->state[3] = 0x10325476;
70 ctx->state[4] = 0xC3D2E1F0;
71
72 return( 0 );
73 }
74
75 #if !defined(MBEDTLS_SHA1_PROCESS_ALT)
mbedtls_internal_sha1_process(mbedtls_sha1_context * ctx,const unsigned char data[64])76 int mbedtls_internal_sha1_process( mbedtls_sha1_context *ctx,
77 const unsigned char data[64] )
78 {
79 struct
80 {
81 uint32_t temp, W[16], A, B, C, D, E;
82 } local;
83
84 local.W[ 0] = MBEDTLS_GET_UINT32_BE( data, 0 );
85 local.W[ 1] = MBEDTLS_GET_UINT32_BE( data, 4 );
86 local.W[ 2] = MBEDTLS_GET_UINT32_BE( data, 8 );
87 local.W[ 3] = MBEDTLS_GET_UINT32_BE( data, 12 );
88 local.W[ 4] = MBEDTLS_GET_UINT32_BE( data, 16 );
89 local.W[ 5] = MBEDTLS_GET_UINT32_BE( data, 20 );
90 local.W[ 6] = MBEDTLS_GET_UINT32_BE( data, 24 );
91 local.W[ 7] = MBEDTLS_GET_UINT32_BE( data, 28 );
92 local.W[ 8] = MBEDTLS_GET_UINT32_BE( data, 32 );
93 local.W[ 9] = MBEDTLS_GET_UINT32_BE( data, 36 );
94 local.W[10] = MBEDTLS_GET_UINT32_BE( data, 40 );
95 local.W[11] = MBEDTLS_GET_UINT32_BE( data, 44 );
96 local.W[12] = MBEDTLS_GET_UINT32_BE( data, 48 );
97 local.W[13] = MBEDTLS_GET_UINT32_BE( data, 52 );
98 local.W[14] = MBEDTLS_GET_UINT32_BE( data, 56 );
99 local.W[15] = MBEDTLS_GET_UINT32_BE( data, 60 );
100
101 #define S(x,n) (((x) << (n)) | (((x) & 0xFFFFFFFF) >> (32 - (n))))
102
103 #define R(t) \
104 ( \
105 local.temp = local.W[( (t) - 3 ) & 0x0F] ^ \
106 local.W[( (t) - 8 ) & 0x0F] ^ \
107 local.W[( (t) - 14 ) & 0x0F] ^ \
108 local.W[ (t) & 0x0F], \
109 ( local.W[(t) & 0x0F] = S(local.temp,1) ) \
110 )
111
112 #define P(a,b,c,d,e,x) \
113 do \
114 { \
115 (e) += S((a),5) + F((b),(c),(d)) + K + (x); \
116 (b) = S((b),30); \
117 } while( 0 )
118
119 local.A = ctx->state[0];
120 local.B = ctx->state[1];
121 local.C = ctx->state[2];
122 local.D = ctx->state[3];
123 local.E = ctx->state[4];
124
125 #define F(x,y,z) ((z) ^ ((x) & ((y) ^ (z))))
126 #define K 0x5A827999
127
128 P( local.A, local.B, local.C, local.D, local.E, local.W[0] );
129 P( local.E, local.A, local.B, local.C, local.D, local.W[1] );
130 P( local.D, local.E, local.A, local.B, local.C, local.W[2] );
131 P( local.C, local.D, local.E, local.A, local.B, local.W[3] );
132 P( local.B, local.C, local.D, local.E, local.A, local.W[4] );
133 P( local.A, local.B, local.C, local.D, local.E, local.W[5] );
134 P( local.E, local.A, local.B, local.C, local.D, local.W[6] );
135 P( local.D, local.E, local.A, local.B, local.C, local.W[7] );
136 P( local.C, local.D, local.E, local.A, local.B, local.W[8] );
137 P( local.B, local.C, local.D, local.E, local.A, local.W[9] );
138 P( local.A, local.B, local.C, local.D, local.E, local.W[10] );
139 P( local.E, local.A, local.B, local.C, local.D, local.W[11] );
140 P( local.D, local.E, local.A, local.B, local.C, local.W[12] );
141 P( local.C, local.D, local.E, local.A, local.B, local.W[13] );
142 P( local.B, local.C, local.D, local.E, local.A, local.W[14] );
143 P( local.A, local.B, local.C, local.D, local.E, local.W[15] );
144 P( local.E, local.A, local.B, local.C, local.D, R(16) );
145 P( local.D, local.E, local.A, local.B, local.C, R(17) );
146 P( local.C, local.D, local.E, local.A, local.B, R(18) );
147 P( local.B, local.C, local.D, local.E, local.A, R(19) );
148
149 #undef K
150 #undef F
151
152 #define F(x,y,z) ((x) ^ (y) ^ (z))
153 #define K 0x6ED9EBA1
154
155 P( local.A, local.B, local.C, local.D, local.E, R(20) );
156 P( local.E, local.A, local.B, local.C, local.D, R(21) );
157 P( local.D, local.E, local.A, local.B, local.C, R(22) );
158 P( local.C, local.D, local.E, local.A, local.B, R(23) );
159 P( local.B, local.C, local.D, local.E, local.A, R(24) );
160 P( local.A, local.B, local.C, local.D, local.E, R(25) );
161 P( local.E, local.A, local.B, local.C, local.D, R(26) );
162 P( local.D, local.E, local.A, local.B, local.C, R(27) );
163 P( local.C, local.D, local.E, local.A, local.B, R(28) );
164 P( local.B, local.C, local.D, local.E, local.A, R(29) );
165 P( local.A, local.B, local.C, local.D, local.E, R(30) );
166 P( local.E, local.A, local.B, local.C, local.D, R(31) );
167 P( local.D, local.E, local.A, local.B, local.C, R(32) );
168 P( local.C, local.D, local.E, local.A, local.B, R(33) );
169 P( local.B, local.C, local.D, local.E, local.A, R(34) );
170 P( local.A, local.B, local.C, local.D, local.E, R(35) );
171 P( local.E, local.A, local.B, local.C, local.D, R(36) );
172 P( local.D, local.E, local.A, local.B, local.C, R(37) );
173 P( local.C, local.D, local.E, local.A, local.B, R(38) );
174 P( local.B, local.C, local.D, local.E, local.A, R(39) );
175
176 #undef K
177 #undef F
178
179 #define F(x,y,z) (((x) & (y)) | ((z) & ((x) | (y))))
180 #define K 0x8F1BBCDC
181
182 P( local.A, local.B, local.C, local.D, local.E, R(40) );
183 P( local.E, local.A, local.B, local.C, local.D, R(41) );
184 P( local.D, local.E, local.A, local.B, local.C, R(42) );
185 P( local.C, local.D, local.E, local.A, local.B, R(43) );
186 P( local.B, local.C, local.D, local.E, local.A, R(44) );
187 P( local.A, local.B, local.C, local.D, local.E, R(45) );
188 P( local.E, local.A, local.B, local.C, local.D, R(46) );
189 P( local.D, local.E, local.A, local.B, local.C, R(47) );
190 P( local.C, local.D, local.E, local.A, local.B, R(48) );
191 P( local.B, local.C, local.D, local.E, local.A, R(49) );
192 P( local.A, local.B, local.C, local.D, local.E, R(50) );
193 P( local.E, local.A, local.B, local.C, local.D, R(51) );
194 P( local.D, local.E, local.A, local.B, local.C, R(52) );
195 P( local.C, local.D, local.E, local.A, local.B, R(53) );
196 P( local.B, local.C, local.D, local.E, local.A, R(54) );
197 P( local.A, local.B, local.C, local.D, local.E, R(55) );
198 P( local.E, local.A, local.B, local.C, local.D, R(56) );
199 P( local.D, local.E, local.A, local.B, local.C, R(57) );
200 P( local.C, local.D, local.E, local.A, local.B, R(58) );
201 P( local.B, local.C, local.D, local.E, local.A, R(59) );
202
203 #undef K
204 #undef F
205
206 #define F(x,y,z) ((x) ^ (y) ^ (z))
207 #define K 0xCA62C1D6
208
209 P( local.A, local.B, local.C, local.D, local.E, R(60) );
210 P( local.E, local.A, local.B, local.C, local.D, R(61) );
211 P( local.D, local.E, local.A, local.B, local.C, R(62) );
212 P( local.C, local.D, local.E, local.A, local.B, R(63) );
213 P( local.B, local.C, local.D, local.E, local.A, R(64) );
214 P( local.A, local.B, local.C, local.D, local.E, R(65) );
215 P( local.E, local.A, local.B, local.C, local.D, R(66) );
216 P( local.D, local.E, local.A, local.B, local.C, R(67) );
217 P( local.C, local.D, local.E, local.A, local.B, R(68) );
218 P( local.B, local.C, local.D, local.E, local.A, R(69) );
219 P( local.A, local.B, local.C, local.D, local.E, R(70) );
220 P( local.E, local.A, local.B, local.C, local.D, R(71) );
221 P( local.D, local.E, local.A, local.B, local.C, R(72) );
222 P( local.C, local.D, local.E, local.A, local.B, R(73) );
223 P( local.B, local.C, local.D, local.E, local.A, R(74) );
224 P( local.A, local.B, local.C, local.D, local.E, R(75) );
225 P( local.E, local.A, local.B, local.C, local.D, R(76) );
226 P( local.D, local.E, local.A, local.B, local.C, R(77) );
227 P( local.C, local.D, local.E, local.A, local.B, R(78) );
228 P( local.B, local.C, local.D, local.E, local.A, R(79) );
229
230 #undef K
231 #undef F
232
233 ctx->state[0] += local.A;
234 ctx->state[1] += local.B;
235 ctx->state[2] += local.C;
236 ctx->state[3] += local.D;
237 ctx->state[4] += local.E;
238
239 /* Zeroise buffers and variables to clear sensitive data from memory. */
240 mbedtls_platform_zeroize( &local, sizeof( local ) );
241
242 return( 0 );
243 }
244
245 #endif /* !MBEDTLS_SHA1_PROCESS_ALT */
246
247 /*
248 * SHA-1 process buffer
249 */
mbedtls_sha1_update(mbedtls_sha1_context * ctx,const unsigned char * input,size_t ilen)250 int mbedtls_sha1_update( mbedtls_sha1_context *ctx,
251 const unsigned char *input,
252 size_t ilen )
253 {
254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
255 size_t fill;
256 uint32_t left;
257
258 if( ilen == 0 )
259 return( 0 );
260
261 left = ctx->total[0] & 0x3F;
262 fill = 64 - left;
263
264 ctx->total[0] += (uint32_t) ilen;
265 ctx->total[0] &= 0xFFFFFFFF;
266
267 if( ctx->total[0] < (uint32_t) ilen )
268 ctx->total[1]++;
269
270 if( left && ilen >= fill )
271 {
272 memcpy( (void *) (ctx->buffer + left), input, fill );
273
274 if( ( ret = mbedtls_internal_sha1_process( ctx, ctx->buffer ) ) != 0 )
275 return( ret );
276
277 input += fill;
278 ilen -= fill;
279 left = 0;
280 }
281
282 while( ilen >= 64 )
283 {
284 if( ( ret = mbedtls_internal_sha1_process( ctx, input ) ) != 0 )
285 return( ret );
286
287 input += 64;
288 ilen -= 64;
289 }
290
291 if( ilen > 0 )
292 memcpy( (void *) (ctx->buffer + left), input, ilen );
293
294 return( 0 );
295 }
296
297 /*
298 * SHA-1 final digest
299 */
mbedtls_sha1_finish(mbedtls_sha1_context * ctx,unsigned char output[20])300 int mbedtls_sha1_finish( mbedtls_sha1_context *ctx,
301 unsigned char output[20] )
302 {
303 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
304 uint32_t used;
305 uint32_t high, low;
306
307 /*
308 * Add padding: 0x80 then 0x00 until 8 bytes remain for the length
309 */
310 used = ctx->total[0] & 0x3F;
311
312 ctx->buffer[used++] = 0x80;
313
314 if( used <= 56 )
315 {
316 /* Enough room for padding + length in current block */
317 memset( ctx->buffer + used, 0, 56 - used );
318 }
319 else
320 {
321 /* We'll need an extra block */
322 memset( ctx->buffer + used, 0, 64 - used );
323
324 if( ( ret = mbedtls_internal_sha1_process( ctx, ctx->buffer ) ) != 0 )
325 return( ret );
326
327 memset( ctx->buffer, 0, 56 );
328 }
329
330 /*
331 * Add message length
332 */
333 high = ( ctx->total[0] >> 29 )
334 | ( ctx->total[1] << 3 );
335 low = ( ctx->total[0] << 3 );
336
337 MBEDTLS_PUT_UINT32_BE( high, ctx->buffer, 56 );
338 MBEDTLS_PUT_UINT32_BE( low, ctx->buffer, 60 );
339
340 if( ( ret = mbedtls_internal_sha1_process( ctx, ctx->buffer ) ) != 0 )
341 return( ret );
342
343 /*
344 * Output final state
345 */
346 MBEDTLS_PUT_UINT32_BE( ctx->state[0], output, 0 );
347 MBEDTLS_PUT_UINT32_BE( ctx->state[1], output, 4 );
348 MBEDTLS_PUT_UINT32_BE( ctx->state[2], output, 8 );
349 MBEDTLS_PUT_UINT32_BE( ctx->state[3], output, 12 );
350 MBEDTLS_PUT_UINT32_BE( ctx->state[4], output, 16 );
351
352 return( 0 );
353 }
354
355 #endif /* !MBEDTLS_SHA1_ALT */
356
357 /*
358 * output = SHA-1( input buffer )
359 */
mbedtls_sha1(const unsigned char * input,size_t ilen,unsigned char output[20])360 int mbedtls_sha1( const unsigned char *input,
361 size_t ilen,
362 unsigned char output[20] )
363 {
364 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
365 mbedtls_sha1_context ctx;
366
367 mbedtls_sha1_init( &ctx );
368
369 if( ( ret = mbedtls_sha1_starts( &ctx ) ) != 0 )
370 goto exit;
371
372 if( ( ret = mbedtls_sha1_update( &ctx, input, ilen ) ) != 0 )
373 goto exit;
374
375 if( ( ret = mbedtls_sha1_finish( &ctx, output ) ) != 0 )
376 goto exit;
377
378 exit:
379 mbedtls_sha1_free( &ctx );
380
381 return( ret );
382 }
383
384 #if defined(MBEDTLS_SELF_TEST)
385 /*
386 * FIPS-180-1 test vectors
387 */
388 static const unsigned char sha1_test_buf[3][57] =
389 {
390 { "abc" },
391 { "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq" },
392 { "" }
393 };
394
395 static const size_t sha1_test_buflen[3] =
396 {
397 3, 56, 1000
398 };
399
400 static const unsigned char sha1_test_sum[3][20] =
401 {
402 { 0xA9, 0x99, 0x3E, 0x36, 0x47, 0x06, 0x81, 0x6A, 0xBA, 0x3E,
403 0x25, 0x71, 0x78, 0x50, 0xC2, 0x6C, 0x9C, 0xD0, 0xD8, 0x9D },
404 { 0x84, 0x98, 0x3E, 0x44, 0x1C, 0x3B, 0xD2, 0x6E, 0xBA, 0xAE,
405 0x4A, 0xA1, 0xF9, 0x51, 0x29, 0xE5, 0xE5, 0x46, 0x70, 0xF1 },
406 { 0x34, 0xAA, 0x97, 0x3C, 0xD4, 0xC4, 0xDA, 0xA4, 0xF6, 0x1E,
407 0xEB, 0x2B, 0xDB, 0xAD, 0x27, 0x31, 0x65, 0x34, 0x01, 0x6F }
408 };
409
410 /*
411 * Checkup routine
412 */
mbedtls_sha1_self_test(int verbose)413 int mbedtls_sha1_self_test( int verbose )
414 {
415 int i, j, buflen, ret = 0;
416 unsigned char buf[1024];
417 unsigned char sha1sum[20];
418 mbedtls_sha1_context ctx;
419
420 mbedtls_sha1_init( &ctx );
421
422 /*
423 * SHA-1
424 */
425 for( i = 0; i < 3; i++ )
426 {
427 if( verbose != 0 )
428 mbedtls_printf( " SHA-1 test #%d: ", i + 1 );
429
430 if( ( ret = mbedtls_sha1_starts( &ctx ) ) != 0 )
431 goto fail;
432
433 if( i == 2 )
434 {
435 memset( buf, 'a', buflen = 1000 );
436
437 for( j = 0; j < 1000; j++ )
438 {
439 ret = mbedtls_sha1_update( &ctx, buf, buflen );
440 if( ret != 0 )
441 goto fail;
442 }
443 }
444 else
445 {
446 ret = mbedtls_sha1_update( &ctx, sha1_test_buf[i],
447 sha1_test_buflen[i] );
448 if( ret != 0 )
449 goto fail;
450 }
451
452 if( ( ret = mbedtls_sha1_finish( &ctx, sha1sum ) ) != 0 )
453 goto fail;
454
455 if( memcmp( sha1sum, sha1_test_sum[i], 20 ) != 0 )
456 {
457 ret = 1;
458 goto fail;
459 }
460
461 if( verbose != 0 )
462 mbedtls_printf( "passed\n" );
463 }
464
465 if( verbose != 0 )
466 mbedtls_printf( "\n" );
467
468 goto exit;
469
470 fail:
471 if( verbose != 0 )
472 mbedtls_printf( "failed\n" );
473
474 exit:
475 mbedtls_sha1_free( &ctx );
476
477 return( ret );
478 }
479
480 #endif /* MBEDTLS_SELF_TEST */
481
482 #endif /* MBEDTLS_SHA1_C */
483
