1 /*
2  *  RFC 1321 compliant MD5 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 MD5 algorithm was designed by Ron Rivest in 1991.
21  *
22  *  http://www.ietf.org/rfc/rfc1321.txt
23  */
24 
25 #include "common.h"
26 
27 #if defined(MBEDTLS_MD5_C)
28 
29 #include "mbedtls/md5.h"
30 #include "mbedtls/platform_util.h"
31 #include "mbedtls/error.h"
32 
33 #include <string.h>
34 
35 #if defined(MBEDTLS_SELF_TEST)
36 #if defined(MBEDTLS_PLATFORM_C)
37 #include "mbedtls/platform.h"
38 #else
39 #include <stdio.h>
40 #define mbedtls_printf printf
41 #endif /* MBEDTLS_PLATFORM_C */
42 #endif /* MBEDTLS_SELF_TEST */
43 
44 #if !defined(MBEDTLS_MD5_ALT)
45 
46 /*
47  * 32-bit integer manipulation macros (little endian)
48  */
49 #ifndef GET_UINT32_LE
50 #define GET_UINT32_LE(n,b,i)                            \
51 {                                                       \
52     (n) = ( (uint32_t) (b)[(i)    ]       )             \
53         | ( (uint32_t) (b)[(i) + 1] <<  8 )             \
54         | ( (uint32_t) (b)[(i) + 2] << 16 )             \
55         | ( (uint32_t) (b)[(i) + 3] << 24 );            \
56 }
57 #endif
58 
59 #ifndef PUT_UINT32_LE
60 #define PUT_UINT32_LE(n,b,i)                                    \
61 {                                                               \
62     (b)[(i)    ] = (unsigned char) ( ( (n)       ) & 0xFF );    \
63     (b)[(i) + 1] = (unsigned char) ( ( (n) >>  8 ) & 0xFF );    \
64     (b)[(i) + 2] = (unsigned char) ( ( (n) >> 16 ) & 0xFF );    \
65     (b)[(i) + 3] = (unsigned char) ( ( (n) >> 24 ) & 0xFF );    \
66 }
67 #endif
68 
mbedtls_md5_init(mbedtls_md5_context * ctx)69 void mbedtls_md5_init( mbedtls_md5_context *ctx )
70 {
71     memset( ctx, 0, sizeof( mbedtls_md5_context ) );
72 }
73 
mbedtls_md5_free(mbedtls_md5_context * ctx)74 void mbedtls_md5_free( mbedtls_md5_context *ctx )
75 {
76     if( ctx == NULL )
77         return;
78 
79     mbedtls_platform_zeroize( ctx, sizeof( mbedtls_md5_context ) );
80 }
81 
mbedtls_md5_clone(mbedtls_md5_context * dst,const mbedtls_md5_context * src)82 void mbedtls_md5_clone( mbedtls_md5_context *dst,
83                         const mbedtls_md5_context *src )
84 {
85     *dst = *src;
86 }
87 
88 /*
89  * MD5 context setup
90  */
mbedtls_md5_starts_ret(mbedtls_md5_context * ctx)91 int mbedtls_md5_starts_ret( mbedtls_md5_context *ctx )
92 {
93     ctx->total[0] = 0;
94     ctx->total[1] = 0;
95 
96     ctx->state[0] = 0x67452301;
97     ctx->state[1] = 0xEFCDAB89;
98     ctx->state[2] = 0x98BADCFE;
99     ctx->state[3] = 0x10325476;
100 
101     return( 0 );
102 }
103 
104 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
mbedtls_md5_starts(mbedtls_md5_context * ctx)105 void mbedtls_md5_starts( mbedtls_md5_context *ctx )
106 {
107     mbedtls_md5_starts_ret( ctx );
108 }
109 #endif
110 
111 #if !defined(MBEDTLS_MD5_PROCESS_ALT)
mbedtls_internal_md5_process(mbedtls_md5_context * ctx,const unsigned char data[64])112 int mbedtls_internal_md5_process( mbedtls_md5_context *ctx,
113                                   const unsigned char data[64] )
114 {
115     struct
116     {
117         uint32_t X[16], A, B, C, D;
118     } local;
119 
120     GET_UINT32_LE( local.X[ 0], data,  0 );
121     GET_UINT32_LE( local.X[ 1], data,  4 );
122     GET_UINT32_LE( local.X[ 2], data,  8 );
123     GET_UINT32_LE( local.X[ 3], data, 12 );
124     GET_UINT32_LE( local.X[ 4], data, 16 );
125     GET_UINT32_LE( local.X[ 5], data, 20 );
126     GET_UINT32_LE( local.X[ 6], data, 24 );
127     GET_UINT32_LE( local.X[ 7], data, 28 );
128     GET_UINT32_LE( local.X[ 8], data, 32 );
129     GET_UINT32_LE( local.X[ 9], data, 36 );
130     GET_UINT32_LE( local.X[10], data, 40 );
131     GET_UINT32_LE( local.X[11], data, 44 );
132     GET_UINT32_LE( local.X[12], data, 48 );
133     GET_UINT32_LE( local.X[13], data, 52 );
134     GET_UINT32_LE( local.X[14], data, 56 );
135     GET_UINT32_LE( local.X[15], data, 60 );
136 
137 #define S(x,n)                                                          \
138     ( ( (x) << (n) ) | ( ( (x) & 0xFFFFFFFF) >> ( 32 - (n) ) ) )
139 
140 #define P(a,b,c,d,k,s,t)                                                \
141     do                                                                  \
142     {                                                                   \
143         (a) += F((b),(c),(d)) + local.X[(k)] + (t);                     \
144         (a) = S((a),(s)) + (b);                                         \
145     } while( 0 )
146 
147     local.A = ctx->state[0];
148     local.B = ctx->state[1];
149     local.C = ctx->state[2];
150     local.D = ctx->state[3];
151 
152 #define F(x,y,z) ((z) ^ ((x) & ((y) ^ (z))))
153 
154     P( local.A, local.B, local.C, local.D,  0,  7, 0xD76AA478 );
155     P( local.D, local.A, local.B, local.C,  1, 12, 0xE8C7B756 );
156     P( local.C, local.D, local.A, local.B,  2, 17, 0x242070DB );
157     P( local.B, local.C, local.D, local.A,  3, 22, 0xC1BDCEEE );
158     P( local.A, local.B, local.C, local.D,  4,  7, 0xF57C0FAF );
159     P( local.D, local.A, local.B, local.C,  5, 12, 0x4787C62A );
160     P( local.C, local.D, local.A, local.B,  6, 17, 0xA8304613 );
161     P( local.B, local.C, local.D, local.A,  7, 22, 0xFD469501 );
162     P( local.A, local.B, local.C, local.D,  8,  7, 0x698098D8 );
163     P( local.D, local.A, local.B, local.C,  9, 12, 0x8B44F7AF );
164     P( local.C, local.D, local.A, local.B, 10, 17, 0xFFFF5BB1 );
165     P( local.B, local.C, local.D, local.A, 11, 22, 0x895CD7BE );
166     P( local.A, local.B, local.C, local.D, 12,  7, 0x6B901122 );
167     P( local.D, local.A, local.B, local.C, 13, 12, 0xFD987193 );
168     P( local.C, local.D, local.A, local.B, 14, 17, 0xA679438E );
169     P( local.B, local.C, local.D, local.A, 15, 22, 0x49B40821 );
170 
171 #undef F
172 
173 #define F(x,y,z) ((y) ^ ((z) & ((x) ^ (y))))
174 
175     P( local.A, local.B, local.C, local.D,  1,  5, 0xF61E2562 );
176     P( local.D, local.A, local.B, local.C,  6,  9, 0xC040B340 );
177     P( local.C, local.D, local.A, local.B, 11, 14, 0x265E5A51 );
178     P( local.B, local.C, local.D, local.A,  0, 20, 0xE9B6C7AA );
179     P( local.A, local.B, local.C, local.D,  5,  5, 0xD62F105D );
180     P( local.D, local.A, local.B, local.C, 10,  9, 0x02441453 );
181     P( local.C, local.D, local.A, local.B, 15, 14, 0xD8A1E681 );
182     P( local.B, local.C, local.D, local.A,  4, 20, 0xE7D3FBC8 );
183     P( local.A, local.B, local.C, local.D,  9,  5, 0x21E1CDE6 );
184     P( local.D, local.A, local.B, local.C, 14,  9, 0xC33707D6 );
185     P( local.C, local.D, local.A, local.B,  3, 14, 0xF4D50D87 );
186     P( local.B, local.C, local.D, local.A,  8, 20, 0x455A14ED );
187     P( local.A, local.B, local.C, local.D, 13,  5, 0xA9E3E905 );
188     P( local.D, local.A, local.B, local.C,  2,  9, 0xFCEFA3F8 );
189     P( local.C, local.D, local.A, local.B,  7, 14, 0x676F02D9 );
190     P( local.B, local.C, local.D, local.A, 12, 20, 0x8D2A4C8A );
191 
192 #undef F
193 
194 #define F(x,y,z) ((x) ^ (y) ^ (z))
195 
196     P( local.A, local.B, local.C, local.D,  5,  4, 0xFFFA3942 );
197     P( local.D, local.A, local.B, local.C,  8, 11, 0x8771F681 );
198     P( local.C, local.D, local.A, local.B, 11, 16, 0x6D9D6122 );
199     P( local.B, local.C, local.D, local.A, 14, 23, 0xFDE5380C );
200     P( local.A, local.B, local.C, local.D,  1,  4, 0xA4BEEA44 );
201     P( local.D, local.A, local.B, local.C,  4, 11, 0x4BDECFA9 );
202     P( local.C, local.D, local.A, local.B,  7, 16, 0xF6BB4B60 );
203     P( local.B, local.C, local.D, local.A, 10, 23, 0xBEBFBC70 );
204     P( local.A, local.B, local.C, local.D, 13,  4, 0x289B7EC6 );
205     P( local.D, local.A, local.B, local.C,  0, 11, 0xEAA127FA );
206     P( local.C, local.D, local.A, local.B,  3, 16, 0xD4EF3085 );
207     P( local.B, local.C, local.D, local.A,  6, 23, 0x04881D05 );
208     P( local.A, local.B, local.C, local.D,  9,  4, 0xD9D4D039 );
209     P( local.D, local.A, local.B, local.C, 12, 11, 0xE6DB99E5 );
210     P( local.C, local.D, local.A, local.B, 15, 16, 0x1FA27CF8 );
211     P( local.B, local.C, local.D, local.A,  2, 23, 0xC4AC5665 );
212 
213 #undef F
214 
215 #define F(x,y,z) ((y) ^ ((x) | ~(z)))
216 
217     P( local.A, local.B, local.C, local.D,  0,  6, 0xF4292244 );
218     P( local.D, local.A, local.B, local.C,  7, 10, 0x432AFF97 );
219     P( local.C, local.D, local.A, local.B, 14, 15, 0xAB9423A7 );
220     P( local.B, local.C, local.D, local.A,  5, 21, 0xFC93A039 );
221     P( local.A, local.B, local.C, local.D, 12,  6, 0x655B59C3 );
222     P( local.D, local.A, local.B, local.C,  3, 10, 0x8F0CCC92 );
223     P( local.C, local.D, local.A, local.B, 10, 15, 0xFFEFF47D );
224     P( local.B, local.C, local.D, local.A,  1, 21, 0x85845DD1 );
225     P( local.A, local.B, local.C, local.D,  8,  6, 0x6FA87E4F );
226     P( local.D, local.A, local.B, local.C, 15, 10, 0xFE2CE6E0 );
227     P( local.C, local.D, local.A, local.B,  6, 15, 0xA3014314 );
228     P( local.B, local.C, local.D, local.A, 13, 21, 0x4E0811A1 );
229     P( local.A, local.B, local.C, local.D,  4,  6, 0xF7537E82 );
230     P( local.D, local.A, local.B, local.C, 11, 10, 0xBD3AF235 );
231     P( local.C, local.D, local.A, local.B,  2, 15, 0x2AD7D2BB );
232     P( local.B, local.C, local.D, local.A,  9, 21, 0xEB86D391 );
233 
234 #undef F
235 
236     ctx->state[0] += local.A;
237     ctx->state[1] += local.B;
238     ctx->state[2] += local.C;
239     ctx->state[3] += local.D;
240 
241     /* Zeroise variables to clear sensitive data from memory. */
242     mbedtls_platform_zeroize( &local, sizeof( local ) );
243 
244     return( 0 );
245 }
246 
247 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
mbedtls_md5_process(mbedtls_md5_context * ctx,const unsigned char data[64])248 void mbedtls_md5_process( mbedtls_md5_context *ctx,
249                           const unsigned char data[64] )
250 {
251     mbedtls_internal_md5_process( ctx, data );
252 }
253 #endif
254 #endif /* !MBEDTLS_MD5_PROCESS_ALT */
255 
256 /*
257  * MD5 process buffer
258  */
mbedtls_md5_update_ret(mbedtls_md5_context * ctx,const unsigned char * input,size_t ilen)259 int mbedtls_md5_update_ret( mbedtls_md5_context *ctx,
260                             const unsigned char *input,
261                             size_t ilen )
262 {
263     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
264     size_t fill;
265     uint32_t left;
266 
267     if( ilen == 0 )
268         return( 0 );
269 
270     left = ctx->total[0] & 0x3F;
271     fill = 64 - left;
272 
273     ctx->total[0] += (uint32_t) ilen;
274     ctx->total[0] &= 0xFFFFFFFF;
275 
276     if( ctx->total[0] < (uint32_t) ilen )
277         ctx->total[1]++;
278 
279     if( left && ilen >= fill )
280     {
281         memcpy( (void *) (ctx->buffer + left), input, fill );
282         if( ( ret = mbedtls_internal_md5_process( ctx, ctx->buffer ) ) != 0 )
283             return( ret );
284 
285         input += fill;
286         ilen  -= fill;
287         left = 0;
288     }
289 
290     while( ilen >= 64 )
291     {
292         if( ( ret = mbedtls_internal_md5_process( ctx, input ) ) != 0 )
293             return( ret );
294 
295         input += 64;
296         ilen  -= 64;
297     }
298 
299     if( ilen > 0 )
300     {
301         memcpy( (void *) (ctx->buffer + left), input, ilen );
302     }
303 
304     return( 0 );
305 }
306 
307 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
mbedtls_md5_update(mbedtls_md5_context * ctx,const unsigned char * input,size_t ilen)308 void mbedtls_md5_update( mbedtls_md5_context *ctx,
309                          const unsigned char *input,
310                          size_t ilen )
311 {
312     mbedtls_md5_update_ret( ctx, input, ilen );
313 }
314 #endif
315 
316 /*
317  * MD5 final digest
318  */
mbedtls_md5_finish_ret(mbedtls_md5_context * ctx,unsigned char output[16])319 int mbedtls_md5_finish_ret( mbedtls_md5_context *ctx,
320                             unsigned char output[16] )
321 {
322     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
323     uint32_t used;
324     uint32_t high, low;
325 
326     /*
327      * Add padding: 0x80 then 0x00 until 8 bytes remain for the length
328      */
329     used = ctx->total[0] & 0x3F;
330 
331     ctx->buffer[used++] = 0x80;
332 
333     if( used <= 56 )
334     {
335         /* Enough room for padding + length in current block */
336         memset( ctx->buffer + used, 0, 56 - used );
337     }
338     else
339     {
340         /* We'll need an extra block */
341         memset( ctx->buffer + used, 0, 64 - used );
342 
343         if( ( ret = mbedtls_internal_md5_process( ctx, ctx->buffer ) ) != 0 )
344             return( ret );
345 
346         memset( ctx->buffer, 0, 56 );
347     }
348 
349     /*
350      * Add message length
351      */
352     high = ( ctx->total[0] >> 29 )
353          | ( ctx->total[1] <<  3 );
354     low  = ( ctx->total[0] <<  3 );
355 
356     PUT_UINT32_LE( low,  ctx->buffer, 56 );
357     PUT_UINT32_LE( high, ctx->buffer, 60 );
358 
359     if( ( ret = mbedtls_internal_md5_process( ctx, ctx->buffer ) ) != 0 )
360         return( ret );
361 
362     /*
363      * Output final state
364      */
365     PUT_UINT32_LE( ctx->state[0], output,  0 );
366     PUT_UINT32_LE( ctx->state[1], output,  4 );
367     PUT_UINT32_LE( ctx->state[2], output,  8 );
368     PUT_UINT32_LE( ctx->state[3], output, 12 );
369 
370     return( 0 );
371 }
372 
373 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
mbedtls_md5_finish(mbedtls_md5_context * ctx,unsigned char output[16])374 void mbedtls_md5_finish( mbedtls_md5_context *ctx,
375                          unsigned char output[16] )
376 {
377     mbedtls_md5_finish_ret( ctx, output );
378 }
379 #endif
380 
381 #endif /* !MBEDTLS_MD5_ALT */
382 
383 /*
384  * output = MD5( input buffer )
385  */
mbedtls_md5_ret(const unsigned char * input,size_t ilen,unsigned char output[16])386 int mbedtls_md5_ret( const unsigned char *input,
387                      size_t ilen,
388                      unsigned char output[16] )
389 {
390     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
391     mbedtls_md5_context ctx;
392 
393     mbedtls_md5_init( &ctx );
394 
395     if( ( ret = mbedtls_md5_starts_ret( &ctx ) ) != 0 )
396         goto exit;
397 
398     if( ( ret = mbedtls_md5_update_ret( &ctx, input, ilen ) ) != 0 )
399         goto exit;
400 
401     if( ( ret = mbedtls_md5_finish_ret( &ctx, output ) ) != 0 )
402         goto exit;
403 
404 exit:
405     mbedtls_md5_free( &ctx );
406 
407     return( ret );
408 }
409 
410 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
mbedtls_md5(const unsigned char * input,size_t ilen,unsigned char output[16])411 void mbedtls_md5( const unsigned char *input,
412                   size_t ilen,
413                   unsigned char output[16] )
414 {
415     mbedtls_md5_ret( input, ilen, output );
416 }
417 #endif
418 
419 #if defined(MBEDTLS_SELF_TEST)
420 /*
421  * RFC 1321 test vectors
422  */
423 static const unsigned char md5_test_buf[7][81] =
424 {
425     { "" },
426     { "a" },
427     { "abc" },
428     { "message digest" },
429     { "abcdefghijklmnopqrstuvwxyz" },
430     { "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789" },
431     { "12345678901234567890123456789012345678901234567890123456789012345678901234567890" }
432 };
433 
434 static const size_t md5_test_buflen[7] =
435 {
436     0, 1, 3, 14, 26, 62, 80
437 };
438 
439 static const unsigned char md5_test_sum[7][16] =
440 {
441     { 0xD4, 0x1D, 0x8C, 0xD9, 0x8F, 0x00, 0xB2, 0x04,
442       0xE9, 0x80, 0x09, 0x98, 0xEC, 0xF8, 0x42, 0x7E },
443     { 0x0C, 0xC1, 0x75, 0xB9, 0xC0, 0xF1, 0xB6, 0xA8,
444       0x31, 0xC3, 0x99, 0xE2, 0x69, 0x77, 0x26, 0x61 },
445     { 0x90, 0x01, 0x50, 0x98, 0x3C, 0xD2, 0x4F, 0xB0,
446       0xD6, 0x96, 0x3F, 0x7D, 0x28, 0xE1, 0x7F, 0x72 },
447     { 0xF9, 0x6B, 0x69, 0x7D, 0x7C, 0xB7, 0x93, 0x8D,
448       0x52, 0x5A, 0x2F, 0x31, 0xAA, 0xF1, 0x61, 0xD0 },
449     { 0xC3, 0xFC, 0xD3, 0xD7, 0x61, 0x92, 0xE4, 0x00,
450       0x7D, 0xFB, 0x49, 0x6C, 0xCA, 0x67, 0xE1, 0x3B },
451     { 0xD1, 0x74, 0xAB, 0x98, 0xD2, 0x77, 0xD9, 0xF5,
452       0xA5, 0x61, 0x1C, 0x2C, 0x9F, 0x41, 0x9D, 0x9F },
453     { 0x57, 0xED, 0xF4, 0xA2, 0x2B, 0xE3, 0xC9, 0x55,
454       0xAC, 0x49, 0xDA, 0x2E, 0x21, 0x07, 0xB6, 0x7A }
455 };
456 
457 /*
458  * Checkup routine
459  */
mbedtls_md5_self_test(int verbose)460 int mbedtls_md5_self_test( int verbose )
461 {
462     int i, ret = 0;
463     unsigned char md5sum[16];
464 
465     for( i = 0; i < 7; i++ )
466     {
467         if( verbose != 0 )
468             mbedtls_printf( "  MD5 test #%d: ", i + 1 );
469 
470         ret = mbedtls_md5_ret( md5_test_buf[i], md5_test_buflen[i], md5sum );
471         if( ret != 0 )
472             goto fail;
473 
474         if( memcmp( md5sum, md5_test_sum[i], 16 ) != 0 )
475         {
476             ret = 1;
477             goto fail;
478         }
479 
480         if( verbose != 0 )
481             mbedtls_printf( "passed\n" );
482     }
483 
484     if( verbose != 0 )
485         mbedtls_printf( "\n" );
486 
487     return( 0 );
488 
489 fail:
490     if( verbose != 0 )
491         mbedtls_printf( "failed\n" );
492 
493     return( ret );
494 }
495 
496 #endif /* MBEDTLS_SELF_TEST */
497 
498 #endif /* MBEDTLS_MD5_C */
499