* keylist.c (show_policy_url, show_keyserver_url, show_notation)
[gnupg.git] / cipher / sha256.c
1 /* sha256.c - SHA256 hash function
2  *      Copyright (C) 2003 Free Software Foundation, Inc.
3  *
4  * Please see below for more legal information!
5  *
6  * This file is part of GnuPG.
7  *
8  * GnuPG is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * GnuPG is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
21  */
22
23
24 /*  Test vectors from FIPS-180-2:
25  *
26  *  "abc"
27  *  BA7816BF 8F01CFEA 414140DE 5DAE2223 B00361A3 96177A9C B410FF61 F20015AD
28  *
29  *  "abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"
30  *  248D6A61 D20638B8 E5C02693 0C3E6039 A33CE459 64FF2167 F6ECEDD4 19DB06C1
31  *
32  *  "a" x 1000000
33  *  CDC76E5C 9914FB92 81A1C7E2 84D73E67 F1809A48 A497200E 046D39CC C7112CD0
34  */
35
36
37 #include <config.h>
38 #include <string.h>
39 #include "util.h"
40 #include "algorithms.h"
41
42
43 typedef struct {
44     u32  h0,h1,h2,h3,h4,h5,h6,h7;
45     u32  nblocks;
46     byte buf[64];
47     int  count;
48 } SHA256_CONTEXT;
49
50 static void
51 burn_stack (int bytes)
52 {
53     char buf[128];
54
55     wipememory(buf,sizeof buf);
56     bytes -= sizeof buf;
57     if (bytes > 0)
58         burn_stack (bytes);
59 }
60
61
62 void
63 sha256_init( SHA256_CONTEXT *hd )
64 {
65     hd->h0 = 0x6a09e667;
66     hd->h1 = 0xbb67ae85;
67     hd->h2 = 0x3c6ef372;
68     hd->h3 = 0xa54ff53a;
69     hd->h4 = 0x510e527f;
70     hd->h5 = 0x9b05688c;
71     hd->h6 = 0x1f83d9ab;
72     hd->h7 = 0x5be0cd19;
73
74     hd->nblocks = 0;
75     hd->count = 0;
76 }
77
78
79 /****************
80  * Transform the message w which consists of 16 32-bit words
81  */
82 static void
83 transform( SHA256_CONTEXT *hd, byte *data )
84 {
85   u32 a,b,c,d,e,f,g,h;
86   u32 w[64];
87   int t;
88   static const u32 k[]=
89     {
90       0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1,
91       0x923f82a4, 0xab1c5ed5, 0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3,
92       0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174, 0xe49b69c1, 0xefbe4786,
93       0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
94       0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7, 0xc6e00bf3, 0xd5a79147,
95       0x06ca6351, 0x14292967, 0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13,
96       0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85, 0xa2bfe8a1, 0xa81a664b,
97       0xc24b8b70, 0xc76c51a3, 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
98       0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5, 0x391c0cb3, 0x4ed8aa4a,
99       0x5b9cca4f, 0x682e6ff3, 0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208,
100       0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2
101     };
102
103   /* get values from the chaining vars */
104   a = hd->h0;
105   b = hd->h1;
106   c = hd->h2;
107   d = hd->h3;
108   e = hd->h4;
109   f = hd->h5;
110   g = hd->h6;
111   h = hd->h7;
112
113 #ifdef BIG_ENDIAN_HOST
114   memcpy( w, data, 64 );
115 #else
116   {
117     int i;
118     byte *p2;
119
120     for(i=0, p2=(byte*)w; i < 16; i++, p2 += 4 )
121       {
122         p2[3] = *data++;
123         p2[2] = *data++;
124         p2[1] = *data++;
125         p2[0] = *data++;
126       }
127   }
128 #endif
129
130 #define ROTR(x,n) (((x)>>(n)) | ((x)<<(32-(n))))
131 #define Ch(x,y,z) (((x) & (y)) ^ ((~(x)) & (z)))
132 #define Maj(x,y,z) (((x) & (y)) ^ ((x) & (z)) ^ ((y) & (z)))
133 #define Sum0(x) (ROTR((x),2) ^ ROTR((x),13) ^ ROTR((x),22))
134 #define Sum1(x) (ROTR((x),6) ^ ROTR((x),11) ^ ROTR((x),25))
135 #define S0(x) (ROTR((x),7) ^ ROTR((x),18) ^ ((x)>>3))
136 #define S1(x) (ROTR((x),17) ^ ROTR((x),19) ^ ((x)>>10))
137
138   for(t=16;t<64;t++)
139     w[t] = S1(w[t-2]) + w[t-7] + S0(w[t-15]) + w[t-16];
140
141   for(t=0;t<64;t++)
142     {
143       u32 t1,t2;
144
145       t1=h+Sum1(e)+Ch(e,f,g)+k[t]+w[t];
146       t2=Sum0(a)+Maj(a,b,c);
147       h=g;
148       g=f;
149       f=e;
150       e=d+t1;
151       d=c;
152       c=b;
153       b=a;
154       a=t1+t2;
155       /* printf("t=%d a=%08lX b=%08lX c=%08lX d=%08lX e=%08lX f=%08lX g=%08lX h=%08lX\n",t,a,b,c,d,e,f,g,h); */
156     }
157
158   /* update chaining vars */
159   hd->h0 += a;
160   hd->h1 += b;
161   hd->h2 += c;
162   hd->h3 += d;
163   hd->h4 += e;
164   hd->h5 += f;
165   hd->h6 += g;
166   hd->h7 += h;
167 }
168
169
170 /* Update the message digest with the contents
171  * of INBUF with length INLEN.
172  */
173 static void
174 sha256_write( SHA256_CONTEXT *hd, byte *inbuf, size_t inlen)
175 {
176     if( hd->count == 64 ) { /* flush the buffer */
177         transform( hd, hd->buf );
178         burn_stack (328);
179         hd->count = 0;
180         hd->nblocks++;
181     }
182     if( !inbuf )
183         return;
184     if( hd->count ) {
185         for( ; inlen && hd->count < 64; inlen-- )
186             hd->buf[hd->count++] = *inbuf++;
187         sha256_write( hd, NULL, 0 );
188         if( !inlen )
189             return;
190     }
191
192     while( inlen >= 64 ) {
193         transform( hd, inbuf );
194         hd->count = 0;
195         hd->nblocks++;
196         inlen -= 64;
197         inbuf += 64;
198     }
199     burn_stack (328);
200     for( ; inlen && hd->count < 64; inlen-- )
201         hd->buf[hd->count++] = *inbuf++;
202 }
203
204
205 /* The routine final terminates the computation and
206  * returns the digest.
207  * The handle is prepared for a new cycle, but adding bytes to the
208  * handle will the destroy the returned buffer.
209  * Returns: 32 bytes representing the digest.
210  */
211
212 static void
213 sha256_final(SHA256_CONTEXT *hd)
214 {
215     u32 t, msb, lsb;
216     byte *p;
217
218     sha256_write(hd, NULL, 0); /* flush */;
219
220     t = hd->nblocks;
221     /* multiply by 64 to make a byte count */
222     lsb = t << 6;
223     msb = t >> 26;
224     /* add the count */
225     t = lsb;
226     if( (lsb += hd->count) < t )
227         msb++;
228     /* multiply by 8 to make a bit count */
229     t = lsb;
230     lsb <<= 3;
231     msb <<= 3;
232     msb |= t >> 29;
233
234     if( hd->count < 56 ) { /* enough room */
235         hd->buf[hd->count++] = 0x80; /* pad */
236         while( hd->count < 56 )
237             hd->buf[hd->count++] = 0;  /* pad */
238     }
239     else { /* need one extra block */
240         hd->buf[hd->count++] = 0x80; /* pad character */
241         while( hd->count < 64 )
242             hd->buf[hd->count++] = 0;
243         sha256_write(hd, NULL, 0);  /* flush */;
244         memset(hd->buf, 0, 56 ); /* fill next block with zeroes */
245     }
246     /* append the 64 bit count */
247     hd->buf[56] = msb >> 24;
248     hd->buf[57] = msb >> 16;
249     hd->buf[58] = msb >>  8;
250     hd->buf[59] = msb      ;
251     hd->buf[60] = lsb >> 24;
252     hd->buf[61] = lsb >> 16;
253     hd->buf[62] = lsb >>  8;
254     hd->buf[63] = lsb      ;
255     transform( hd, hd->buf );
256     burn_stack (328);
257
258     p = hd->buf;
259 #ifdef BIG_ENDIAN_HOST
260 #define X(a) do { *(u32*)p = hd->h##a ; p += 4; } while(0)
261 #else /* little endian */
262 #define X(a) do { *p++ = hd->h##a >> 24; *p++ = hd->h##a >> 16;  \
263                       *p++ = hd->h##a >> 8; *p++ = hd->h##a; } while(0)
264 #endif
265     X(0);
266     X(1);
267     X(2);
268     X(3);
269     X(4);
270     X(5);
271     X(6);
272     X(7);
273 #undef X
274 }
275
276 static byte *
277 sha256_read( SHA256_CONTEXT *hd )
278 {
279     return hd->buf;
280 }
281
282 /****************
283  * Return some information about the algorithm.  We need algo here to
284  * distinguish different flavors of the algorithm.
285  * Returns: A pointer to string describing the algorithm or NULL if
286  *          the ALGO is invalid.
287  */
288 const char *
289 sha256_get_info( int algo, size_t *contextsize,
290                  byte **r_asnoid, int *r_asnlen, int *r_mdlen,
291                  void (**r_init)( void *c ),
292                  void (**r_write)( void *c, byte *buf, size_t nbytes ),
293                  void (**r_final)( void *c ),
294                  byte *(**r_read)( void *c )
295                  )
296 {
297     static byte asn[] = /* Object ID is 2.16.840.1.101.3.4.2.1 */
298       { 
299         0x30, 0x31, 0x30, 0x0d, 0x06, 0x09, 0x60, 0x86,
300         0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, 0x05,
301         0x00, 0x04, 0x20
302       };
303
304     if( algo != 8 )
305         return NULL;
306
307     *contextsize = sizeof(SHA256_CONTEXT);
308     *r_asnoid = asn;
309     *r_asnlen = DIM(asn);
310     *r_mdlen = 32;
311     *(void  (**)(SHA256_CONTEXT *))r_init                 = sha256_init;
312     *(void  (**)(SHA256_CONTEXT *, byte*, size_t))r_write = sha256_write;
313     *(void  (**)(SHA256_CONTEXT *))r_final                = sha256_final;
314     *(byte *(**)(SHA256_CONTEXT *))r_read                 = sha256_read;
315
316     return "SHA256";
317 }