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