2003-02-23 Moritz Schulte <moritz@g10code.com>
[libgcrypt.git] / cipher / md.c
index bc9c6e8..40bf6e6 100644 (file)
@@ -1,20 +1,20 @@
 /* md.c  -  message digest dispatcher
- *     Copyright (C) 1998,1999 Free Software Foundation, Inc.
+ * Copyright (C) 1998, 1999, 2002, 2003 Free Software Foundation, Inc.
  *
- * This file is part of GnuPG.
+ * This file is part of Libgcrypt.
  *
- * GnuPG is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * Libgcrypt is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser general Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
  *
- * GnuPG is distributed in the hope that it will be useful,
+ * Libgcrypt is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
  */
 
 #include "rmd.h"
 
 
+static struct {
+  const char *oidstring;
+  int algo;
+} oid_table[] = {
+  /* iso.member-body.us.rsadsi.pkcs.pkcs-1.5 (sha1WithRSAEncryption) */
+  { "1.2.840.113549.1.1.5",  GCRY_MD_SHA1 },
+  /* iso.member-body.us.rsadsi.pkcs.pkcs-1.4 (md5WithRSAEncryption) */
+  { "1.2.840.113549.1.1.4",  GCRY_MD_MD5 },
+  /* iso.member-body.us.x9-57.x9cm.3 (dsaWithSha1)*/
+  { "1.2.840.10040.4.3",     GCRY_MD_SHA1 },
+  /* from NIST's OIW  (sha1) */
+  { "1.3.14.3.2.26",         GCRY_MD_SHA1 },
+  /* rsaSignatureWithripemd160 */
+  { "1.3.36.3.3.1.2",       GCRY_MD_RMD160 },
+  /* RSADSI digestAlgorithm MD5 */
+  { "1.2.840.113549.2.5",   GCRY_MD_MD5 },
+  /* GNU.digestAlgorithm TIGER */
+  { "1.3.6.1.4.1.11591.12.2", GCRY_MD_TIGER },
+  /* iso.member-body.us.rsadsi.digestAlgorithm.md4 */
+  { "1.2.840.113549.2.4", GCRY_MD_MD4 },
+  /* from NIST OIW (sha-1WithRSAEncryption) */
+  { "1.3.14.3.2.29", GCRY_MD_SHA1 },
+  /* According to the OpenPGG draft rfc2440-bis06 */
+  { "2.16.840.1.101.3.4.2.1", GCRY_MD_SHA256 }, 
+  { "2.16.840.1.101.3.4.2.2", GCRY_MD_SHA384 }, 
+  { "2.16.840.1.101.3.4.2.3", GCRY_MD_SHA512 }, 
+  {NULL}
+};
+
+
+
+
 struct md_digest_list_s;
 
 /* this structure is put right after the GCRY_MD_HD buffer, so that
@@ -41,13 +73,14 @@ struct gcry_md_context {
     FILE  *debug;
     int finalized;
     struct md_digest_list_s *list;
+    byte *macpads;
 };
 #define CTX_MAGIC_NORMAL 0x11071961
 #define CTX_MAGIC_SECURE 0x16917011
 
 static const char * digest_algo_to_string( int algo );
 static int check_digest_algo( int algo );
-static GCRY_MD_HD md_open( int algo, int secure );
+static GCRY_MD_HD md_open( int algo, int secure, int hmac );
 static int  md_enable( GCRY_MD_HD hd, int algo );
 static GCRY_MD_HD md_copy( GCRY_MD_HD a );
 static void md_close(GCRY_MD_HD a);
@@ -82,6 +115,7 @@ struct md_digest_list_s {
 static struct md_digest_list_s *digest_list;
 
 
+\f
 static struct md_digest_list_s *
 new_list_item( int algo,
               const char *(*get_info)( int, size_t*,byte**, int*, int*,
@@ -91,13 +125,13 @@ new_list_item( int algo,
 {
     struct md_digest_list_s *r;
 
-    r = g10_xcalloc( 1, sizeof *r );
+    r = gcry_xcalloc( 1, sizeof *r );
     r->algo = algo,
     r->name = (*get_info)( algo, &r->contextsize,
                           &r->asnoid, &r->asnlen, &r->mdlen,
                           &r->init, &r->write, &r->final, &r->read );
     if( !r->name ) {
-       g10_free(r);
+       gcry_free(r);
        r = NULL;
     }
     return r;
@@ -106,7 +140,7 @@ new_list_item( int algo,
 
 
 /****************
- * Try to load the modules with the requeste algorithm
+ * Try to load the modules with the requested algorithm
  * and return true if new modules are available
  * If req_alog is -1 try to load all digest algorithms.
  */
