Home | History | Annotate | Download | only in digest_extra
      1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      2  * All rights reserved.
      3  *
      4  * This package is an SSL implementation written
      5  * by Eric Young (eay (at) cryptsoft.com).
      6  * The implementation was written so as to conform with Netscapes SSL.
      7  *
      8  * This library is free for commercial and non-commercial use as long as
      9  * the following conditions are aheared to.  The following conditions
     10  * apply to all code found in this distribution, be it the RC4, RSA,
     11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
     12  * included with this distribution is covered by the same copyright terms
     13  * except that the holder is Tim Hudson (tjh (at) cryptsoft.com).
     14  *
     15  * Copyright remains Eric Young's, and as such any Copyright notices in
     16  * the code are not to be removed.
     17  * If this package is used in a product, Eric Young should be given attribution
     18  * as the author of the parts of the library used.
     19  * This can be in the form of a textual message at program startup or
     20  * in documentation (online or textual) provided with the package.
     21  *
     22  * Redistribution and use in source and binary forms, with or without
     23  * modification, are permitted provided that the following conditions
     24  * are met:
     25  * 1. Redistributions of source code must retain the copyright
     26  *    notice, this list of conditions and the following disclaimer.
     27  * 2. Redistributions in binary form must reproduce the above copyright
     28  *    notice, this list of conditions and the following disclaimer in the
     29  *    documentation and/or other materials provided with the distribution.
     30  * 3. All advertising materials mentioning features or use of this software
     31  *    must display the following acknowledgement:
     32  *    "This product includes cryptographic software written by
     33  *     Eric Young (eay (at) cryptsoft.com)"
     34  *    The word 'cryptographic' can be left out if the rouines from the library
     35  *    being used are not cryptographic related :-).
     36  * 4. If you include any Windows specific code (or a derivative thereof) from
     37  *    the apps directory (application code) you must include an acknowledgement:
     38  *    "This product includes software written by Tim Hudson (tjh (at) cryptsoft.com)"
     39  *
     40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
     41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     50  * SUCH DAMAGE.
     51  *
     52  * The licence and distribution terms for any publically available version or
     53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
     54  * copied and put under another distribution licence
     55  * [including the GNU Public Licence.] */
     56 
     57 #include <openssl/digest.h>
     58 
     59 #include <string.h>
     60 
     61 #include <openssl/asn1.h>
     62 #include <openssl/bytestring.h>
     63 #include <openssl/nid.h>
     64 
     65 #include "../internal.h"
     66 
     67 
     68 struct nid_to_digest {
     69   int nid;
     70   const EVP_MD* (*md_func)(void);
     71   const char *short_name;
     72   const char *long_name;
     73 };
     74 
     75 static const struct nid_to_digest nid_to_digest_mapping[] = {
     76     {NID_md4, EVP_md4, SN_md4, LN_md4},
     77     {NID_md5, EVP_md5, SN_md5, LN_md5},
     78     {NID_sha1, EVP_sha1, SN_sha1, LN_sha1},
     79     {NID_sha224, EVP_sha224, SN_sha224, LN_sha224},
     80     {NID_sha256, EVP_sha256, SN_sha256, LN_sha256},
     81     {NID_sha384, EVP_sha384, SN_sha384, LN_sha384},
     82     {NID_sha512, EVP_sha512, SN_sha512, LN_sha512},
     83     {NID_md5_sha1, EVP_md5_sha1, SN_md5_sha1, LN_md5_sha1},
     84     // As a remnant of signing |EVP_MD|s, OpenSSL returned the corresponding
     85     // hash function when given a signature OID. To avoid unintended lax parsing
     86     // of hash OIDs, this is no longer supported for lookup by OID or NID.
     87     // Node.js, however, exposes |EVP_get_digestbyname|'s full behavior to
     88     // consumers so we retain it there.
     89     {NID_undef, EVP_sha1, SN_dsaWithSHA, LN_dsaWithSHA},
     90     {NID_undef, EVP_sha1, SN_dsaWithSHA1, LN_dsaWithSHA1},
     91     {NID_undef, EVP_sha1, SN_ecdsa_with_SHA1, NULL},
     92     {NID_undef, EVP_md5, SN_md5WithRSAEncryption, LN_md5WithRSAEncryption},
     93     {NID_undef, EVP_sha1, SN_sha1WithRSAEncryption, LN_sha1WithRSAEncryption},
     94     {NID_undef, EVP_sha224, SN_sha224WithRSAEncryption,
     95      LN_sha224WithRSAEncryption},
     96     {NID_undef, EVP_sha256, SN_sha256WithRSAEncryption,
     97      LN_sha256WithRSAEncryption},
     98     {NID_undef, EVP_sha384, SN_sha384WithRSAEncryption,
     99      LN_sha384WithRSAEncryption},
    100     {NID_undef, EVP_sha512, SN_sha512WithRSAEncryption,
    101      LN_sha512WithRSAEncryption},
    102 };
    103 
    104 const EVP_MD* EVP_get_digestbynid(int nid) {
    105   if (nid == NID_undef) {
    106     // Skip the |NID_undef| entries in |nid_to_digest_mapping|.
    107     return NULL;
    108   }
    109 
    110   for (unsigned i = 0; i < OPENSSL_ARRAY_SIZE(nid_to_digest_mapping); i++) {
    111     if (nid_to_digest_mapping[i].nid == nid) {
    112       return nid_to_digest_mapping[i].md_func();
    113     }
    114   }
    115 
    116   return NULL;
    117 }
    118 
    119 static const struct {
    120   uint8_t oid[9];
    121   uint8_t oid_len;
    122   int nid;
    123 } kMDOIDs[] = {
    124   // 1.2.840.113549.2.4
    125   { {0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x04}, 8, NID_md4 },
    126   // 1.2.840.113549.2.5
    127   { {0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x05}, 8, NID_md5 },
    128   // 1.3.14.3.2.26
    129   { {0x2b, 0x0e, 0x03, 0x02, 0x1a}, 5, NID_sha1 },
    130   // 2.16.840.1.101.3.4.2.1
    131   { {0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01}, 9, NID_sha256 },
    132   // 2.16.840.1.101.3.4.2.2
    133   { {0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x02}, 9, NID_sha384 },
    134   // 2.16.840.1.101.3.4.2.3
    135   { {0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x03}, 9, NID_sha512 },
    136   // 2.16.840.1.101.3.4.2.4
    137   { {0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x04}, 9, NID_sha224 },
    138 };
    139 
    140 static const EVP_MD *cbs_to_md(const CBS *cbs) {
    141   for (size_t i = 0; i < OPENSSL_ARRAY_SIZE(kMDOIDs); i++) {
    142     if (CBS_len(cbs) == kMDOIDs[i].oid_len &&
    143         OPENSSL_memcmp(CBS_data(cbs), kMDOIDs[i].oid, kMDOIDs[i].oid_len) ==
    144             0) {
    145       return EVP_get_digestbynid(kMDOIDs[i].nid);
    146     }
    147   }
    148 
    149   return NULL;
    150 }
    151 
    152 const EVP_MD *EVP_get_digestbyobj(const ASN1_OBJECT *obj) {
    153   // Handle objects with no corresponding OID.
    154   if (obj->nid != NID_undef) {
    155     return EVP_get_digestbynid(obj->nid);
    156   }
    157 
    158   CBS cbs;
    159   CBS_init(&cbs, obj->data, obj->length);
    160   return cbs_to_md(&cbs);
    161 }
    162 
    163 const EVP_MD *EVP_parse_digest_algorithm(CBS *cbs) {
    164   CBS algorithm, oid;
    165   if (!CBS_get_asn1(cbs, &algorithm, CBS_ASN1_SEQUENCE) ||
    166       !CBS_get_asn1(&algorithm, &oid, CBS_ASN1_OBJECT)) {
    167     OPENSSL_PUT_ERROR(DIGEST, DIGEST_R_DECODE_ERROR);
    168     return NULL;
    169   }
    170 
    171   const EVP_MD *ret = cbs_to_md(&oid);
    172   if (ret == NULL) {
    173     OPENSSL_PUT_ERROR(DIGEST, DIGEST_R_UNKNOWN_HASH);
    174     return NULL;
    175   }
    176 
    177   // The parameters, if present, must be NULL. Historically, whether the NULL
    178   // was included or omitted was not well-specified. When parsing an
    179   // AlgorithmIdentifier, we allow both. (Note this code is not used when
    180   // verifying RSASSA-PKCS1-v1_5 signatures.)
    181   if (CBS_len(&algorithm) > 0) {
    182     CBS param;
    183     if (!CBS_get_asn1(&algorithm, &param, CBS_ASN1_NULL) ||
    184         CBS_len(&param) != 0 ||
    185         CBS_len(&algorithm) != 0) {
    186       OPENSSL_PUT_ERROR(DIGEST, DIGEST_R_DECODE_ERROR);
    187       return NULL;
    188     }
    189   }
    190 
    191   return ret;
    192 }
    193 
    194 int EVP_marshal_digest_algorithm(CBB *cbb, const EVP_MD *md) {
    195   CBB algorithm, oid, null;
    196   if (!CBB_add_asn1(cbb, &algorithm, CBS_ASN1_SEQUENCE) ||
    197       !CBB_add_asn1(&algorithm, &oid, CBS_ASN1_OBJECT)) {
    198     OPENSSL_PUT_ERROR(DIGEST, ERR_R_MALLOC_FAILURE);
    199     return 0;
    200   }
    201 
    202   int found = 0;
    203   int nid = EVP_MD_type(md);
    204   for (size_t i = 0; i < OPENSSL_ARRAY_SIZE(kMDOIDs); i++) {
    205     if (nid == kMDOIDs[i].nid) {
    206       if (!CBB_add_bytes(&oid, kMDOIDs[i].oid, kMDOIDs[i].oid_len)) {
    207         OPENSSL_PUT_ERROR(DIGEST, ERR_R_MALLOC_FAILURE);
    208         return 0;
    209       }
    210       found = 1;
    211       break;
    212     }
    213   }
    214 
    215   if (!found) {
    216     OPENSSL_PUT_ERROR(DIGEST, DIGEST_R_UNKNOWN_HASH);
    217     return 0;
    218   }
    219 
    220   if (!CBB_add_asn1(&algorithm, &null, CBS_ASN1_NULL) ||
    221       !CBB_flush(cbb)) {
    222     OPENSSL_PUT_ERROR(DIGEST, ERR_R_MALLOC_FAILURE);
    223     return 0;
    224   }
    225 
    226   return 1;
    227 }
    228 
    229 const EVP_MD *EVP_get_digestbyname(const char *name) {
    230   for (unsigned i = 0; i < OPENSSL_ARRAY_SIZE(nid_to_digest_mapping); i++) {
    231     const char *short_name = nid_to_digest_mapping[i].short_name;
    232     const char *long_name = nid_to_digest_mapping[i].long_name;
    233     if ((short_name && strcmp(short_name, name) == 0) ||
    234         (long_name && strcmp(long_name, name) == 0)) {
    235       return nid_to_digest_mapping[i].md_func();
    236     }
    237   }
    238 
    239   return NULL;
    240 }
    241