2 * Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * DH low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
17 #include "internal/cryptlib.h"
18 #include <openssl/x509.h>
19 #include <openssl/asn1.h>
21 #include <openssl/bn.h>
22 #include "crypto/asn1.h"
23 #include "crypto/evp.h"
24 #include <openssl/cms.h>
25 #include <openssl/core_names.h>
26 #include "internal/param_build.h"
29 * i2d/d2i like DH parameter functions which use the appropriate routine for
30 * PKCS#3 DH or X9.42 DH.
33 static DH *d2i_dhp(const EVP_PKEY *pkey, const unsigned char **pp,
36 if (pkey->ameth == &dhx_asn1_meth)
37 return d2i_DHxparams(NULL, pp, length);
38 return d2i_DHparams(NULL, pp, length);
41 static int i2d_dhp(const EVP_PKEY *pkey, const DH *a, unsigned char **pp)
43 if (pkey->ameth == &dhx_asn1_meth)
44 return i2d_DHxparams(a, pp);
45 return i2d_DHparams(a, pp);
48 static void int_dh_free(EVP_PKEY *pkey)
50 DH_free(pkey->pkey.dh);
53 static int dh_pub_decode(EVP_PKEY *pkey, X509_PUBKEY *pubkey)
55 const unsigned char *p, *pm;
59 const ASN1_STRING *pstr;
61 ASN1_INTEGER *public_key = NULL;
65 if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, &palg, pubkey))
67 X509_ALGOR_get0(NULL, &ptype, &pval, palg);
69 if (ptype != V_ASN1_SEQUENCE) {
70 DHerr(DH_F_DH_PUB_DECODE, DH_R_PARAMETER_ENCODING_ERROR);
78 if ((dh = d2i_dhp(pkey, &pm, pmlen)) == NULL) {
79 DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
83 if ((public_key = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL) {
84 DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
88 /* We have parameters now set public key */
89 if ((dh->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
90 DHerr(DH_F_DH_PUB_DECODE, DH_R_BN_DECODE_ERROR);
94 ASN1_INTEGER_free(public_key);
95 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
99 ASN1_INTEGER_free(public_key);
105 static int dh_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
109 unsigned char *penc = NULL;
112 ASN1_INTEGER *pub_key = NULL;
116 str = ASN1_STRING_new();
118 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
121 str->length = i2d_dhp(pkey, dh, &str->data);
122 if (str->length <= 0) {
123 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
126 ptype = V_ASN1_SEQUENCE;
128 pub_key = BN_to_ASN1_INTEGER(dh->pub_key, NULL);
132 penclen = i2d_ASN1_INTEGER(pub_key, &penc);
134 ASN1_INTEGER_free(pub_key);
137 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
141 if (X509_PUBKEY_set0_param(pk, OBJ_nid2obj(pkey->ameth->pkey_id),
142 ptype, str, penc, penclen))
147 ASN1_STRING_free(str);
153 * PKCS#8 DH is defined in PKCS#11 of all places. It is similar to DH in that
154 * the AlgorithmIdentifier contains the parameters, the private key is
155 * explicitly included and the pubkey must be recalculated.
158 static int dh_priv_decode(EVP_PKEY *pkey, const PKCS8_PRIV_KEY_INFO *p8)
160 const unsigned char *p, *pm;
164 const ASN1_STRING *pstr;
165 const X509_ALGOR *palg;
166 ASN1_INTEGER *privkey = NULL;
169 if (!PKCS8_pkey_get0(NULL, &p, &pklen, &palg, p8))
172 X509_ALGOR_get0(NULL, &ptype, &pval, palg);
174 if (ptype != V_ASN1_SEQUENCE)
176 if ((privkey = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL)
181 pmlen = pstr->length;
182 if ((dh = d2i_dhp(pkey, &pm, pmlen)) == NULL)
185 /* We have parameters now set private key */
186 if ((dh->priv_key = BN_secure_new()) == NULL
187 || !ASN1_INTEGER_to_BN(privkey, dh->priv_key)) {
188 DHerr(DH_F_DH_PRIV_DECODE, DH_R_BN_ERROR);
191 /* Calculate public key, increments dirty_cnt */
192 if (!DH_generate_key(dh))
195 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
197 ASN1_STRING_clear_free(privkey);
202 DHerr(DH_F_DH_PRIV_DECODE, EVP_R_DECODE_ERROR);
205 ASN1_STRING_clear_free(privkey);
209 static int dh_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
211 ASN1_STRING *params = NULL;
212 ASN1_INTEGER *prkey = NULL;
213 unsigned char *dp = NULL;
216 params = ASN1_STRING_new();
218 if (params == NULL) {
219 DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
223 params->length = i2d_dhp(pkey, pkey->pkey.dh, ¶ms->data);
224 if (params->length <= 0) {
225 DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
228 params->type = V_ASN1_SEQUENCE;
230 /* Get private key into integer */
231 prkey = BN_to_ASN1_INTEGER(pkey->pkey.dh->priv_key, NULL);
234 DHerr(DH_F_DH_PRIV_ENCODE, DH_R_BN_ERROR);
238 dplen = i2d_ASN1_INTEGER(prkey, &dp);
240 ASN1_STRING_clear_free(prkey);
243 if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(pkey->ameth->pkey_id), 0,
244 V_ASN1_SEQUENCE, params, dp, dplen))
251 ASN1_STRING_free(params);
252 ASN1_STRING_clear_free(prkey);
256 static int dh_param_decode(EVP_PKEY *pkey,
257 const unsigned char **pder, int derlen)
261 if ((dh = d2i_dhp(pkey, pder, derlen)) == NULL) {
262 DHerr(DH_F_DH_PARAM_DECODE, ERR_R_DH_LIB);
266 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
270 static int dh_param_encode(const EVP_PKEY *pkey, unsigned char **pder)
272 return i2d_dhp(pkey, pkey->pkey.dh, pder);
275 static int do_dh_print(BIO *bp, const DH *x, int indent, int ptype)
277 int reason = ERR_R_BUF_LIB;
278 const char *ktype = NULL;
279 BIGNUM *priv_key, *pub_key;
282 priv_key = x->priv_key;
287 pub_key = x->pub_key;
291 if (x->params.p == NULL || (ptype == 2 && priv_key == NULL)
292 || (ptype > 0 && pub_key == NULL)) {
293 reason = ERR_R_PASSED_NULL_PARAMETER;
298 ktype = "DH Private-Key";
300 ktype = "DH Public-Key";
302 ktype = "DH Parameters";
304 if (!BIO_indent(bp, indent, 128)
305 || BIO_printf(bp, "%s: (%d bit)\n", ktype, DH_bits(x)) <= 0)
309 if (!ASN1_bn_print(bp, "private-key:", priv_key, NULL, indent))
311 if (!ASN1_bn_print(bp, "public-key:", pub_key, NULL, indent))
314 if (!ffc_params_print(bp, &x->params, indent))
317 if (x->length != 0) {
318 if (!BIO_indent(bp, indent, 128)
319 || BIO_printf(bp, "recommended-private-length: %d bits\n",
320 (int)x->length) <= 0)
327 DHerr(DH_F_DO_DH_PRINT, reason);
331 static int int_dh_size(const EVP_PKEY *pkey)
333 return DH_size(pkey->pkey.dh);
336 static int dh_bits(const EVP_PKEY *pkey)
338 return DH_bits(pkey->pkey.dh);
341 static int dh_security_bits(const EVP_PKEY *pkey)
343 return DH_security_bits(pkey->pkey.dh);
346 static int dh_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
348 return ffc_params_cmp(&a->pkey.dh->params, &a->pkey.dh->params,
349 a->ameth != &dhx_asn1_meth);
352 static int int_dh_param_copy(DH *to, const DH *from, int is_x942)
355 is_x942 = (from->params.q != NULL);
356 if (!ffc_params_copy(&to->params, &from->params))
359 to->length = from->length;
364 DH *DHparams_dup(const DH *dh)
370 if (!int_dh_param_copy(ret, dh, -1)) {
377 static int dh_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
379 if (to->pkey.dh == NULL) {
380 to->pkey.dh = DH_new();
381 if (to->pkey.dh == NULL)
384 return int_dh_param_copy(to->pkey.dh, from->pkey.dh,
385 from->ameth == &dhx_asn1_meth);
388 static int dh_missing_parameters(const EVP_PKEY *a)
390 return a->pkey.dh == NULL
391 || a->pkey.dh->params.p == NULL
392 || a->pkey.dh->params.g == NULL;
395 static int dh_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
397 if (dh_cmp_parameters(a, b) == 0)
399 if (BN_cmp(b->pkey.dh->pub_key, a->pkey.dh->pub_key) != 0)
405 static int dh_param_print(BIO *bp, const EVP_PKEY *pkey, int indent,
408 return do_dh_print(bp, pkey->pkey.dh, indent, 0);
411 static int dh_public_print(BIO *bp, const EVP_PKEY *pkey, int indent,
414 return do_dh_print(bp, pkey->pkey.dh, indent, 1);
417 static int dh_private_print(BIO *bp, const EVP_PKEY *pkey, int indent,
420 return do_dh_print(bp, pkey->pkey.dh, indent, 2);
423 int DHparams_print(BIO *bp, const DH *x)
425 return do_dh_print(bp, x, 4, 0);
428 #ifndef OPENSSL_NO_CMS
429 static int dh_cms_decrypt(CMS_RecipientInfo *ri);
430 static int dh_cms_encrypt(CMS_RecipientInfo *ri);
433 static int dh_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
436 case ASN1_PKEY_CTRL_SET1_TLS_ENCPT:
437 return dh_buf2key(EVP_PKEY_get0_DH(pkey), arg2, arg1);
438 case ASN1_PKEY_CTRL_GET1_TLS_ENCPT:
439 return dh_key2buf(EVP_PKEY_get0_DH(pkey), arg2);
445 static int dhx_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
448 #ifndef OPENSSL_NO_CMS
450 case ASN1_PKEY_CTRL_CMS_ENVELOPE:
452 return dh_cms_decrypt(arg2);
454 return dh_cms_encrypt(arg2);
457 case ASN1_PKEY_CTRL_CMS_RI_TYPE:
458 *(int *)arg2 = CMS_RECIPINFO_AGREE;
467 static int dh_pkey_public_check(const EVP_PKEY *pkey)
469 DH *dh = pkey->pkey.dh;
471 if (dh->pub_key == NULL) {
472 DHerr(DH_F_DH_PKEY_PUBLIC_CHECK, DH_R_MISSING_PUBKEY);
476 return DH_check_pub_key_ex(dh, dh->pub_key);
479 static int dh_pkey_param_check(const EVP_PKEY *pkey)
481 DH *dh = pkey->pkey.dh;
483 return DH_check_ex(dh);
486 static size_t dh_pkey_dirty_cnt(const EVP_PKEY *pkey)
488 return pkey->pkey.dh->dirty_cnt;
491 static int dh_pkey_export_to(const EVP_PKEY *from, void *to_keydata,
492 EVP_KEYMGMT *to_keymgmt)
494 DH *dh = from->pkey.dh;
496 const BIGNUM *p = DH_get0_p(dh), *g = DH_get0_g(dh), *q = DH_get0_q(dh);
497 const BIGNUM *pub_key = DH_get0_pub_key(dh);
498 const BIGNUM *priv_key = DH_get0_priv_key(dh);
502 if (p == NULL || g == NULL)
505 ossl_param_bld_init(&tmpl);
506 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_FFC_P, p)
507 || !ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_FFC_G, g))
510 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_FFC_Q, q))
513 /* A key must at least have a public part. */
514 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_PUB_KEY, pub_key))
516 if (priv_key != NULL) {
517 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_PRIV_KEY,
522 if ((params = ossl_param_bld_to_param(&tmpl)) == NULL)
525 /* We export, the provider imports */
526 rv = evp_keymgmt_import(to_keymgmt, to_keydata, OSSL_KEYMGMT_SELECT_ALL,
529 ossl_param_bld_free(params);
534 const EVP_PKEY_ASN1_METHOD dh_asn1_meth = {
540 "OpenSSL PKCS#3 DH method",
557 dh_missing_parameters,
569 dh_pkey_public_check,
578 const EVP_PKEY_ASN1_METHOD dhx_asn1_meth = {
584 "OpenSSL X9.42 DH method",
601 dh_missing_parameters,
613 dh_pkey_public_check,
617 #ifndef OPENSSL_NO_CMS
619 static int dh_cms_set_peerkey(EVP_PKEY_CTX *pctx,
620 X509_ALGOR *alg, ASN1_BIT_STRING *pubkey)
622 const ASN1_OBJECT *aoid;
625 ASN1_INTEGER *public_key = NULL;
627 EVP_PKEY *pkpeer = NULL, *pk = NULL;
629 const unsigned char *p;
632 X509_ALGOR_get0(&aoid, &atype, &aval, alg);
633 if (OBJ_obj2nid(aoid) != NID_dhpublicnumber)
635 /* Only absent parameters allowed in RFC XXXX */
636 if (atype != V_ASN1_UNDEF && atype == V_ASN1_NULL)
639 pk = EVP_PKEY_CTX_get0_pkey(pctx);
642 if (pk->type != EVP_PKEY_DHX)
644 /* Get parameters from parent key */
645 dhpeer = DHparams_dup(pk->pkey.dh);
646 /* We have parameters now set public key */
647 plen = ASN1_STRING_length(pubkey);
648 p = ASN1_STRING_get0_data(pubkey);
649 if (p == NULL || plen == 0)
652 if ((public_key = d2i_ASN1_INTEGER(NULL, &p, plen)) == NULL) {
653 DHerr(DH_F_DH_CMS_SET_PEERKEY, DH_R_DECODE_ERROR);
657 /* We have parameters now set public key */
658 if ((dhpeer->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
659 DHerr(DH_F_DH_CMS_SET_PEERKEY, DH_R_BN_DECODE_ERROR);
663 pkpeer = EVP_PKEY_new();
666 EVP_PKEY_assign(pkpeer, pk->ameth->pkey_id, dhpeer);
668 if (EVP_PKEY_derive_set_peer(pctx, pkpeer) > 0)
671 ASN1_INTEGER_free(public_key);
672 EVP_PKEY_free(pkpeer);
677 static int dh_cms_set_shared_info(EVP_PKEY_CTX *pctx, CMS_RecipientInfo *ri)
681 X509_ALGOR *alg, *kekalg = NULL;
682 ASN1_OCTET_STRING *ukm;
683 const unsigned char *p;
684 unsigned char *dukm = NULL;
687 const EVP_CIPHER *kekcipher;
688 EVP_CIPHER_CTX *kekctx;
690 if (!CMS_RecipientInfo_kari_get0_alg(ri, &alg, &ukm))
694 * For DH we only have one OID permissible. If ever any more get defined
695 * we will need something cleverer.
697 if (OBJ_obj2nid(alg->algorithm) != NID_id_smime_alg_ESDH) {
698 DHerr(DH_F_DH_CMS_SET_SHARED_INFO, DH_R_KDF_PARAMETER_ERROR);
702 if (EVP_PKEY_CTX_set_dh_kdf_type(pctx, EVP_PKEY_DH_KDF_X9_42) <= 0)
705 if (EVP_PKEY_CTX_set_dh_kdf_md(pctx, EVP_sha1()) <= 0)
708 if (alg->parameter->type != V_ASN1_SEQUENCE)
711 p = alg->parameter->value.sequence->data;
712 plen = alg->parameter->value.sequence->length;
713 kekalg = d2i_X509_ALGOR(NULL, &p, plen);
716 kekctx = CMS_RecipientInfo_kari_get0_ctx(ri);
719 kekcipher = EVP_get_cipherbyobj(kekalg->algorithm);
720 if (!kekcipher || EVP_CIPHER_mode(kekcipher) != EVP_CIPH_WRAP_MODE)
722 if (!EVP_EncryptInit_ex(kekctx, kekcipher, NULL, NULL, NULL))
724 if (EVP_CIPHER_asn1_to_param(kekctx, kekalg->parameter) <= 0)
727 keylen = EVP_CIPHER_CTX_key_length(kekctx);
728 if (EVP_PKEY_CTX_set_dh_kdf_outlen(pctx, keylen) <= 0)
730 /* Use OBJ_nid2obj to ensure we use built in OID that isn't freed */
731 if (EVP_PKEY_CTX_set0_dh_kdf_oid(pctx,
732 OBJ_nid2obj(EVP_CIPHER_type(kekcipher)))
737 dukmlen = ASN1_STRING_length(ukm);
738 dukm = OPENSSL_memdup(ASN1_STRING_get0_data(ukm), dukmlen);
743 if (EVP_PKEY_CTX_set0_dh_kdf_ukm(pctx, dukm, dukmlen) <= 0)
749 X509_ALGOR_free(kekalg);
754 static int dh_cms_decrypt(CMS_RecipientInfo *ri)
758 pctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
762 /* See if we need to set peer key */
763 if (!EVP_PKEY_CTX_get0_peerkey(pctx)) {
765 ASN1_BIT_STRING *pubkey;
766 if (!CMS_RecipientInfo_kari_get0_orig_id(ri, &alg, &pubkey,
771 if (!dh_cms_set_peerkey(pctx, alg, pubkey)) {
772 DHerr(DH_F_DH_CMS_DECRYPT, DH_R_PEER_KEY_ERROR);
776 /* Set DH derivation parameters and initialise unwrap context */
777 if (!dh_cms_set_shared_info(pctx, ri)) {
778 DHerr(DH_F_DH_CMS_DECRYPT, DH_R_SHARED_INFO_ERROR);
784 static int dh_cms_encrypt(CMS_RecipientInfo *ri)
790 X509_ALGOR *talg, *wrap_alg = NULL;
791 const ASN1_OBJECT *aoid;
792 ASN1_BIT_STRING *pubkey;
793 ASN1_STRING *wrap_str;
794 ASN1_OCTET_STRING *ukm;
795 unsigned char *penc = NULL, *dukm = NULL;
799 int kdf_type, wrap_nid;
800 const EVP_MD *kdf_md;
802 pctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
805 /* Get ephemeral key */
806 pkey = EVP_PKEY_CTX_get0_pkey(pctx);
807 if (!CMS_RecipientInfo_kari_get0_orig_id(ri, &talg, &pubkey,
810 X509_ALGOR_get0(&aoid, NULL, NULL, talg);
811 /* Is everything uninitialised? */
812 if (aoid == OBJ_nid2obj(NID_undef)) {
813 ASN1_INTEGER *pubk = BN_to_ASN1_INTEGER(pkey->pkey.dh->pub_key, NULL);
819 penclen = i2d_ASN1_INTEGER(pubk, &penc);
820 ASN1_INTEGER_free(pubk);
823 ASN1_STRING_set0(pubkey, penc, penclen);
824 pubkey->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
825 pubkey->flags |= ASN1_STRING_FLAG_BITS_LEFT;
828 X509_ALGOR_set0(talg, OBJ_nid2obj(NID_dhpublicnumber),
832 /* See if custom parameters set */
833 kdf_type = EVP_PKEY_CTX_get_dh_kdf_type(pctx);
836 if (!EVP_PKEY_CTX_get_dh_kdf_md(pctx, &kdf_md))
839 if (kdf_type == EVP_PKEY_DH_KDF_NONE) {
840 kdf_type = EVP_PKEY_DH_KDF_X9_42;
841 if (EVP_PKEY_CTX_set_dh_kdf_type(pctx, kdf_type) <= 0)
843 } else if (kdf_type != EVP_PKEY_DH_KDF_X9_42)
846 if (kdf_md == NULL) {
847 /* Only SHA1 supported */
849 if (EVP_PKEY_CTX_set_dh_kdf_md(pctx, kdf_md) <= 0)
851 } else if (EVP_MD_type(kdf_md) != NID_sha1)
852 /* Unsupported digest */
855 if (!CMS_RecipientInfo_kari_get0_alg(ri, &talg, &ukm))
859 ctx = CMS_RecipientInfo_kari_get0_ctx(ri);
860 wrap_nid = EVP_CIPHER_CTX_type(ctx);
861 if (EVP_PKEY_CTX_set0_dh_kdf_oid(pctx, OBJ_nid2obj(wrap_nid)) <= 0)
863 keylen = EVP_CIPHER_CTX_key_length(ctx);
865 /* Package wrap algorithm in an AlgorithmIdentifier */
867 wrap_alg = X509_ALGOR_new();
868 if (wrap_alg == NULL)
870 wrap_alg->algorithm = OBJ_nid2obj(wrap_nid);
871 wrap_alg->parameter = ASN1_TYPE_new();
872 if (wrap_alg->parameter == NULL)
874 if (EVP_CIPHER_param_to_asn1(ctx, wrap_alg->parameter) <= 0)
876 if (ASN1_TYPE_get(wrap_alg->parameter) == NID_undef) {
877 ASN1_TYPE_free(wrap_alg->parameter);
878 wrap_alg->parameter = NULL;
881 if (EVP_PKEY_CTX_set_dh_kdf_outlen(pctx, keylen) <= 0)
885 dukmlen = ASN1_STRING_length(ukm);
886 dukm = OPENSSL_memdup(ASN1_STRING_get0_data(ukm), dukmlen);
891 if (EVP_PKEY_CTX_set0_dh_kdf_ukm(pctx, dukm, dukmlen) <= 0)
896 * Now need to wrap encoding of wrap AlgorithmIdentifier into parameter
897 * of another AlgorithmIdentifier.
900 penclen = i2d_X509_ALGOR(wrap_alg, &penc);
901 if (penc == NULL || penclen == 0)
903 wrap_str = ASN1_STRING_new();
904 if (wrap_str == NULL)
906 ASN1_STRING_set0(wrap_str, penc, penclen);
908 X509_ALGOR_set0(talg, OBJ_nid2obj(NID_id_smime_alg_ESDH),
909 V_ASN1_SEQUENCE, wrap_str);
915 X509_ALGOR_free(wrap_alg);