See ChangeLog: Wed Feb 10 17:15:39 CET 1999 Werner Koch
[gnupg.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     char context[1];
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                   : m_alloc( sizeof *ac + r->contextsize );
243     *ac = *r;
244     ac->next = h->list;
245     h->list = ac;
246     /* and init this instance */
247     (*ac->init)( &ac->context );
248 }
249
250
251 MD_HANDLE
252 md_copy( MD_HANDLE a )
253 {
254     MD_HANDLE b;
255     struct md_digest_list_s *ar, *br;
256
257     if( a->bufcount )
258         md_write( a, NULL, 0 );
259     b = a->secure ? m_alloc_secure( sizeof *b + a->bufsize - 1 )
260                   : m_alloc( sizeof *b + a->bufsize - 1 );
261     memcpy( b, a, sizeof *a + a->bufsize - 1 );
262     b->list = NULL;
263     b->debug = NULL;
264     /* and now copy the complete list of algorithms */
265     /* I know that the copied list is reversed, but that doesn't matter */
266     for( ar=a->list; ar; ar = ar->next ) {
267         br = a->secure ? m_alloc_secure( sizeof *br + ar->contextsize )
268                        : m_alloc( sizeof *br + ar->contextsize );
269         memcpy( br, ar, sizeof(*br) + ar->contextsize );
270         br->next = b->list;
271         b->list = br;
272     }
273
274     if( a->debug )
275         md_start_debug( b, "unknown" );
276     return b;
277 }
278
279
280 /****************
281  * Reset all contexts and discard any buffered stuff.  This may be used
282  * instead of a md_close(); md_open().
283  */
284 void
285 md_reset( MD_HANDLE a )
286 {
287     struct md_digest_list_s *r;
288
289     a->bufcount = 0;
290     for( r=a->list; r; r = r->next ) {
291         memset( r->context, 0, r->contextsize );
292         (*r->init)( &r->context );
293     }
294 }
295
296
297 void
298 md_close(MD_HANDLE a)
299 {
300     struct md_digest_list_s *r, *r2;
301
302     if( !a )
303         return;
304     if( a->debug )
305         md_stop_debug(a);
306     for(r=a->list; r; r = r2 ) {
307         r2 = r->next;
308         m_free(r);
309     }
310     m_free(a);
311 }
312
313
314 void
315 md_write( MD_HANDLE a, byte *inbuf, size_t inlen)
316 {
317     struct md_digest_list_s *r;
318
319     if( a->debug ) {
320         if( a->bufcount && fwrite(a->buffer, a->bufcount, 1, a->debug ) != 1 )
321             BUG();
322         if( inlen && fwrite(inbuf, inlen, 1, a->debug ) != 1 )
323             BUG();
324     }
325     for(r=a->list; r; r = r->next ) {
326         (*r->write)( &r->context, a->buffer, a->bufcount );
327         (*r->write)( &r->context, inbuf, inlen );
328     }
329     a->bufcount = 0;
330 }
331
332
333
334 void
335 md_final(MD_HANDLE a)
336 {
337     struct md_digest_list_s *r;
338
339     if( a->bufcount )
340         md_write( a, NULL, 0 );
341
342     for(r=a->list; r; r = r->next ) {
343         (*r->final)( &r->context );
344     }
345 }
346
347
348 /****************
349  * if ALGO is null get the digest for the used algo (which should be only one)
350  */
351 byte *
352 md_read( MD_HANDLE a, int algo )
353 {
354     struct md_digest_list_s *r;
355
356     if( !algo ) {  /* return the first algorithm */
357         if( (r=a->list) ) {
358             if( r->next )
359                 log_debug("more than algorithm in md_read(0)\n");
360             return (*r->read)( &r->context );
361         }
362     }
363     else {
364         for(r=a->list; r; r = r->next )
365             if( r->algo == algo )
366                 return (*r->read)( &r->context );
367     }
368     BUG();
369     return NULL;
370 }
371
372
373 /****************
374  * This function combines md_final and md_read but keeps the context
375  * intact.  This function can be used to calculate intermediate
376  * digests.  The digest is copied into buffer and the digestlength is
377  * returned.  If buffer is NULL only the needed size for buffer is returned.
378  * buflen gives the max size of buffer. If the buffer is too shourt to
379  * hold the complete digest, the buffer is filled with as many bytes are
380  * possible and this value is returned.
381  */
382 int
383 md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen )
384 {
385     struct md_digest_list_s *r = NULL;
386     char *context;
387     char *digest;
388
389     if( a->bufcount )
390         md_write( a, NULL, 0 );
391
392     if( !algo ) {  /* return digest for the first algorithm */
393         if( (r=a->list) && r->next )
394             log_debug("more than algorithm in md_digest(0)\n");
395     }
396     else {
397         for(r=a->list; r; r = r->next )
398             if( r->algo == algo )
399                 break;
400     }
401     if( !r )
402         BUG();
403
404     if( !buffer )
405         return r->mdlen;
406
407     /* I don't want to change the interface, so I simply work on a copy
408      * the context (extra overhead - should be fixed)*/
409     context = a->secure ? m_alloc_secure( r->contextsize )
410                         : m_alloc( r->contextsize );
411     memcpy( context, r->context, r->contextsize );
412     (*r->final)( context );
413     digest = (*r->read)( context );
414
415     if( buflen > r->mdlen )
416         buflen = r->mdlen;
417     memcpy( buffer, digest, buflen );
418
419     m_free(context);
420     return buflen;
421 }
422
423
424 int
425 md_get_algo( MD_HANDLE a )
426 {
427     struct md_digest_list_s *r;
428
429     if( (r=a->list) ) {
430         if( r->next )
431             log_error("WARNING: more than algorithm in md_get_algo()\n");
432         return r->algo;
433     }
434     return 0;
435 }
436
437 /****************
438  * Return the length of the digest
439  */
440 int
441 md_digest_length( int algo )
442 {
443     struct md_digest_list_s *r;
444
445     do {
446         for(r = digest_list; r; r = r->next ) {
447             if( r->algo == algo )
448                 return r->mdlen;
449         }
450     } while( !r && load_digest_module( algo ) );
451     log_error("WARNING: no length for md algo %d\n", algo);
452     return 0;
453 }
454
455
456 /* fixme: add a mode to enumerate the OIDs
457  *        to make g10/sig-check.c more portable */
458 const byte *
459 md_asn_oid( int algo, size_t *asnlen, size_t *mdlen )
460 {
461     struct md_digest_list_s *r;
462
463     do {
464         for(r = digest_list; r; r = r->next ) {
465             if( r->algo == algo ) {
466                 if( asnlen )
467                     *asnlen = r->asnlen;
468                 if( mdlen )
469                     *mdlen = r->mdlen;
470                 return r->asnoid;
471             }
472         }
473     } while( !r && load_digest_module( algo ) );
474     log_bug("no asn for md algo %d\n", algo);
475     return NULL;
476 }
477
478
479 void
480 md_start_debug( MD_HANDLE md, const char *suffix )
481 {
482     static int index=0;
483     char buf[25];
484
485     if( md->debug ) {
486         log_debug("Oops: md debug already started\n");
487         return;
488     }
489     index++;
490     sprintf(buf, "dbgmd-%05d.%.10s", index, suffix );
491     md->debug = fopen(buf, "w");
492     if( !md->debug )
493         log_debug("md debug: can't open %s\n", buf );
494 }
495
496 void
497 md_stop_debug( MD_HANDLE md )
498 {
499     if( md->debug ) {
500         if( md->bufcount )
501             md_write( md, NULL, 0 );
502         fclose(md->debug);
503         md->debug = NULL;
504     }
505   #ifdef HAVE_U64_TYPEDEF
506     {  /* a kludge to pull in the __muldi3 for Solaris */
507        volatile u32 a = (u32)(ulong)md;
508        volatile u64 b = 42;
509        volatile u64 c;
510        c = a * b;
511     }
512   #endif
513 }
514