A lot of cleanups as well as minor API changes.
[libgcrypt.git] / cipher / sha1.c
1 /* sha1.c - SHA1 hash function
2  *      Copyright (C) 1998, 2001, 2002, 2003 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21
22 /*  Test vectors:
23  *
24  *  "abc"
25  *  A999 3E36 4706 816A BA3E  2571 7850 C26C 9CD0 D89D
26  *
27  *  "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"
28  *  8498 3E44 1C3B D26E BAAE  4AA1 F951 29E5 E546 70F1
29  */
30
31
32 #include <config.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <string.h>
36
37 #include "g10lib.h"
38 #include "memory.h"
39 #include "bithelp.h"
40 #include "cipher.h"
41
42 typedef struct {
43     u32  h0,h1,h2,h3,h4;
44     u32  nblocks;
45     byte buf[64];
46     int  count;
47 } SHA1_CONTEXT;
48
49
50 static void
51 sha1_init (void *context)
52 {
53   SHA1_CONTEXT *hd = context;
54
55   hd->h0 = 0x67452301;
56   hd->h1 = 0xefcdab89;
57   hd->h2 = 0x98badcfe;
58   hd->h3 = 0x10325476;
59   hd->h4 = 0xc3d2e1f0;
60   hd->nblocks = 0;
61   hd->count = 0;
62 }
63
64
65 /****************
66  * Transform the message X which consists of 16 32-bit-words
67  */
68 static void
69 transform ( SHA1_CONTEXT *hd, const unsigned char *data )
70 {
71   register u32 a,b,c,d,e,tm;
72   u32 x[16];
73
74   /* Get values from the chaining vars. */
75   a = hd->h0;
76   b = hd->h1;
77   c = hd->h2;
78   d = hd->h3;
79   e = hd->h4;
80
81 #ifdef WORDS_BIGENDIAN
82   memcpy( x, data, 64 );
83 #else
84   {
85     int i;
86     byte *p2;
87     for(i=0, p2=(byte*)x; i < 16; i++, p2 += 4 )
88       {
89         p2[3] = *data++;
90         p2[2] = *data++;
91         p2[1] = *data++;
92         p2[0] = *data++;
93       }
94   }
95 #endif
96
97
98 #define K1  0x5A827999L
99 #define K2  0x6ED9EBA1L
100 #define K3  0x8F1BBCDCL
101 #define K4  0xCA62C1D6L
102 #define F1(x,y,z)   ( z ^ ( x & ( y ^ z ) ) )
103 #define F2(x,y,z)   ( x ^ y ^ z )
104 #define F3(x,y,z)   ( ( x & y ) | ( z & ( x | y ) ) )
105 #define F4(x,y,z)   ( x ^ y ^ z )
106
107
108 #define M(i) ( tm =   x[i&0x0f] ^ x[(i-14)&0x0f] \
109                     ^ x[(i-8)&0x0f] ^ x[(i-3)&0x0f] \
110                , (x[i&0x0f] = rol(tm, 1)) )
111
112 #define R(a,b,c,d,e,f,k,m)  do { e += rol( a, 5 )     \
113                                       + f( b, c, d )  \
114                                       + k             \
115                                       + m;            \
116                                  b = rol( b, 30 );    \
117                                } while(0)
118   R( a, b, c, d, e, F1, K1, x[ 0] );
119   R( e, a, b, c, d, F1, K1, x[ 1] );
120   R( d, e, a, b, c, F1, K1, x[ 2] );
121   R( c, d, e, a, b, F1, K1, x[ 3] );
122   R( b, c, d, e, a, F1, K1, x[ 4] );
123   R( a, b, c, d, e, F1, K1, x[ 5] );
124   R( e, a, b, c, d, F1, K1, x[ 6] );
125   R( d, e, a, b, c, F1, K1, x[ 7] );
126   R( c, d, e, a, b, F1, K1, x[ 8] );
127   R( b, c, d, e, a, F1, K1, x[ 9] );
128   R( a, b, c, d, e, F1, K1, x[10] );
129   R( e, a, b, c, d, F1, K1, x[11] );
130   R( d, e, a, b, c, F1, K1, x[12] );
131   R( c, d, e, a, b, F1, K1, x[13] );
132   R( b, c, d, e, a, F1, K1, x[14] );
133   R( a, b, c, d, e, F1, K1, x[15] );
134   R( e, a, b, c, d, F1, K1, M(16) );
135   R( d, e, a, b, c, F1, K1, M(17) );
136   R( c, d, e, a, b, F1, K1, M(18) );
137   R( b, c, d, e, a, F1, K1, M(19) );
138   R( a, b, c, d, e, F2, K2, M(20) );
139   R( e, a, b, c, d, F2, K2, M(21) );
140   R( d, e, a, b, c, F2, K2, M(22) );
141   R( c, d, e, a, b, F2, K2, M(23) );
142   R( b, c, d, e, a, F2, K2, M(24) );
143   R( a, b, c, d, e, F2, K2, M(25) );
144   R( e, a, b, c, d, F2, K2, M(26) );
145   R( d, e, a, b, c, F2, K2, M(27) );
146   R( c, d, e, a, b, F2, K2, M(28) );
147   R( b, c, d, e, a, F2, K2, M(29) );
148   R( a, b, c, d, e, F2, K2, M(30) );
149   R( e, a, b, c, d, F2, K2, M(31) );
150   R( d, e, a, b, c, F2, K2, M(32) );
151   R( c, d, e, a, b, F2, K2, M(33) );
152   R( b, c, d, e, a, F2, K2, M(34) );
153   R( a, b, c, d, e, F2, K2, M(35) );
154   R( e, a, b, c, d, F2, K2, M(36) );
155   R( d, e, a, b, c, F2, K2, M(37) );
156   R( c, d, e, a, b, F2, K2, M(38) );
157   R( b, c, d, e, a, F2, K2, M(39) );
158   R( a, b, c, d, e, F3, K3, M(40) );
159   R( e, a, b, c, d, F3, K3, M(41) );
160   R( d, e, a, b, c, F3, K3, M(42) );
161   R( c, d, e, a, b, F3, K3, M(43) );
162   R( b, c, d, e, a, F3, K3, M(44) );
163   R( a, b, c, d, e, F3, K3, M(45) );
164   R( e, a, b, c, d, F3, K3, M(46) );
165   R( d, e, a, b, c, F3, K3, M(47) );
166   R( c, d, e, a, b, F3, K3, M(48) );
167   R( b, c, d, e, a, F3, K3, M(49) );
168   R( a, b, c, d, e, F3, K3, M(50) );
169   R( e, a, b, c, d, F3, K3, M(51) );
170   R( d, e, a, b, c, F3, K3, M(52) );
171   R( c, d, e, a, b, F3, K3, M(53) );
172   R( b, c, d, e, a, F3, K3, M(54) );
173   R( a, b, c, d, e, F3, K3, M(55) );
174   R( e, a, b, c, d, F3, K3, M(56) );
175   R( d, e, a, b, c, F3, K3, M(57) );
176   R( c, d, e, a, b, F3, K3, M(58) );
177   R( b, c, d, e, a, F3, K3, M(59) );
178   R( a, b, c, d, e, F4, K4, M(60) );
179   R( e, a, b, c, d, F4, K4, M(61) );
180   R( d, e, a, b, c, F4, K4, M(62) );
181   R( c, d, e, a, b, F4, K4, M(63) );
182   R( b, c, d, e, a, F4, K4, M(64) );
183   R( a, b, c, d, e, F4, K4, M(65) );
184   R( e, a, b, c, d, F4, K4, M(66) );
185   R( d, e, a, b, c, F4, K4, M(67) );
186   R( c, d, e, a, b, F4, K4, M(68) );
187   R( b, c, d, e, a, F4, K4, M(69) );
188   R( a, b, c, d, e, F4, K4, M(70) );
189   R( e, a, b, c, d, F4, K4, M(71) );
190   R( d, e, a, b, c, F4, K4, M(72) );
191   R( c, d, e, a, b, F4, K4, M(73) );
192   R( b, c, d, e, a, F4, K4, M(74) );
193   R( a, b, c, d, e, F4, K4, M(75) );
194   R( e, a, b, c, d, F4, K4, M(76) );
195   R( d, e, a, b, c, F4, K4, M(77) );
196   R( c, d, e, a, b, F4, K4, M(78) );
197   R( b, c, d, e, a, F4, K4, M(79) );
198
199   /* Update chaining vars. */
200   hd->h0 += a;
201   hd->h1 += b;
202   hd->h2 += c;
203   hd->h3 += d;
204   hd->h4 += e;
205 }
206
207
208 /* Update the message digest with the contents
209  * of INBUF with length INLEN.
210  */
211 static void
212 sha1_write( void *context, const void *inbuf_arg, size_t inlen)
213 {
214   const unsigned char *inbuf = inbuf_arg;
215   SHA1_CONTEXT *hd = context;
216
217   if( hd->count == 64 )  /* flush the buffer */
218     {
219       transform( hd, hd->buf );
220       _gcry_burn_stack (88+4*sizeof(void*));
221       hd->count = 0;
222       hd->nblocks++;
223     }
224   if( !inbuf )
225     return;
226
227   if( hd->count )
228     {
229       for( ; inlen && hd->count < 64; inlen-- )
230         hd->buf[hd->count++] = *inbuf++;
231       sha1_write( hd, NULL, 0 );
232       if( !inlen )
233         return;
234     }
235
236   while( inlen >= 64 ) 
237     {
238       transform( hd, inbuf );
239       hd->count = 0;
240       hd->nblocks++;
241       inlen -= 64;
242       inbuf += 64;
243     }
244   _gcry_burn_stack (88+4*sizeof(void*));
245   for( ; inlen && hd->count < 64; inlen-- )
246     hd->buf[hd->count++] = *inbuf++;
247 }
248
249
250 /* The routine final terminates the computation and
251  * returns the digest.
252  * The handle is prepared for a new cycle, but adding bytes to the
253  * handle will the destroy the returned buffer.
254  * Returns: 20 bytes representing the digest.
255  */
256
257 static void
258 sha1_final(void *context)
259 {
260   SHA1_CONTEXT *hd = context;
261   
262   u32 t, msb, lsb;
263   byte *p;
264
265   sha1_write(hd, NULL, 0); /* flush */;
266
267   t = hd->nblocks;
268   /* multiply by 64 to make a byte count */
269   lsb = t << 6;
270   msb = t >> 26;
271   /* add the count */
272   t = lsb;
273   if( (lsb += hd->count) < t )
274     msb++;
275   /* multiply by 8 to make a bit count */
276   t = lsb;
277   lsb <<= 3;
278   msb <<= 3;
279   msb |= t >> 29;
280
281   if( hd->count < 56 )  /* enough room */
282     {
283       hd->buf[hd->count++] = 0x80; /* pad */
284       while( hd->count < 56 )
285         hd->buf[hd->count++] = 0;  /* pad */
286     }
287   else  /* need one extra block */
288     {
289       hd->buf[hd->count++] = 0x80; /* pad character */
290       while( hd->count < 64 )
291         hd->buf[hd->count++] = 0;
292       sha1_write(hd, NULL, 0);  /* flush */;
293       memset(hd->buf, 0, 56 ); /* fill next block with zeroes */
294     }
295   /* append the 64 bit count */
296   hd->buf[56] = msb >> 24;
297   hd->buf[57] = msb >> 16;
298   hd->buf[58] = msb >>  8;
299   hd->buf[59] = msb        ;
300   hd->buf[60] = lsb >> 24;
301   hd->buf[61] = lsb >> 16;
302   hd->buf[62] = lsb >>  8;
303   hd->buf[63] = lsb        ;
304   transform( hd, hd->buf );
305   _gcry_burn_stack (88+4*sizeof(void*));
306
307   p = hd->buf;
308 #ifdef WORDS_BIGENDIAN
309 #define X(a) do { *(u32*)p = hd->h##a ; p += 4; } while(0)
310 #else /* little endian */
311 #define X(a) do { *p++ = hd->h##a >> 24; *p++ = hd->h##a >> 16;  \
312                   *p++ = hd->h##a >> 8; *p++ = hd->h##a; } while(0)
313 #endif
314   X(0);
315   X(1);
316   X(2);
317   X(3);
318   X(4);
319 #undef X
320
321 }
322
323 static byte *
324 sha1_read( void *context )
325 {
326   SHA1_CONTEXT *hd = context;
327
328   return hd->buf;
329 }
330
331 /****************
332  * Shortcut functions which puts the hash value of the supplied buffer
333  * into outbuf which must have a size of 20 bytes.
334  */
335 void
336 _gcry_sha1_hash_buffer (void *outbuf, const void *buffer, size_t length)
337 {
338   SHA1_CONTEXT hd;
339
340   sha1_init (&hd);
341   sha1_write (&hd, buffer, length);
342   sha1_final (&hd);
343   memcpy (outbuf, hd.buf, 20);
344 }
345
346
347 static byte asn[15] = /* Object ID is 1.3.14.3.2.26 */
348   { 0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2b, 0x0e, 0x03,
349     0x02, 0x1a, 0x05, 0x00, 0x04, 0x14 };
350
351 static gcry_md_oid_spec_t oid_spec_sha1[] =
352   {
353     /* iso.member-body.us.rsadsi.pkcs.pkcs-1.5 (sha1WithRSAEncryption) */
354     { "1.2.840.113549.1.1.5" },
355     /* iso.member-body.us.x9-57.x9cm.3 (dsaWithSha1)*/
356     { "1.2.840.10040.4.3" },
357     /* from NIST's OIW  (sha1) */
358     { "1.3.14.3.2.26" },
359     /* from NIST OIW (sha-1WithRSAEncryption) */
360     { "1.3.14.3.2.29" },
361     { NULL },
362   };
363
364 gcry_md_spec_t _gcry_digest_spec_sha1 =
365   {
366     "SHA1", asn, DIM (asn), oid_spec_sha1, 20,
367     sha1_init, sha1_write, sha1_final, sha1_read,
368     sizeof (SHA1_CONTEXT)
369   };