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