@@ -114,7 +148,7 @@ static int
 load_digest_module( int req_algo )
 {
     static int initialized = 0;
-    static u32 checked_algos[256/32];
+    static u32 checked_algos[512/32];
     static int checked_all = 0;
     struct md_digest_list_s *r;
     void *context = NULL;
@@ -126,11 +160,11 @@ load_digest_module( int req_algo )
                            void (**)(void*),byte *(**)(void*));
 
     if( !initialized ) {
-       cipher_modules_constructor();
+       _gcry_cipher_modules_constructor();
        initialized = 1;
     }
     algo = req_algo;
-    if( algo > 255 || !algo )
+    if( algo > 511 || !algo )
        return 0; /* algorithm number too high (does not fit into out bitmap)*/
     if( checked_all )
        return 0; /* already called with -1 */
@@ -141,7 +175,7 @@ load_digest_module( int req_algo )
     else
        checked_algos[algo/32] |= (1 << (algo%32));
 
-    while( enum_gnupgext_digests( &context, &algo, &get_info ) ) {
+    while( _gcry_enum_gnupgext_digests( &context, &algo, &get_info ) ) {
        if( req_algo != -1 && algo != req_algo )
            continue;
        for(r=digest_list; r; r = r->next )
@@ -157,7 +191,7 @@ load_digest_module( int req_algo )
            continue;
        }
        /* put it into the list */
-       if( g10_opt_verbose > 1 )
+       if( _gcry_log_verbosity( 2 ) )
            log_info("loaded digest %d\n", algo);
        r->next = digest_list;
        digest_list = r;
@@ -165,7 +199,7 @@ load_digest_module( int req_algo )
        if( req_algo != -1 )
            break;
     }
-    enum_gnupgext_digests( &context, NULL, NULL );
+    _gcry_enum_gnupgext_digests( &context, NULL, NULL );
     return any;
 }
 
