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 #include "internal/cryptlib.h"
12 #include <openssl/x509.h>
13 #include <openssl/asn1.h>
15 #include <openssl/bn.h>
16 #include "crypto/asn1.h"
17 #include "crypto/evp.h"
18 #include <openssl/cms.h>
19 #include <openssl/core_names.h>
20 #include "internal/param_build.h"
23 * i2d/d2i like DH parameter functions which use the appropriate routine for
24 * PKCS#3 DH or X9.42 DH.
27 static DH *d2i_dhp(const EVP_PKEY *pkey, const unsigned char **pp,
30 if (pkey->ameth == &dhx_asn1_meth)
31 return d2i_DHxparams(NULL, pp, length);
32 return d2i_DHparams(NULL, pp, length);
35 static int i2d_dhp(const EVP_PKEY *pkey, const DH *a, unsigned char **pp)
37 if (pkey->ameth == &dhx_asn1_meth)
38 return i2d_DHxparams(a, pp);
39 return i2d_DHparams(a, pp);
42 static void int_dh_free(EVP_PKEY *pkey)
44 DH_free(pkey->pkey.dh);
47 static int dh_pub_decode(EVP_PKEY *pkey, X509_PUBKEY *pubkey)
49 const unsigned char *p, *pm;
53 const ASN1_STRING *pstr;
55 ASN1_INTEGER *public_key = NULL;
59 if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, &palg, pubkey))
61 X509_ALGOR_get0(NULL, &ptype, &pval, palg);
63 if (ptype != V_ASN1_SEQUENCE) {
64 DHerr(DH_F_DH_PUB_DECODE, DH_R_PARAMETER_ENCODING_ERROR);
72 if ((dh = d2i_dhp(pkey, &pm, pmlen)) == NULL) {
73 DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
77 if ((public_key = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL) {
78 DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
82 /* We have parameters now set public key */
83 if ((dh->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
84 DHerr(DH_F_DH_PUB_DECODE, DH_R_BN_DECODE_ERROR);
88 ASN1_INTEGER_free(public_key);
89 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
93 ASN1_INTEGER_free(public_key);
99 static int dh_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
103 unsigned char *penc = NULL;
106 ASN1_INTEGER *pub_key = NULL;
110 str = ASN1_STRING_new();
112 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
115 str->length = i2d_dhp(pkey, dh, &str->data);
116 if (str->length <= 0) {
117 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
120 ptype = V_ASN1_SEQUENCE;
122 pub_key = BN_to_ASN1_INTEGER(dh->pub_key, NULL);
126 penclen = i2d_ASN1_INTEGER(pub_key, &penc);
128 ASN1_INTEGER_free(pub_key);
131 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
135 if (X509_PUBKEY_set0_param(pk, OBJ_nid2obj(pkey->ameth->pkey_id),
136 ptype, str, penc, penclen))
141 ASN1_STRING_free(str);
147 * PKCS#8 DH is defined in PKCS#11 of all places. It is similar to DH in that
148 * the AlgorithmIdentifier contains the parameters, the private key is
149 * explicitly included and the pubkey must be recalculated.
152 static int dh_priv_decode(EVP_PKEY *pkey, const PKCS8_PRIV_KEY_INFO *p8)
154 const unsigned char *p, *pm;
158 const ASN1_STRING *pstr;
159 const X509_ALGOR *palg;
160 ASN1_INTEGER *privkey = NULL;
163 if (!PKCS8_pkey_get0(NULL, &p, &pklen, &palg, p8))
166 X509_ALGOR_get0(NULL, &ptype, &pval, palg);
168 if (ptype != V_ASN1_SEQUENCE)
170 if ((privkey = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL)
175 pmlen = pstr->length;
176 if ((dh = d2i_dhp(pkey, &pm, pmlen)) == NULL)
179 /* We have parameters now set private key */
180 if ((dh->priv_key = BN_secure_new()) == NULL
181 || !ASN1_INTEGER_to_BN(privkey, dh->priv_key)) {
182 DHerr(DH_F_DH_PRIV_DECODE, DH_R_BN_ERROR);
185 /* Calculate public key, increments dirty_cnt */
186 if (!DH_generate_key(dh))
189 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
191 ASN1_STRING_clear_free(privkey);
196 DHerr(DH_F_DH_PRIV_DECODE, EVP_R_DECODE_ERROR);
199 ASN1_STRING_clear_free(privkey);
203 static int dh_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
205 ASN1_STRING *params = NULL;
206 ASN1_INTEGER *prkey = NULL;
207 unsigned char *dp = NULL;
210 params = ASN1_STRING_new();
212 if (params == NULL) {
213 DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
217 params->length = i2d_dhp(pkey, pkey->pkey.dh, ¶ms->data);
218 if (params->length <= 0) {
219 DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
222 params->type = V_ASN1_SEQUENCE;
224 /* Get private key into integer */
225 prkey = BN_to_ASN1_INTEGER(pkey->pkey.dh->priv_key, NULL);
228 DHerr(DH_F_DH_PRIV_ENCODE, DH_R_BN_ERROR);
232 dplen = i2d_ASN1_INTEGER(prkey, &dp);
234 ASN1_STRING_clear_free(prkey);
237 if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(pkey->ameth->pkey_id), 0,
238 V_ASN1_SEQUENCE, params, dp, dplen))
245 ASN1_STRING_free(params);
246 ASN1_STRING_clear_free(prkey);
250 static int dh_param_decode(EVP_PKEY *pkey,
251 const unsigned char **pder, int derlen)
255 if ((dh = d2i_dhp(pkey, pder, derlen)) == NULL) {
256 DHerr(DH_F_DH_PARAM_DECODE, ERR_R_DH_LIB);
260 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
264 static int dh_param_encode(const EVP_PKEY *pkey, unsigned char **pder)
266 return i2d_dhp(pkey, pkey->pkey.dh, pder);
269 static int do_dh_print(BIO *bp, const DH *x, int indent, int ptype)
271 int reason = ERR_R_BUF_LIB;
272 const char *ktype = NULL;
273 BIGNUM *priv_key, *pub_key;
276 priv_key = x->priv_key;
281 pub_key = x->pub_key;
285 if (x->params.p == NULL || (ptype == 2 && priv_key == NULL)
286 || (ptype > 0 && pub_key == NULL)) {
287 reason = ERR_R_PASSED_NULL_PARAMETER;
292 ktype = "DH Private-Key";
294 ktype = "DH Public-Key";
296 ktype = "DH Parameters";
298 if (!BIO_indent(bp, indent, 128)
299 || BIO_printf(bp, "%s: (%d bit)\n", ktype, DH_bits(x)) <= 0)
303 if (!ASN1_bn_print(bp, "private-key:", priv_key, NULL, indent))
305 if (!ASN1_bn_print(bp, "public-key:", pub_key, NULL, indent))
308 if (!ffc_params_print(bp, &x->params, indent))
311 if (x->length != 0) {
312 if (!BIO_indent(bp, indent, 128)
313 || BIO_printf(bp, "recommended-private-length: %d bits\n",
314 (int)x->length) <= 0)
321 DHerr(DH_F_DO_DH_PRINT, reason);
325 static int int_dh_size(const EVP_PKEY *pkey)
327 return DH_size(pkey->pkey.dh);
330 static int dh_bits(const EVP_PKEY *pkey)
332 return DH_bits(pkey->pkey.dh);
335 static int dh_security_bits(const EVP_PKEY *pkey)
337 return DH_security_bits(pkey->pkey.dh);
340 static int dh_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
342 return ffc_params_cmp(&a->pkey.dh->params, &a->pkey.dh->params,
343 a->ameth != &dhx_asn1_meth);
346 static int int_dh_param_copy(DH *to, const DH *from, int is_x942)
349 is_x942 = (from->params.q != NULL);
350 if (!ffc_params_copy(&to->params, &from->params))
353 to->length = from->length;
358 DH *DHparams_dup(const DH *dh)
364 if (!int_dh_param_copy(ret, dh, -1)) {
371 static int dh_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
373 if (to->pkey.dh == NULL) {
374 to->pkey.dh = DH_new();
375 if (to->pkey.dh == NULL)
378 return int_dh_param_copy(to->pkey.dh, from->pkey.dh,
379 from->ameth == &dhx_asn1_meth);
382 static int dh_missing_parameters(const EVP_PKEY *a)
384 return a->pkey.dh == NULL
385 || a->pkey.dh->params.p == NULL
386 || a->pkey.dh->params.g == NULL;
389 static int dh_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
391 if (dh_cmp_parameters(a, b) == 0)
393 if (BN_cmp(b->pkey.dh->pub_key, a->pkey.dh->pub_key) != 0)
399 static int dh_param_print(BIO *bp, const EVP_PKEY *pkey, int indent,
402 return do_dh_print(bp, pkey->pkey.dh, indent, 0);
405 static int dh_public_print(BIO *bp, const EVP_PKEY *pkey, int indent,
408 return do_dh_print(bp, pkey->pkey.dh, indent, 1);
411 static int dh_private_print(BIO *bp, const EVP_PKEY *pkey, int indent,
414 return do_dh_print(bp, pkey->pkey.dh, indent, 2);
417 int DHparams_print(BIO *bp, const DH *x)
419 return do_dh_print(bp, x, 4, 0);
422 #ifndef OPENSSL_NO_CMS
423 static int dh_cms_decrypt(CMS_RecipientInfo *ri);
424 static int dh_cms_encrypt(CMS_RecipientInfo *ri);
427 static int dh_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
430 case ASN1_PKEY_CTRL_SET1_TLS_ENCPT:
431 return dh_buf2key(EVP_PKEY_get0_DH(pkey), arg2, arg1);
432 case ASN1_PKEY_CTRL_GET1_TLS_ENCPT:
433 return dh_key2buf(EVP_PKEY_get0_DH(pkey), arg2);
439 static int dhx_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
442 #ifndef OPENSSL_NO_CMS
444 case ASN1_PKEY_CTRL_CMS_ENVELOPE:
446 return dh_cms_decrypt(arg2);
448 return dh_cms_encrypt(arg2);
451 case ASN1_PKEY_CTRL_CMS_RI_TYPE:
452 *(int *)arg2 = CMS_RECIPINFO_AGREE;
461 static int dh_pkey_public_check(const EVP_PKEY *pkey)
463 DH *dh = pkey->pkey.dh;
465 if (dh->pub_key == NULL) {
466 DHerr(DH_F_DH_PKEY_PUBLIC_CHECK, DH_R_MISSING_PUBKEY);
470 return DH_check_pub_key_ex(dh, dh->pub_key);
473 static int dh_pkey_param_check(const EVP_PKEY *pkey)
475 DH *dh = pkey->pkey.dh;
477 return DH_check_ex(dh);
480 static size_t dh_pkey_dirty_cnt(const EVP_PKEY *pkey)
482 return pkey->pkey.dh->dirty_cnt;
485 static int dh_pkey_export_to(const EVP_PKEY *from, void *to_keydata,
486 EVP_KEYMGMT *to_keymgmt)
488 DH *dh = from->pkey.dh;
490 const BIGNUM *p = DH_get0_p(dh), *g = DH_get0_g(dh), *q = DH_get0_q(dh);
491 const BIGNUM *pub_key = DH_get0_pub_key(dh);
492 const BIGNUM *priv_key = DH_get0_priv_key(dh);
496 if (p == NULL || g == NULL)
499 ossl_param_bld_init(&tmpl);
500 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_FFC_P, p)
501 || !ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_FFC_G, g))
504 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_FFC_Q, q))
507 /* A key must at least have a public part. */
508 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_PUB_KEY, pub_key))
510 if (priv_key != NULL) {
511 if (!ossl_param_bld_push_BN(&tmpl, OSSL_PKEY_PARAM_PRIV_KEY,
516 if ((params = ossl_param_bld_to_param(&tmpl)) == NULL)
519 /* We export, the provider imports */
520 rv = evp_keymgmt_import(to_keymgmt, to_keydata, OSSL_KEYMGMT_SELECT_ALL,
523 ossl_param_bld_free(params);
528 const EVP_PKEY_ASN1_METHOD dh_asn1_meth = {
534 "OpenSSL PKCS#3 DH method",
551 dh_missing_parameters,
563 dh_pkey_public_check,
572 const EVP_PKEY_ASN1_METHOD dhx_asn1_meth = {
578 "OpenSSL X9.42 DH method",
595 dh_missing_parameters,
607 dh_pkey_public_check,
611 #ifndef OPENSSL_NO_CMS
613 static int dh_cms_set_peerkey(EVP_PKEY_CTX *pctx,
614 X509_ALGOR *alg, ASN1_BIT_STRING *pubkey)
616 const ASN1_OBJECT *aoid;
619 ASN1_INTEGER *public_key = NULL;
621 EVP_PKEY *pkpeer = NULL, *pk = NULL;
623 const unsigned char *p;
626 X509_ALGOR_get0(&aoid, &atype, &aval, alg);
627 if (OBJ_obj2nid(aoid) != NID_dhpublicnumber)
629 /* Only absent parameters allowed in RFC XXXX */
630 if (atype != V_ASN1_UNDEF && atype == V_ASN1_NULL)
633 pk = EVP_PKEY_CTX_get0_pkey(pctx);
636 if (pk->type != EVP_PKEY_DHX)
638 /* Get parameters from parent key */
639 dhpeer = DHparams_dup(pk->pkey.dh);
640 /* We have parameters now set public key */
641 plen = ASN1_STRING_length(pubkey);
642 p = ASN1_STRING_get0_data(pubkey);
643 if (p == NULL || plen == 0)
646 if ((public_key = d2i_ASN1_INTEGER(NULL, &p, plen)) == NULL) {
647 DHerr(DH_F_DH_CMS_SET_PEERKEY, DH_R_DECODE_ERROR);
651 /* We have parameters now set public key */
652 if ((dhpeer->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
653 DHerr(DH_F_DH_CMS_SET_PEERKEY, DH_R_BN_DECODE_ERROR);
657 pkpeer = EVP_PKEY_new();
660 EVP_PKEY_assign(pkpeer, pk->ameth->pkey_id, dhpeer);
662 if (EVP_PKEY_derive_set_peer(pctx, pkpeer) > 0)
665 ASN1_INTEGER_free(public_key);
666 EVP_PKEY_free(pkpeer);
671 static int dh_cms_set_shared_info(EVP_PKEY_CTX *pctx, CMS_RecipientInfo *ri)
675 X509_ALGOR *alg, *kekalg = NULL;
676 ASN1_OCTET_STRING *ukm;
677 const unsigned char *p;
678 unsigned char *dukm = NULL;
681 const EVP_CIPHER *kekcipher;
682 EVP_CIPHER_CTX *kekctx;
684 if (!CMS_RecipientInfo_kari_get0_alg(ri, &alg, &ukm))
688 * For DH we only have one OID permissible. If ever any more get defined
689 * we will need something cleverer.
691 if (OBJ_obj2nid(alg->algorithm) != NID_id_smime_alg_ESDH) {
692 DHerr(DH_F_DH_CMS_SET_SHARED_INFO, DH_R_KDF_PARAMETER_ERROR);
696 if (EVP_PKEY_CTX_set_dh_kdf_type(pctx, EVP_PKEY_DH_KDF_X9_42) <= 0)
699 if (EVP_PKEY_CTX_set_dh_kdf_md(pctx, EVP_sha1()) <= 0)
702 if (alg->parameter->type != V_ASN1_SEQUENCE)
705 p = alg->parameter->value.sequence->data;
706 plen = alg->parameter->value.sequence->length;
707 kekalg = d2i_X509_ALGOR(NULL, &p, plen);
710 kekctx = CMS_RecipientInfo_kari_get0_ctx(ri);
713 kekcipher = EVP_get_cipherbyobj(kekalg->algorithm);
714 if (!kekcipher || EVP_CIPHER_mode(kekcipher) != EVP_CIPH_WRAP_MODE)
716 if (!EVP_EncryptInit_ex(kekctx, kekcipher, NULL, NULL, NULL))
718 if (EVP_CIPHER_asn1_to_param(kekctx, kekalg->parameter) <= 0)
721 keylen = EVP_CIPHER_CTX_key_length(kekctx);
722 if (EVP_PKEY_CTX_set_dh_kdf_outlen(pctx, keylen) <= 0)
724 /* Use OBJ_nid2obj to ensure we use built in OID that isn't freed */
725 if (EVP_PKEY_CTX_set0_dh_kdf_oid(pctx,
726 OBJ_nid2obj(EVP_CIPHER_type(kekcipher)))
731 dukmlen = ASN1_STRING_length(ukm);
732 dukm = OPENSSL_memdup(ASN1_STRING_get0_data(ukm), dukmlen);
737 if (EVP_PKEY_CTX_set0_dh_kdf_ukm(pctx, dukm, dukmlen) <= 0)
743 X509_ALGOR_free(kekalg);
748 static int dh_cms_decrypt(CMS_RecipientInfo *ri)
752 pctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
756 /* See if we need to set peer key */
757 if (!EVP_PKEY_CTX_get0_peerkey(pctx)) {
759 ASN1_BIT_STRING *pubkey;
760 if (!CMS_RecipientInfo_kari_get0_orig_id(ri, &alg, &pubkey,
765 if (!dh_cms_set_peerkey(pctx, alg, pubkey)) {
766 DHerr(DH_F_DH_CMS_DECRYPT, DH_R_PEER_KEY_ERROR);
770 /* Set DH derivation parameters and initialise unwrap context */
771 if (!dh_cms_set_shared_info(pctx, ri)) {
772 DHerr(DH_F_DH_CMS_DECRYPT, DH_R_SHARED_INFO_ERROR);
778 static int dh_cms_encrypt(CMS_RecipientInfo *ri)
784 X509_ALGOR *talg, *wrap_alg = NULL;
785 const ASN1_OBJECT *aoid;
786 ASN1_BIT_STRING *pubkey;
787 ASN1_STRING *wrap_str;
788 ASN1_OCTET_STRING *ukm;
789 unsigned char *penc = NULL, *dukm = NULL;
793 int kdf_type, wrap_nid;
794 const EVP_MD *kdf_md;
796 pctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
799 /* Get ephemeral key */
800 pkey = EVP_PKEY_CTX_get0_pkey(pctx);
801 if (!CMS_RecipientInfo_kari_get0_orig_id(ri, &talg, &pubkey,
804 X509_ALGOR_get0(&aoid, NULL, NULL, talg);
805 /* Is everything uninitialised? */
806 if (aoid == OBJ_nid2obj(NID_undef)) {
807 ASN1_INTEGER *pubk = BN_to_ASN1_INTEGER(pkey->pkey.dh->pub_key, NULL);
813 penclen = i2d_ASN1_INTEGER(pubk, &penc);
814 ASN1_INTEGER_free(pubk);
817 ASN1_STRING_set0(pubkey, penc, penclen);
818 pubkey->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
819 pubkey->flags |= ASN1_STRING_FLAG_BITS_LEFT;
822 X509_ALGOR_set0(talg, OBJ_nid2obj(NID_dhpublicnumber),
826 /* See if custom parameters set */
827 kdf_type = EVP_PKEY_CTX_get_dh_kdf_type(pctx);
830 if (!EVP_PKEY_CTX_get_dh_kdf_md(pctx, &kdf_md))
833 if (kdf_type == EVP_PKEY_DH_KDF_NONE) {
834 kdf_type = EVP_PKEY_DH_KDF_X9_42;
835 if (EVP_PKEY_CTX_set_dh_kdf_type(pctx, kdf_type) <= 0)
837 } else if (kdf_type != EVP_PKEY_DH_KDF_X9_42)
840 if (kdf_md == NULL) {
841 /* Only SHA1 supported */
843 if (EVP_PKEY_CTX_set_dh_kdf_md(pctx, kdf_md) <= 0)
845 } else if (EVP_MD_type(kdf_md) != NID_sha1)
846 /* Unsupported digest */
849 if (!CMS_RecipientInfo_kari_get0_alg(ri, &talg, &ukm))
853 ctx = CMS_RecipientInfo_kari_get0_ctx(ri);
854 wrap_nid = EVP_CIPHER_CTX_type(ctx);
855 if (EVP_PKEY_CTX_set0_dh_kdf_oid(pctx, OBJ_nid2obj(wrap_nid)) <= 0)
857 keylen = EVP_CIPHER_CTX_key_length(ctx);
859 /* Package wrap algorithm in an AlgorithmIdentifier */
861 wrap_alg = X509_ALGOR_new();
862 if (wrap_alg == NULL)
864 wrap_alg->algorithm = OBJ_nid2obj(wrap_nid);
865 wrap_alg->parameter = ASN1_TYPE_new();
866 if (wrap_alg->parameter == NULL)
868 if (EVP_CIPHER_param_to_asn1(ctx, wrap_alg->parameter) <= 0)
870 if (ASN1_TYPE_get(wrap_alg->parameter) == NID_undef) {
871 ASN1_TYPE_free(wrap_alg->parameter);
872 wrap_alg->parameter = NULL;
875 if (EVP_PKEY_CTX_set_dh_kdf_outlen(pctx, keylen) <= 0)
879 dukmlen = ASN1_STRING_length(ukm);
880 dukm = OPENSSL_memdup(ASN1_STRING_get0_data(ukm), dukmlen);
885 if (EVP_PKEY_CTX_set0_dh_kdf_ukm(pctx, dukm, dukmlen) <= 0)
890 * Now need to wrap encoding of wrap AlgorithmIdentifier into parameter
891 * of another AlgorithmIdentifier.
894 penclen = i2d_X509_ALGOR(wrap_alg, &penc);
895 if (penc == NULL || penclen == 0)
897 wrap_str = ASN1_STRING_new();
898 if (wrap_str == NULL)
900 ASN1_STRING_set0(wrap_str, penc, penclen);
902 X509_ALGOR_set0(talg, OBJ_nid2obj(NID_id_smime_alg_ESDH),
903 V_ASN1_SEQUENCE, wrap_str);
909 X509_ALGOR_free(wrap_alg);