2 * Copyright 2006-2022 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 <openssl/x509.h>
18 #include <openssl/asn1.h>
19 #include <openssl/bn.h>
20 #include <openssl/core_names.h>
21 #include <openssl/param_build.h>
22 #include "internal/ffc.h"
23 #include "internal/cryptlib.h"
24 #include "crypto/asn1.h"
25 #include "crypto/dh.h"
26 #include "crypto/evp.h"
30 * i2d/d2i like DH parameter functions which use the appropriate routine for
31 * PKCS#3 DH or X9.42 DH.
34 static DH
*d2i_dhp(const EVP_PKEY
*pkey
, const unsigned char **pp
,
38 int is_dhx
= (pkey
->ameth
== &ossl_dhx_asn1_meth
);
41 dh
= d2i_DHxparams(NULL
, pp
, length
);
43 dh
= d2i_DHparams(NULL
, pp
, length
);
48 static int i2d_dhp(const EVP_PKEY
*pkey
, const DH
*a
, unsigned char **pp
)
50 if (pkey
->ameth
== &ossl_dhx_asn1_meth
)
51 return i2d_DHxparams(a
, pp
);
52 return i2d_DHparams(a
, pp
);
55 static void int_dh_free(EVP_PKEY
*pkey
)
57 DH_free(pkey
->pkey
.dh
);
60 static int dh_pub_decode(EVP_PKEY
*pkey
, const X509_PUBKEY
*pubkey
)
62 const unsigned char *p
, *pm
;
66 const ASN1_STRING
*pstr
;
68 ASN1_INTEGER
*public_key
= NULL
;
72 if (!X509_PUBKEY_get0_param(NULL
, &p
, &pklen
, &palg
, pubkey
))
74 X509_ALGOR_get0(NULL
, &ptype
, &pval
, palg
);
76 if (ptype
!= V_ASN1_SEQUENCE
) {
77 ERR_raise(ERR_LIB_DH
, DH_R_PARAMETER_ENCODING_ERROR
);
85 if ((dh
= d2i_dhp(pkey
, &pm
, pmlen
)) == NULL
) {
86 ERR_raise(ERR_LIB_DH
, DH_R_DECODE_ERROR
);
90 if ((public_key
= d2i_ASN1_INTEGER(NULL
, &p
, pklen
)) == NULL
) {
91 ERR_raise(ERR_LIB_DH
, DH_R_DECODE_ERROR
);
95 /* We have parameters now set public key */
96 if ((dh
->pub_key
= ASN1_INTEGER_to_BN(public_key
, NULL
)) == NULL
) {
97 ERR_raise(ERR_LIB_DH
, DH_R_BN_DECODE_ERROR
);
101 ASN1_INTEGER_free(public_key
);
102 EVP_PKEY_assign(pkey
, pkey
->ameth
->pkey_id
, dh
);
106 ASN1_INTEGER_free(public_key
);
111 static int dh_pub_encode(X509_PUBKEY
*pk
, const EVP_PKEY
*pkey
)
115 unsigned char *penc
= NULL
;
118 ASN1_INTEGER
*pub_key
= NULL
;
122 str
= ASN1_STRING_new();
124 ERR_raise(ERR_LIB_DH
, ERR_R_ASN1_LIB
);
127 str
->length
= i2d_dhp(pkey
, dh
, &str
->data
);
128 if (str
->length
<= 0) {
129 ERR_raise(ERR_LIB_DH
, ERR_R_ASN1_LIB
);
132 ptype
= V_ASN1_SEQUENCE
;
134 pub_key
= BN_to_ASN1_INTEGER(dh
->pub_key
, NULL
);
138 penclen
= i2d_ASN1_INTEGER(pub_key
, &penc
);
140 ASN1_INTEGER_free(pub_key
);
143 ERR_raise(ERR_LIB_DH
, ERR_R_ASN1_LIB
);
147 if (X509_PUBKEY_set0_param(pk
, OBJ_nid2obj(pkey
->ameth
->pkey_id
),
148 ptype
, str
, penc
, penclen
))
153 ASN1_STRING_free(str
);
159 * PKCS#8 DH is defined in PKCS#11 of all places. It is similar to DH in that
160 * the AlgorithmIdentifier contains the parameters, the private key is
161 * explicitly included and the pubkey must be recalculated.
164 static int dh_priv_decode(EVP_PKEY
*pkey
, const PKCS8_PRIV_KEY_INFO
*p8
)
167 DH
*dh
= ossl_dh_key_from_pkcs8(p8
, NULL
, NULL
);
171 EVP_PKEY_assign(pkey
, pkey
->ameth
->pkey_id
, dh
);
177 static int dh_priv_encode(PKCS8_PRIV_KEY_INFO
*p8
, const EVP_PKEY
*pkey
)
179 ASN1_STRING
*params
= NULL
;
180 ASN1_INTEGER
*prkey
= NULL
;
181 unsigned char *dp
= NULL
;
184 params
= ASN1_STRING_new();
186 if (params
== NULL
) {
187 ERR_raise(ERR_LIB_DH
, ERR_R_ASN1_LIB
);
191 params
->length
= i2d_dhp(pkey
, pkey
->pkey
.dh
, ¶ms
->data
);
192 if (params
->length
<= 0) {
193 ERR_raise(ERR_LIB_DH
, ERR_R_ASN1_LIB
);
196 params
->type
= V_ASN1_SEQUENCE
;
198 /* Get private key into integer */
199 prkey
= BN_to_ASN1_INTEGER(pkey
->pkey
.dh
->priv_key
, NULL
);
202 ERR_raise(ERR_LIB_DH
, DH_R_BN_ERROR
);
206 dplen
= i2d_ASN1_INTEGER(prkey
, &dp
);
208 ASN1_STRING_clear_free(prkey
);
211 ERR_raise(ERR_LIB_DH
, DH_R_BN_ERROR
);
215 if (!PKCS8_pkey_set0(p8
, OBJ_nid2obj(pkey
->ameth
->pkey_id
), 0,
216 V_ASN1_SEQUENCE
, params
, dp
, dplen
)) {
217 OPENSSL_clear_free(dp
, dplen
);
223 ASN1_STRING_free(params
);
227 static int dh_param_decode(EVP_PKEY
*pkey
,
228 const unsigned char **pder
, int derlen
)
232 if ((dh
= d2i_dhp(pkey
, pder
, derlen
)) == NULL
)
235 EVP_PKEY_assign(pkey
, pkey
->ameth
->pkey_id
, dh
);
239 static int dh_param_encode(const EVP_PKEY
*pkey
, unsigned char **pder
)
241 return i2d_dhp(pkey
, pkey
->pkey
.dh
, pder
);
244 static int do_dh_print(BIO
*bp
, const DH
*x
, int indent
, int ptype
)
246 int reason
= ERR_R_BUF_LIB
;
247 const char *ktype
= NULL
;
248 BIGNUM
*priv_key
, *pub_key
;
251 priv_key
= x
->priv_key
;
256 pub_key
= x
->pub_key
;
260 if (x
->params
.p
== NULL
|| (ptype
== 2 && priv_key
== NULL
)
261 || (ptype
> 0 && pub_key
== NULL
)) {
262 reason
= ERR_R_PASSED_NULL_PARAMETER
;
267 ktype
= "DH Private-Key";
269 ktype
= "DH Public-Key";
271 ktype
= "DH Parameters";
273 if (!BIO_indent(bp
, indent
, 128)
274 || BIO_printf(bp
, "%s: (%d bit)\n", ktype
, DH_bits(x
)) <= 0)
278 if (!ASN1_bn_print(bp
, "private-key:", priv_key
, NULL
, indent
))
280 if (!ASN1_bn_print(bp
, "public-key:", pub_key
, NULL
, indent
))
283 if (!ossl_ffc_params_print(bp
, &x
->params
, indent
))
286 if (x
->length
!= 0) {
287 if (!BIO_indent(bp
, indent
, 128)
288 || BIO_printf(bp
, "recommended-private-length: %d bits\n",
289 (int)x
->length
) <= 0)
296 ERR_raise(ERR_LIB_DH
, reason
);
300 static int int_dh_size(const EVP_PKEY
*pkey
)
302 return DH_size(pkey
->pkey
.dh
);
305 static int dh_bits(const EVP_PKEY
*pkey
)
307 return DH_bits(pkey
->pkey
.dh
);
310 static int dh_security_bits(const EVP_PKEY
*pkey
)
312 return DH_security_bits(pkey
->pkey
.dh
);
315 static int dh_cmp_parameters(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
317 return ossl_ffc_params_cmp(&a
->pkey
.dh
->params
, &b
->pkey
.dh
->params
,
318 a
->ameth
!= &ossl_dhx_asn1_meth
);
321 static int int_dh_param_copy(DH
*to
, const DH
*from
, int is_x942
)
324 is_x942
= (from
->params
.q
!= NULL
);
325 if (!ossl_ffc_params_copy(&to
->params
, &from
->params
))
328 to
->length
= from
->length
;
333 DH
*DHparams_dup(const DH
*dh
)
339 if (!int_dh_param_copy(ret
, dh
, -1)) {
346 static int dh_copy_parameters(EVP_PKEY
*to
, const EVP_PKEY
*from
)
348 if (to
->pkey
.dh
== NULL
) {
349 to
->pkey
.dh
= DH_new();
350 if (to
->pkey
.dh
== NULL
)
353 return int_dh_param_copy(to
->pkey
.dh
, from
->pkey
.dh
,
354 from
->ameth
== &ossl_dhx_asn1_meth
);
357 static int dh_missing_parameters(const EVP_PKEY
*a
)
359 return a
->pkey
.dh
== NULL
360 || a
->pkey
.dh
->params
.p
== NULL
361 || a
->pkey
.dh
->params
.g
== NULL
;
364 static int dh_pub_cmp(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
366 if (dh_cmp_parameters(a
, b
) == 0)
368 if (BN_cmp(b
->pkey
.dh
->pub_key
, a
->pkey
.dh
->pub_key
) != 0)
374 static int dh_param_print(BIO
*bp
, const EVP_PKEY
*pkey
, int indent
,
377 return do_dh_print(bp
, pkey
->pkey
.dh
, indent
, 0);
380 static int dh_public_print(BIO
*bp
, const EVP_PKEY
*pkey
, int indent
,
383 return do_dh_print(bp
, pkey
->pkey
.dh
, indent
, 1);
386 static int dh_private_print(BIO
*bp
, const EVP_PKEY
*pkey
, int indent
,
389 return do_dh_print(bp
, pkey
->pkey
.dh
, indent
, 2);
392 int DHparams_print(BIO
*bp
, const DH
*x
)
394 return do_dh_print(bp
, x
, 4, 0);
397 static int dh_pkey_ctrl(EVP_PKEY
*pkey
, int op
, long arg1
, void *arg2
)
401 case ASN1_PKEY_CTRL_SET1_TLS_ENCPT
:
402 /* We should only be here if we have a legacy key */
403 if (!ossl_assert(evp_pkey_is_legacy(pkey
)))
405 dh
= (DH
*) evp_pkey_get0_DH_int(pkey
);
408 return ossl_dh_buf2key(dh
, arg2
, arg1
);
409 case ASN1_PKEY_CTRL_GET1_TLS_ENCPT
:
410 dh
= (DH
*) EVP_PKEY_get0_DH(pkey
);
413 return ossl_dh_key2buf(dh
, arg2
, 0, 1);
419 static int dhx_pkey_ctrl(EVP_PKEY
*pkey
, int op
, long arg1
, void *arg2
)
428 static int dh_pkey_public_check(const EVP_PKEY
*pkey
)
430 DH
*dh
= pkey
->pkey
.dh
;
432 if (dh
->pub_key
== NULL
) {
433 ERR_raise(ERR_LIB_DH
, DH_R_MISSING_PUBKEY
);
437 return DH_check_pub_key_ex(dh
, dh
->pub_key
);
440 static int dh_pkey_param_check(const EVP_PKEY
*pkey
)
442 DH
*dh
= pkey
->pkey
.dh
;
444 return DH_check_ex(dh
);
447 static size_t dh_pkey_dirty_cnt(const EVP_PKEY
*pkey
)
449 return pkey
->pkey
.dh
->dirty_cnt
;
452 static int dh_pkey_export_to(const EVP_PKEY
*from
, void *to_keydata
,
453 OSSL_FUNC_keymgmt_import_fn
*importer
,
454 OSSL_LIB_CTX
*libctx
, const char *propq
)
456 DH
*dh
= from
->pkey
.dh
;
457 OSSL_PARAM_BLD
*tmpl
;
458 const BIGNUM
*p
= DH_get0_p(dh
), *g
= DH_get0_g(dh
), *q
= DH_get0_q(dh
);
459 long l
= DH_get_length(dh
);
460 const BIGNUM
*pub_key
= DH_get0_pub_key(dh
);
461 const BIGNUM
*priv_key
= DH_get0_priv_key(dh
);
462 OSSL_PARAM
*params
= NULL
;
466 if (p
== NULL
|| g
== NULL
)
469 tmpl
= OSSL_PARAM_BLD_new();
472 if (!OSSL_PARAM_BLD_push_BN(tmpl
, OSSL_PKEY_PARAM_FFC_P
, p
)
473 || !OSSL_PARAM_BLD_push_BN(tmpl
, OSSL_PKEY_PARAM_FFC_G
, g
))
476 if (!OSSL_PARAM_BLD_push_BN(tmpl
, OSSL_PKEY_PARAM_FFC_Q
, q
))
479 selection
|= OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
;
481 if (!OSSL_PARAM_BLD_push_long(tmpl
, OSSL_PKEY_PARAM_DH_PRIV_LEN
, l
))
483 selection
|= OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS
;
485 if (pub_key
!= NULL
) {
486 if (!OSSL_PARAM_BLD_push_BN(tmpl
, OSSL_PKEY_PARAM_PUB_KEY
, pub_key
))
488 selection
|= OSSL_KEYMGMT_SELECT_PUBLIC_KEY
;
490 if (priv_key
!= NULL
) {
491 if (!OSSL_PARAM_BLD_push_BN(tmpl
, OSSL_PKEY_PARAM_PRIV_KEY
,
494 selection
|= OSSL_KEYMGMT_SELECT_PRIVATE_KEY
;
497 if ((params
= OSSL_PARAM_BLD_to_param(tmpl
)) == NULL
)
500 /* We export, the provider imports */
501 rv
= importer(to_keydata
, selection
, params
);
503 OSSL_PARAM_free(params
);
505 OSSL_PARAM_BLD_free(tmpl
);
509 static int dh_pkey_import_from_type(const OSSL_PARAM params
[], void *vpctx
,
512 EVP_PKEY_CTX
*pctx
= vpctx
;
513 EVP_PKEY
*pkey
= EVP_PKEY_CTX_get0_pkey(pctx
);
514 DH
*dh
= ossl_dh_new_ex(pctx
->libctx
);
517 ERR_raise(ERR_LIB_DH
, ERR_R_DH_LIB
);
520 DH_clear_flags(dh
, DH_FLAG_TYPE_MASK
);
521 DH_set_flags(dh
, type
== EVP_PKEY_DH
? DH_FLAG_TYPE_DH
: DH_FLAG_TYPE_DHX
);
523 if (!ossl_dh_params_fromdata(dh
, params
)
524 || !ossl_dh_key_fromdata(dh
, params
, 1)
525 || !EVP_PKEY_assign(pkey
, type
, dh
)) {
532 static int dh_pkey_import_from(const OSSL_PARAM params
[], void *vpctx
)
534 return dh_pkey_import_from_type(params
, vpctx
, EVP_PKEY_DH
);
537 static int dhx_pkey_import_from(const OSSL_PARAM params
[], void *vpctx
)
539 return dh_pkey_import_from_type(params
, vpctx
, EVP_PKEY_DHX
);
542 static int dh_pkey_copy(EVP_PKEY
*to
, EVP_PKEY
*from
)
544 DH
*dh
= from
->pkey
.dh
;
549 dupkey
= ossl_dh_dup(dh
, OSSL_KEYMGMT_SELECT_ALL
);
554 ret
= EVP_PKEY_assign(to
, from
->type
, dupkey
);
560 const EVP_PKEY_ASN1_METHOD ossl_dh_asn1_meth
= {
566 "OpenSSL PKCS#3 DH method",
583 dh_missing_parameters
,
595 dh_pkey_public_check
,
606 const EVP_PKEY_ASN1_METHOD ossl_dhx_asn1_meth
= {
612 "OpenSSL X9.42 DH method",
629 dh_missing_parameters
,
641 dh_pkey_public_check
,
646 dhx_pkey_import_from
,