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