2 * Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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 "internal/asn1_int.h"
17 #include "internal/evp_int.h"
18 #include <openssl/cms.h>
21 * i2d/d2i like DH parameter functions which use the appropriate routine for
22 * PKCS#3 DH or X9.42 DH.
25 static DH *d2i_dhp(const EVP_PKEY *pkey, const unsigned char **pp,
28 if (pkey->ameth == &dhx_asn1_meth)
29 return d2i_DHxparams(NULL, pp, length);
30 return d2i_DHparams(NULL, pp, length);
33 static int i2d_dhp(const EVP_PKEY *pkey, const DH *a, unsigned char **pp)
35 if (pkey->ameth == &dhx_asn1_meth)
36 return i2d_DHxparams(a, pp);
37 return i2d_DHparams(a, pp);
40 static void int_dh_free(EVP_PKEY *pkey)
42 DH_free(pkey->pkey.dh);
45 static int dh_pub_decode(EVP_PKEY *pkey, X509_PUBKEY *pubkey)
47 const unsigned char *p, *pm;
51 const ASN1_STRING *pstr;
53 ASN1_INTEGER *public_key = NULL;
57 if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, &palg, pubkey))
59 X509_ALGOR_get0(NULL, &ptype, &pval, palg);
61 if (ptype != V_ASN1_SEQUENCE) {
62 DHerr(DH_F_DH_PUB_DECODE, DH_R_PARAMETER_ENCODING_ERROR);
70 if ((dh = d2i_dhp(pkey, &pm, pmlen)) == NULL) {
71 DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
75 if ((public_key = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL) {
76 DHerr(DH_F_DH_PUB_DECODE, DH_R_DECODE_ERROR);
80 /* We have parameters now set public key */
81 if ((dh->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
82 DHerr(DH_F_DH_PUB_DECODE, DH_R_BN_DECODE_ERROR);
86 ASN1_INTEGER_free(public_key);
87 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
91 ASN1_INTEGER_free(public_key);
97 static int dh_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
101 unsigned char *penc = NULL;
104 ASN1_INTEGER *pub_key = NULL;
108 str = ASN1_STRING_new();
110 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
113 str->length = i2d_dhp(pkey, dh, &str->data);
114 if (str->length <= 0) {
115 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
118 ptype = V_ASN1_SEQUENCE;
120 pub_key = BN_to_ASN1_INTEGER(dh->pub_key, NULL);
124 penclen = i2d_ASN1_INTEGER(pub_key, &penc);
126 ASN1_INTEGER_free(pub_key);
129 DHerr(DH_F_DH_PUB_ENCODE, ERR_R_MALLOC_FAILURE);
133 if (X509_PUBKEY_set0_param(pk, OBJ_nid2obj(pkey->ameth->pkey_id),
134 ptype, str, penc, penclen))
139 ASN1_STRING_free(str);
145 * PKCS#8 DH is defined in PKCS#11 of all places. It is similar to DH in that
146 * the AlgorithmIdentifier contains the parameters, the private key is
147 * explicitly included and the pubkey must be recalculated.
150 static int dh_priv_decode(EVP_PKEY *pkey, const PKCS8_PRIV_KEY_INFO *p8)
152 const unsigned char *p, *pm;
156 const ASN1_STRING *pstr;
157 const X509_ALGOR *palg;
158 ASN1_INTEGER *privkey = NULL;
162 if (!PKCS8_pkey_get0(NULL, &p, &pklen, &palg, p8))
165 X509_ALGOR_get0(NULL, &ptype, &pval, palg);
167 if (ptype != V_ASN1_SEQUENCE)
169 if ((privkey = d2i_ASN1_INTEGER(NULL, &p, pklen)) == NULL)
174 pmlen = pstr->length;
175 if ((dh = d2i_dhp(pkey, &pm, pmlen)) == NULL)
178 /* We have parameters now set private key */
179 if ((dh->priv_key = BN_secure_new()) == NULL
180 || !ASN1_INTEGER_to_BN(privkey, dh->priv_key)) {
181 DHerr(DH_F_DH_PRIV_DECODE, DH_R_BN_ERROR);
184 /* Calculate public key */
185 if (!DH_generate_key(dh))
188 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
190 ASN1_STRING_clear_free(privkey);
195 DHerr(DH_F_DH_PRIV_DECODE, EVP_R_DECODE_ERROR);
198 ASN1_STRING_clear_free(privkey);
202 static int dh_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
204 ASN1_STRING *params = NULL;
205 ASN1_INTEGER *prkey = NULL;
206 unsigned char *dp = NULL;
209 params = ASN1_STRING_new();
211 if (params == NULL) {
212 DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
216 params->length = i2d_dhp(pkey, pkey->pkey.dh, ¶ms->data);
217 if (params->length <= 0) {
218 DHerr(DH_F_DH_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
221 params->type = V_ASN1_SEQUENCE;
223 /* Get private key into integer */
224 prkey = BN_to_ASN1_INTEGER(pkey->pkey.dh->priv_key, NULL);
227 DHerr(DH_F_DH_PRIV_ENCODE, DH_R_BN_ERROR);
231 dplen = i2d_ASN1_INTEGER(prkey, &dp);
233 ASN1_STRING_clear_free(prkey);
236 if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(pkey->ameth->pkey_id), 0,
237 V_ASN1_SEQUENCE, params, dp, dplen))
244 ASN1_STRING_free(params);
245 ASN1_STRING_clear_free(prkey);
249 static int dh_param_decode(EVP_PKEY *pkey,
250 const unsigned char **pder, int derlen)
254 if ((dh = d2i_dhp(pkey, pder, derlen)) == NULL) {
255 DHerr(DH_F_DH_PARAM_DECODE, ERR_R_DH_LIB);
258 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, dh);
262 static int dh_param_encode(const EVP_PKEY *pkey, unsigned char **pder)
264 return i2d_dhp(pkey, pkey->pkey.dh, pder);
267 static int do_dh_print(BIO *bp, const DH *x, int indent, int ptype)
269 int reason = ERR_R_BUF_LIB;
270 const char *ktype = NULL;
271 BIGNUM *priv_key, *pub_key;
274 priv_key = x->priv_key;
279 pub_key = x->pub_key;
283 if (x->p == NULL || (ptype == 2 && priv_key == NULL)
284 || (ptype > 0 && pub_key == NULL)) {
285 reason = ERR_R_PASSED_NULL_PARAMETER;
290 ktype = "DH Private-Key";
292 ktype = "DH Public-Key";
294 ktype = "DH Parameters";
296 BIO_indent(bp, indent, 128);
297 if (BIO_printf(bp, "%s: (%d bit)\n", ktype, BN_num_bits(x->p)) <= 0)
301 if (!ASN1_bn_print(bp, "private-key:", priv_key, NULL, indent))
303 if (!ASN1_bn_print(bp, "public-key:", pub_key, NULL, indent))
306 if (!ASN1_bn_print(bp, "prime:", x->p, NULL, indent))
308 if (!ASN1_bn_print(bp, "generator:", x->g, NULL, indent))
310 if (x->q && !ASN1_bn_print(bp, "subgroup order:", x->q, NULL, indent))
312 if (x->j && !ASN1_bn_print(bp, "subgroup factor:", x->j, NULL, indent))
316 BIO_indent(bp, indent, 128);
317 BIO_puts(bp, "seed:");
318 for (i = 0; i < x->seedlen; i++) {
320 if (BIO_puts(bp, "\n") <= 0
321 || !BIO_indent(bp, indent + 4, 128))
324 if (BIO_printf(bp, "%02x%s", x->seed[i],
325 ((i + 1) == x->seedlen) ? "" : ":") <= 0)
328 if (BIO_write(bp, "\n", 1) <= 0)
331 if (x->counter && !ASN1_bn_print(bp, "counter:", x->counter, NULL, indent))
333 if (x->length != 0) {
334 BIO_indent(bp, indent, 128);
335 if (BIO_printf(bp, "recommended-private-length: %d bits\n",
336 (int)x->length) <= 0)
343 DHerr(DH_F_DO_DH_PRINT, reason);
347 static int int_dh_size(const EVP_PKEY *pkey)
349 return DH_size(pkey->pkey.dh);
352 static int dh_bits(const EVP_PKEY *pkey)
354 return BN_num_bits(pkey->pkey.dh->p);
357 static int dh_security_bits(const EVP_PKEY *pkey)
359 return DH_security_bits(pkey->pkey.dh);
362 static int dh_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
364 if (BN_cmp(a->pkey.dh->p, b->pkey.dh->p) ||
365 BN_cmp(a->pkey.dh->g, b->pkey.dh->g))
367 else if (a->ameth == &dhx_asn1_meth) {
368 if (BN_cmp(a->pkey.dh->q, b->pkey.dh->q))
374 static int int_dh_bn_cpy(BIGNUM **dst, const BIGNUM *src)
379 * If source is read only just copy the pointer, so
380 * we don't have to reallocate it.
384 else if (BN_get_flags(src, BN_FLG_STATIC_DATA)
385 && !BN_get_flags(src, BN_FLG_MALLOCED))
387 else if ((a = BN_dup(src)) == NULL)
394 static int int_dh_param_copy(DH *to, const DH *from, int is_x942)
397 is_x942 = ! !from->q;
398 if (!int_dh_bn_cpy(&to->p, from->p))
400 if (!int_dh_bn_cpy(&to->g, from->g))
403 if (!int_dh_bn_cpy(&to->q, from->q))
405 if (!int_dh_bn_cpy(&to->j, from->j))
407 OPENSSL_free(to->seed);
411 to->seed = OPENSSL_memdup(from->seed, from->seedlen);
414 to->seedlen = from->seedlen;
417 to->length = from->length;
421 DH *DHparams_dup(DH *dh)
427 if (!int_dh_param_copy(ret, dh, -1)) {
434 static int dh_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
436 if (to->pkey.dh == NULL) {
437 to->pkey.dh = DH_new();
438 if (to->pkey.dh == NULL)
441 return int_dh_param_copy(to->pkey.dh, from->pkey.dh,
442 from->ameth == &dhx_asn1_meth);
445 static int dh_missing_parameters(const EVP_PKEY *a)
447 if (a->pkey.dh == NULL || a->pkey.dh->p == NULL || a->pkey.dh->g == NULL)
452 static int dh_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
454 if (dh_cmp_parameters(a, b) == 0)
456 if (BN_cmp(b->pkey.dh->pub_key, a->pkey.dh->pub_key) != 0)
462 static int dh_param_print(BIO *bp, const EVP_PKEY *pkey, int indent,
465 return do_dh_print(bp, pkey->pkey.dh, indent, 0);
468 static int dh_public_print(BIO *bp, const EVP_PKEY *pkey, int indent,
471 return do_dh_print(bp, pkey->pkey.dh, indent, 1);
474 static int dh_private_print(BIO *bp, const EVP_PKEY *pkey, int indent,
477 return do_dh_print(bp, pkey->pkey.dh, indent, 2);
480 int DHparams_print(BIO *bp, const DH *x)
482 return do_dh_print(bp, x, 4, 0);
485 #ifndef OPENSSL_NO_CMS
486 static int dh_cms_decrypt(CMS_RecipientInfo *ri);
487 static int dh_cms_encrypt(CMS_RecipientInfo *ri);
490 static int dh_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
493 #ifndef OPENSSL_NO_CMS
495 case ASN1_PKEY_CTRL_CMS_ENVELOPE:
497 return dh_cms_decrypt(arg2);
499 return dh_cms_encrypt(arg2);
502 case ASN1_PKEY_CTRL_CMS_RI_TYPE:
503 *(int *)arg2 = CMS_RECIPINFO_AGREE;
512 static int dh_pkey_public_check(const EVP_PKEY *pkey)
514 DH *dh = pkey->pkey.dh;
516 if (dh->pub_key == NULL) {
517 DHerr(DH_F_DH_PKEY_PUBLIC_CHECK, DH_R_MISSING_PUBKEY);
521 return DH_check_pub_key_ex(dh, dh->pub_key);
524 static int dh_pkey_param_check(const EVP_PKEY *pkey)
526 DH *dh = pkey->pkey.dh;
528 return DH_check_ex(dh);
531 const EVP_PKEY_ASN1_METHOD dh_asn1_meth = {
537 "OpenSSL PKCS#3 DH method",
554 dh_missing_parameters,
566 dh_pkey_public_check,
570 const EVP_PKEY_ASN1_METHOD dhx_asn1_meth = {
576 "OpenSSL X9.42 DH method",
593 dh_missing_parameters,
605 dh_pkey_public_check,
609 #ifndef OPENSSL_NO_CMS
611 static int dh_cms_set_peerkey(EVP_PKEY_CTX *pctx,
612 X509_ALGOR *alg, ASN1_BIT_STRING *pubkey)
614 const ASN1_OBJECT *aoid;
617 ASN1_INTEGER *public_key = NULL;
619 EVP_PKEY *pkpeer = NULL, *pk = NULL;
621 const unsigned char *p;
624 X509_ALGOR_get0(&aoid, &atype, &aval, alg);
625 if (OBJ_obj2nid(aoid) != NID_dhpublicnumber)
627 /* Only absent parameters allowed in RFC XXXX */
628 if (atype != V_ASN1_UNDEF && atype == V_ASN1_NULL)
631 pk = EVP_PKEY_CTX_get0_pkey(pctx);
634 if (pk->type != EVP_PKEY_DHX)
636 /* Get parameters from parent key */
637 dhpeer = DHparams_dup(pk->pkey.dh);
638 /* We have parameters now set public key */
639 plen = ASN1_STRING_length(pubkey);
640 p = ASN1_STRING_get0_data(pubkey);
644 if ((public_key = d2i_ASN1_INTEGER(NULL, &p, plen)) == NULL) {
645 DHerr(DH_F_DH_CMS_SET_PEERKEY, DH_R_DECODE_ERROR);
649 /* We have parameters now set public key */
650 if ((dhpeer->pub_key = ASN1_INTEGER_to_BN(public_key, NULL)) == NULL) {
651 DHerr(DH_F_DH_CMS_SET_PEERKEY, DH_R_BN_DECODE_ERROR);
655 pkpeer = EVP_PKEY_new();
658 EVP_PKEY_assign(pkpeer, pk->ameth->pkey_id, dhpeer);
660 if (EVP_PKEY_derive_set_peer(pctx, pkpeer) > 0)
663 ASN1_INTEGER_free(public_key);
664 EVP_PKEY_free(pkpeer);
669 static int dh_cms_set_shared_info(EVP_PKEY_CTX *pctx, CMS_RecipientInfo *ri)
673 X509_ALGOR *alg, *kekalg = NULL;
674 ASN1_OCTET_STRING *ukm;
675 const unsigned char *p;
676 unsigned char *dukm = NULL;
679 const EVP_CIPHER *kekcipher;
680 EVP_CIPHER_CTX *kekctx;
682 if (!CMS_RecipientInfo_kari_get0_alg(ri, &alg, &ukm))
686 * For DH we only have one OID permissible. If ever any more get defined
687 * we will need something cleverer.
689 if (OBJ_obj2nid(alg->algorithm) != NID_id_smime_alg_ESDH) {
690 DHerr(DH_F_DH_CMS_SET_SHARED_INFO, DH_R_KDF_PARAMETER_ERROR);
694 if (EVP_PKEY_CTX_set_dh_kdf_type(pctx, EVP_PKEY_DH_KDF_X9_42) <= 0)
697 if (EVP_PKEY_CTX_set_dh_kdf_md(pctx, EVP_sha1()) <= 0)
700 if (alg->parameter->type != V_ASN1_SEQUENCE)
703 p = alg->parameter->value.sequence->data;
704 plen = alg->parameter->value.sequence->length;
705 kekalg = d2i_X509_ALGOR(NULL, &p, plen);
708 kekctx = CMS_RecipientInfo_kari_get0_ctx(ri);
711 kekcipher = EVP_get_cipherbyobj(kekalg->algorithm);
712 if (!kekcipher || EVP_CIPHER_mode(kekcipher) != EVP_CIPH_WRAP_MODE)
714 if (!EVP_EncryptInit_ex(kekctx, kekcipher, NULL, NULL, NULL))
716 if (EVP_CIPHER_asn1_to_param(kekctx, kekalg->parameter) <= 0)
719 keylen = EVP_CIPHER_CTX_key_length(kekctx);
720 if (EVP_PKEY_CTX_set_dh_kdf_outlen(pctx, keylen) <= 0)
722 /* Use OBJ_nid2obj to ensure we use built in OID that isn't freed */
723 if (EVP_PKEY_CTX_set0_dh_kdf_oid(pctx,
724 OBJ_nid2obj(EVP_CIPHER_type(kekcipher)))
729 dukmlen = ASN1_STRING_length(ukm);
730 dukm = OPENSSL_memdup(ASN1_STRING_get0_data(ukm), dukmlen);
735 if (EVP_PKEY_CTX_set0_dh_kdf_ukm(pctx, dukm, dukmlen) <= 0)
741 X509_ALGOR_free(kekalg);
746 static int dh_cms_decrypt(CMS_RecipientInfo *ri)
749 pctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
752 /* See if we need to set peer key */
753 if (!EVP_PKEY_CTX_get0_peerkey(pctx)) {
755 ASN1_BIT_STRING *pubkey;
756 if (!CMS_RecipientInfo_kari_get0_orig_id(ri, &alg, &pubkey,
761 if (!dh_cms_set_peerkey(pctx, alg, pubkey)) {
762 DHerr(DH_F_DH_CMS_DECRYPT, DH_R_PEER_KEY_ERROR);
766 /* Set DH derivation parameters and initialise unwrap context */
767 if (!dh_cms_set_shared_info(pctx, ri)) {
768 DHerr(DH_F_DH_CMS_DECRYPT, DH_R_SHARED_INFO_ERROR);
774 static int dh_cms_encrypt(CMS_RecipientInfo *ri)
780 X509_ALGOR *talg, *wrap_alg = NULL;
781 const ASN1_OBJECT *aoid;
782 ASN1_BIT_STRING *pubkey;
783 ASN1_STRING *wrap_str;
784 ASN1_OCTET_STRING *ukm;
785 unsigned char *penc = NULL, *dukm = NULL;
789 int kdf_type, wrap_nid;
790 const EVP_MD *kdf_md;
791 pctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
794 /* Get ephemeral key */
795 pkey = EVP_PKEY_CTX_get0_pkey(pctx);
796 if (!CMS_RecipientInfo_kari_get0_orig_id(ri, &talg, &pubkey,
799 X509_ALGOR_get0(&aoid, NULL, NULL, talg);
800 /* Is everything uninitialised? */
801 if (aoid == OBJ_nid2obj(NID_undef)) {
802 ASN1_INTEGER *pubk = BN_to_ASN1_INTEGER(pkey->pkey.dh->pub_key, NULL);
807 penclen = i2d_ASN1_INTEGER(pubk, &penc);
808 ASN1_INTEGER_free(pubk);
811 ASN1_STRING_set0(pubkey, penc, penclen);
812 pubkey->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
813 pubkey->flags |= ASN1_STRING_FLAG_BITS_LEFT;
816 X509_ALGOR_set0(talg, OBJ_nid2obj(NID_dhpublicnumber),
820 /* See if custom parameters set */
821 kdf_type = EVP_PKEY_CTX_get_dh_kdf_type(pctx);
824 if (!EVP_PKEY_CTX_get_dh_kdf_md(pctx, &kdf_md))
827 if (kdf_type == EVP_PKEY_DH_KDF_NONE) {
828 kdf_type = EVP_PKEY_DH_KDF_X9_42;
829 if (EVP_PKEY_CTX_set_dh_kdf_type(pctx, kdf_type) <= 0)
831 } else if (kdf_type != EVP_PKEY_DH_KDF_X9_42)
834 if (kdf_md == NULL) {
835 /* Only SHA1 supported */
837 if (EVP_PKEY_CTX_set_dh_kdf_md(pctx, kdf_md) <= 0)
839 } else if (EVP_MD_type(kdf_md) != NID_sha1)
840 /* Unsupported digest */
843 if (!CMS_RecipientInfo_kari_get0_alg(ri, &talg, &ukm))
847 ctx = CMS_RecipientInfo_kari_get0_ctx(ri);
848 wrap_nid = EVP_CIPHER_CTX_type(ctx);
849 if (EVP_PKEY_CTX_set0_dh_kdf_oid(pctx, OBJ_nid2obj(wrap_nid)) <= 0)
851 keylen = EVP_CIPHER_CTX_key_length(ctx);
853 /* Package wrap algorithm in an AlgorithmIdentifier */
855 wrap_alg = X509_ALGOR_new();
856 if (wrap_alg == NULL)
858 wrap_alg->algorithm = OBJ_nid2obj(wrap_nid);
859 wrap_alg->parameter = ASN1_TYPE_new();
860 if (wrap_alg->parameter == NULL)
862 if (EVP_CIPHER_param_to_asn1(ctx, wrap_alg->parameter) <= 0)
864 if (ASN1_TYPE_get(wrap_alg->parameter) == NID_undef) {
865 ASN1_TYPE_free(wrap_alg->parameter);
866 wrap_alg->parameter = NULL;
869 if (EVP_PKEY_CTX_set_dh_kdf_outlen(pctx, keylen) <= 0)
873 dukmlen = ASN1_STRING_length(ukm);
874 dukm = OPENSSL_memdup(ASN1_STRING_get0_data(ukm), dukmlen);
879 if (EVP_PKEY_CTX_set0_dh_kdf_ukm(pctx, dukm, dukmlen) <= 0)
884 * Now need to wrap encoding of wrap AlgorithmIdentifier into parameter
885 * of another AlgorithmIdentifier.
888 penclen = i2d_X509_ALGOR(wrap_alg, &penc);
889 if (!penc || !penclen)
891 wrap_str = ASN1_STRING_new();
892 if (wrap_str == NULL)
894 ASN1_STRING_set0(wrap_str, penc, penclen);
896 X509_ALGOR_set0(talg, OBJ_nid2obj(NID_id_smime_alg_ESDH),
897 V_ASN1_SEQUENCE, wrap_str);
903 X509_ALGOR_free(wrap_alg);