See ChangeLog: Thu Jan 7 18:00:58 CET 1999 Werner Koch
[libgcrypt.git] / cipher / md.c
1 /* md.c  -  message digest dispatcher
2  *      Copyright (C) 1998 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 #define DEFINES_MD_HANDLE 1
22
23 #include <config.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <errno.h>
28 #include <assert.h>
29 #include "util.h"
30 #include "cipher.h"
31 #include "errors.h"
32 #include "dynload.h"
33 #include "md5.h"
34 #include "sha1.h"
35 #include "rmd.h"
36
37
38 /****************
39  * This structure is used for the list of available algorithms
40  * and for the list of algorithms in MD_HANDLE.
41  */
42 struct md_digest_list_s {
43     struct md_digest_list_s *next;
44     const char *name;
45     int algo;
46     byte *asnoid;
47     int asnlen;
48     int mdlen;
49     void (*init)( void *c );
50     void (*write)( void *c, byte *buf, size_t nbytes );
51     void (*final)( void *c );
52     byte *(*read)( void *c );
53     size_t contextsize; /* allocate this amount of context */
54     char context[1];
55 };
56
57 static struct md_digest_list_s *digest_list;
58
59
60
61 static struct md_digest_list_s *
62 new_list_item( int algo,
63                const char *(*get_info)( int, size_t*,byte**, int*, int*,
64                                        void (**)(void*),
65                                        void (**)(void*,byte*,size_t),
66                                        void (**)(void*),byte *(**)(void*)) )
67 {
68     struct md_digest_list_s *r;
69
70     r = m_alloc_clear( sizeof *r );
71     r->algo = algo,
72     r->name = (*get_info)( algo, &r->contextsize,
73                            &r->asnoid, &r->asnlen, &r->mdlen,
74                            &r->init, &r->write, &r->final, &r->read );
75     if( !r->name ) {
76         m_free(r);
77         r = NULL;
78     }
79     return r;
80 }
81
82 /****************
83  * Put the static entries into the table.
84  */
85 static void
86 setup_digest_list()
87 {
88     struct md_digest_list_s *r;
89
90     r = new_list_item( DIGEST_ALGO_MD5, md5_get_info );
91     if( r ) { r->next = digest_list; digest_list = r; }
92
93     r = new_list_item( DIGEST_ALGO_RMD160, rmd160_get_info );
94     if( r ) { r->next = digest_list; digest_list = r; }
95
96     r = new_list_item( DIGEST_ALGO_SHA1, sha1_get_info );
97     if( r ) { r->next = digest_list; digest_list = r; }
98 }
99
100
101 /****************
102  * Try to load all modules and return true if new modules are available
103  */
104 static int
105 load_digest_modules()
106 {
107     static int done = 0;
108     static int initialized = 0;
109     struct md_digest_list_s *r;
110     void *context = NULL;
111     int algo;
112     int any = 0;
113     const char *(*get_info)( int, size_t*,byte**, int*, int*,
114                             void (**)(void*),
115                             void (**)(void*,byte*,size_t),
116                             void (**)(void*),byte *(**)(void*));
117
118     if( !initialized ) {
119         setup_digest_list(); /* load static modules on the first call */
120         initialized = 1;
121         return 1;
122     }
123
124     if( done )
125         return 0;
126     done = 1;
127
128     while( enum_gnupgext_digests( &context, &algo, &get_info ) ) {
129         for(r=digest_list; r; r = r->next )
130             if( r->algo == algo )
131                 break;
132         if( r ) {
133             log_info("skipping digest %d: already loaded\n", algo );
134             continue;
135         }
136         r = new_list_item( algo, get_info );
137         if( ! r ) {
138             log_info("skipping digest %d: no name\n", algo );
139             continue;
140         }
141         /* put it into the list */
142         if( g10_opt_verbose > 1 )
143             log_info("loaded digest %d\n", algo);
144         r->next = digest_list;
145         digest_list = r;
146         any = 1;
147     }
148     enum_gnupgext_digests( &context, NULL, NULL );
149     return any;
150 }
151
152
153
154 /****************
155  * Map a string to the digest algo
156  */
157 int
158 string_to_digest_algo( const char *string )
159 {
160     struct md_digest_list_s *r;
161
162     do {
163         for(r = digest_list; r; r = r->next )
164             if( !stricmp( r->name, string ) )
165                 return r->algo;
166     } while( !r && load_digest_modules() );
167     return 0;
168 }
169
170
171 /****************
172  * Map a digest algo to a string
173  */
174 const char *
175 digest_algo_to_string( int algo )
176 {
177     struct md_digest_list_s *r;
178
179     do {
180         for(r = digest_list; r; r = r->next )
181             if( r->algo == algo )
182                 return r->name;
183     } while( !r && load_digest_modules() );
184     return NULL;
185 }
186
187
188 int
189 check_digest_algo( int algo )
190 {
191     struct md_digest_list_s *r;
192
193     do {
194         for(r = digest_list; r; r = r->next )
195             if( r->algo == algo )
196                 return 0;
197     } while( !r && load_digest_modules() );
198     return G10ERR_DIGEST_ALGO;
199 }
200
201
202
203 /****************
204  * Open a message digest handle for use with algorithm ALGO.
205  * More algorithms may be added by md_enable(). The initial algorithm
206  * may be 0.
207  */
208 MD_HANDLE
209 md_open( int algo, int secure )
210 {
211     MD_HANDLE hd;
212     int bufsize;
213
214     if( secure ) {
215         bufsize = 512 - sizeof( *hd );
216         hd = m_alloc_secure_clear( sizeof *hd + bufsize );
217     }
218     else {
219         bufsize = 1024 - sizeof( *hd );
220         hd = m_alloc_clear( sizeof *hd + bufsize );
221     }
222
223     hd->bufsize = bufsize+1; /* hd has already one byte allocated */
224     hd->secure = secure;
225     if( algo )
226         md_enable( hd, algo );
227     fast_random_poll();
228     return hd;
229 }
230
231 void
232 md_enable( MD_HANDLE h, int algo )
233 {
234     struct md_digest_list_s *r, *ac;
235
236     for( ac=h->list; ac; ac = ac->next )
237         if( ac->algo == algo )
238             return ; /* already enabled */
239     /* find the algorithm */
240     do {
241         for(r = digest_list; r; r = r->next )
242             if( r->algo == algo )
243                 break;
244     } while( !r && load_digest_modules() );
245     if( !r ) {
246         log_error("md_enable: algorithm %d not available\n", algo );
247         return;
248     }
249     /* and allocate a new list entry */
250     ac = h->secure? m_alloc_secure( sizeof *ac + r->contextsize )
251                   : m_alloc( sizeof *ac + r->contextsize );
252     *ac = *r;
253     ac->next = h->list;
254     h->list = ac;
255     /* and init this instance */
256     (*ac->init)( &ac->context );
257 }
258
259
260 MD_HANDLE
261 md_copy( MD_HANDLE a )
262 {
263     MD_HANDLE b;
264     struct md_digest_list_s *ar, *br;
265
266     if( a->bufcount )
267         md_write( a, NULL, 0 );
268     b = a->secure ? m_alloc_secure( sizeof *b + a->bufsize - 1 )
269                   : m_alloc( sizeof *b + a->bufsize - 1 );
270     memcpy( b, a, sizeof *a + a->bufsize - 1 );
271     b->list = NULL;
272     b->debug = NULL;
273     /* and now copy the complete list of algorithms */
274     /* I know that the copied list is reversed, but that doesn't matter */
275     for( ar=a->list; ar; ar = ar->next ) {
276         br = a->secure ? m_alloc_secure( sizeof *br + ar->contextsize )
277                        : m_alloc( sizeof *br + ar->contextsize );
278         memcpy( br, ar, sizeof(*br) + ar->contextsize );
279         br->next = b->list;
280         b->list = br;
281     }
282
283     if( a->debug )
284         md_start_debug( b, "unknown" );
285     return b;
286 }
287
288
289 /****************
290  * Reset all contexts and discard any buffered stuff.  This may be used
291  * instead of a md_close(); md_open().
292  */
293 void
294 md_reset( MD_HANDLE a )
295 {
296     struct md_digest_list_s *r;
297
298     a->bufcount = 0;
299     for( r=a->list; r; r = r->next ) {
300         memset( r->context, 0, r->contextsize );
301         (*r->init)( &r->context );
302     }
303 }
304
305
306 void
307 md_close(MD_HANDLE a)
308 {
309     struct md_digest_list_s *r, *r2;
310
311     if( !a )
312         return;
313     if( a->debug )
314         md_stop_debug(a);
315     for(r=a->list; r; r = r2 ) {
316         r2 = r->next;
317         m_free(r);
318     }
319     m_free(a);
320 }
321
322
323 void
324 md_write( MD_HANDLE a, byte *inbuf, size_t inlen)
325 {
326     struct md_digest_list_s *r;
327
328     if( a->debug ) {
329         if( a->bufcount && fwrite(a->buffer, a->bufcount, 1, a->debug ) != 1 )
330             BUG();
331         if( inlen && fwrite(inbuf, inlen, 1, a->debug ) != 1 )
332             BUG();
333     }
334     for(r=a->list; r; r = r->next ) {
335         (*r->write)( &r->context, a->buffer, a->bufcount );
336         (*r->write)( &r->context, inbuf, inlen );
337     }
338     a->bufcount = 0;
339 }
340
341
342
343 void
344 md_final(MD_HANDLE a)
345 {
346     struct md_digest_list_s *r;
347
348     if( a->bufcount )
349         md_write( a, NULL, 0 );
350
351     for(r=a->list; r; r = r->next ) {
352         (*r->final)( &r->context );
353     }
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 );
370         }
371     }
372     else {
373         for(r=a->list; r; r = r->next )
374             if( r->algo == algo )
375                 return (*r->read)( &r->context );
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, 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_modules() );
460     log_error("WARNING: no length for md algo %d\n", algo);
461     return 0;
462 }
463
464
465 /* fixme: 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_modules() );
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 index=0;
492     char buf[25];
493
494     if( md->debug ) {
495         log_debug("Oops: md debug already started\n");
496         return;
497     }
498     index++;
499     sprintf(buf, "dbgmd-%05d.%.10s", index, 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