* w32reg.c (read_w32_registry_string): Fallback to HLM.
[gnupg.git] / cipher / md.c
1 /* md.c  -  message digest dispatcher
2  *      Copyright (C) 1998, 1999, 2002 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include "util.h"
28 #include "cipher.h"
29 #include "errors.h"
30 #include "algorithms.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 = m_alloc_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       m_free(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_TIGER
99   if (!new_list_item (DIGEST_ALGO_TIGER, tiger_get_info))
100     BUG();
101 #endif
102   if (!new_list_item (DIGEST_ALGO_MD5, md5_get_info)) 
103     BUG ();
104   if (!new_list_item (DIGEST_ALGO_RMD160, rmd160_get_info)) 
105     BUG ();
106   if (!new_list_item (DIGEST_ALGO_SHA1, sha1_get_info)) 
107     BUG ();
108
109   return 1;
110 }      
111
112
113 /****************
114  * Map a string to the digest algo */
115 int
116 string_to_digest_algo( const char *string )
117 {
118     struct md_digest_list_s *r;
119
120     do {
121         for(r = digest_list; r; r = r->next )
122             if( !ascii_strcasecmp( r->name, string ) )
123                 return r->algo;
124     } while( !r && load_digest_module () );
125     return 0;
126 }
127
128
129 /****************
130  * Map a digest algo to a string
131  */
132 const char *
133 digest_algo_to_string( int algo )
134 {
135     struct md_digest_list_s *r;
136
137     do {
138         for(r = digest_list; r; r = r->next )
139             if( r->algo == algo )
140                 return r->name;
141     } while( !r && load_digest_module () );
142     return NULL;
143 }
144
145
146 int
147 check_digest_algo( int algo )
148 {
149     struct md_digest_list_s *r;
150
151     do {
152         for(r = digest_list; r; r = r->next )
153             if( r->algo == algo )
154                 return 0;
155     } while( !r && load_digest_module () );
156     return G10ERR_DIGEST_ALGO;
157 }
158
159
160
161 /****************
162  * Open a message digest handle for use with algorithm ALGO.
163  * More algorithms may be added by md_enable(). The initial algorithm
164  * may be 0.
165  */
166 MD_HANDLE
167 md_open( int algo, int secure )
168 {
169     MD_HANDLE hd;
170     int bufsize;
171
172     if( secure ) {
173         bufsize = 512 - sizeof( *hd );
174         hd = m_alloc_secure_clear( sizeof *hd + bufsize );
175     }
176     else {
177         bufsize = 1024 - sizeof( *hd );
178         hd = m_alloc_clear( sizeof *hd + bufsize );
179     }
180
181     hd->bufsize = bufsize+1; /* hd has already one byte allocated */
182     hd->secure = secure;
183     if( algo )
184         md_enable( hd, algo );
185     fast_random_poll();
186     return hd;
187 }
188
189 void
190 md_enable( MD_HANDLE h, int algo )
191 {
192     struct md_digest_list_s *r, *ac;
193
194     for( ac=h->list; ac; ac = ac->next )
195         if( ac->algo == algo )
196             return ; /* already enabled */
197     /* find the algorithm */
198     do {
199         for(r = digest_list; r; r = r->next )
200             if( r->algo == algo )
201                 break;
202     } while( !r && load_digest_module () );
203     if( !r ) {
204         log_error("md_enable: algorithm %d not available\n", algo );
205         return;
206     }
207     /* and allocate a new list entry */
208     ac = h->secure? m_alloc_secure( sizeof *ac + r->contextsize
209                                                - sizeof(r->context) )
210                   : m_alloc( sizeof *ac + r->contextsize
211                                                - sizeof(r->context) );
212     *ac = *r;
213     ac->next = h->list;
214     h->list = ac;
215     /* and init this instance */
216     (*ac->init)( &ac->context.c );
217 }
218
219
220 MD_HANDLE
221 md_copy( MD_HANDLE a )
222 {
223     MD_HANDLE b;
224     struct md_digest_list_s *ar, *br;
225
226     if( a->bufcount )
227         md_write( a, NULL, 0 );
228     b = a->secure ? m_alloc_secure( sizeof *b + a->bufsize - 1 )
229                   : m_alloc( sizeof *b + a->bufsize - 1 );
230     memcpy( b, a, sizeof *a + a->bufsize - 1 );
231     b->list = NULL;
232     b->debug = NULL;
233     /* and now copy the complete list of algorithms */
234     /* I know that the copied list is reversed, but that doesn't matter */
235     for( ar=a->list; ar; ar = ar->next ) {
236         br = a->secure ? m_alloc_secure( sizeof *br + ar->contextsize
237                                                - sizeof(ar->context) )
238                        : m_alloc( sizeof *br + ar->contextsize
239                                                - sizeof(ar->context) );
240         memcpy( br, ar, sizeof(*br) + ar->contextsize
241                                     - sizeof(ar->context) );
242         br->next = b->list;
243         b->list = br;
244     }
245
246     if( a->debug )
247         md_start_debug( b, "unknown" );
248     return b;
249 }
250
251
252 /****************
253  * Reset all contexts and discard any buffered stuff.  This may be used
254  * instead of a md_close(); md_open().
255  */
256 void
257 md_reset( MD_HANDLE a )
258 {
259     struct md_digest_list_s *r;
260
261     a->bufcount = a->finalized = 0;
262     for( r=a->list; r; r = r->next ) {
263         memset( r->context.c, 0, r->contextsize );
264         (*r->init)( &r->context.c );
265     }
266 }
267
268
269 void
270 md_close(MD_HANDLE a)
271 {
272     struct md_digest_list_s *r, *r2;
273
274     if( !a )
275         return;
276     if( a->debug )
277         md_stop_debug(a);
278     for(r=a->list; r; r = r2 ) {
279         r2 = r->next;
280         m_free(r);
281     }
282     m_free(a);
283 }
284
285
286 void
287 md_write( MD_HANDLE a, const byte *inbuf, size_t inlen)
288 {
289     struct md_digest_list_s *r;
290
291     if( a->debug ) {
292         if( a->bufcount && fwrite(a->buffer, a->bufcount, 1, a->debug ) != 1 )
293             BUG();
294         if( inlen && fwrite(inbuf, inlen, 1, a->debug ) != 1 )
295             BUG();
296     }
297     for(r=a->list; r; r = r->next ) {
298         (*r->write)( &r->context.c, a->buffer, a->bufcount );
299         /* Fixme: all ->write fnc should take a const byte* */ 
300         (*r->write)( &r->context.c, (byte*)inbuf, inlen );
301     }
302     a->bufcount = 0;
303 }
304
305
306
307 void
308 md_final(MD_HANDLE a)
309 {
310     struct md_digest_list_s *r;
311
312     if( a->finalized )
313         return;
314
315     if( a->bufcount )
316         md_write( a, NULL, 0 );
317
318     for(r=a->list; r; r = r->next ) {
319         (*r->final)( &r->context.c );
320     }
321     a->finalized = 1;
322 }
323
324
325 /****************
326  * if ALGO is null get the digest for the used algo (which should be only one)
327  */
328 byte *
329 md_read( MD_HANDLE a, int algo )
330 {
331     struct md_digest_list_s *r;
332
333     if( !algo ) {  /* return the first algorithm */
334         if( (r=a->list) ) {
335             if( r->next )
336                 log_debug("more than algorithm in md_read(0)\n");
337             return (*r->read)( &r->context.c );
338         }
339     }
340     else {
341         for(r=a->list; r; r = r->next )
342             if( r->algo == algo )
343                 return (*r->read)( &r->context.c );
344     }
345     BUG();
346     return NULL;
347 }
348
349
350 /****************
351  * This function combines md_final and md_read but keeps the context
352  * intact.  This function can be used to calculate intermediate
353  * digests.  The digest is copied into buffer and the digestlength is
354  * returned.  If buffer is NULL only the needed size for buffer is returned.
355  * buflen gives the max size of buffer. If the buffer is too shourt to
356  * hold the complete digest, the buffer is filled with as many bytes are
357  * possible and this value is returned.
358  */
359 int
360 md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen )
361 {
362     struct md_digest_list_s *r = NULL;
363     char *context;
364     char *digest;
365
366     if( a->bufcount )
367         md_write( a, NULL, 0 );
368
369     if( !algo ) {  /* return digest for the first algorithm */
370         if( (r=a->list) && r->next )
371             log_debug("more than algorithm in md_digest(0)\n");
372     }
373     else {
374         for(r=a->list; r; r = r->next )
375             if( r->algo == algo )
376                 break;
377     }
378     if( !r )
379         BUG();
380
381     if( !buffer )
382         return r->mdlen;
383
384     /* I don't want to change the interface, so I simply work on a copy
385      * the context (extra overhead - should be fixed)*/
386     context = a->secure ? m_alloc_secure( r->contextsize )
387                         : m_alloc( r->contextsize );
388     memcpy( context, r->context.c, r->contextsize );
389     (*r->final)( context );
390     digest = (*r->read)( context );
391
392     if( buflen > r->mdlen )
393         buflen = r->mdlen;
394     memcpy( buffer, digest, buflen );
395
396     m_free(context);
397     return buflen;
398 }
399
400
401 int
402 md_get_algo( MD_HANDLE a )
403 {
404     struct md_digest_list_s *r;
405
406     if( (r=a->list) ) {
407         if( r->next )
408             log_error("WARNING: more than algorithm in md_get_algo()\n");
409         return r->algo;
410     }
411     return 0;
412 }
413
414 /* Returns true if a given algo is in use in a md */
415 int
416 md_algo_present( MD_HANDLE a, int algo )
417 {
418   struct md_digest_list_s *r=a->list;
419
420   while(r)
421     {
422       if(r->algo==algo)
423         return 1;
424
425       r=r->next;
426     }
427
428   return 0;
429 }
430
431 /****************
432  * Return the length of the digest
433  */
434 int
435 md_digest_length( int algo )
436 {
437     struct md_digest_list_s *r;
438
439     do {
440         for(r = digest_list; r; r = r->next ) {
441             if( r->algo == algo )
442                 return r->mdlen;
443         }
444     } while( !r && load_digest_module () );
445     log_error("WARNING: no length for md algo %d\n", algo);
446     return 0;
447 }
448
449
450 /* Hmmm: add a mode to enumerate the OIDs
451  *      to make g10/sig-check.c more portable */
452 const byte *
453 md_asn_oid( int algo, size_t *asnlen, size_t *mdlen )
454 {
455     struct md_digest_list_s *r;
456
457     do {
458         for(r = digest_list; r; r = r->next ) {
459             if( r->algo == algo ) {
460                 if( asnlen )
461                     *asnlen = r->asnlen;
462                 if( mdlen )
463                     *mdlen = r->mdlen;
464                 return r->asnoid;
465             }
466         }
467     } while( !r && load_digest_module () );
468     log_bug("no asn for md algo %d\n", algo);
469     return NULL;
470 }
471
472
473 void
474 md_start_debug( MD_HANDLE md, const char *suffix )
475 {
476     static int idx=0;
477     char buf[25];
478
479     if( md->debug ) {
480         log_debug("Oops: md debug already started\n");
481         return;
482     }
483     idx++;
484     sprintf(buf, "dbgmd-%05d" EXTSEP_S "%.10s", idx, suffix );
485     md->debug = fopen(buf, "w");
486     if( !md->debug )
487         log_debug("md debug: can't open %s\n", buf );
488 }
489
490 void
491 md_stop_debug( MD_HANDLE md )
492 {
493     if( md->debug ) {
494         if( md->bufcount )
495             md_write( md, NULL, 0 );
496         fclose(md->debug);
497         md->debug = NULL;
498     }
499 #ifdef HAVE_U64_TYPEDEF
500     {  /* a kludge to pull in the __muldi3 for Solaris */
501        volatile u32 a = (u32)(ulong)md;
502        volatile u64 b = 42;
503        volatile u64 c;
504        c = a * b;
505     }
506 #endif
507 }