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