GCM: Add support for split data buffers and online operation
[libgcrypt.git] / cipher / sha1.c
1 /* sha1.c - SHA1 hash function
2  * Copyright (C) 1998, 2001, 2002, 2003, 2008 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20
21 /*  Test vectors:
22  *
23  *  "abc"
24  *  A999 3E36 4706 816A BA3E  2571 7850 C26C 9CD0 D89D
25  *
26  *  "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"
27  *  8498 3E44 1C3B D26E BAAE  4AA1 F951 29E5 E546 70F1
28  */
29
30
31 #include <config.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #ifdef HAVE_STDINT_H
36 # include <stdint.h>
37 #endif
38
39 #include "g10lib.h"
40 #include "bithelp.h"
41 #include "bufhelp.h"
42 #include "cipher.h"
43 #include "hash-common.h"
44
45
46 /* A macro to test whether P is properly aligned for an u32 type.
47    Note that config.h provides a suitable replacement for uintptr_t if
48    it does not exist in stdint.h.  */
49 /* #if __GNUC__ >= 2 */
50 /* # define U32_ALIGNED_P(p) (!(((uintptr_t)p) % __alignof__ (u32))) */
51 /* #else */
52 /* # define U32_ALIGNED_P(p) (!(((uintptr_t)p) % sizeof (u32))) */
53 /* #endif */
54
55 typedef struct
56 {
57   gcry_md_block_ctx_t bctx;
58   u32           h0,h1,h2,h3,h4;
59 } SHA1_CONTEXT;
60
61 static unsigned int
62 transform (void *c, const unsigned char *data);
63
64
65 static void
66 sha1_init (void *context)
67 {
68   SHA1_CONTEXT *hd = context;
69
70   hd->h0 = 0x67452301;
71   hd->h1 = 0xefcdab89;
72   hd->h2 = 0x98badcfe;
73   hd->h3 = 0x10325476;
74   hd->h4 = 0xc3d2e1f0;
75
76   hd->bctx.nblocks = 0;
77   hd->bctx.nblocks_high = 0;
78   hd->bctx.count = 0;
79   hd->bctx.blocksize = 64;
80   hd->bctx.bwrite = transform;
81 }
82
83
84 /* Round function macros. */
85 #define K1  0x5A827999L
86 #define K2  0x6ED9EBA1L
87 #define K3  0x8F1BBCDCL
88 #define K4  0xCA62C1D6L
89 #define F1(x,y,z)   ( z ^ ( x & ( y ^ z ) ) )
90 #define F2(x,y,z)   ( x ^ y ^ z )
91 #define F3(x,y,z)   ( ( x & y ) | ( z & ( x | y ) ) )
92 #define F4(x,y,z)   ( x ^ y ^ z )
93 #define M(i) ( tm =    x[ i    &0x0f]  \
94                      ^ x[(i-14)&0x0f]  \
95                      ^ x[(i-8) &0x0f]  \
96                      ^ x[(i-3) &0x0f], \
97                      (x[i&0x0f] = rol(tm, 1)))
98 #define R(a,b,c,d,e,f,k,m)  do { e += rol( a, 5 )     \
99                                       + f( b, c, d )  \
100                                       + k             \
101                                       + m;            \
102                                  b = rol( b, 30 );    \
103                                } while(0)
104
105
106 /*
107  * Transform NBLOCKS of each 64 bytes (16 32-bit words) at DATA.
108  */
109 static unsigned int
110 transform (void *ctx, const unsigned char *data)
111 {
112   SHA1_CONTEXT *hd = ctx;
113   const u32 *idata = (const void *)data;
114   register u32 a, b, c, d, e; /* Local copies of the chaining variables.  */
115   register u32 tm;            /* Helper.  */
116   u32 x[16];                  /* The array we work on. */
117
118 #define I(i) (x[i] = buf_get_be32(idata + i))
119
120       /* Get the values of the chaining variables. */
121       a = hd->h0;
122       b = hd->h1;
123       c = hd->h2;
124       d = hd->h3;
125       e = hd->h4;
126
127       /* Transform. */
128       R( a, b, c, d, e, F1, K1, I( 0) );
129       R( e, a, b, c, d, F1, K1, I( 1) );
130       R( d, e, a, b, c, F1, K1, I( 2) );
131       R( c, d, e, a, b, F1, K1, I( 3) );
132       R( b, c, d, e, a, F1, K1, I( 4) );
133       R( a, b, c, d, e, F1, K1, I( 5) );
134       R( e, a, b, c, d, F1, K1, I( 6) );
135       R( d, e, a, b, c, F1, K1, I( 7) );
136       R( c, d, e, a, b, F1, K1, I( 8) );
137       R( b, c, d, e, a, F1, K1, I( 9) );
138       R( a, b, c, d, e, F1, K1, I(10) );
139       R( e, a, b, c, d, F1, K1, I(11) );
140       R( d, e, a, b, c, F1, K1, I(12) );
141       R( c, d, e, a, b, F1, K1, I(13) );
142       R( b, c, d, e, a, F1, K1, I(14) );
143       R( a, b, c, d, e, F1, K1, I(15) );
144       R( e, a, b, c, d, F1, K1, M(16) );
145       R( d, e, a, b, c, F1, K1, M(17) );
146       R( c, d, e, a, b, F1, K1, M(18) );
147       R( b, c, d, e, a, F1, K1, M(19) );
148       R( a, b, c, d, e, F2, K2, M(20) );
149       R( e, a, b, c, d, F2, K2, M(21) );
150       R( d, e, a, b, c, F2, K2, M(22) );
151       R( c, d, e, a, b, F2, K2, M(23) );
152       R( b, c, d, e, a, F2, K2, M(24) );
153       R( a, b, c, d, e, F2, K2, M(25) );
154       R( e, a, b, c, d, F2, K2, M(26) );
155       R( d, e, a, b, c, F2, K2, M(27) );
156       R( c, d, e, a, b, F2, K2, M(28) );
157       R( b, c, d, e, a, F2, K2, M(29) );
158       R( a, b, c, d, e, F2, K2, M(30) );
159       R( e, a, b, c, d, F2, K2, M(31) );
160       R( d, e, a, b, c, F2, K2, M(32) );
161       R( c, d, e, a, b, F2, K2, M(33) );
162       R( b, c, d, e, a, F2, K2, M(34) );
163       R( a, b, c, d, e, F2, K2, M(35) );
164       R( e, a, b, c, d, F2, K2, M(36) );
165       R( d, e, a, b, c, F2, K2, M(37) );
166       R( c, d, e, a, b, F2, K2, M(38) );
167       R( b, c, d, e, a, F2, K2, M(39) );
168       R( a, b, c, d, e, F3, K3, M(40) );
169       R( e, a, b, c, d, F3, K3, M(41) );
170       R( d, e, a, b, c, F3, K3, M(42) );
171       R( c, d, e, a, b, F3, K3, M(43) );
172       R( b, c, d, e, a, F3, K3, M(44) );
173       R( a, b, c, d, e, F3, K3, M(45) );
174       R( e, a, b, c, d, F3, K3, M(46) );
175       R( d, e, a, b, c, F3, K3, M(47) );
176       R( c, d, e, a, b, F3, K3, M(48) );
177       R( b, c, d, e, a, F3, K3, M(49) );
178       R( a, b, c, d, e, F3, K3, M(50) );
179       R( e, a, b, c, d, F3, K3, M(51) );
180       R( d, e, a, b, c, F3, K3, M(52) );
181       R( c, d, e, a, b, F3, K3, M(53) );
182       R( b, c, d, e, a, F3, K3, M(54) );
183       R( a, b, c, d, e, F3, K3, M(55) );
184       R( e, a, b, c, d, F3, K3, M(56) );
185       R( d, e, a, b, c, F3, K3, M(57) );
186       R( c, d, e, a, b, F3, K3, M(58) );
187       R( b, c, d, e, a, F3, K3, M(59) );
188       R( a, b, c, d, e, F4, K4, M(60) );
189       R( e, a, b, c, d, F4, K4, M(61) );
190       R( d, e, a, b, c, F4, K4, M(62) );
191       R( c, d, e, a, b, F4, K4, M(63) );
192       R( b, c, d, e, a, F4, K4, M(64) );
193       R( a, b, c, d, e, F4, K4, M(65) );
194       R( e, a, b, c, d, F4, K4, M(66) );
195       R( d, e, a, b, c, F4, K4, M(67) );
196       R( c, d, e, a, b, F4, K4, M(68) );
197       R( b, c, d, e, a, F4, K4, M(69) );
198       R( a, b, c, d, e, F4, K4, M(70) );
199       R( e, a, b, c, d, F4, K4, M(71) );
200       R( d, e, a, b, c, F4, K4, M(72) );
201       R( c, d, e, a, b, F4, K4, M(73) );
202       R( b, c, d, e, a, F4, K4, M(74) );
203       R( a, b, c, d, e, F4, K4, M(75) );
204       R( e, a, b, c, d, F4, K4, M(76) );
205       R( d, e, a, b, c, F4, K4, M(77) );
206       R( c, d, e, a, b, F4, K4, M(78) );
207       R( b, c, d, e, a, F4, K4, M(79) );
208
209       /* Update the chaining variables. */
210       hd->h0 += a;
211       hd->h1 += b;
212       hd->h2 += c;
213       hd->h3 += d;
214       hd->h4 += e;
215
216   return /* burn_stack */ 88+4*sizeof(void*);
217 }
218
219
220 /* The routine final terminates the computation and
221  * returns the digest.
222  * The handle is prepared for a new cycle, but adding bytes to the
223  * handle will the destroy the returned buffer.
224  * Returns: 20 bytes representing the digest.
225  */
226
227 static void
228 sha1_final(void *context)
229 {
230   SHA1_CONTEXT *hd = context;
231   u32 t, th, msb, lsb;
232   unsigned char *p;
233   unsigned int burn;
234
235   _gcry_md_block_write (hd, NULL, 0); /* flush */;
236
237   t = hd->bctx.nblocks;
238   if (sizeof t == sizeof hd->bctx.nblocks)
239     th = hd->bctx.nblocks_high;
240   else
241     th = hd->bctx.nblocks >> 32;
242
243   /* multiply by 64 to make a byte count */
244   lsb = t << 6;
245   msb = (th << 6) | (t >> 26);
246   /* add the count */
247   t = lsb;
248   if( (lsb += hd->bctx.count) < t )
249     msb++;
250   /* multiply by 8 to make a bit count */
251   t = lsb;
252   lsb <<= 3;
253   msb <<= 3;
254   msb |= t >> 29;
255
256   if( hd->bctx.count < 56 )  /* enough room */
257     {
258       hd->bctx.buf[hd->bctx.count++] = 0x80; /* pad */
259       while( hd->bctx.count < 56 )
260         hd->bctx.buf[hd->bctx.count++] = 0;  /* pad */
261     }
262   else  /* need one extra block */
263     {
264       hd->bctx.buf[hd->bctx.count++] = 0x80; /* pad character */
265       while( hd->bctx.count < 64 )
266         hd->bctx.buf[hd->bctx.count++] = 0;
267       _gcry_md_block_write(hd, NULL, 0);  /* flush */;
268       memset(hd->bctx.buf, 0, 56 ); /* fill next block with zeroes */
269     }
270   /* append the 64 bit count */
271   buf_put_be32(hd->bctx.buf + 56, msb);
272   buf_put_be32(hd->bctx.buf + 60, lsb);
273   burn = transform( hd, hd->bctx.buf );
274   _gcry_burn_stack (burn);
275
276   p = hd->bctx.buf;
277 #define X(a) do { *(u32*)p = be_bswap32(hd->h##a) ; p += 4; } while(0)
278   X(0);
279   X(1);
280   X(2);
281   X(3);
282   X(4);
283 #undef X
284
285 }
286
287 static unsigned char *
288 sha1_read( void *context )
289 {
290   SHA1_CONTEXT *hd = context;
291
292   return hd->bctx.buf;
293 }
294
295 /****************
296  * Shortcut functions which puts the hash value of the supplied buffer
297  * into outbuf which must have a size of 20 bytes.
298  */
299 void
300 _gcry_sha1_hash_buffer (void *outbuf, const void *buffer, size_t length)
301 {
302   SHA1_CONTEXT hd;
303
304   sha1_init (&hd);
305   _gcry_md_block_write (&hd, buffer, length);
306   sha1_final (&hd);
307   memcpy (outbuf, hd.bctx.buf, 20);
308 }
309
310
311 /* Variant of the above shortcut function using a multiple buffers.  */
312 void
313 _gcry_sha1_hash_buffers (void *outbuf, const gcry_buffer_t *iov, int iovcnt)
314 {
315   SHA1_CONTEXT hd;
316
317   sha1_init (&hd);
318   for (;iovcnt > 0; iov++, iovcnt--)
319     _gcry_md_block_write (&hd,
320                           (const char*)iov[0].data + iov[0].off, iov[0].len);
321   sha1_final (&hd);
322   memcpy (outbuf, hd.bctx.buf, 20);
323 }
324
325
326 \f
327 /*
328      Self-test section.
329  */
330
331
332 static gpg_err_code_t
333 selftests_sha1 (int extended, selftest_report_func_t report)
334 {
335   const char *what;
336   const char *errtxt;
337
338   what = "short string";
339   errtxt = _gcry_hash_selftest_check_one
340     (GCRY_MD_SHA1, 0,
341      "abc", 3,
342      "\xA9\x99\x3E\x36\x47\x06\x81\x6A\xBA\x3E"
343      "\x25\x71\x78\x50\xC2\x6C\x9C\xD0\xD8\x9D", 20);
344   if (errtxt)
345     goto failed;
346
347   if (extended)
348     {
349       what = "long string";
350       errtxt = _gcry_hash_selftest_check_one
351         (GCRY_MD_SHA1, 0,
352          "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq", 56,
353          "\x84\x98\x3E\x44\x1C\x3B\xD2\x6E\xBA\xAE"
354          "\x4A\xA1\xF9\x51\x29\xE5\xE5\x46\x70\xF1", 20);
355       if (errtxt)
356         goto failed;
357
358       what = "one million \"a\"";
359       errtxt = _gcry_hash_selftest_check_one
360         (GCRY_MD_SHA1, 1,
361          NULL, 0,
362          "\x34\xAA\x97\x3C\xD4\xC4\xDA\xA4\xF6\x1E"
363          "\xEB\x2B\xDB\xAD\x27\x31\x65\x34\x01\x6F", 20);
364       if (errtxt)
365         goto failed;
366     }
367
368   return 0; /* Succeeded. */
369
370  failed:
371   if (report)
372     report ("digest", GCRY_MD_SHA1, what, errtxt);
373   return GPG_ERR_SELFTEST_FAILED;
374 }
375
376
377 /* Run a full self-test for ALGO and return 0 on success.  */
378 static gpg_err_code_t
379 run_selftests (int algo, int extended, selftest_report_func_t report)
380 {
381   gpg_err_code_t ec;
382
383   switch (algo)
384     {
385     case GCRY_MD_SHA1:
386       ec = selftests_sha1 (extended, report);
387       break;
388     default:
389       ec = GPG_ERR_DIGEST_ALGO;
390       break;
391
392     }
393   return ec;
394 }
395
396
397
398 \f
399 static unsigned char asn[15] = /* Object ID is 1.3.14.3.2.26 */
400   { 0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2b, 0x0e, 0x03,
401     0x02, 0x1a, 0x05, 0x00, 0x04, 0x14 };
402
403 static gcry_md_oid_spec_t oid_spec_sha1[] =
404   {
405     /* iso.member-body.us.rsadsi.pkcs.pkcs-1.5 (sha1WithRSAEncryption) */
406     { "1.2.840.113549.1.1.5" },
407     /* iso.member-body.us.x9-57.x9cm.3 (dsaWithSha1)*/
408     { "1.2.840.10040.4.3" },
409     /* from NIST's OIW  (sha1) */
410     { "1.3.14.3.2.26" },
411     /* from NIST OIW (sha-1WithRSAEncryption) */
412     { "1.3.14.3.2.29" },
413     /* iso.member-body.us.ansi-x9-62.signatures.ecdsa-with-sha1 */
414     { "1.2.840.10045.4.1" },
415     { NULL },
416   };
417
418 gcry_md_spec_t _gcry_digest_spec_sha1 =
419   {
420     GCRY_MD_SHA1, {0, 1},
421     "SHA1", asn, DIM (asn), oid_spec_sha1, 20,
422     sha1_init, _gcry_md_block_write, sha1_final, sha1_read,
423     sizeof (SHA1_CONTEXT),
424     run_selftests
425   };