Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / intern / hash_md5.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  * Copyright (C) 1995 Software Foundation, Inc.
16  *
17  * Written by Ulrich Drepper <drepper@gnu.ai.mit.edu>.
18  */
19
20 /** \file \ingroup bli
21  *
22  *  Functions to compute MD5 message digest of files or memory blocks
23  *  according to the definition of MD5 in RFC 1321 from April 1992.
24  */
25
26 #include <stdlib.h>
27 #include <string.h>
28 #include <stdio.h>
29 #include <sys/types.h>
30
31 #include "BLI_hash_md5.h"  /* own include */
32
33 #if defined HAVE_LIMITS_H || defined _LIBC
34 #  include <limits.h>
35 #endif
36
37 /* The following contortions are an attempt to use the C preprocessor to determine an unsigned
38  * integral type that is 32 bits wide.
39  * An alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but doing that would require
40  * that the configure script compile and *run* the resulting executable.
41  * Locally running cross-compiled executables is usually not possible.
42  */
43
44 #if defined __STDC__ && __STDC__
45 #  define UINT_MAX_32_BITS 4294967295U
46 #else
47 #  define UINT_MAX_32_BITS 0xFFFFFFFF
48 #endif
49
50 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
51  * This should be valid for all systems GNU cares about because that doesn't include 16-bit systems,
52  * and only modern systems (that certainly have <limits.h>) have 64+-bit integral types.
53  */
54
55 #ifndef UINT_MAX
56 #  define UINT_MAX UINT_MAX_32_BITS
57 #endif
58
59 #if UINT_MAX == UINT_MAX_32_BITS
60    typedef unsigned int md5_uint32;
61 #else
62 #  if USHRT_MAX == UINT_MAX_32_BITS
63      typedef unsigned short md5_uint32;
64 #  else
65 #    if ULONG_MAX == UINT_MAX_32_BITS
66        typedef unsigned long md5_uint32;
67 #    else
68        /* The following line is intended to evoke an error. Using #error is not portable enough. */
69        "Cannot determine unsigned 32-bit data type."
70 #    endif
71 #  endif
72 #endif
73
74
75 /* Following code is low level, upon which are built up the functions
76  * 'BLI_hash_md5_stream' and 'BLI_hash_md5_buffer'. */
77
78 /* Structure to save state of computation between the single steps. */
79 struct md5_ctx {
80         md5_uint32 A;
81         md5_uint32 B;
82         md5_uint32 C;
83         md5_uint32 D;
84 };
85
86 #ifdef __BIG_ENDIAN__
87 #  define SWAP(n) (((n) << 24) | (((n) & 0xff00) << 8) | (((n) >> 8) & 0xff00) | ((n) >> 24))
88 #else
89 #  define SWAP(n) (n)
90 #endif
91
92 /* This array contains the bytes used to pad the buffer to the next 64-byte boundary.
93  * (RFC 1321, 3.1: Step 1) */
94 static const unsigned char fillbuf[64] = {0x80, 0 /* , 0, 0, ...  */};
95
96 /** Initialize structure containing state of computation.
97  *  (RFC 1321, 3.3: Step 3)
98  */
99 static void md5_init_ctx(struct md5_ctx *ctx)
100 {
101         ctx->A = 0x67452301;
102         ctx->B = 0xefcdab89;
103         ctx->C = 0x98badcfe;
104         ctx->D = 0x10325476;
105 }
106
107 /**
108  * Starting with the result of former calls of this function (or the initialization),
109  * this function updates the 'ctx' context for the next 'len' bytes starting at 'buffer'.
110  * It is necessary that 'len' is a multiple of 64!!!
111  */
112 static void md5_process_block(const void *buffer, size_t len, struct md5_ctx *ctx)
113 {
114 /* These are the four functions used in the four steps of the MD5 algorithm and defined in the
115  * RFC 1321. The first function is a little bit optimized
116  * (as found in Colin Plumbs public domain implementation).
117  */
118 /* #define FF(b, c, d) ((b & c) | (~b & d)) */
119 #define FF(b, c, d) (d ^ (b & (c ^ d)))
120 #define FG(b, c, d) FF (d, b, c)
121 #define FH(b, c, d) (b ^ c ^ d)
122 #define FI(b, c, d) (c ^ (b | ~d))
123
124 /* It is unfortunate that C does not provide an operator for cyclic rotation.
125  * Hope the C compiler is smart enough. */
126 #define CYCLIC(w, s) (w = (w << s) | (w >> (32 - s)))
127
128         md5_uint32 correct_words[16];
129         const md5_uint32 *words = buffer;
130         size_t nwords = len / sizeof(md5_uint32);
131         const md5_uint32 *endp = words + nwords;
132         md5_uint32 A = ctx->A;
133         md5_uint32 B = ctx->B;
134         md5_uint32 C = ctx->C;
135         md5_uint32 D = ctx->D;
136
137         /* Process all bytes in the buffer with 64 bytes in each round of the loop.  */
138         while (words < endp) {
139                 md5_uint32 *cwp = correct_words;
140                 md5_uint32 A_save = A;
141                 md5_uint32 B_save = B;
142                 md5_uint32 C_save = C;
143                 md5_uint32 D_save = D;
144
145                 /* First round: using the given function, the context and a constant the next context is
146                  * computed. Because the algorithms processing unit is a 32-bit word and it is determined
147                  * to work on words in little endian byte order we perhaps have to change the byte order
148                  * before the computation. To reduce the work for the next steps we store the swapped words
149                  * in the array CORRECT_WORDS.
150                  */
151 #define OP(a, b, c, d, s, T)                                   \
152                 a += FF(b, c, d) + (*cwp++ = SWAP(*words)) + T;        \
153                 ++words;                                               \
154                 CYCLIC(a, s);                                          \
155                 a += b;                                                \
156                 (void)0
157
158                 /* Before we start, one word to the strange constants. They are defined in RFC 1321 as:
159                  *     T[i] = (int) (4294967296.0 * fabs (sin (i))), i=1..64
160                  */
161
162                 /* Round 1.  */
163                 OP(A, B, C, D,  7, 0xd76aa478);
164                 OP(D, A, B, C, 12, 0xe8c7b756);
165                 OP(C, D, A, B, 17, 0x242070db);
166                 OP(B, C, D, A, 22, 0xc1bdceee);
167                 OP(A, B, C, D,  7, 0xf57c0faf);
168                 OP(D, A, B, C, 12, 0x4787c62a);
169                 OP(C, D, A, B, 17, 0xa8304613);
170                 OP(B, C, D, A, 22, 0xfd469501);
171                 OP(A, B, C, D,  7, 0x698098d8);
172                 OP(D, A, B, C, 12, 0x8b44f7af);
173                 OP(C, D, A, B, 17, 0xffff5bb1);
174                 OP(B, C, D, A, 22, 0x895cd7be);
175                 OP(A, B, C, D,  7, 0x6b901122);
176                 OP(D, A, B, C, 12, 0xfd987193);
177                 OP(C, D, A, B, 17, 0xa679438e);
178                 OP(B, C, D, A, 22, 0x49b40821);
179
180 #undef OP
181
182                 /* For the second to fourth round we have the possibly swapped words in CORRECT_WORDS.
183                  * Redefine the macro to take an additional first argument specifying the function to use.
184                  */
185 #define OP(f, a, b, c, d, k, s, T)                             \
186                 a += f(b, c, d) + correct_words[k] + T;                \
187                 CYCLIC(a, s);                                          \
188                 a += b;                                                \
189                 (void)0
190
191                 /* Round 2.  */
192                 OP(FG, A, B, C, D,  1,  5, 0xf61e2562);
193                 OP(FG, D, A, B, C,  6,  9, 0xc040b340);
194                 OP(FG, C, D, A, B, 11, 14, 0x265e5a51);
195                 OP(FG, B, C, D, A,  0, 20, 0xe9b6c7aa);
196                 OP(FG, A, B, C, D,  5,  5, 0xd62f105d);
197                 OP(FG, D, A, B, C, 10,  9, 0x02441453);
198                 OP(FG, C, D, A, B, 15, 14, 0xd8a1e681);
199                 OP(FG, B, C, D, A,  4, 20, 0xe7d3fbc8);
200                 OP(FG, A, B, C, D,  9,  5, 0x21e1cde6);
201                 OP(FG, D, A, B, C, 14,  9, 0xc33707d6);
202                 OP(FG, C, D, A, B,  3, 14, 0xf4d50d87);
203                 OP(FG, B, C, D, A,  8, 20, 0x455a14ed);
204                 OP(FG, A, B, C, D, 13,  5, 0xa9e3e905);
205                 OP(FG, D, A, B, C,  2,  9, 0xfcefa3f8);
206                 OP(FG, C, D, A, B,  7, 14, 0x676f02d9);
207                 OP(FG, B, C, D, A, 12, 20, 0x8d2a4c8a);
208
209                 /* Round 3.  */
210                 OP(FH, A, B, C, D,  5,  4, 0xfffa3942);
211                 OP(FH, D, A, B, C,  8, 11, 0x8771f681);
212                 OP(FH, C, D, A, B, 11, 16, 0x6d9d6122);
213                 OP(FH, B, C, D, A, 14, 23, 0xfde5380c);
214                 OP(FH, A, B, C, D,  1,  4, 0xa4beea44);
215                 OP(FH, D, A, B, C,  4, 11, 0x4bdecfa9);
216                 OP(FH, C, D, A, B,  7, 16, 0xf6bb4b60);
217                 OP(FH, B, C, D, A, 10, 23, 0xbebfbc70);
218                 OP(FH, A, B, C, D, 13,  4, 0x289b7ec6);
219                 OP(FH, D, A, B, C,  0, 11, 0xeaa127fa);
220                 OP(FH, C, D, A, B,  3, 16, 0xd4ef3085);
221                 OP(FH, B, C, D, A,  6, 23, 0x04881d05);
222                 OP(FH, A, B, C, D,  9,  4, 0xd9d4d039);
223                 OP(FH, D, A, B, C, 12, 11, 0xe6db99e5);
224                 OP(FH, C, D, A, B, 15, 16, 0x1fa27cf8);
225                 OP(FH, B, C, D, A,  2, 23, 0xc4ac5665);
226
227                 /* Round 4.  */
228                 OP(FI, A, B, C, D,  0,  6, 0xf4292244);
229                 OP(FI, D, A, B, C,  7, 10, 0x432aff97);
230                 OP(FI, C, D, A, B, 14, 15, 0xab9423a7);
231                 OP(FI, B, C, D, A,  5, 21, 0xfc93a039);
232                 OP(FI, A, B, C, D, 12,  6, 0x655b59c3);
233                 OP(FI, D, A, B, C,  3, 10, 0x8f0ccc92);
234                 OP(FI, C, D, A, B, 10, 15, 0xffeff47d);
235                 OP(FI, B, C, D, A,  1, 21, 0x85845dd1);
236                 OP(FI, A, B, C, D,  8,  6, 0x6fa87e4f);
237                 OP(FI, D, A, B, C, 15, 10, 0xfe2ce6e0);
238                 OP(FI, C, D, A, B,  6, 15, 0xa3014314);
239                 OP(FI, B, C, D, A, 13, 21, 0x4e0811a1);
240                 OP(FI, A, B, C, D,  4,  6, 0xf7537e82);
241                 OP(FI, D, A, B, C, 11, 10, 0xbd3af235);
242                 OP(FI, C, D, A, B,  2, 15, 0x2ad7d2bb);
243                 OP(FI, B, C, D, A,  9, 21, 0xeb86d391);
244
245 #undef OP
246
247                 /* Add the starting values of the context.  */
248                 A += A_save;
249                 B += B_save;
250                 C += C_save;
251                 D += D_save;
252         }
253
254         /* Put checksum in context given as argument.  */
255         ctx->A = A;
256         ctx->B = B;
257         ctx->C = C;
258         ctx->D = D;
259
260 #undef FF
261 #undef FG
262 #undef FH
263 #undef FI
264 #undef CYCLIC
265 }
266
267 /**
268  * Put result from 'ctx' in first 16 bytes of 'resbuf'.
269  * The result is always in little endian byte order,
270  * so that a byte-wise output yields to the wanted ASCII representation of the message digest.
271  */
272 static void *md5_read_ctx(const struct md5_ctx *ctx, void *resbuf)
273 {
274         md5_uint32 *digest = resbuf;
275         digest[0] = SWAP(ctx->A);
276         digest[1] = SWAP(ctx->B);
277         digest[2] = SWAP(ctx->C);
278         digest[3] = SWAP(ctx->D);
279
280         return resbuf;
281 }
282
283 /* Top level public functions. */
284
285 /** Compute MD5 message digest for bytes read from 'stream'.
286  *  The resulting message digest number will be written into the 16 bytes beginning at 'resblock'.
287  *  \return Non-zero if an error occurred.
288  */
289 int BLI_hash_md5_stream(FILE *stream, void *resblock)
290 {
291 #define BLOCKSIZE 4096  /* Important: must be a multiple of 64. */
292         struct md5_ctx ctx;
293         md5_uint32 len[2];
294         char buffer[BLOCKSIZE + 72];
295         size_t pad, sum;
296
297         /* Initialize the computation context. */
298         md5_init_ctx(&ctx);
299
300         len[0] = 0;
301         len[1] = 0;
302
303         /* Iterate over full file contents. */
304         while (1) {
305                 /* We read the file in blocks of BLOCKSIZE bytes.
306                  * One call of the computation function processes the whole buffer
307                  * so that with the next round of the loop another block can be read.
308                  */
309                 size_t n;
310                 sum = 0;
311
312                 /* Read block. Take care for partial reads. */
313                 do {
314                         n = fread(buffer, 1, BLOCKSIZE - sum, stream);
315                         sum += n;
316                 } while (sum < BLOCKSIZE && n != 0);
317
318                 if (n == 0 && ferror(stream))
319                         return 1;
320
321                 /* RFC 1321 specifies the possible length of the file up to 2^64 bits.
322                  * Here we only compute the number of bytes. Do a double word increment.
323                  */
324                 len[0] += sum;
325                 if (len[0] < sum)
326                         ++len[1];
327
328                 /* If end of file is reached, end the loop.  */
329                 if (n == 0)
330                         break;
331
332                 /* Process buffer with BLOCKSIZE bytes. Note that BLOCKSIZE % 64 == 0. */
333                 md5_process_block(buffer, BLOCKSIZE, &ctx);
334         }
335
336         /* We can copy 64 bytes because the buffer is always big enough.
337          * 'fillbuf' contains the needed bits. */
338         memcpy(&buffer[sum], fillbuf, 64);
339
340         /* Compute amount of padding bytes needed. Alignment is done to (N + PAD) % 64 == 56.
341          * There is always at least one byte padded, i.e. if the alignment is correctly aligned,
342          * 64 padding bytes are added.
343          */
344         pad = sum & 63;
345         pad = pad >= 56 ? 64 + 56 - pad : 56 - pad;
346
347         /* Put the 64-bit file length in *bits* at the end of the buffer. */
348         *(md5_uint32 *) &buffer[sum + pad] = SWAP(len[0] << 3);
349         *(md5_uint32 *) &buffer[sum + pad + 4] = SWAP((len[1] << 3) | (len[0] >> 29));
350
351         /* Process last bytes.  */
352         md5_process_block(buffer, sum + pad + 8, &ctx);
353
354         /* Construct result in desired memory.  */
355         md5_read_ctx(&ctx, resblock);
356         return 0;
357 }
358
359 /** Compute MD5 message digest for 'len' bytes beginning at 'buffer'.
360  *  The result is always in little endian byte order, so that a byte-wise output yields to the wanted
361  *  ASCII representation of the message digest.
362  */
363 void *BLI_hash_md5_buffer(const char *buffer, size_t len, void *resblock)
364 {
365         struct md5_ctx ctx;
366         char restbuf[64 + 72];
367         size_t blocks = len & ~63;
368         size_t pad, rest;
369
370         /* Initialize the computation context.  */
371         md5_init_ctx(&ctx);
372
373         /* Process whole buffer but last len % 64 bytes.  */
374         md5_process_block(buffer, blocks, &ctx);
375
376         /* REST bytes are not processed yet.  */
377         rest = len - blocks;
378         /* Copy to own buffer.  */
379         memcpy(restbuf, &buffer[blocks], rest);
380         /* Append needed fill bytes at end of buffer.
381          * We can copy 64 bytes because the buffer is always big enough. */
382         memcpy(&restbuf[rest], fillbuf, 64);
383
384         /* PAD bytes are used for padding to correct alignment.
385          * Note that always at least one byte is padded. */
386         pad = rest >= 56 ? 64 + 56 - rest : 56 - rest;
387
388         /* Put length of buffer in *bits* in last eight bytes. */
389         *(md5_uint32 *) &restbuf[rest + pad] = (md5_uint32) SWAP(len << 3);
390         *(md5_uint32 *) &restbuf[rest + pad + 4] = (md5_uint32) SWAP(len >> 29);
391
392         /* Process last bytes. */
393         md5_process_block(restbuf, rest + pad + 8, &ctx);
394
395         /* Put result in desired memory area. */
396         return md5_read_ctx(&ctx, resblock);
397 }
398
399 char *BLI_hash_md5_to_hexdigest(void *resblock, char r_hex_digest[33])
400 {
401         static const char hex_map[17] = "0123456789abcdef";
402         const unsigned char *p;
403         char *q;
404         short len;
405
406         for (q = r_hex_digest, p = (const unsigned char *)resblock, len = 0; len < 16; ++p, ++len) {
407                 const unsigned char c = *p;
408                 *q++ = hex_map[c >> 4];
409                 *q++ = hex_map[c & 15];
410         }
411         *q = '\0';
412
413         return r_hex_digest;
414 }