2 * validator/val_secalgo.c - validator security algorithm functions.
4 * Copyright (c) 2012, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * This file contains helper functions for the validator module.
40 * These functions take raw data buffers, formatted for crypto verification,
41 * and do the library calls (for the crypto library in use).
44 /* packed_rrset on top to define enum types (forced by c99 standard) */
45 #include "util/data/packed_rrset.h"
46 #include "validator/val_secalgo.h"
47 #include "validator/val_nsec3.h"
49 #include "sldns/rrdef.h"
50 #include "sldns/keyraw.h"
51 #include "sldns/sbuffer.h"
53 #if !defined(HAVE_SSL) && !defined(HAVE_NSS) && !defined(HAVE_NETTLE)
54 #error "Need crypto library to do digital signature cryptography"
57 /* OpenSSL implementation */
59 #ifdef HAVE_OPENSSL_ERR_H
60 #include <openssl/err.h>
63 #ifdef HAVE_OPENSSL_RAND_H
64 #include <openssl/rand.h>
67 #ifdef HAVE_OPENSSL_CONF_H
68 #include <openssl/conf.h>
71 #ifdef HAVE_OPENSSL_ENGINE_H
72 #include <openssl/engine.h>
75 /* return size of digest if supported, or 0 otherwise */
77 nsec3_hash_algo_size_supported(int id)
81 return SHA_DIGEST_LENGTH;
87 /* perform nsec3 hash. return false on failure */
89 secalgo_nsec3_hash(int algo, unsigned char* buf, size_t len,
94 (void)SHA1(buf, len, res);
102 secalgo_hash_sha256(unsigned char* buf, size_t len, unsigned char* res)
104 (void)SHA256(buf, len, res);
108 * Return size of DS digest according to its hash algorithm.
109 * @param algo: DS digest algo.
110 * @return size in bytes of digest, or 0 if not supported.
113 ds_digest_size_supported(int algo)
118 return SHA_DIGEST_LENGTH;
120 #ifdef HAVE_EVP_SHA256
122 return SHA256_DIGEST_LENGTH;
126 /* we support GOST if it can be loaded */
127 (void)sldns_key_EVP_load_gost_id();
128 if(EVP_get_digestbyname("md_gost94"))
134 return SHA384_DIGEST_LENGTH;
142 /** Perform GOST hash */
144 do_gost94(unsigned char* data, size_t len, unsigned char* dest)
146 const EVP_MD* md = EVP_get_digestbyname("md_gost94");
149 return sldns_digest_evp(data, (unsigned int)len, dest, md);
154 secalgo_ds_digest(int algo, unsigned char* buf, size_t len,
160 (void)SHA1(buf, len, res);
163 #ifdef HAVE_EVP_SHA256
165 (void)SHA256(buf, len, res);
170 if(do_gost94(buf, len, res))
176 (void)SHA384(buf, len, res);
180 verbose(VERB_QUERY, "unknown DS digest algorithm %d",
187 /** return true if DNSKEY algorithm id is supported */
189 dnskey_algo_id_is_supported(int id)
193 /* RFC 6725 deprecates RSAMD5 */
200 case LDNS_RSASHA1_NSEC3:
201 #if defined(HAVE_EVP_SHA256) && defined(USE_SHA2)
204 #if defined(HAVE_EVP_SHA512) && defined(USE_SHA2)
208 case LDNS_ECDSAP256SHA256:
209 case LDNS_ECDSAP384SHA384:
214 /* we support GOST if it can be loaded */
215 return sldns_key_EVP_load_gost_id();
223 * Output a libcrypto openssl error to the logfile.
224 * @param str: string to add to it.
225 * @param e: the error to output, error number from ERR_get_error().
228 log_crypto_error(const char* str, unsigned long e)
231 /* or use ERR_error_string if ERR_error_string_n is not avail TODO */
232 ERR_error_string_n(e, buf, sizeof(buf));
233 /* buf now contains */
234 /* error:[error code]:[library name]:[function name]:[reason string] */
235 log_err("%s crypto %s", str, buf);
240 * Setup DSA key digest in DER encoding ...
241 * @param sig: input is signature output alloced ptr (unless failure).
242 * caller must free alloced ptr if this routine returns true.
243 * @param len: input is initial siglen, output is output len.
244 * @return false on failure.
247 setup_dsa_sig(unsigned char** sig, unsigned int* len)
249 unsigned char* orig = *sig;
250 unsigned int origlen = *len;
255 /* extract the R and S field from the sig buffer */
256 if(origlen < 1 + 2*SHA_DIGEST_LENGTH)
260 (void) BN_bin2bn(orig + 1, SHA_DIGEST_LENGTH, R);
263 (void) BN_bin2bn(orig + 21, SHA_DIGEST_LENGTH, S);
264 dsasig = DSA_SIG_new();
265 if(!dsasig) return 0;
270 newlen = i2d_DSA_SIG(dsasig, sig);
272 DSA_SIG_free(dsasig);
276 *len = (unsigned int)newlen;
277 DSA_SIG_free(dsasig);
284 * Setup the ECDSA signature in its encoding that the library wants.
285 * Converts from plain numbers to ASN formatted.
286 * @param sig: input is signature, output alloced ptr (unless failure).
287 * caller must free alloced ptr if this routine returns true.
288 * @param len: input is initial siglen, output is output len.
289 * @return false on failure.
292 setup_ecdsa_sig(unsigned char** sig, unsigned int* len)
294 /* convert from two BIGNUMs in the rdata buffer, to ASN notation.
295 * ASN preable: 30440220 <R 32bytefor256> 0220 <S 32bytefor256>
296 * the '20' is the length of that field (=bnsize).
297 i * the '44' is the total remaining length.
298 * if negative, start with leading zero.
299 * if starts with 00s, remove them from the number.
301 uint8_t pre[] = {0x30, 0x44, 0x02, 0x20};
303 uint8_t mid[] = {0x02, 0x20};
305 int raw_sig_len, r_high, s_high, r_rem=0, s_rem=0;
306 int bnsize = (int)((*len)/2);
307 unsigned char* d = *sig;
309 /* if too short or not even length, fails */
310 if(*len < 16 || bnsize*2 != (int)*len)
313 /* strip leading zeroes from r (but not last one) */
314 while(r_rem < bnsize-1 && d[r_rem] == 0)
316 /* strip leading zeroes from s (but not last one) */
317 while(s_rem < bnsize-1 && d[bnsize+s_rem] == 0)
320 r_high = ((d[0+r_rem]&0x80)?1:0);
321 s_high = ((d[bnsize+s_rem]&0x80)?1:0);
322 raw_sig_len = pre_len + r_high + bnsize - r_rem + mid_len +
323 s_high + bnsize - s_rem;
324 *sig = (unsigned char*)malloc((size_t)raw_sig_len);
329 p[1] = (uint8_t)(raw_sig_len-2);
331 p[3] = (uint8_t)(bnsize + r_high - r_rem);
337 memmove(p, d+r_rem, (size_t)bnsize-r_rem);
339 memmove(p, mid, (size_t)mid_len-1);
341 *p = (uint8_t)(bnsize + s_high - s_rem);
347 memmove(p, d+bnsize+s_rem, (size_t)bnsize-s_rem);
348 *len = (unsigned int)raw_sig_len;
351 #endif /* USE_ECDSA */
353 #ifdef USE_ECDSA_EVP_WORKAROUND
354 static EVP_MD ecdsa_evp_256_md;
355 static EVP_MD ecdsa_evp_384_md;
356 void ecdsa_evp_workaround_init(void)
358 /* openssl before 1.0.0 fixes RSA with the SHA256
359 * hash in EVP. We create one for ecdsa_sha256 */
360 ecdsa_evp_256_md = *EVP_sha256();
361 ecdsa_evp_256_md.required_pkey_type[0] = EVP_PKEY_EC;
362 ecdsa_evp_256_md.verify = (void*)ECDSA_verify;
364 ecdsa_evp_384_md = *EVP_sha384();
365 ecdsa_evp_384_md.required_pkey_type[0] = EVP_PKEY_EC;
366 ecdsa_evp_384_md.verify = (void*)ECDSA_verify;
368 #endif /* USE_ECDSA_EVP_WORKAROUND */
371 * Setup key and digest for verification. Adjust sig if necessary.
373 * @param algo: key algorithm
374 * @param evp_key: EVP PKEY public key to create.
375 * @param digest_type: digest type to use
376 * @param key: key to setup for.
377 * @param keylen: length of key.
378 * @return false on failure.
381 setup_key_digest(int algo, EVP_PKEY** evp_key, const EVP_MD** digest_type,
382 unsigned char* key, size_t keylen)
393 *evp_key = EVP_PKEY_new();
395 log_err("verify: malloc failure in crypto");
398 dsa = sldns_key_buf2dsa_raw(key, keylen);
400 verbose(VERB_QUERY, "verify: "
401 "sldns_key_buf2dsa_raw failed");
404 if(EVP_PKEY_assign_DSA(*evp_key, dsa) == 0) {
405 verbose(VERB_QUERY, "verify: "
406 "EVP_PKEY_assign_DSA failed");
409 *digest_type = EVP_dss1();
414 case LDNS_RSASHA1_NSEC3:
415 #if defined(HAVE_EVP_SHA256) && defined(USE_SHA2)
418 #if defined(HAVE_EVP_SHA512) && defined(USE_SHA2)
421 *evp_key = EVP_PKEY_new();
423 log_err("verify: malloc failure in crypto");
426 rsa = sldns_key_buf2rsa_raw(key, keylen);
428 verbose(VERB_QUERY, "verify: "
429 "sldns_key_buf2rsa_raw SHA failed");
432 if(EVP_PKEY_assign_RSA(*evp_key, rsa) == 0) {
433 verbose(VERB_QUERY, "verify: "
434 "EVP_PKEY_assign_RSA SHA failed");
438 /* select SHA version */
439 #if defined(HAVE_EVP_SHA256) && defined(USE_SHA2)
440 if(algo == LDNS_RSASHA256)
441 *digest_type = EVP_sha256();
444 #if defined(HAVE_EVP_SHA512) && defined(USE_SHA2)
445 if(algo == LDNS_RSASHA512)
446 *digest_type = EVP_sha512();
449 *digest_type = EVP_sha1();
453 *evp_key = EVP_PKEY_new();
455 log_err("verify: malloc failure in crypto");
458 rsa = sldns_key_buf2rsa_raw(key, keylen);
460 verbose(VERB_QUERY, "verify: "
461 "sldns_key_buf2rsa_raw MD5 failed");
464 if(EVP_PKEY_assign_RSA(*evp_key, rsa) == 0) {
465 verbose(VERB_QUERY, "verify: "
466 "EVP_PKEY_assign_RSA MD5 failed");
469 *digest_type = EVP_md5();
474 *evp_key = sldns_gost2pkey_raw(key, keylen);
476 verbose(VERB_QUERY, "verify: "
477 "sldns_gost2pkey_raw failed");
480 *digest_type = EVP_get_digestbyname("md_gost94");
482 verbose(VERB_QUERY, "verify: "
483 "EVP_getdigest md_gost94 failed");
489 case LDNS_ECDSAP256SHA256:
490 *evp_key = sldns_ecdsa2pkey_raw(key, keylen,
491 LDNS_ECDSAP256SHA256);
493 verbose(VERB_QUERY, "verify: "
494 "sldns_ecdsa2pkey_raw failed");
497 #ifdef USE_ECDSA_EVP_WORKAROUND
498 *digest_type = &ecdsa_evp_256_md;
500 *digest_type = EVP_sha256();
503 case LDNS_ECDSAP384SHA384:
504 *evp_key = sldns_ecdsa2pkey_raw(key, keylen,
505 LDNS_ECDSAP384SHA384);
507 verbose(VERB_QUERY, "verify: "
508 "sldns_ecdsa2pkey_raw failed");
511 #ifdef USE_ECDSA_EVP_WORKAROUND
512 *digest_type = &ecdsa_evp_384_md;
514 *digest_type = EVP_sha384();
517 #endif /* USE_ECDSA */
519 verbose(VERB_QUERY, "verify: unknown algorithm %d",
527 * Check a canonical sig+rrset and signature against a dnskey
528 * @param buf: buffer with data to verify, the first rrsig part and the
529 * canonicalized rrset.
530 * @param algo: DNSKEY algorithm.
531 * @param sigblock: signature rdata field from RRSIG
532 * @param sigblock_len: length of sigblock data.
533 * @param key: public key data from DNSKEY RR.
534 * @param keylen: length of keydata.
535 * @param reason: bogus reason in more detail.
536 * @return secure if verification succeeded, bogus on crypto failure,
537 * unchecked on format errors and alloc failures.
540 verify_canonrrset(sldns_buffer* buf, int algo, unsigned char* sigblock,
541 unsigned int sigblock_len, unsigned char* key, unsigned int keylen,
544 const EVP_MD *digest_type;
546 int res, dofree = 0, docrypto_free = 0;
547 EVP_PKEY *evp_key = NULL;
549 if(!setup_key_digest(algo, &evp_key, &digest_type, key, keylen)) {
550 verbose(VERB_QUERY, "verify: failed to setup key");
551 *reason = "use of key for crypto failed";
552 EVP_PKEY_free(evp_key);
553 return sec_status_bogus;
556 /* if it is a DSA signature in bind format, convert to DER format */
557 if((algo == LDNS_DSA || algo == LDNS_DSA_NSEC3) &&
558 sigblock_len == 1+2*SHA_DIGEST_LENGTH) {
559 if(!setup_dsa_sig(&sigblock, &sigblock_len)) {
560 verbose(VERB_QUERY, "verify: failed to setup DSA sig");
561 *reason = "use of key for DSA crypto failed";
562 EVP_PKEY_free(evp_key);
563 return sec_status_bogus;
568 #if defined(USE_ECDSA) && defined(USE_DSA)
572 if(algo == LDNS_ECDSAP256SHA256 || algo == LDNS_ECDSAP384SHA384) {
573 /* EVP uses ASN prefix on sig, which is not in the wire data */
574 if(!setup_ecdsa_sig(&sigblock, &sigblock_len)) {
575 verbose(VERB_QUERY, "verify: failed to setup ECDSA sig");
576 *reason = "use of signature for ECDSA crypto failed";
577 EVP_PKEY_free(evp_key);
578 return sec_status_bogus;
582 #endif /* USE_ECDSA */
584 /* do the signature cryptography work */
585 #ifdef HAVE_EVP_MD_CTX_NEW
586 ctx = EVP_MD_CTX_new();
588 ctx = (EVP_MD_CTX*)malloc(sizeof(*ctx));
589 if(ctx) EVP_MD_CTX_init(ctx);
592 log_err("EVP_MD_CTX_new: malloc failure");
593 EVP_PKEY_free(evp_key);
594 if(dofree) free(sigblock);
595 else if(docrypto_free) OPENSSL_free(sigblock);
596 return sec_status_unchecked;
598 if(EVP_VerifyInit(ctx, digest_type) == 0) {
599 verbose(VERB_QUERY, "verify: EVP_VerifyInit failed");
600 EVP_MD_CTX_destroy(ctx);
601 EVP_PKEY_free(evp_key);
602 if(dofree) free(sigblock);
603 else if(docrypto_free) OPENSSL_free(sigblock);
604 return sec_status_unchecked;
606 if(EVP_VerifyUpdate(ctx, (unsigned char*)sldns_buffer_begin(buf),
607 (unsigned int)sldns_buffer_limit(buf)) == 0) {
608 verbose(VERB_QUERY, "verify: EVP_VerifyUpdate failed");
609 EVP_MD_CTX_destroy(ctx);
610 EVP_PKEY_free(evp_key);
611 if(dofree) free(sigblock);
612 else if(docrypto_free) OPENSSL_free(sigblock);
613 return sec_status_unchecked;
616 res = EVP_VerifyFinal(ctx, sigblock, sigblock_len, evp_key);
617 #ifdef HAVE_EVP_MD_CTX_NEW
618 EVP_MD_CTX_destroy(ctx);
620 EVP_MD_CTX_cleanup(ctx);
623 EVP_PKEY_free(evp_key);
625 if(dofree) free(sigblock);
626 else if(docrypto_free) OPENSSL_free(sigblock);
629 return sec_status_secure;
630 } else if(res == 0) {
631 verbose(VERB_QUERY, "verify: signature mismatch");
632 *reason = "signature crypto failed";
633 return sec_status_bogus;
636 log_crypto_error("verify:", ERR_get_error());
637 return sec_status_unchecked;
640 /**************************************************/
641 #elif defined(HAVE_NSS)
642 /* libnss implementation */
648 #include "cryptohi.h"
652 /* return size of digest if supported, or 0 otherwise */
654 nsec3_hash_algo_size_supported(int id)
657 case NSEC3_HASH_SHA1:
664 /* perform nsec3 hash. return false on failure */
666 secalgo_nsec3_hash(int algo, unsigned char* buf, size_t len,
670 case NSEC3_HASH_SHA1:
671 (void)HASH_HashBuf(HASH_AlgSHA1, res, buf, (unsigned long)len);
679 secalgo_hash_sha256(unsigned char* buf, size_t len, unsigned char* res)
681 (void)HASH_HashBuf(HASH_AlgSHA256, res, buf, (unsigned long)len);
685 ds_digest_size_supported(int algo)
693 return SHA256_LENGTH;
697 return SHA384_LENGTH;
699 /* GOST not supported in NSS */
707 secalgo_ds_digest(int algo, unsigned char* buf, size_t len,
713 return HASH_HashBuf(HASH_AlgSHA1, res, buf, len)
715 #if defined(USE_SHA2)
717 return HASH_HashBuf(HASH_AlgSHA256, res, buf, len)
722 return HASH_HashBuf(HASH_AlgSHA384, res, buf, len)
727 verbose(VERB_QUERY, "unknown DS digest algorithm %d",
735 dnskey_algo_id_is_supported(int id)
740 /* RFC 6725 deprecates RSAMD5 */
747 case LDNS_RSASHA1_NSEC3:
756 case LDNS_ECDSAP256SHA256:
757 case LDNS_ECDSAP384SHA384:
758 return PK11_TokenExists(CKM_ECDSA);
766 /* return a new public key for NSS */
767 static SECKEYPublicKey* nss_key_create(KeyType ktype)
769 SECKEYPublicKey* key;
770 PLArenaPool* arena = PORT_NewArena(DER_DEFAULT_CHUNKSIZE);
772 log_err("out of memory, PORT_NewArena failed");
775 key = PORT_ArenaZNew(arena, SECKEYPublicKey);
777 log_err("out of memory, PORT_ArenaZNew failed");
778 PORT_FreeArena(arena, PR_FALSE);
782 key->keyType = ktype;
783 key->pkcs11Slot = NULL;
784 key->pkcs11ID = CK_INVALID_HANDLE;
788 static SECKEYPublicKey* nss_buf2ecdsa(unsigned char* key, size_t len, int algo)
791 SECItem pub = {siBuffer, NULL, 0};
792 SECItem params = {siBuffer, NULL, 0};
793 static unsigned char param256[] = {
794 /* OBJECTIDENTIFIER 1.2.840.10045.3.1.7 (P-256)
795 * {iso(1) member-body(2) us(840) ansi-x962(10045) curves(3) prime(1) prime256v1(7)} */
796 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07
798 static unsigned char param384[] = {
799 /* OBJECTIDENTIFIER 1.3.132.0.34 (P-384)
800 * {iso(1) identified-organization(3) certicom(132) curve(0) ansip384r1(34)} */
801 0x06, 0x05, 0x2b, 0x81, 0x04, 0x00, 0x22
803 unsigned char buf[256+2]; /* sufficient for 2*384/8+1 */
805 /* check length, which uncompressed must be 2 bignums */
806 if(algo == LDNS_ECDSAP256SHA256) {
807 if(len != 2*256/8) return NULL;
808 /* ECCurve_X9_62_PRIME_256V1 */
809 } else if(algo == LDNS_ECDSAP384SHA384) {
810 if(len != 2*384/8) return NULL;
811 /* ECCurve_X9_62_PRIME_384R1 */
814 buf[0] = 0x04; /* POINT_FORM_UNCOMPRESSED */
815 memmove(buf+1, key, len);
818 if(algo == LDNS_ECDSAP256SHA256) {
819 params.data = param256;
820 params.len = sizeof(param256);
822 params.data = param384;
823 params.len = sizeof(param384);
826 pk = nss_key_create(ecKey);
829 pk->u.ec.size = (len/2)*8;
830 if(SECITEM_CopyItem(pk->arena, &pk->u.ec.publicValue, &pub)) {
831 SECKEY_DestroyPublicKey(pk);
834 if(SECITEM_CopyItem(pk->arena, &pk->u.ec.DEREncodedParams, ¶ms)) {
835 SECKEY_DestroyPublicKey(pk);
842 static SECKEYPublicKey* nss_buf2dsa(unsigned char* key, size_t len)
848 SECItem Q = {siBuffer, NULL, 0};
849 SECItem P = {siBuffer, NULL, 0};
850 SECItem G = {siBuffer, NULL, 0};
851 SECItem Y = {siBuffer, NULL, 0};
856 length = (64 + T * 8);
862 if(len < (size_t)1 + SHA1_LENGTH + 3*length)
867 offset += SHA1_LENGTH;
881 pk = nss_key_create(dsaKey);
884 if(SECITEM_CopyItem(pk->arena, &pk->u.dsa.params.prime, &P)) {
885 SECKEY_DestroyPublicKey(pk);
888 if(SECITEM_CopyItem(pk->arena, &pk->u.dsa.params.subPrime, &Q)) {
889 SECKEY_DestroyPublicKey(pk);
892 if(SECITEM_CopyItem(pk->arena, &pk->u.dsa.params.base, &G)) {
893 SECKEY_DestroyPublicKey(pk);
896 if(SECITEM_CopyItem(pk->arena, &pk->u.dsa.publicValue, &Y)) {
897 SECKEY_DestroyPublicKey(pk);
903 static SECKEYPublicKey* nss_buf2rsa(unsigned char* key, size_t len)
909 SECItem modulus = {siBuffer, NULL, 0};
910 SECItem exponent = {siBuffer, NULL, 0};
916 /* the exponent is too large so it's places further */
917 memmove(&int16, key+1, 2);
925 /* key length at least one */
926 if(len < (size_t)offset + exp + 1)
929 exponent.data = key+offset;
932 modulus.data = key+offset;
933 modulus.len = (len - offset);
935 pk = nss_key_create(rsaKey);
938 if(SECITEM_CopyItem(pk->arena, &pk->u.rsa.modulus, &modulus)) {
939 SECKEY_DestroyPublicKey(pk);
942 if(SECITEM_CopyItem(pk->arena, &pk->u.rsa.publicExponent, &exponent)) {
943 SECKEY_DestroyPublicKey(pk);
950 * Setup key and digest for verification. Adjust sig if necessary.
952 * @param algo: key algorithm
953 * @param evp_key: EVP PKEY public key to create.
954 * @param digest_type: digest type to use
955 * @param key: key to setup for.
956 * @param keylen: length of key.
957 * @param prefix: if returned, the ASN prefix for the hashblob.
958 * @param prefixlen: length of the prefix.
959 * @return false on failure.
962 nss_setup_key_digest(int algo, SECKEYPublicKey** pubkey, HASH_HashType* htype,
963 unsigned char* key, size_t keylen, unsigned char** prefix,
968 /* hash prefix for md5, RFC2537 */
969 static unsigned char p_md5[] = {0x30, 0x20, 0x30, 0x0c, 0x06, 0x08, 0x2a,
970 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x02, 0x05, 0x05, 0x00, 0x04, 0x10};
971 /* hash prefix to prepend to hash output, from RFC3110 */
972 static unsigned char p_sha1[] = {0x30, 0x21, 0x30, 0x09, 0x06, 0x05, 0x2B,
973 0x0E, 0x03, 0x02, 0x1A, 0x05, 0x00, 0x04, 0x14};
975 static unsigned char p_sha256[] = {0x30, 0x31, 0x30, 0x0d, 0x06, 0x09, 0x60,
976 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, 0x05, 0x00, 0x04, 0x20};
977 static unsigned char p_sha512[] = {0x30, 0x51, 0x30, 0x0d, 0x06, 0x09, 0x60,
978 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x03, 0x05, 0x00, 0x04, 0x40};
980 /* for future RSASHA384 ..
981 static unsigned char p_sha384[] = {0x30, 0x51, 0x30, 0x0d, 0x06, 0x09, 0x60,
982 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x02, 0x05, 0x00, 0x04, 0x30};
989 *pubkey = nss_buf2dsa(key, keylen);
991 log_err("verify: malloc failure in crypto");
994 *htype = HASH_AlgSHA1;
995 /* no prefix for DSA verification */
999 case LDNS_RSASHA1_NSEC3:
1001 case LDNS_RSASHA256:
1004 case LDNS_RSASHA512:
1006 *pubkey = nss_buf2rsa(key, keylen);
1008 log_err("verify: malloc failure in crypto");
1011 /* select SHA version */
1013 if(algo == LDNS_RSASHA256) {
1014 *htype = HASH_AlgSHA256;
1016 *prefixlen = sizeof(p_sha256);
1020 if(algo == LDNS_RSASHA512) {
1021 *htype = HASH_AlgSHA512;
1023 *prefixlen = sizeof(p_sha512);
1027 *htype = HASH_AlgSHA1;
1029 *prefixlen = sizeof(p_sha1);
1034 *pubkey = nss_buf2rsa(key, keylen);
1036 log_err("verify: malloc failure in crypto");
1039 *htype = HASH_AlgMD5;
1041 *prefixlen = sizeof(p_md5);
1045 case LDNS_ECDSAP256SHA256:
1046 *pubkey = nss_buf2ecdsa(key, keylen,
1047 LDNS_ECDSAP256SHA256);
1049 log_err("verify: malloc failure in crypto");
1052 *htype = HASH_AlgSHA256;
1053 /* no prefix for DSA verification */
1055 case LDNS_ECDSAP384SHA384:
1056 *pubkey = nss_buf2ecdsa(key, keylen,
1057 LDNS_ECDSAP384SHA384);
1059 log_err("verify: malloc failure in crypto");
1062 *htype = HASH_AlgSHA384;
1063 /* no prefix for DSA verification */
1065 #endif /* USE_ECDSA */
1068 verbose(VERB_QUERY, "verify: unknown algorithm %d",
1076 * Check a canonical sig+rrset and signature against a dnskey
1077 * @param buf: buffer with data to verify, the first rrsig part and the
1078 * canonicalized rrset.
1079 * @param algo: DNSKEY algorithm.
1080 * @param sigblock: signature rdata field from RRSIG
1081 * @param sigblock_len: length of sigblock data.
1082 * @param key: public key data from DNSKEY RR.
1083 * @param keylen: length of keydata.
1084 * @param reason: bogus reason in more detail.
1085 * @return secure if verification succeeded, bogus on crypto failure,
1086 * unchecked on format errors and alloc failures.
1089 verify_canonrrset(sldns_buffer* buf, int algo, unsigned char* sigblock,
1090 unsigned int sigblock_len, unsigned char* key, unsigned int keylen,
1094 /* large enough for the different hashes */
1095 unsigned char hash[HASH_LENGTH_MAX];
1096 unsigned char hash2[HASH_LENGTH_MAX*2];
1097 HASH_HashType htype = 0;
1098 SECKEYPublicKey* pubkey = NULL;
1099 SECItem secsig = {siBuffer, sigblock, sigblock_len};
1100 SECItem sechash = {siBuffer, hash, 0};
1102 unsigned char* prefix = NULL; /* prefix for hash, RFC3110, RFC5702 */
1103 size_t prefixlen = 0;
1106 if(!nss_setup_key_digest(algo, &pubkey, &htype, key, keylen,
1107 &prefix, &prefixlen)) {
1108 verbose(VERB_QUERY, "verify: failed to setup key");
1109 *reason = "use of key for crypto failed";
1110 SECKEY_DestroyPublicKey(pubkey);
1111 return sec_status_bogus;
1115 /* need to convert DSA, ECDSA signatures? */
1116 if((algo == LDNS_DSA || algo == LDNS_DSA_NSEC3)) {
1117 if(sigblock_len == 1+2*SHA1_LENGTH) {
1121 SECItem* p = DSAU_DecodeDerSig(&secsig);
1123 verbose(VERB_QUERY, "verify: failed DER decode");
1124 *reason = "signature DER decode failed";
1125 SECKEY_DestroyPublicKey(pubkey);
1126 return sec_status_bogus;
1128 if(SECITEM_CopyItem(pubkey->arena, &secsig, p)) {
1129 log_err("alloc failure in DER decode");
1130 SECKEY_DestroyPublicKey(pubkey);
1131 SECITEM_FreeItem(p, PR_TRUE);
1132 return sec_status_unchecked;
1134 SECITEM_FreeItem(p, PR_TRUE);
1137 #endif /* USE_DSA */
1139 /* do the signature cryptography work */
1141 sechash.len = HASH_ResultLen(htype);
1142 if(sechash.len > sizeof(hash)) {
1143 verbose(VERB_QUERY, "verify: hash too large for buffer");
1144 SECKEY_DestroyPublicKey(pubkey);
1145 return sec_status_unchecked;
1147 if(HASH_HashBuf(htype, hash, (unsigned char*)sldns_buffer_begin(buf),
1148 (unsigned int)sldns_buffer_limit(buf)) != SECSuccess) {
1149 verbose(VERB_QUERY, "verify: HASH_HashBuf failed");
1150 SECKEY_DestroyPublicKey(pubkey);
1151 return sec_status_unchecked;
1154 int hashlen = sechash.len;
1155 if(prefixlen+hashlen > sizeof(hash2)) {
1156 verbose(VERB_QUERY, "verify: hashprefix too large");
1157 SECKEY_DestroyPublicKey(pubkey);
1158 return sec_status_unchecked;
1160 sechash.data = hash2;
1161 sechash.len = prefixlen+hashlen;
1162 memcpy(sechash.data, prefix, prefixlen);
1163 memmove(sechash.data+prefixlen, hash, hashlen);
1166 /* verify the signature */
1167 res = PK11_Verify(pubkey, &secsig, &sechash, NULL /*wincx*/);
1168 SECKEY_DestroyPublicKey(pubkey);
1170 if(res == SECSuccess) {
1171 return sec_status_secure;
1173 err = PORT_GetError();
1174 if(err != SEC_ERROR_BAD_SIGNATURE) {
1175 /* failed to verify */
1176 verbose(VERB_QUERY, "verify: PK11_Verify failed: %s",
1177 PORT_ErrorToString(err));
1178 /* if it is not supported, like ECC is removed, we get,
1179 * SEC_ERROR_NO_MODULE */
1180 if(err == SEC_ERROR_NO_MODULE)
1181 return sec_status_unchecked;
1182 /* but other errors are commonly returned
1183 * for a bad signature from NSS. Thus we return bogus,
1185 *reason = "signature crypto failed";
1186 return sec_status_bogus;
1188 verbose(VERB_QUERY, "verify: signature mismatch: %s",
1189 PORT_ErrorToString(err));
1190 *reason = "signature crypto failed";
1191 return sec_status_bogus;
1194 #elif defined(HAVE_NETTLE)
1201 #ifdef HAVE_NETTLE_DSA_COMPAT_H
1202 #include "dsa-compat.h"
1207 #include "ecc-curve.h"
1211 _digest_nettle(int algo, uint8_t* buf, size_t len,
1215 case SHA1_DIGEST_SIZE:
1217 struct sha1_ctx ctx;
1219 sha1_update(&ctx, len, buf);
1220 sha1_digest(&ctx, SHA1_DIGEST_SIZE, res);
1223 case SHA256_DIGEST_SIZE:
1225 struct sha256_ctx ctx;
1227 sha256_update(&ctx, len, buf);
1228 sha256_digest(&ctx, SHA256_DIGEST_SIZE, res);
1231 case SHA384_DIGEST_SIZE:
1233 struct sha384_ctx ctx;
1235 sha384_update(&ctx, len, buf);
1236 sha384_digest(&ctx, SHA384_DIGEST_SIZE, res);
1239 case SHA512_DIGEST_SIZE:
1241 struct sha512_ctx ctx;
1243 sha512_update(&ctx, len, buf);
1244 sha512_digest(&ctx, SHA512_DIGEST_SIZE, res);
1253 /* return size of digest if supported, or 0 otherwise */
1255 nsec3_hash_algo_size_supported(int id)
1258 case NSEC3_HASH_SHA1:
1259 return SHA1_DIGEST_SIZE;
1265 /* perform nsec3 hash. return false on failure */
1267 secalgo_nsec3_hash(int algo, unsigned char* buf, size_t len,
1271 case NSEC3_HASH_SHA1:
1272 return _digest_nettle(SHA1_DIGEST_SIZE, (uint8_t*)buf, len,
1280 secalgo_hash_sha256(unsigned char* buf, size_t len, unsigned char* res)
1282 _digest_nettle(SHA256_DIGEST_SIZE, (uint8_t*)buf, len, res);
1286 * Return size of DS digest according to its hash algorithm.
1287 * @param algo: DS digest algo.
1288 * @return size in bytes of digest, or 0 if not supported.
1291 ds_digest_size_supported(int algo)
1295 return SHA1_DIGEST_SIZE;
1298 return SHA256_DIGEST_SIZE;
1302 return SHA384_DIGEST_SIZE;
1304 /* GOST not supported */
1305 case LDNS_HASH_GOST:
1313 secalgo_ds_digest(int algo, unsigned char* buf, size_t len,
1318 return _digest_nettle(SHA1_DIGEST_SIZE, buf, len, res);
1319 #if defined(USE_SHA2)
1321 return _digest_nettle(SHA256_DIGEST_SIZE, buf, len, res);
1325 return _digest_nettle(SHA384_DIGEST_SIZE, buf, len, res);
1328 case LDNS_HASH_GOST:
1330 verbose(VERB_QUERY, "unknown DS digest algorithm %d",
1338 dnskey_algo_id_is_supported(int id)
1340 /* uses libnettle */
1344 case LDNS_DSA_NSEC3:
1347 case LDNS_RSASHA1_NSEC3:
1349 case LDNS_RSASHA256:
1350 case LDNS_RSASHA512:
1353 case LDNS_ECDSAP256SHA256:
1354 case LDNS_ECDSAP384SHA384:
1357 case LDNS_RSAMD5: /* RFC 6725 deprecates RSAMD5 */
1366 _verify_nettle_dsa(sldns_buffer* buf, unsigned char* sigblock,
1367 unsigned int sigblock_len, unsigned char* key, unsigned int keylen)
1369 uint8_t digest[SHA1_DIGEST_SIZE];
1373 struct dsa_public_key pubkey;
1374 struct dsa_signature signature;
1375 unsigned int expected_len;
1377 /* Extract DSA signature from the record */
1378 nettle_dsa_signature_init(&signature);
1379 /* Signature length: 41 bytes - RFC 2536 sec. 3 */
1380 if(sigblock_len == 41) {
1381 if(key[0] != sigblock[0])
1382 return "invalid T value in DSA signature or pubkey";
1383 nettle_mpz_set_str_256_u(signature.r, 20, sigblock+1);
1384 nettle_mpz_set_str_256_u(signature.s, 20, sigblock+1+20);
1386 /* DER encoded, decode the ASN1 notated R and S bignums */
1387 /* SEQUENCE { r INTEGER, s INTEGER } */
1388 struct asn1_der_iterator i, seq;
1389 if(asn1_der_iterator_first(&i, sigblock_len,
1390 (uint8_t*)sigblock) != ASN1_ITERATOR_CONSTRUCTED
1391 || i.type != ASN1_SEQUENCE)
1392 return "malformed DER encoded DSA signature";
1393 /* decode this element of i using the seq iterator */
1394 if(asn1_der_decode_constructed(&i, &seq) !=
1395 ASN1_ITERATOR_PRIMITIVE || seq.type != ASN1_INTEGER)
1396 return "malformed DER encoded DSA signature";
1397 if(!asn1_der_get_bignum(&seq, signature.r, 20*8))
1398 return "malformed DER encoded DSA signature";
1399 if(asn1_der_iterator_next(&seq) != ASN1_ITERATOR_PRIMITIVE
1400 || seq.type != ASN1_INTEGER)
1401 return "malformed DER encoded DSA signature";
1402 if(!asn1_der_get_bignum(&seq, signature.s, 20*8))
1403 return "malformed DER encoded DSA signature";
1404 if(asn1_der_iterator_next(&i) != ASN1_ITERATOR_END)
1405 return "malformed DER encoded DSA signature";
1408 /* Validate T values constraints - RFC 2536 sec. 2 & sec. 3 */
1411 return "invalid T value in DSA pubkey";
1414 /* Pubkey minimum length: 21 bytes - RFC 2536 sec. 2 */
1416 return "DSA pubkey too short";
1419 expected_len = 1 + /* T */
1421 (64 + key_t*8) + /* P */
1422 (64 + key_t*8) + /* G */
1423 (64 + key_t*8); /* Y */
1424 if (keylen != expected_len ) {
1425 return "invalid DSA pubkey length";
1428 /* Extract DSA pubkey from the record */
1429 nettle_dsa_public_key_init(&pubkey);
1431 nettle_mpz_set_str_256_u(pubkey.q, 20, key+offset);
1433 nettle_mpz_set_str_256_u(pubkey.p, (64 + key_t*8), key+offset);
1434 offset += (64 + key_t*8);
1435 nettle_mpz_set_str_256_u(pubkey.g, (64 + key_t*8), key+offset);
1436 offset += (64 + key_t*8);
1437 nettle_mpz_set_str_256_u(pubkey.y, (64 + key_t*8), key+offset);
1439 /* Digest content of "buf" and verify its DSA signature in "sigblock"*/
1440 res = _digest_nettle(SHA1_DIGEST_SIZE, (unsigned char*)sldns_buffer_begin(buf),
1441 (unsigned int)sldns_buffer_limit(buf), (unsigned char*)digest);
1442 res &= dsa_sha1_verify_digest(&pubkey, digest, &signature);
1444 /* Clear and return */
1445 nettle_dsa_signature_clear(&signature);
1446 nettle_dsa_public_key_clear(&pubkey);
1448 return "DSA signature verification failed";
1452 #endif /* USE_DSA */
1455 _verify_nettle_rsa(sldns_buffer* buf, unsigned int digest_size, char* sigblock,
1456 unsigned int sigblock_len, uint8_t* key, unsigned int keylen)
1458 uint16_t exp_len = 0;
1459 size_t exp_offset = 0, mod_offset = 0;
1460 struct rsa_public_key pubkey;
1464 /* RSA pubkey parsing as per RFC 3110 sec. 2 */
1466 return "null RSA key";
1473 /* 1-byte NUL + 2-bytes exponent length */
1475 return "incorrect RSA key length";
1477 exp_len = READ_UINT16(key+1);
1479 return "null RSA exponent length";
1482 /* Check that we are not over-running input length */
1483 if (keylen < exp_offset + exp_len + 1) {
1484 return "RSA key content shorter than expected";
1486 mod_offset = exp_offset + exp_len;
1487 nettle_rsa_public_key_init(&pubkey);
1488 pubkey.size = keylen - mod_offset;
1489 nettle_mpz_set_str_256_u(pubkey.e, exp_len, &key[exp_offset]);
1490 nettle_mpz_set_str_256_u(pubkey.n, pubkey.size, &key[mod_offset]);
1492 /* Digest content of "buf" and verify its RSA signature in "sigblock"*/
1493 nettle_mpz_init_set_str_256_u(signature, sigblock_len, (uint8_t*)sigblock);
1494 switch (digest_size) {
1495 case SHA1_DIGEST_SIZE:
1497 uint8_t digest[SHA1_DIGEST_SIZE];
1498 res = _digest_nettle(SHA1_DIGEST_SIZE, (unsigned char*)sldns_buffer_begin(buf),
1499 (unsigned int)sldns_buffer_limit(buf), (unsigned char*)digest);
1500 res &= rsa_sha1_verify_digest(&pubkey, digest, signature);
1503 case SHA256_DIGEST_SIZE:
1505 uint8_t digest[SHA256_DIGEST_SIZE];
1506 res = _digest_nettle(SHA256_DIGEST_SIZE, (unsigned char*)sldns_buffer_begin(buf),
1507 (unsigned int)sldns_buffer_limit(buf), (unsigned char*)digest);
1508 res &= rsa_sha256_verify_digest(&pubkey, digest, signature);
1511 case SHA512_DIGEST_SIZE:
1513 uint8_t digest[SHA512_DIGEST_SIZE];
1514 res = _digest_nettle(SHA512_DIGEST_SIZE, (unsigned char*)sldns_buffer_begin(buf),
1515 (unsigned int)sldns_buffer_limit(buf), (unsigned char*)digest);
1516 res &= rsa_sha512_verify_digest(&pubkey, digest, signature);
1523 /* Clear and return */
1524 nettle_rsa_public_key_clear(&pubkey);
1525 mpz_clear(signature);
1527 return "RSA signature verification failed";
1535 _verify_nettle_ecdsa(sldns_buffer* buf, unsigned int digest_size, unsigned char* sigblock,
1536 unsigned int sigblock_len, unsigned char* key, unsigned int keylen)
1539 struct ecc_point pubkey;
1540 struct dsa_signature signature;
1542 /* Always matched strength, as per RFC 6605 sec. 1 */
1543 if (sigblock_len != 2*digest_size || keylen != 2*digest_size) {
1544 return "wrong ECDSA signature length";
1547 /* Parse ECDSA signature as per RFC 6605 sec. 4 */
1548 nettle_dsa_signature_init(&signature);
1549 switch (digest_size) {
1550 case SHA256_DIGEST_SIZE:
1552 uint8_t digest[SHA256_DIGEST_SIZE];
1554 nettle_ecc_point_init(&pubkey, &nettle_secp_256r1);
1555 nettle_mpz_init_set_str_256_u(x, SHA256_DIGEST_SIZE, key);
1556 nettle_mpz_init_set_str_256_u(y, SHA256_DIGEST_SIZE, key+SHA256_DIGEST_SIZE);
1557 nettle_mpz_set_str_256_u(signature.r, SHA256_DIGEST_SIZE, sigblock);
1558 nettle_mpz_set_str_256_u(signature.s, SHA256_DIGEST_SIZE, sigblock+SHA256_DIGEST_SIZE);
1559 res = _digest_nettle(SHA256_DIGEST_SIZE, (unsigned char*)sldns_buffer_begin(buf),
1560 (unsigned int)sldns_buffer_limit(buf), (unsigned char*)digest);
1561 res &= nettle_ecc_point_set(&pubkey, x, y);
1562 res &= nettle_ecdsa_verify (&pubkey, SHA256_DIGEST_SIZE, digest, &signature);
1567 case SHA384_DIGEST_SIZE:
1569 uint8_t digest[SHA384_DIGEST_SIZE];
1571 nettle_ecc_point_init(&pubkey, &nettle_secp_384r1);
1572 nettle_mpz_init_set_str_256_u(x, SHA384_DIGEST_SIZE, key);
1573 nettle_mpz_init_set_str_256_u(y, SHA384_DIGEST_SIZE, key+SHA384_DIGEST_SIZE);
1574 nettle_mpz_set_str_256_u(signature.r, SHA384_DIGEST_SIZE, sigblock);
1575 nettle_mpz_set_str_256_u(signature.s, SHA384_DIGEST_SIZE, sigblock+SHA384_DIGEST_SIZE);
1576 res = _digest_nettle(SHA384_DIGEST_SIZE, (unsigned char*)sldns_buffer_begin(buf),
1577 (unsigned int)sldns_buffer_limit(buf), (unsigned char*)digest);
1578 res &= nettle_ecc_point_set(&pubkey, x, y);
1579 res &= nettle_ecdsa_verify (&pubkey, SHA384_DIGEST_SIZE, digest, &signature);
1582 nettle_ecc_point_clear(&pubkey);
1586 return "unknown ECDSA algorithm";
1589 /* Clear and return */
1590 nettle_dsa_signature_clear(&signature);
1592 return "ECDSA signature verification failed";
1599 * Check a canonical sig+rrset and signature against a dnskey
1600 * @param buf: buffer with data to verify, the first rrsig part and the
1601 * canonicalized rrset.
1602 * @param algo: DNSKEY algorithm.
1603 * @param sigblock: signature rdata field from RRSIG
1604 * @param sigblock_len: length of sigblock data.
1605 * @param key: public key data from DNSKEY RR.
1606 * @param keylen: length of keydata.
1607 * @param reason: bogus reason in more detail.
1608 * @return secure if verification succeeded, bogus on crypto failure,
1609 * unchecked on format errors and alloc failures.
1612 verify_canonrrset(sldns_buffer* buf, int algo, unsigned char* sigblock,
1613 unsigned int sigblock_len, unsigned char* key, unsigned int keylen,
1616 unsigned int digest_size = 0;
1618 if (sigblock_len == 0 || keylen == 0) {
1619 *reason = "null signature";
1620 return sec_status_bogus;
1626 case LDNS_DSA_NSEC3:
1627 *reason = _verify_nettle_dsa(buf, sigblock, sigblock_len, key, keylen);
1628 if (*reason != NULL)
1629 return sec_status_bogus;
1631 return sec_status_secure;
1632 #endif /* USE_DSA */
1635 case LDNS_RSASHA1_NSEC3:
1636 digest_size = (digest_size ? digest_size : SHA1_DIGEST_SIZE);
1638 case LDNS_RSASHA256:
1639 digest_size = (digest_size ? digest_size : SHA256_DIGEST_SIZE);
1640 case LDNS_RSASHA512:
1641 digest_size = (digest_size ? digest_size : SHA512_DIGEST_SIZE);
1644 *reason = _verify_nettle_rsa(buf, digest_size, (char*)sigblock,
1645 sigblock_len, key, keylen);
1646 if (*reason != NULL)
1647 return sec_status_bogus;
1649 return sec_status_secure;
1652 case LDNS_ECDSAP256SHA256:
1653 digest_size = (digest_size ? digest_size : SHA256_DIGEST_SIZE);
1654 case LDNS_ECDSAP384SHA384:
1655 digest_size = (digest_size ? digest_size : SHA384_DIGEST_SIZE);
1656 *reason = _verify_nettle_ecdsa(buf, digest_size, sigblock,
1657 sigblock_len, key, keylen);
1658 if (*reason != NULL)
1659 return sec_status_bogus;
1661 return sec_status_secure;
1666 *reason = "unable to verify signature, unknown algorithm";
1667 return sec_status_bogus;
1671 #endif /* HAVE_SSL or HAVE_NSS or HAVE_NETTLE */