Update
[gnupg.git] / cipher / md.c
1 /* md.c  -  message digest dispatcher
2  * Copyright (C) 1998, 1999, 2002, 2003, 2006 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG 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 General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <assert.h>
26 #include "util.h"
27 #include "cipher.h"
28 #include "errors.h"
29 #include "algorithms.h"
30 #include "i18n.h"
31
32 /****************
33  * This structure is used for the list of available algorithms
34  * and for the list of algorithms in MD_HANDLE.
35  */
36 struct md_digest_list_s {
37     struct md_digest_list_s *next;
38     const char *name;
39     int algo;
40     byte *asnoid;
41     int asnlen;
42     int mdlen;
43     void (*init)( void *c );
44     void (*write)( void *c, byte *buf, size_t nbytes );
45     void (*final)( void *c );
46     byte *(*read)( void *c );
47     size_t contextsize; /* allocate this amount of context */
48     PROPERLY_ALIGNED_TYPE context;
49 };
50
51 static struct md_digest_list_s *digest_list;
52
53
54 static struct md_digest_list_s *
55 new_list_item (int algo,
56                const char *(*get_info)( int, size_t*,byte**, int*, int*,
57                                        void (**)(void*),
58                                        void (**)(void*,byte*,size_t),
59                                        void (**)(void*),byte *(**)(void*)))
60 {
61   struct md_digest_list_s *r;
62
63   r = xmalloc_clear (sizeof *r );
64   r->algo = algo;
65   r->name = (*get_info)( algo, &r->contextsize,
66                          &r->asnoid, &r->asnlen, &r->mdlen,
67                          &r->init, &r->write, &r->final, &r->read );
68   if (!r->name ) 
69     {
70       xfree(r);
71       r = NULL;
72     }
73   if (r)
74     {
75       r->next = digest_list;
76       digest_list = r;
77     }
78   return r;
79 }
80
81
82
83 /*
84   Load all available hash algorithms and return true.  Subsequent
85   calls will return 0.  
86  */
87 static int
88 load_digest_module (void)
89 {
90   static int initialized = 0;
91
92   if (initialized)
93     return 0;
94   initialized = 1;
95
96   /* We load them in reverse order so that the most
97      frequently used are the first in the list. */
98 #ifdef USE_SHA512
99   if (!new_list_item (DIGEST_ALGO_SHA512, sha512_get_info)) 
100     BUG ();
101   if (!new_list_item (DIGEST_ALGO_SHA384, sha384_get_info)) 
102     BUG ();
103 #endif
104 #ifdef USE_SHA256
105   if (!new_list_item (DIGEST_ALGO_SHA256, sha256_get_info)) 
106     BUG ();
107   if (!new_list_item (DIGEST_ALGO_SHA224, sha224_get_info)) 
108     BUG ();
109 #endif
110   if (!new_list_item (DIGEST_ALGO_MD5, md5_get_info)) 
111     BUG ();
112   if (!new_list_item (DIGEST_ALGO_RMD160, rmd160_get_info)) 
113     BUG ();
114   if (!new_list_item (DIGEST_ALGO_SHA1, sha1_get_info)) 
115     BUG ();
116
117   return 1;
118 }      
119
120
121 /****************
122  * Map a string to the digest algo */
123 int
124 string_to_digest_algo( const char *string )
125 {
126     struct md_digest_list_s *r;
127
128     do {
129         for(r = digest_list; r; r = r->next )
130             if( !ascii_strcasecmp( r->name, string ) )
131                 return r->algo;
132     } while( !r && load_digest_module () );
133
134     /* Didn't find it, so try the Hx format */
135     if(string[0]=='H' || string[0]=='h')
136       {
137         long val;
138         char *endptr;
139
140         string++;
141
142         val=strtol(string,&endptr,10);
143         if(*string!='\0' && *endptr=='\0' && check_digest_algo(val)==0)
144           return val;
145       }
146
147     return 0;
148 }
149
150 /****************
151  * Map a digest algo to a string
152  */
153 const char *
154 digest_algo_to_string( int algo )
155 {
156     struct md_digest_list_s *r;
157
158     do {
159         for(r = digest_list; r; r = r->next )
160             if( r->algo == algo )
161                 return r->name;
162     } while( !r && load_digest_module () );
163     return NULL;
164 }
165
166
167 int
168 check_digest_algo( int algo )
169 {
170     struct md_digest_list_s *r;
171
172     do {
173         for(r = digest_list; r; r = r->next )
174             if( r->algo == algo )
175                 return 0;
176     } while( !r && load_digest_module () );
177     return G10ERR_DIGEST_ALGO;
178 }
179
180
181
182 /****************
183  * Open a message digest handle for use with algorithm ALGO.
184  * More algorithms may be added by md_enable(). The initial algorithm
185  * may be 0.
186  */
187 MD_HANDLE
188 md_open( int algo, int secure )
189 {
190     MD_HANDLE hd;
191     int bufsize;
192
193     if( secure ) {
194         bufsize = 512 - sizeof( *hd );
195         hd = xmalloc_secure_clear( sizeof *hd + bufsize );
196     }
197     else {
198         bufsize = 1024 - sizeof( *hd );
199         hd = xmalloc_clear( sizeof *hd + bufsize );
200     }
201
202     hd->bufsize = bufsize+1; /* hd has already one byte allocated */
203     hd->secure = secure;
204     if( algo )
205         md_enable( hd, algo );
206     fast_random_poll();
207     return hd;
208 }
209
210 void
211 md_enable( MD_HANDLE h, int algo )
212 {
213     struct md_digest_list_s *r, *ac;
214
215     for( ac=h->list; ac; ac = ac->next )
216         if( ac->algo == algo )
217             return ; /* already enabled */
218     /* find the algorithm */
219     do {
220         for(r = digest_list; r; r = r->next )
221             if( r->algo == algo )
222                 break;
223     } while( !r && load_digest_module () );
224     if( !r ) {
225         log_error("md_enable: algorithm %d not available\n", algo );
226         return;
227     }
228     /* and allocate a new list entry */
229     ac = h->secure? xmalloc_secure( sizeof *ac + r->contextsize
230                                                - sizeof(r->context) )
231                   : xmalloc( sizeof *ac + r->contextsize
232                                                - sizeof(r->context) );
233     *ac = *r;
234     ac->next = h->list;
235     h->list = ac;
236     /* and init this instance */
237     (*ac->init)( &ac->context.c );
238 }
239
240
241 MD_HANDLE
242 md_copy( MD_HANDLE a )
243 {
244     MD_HANDLE b;
245     struct md_digest_list_s *ar, *br;
246
247     if( a->bufcount )
248         md_write( a, NULL, 0 );
249     b = a->secure ? xmalloc_secure( sizeof *b + a->bufsize - 1 )
250                   : xmalloc( sizeof *b + a->bufsize - 1 );
251     memcpy( b, a, sizeof *a + a->bufsize - 1 );
252     b->list = NULL;
253     b->debug = NULL;
254     /* and now copy the complete list of algorithms */
255     /* I know that the copied list is reversed, but that doesn't matter */
256     for( ar=a->list; ar; ar = ar->next ) {
257         br = a->secure ? xmalloc_secure( sizeof *br + ar->contextsize
258                                                - sizeof(ar->context) )
259                        : xmalloc( sizeof *br + ar->contextsize
260                                                - sizeof(ar->context) );
261         memcpy( br, ar, sizeof(*br) + ar->contextsize
262                                     - sizeof(ar->context) );
263         br->next = b->list;
264         b->list = br;
265     }
266
267     if( a->debug )
268         md_start_debug( b, "unknown" );
269     return b;
270 }
271
272
273 /****************
274  * Reset all contexts and discard any buffered stuff.  This may be used
275  * instead of a md_close(); md_open().
276  */
277 void
278 md_reset( MD_HANDLE a )
279 {
280     struct md_digest_list_s *r;
281
282     a->bufcount = a->finalized = 0;
283     for( r=a->list; r; r = r->next ) {
284         memset( r->context.c, 0, r->contextsize );
285         (*r->init)( &r->context.c );
286     }
287 }
288
289
290 void
291 md_close(MD_HANDLE a)
292 {
293     struct md_digest_list_s *r, *r2;
294
295     if( !a )
296         return;
297     if( a->debug )
298         md_stop_debug(a);
299     for(r=a->list; r; r = r2 ) {
300         r2 = r->next;
301         xfree(r);
302     }
303     xfree(a);
304 }
305
306
307 void
308 md_write( MD_HANDLE a, const byte *inbuf, size_t inlen)
309 {
310     struct md_digest_list_s *r;
311
312     if( a->debug ) {
313         if( a->bufcount && fwrite(a->buffer, a->bufcount, 1, a->debug ) != 1 )
314             BUG();
315         if( inlen && fwrite(inbuf, inlen, 1, a->debug ) != 1 )
316             BUG();
317     }
318     for(r=a->list; r; r = r->next ) {
319         (*r->write)( &r->context.c, a->buffer, a->bufcount );
320         /* Fixme: all ->write fnc should take a const byte* */ 
321         (*r->write)( &r->context.c, (byte*)inbuf, inlen );
322     }
323     a->bufcount = 0;
324 }
325
326
327
328 void
329 md_final(MD_HANDLE a)
330 {
331     struct md_digest_list_s *r;
332
333     if( a->finalized )
334         return;
335
336     if( a->bufcount )
337         md_write( a, NULL, 0 );
338
339     for(r=a->list; r; r = r->next ) {
340         (*r->final)( &r->context.c );
341     }
342     a->finalized = 1;
343 }
344
345
346 /****************
347  * if ALGO is null get the digest for the used algo (which should be only one)
348  */
349 byte *
350 md_read( MD_HANDLE a, int algo )
351 {
352     struct md_digest_list_s *r;
353
354     if( !algo ) {  /* return the first algorithm */
355         if( (r=a->list) ) {
356             if( r->next )
357                 log_debug("more than algorithm in md_read(0)\n");
358             return (*r->read)( &r->context.c );
359         }
360     }
361     else {
362         for(r=a->list; r; r = r->next )
363             if( r->algo == algo )
364                 return (*r->read)( &r->context.c );
365     }
366     BUG();
367     return NULL;
368 }
369
370
371 /****************
372  * This function combines md_final and md_read but keeps the context
373  * intact.  This function can be used to calculate intermediate
374  * digests.  The digest is copied into buffer and the digestlength is
375  * returned.  If buffer is NULL only the needed size for buffer is returned.
376  * buflen gives the max size of buffer. If the buffer is too shourt to
377  * hold the complete digest, the buffer is filled with as many bytes are
378  * possible and this value is returned.
379  */
380 int
381 md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen )
382 {
383     struct md_digest_list_s *r = NULL;
384     char *context;
385     char *digest;
386
387     if( a->bufcount )
388         md_write( a, NULL, 0 );
389
390     if( !algo ) {  /* return digest for the first algorithm */
391         if( (r=a->list) && r->next )
392             log_debug("more than algorithm in md_digest(0)\n");
393     }
394     else {
395         for(r=a->list; r; r = r->next )
396             if( r->algo == algo )
397                 break;
398     }
399     if( !r )
400         BUG();
401
402     if( !buffer )
403         return r->mdlen;
404
405     /* I don't want to change the interface, so I simply work on a copy
406      * the context (extra overhead - should be fixed)*/
407     context = a->secure ? xmalloc_secure( r->contextsize )
408                         : xmalloc( r->contextsize );
409     memcpy( context, r->context.c, r->contextsize );
410     (*r->final)( context );
411     digest = (*r->read)( context );
412
413     if( buflen > r->mdlen )
414         buflen = r->mdlen;
415     memcpy( buffer, digest, buflen );
416
417     xfree(context);
418     return buflen;
419 }
420
421
422 int
423 md_get_algo( MD_HANDLE a )
424 {
425     struct md_digest_list_s *r;
426
427     if( (r=a->list) ) {
428         if( r->next )
429             log_error("WARNING: more than algorithm in md_get_algo()\n");
430         return r->algo;
431     }
432     return 0;
433 }
434
435 /* Returns true if a given algo is in use in a md */
436 int
437 md_algo_present( MD_HANDLE a, int algo )
438 {
439   struct md_digest_list_s *r=a->list;
440
441   while(r)
442     {
443       if(r->algo==algo)
444         return 1;
445
446       r=r->next;
447     }
448
449   return 0;
450 }
451
452 /****************
453  * Return the length of the digest
454  */
455 int
456 md_digest_length( int algo )
457 {
458     struct md_digest_list_s *r;
459
460     do {
461         for(r = digest_list; r; r = r->next ) {
462             if( r->algo == algo )
463                 return r->mdlen;
464         }
465     } while( !r && load_digest_module () );
466     log_error("WARNING: no length for md algo %d\n", algo);
467     return 0;
468 }
469
470
471 /* Hmmm: add a mode to enumerate the OIDs
472  *      to make g10/sig-check.c more portable */
473 const byte *
474 md_asn_oid( int algo, size_t *asnlen, size_t *mdlen )
475 {
476     struct md_digest_list_s *r;
477
478     do {
479         for(r = digest_list; r; r = r->next ) {
480             if( r->algo == algo ) {
481                 if( asnlen )
482                     *asnlen = r->asnlen;
483                 if( mdlen )
484                     *mdlen = r->mdlen;
485                 return r->asnoid;
486             }
487         }
488     } while( !r && load_digest_module () );
489     log_bug("no asn for md algo %d\n", algo);
490     return NULL;
491 }
492
493
494 void
495 md_start_debug( MD_HANDLE md, const char *suffix )
496 {
497     static int idx=0;
498     char buf[25];
499
500     if( md->debug ) {
501         log_debug("Oops: md debug already started\n");
502         return;
503     }
504     idx++;
505     sprintf(buf, "dbgmd-%05d" EXTSEP_S "%.10s", idx, suffix );
506     md->debug = fopen(buf, "wb");
507     if( !md->debug )
508         log_debug("md debug: can't open %s\n", buf );
509 }
510
511 void
512 md_stop_debug( MD_HANDLE md )
513 {
514     if( md->debug ) {
515         if( md->bufcount )
516             md_write( md, NULL, 0 );
517         fclose(md->debug);
518         md->debug = NULL;
519     }
520 #ifdef HAVE_U64_TYPEDEF
521     {  /* a kludge to pull in the __muldi3 for Solaris */
522        volatile u32 a = (u32)(ulong)md;
523        volatile u64 b = 42;
524        volatile u64 c;
525        c = a * b;
526     }
527 #endif
528 }