@@ -178,6 +212,26 @@ int
 gcry_md_map_name( const char *string )
 {
     struct md_digest_list_s *r;
+    
+    if (!string)
+      return 0;
+
+    /* If the string starts with a digit (optionally prefixed with
+       either "OID." or "oid."), we first look into our table of ASN.1
+       object identifiers to figure out the algorithm */
+    if (digitp (string)
+        || !strncmp (string, "oid.", 4) 
+        || !strncmp (string, "OID.", 4) )
+      {
+        int i;
+        const char *s =  digitp(string)? string : (string+4);
+
+        for (i=0; oid_table[i].oidstring; i++)
+          {
+            if (!strcmp (s, oid_table[i].oidstring))
+              return oid_table[i].algo;
+          }
+      }
 
     do {
        for(r = digest_list; r; r = r->next )
@@ -239,7 +293,7 @@ check_digest_algo( int algo )
  * may be 0.
  */
 static GCRY_MD_HD
-md_open( int algo, int secure )
+md_open( int algo, int secure, int hmac )
 {
     GCRY_MD_HD hd;
     struct gcry_md_context *ctx;
@@ -265,8 +319,8 @@ md_open( int algo, int secure )
         / sizeof(PROPERLY_ALIGNED_TYPE) ) * sizeof(PROPERLY_ALIGNED_TYPE);
 
     /* allocate and set the Context pointer to the private data */
-    hd = secure ? g10_malloc_secure( n + sizeof( struct gcry_md_context ) )
-               : g10_malloc(        n + sizeof( struct gcry_md_context ) );
+    hd = secure ? gcry_malloc_secure( n + sizeof( struct gcry_md_context ) )
+               : gcry_malloc(       n + sizeof( struct gcry_md_context ) );
     if( !hd ) {
        set_lasterr( GCRYERR_NO_MEM );
        return NULL;
@@ -280,6 +334,14 @@ md_open( int algo, int secure )
     memset( hd->ctx, 0, sizeof *hd->ctx );
     ctx->magic = secure ? CTX_MAGIC_SECURE : CTX_MAGIC_NORMAL;
     ctx->secure = secure;
+    if( hmac ) {
+       ctx->macpads = gcry_malloc_secure( 128 );
+       if( !ctx->macpads ) {
+           md_close( hd );
+           set_lasterr( GCRYERR_NO_MEM );
+           return NULL;
+       }
+    }
     fast_random_poll(); /* FIXME: should we really do that? */
     if( algo && md_enable( hd, algo ) ) {
        md_close( hd );
@@ -289,14 +351,23 @@ md_open( int algo, int secure )
 }
 
 
-GCRY_MD_HD
-gcry_md_open( int algo, unsigned int flags )
+/* Create a message digest object for algorithm ALGO.  FLAGS may be
+   given as an bitwise OR of the gcry_md_flags values.  ALGO may be
+   given as 0 if the algorithms to be used are later set using
+   gcry_md_enable. */
+GcryMDHd
+gcry_md_open (int algo, unsigned int flags)
 {
-    GCRY_MD_HD hd;
-    /* fixme: check that algo is available and that only valid
-     * flag values are used */
-    hd = md_open( algo, (flags & GCRY_MD_FLAG_SECURE) );
-    return hd;
+  GCRY_MD_HD hd;
+
+  if ((flags & ~(GCRY_MD_FLAG_SECURE | GCRY_MD_FLAG_HMAC)))
+    {
+      set_lasterr (GCRYERR_INV_ARG);
+      return NULL;
+    }
+  hd = md_open (algo, (flags & GCRY_MD_FLAG_SECURE),
+                (flags & GCRY_MD_FLAG_HMAC));
+  return hd;
 }
 
 
@@ -321,9 +392,9 @@ md_enable( GCRY_MD_HD hd, int algo )
        return set_lasterr( GCRYERR_INV_MD_ALGO );
     }
     /* and allocate a new list entry */
-    ac = h->secure? g10_malloc_secure( sizeof *ac + r->contextsize
+    ac = h->secure? gcry_malloc_secure( sizeof *ac + r->contextsize
                                               - sizeof(r->context) )
-                 : g10_malloc( sizeof *ac + r->contextsize
+                 : gcry_malloc( sizeof *ac + r->contextsize
                                               - sizeof(r->context) );
     if( !ac )
        return set_lasterr( GCRYERR_NO_MEM );
@@ -356,8 +427,8 @@ md_copy( GCRY_MD_HD ahd )
        md_write( ahd, NULL, 0 );
 
     n = (char*)ahd->ctx - (char*)ahd;
-    bhd = a->secure ? g10_malloc_secure( n + sizeof( struct gcry_md_context ) )
-                   : g10_malloc(        n + sizeof( struct gcry_md_context ) );
+    bhd = a->secure ? gcry_malloc_secure( n + sizeof( struct gcry_md_context ) )
+                   : gcry_malloc(       n + sizeof( struct gcry_md_context ) );
     if( !bhd ) {
        set_lasterr( GCRYERR_NO_MEM );
        return NULL;
@@ -371,12 +442,16 @@ md_copy( GCRY_MD_HD ahd )
     memcpy( b, a, sizeof *a );
     b->list = NULL;
     b->debug = NULL;
+    if( a->macpads ) {
+       b->macpads = gcry_malloc_secure( 128 );
+       memcpy( b->macpads, a->macpads, 128 );
+    }
     /* and now copy the complete list of algorithms */
     /* I know that the copied list is reversed, but that doesn't matter */
     for( ar=a->list; ar; ar = ar->next ) {
-       br = a->secure ? g10_xmalloc_secure( sizeof *br + ar->contextsize
+       br = a->secure ? gcry_xmalloc_secure( sizeof *br + ar->contextsize
                                               - sizeof(ar->context) )
-                      : g10_xmalloc( sizeof *br + ar->contextsize
+                      : gcry_xmalloc( sizeof *br + ar->contextsize
                                               - sizeof(ar->context) );
        memcpy( br, ar, sizeof(*br) + ar->contextsize
                                    - sizeof(ar->context) );
@@ -409,6 +484,9 @@ gcry_md_reset( GCRY_MD_HD a )
        memset( r->context.c, 0, r->contextsize );
        (*r->init)( &r->context.c );
     }
+    if( a->ctx->macpads ) {
+       md_write( a, a->ctx->macpads, 64 ); /* inner pad */
+    }
 }
 
 
@@ -423,9 +501,10 @@ md_close(GCRY_MD_HD a)
        md_stop_debug(a);
     for(r=a->ctx->list; r; r = r2 ) {
        r2 = r->next;
-       g10_free(r);
+       gcry_free(r);
     }
-    g10_free(a);
+    gcry_free(a->ctx->macpads);
+    gcry_free(a);
 }
 
 
@@ -457,9 +536,9 @@ md_write( GCRY_MD_HD a, byte *inbuf, size_t inlen)
 
 
 void
-gcry_md_write( GCRY_MD_HD hd, const byte *inbuf, size_t inlen)
+gcry_md_write( GCRY_MD_HD hd, const void *inbuf, size_t inlen)
 {
-    md_write( hd, (byte*)inbuf, inlen );
+    md_write( hd, (unsigned char *)inbuf, inlen );
 }
 
 
@@ -479,17 +558,91 @@ md_final(GCRY_MD_HD a)
        (*r->final)( &r->context.c );
     }
     a->ctx->finalized = 1;
+    if( a->ctx->macpads ) {  /* finish the hmac */
+       int algo = md_get_algo( a );
+       byte *p = md_read( a, algo );
+       size_t dlen = md_digest_length(algo);
+
+       GCRY_MD_HD om = md_open( algo, a->ctx->secure, 0 );
+       if( !om )
+           _gcry_fatal_error( gcry_errno(), NULL );
+       md_write( om, a->ctx->macpads+64, 64 );
+       md_write( om, p, dlen );
+       md_final( om );
+       /* replace our digest with the mac (they have the same size) */
+       memcpy( p, md_read( om, algo ), dlen );
+       md_close( om );
+    }
 }
 
 
+
+static int
+prepare_macpads( GCRY_MD_HD hd, const byte *key, size_t keylen)
+{
+    int i;
+    int algo = md_get_algo( hd );
+    byte *helpkey = NULL;
+    byte *ipad, *opad;
+
+    if( !algo )
+       return GCRYERR_INV_MD_ALGO; /* i.e. no algo enabled */
+
+    if( keylen > 64 ) {
+       helpkey = gcry_malloc_secure( md_digest_length( algo ) );
+       if( !helpkey )
+           return GCRYERR_NO_MEM;
+       gcry_md_hash_buffer( algo, helpkey, key, keylen );
+       key = helpkey;
+       keylen = md_digest_length( algo );
+       assert( keylen <= 64 );
+    }
+
+    memset( hd->ctx->macpads, 0, 128 );
+    ipad = hd->ctx->macpads;
+    opad = hd->ctx->macpads+64;
+    memcpy( ipad, key, keylen );
+    memcpy( opad, key, keylen );
+    for(i=0; i < 64; i++ ) {
+       ipad[i] ^= 0x36;
+       opad[i] ^= 0x5c;
+    }
+    gcry_free( helpkey );
+    return 0;
+}
+
 int
 gcry_md_ctl( GCRY_MD_HD hd, int cmd, byte *buffer, size_t buflen)
 {
+    int rc = 0;
     if( cmd == GCRYCTL_FINALIZE )
        md_final( hd );
+    else if( cmd == GCRYCTL_SET_KEY ) {
+        rc = gcry_md_setkey ( hd, buffer, buflen );
+    }
+    else if( cmd == GCRYCTL_START_DUMP ) {
+       md_start_debug( hd, buffer );
+    }
+    else if( cmd == GCRYCTL_STOP_DUMP ) {
+       md_stop_debug( hd );
+    }
     else
-       return GCRYERR_INV_OP;
-    return 0;
+       rc = GCRYERR_INV_OP;
+    return set_lasterr( rc );
+}
+
+
+int
+gcry_md_setkey( GCRY_MD_HD hd, const void *key, size_t keylen )
+{
+    int rc = 0;
+
+    if( !(hd->ctx->macpads ) )
+        rc = GCRYERR_CONFLICT;
+    else if ( !(rc = prepare_macpads( hd, key, keylen )) )
+        gcry_md_reset( hd );
+
+    return rc;
 }
 
 
@@ -566,8 +719,8 @@ md_digest( GCRY_MD_HD a, int algo, byte *buffer, int buflen )
 
     /* I don't want to change the interface, so I simply work on a copy
      * of the context (extra overhead - should be fixed)*/
-    context = a->ctx->secure ? g10_xmalloc_secure( r->contextsize )
-                            : g10_xmalloc( r->contextsize );
+    context = a->ctx->secure ? gcry_xmalloc_secure( r->contextsize )
+                            : gcry_xmalloc( r->contextsize );
     memcpy( context, r->context.c, r->contextsize );
     (*r->final)( context );
     digest = (*r->read)( context );
@@ -576,7 +729,7 @@ md_digest( GCRY_MD_HD a, int algo, byte *buffer, int buflen )
        buflen = r->mdlen;
     memcpy( buffer, digest, buflen );
 
-    g10_free(context);
+    gcry_free(context);
     return buflen;
 }
 #endif
@@ -596,15 +749,23 @@ gcry_md_get( GCRY_MD_HD hd, int algo, byte *buffer, int buflen )
  * Shortcut function to hash a buffer with a given algo. The only supported
  * algorithm is RIPE-MD. The supplied digest buffer must be large enough
  * to store the resulting hash.  No error is returned, the function will
- * abort on an invalite algo.  DISABLED_ALGOS are ignored here.
+ * abort on an invalid algo.  DISABLED_ALGOS are ignored here.
  */
 void
-gcry_md_hash_buffer( int algo, char *digest, const char *buffer, size_t length)
+gcry_md_hash_buffer( int algo, void *digest, const void *buffer, size_t length)
 {
     if( algo == GCRY_MD_RMD160 )
-       rmd160_hash_buffer( digest, buffer, length );
-    else
-       BUG();
+       _gcry_rmd160_hash_buffer( digest, buffer, length );
+    else { /* for the others we do not have a fast function, so
+           * we use the normal functions to do it */
+       GCRY_MD_HD h = md_open( algo, 0, 0 );
+       if( !h )
+           BUG(); /* algo not available */
+       md_write( h, (byte*)buffer, length );
+       md_final( h );
+       memcpy( digest, md_read( h, algo ), md_digest_length( algo ) );
+        md_close (h);
+    }
 }
 
 static int
@@ -622,9 +783,15 @@ md_get_algo( GCRY_MD_HD a )
 
 
 int
-gcry_md_get_algo( GCRY_MD_HD hd )
+gcry_md_get_algo (GCRY_MD_HD hd)
 {
-    return md_get_algo( hd ); /* fixme: we need error handling */
+  int algo = md_get_algo (hd);
+  if (!algo)
+    {
+      set_lasterr (GCRYERR_GENERAL);
+      return 0;
+    }
+  return algo;
 }
 
 
@@ -652,18 +819,26 @@ md_digest_length( int algo )
 unsigned int
 gcry_md_get_algo_dlen( int algo )
 {
-    /* we do some very quick checks here */
-    switch( algo )
+  /* we cheat a little bit */
+  switch( algo )
     {
-      case GCRY_MD_MD5: return 16;
-      case GCRY_MD_SHA1:
-      case GCRY_MD_RMD160: return 20;
-      default: {
-           int len = md_digest_length( algo );
-           if( !len )
-               set_lasterr( GCRYERR_INV_MD_ALGO );
-           return 0;
-       }
+    case GCRY_MD_MD4:
+    case GCRY_MD_MD5: return 16;
+    case GCRY_MD_SHA1:
+    case GCRY_MD_RMD160: return 20;
+    case GCRY_MD_SHA256: return 32;
+    case GCRY_MD_SHA384: return 48;
+    case GCRY_MD_SHA512: return 64;
+    case GCRY_MD_CRC32:
+    case GCRY_MD_CRC32_RFC1510: return 4;
+    case GCRY_MD_CRC24_RFC2440: return 3;
+    default: 
+      {
+        int len = md_digest_length( algo );
+        if( !len )
+          set_lasterr( GCRYERR_INV_MD_ALGO );
+        return 0;
+      }
     }
 }
 
@@ -704,7 +879,7 @@ md_asn_oid( int algo, size_t *asnlen, size_t *mdlen )
  *
  * On error the value -1 is returned and the error reason may be
  * retrieved by gcry_errno().
- * Note:  Because this function is in most caes used to return an
+ * Note:  Because this function is in most cases used to return an
  * integer value, we can make it easier for the caller to just look at
  * the return value.  The caller will in all cases consult the value
  * and thereby detecting whether a error occured or not (i.e. while checking
@@ -752,7 +927,7 @@ gcry_md_algo_info( int algo, int what, void *buffer, size_t *nbytes)
 
 
 
-void
+static void
 md_start_debug( GCRY_MD_HD md, const char *suffix )
 {
     static int idx=0;
@@ -769,7 +944,7 @@ md_start_debug( GCRY_MD_HD md, const char *suffix )
        log_debug("md debug: can't open %s\n", buf );
 }
 
-void
+static void
 md_stop_debug( GCRY_MD_HD md )
 {
     if( md->ctx->debug ) {
@@ -795,14 +970,35 @@ md_stop_debug( GCRY_MD_HD md )
  *  GCRYCTL_IS_SECURE:
  *     Returns 1 when the handle works on secured memory
  *     otherwise 0 is returned.  There is no error return.
+ *  GCRYCTL_IS_ALGO_ENABLED:
+ *     Returns 1 if the algo is enanled for that handle.
+ *     The algo must be passed as the address of an int.
  */
 int
 gcry_md_info( GCRY_MD_HD h, int cmd, void *buffer, size_t *nbytes)
 {
+
     switch( cmd ) {
       case GCRYCTL_IS_SECURE:
        return h->ctx->secure;
 
+      case GCRYCTL_IS_ALGO_ENABLED:
+        {
+            int algo;
+            struct md_digest_list_s *r;
+
+            if (!buffer || (nbytes && *nbytes != sizeof (int))) {
+                set_lasterr (GCRYERR_INV_ARG);
+                return -1;
+            }
+            algo = *(int*)buffer;        
+            for(r=h->ctx->list; r; r = r->next ) {
+                if( r->algo == algo )
+                    return 1;
+            }
+        }
+        break;
+
       default:
        set_lasterr( GCRYERR_INV_OP );
        return -1;
@@ -810,3 +1006,6 @@ gcry_md_info( GCRY_MD_HD h, int cmd, void *buffer, size_t *nbytes)
     return 0;
 }
 
+
+
+