See ChangeLog: Fri Mar 24 11:25:45 CET 2000 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
28 #include "g10lib.h"
29 #include "cipher.h"
30 #include "dynload.h"
31 #include "rmd.h"
32
33
34 struct md_digest_list_s;
35
36 /* this structure is put right after the GCRY_MD_HD buffer, so that
37  * only one memory block is needed. */
38 struct gcry_md_context {
39     int  magic;
40     int  secure;
41     FILE  *debug;
42     int finalized;
43     struct md_digest_list_s *list;
44     byte *macpads;
45 };
46 #define CTX_MAGIC_NORMAL 0x11071961
47 #define CTX_MAGIC_SECURE 0x16917011
48
49 static const char * digest_algo_to_string( int algo );
50 static int check_digest_algo( int algo );
51 static GCRY_MD_HD md_open( int algo, int secure, int hmac );
52 static int  md_enable( GCRY_MD_HD hd, int algo );
53 static GCRY_MD_HD md_copy( GCRY_MD_HD a );
54 static void md_close(GCRY_MD_HD a);
55 static void md_write( GCRY_MD_HD a, byte *inbuf, size_t inlen);
56 static void md_final(GCRY_MD_HD a);
57 static byte *md_read( GCRY_MD_HD a, int algo );
58 static int md_get_algo( GCRY_MD_HD a );
59 static int md_digest_length( int algo );
60 static const byte *md_asn_oid( int algo, size_t *asnlen, size_t *mdlen );
61 static void md_start_debug( GCRY_MD_HD a, const char *suffix );
62 static void md_stop_debug( GCRY_MD_HD a );
63
64 /****************
65  * This structure is used for the list of available algorithms
66  * and for the list of algorithms in GCRY_MD_HD.
67  */
68 struct md_digest_list_s {
69     struct md_digest_list_s *next;
70     const char *name;
71     int algo;
72     byte *asnoid;
73     int asnlen;
74     int mdlen;
75     void (*init)( void *c );
76     void (*write)( void *c, byte *buf, size_t nbytes );
77     void (*final)( void *c );
78     byte *(*read)( void *c );
79     size_t contextsize; /* allocate this amount of context */
80     PROPERLY_ALIGNED_TYPE context;
81 };
82
83 static struct md_digest_list_s *digest_list;
84
85
86 static struct md_digest_list_s *
87 new_list_item( int algo,
88                const char *(*get_info)( int, size_t*,byte**, int*, int*,
89                                        void (**)(void*),
90                                        void (**)(void*,byte*,size_t),
91                                        void (**)(void*),byte *(**)(void*)) )
92 {
93     struct md_digest_list_s *r;
94
95     r = g10_xcalloc( 1, sizeof *r );
96     r->algo = algo,
97     r->name = (*get_info)( algo, &r->contextsize,
98                            &r->asnoid, &r->asnlen, &r->mdlen,
99                            &r->init, &r->write, &r->final, &r->read );
100     if( !r->name ) {
101         g10_free(r);
102         r = NULL;
103     }
104     return r;
105 }
106
107
108
109 /****************
110  * Try to load the modules with the requeste algorithm
111  * and return true if new modules are available
112  * If req_alog is -1 try to load all digest algorithms.
113  */
114 static int
115 load_digest_module( int req_algo )
116 {
117     static int initialized = 0;
118     static u32 checked_algos[256/32];
119     static int checked_all = 0;
120     struct md_digest_list_s *r;
121     void *context = NULL;
122     int algo;
123     int any = 0;
124     const char *(*get_info)( int, size_t*,byte**, int*, int*,
125                             void (**)(void*),
126                             void (**)(void*,byte*,size_t),
127                             void (**)(void*),byte *(**)(void*));
128
129     if( !initialized ) {
130         cipher_modules_constructor();
131         initialized = 1;
132     }
133     algo = req_algo;
134     if( algo > 255 || !algo )
135         return 0; /* algorithm number too high (does not fit into out bitmap)*/
136     if( checked_all )
137         return 0; /* already called with -1 */
138     if( algo < 0 )
139         checked_all = 1;
140     else if( (checked_algos[algo/32] & (1 << (algo%32))) )
141         return 0; /* already checked and not found */
142     else
143         checked_algos[algo/32] |= (1 << (algo%32));
144
145     while( enum_gnupgext_digests( &context, &algo, &get_info ) ) {
146         if( req_algo != -1 && algo != req_algo )
147             continue;
148         for(r=digest_list; r; r = r->next )
149             if( r->algo == algo )
150                 break;
151         if( r ) {
152             log_info("skipping digest %d: already loaded\n", algo );
153             continue;
154         }
155         r = new_list_item( algo, get_info );
156         if( ! r ) {
157             log_info("skipping digest %d: no name\n", algo );
158             continue;
159         }
160         /* put it into the list */
161         if( g10_log_verbosity( 2 ) )
162             log_info("loaded digest %d\n", algo);
163         r->next = digest_list;
164         digest_list = r;
165         any = 1;
166         if( req_algo != -1 )
167             break;
168     }
169     enum_gnupgext_digests( &context, NULL, NULL );
170     return any;
171 }
172
173
174
175 /****************
176  * Map a string to the digest algo
177  */
178 int
179 gcry_md_map_name( const char *string )
180 {
181     struct md_digest_list_s *r;
182
183     do {
184         for(r = digest_list; r; r = r->next )
185             if( !stricmp( r->name, string ) )
186                 return r->algo;
187     } while( !r && load_digest_module(-1) );
188     return 0;
189 }
190
191
192 /****************
193  * Map a digest algo to a string
194  */
195 static const char *
196 digest_algo_to_string( int algo )
197 {
198     struct md_digest_list_s *r;
199
200     do {
201         for(r = digest_list; r; r = r->next )
202             if( r->algo == algo )
203                 return r->name;
204     } while( !r && load_digest_module( algo ) );
205     return NULL;
206 }
207
208 /****************
209  * This function simply returns the name of the algorithm or some constant
210  * string when there is no algo.  It will never return NULL.
211  * Use  the macro gcry_md_test_algo() to check whether the algorithm
212  * is valid.
213  */
214 const char *
215 gcry_md_algo_name( int algo )
216 {
217     const char *s = digest_algo_to_string( algo );
218     return s? s: "?";
219 }
220
221
222 static int
223 check_digest_algo( int algo )
224 {
225     struct md_digest_list_s *r;
226
227     do {
228         for(r = digest_list; r; r = r->next )
229             if( r->algo == algo )
230                 return 0;
231     } while( !r && load_digest_module(algo) );
232     return GCRYERR_INV_MD_ALGO;
233 }
234
235
236
237 /****************
238  * Open a message digest handle for use with algorithm ALGO.
239  * More algorithms may be added by md_enable(). The initial algorithm
240  * may be 0.
241  */
242 static GCRY_MD_HD
243 md_open( int algo, int secure, int hmac )
244 {
245     GCRY_MD_HD hd;
246     struct gcry_md_context *ctx;
247     int bufsize = secure? 512 : 1024;
248     size_t n;
249
250     /* Allocate a memory area to hold the caller visible buffer with it's
251      * control information and the data required by this module. Set the
252      * context pointer at the beginning to this area.
253      * We have to use this strange scheme because we want to hide the
254      * internal data but have a variable sized buffer.
255      *
256      *  +---+------+---........------+-------------+
257      *  !ctx! bctl !  buffer         ! private     !
258      *  +---+------+---........------+-------------+
259      *    !                           ^
260      *    !---------------------------!
261      *
262      * We have to make sture that private is well aligned.
263      */
264     n = sizeof( struct gcry_md_handle ) + bufsize;
265     n = ((n + sizeof(PROPERLY_ALIGNED_TYPE)-1)
266          / sizeof(PROPERLY_ALIGNED_TYPE) ) * sizeof(PROPERLY_ALIGNED_TYPE);
267
268     /* allocate and set the Context pointer to the private data */
269     hd = secure ? g10_malloc_secure( n + sizeof( struct gcry_md_context ) )
270                 : g10_malloc(        n + sizeof( struct gcry_md_context ) );
271     if( !hd ) {
272         set_lasterr( GCRYERR_NO_MEM );
273         return NULL;
274     }
275
276     hd->ctx = ctx = (struct gcry_md_context*)( (char*)hd + n );
277     /* setup the globally visible data (bctl in the diagram)*/
278     hd->bufsize = n - sizeof( struct gcry_md_handle ) + 1;
279     hd->bufpos = 0;
280     /* initialize the private data */
281     memset( hd->ctx, 0, sizeof *hd->ctx );
282     ctx->magic = secure ? CTX_MAGIC_SECURE : CTX_MAGIC_NORMAL;
283     ctx->secure = secure;
284     if( hmac ) {
285         ctx->macpads = g10_malloc_secure( 128 );
286         if( !ctx->macpads ) {
287             md_close( hd );
288             set_lasterr( GCRYERR_NO_MEM );
289             return NULL;
290         }
291     }
292     fast_random_poll(); /* FIXME: should we really do that? */
293     if( algo && md_enable( hd, algo ) ) {
294         md_close( hd );
295         return NULL;
296     }
297     return hd;
298 }
299
300
301 GCRY_MD_HD
302 gcry_md_open( int algo, unsigned int flags )
303 {
304     GCRY_MD_HD hd;
305     /* fixme: check that algo is available and that only valid
306      * flag values are used */
307     hd = md_open( algo, (flags & GCRY_MD_FLAG_SECURE),
308                         (flags & GCRY_MD_FLAG_HMAC) );
309     return hd;
310 }
311
312
313
314 static int
315 md_enable( GCRY_MD_HD hd, int algo )
316 {
317     struct gcry_md_context *h = hd->ctx;
318     struct md_digest_list_s *r, *ac;
319
320     for( ac=h->list; ac; ac = ac->next )
321         if( ac->algo == algo )
322             return 0; /* already enabled */
323     /* find the algorithm */
324     do {
325         for(r = digest_list; r; r = r->next )
326             if( r->algo == algo )
327                 break;
328     } while( !r && load_digest_module( algo ) );
329     if( !r ) {
330         log_debug("md_enable: algorithm %d not available\n", algo );
331         return set_lasterr( GCRYERR_INV_MD_ALGO );
332     }
333     /* and allocate a new list entry */
334     ac = h->secure? g10_malloc_secure( sizeof *ac + r->contextsize
335                                                - sizeof(r->context) )
336                   : g10_malloc( sizeof *ac + r->contextsize
337                                                - sizeof(r->context) );
338     if( !ac )
339         return set_lasterr( GCRYERR_NO_MEM );
340
341     *ac = *r;
342     ac->next = h->list;
343     h->list = ac;
344     /* and init this instance */
345     (*ac->init)( &ac->context.c );
346     return 0;
347 }
348
349
350 int
351 gcry_md_enable( GCRY_MD_HD hd, int algo )
352 {
353     return md_enable( hd, algo );
354 }
355
356 static GCRY_MD_HD
357 md_copy( GCRY_MD_HD ahd )
358 {
359     struct gcry_md_context *a = ahd->ctx;
360     struct gcry_md_context *b;
361     GCRY_MD_HD bhd;
362     struct md_digest_list_s *ar, *br;
363     size_t n;
364
365     if( ahd->bufpos )
366         md_write( ahd, NULL, 0 );
367
368     n = (char*)ahd->ctx - (char*)ahd;
369     bhd = a->secure ? g10_malloc_secure( n + sizeof( struct gcry_md_context ) )
370                     : g10_malloc(        n + sizeof( struct gcry_md_context ) );
371     if( !bhd ) {
372         set_lasterr( GCRYERR_NO_MEM );
373         return NULL;
374     }
375
376     bhd->ctx = b = (struct gcry_md_context*)( (char*)bhd + n );
377     /* no need to copy the buffer due to the write above */
378     assert( ahd->bufsize == (n - sizeof( struct gcry_md_handle ) + 1) );
379     bhd->bufsize = ahd->bufsize;
380     bhd->bufpos = 0;  assert( !ahd->bufpos );
381     memcpy( b, a, sizeof *a );
382     b->list = NULL;
383     b->debug = NULL;
384     if( a->macpads ) {
385         b->macpads = g10_malloc_secure( 128 );
386         memcpy( b->macpads, a->macpads, 128 );
387     }
388     /* and now copy the complete list of algorithms */
389     /* I know that the copied list is reversed, but that doesn't matter */
390     for( ar=a->list; ar; ar = ar->next ) {
391         br = a->secure ? g10_xmalloc_secure( sizeof *br + ar->contextsize
392                                                - sizeof(ar->context) )
393                        : g10_xmalloc( sizeof *br + ar->contextsize
394                                                - sizeof(ar->context) );
395         memcpy( br, ar, sizeof(*br) + ar->contextsize
396                                     - sizeof(ar->context) );
397         br->next = b->list;
398         b->list = br;
399     }
400
401     if( a->debug )
402         md_start_debug( bhd, "unknown" );
403     return bhd;
404 }
405
406 GCRY_MD_HD
407 gcry_md_copy( GCRY_MD_HD hd )
408 {
409     return md_copy( hd );
410 }
411
412 /****************
413  * Reset all contexts and discard any buffered stuff.  This may be used
414  * instead of a md_close(); md_open().
415  */
416 void
417 gcry_md_reset( GCRY_MD_HD a )
418 {
419     struct md_digest_list_s *r;
420
421     a->bufpos = a->ctx->finalized = 0;
422     for( r=a->ctx->list; r; r = r->next ) {
423         memset( r->context.c, 0, r->contextsize );
424         (*r->init)( &r->context.c );
425     }
426     if( a->ctx->macpads ) {
427         md_write( a, a->ctx->macpads, 64 ); /* inner pad */
428     }
429 }
430
431
432 static void
433 md_close(GCRY_MD_HD a)
434 {
435     struct md_digest_list_s *r, *r2;
436
437     if( !a )
438         return;
439     if( a->ctx->debug )
440         md_stop_debug(a);
441     for(r=a->ctx->list; r; r = r2 ) {
442         r2 = r->next;
443         g10_free(r);
444     }
445     g10_free(a->ctx->macpads);
446     g10_free(a);
447 }
448
449
450 void
451 gcry_md_close( GCRY_MD_HD hd )
452 {
453     md_close( hd );
454 }
455
456
457 static void
458 md_write( GCRY_MD_HD a, byte *inbuf, size_t inlen)
459 {
460     struct md_digest_list_s *r;
461
462     if( a->ctx->debug ) {
463         if( a->bufpos && fwrite(a->buf, a->bufpos, 1, a->ctx->debug ) != 1 )
464             BUG();
465         if( inlen && fwrite(inbuf, inlen, 1, a->ctx->debug ) != 1 )
466             BUG();
467     }
468     for(r=a->ctx->list; r; r = r->next ) {
469         if( a->bufpos )
470             (*r->write)( &r->context.c, a->buf, a->bufpos );
471         (*r->write)( &r->context.c, inbuf, inlen );
472     }
473     a->bufpos = 0;
474 }
475
476
477 void
478 gcry_md_write( GCRY_MD_HD hd, const byte *inbuf, size_t inlen)
479 {
480     md_write( hd, (byte*)inbuf, inlen );
481 }
482
483
484
485 static void
486 md_final(GCRY_MD_HD a)
487 {
488     struct md_digest_list_s *r;
489
490     if( a->ctx->finalized )
491         return;
492
493     if( a->bufpos )
494         md_write( a, NULL, 0 );
495
496     for(r=a->ctx->list; r; r = r->next ) {
497         (*r->final)( &r->context.c );
498     }
499     a->ctx->finalized = 1;
500     if( a->ctx->macpads ) {  /* finish the hmac */
501         int algo = md_get_algo( a );
502         byte *p = md_read( a, algo );
503         size_t dlen = md_digest_length(algo);
504
505         GCRY_MD_HD om = md_open( algo, a->ctx->secure, 0 );
506         if( !om )
507             g10_fatal_error( gcry_errno(), NULL );
508         md_write( om, a->ctx->macpads+64, 64 );
509         md_write( om, p, dlen );
510         md_final( om );
511         /* replace our digest with the mac (they have the same size) */
512         memcpy( p, md_read( om, algo ), dlen );
513         md_close( om );
514     }
515 }
516
517
518
519 static int
520 prepare_macpads( GCRY_MD_HD hd, byte *key, size_t keylen)
521 {
522     int i;
523     int algo = md_get_algo( hd );
524     byte *helpkey = NULL;
525     byte *ipad, *opad;
526
527     if( !algo )
528         return GCRYERR_INV_MD_ALGO; /* i.e. no algo enabled */
529
530     if( keylen > 64 ) {
531         helpkey = g10_malloc_secure( md_digest_length( algo ) );
532         if( !helpkey )
533             return GCRYERR_NO_MEM;
534         gcry_md_hash_buffer( algo, helpkey, key, keylen );
535         key = helpkey;
536         keylen = md_digest_length( algo );
537         assert( keylen <= 64 );
538     }
539
540     memset( hd->ctx->macpads, 0, 128 );
541     ipad = hd->ctx->macpads;
542     opad = hd->ctx->macpads+64;
543     memcpy( ipad, key, keylen );
544     memcpy( opad, key, keylen );
545     for(i=0; i < 64; i++ ) {
546         ipad[i] ^= 0x36;
547         opad[i] ^= 0x5c;
548     }
549     g10_free( helpkey );
550     return 0;
551 }
552
553 int
554 gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen)
555 {
556     int rc = 0;
557     if( cmd == GCRYCTL_FINALIZE )
558         md_final( hd );
559     else if( cmd == GCRYCTL_SET_KEY ) {
560         if( !(hd->ctx->macpads ) )
561             rc = GCRYERR_CONFLICT;
562         else if ( !(rc = prepare_macpads( hd, buffer, buflen )) )
563             gcry_md_reset( hd );
564     }
565     else
566         rc = GCRYERR_INV_OP;
567     return set_lasterr( rc );
568 }
569
570
571 /****************
572  * if ALGO is null get the digest for the used algo (which should be only one)
573  */
574 static byte *
575 md_read( GCRY_MD_HD a, int algo )
576 {
577     struct md_digest_list_s *r;
578
579     if( !algo ) {  /* return the first algorithm */
580         if( (r=a->ctx->list) ) {
581             if( r->next )
582                 log_debug("more than algorithm in md_read(0)\n");
583             return (*r->read)( &r->context.c );
584         }
585     }
586     else {
587         for(r=a->ctx->list; r; r = r->next )
588             if( r->algo == algo )
589                 return (*r->read)( &r->context.c );
590     }
591     BUG();
592     return NULL;
593 }
594
595 /****************
596  * Read out the complete digest, this function implictly finalizes
597  * the hash.
598  */
599 byte *
600 gcry_md_read( GCRY_MD_HD hd, int algo )
601 {
602     gcry_md_ctl( hd, GCRYCTL_FINALIZE, NULL, 0 );
603     return md_read( hd, algo);
604 }
605
606
607 /****************
608  * This function combines md_final and md_read but keeps the context
609  * intact.  This function can be used to calculate intermediate
610  * digests.  The digest is copied into buffer and the digestlength is
611  * returned.  If buffer is NULL only the needed size for buffer is returned.
612  * buflen gives the max size of buffer. If the buffer is too shourt to
613  * hold the complete digest, the buffer is filled with as many bytes are
614  * possible and this value is returned.
615  */
616 #if 0
617 static int
618 md_digest( GCRY_MD_HD a, int algo, byte *buffer, int buflen )
619 {
620     struct md_digest_list_s *r = NULL;
621     char *context;
622     char *digest;
623
624     if( a->bufpos )
625         md_write( a, NULL, 0 );
626
627     if( !algo ) {  /* return digest for the first algorithm */
628         if( (r=a->ctx->list) && r->next )
629             log_debug("more than algorithm in md_digest(0)\n");
630     }
631     else {
632         for(r=a->ctx->list; r; r = r->next )
633             if( r->algo == algo )
634                 break;
635     }
636     if( !r )
637         BUG();
638
639     if( !buffer )
640         return r->mdlen;
641
642     /* I don't want to change the interface, so I simply work on a copy
643      * of the context (extra overhead - should be fixed)*/
644     context = a->ctx->secure ? g10_xmalloc_secure( r->contextsize )
645                              : g10_xmalloc( r->contextsize );
646     memcpy( context, r->context.c, r->contextsize );
647     (*r->final)( context );
648     digest = (*r->read)( context );
649
650     if( buflen > r->mdlen )
651         buflen = r->mdlen;
652     memcpy( buffer, digest, buflen );
653
654     g10_free(context);
655     return buflen;
656 }
657 #endif
658
659 /****************
660  * Read out an intermediate digest.
661  */
662 int
663 gcry_md_get( GCRY_MD_HD hd, int algo, byte *buffer, int buflen )
664 {
665     /*md_digest ... */
666     return GCRYERR_INTERNAL;
667 }
668
669
670 /****************
671  * Shortcut function to hash a buffer with a given algo. The only supported
672  * algorithm is RIPE-MD. The supplied digest buffer must be large enough
673  * to store the resulting hash.  No error is returned, the function will
674  * abort on an invalid algo.  DISABLED_ALGOS are ignored here.
675  */
676 void
677 gcry_md_hash_buffer( int algo, char *digest, const char *buffer, size_t length)
678 {
679     if( algo == GCRY_MD_RMD160 )
680         rmd160_hash_buffer( digest, buffer, length );
681     else { /* for the others we do not have a fast function, so
682             * we use the normal functions to do it */
683         GCRY_MD_HD h = md_open( algo, 0, 0 );
684         if( !h )
685             BUG(); /* algo not available */
686         md_write( h, (byte*)buffer, length );
687         md_final( h );
688         memcpy( digest, md_read( h, algo ), md_digest_length( algo ) );
689     }
690 }
691
692 static int
693 md_get_algo( GCRY_MD_HD a )
694 {
695     struct md_digest_list_s *r;
696
697     if( (r=a->ctx->list) ) {
698         if( r->next )
699             log_error("WARNING: more than algorithm in md_get_algo()\n");
700         return r->algo;
701     }
702     return 0;
703 }
704
705
706 int
707 gcry_md_get_algo( GCRY_MD_HD hd )
708 {
709     return md_get_algo( hd ); /* fixme: we need error handling */
710 }
711
712
713 /****************
714  * Return the length of the digest
715  */
716 static int
717 md_digest_length( int algo )
718 {
719     struct md_digest_list_s *r;
720
721     do {
722         for(r = digest_list; r; r = r->next ) {
723             if( r->algo == algo )
724                 return r->mdlen;
725         }
726     } while( !r && load_digest_module( algo ) );
727     return 0;
728 }
729
730 /****************
731  * Return the length of the digest in bytes.
732  * This function will return 0 in case of errors.
733  */
734 unsigned int
735 gcry_md_get_algo_dlen( int algo )
736 {
737     /* we do some very quick checks here */
738     switch( algo )
739     {
740       case GCRY_MD_MD5: return 16;
741       case GCRY_MD_SHA1:
742       case GCRY_MD_RMD160: return 20;
743       default: {
744             int len = md_digest_length( algo );
745             if( !len )
746                 set_lasterr( GCRYERR_INV_MD_ALGO );
747             return 0;
748         }
749     }
750 }
751
752
753 /* Hmmm: add a mode to enumerate the OIDs
754  *      to make g10/sig-check.c more portable */
755 static const byte *
756 md_asn_oid( int algo, size_t *asnlen, size_t *mdlen )
757 {
758     struct md_digest_list_s *r;
759
760     do {
761         for(r = digest_list; r; r = r->next ) {
762             if( r->algo == algo ) {
763                 if( asnlen )
764                     *asnlen = r->asnlen;
765                 if( mdlen )
766                     *mdlen = r->mdlen;
767                 return r->asnoid;
768             }
769         }
770     } while( !r && load_digest_module( algo ) );
771     log_bug("no asn for md algo %d\n", algo);
772     return NULL;
773 }
774
775
776
777 /****************
778  * Return information about the given cipher algorithm
779  * WHAT select the kind of information returned:
780  *  GCRYCTL_TEST_ALGO:
781  *      Returns 0 when the specified algorithm is available for use.
782  *      buffer and nbytes must be zero.
783  *  GCRYCTL_GET_ASNOID:
784  *      Return the ASNOID of the algorithm in buffer. if buffer is NULL, only
785  *      the required length is returned.
786  *
787  * On error the value -1 is returned and the error reason may be
788  * retrieved by gcry_errno().
789  * Note:  Because this function is in most caes used to return an
790  * integer value, we can make it easier for the caller to just look at
791  * the return value.  The caller will in all cases consult the value
792  * and thereby detecting whether a error occured or not (i.e. while checking
793  * the block size)
794  */
795 int
796 gcry_md_algo_info( int algo, int what, void *buffer, size_t *nbytes)
797 {
798     switch( what ) {
799       case GCRYCTL_TEST_ALGO:
800         if( buffer || nbytes ) {
801             set_lasterr( GCRYERR_INV_ARG );
802             return -1;
803         }
804         if( check_digest_algo( algo ) ) {
805             set_lasterr( GCRYERR_INV_MD_ALGO );
806             return -1;
807         }
808         break;
809
810       case GCRYCTL_GET_ASNOID: {
811             size_t asnlen;
812             const char *asn = md_asn_oid( algo, &asnlen, NULL );
813             if( buffer && *nbytes >= asnlen ) {
814                 memcpy( buffer, asn, asnlen );
815                 *nbytes = asnlen;
816                 return 0;
817             }
818             if( !buffer && nbytes ) {
819                 *nbytes = asnlen;
820                 return 0;
821             }
822             set_lasterr( buffer ? GCRYERR_TOO_SHORT : GCRYERR_INV_ARG );
823             return -1;
824         }
825         break;
826
827       default:
828         set_lasterr( GCRYERR_INV_OP );
829         return -1;
830     }
831     return 0;
832 }
833
834
835
836
837 void
838 md_start_debug( GCRY_MD_HD md, const char *suffix )
839 {
840     static int idx=0;
841     char buf[25];
842
843     if( md->ctx->debug ) {
844         log_debug("Oops: md debug already started\n");
845         return;
846     }
847     idx++;
848     sprintf(buf, "dbgmd-%05d.%.10s", idx, suffix );
849     md->ctx->debug = fopen(buf, "w");
850     if( !md->ctx->debug )
851         log_debug("md debug: can't open %s\n", buf );
852 }
853
854 void
855 md_stop_debug( GCRY_MD_HD md )
856 {
857     if( md->ctx->debug ) {
858         if( md->bufpos )
859             md_write( md, NULL, 0 );
860         fclose(md->ctx->debug);
861         md->ctx->debug = NULL;
862     }
863   #ifdef HAVE_U64_TYPEDEF
864     {  /* a kludge to pull in the __muldi3 for Solaris */
865        volatile u32 a = (u32)(ulong)md;
866        volatile u64 b = 42;
867        volatile u64 c;
868        c = a * b;
869     }
870   #endif
871 }
872
873
874
875 /****************
876  * Return information about the digest handle.
877  *  GCRYCTL_IS_SECURE:
878  *      Returns 1 when the handle works on secured memory
879  *      otherwise 0 is returned.  There is no error return.
880  */
881 int
882 gcry_md_info( GCRY_MD_HD h, int cmd, void *buffer, size_t *nbytes)
883 {
884     switch( cmd ) {
885       case GCRYCTL_IS_SECURE:
886         return h->ctx->secure;
887
888       default:
889         set_lasterr( GCRYERR_INV_OP );
890         return -1;
891     }
892     return 0;
893 }
894