Update from GNU gettext 0.15.
[gnulib.git] / lib / md5.c
1 /* Functions to compute MD5 message digest of files or memory blocks.
2    according to the definition of MD5 in RFC 1321 from April 1992.
3    Copyright (C) 1995,1996,1997,1999,2000,2001,2005,2006
4         Free Software Foundation, Inc.
5    This file is part of the GNU C Library.
6
7    This program is free software; you can redistribute it and/or modify it
8    under the terms of the GNU General Public License as published by the
9    Free Software Foundation; either version 2, or (at your option) any
10    later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software Foundation,
19    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
20
21 /* Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>, 1995.  */
22
23 #ifdef HAVE_CONFIG_H
24 # include <config.h>
25 #endif
26
27 #include "md5.h"
28
29 #include <stddef.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <sys/types.h>
33
34 #if USE_UNLOCKED_IO
35 # include "unlocked-io.h"
36 #endif
37
38 #ifdef _LIBC
39 # include <endian.h>
40 # if __BYTE_ORDER == __BIG_ENDIAN
41 #  define WORDS_BIGENDIAN 1
42 # endif
43 /* We need to keep the namespace clean so define the MD5 function
44    protected using leading __ .  */
45 # define md5_init_ctx __md5_init_ctx
46 # define md5_process_block __md5_process_block
47 # define md5_process_bytes __md5_process_bytes
48 # define md5_finish_ctx __md5_finish_ctx
49 # define md5_read_ctx __md5_read_ctx
50 # define md5_stream __md5_stream
51 # define md5_buffer __md5_buffer
52 #endif
53
54 #ifdef WORDS_BIGENDIAN
55 # define SWAP(n)                                                        \
56     (((n) << 24) | (((n) & 0xff00) << 8) | (((n) >> 8) & 0xff00) | ((n) >> 24))
57 #else
58 # define SWAP(n) (n)
59 #endif
60
61 #define BLOCKSIZE 4096
62 #if BLOCKSIZE % 64 != 0
63 # error "invalid BLOCKSIZE"
64 #endif
65
66 /* This array contains the bytes used to pad the buffer to the next
67    64-byte boundary.  (RFC 1321, 3.1: Step 1)  */
68 static const unsigned char fillbuf[64] = { 0x80, 0 /* , 0, 0, ...  */ };
69
70
71 /* Initialize structure containing state of computation.
72    (RFC 1321, 3.3: Step 3)  */
73 void
74 md5_init_ctx (struct md5_ctx *ctx)
75 {
76   ctx->A = 0x67452301;
77   ctx->B = 0xefcdab89;
78   ctx->C = 0x98badcfe;
79   ctx->D = 0x10325476;
80
81   ctx->total[0] = ctx->total[1] = 0;
82   ctx->buflen = 0;
83 }
84
85 /* Put result from CTX in first 16 bytes following RESBUF.  The result
86    must be in little endian byte order.
87
88    IMPORTANT: On some systems it is required that RESBUF is correctly
89    aligned for a 32-bit value.  */
90 void *
91 md5_read_ctx (const struct md5_ctx *ctx, void *resbuf)
92 {
93   ((uint32_t *) resbuf)[0] = SWAP (ctx->A);
94   ((uint32_t *) resbuf)[1] = SWAP (ctx->B);
95   ((uint32_t *) resbuf)[2] = SWAP (ctx->C);
96   ((uint32_t *) resbuf)[3] = SWAP (ctx->D);
97
98   return resbuf;
99 }
100
101 /* Process the remaining bytes in the internal buffer and the usual
102    prolog according to the standard and write the result to RESBUF.
103
104    IMPORTANT: On some systems it is required that RESBUF is correctly
105    aligned for a 32-bit value.  */
106 void *
107 md5_finish_ctx (struct md5_ctx *ctx, void *resbuf)
108 {
109   /* Take yet unprocessed bytes into account.  */
110   uint32_t bytes = ctx->buflen;
111   size_t size = (bytes < 56) ? 64 / 4 : 64 * 2 / 4;
112
113   /* Now count remaining bytes.  */
114   ctx->total[0] += bytes;
115   if (ctx->total[0] < bytes)
116     ++ctx->total[1];
117
118   /* Put the 64-bit file length in *bits* at the end of the buffer.  */
119   ctx->buffer[size - 2] = SWAP (ctx->total[0] << 3);
120   ctx->buffer[size - 1] = SWAP ((ctx->total[1] << 3) | (ctx->total[0] >> 29));
121
122   memcpy (&((char *) ctx->buffer)[bytes], fillbuf, (size - 2) * 4 - bytes);
123
124   /* Process last bytes.  */
125   md5_process_block (ctx->buffer, size * 4, ctx);
126
127   return md5_read_ctx (ctx, resbuf);
128 }
129
130 /* Compute MD5 message digest for bytes read from STREAM.  The
131    resulting message digest number will be written into the 16 bytes
132    beginning at RESBLOCK.  */
133 int
134 md5_stream (FILE *stream, void *resblock)
135 {
136   struct md5_ctx ctx;
137   char buffer[BLOCKSIZE + 72];
138   size_t sum;
139
140   /* Initialize the computation context.  */
141   md5_init_ctx (&ctx);
142
143   /* Iterate over full file contents.  */
144   while (1)
145     {
146       /* We read the file in blocks of BLOCKSIZE bytes.  One call of the
147          computation function processes the whole buffer so that with the
148          next round of the loop another block can be read.  */
149       size_t n;
150       sum = 0;
151
152       /* Read block.  Take care for partial reads.  */
153       while (1)
154         {
155           n = fread (buffer + sum, 1, BLOCKSIZE - sum, stream);
156
157           sum += n;
158
159           if (sum == BLOCKSIZE)
160             break;
161
162           if (n == 0)
163             {
164               /* Check for the error flag IFF N == 0, so that we don't
165                  exit the loop after a partial read due to e.g., EAGAIN
166                  or EWOULDBLOCK.  */
167               if (ferror (stream))
168                 return 1;
169               goto process_partial_block;
170             }
171
172           /* We've read at least one byte, so ignore errors.  But always
173              check for EOF, since feof may be true even though N > 0.
174              Otherwise, we could end up calling fread after EOF.  */
175           if (feof (stream))
176             goto process_partial_block;
177         }
178
179       /* Process buffer with BLOCKSIZE bytes.  Note that
180          BLOCKSIZE % 64 == 0
181        */
182       md5_process_block (buffer, BLOCKSIZE, &ctx);
183     }
184
185 process_partial_block:
186
187   /* Process any remaining bytes.  */
188   if (sum > 0)
189     md5_process_bytes (buffer, sum, &ctx);
190
191   /* Construct result in desired memory.  */
192   md5_finish_ctx (&ctx, resblock);
193   return 0;
194 }
195
196 /* Compute MD5 message digest for LEN bytes beginning at BUFFER.  The
197    result is always in little endian byte order, so that a byte-wise
198    output yields to the wanted ASCII representation of the message
199    digest.  */
200 void *
201 md5_buffer (const char *buffer, size_t len, void *resblock)
202 {
203   struct md5_ctx ctx;
204
205   /* Initialize the computation context.  */
206   md5_init_ctx (&ctx);
207
208   /* Process whole buffer but last len % 64 bytes.  */
209   md5_process_bytes (buffer, len, &ctx);
210
211   /* Put result in desired memory area.  */
212   return md5_finish_ctx (&ctx, resblock);
213 }
214
215
216 void
217 md5_process_bytes (const void *buffer, size_t len, struct md5_ctx *ctx)
218 {
219   /* When we already have some bits in our internal buffer concatenate
220      both inputs first.  */
221   if (ctx->buflen != 0)
222     {
223       size_t left_over = ctx->buflen;
224       size_t add = 128 - left_over > len ? len : 128 - left_over;
225
226       memcpy (&((char *) ctx->buffer)[left_over], buffer, add);
227       ctx->buflen += add;
228
229       if (ctx->buflen > 64)
230         {
231           md5_process_block (ctx->buffer, ctx->buflen & ~63, ctx);
232
233           ctx->buflen &= 63;
234           /* The regions in the following copy operation cannot overlap.  */
235           memcpy (ctx->buffer,
236                   &((char *) ctx->buffer)[(left_over + add) & ~63],
237                   ctx->buflen);
238         }
239
240       buffer = (const char *) buffer + add;
241       len -= add;
242     }
243
244   /* Process available complete blocks.  */
245   if (len >= 64)
246     {
247 #if !_STRING_ARCH_unaligned
248 # define alignof(type) offsetof (struct { char c; type x; }, x)
249 # define UNALIGNED_P(p) (((size_t) p) % alignof (uint32_t) != 0)
250       if (UNALIGNED_P (buffer))
251         while (len > 64)
252           {
253             md5_process_block (memcpy (ctx->buffer, buffer, 64), 64, ctx);
254             buffer = (const char *) buffer + 64;
255             len -= 64;
256           }
257       else
258 #endif
259         {
260           md5_process_block (buffer, len & ~63, ctx);
261           buffer = (const char *) buffer + (len & ~63);
262           len &= 63;
263         }
264     }
265
266   /* Move remaining bytes in internal buffer.  */
267   if (len > 0)
268     {
269       size_t left_over = ctx->buflen;
270
271       memcpy (&((char *) ctx->buffer)[left_over], buffer, len);
272       left_over += len;
273       if (left_over >= 64)
274         {
275           md5_process_block (ctx->buffer, 64, ctx);
276           left_over -= 64;
277           memcpy (ctx->buffer, &ctx->buffer[16], left_over);
278         }
279       ctx->buflen = left_over;
280     }
281 }
282
283
284 /* These are the four functions used in the four steps of the MD5 algorithm
285    and defined in the RFC 1321.  The first function is a little bit optimized
286    (as found in Colin Plumbs public domain implementation).  */
287 /* #define FF(b, c, d) ((b & c) | (~b & d)) */
288 #define FF(b, c, d) (d ^ (b & (c ^ d)))
289 #define FG(b, c, d) FF (d, b, c)
290 #define FH(b, c, d) (b ^ c ^ d)
291 #define FI(b, c, d) (c ^ (b | ~d))
292
293 /* Process LEN bytes of BUFFER, accumulating context into CTX.
294    It is assumed that LEN % 64 == 0.  */
295
296 void
297 md5_process_block (const void *buffer, size_t len, struct md5_ctx *ctx)
298 {
299   uint32_t correct_words[16];
300   const uint32_t *words = buffer;
301   size_t nwords = len / sizeof (uint32_t);
302   const uint32_t *endp = words + nwords;
303   uint32_t A = ctx->A;
304   uint32_t B = ctx->B;
305   uint32_t C = ctx->C;
306   uint32_t D = ctx->D;
307
308   /* First increment the byte count.  RFC 1321 specifies the possible
309      length of the file up to 2^64 bits.  Here we only compute the
310      number of bytes.  Do a double word increment.  */
311   ctx->total[0] += len;
312   if (ctx->total[0] < len)
313     ++ctx->total[1];
314
315   /* Process all bytes in the buffer with 64 bytes in each round of
316      the loop.  */
317   while (words < endp)
318     {
319       uint32_t *cwp = correct_words;
320       uint32_t A_save = A;
321       uint32_t B_save = B;
322       uint32_t C_save = C;
323       uint32_t D_save = D;
324
325       /* First round: using the given function, the context and a constant
326          the next context is computed.  Because the algorithms processing
327          unit is a 32-bit word and it is determined to work on words in
328          little endian byte order we perhaps have to change the byte order
329          before the computation.  To reduce the work for the next steps
330          we store the swapped words in the array CORRECT_WORDS.  */
331
332 #define OP(a, b, c, d, s, T)                                            \
333       do                                                                \
334         {                                                               \
335           a += FF (b, c, d) + (*cwp++ = SWAP (*words)) + T;             \
336           ++words;                                                      \
337           CYCLIC (a, s);                                                \
338           a += b;                                                       \
339         }                                                               \
340       while (0)
341
342       /* It is unfortunate that C does not provide an operator for
343          cyclic rotation.  Hope the C compiler is smart enough.  */
344 #define CYCLIC(w, s) (w = (w << s) | (w >> (32 - s)))
345
346       /* Before we start, one word to the strange constants.
347          They are defined in RFC 1321 as
348
349          T[i] = (int) (4294967296.0 * fabs (sin (i))), i=1..64
350
351          Here is an equivalent invocation using Perl:
352
353          perl -e 'foreach(1..64){printf "0x%08x\n", int (4294967296 * abs (sin $_))}'
354        */
355
356       /* Round 1.  */
357       OP (A, B, C, D, 7, 0xd76aa478);
358       OP (D, A, B, C, 12, 0xe8c7b756);
359       OP (C, D, A, B, 17, 0x242070db);
360       OP (B, C, D, A, 22, 0xc1bdceee);
361       OP (A, B, C, D, 7, 0xf57c0faf);
362       OP (D, A, B, C, 12, 0x4787c62a);
363       OP (C, D, A, B, 17, 0xa8304613);
364       OP (B, C, D, A, 22, 0xfd469501);
365       OP (A, B, C, D, 7, 0x698098d8);
366       OP (D, A, B, C, 12, 0x8b44f7af);
367       OP (C, D, A, B, 17, 0xffff5bb1);
368       OP (B, C, D, A, 22, 0x895cd7be);
369       OP (A, B, C, D, 7, 0x6b901122);
370       OP (D, A, B, C, 12, 0xfd987193);
371       OP (C, D, A, B, 17, 0xa679438e);
372       OP (B, C, D, A, 22, 0x49b40821);
373
374       /* For the second to fourth round we have the possibly swapped words
375          in CORRECT_WORDS.  Redefine the macro to take an additional first
376          argument specifying the function to use.  */
377 #undef OP
378 #define OP(f, a, b, c, d, k, s, T)                                      \
379       do                                                                \
380         {                                                               \
381           a += f (b, c, d) + correct_words[k] + T;                      \
382           CYCLIC (a, s);                                                \
383           a += b;                                                       \
384         }                                                               \
385       while (0)
386
387       /* Round 2.  */
388       OP (FG, A, B, C, D, 1, 5, 0xf61e2562);
389       OP (FG, D, A, B, C, 6, 9, 0xc040b340);
390       OP (FG, C, D, A, B, 11, 14, 0x265e5a51);
391       OP (FG, B, C, D, A, 0, 20, 0xe9b6c7aa);
392       OP (FG, A, B, C, D, 5, 5, 0xd62f105d);
393       OP (FG, D, A, B, C, 10, 9, 0x02441453);
394       OP (FG, C, D, A, B, 15, 14, 0xd8a1e681);
395       OP (FG, B, C, D, A, 4, 20, 0xe7d3fbc8);
396       OP (FG, A, B, C, D, 9, 5, 0x21e1cde6);
397       OP (FG, D, A, B, C, 14, 9, 0xc33707d6);
398       OP (FG, C, D, A, B, 3, 14, 0xf4d50d87);
399       OP (FG, B, C, D, A, 8, 20, 0x455a14ed);
400       OP (FG, A, B, C, D, 13, 5, 0xa9e3e905);
401       OP (FG, D, A, B, C, 2, 9, 0xfcefa3f8);
402       OP (FG, C, D, A, B, 7, 14, 0x676f02d9);
403       OP (FG, B, C, D, A, 12, 20, 0x8d2a4c8a);
404
405       /* Round 3.  */
406       OP (FH, A, B, C, D, 5, 4, 0xfffa3942);
407       OP (FH, D, A, B, C, 8, 11, 0x8771f681);
408       OP (FH, C, D, A, B, 11, 16, 0x6d9d6122);
409       OP (FH, B, C, D, A, 14, 23, 0xfde5380c);
410       OP (FH, A, B, C, D, 1, 4, 0xa4beea44);
411       OP (FH, D, A, B, C, 4, 11, 0x4bdecfa9);
412       OP (FH, C, D, A, B, 7, 16, 0xf6bb4b60);
413       OP (FH, B, C, D, A, 10, 23, 0xbebfbc70);
414       OP (FH, A, B, C, D, 13, 4, 0x289b7ec6);
415       OP (FH, D, A, B, C, 0, 11, 0xeaa127fa);
416       OP (FH, C, D, A, B, 3, 16, 0xd4ef3085);
417       OP (FH, B, C, D, A, 6, 23, 0x04881d05);
418       OP (FH, A, B, C, D, 9, 4, 0xd9d4d039);
419       OP (FH, D, A, B, C, 12, 11, 0xe6db99e5);
420       OP (FH, C, D, A, B, 15, 16, 0x1fa27cf8);
421       OP (FH, B, C, D, A, 2, 23, 0xc4ac5665);
422
423       /* Round 4.  */
424       OP (FI, A, B, C, D, 0, 6, 0xf4292244);
425       OP (FI, D, A, B, C, 7, 10, 0x432aff97);
426       OP (FI, C, D, A, B, 14, 15, 0xab9423a7);
427       OP (FI, B, C, D, A, 5, 21, 0xfc93a039);
428       OP (FI, A, B, C, D, 12, 6, 0x655b59c3);
429       OP (FI, D, A, B, C, 3, 10, 0x8f0ccc92);
430       OP (FI, C, D, A, B, 10, 15, 0xffeff47d);
431       OP (FI, B, C, D, A, 1, 21, 0x85845dd1);
432       OP (FI, A, B, C, D, 8, 6, 0x6fa87e4f);
433       OP (FI, D, A, B, C, 15, 10, 0xfe2ce6e0);
434       OP (FI, C, D, A, B, 6, 15, 0xa3014314);
435       OP (FI, B, C, D, A, 13, 21, 0x4e0811a1);
436       OP (FI, A, B, C, D, 4, 6, 0xf7537e82);
437       OP (FI, D, A, B, C, 11, 10, 0xbd3af235);
438       OP (FI, C, D, A, B, 2, 15, 0x2ad7d2bb);
439       OP (FI, B, C, D, A, 9, 21, 0xeb86d391);
440
441       /* Add the starting values of the context.  */
442       A += A_save;
443       B += B_save;
444       C += C_save;
445       D += D_save;
446     }
447
448   /* Put checksum in context given as argument.  */
449   ctx->A = A;
450   ctx->B = B;
451   ctx->C = C;
452   ctx->D = D;
453 }