2 * Copyright 1995-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 * DSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
18 #include "internal/cryptlib.h"
19 #include "internal/refcount.h"
20 #include "internal/namemap.h"
21 #include <openssl/bn.h>
22 #include <openssl/err.h>
23 #include <openssl/objects.h>
24 #include <openssl/evp.h>
25 #include <openssl/rsa.h>
26 #include <openssl/dsa.h>
27 #include <openssl/dh.h>
28 #include <openssl/ec.h>
29 #include <openssl/cmac.h>
31 # include <openssl/engine.h>
33 #include <openssl/params.h>
34 #include <openssl/param_build.h>
35 #include <openssl/encoder.h>
36 #include <openssl/core_names.h>
38 #include "internal/numbers.h" /* includes SIZE_MAX */
39 #include "internal/ffc.h"
40 #include "crypto/evp.h"
41 #include "crypto/dh.h"
42 #include "crypto/dsa.h"
43 #include "crypto/ec.h"
44 #include "crypto/ecx.h"
45 #include "crypto/rsa.h"
47 # include "crypto/asn1.h"
48 # include "crypto/x509.h"
50 #include "internal/provider.h"
51 #include "evp_local.h"
53 static int pkey_set_type(EVP_PKEY
*pkey
, ENGINE
*e
, int type
, const char *str
,
54 int len
, EVP_KEYMGMT
*keymgmt
);
55 static void evp_pkey_free_it(EVP_PKEY
*key
);
59 /* The type of parameters selected in key parameter functions */
60 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
62 int EVP_PKEY_get_bits(const EVP_PKEY
*pkey
)
67 size
= pkey
->cache
.bits
;
68 if (pkey
->ameth
!= NULL
&& pkey
->ameth
->pkey_bits
!= NULL
)
69 size
= pkey
->ameth
->pkey_bits(pkey
);
71 return size
< 0 ? 0 : size
;
74 int EVP_PKEY_get_security_bits(const EVP_PKEY
*pkey
)
79 size
= pkey
->cache
.security_bits
;
80 if (pkey
->ameth
!= NULL
&& pkey
->ameth
->pkey_security_bits
!= NULL
)
81 size
= pkey
->ameth
->pkey_security_bits(pkey
);
83 return size
< 0 ? 0 : size
;
86 int EVP_PKEY_save_parameters(EVP_PKEY
*pkey
, int mode
)
88 # ifndef OPENSSL_NO_DSA
89 if (pkey
->type
== EVP_PKEY_DSA
) {
90 int ret
= pkey
->save_parameters
;
93 pkey
->save_parameters
= mode
;
97 # ifndef OPENSSL_NO_EC
98 if (pkey
->type
== EVP_PKEY_EC
) {
99 int ret
= pkey
->save_parameters
;
102 pkey
->save_parameters
= mode
;
109 int EVP_PKEY_set_ex_data(EVP_PKEY
*key
, int idx
, void *arg
)
111 return CRYPTO_set_ex_data(&key
->ex_data
, idx
, arg
);
114 void *EVP_PKEY_get_ex_data(const EVP_PKEY
*key
, int idx
)
116 return CRYPTO_get_ex_data(&key
->ex_data
, idx
);
119 int EVP_PKEY_copy_parameters(EVP_PKEY
*to
, const EVP_PKEY
*from
)
122 * Clean up legacy stuff from this function when legacy support is gone.
125 EVP_PKEY
*downgraded_from
= NULL
;
129 * If |to| is a legacy key and |from| isn't, we must make a downgraded
130 * copy of |from|. If that fails, this function fails.
132 if (evp_pkey_is_legacy(to
) && evp_pkey_is_provided(from
)) {
133 if (!evp_pkey_copy_downgraded(&downgraded_from
, from
))
135 from
= downgraded_from
;
139 * Make sure |to| is typed. Content is less important at this early
142 * 1. If |to| is untyped, assign |from|'s key type to it.
143 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
144 * (|from| was already downgraded above)
146 * If |to| is a provided key, there's nothing more to do here, functions
147 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
148 * further down help us find out if they are the same or not.
150 if (evp_pkey_is_blank(to
)) {
151 if (evp_pkey_is_legacy(from
)) {
152 if (EVP_PKEY_set_type(to
, from
->type
) == 0)
155 if (EVP_PKEY_set_type_by_keymgmt(to
, from
->keymgmt
) == 0)
158 } else if (evp_pkey_is_legacy(to
)) {
159 if (to
->type
!= from
->type
) {
160 ERR_raise(ERR_LIB_EVP
, EVP_R_DIFFERENT_KEY_TYPES
);
165 if (EVP_PKEY_missing_parameters(from
)) {
166 ERR_raise(ERR_LIB_EVP
, EVP_R_MISSING_PARAMETERS
);
170 if (!EVP_PKEY_missing_parameters(to
)) {
171 if (EVP_PKEY_parameters_eq(to
, from
) == 1)
174 ERR_raise(ERR_LIB_EVP
, EVP_R_DIFFERENT_PARAMETERS
);
178 /* For purely provided keys, we just call the keymgmt utility */
179 if (to
->keymgmt
!= NULL
&& from
->keymgmt
!= NULL
) {
180 ok
= evp_keymgmt_util_copy(to
, (EVP_PKEY
*)from
, SELECT_PARAMETERS
);
185 * If |to| is provided, we know that |from| is legacy at this point.
186 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_dup()
187 * to copy the appropriate data to |to|'s keydata.
188 * We cannot override existing data so do it only if there is no keydata
191 if (to
->keymgmt
!= NULL
&& to
->keydata
== NULL
) {
192 EVP_KEYMGMT
*to_keymgmt
= to
->keymgmt
;
194 evp_pkey_export_to_provider((EVP_PKEY
*)from
, NULL
, &to_keymgmt
,
198 * If we get a NULL, it could be an internal error, or it could be
199 * that there's a key mismatch. We're pretending the latter...
201 if (from_keydata
== NULL
)
202 ERR_raise(ERR_LIB_EVP
, EVP_R_DIFFERENT_KEY_TYPES
);
204 ok
= (to
->keydata
= evp_keymgmt_dup(to
->keymgmt
,
206 SELECT_PARAMETERS
)) != NULL
;
210 /* Both keys are legacy */
211 if (from
->ameth
!= NULL
&& from
->ameth
->param_copy
!= NULL
)
212 ok
= from
->ameth
->param_copy(to
, from
);
214 EVP_PKEY_free(downgraded_from
);
218 int EVP_PKEY_missing_parameters(const EVP_PKEY
*pkey
)
221 if (pkey
->keymgmt
!= NULL
)
222 return !evp_keymgmt_util_has((EVP_PKEY
*)pkey
, SELECT_PARAMETERS
);
223 else if (pkey
->ameth
!= NULL
&& pkey
->ameth
->param_missing
!= NULL
)
224 return pkey
->ameth
->param_missing(pkey
);
230 * This function is called for any mixture of keys except pure legacy pair.
231 * When legacy keys are gone, we replace a call to this functions with
232 * a call to evp_keymgmt_util_match().
234 static int evp_pkey_cmp_any(const EVP_PKEY
*a
, const EVP_PKEY
*b
,
237 EVP_KEYMGMT
*keymgmt1
= NULL
, *keymgmt2
= NULL
;
238 void *keydata1
= NULL
, *keydata2
= NULL
, *tmp_keydata
= NULL
;
240 /* If none of them are provided, this function shouldn't have been called */
241 if (!ossl_assert(evp_pkey_is_provided(a
) || evp_pkey_is_provided(b
)))
244 /* For purely provided keys, we just call the keymgmt utility */
245 if (evp_pkey_is_provided(a
) && evp_pkey_is_provided(b
))
246 return evp_keymgmt_util_match((EVP_PKEY
*)a
, (EVP_PKEY
*)b
, selection
);
249 * At this point, one of them is provided, the other not. This allows
250 * us to compare types using legacy NIDs.
252 if (evp_pkey_is_legacy(a
)
253 && !EVP_KEYMGMT_is_a(b
->keymgmt
, OBJ_nid2sn(a
->type
)))
254 return -1; /* not the same key type */
255 if (evp_pkey_is_legacy(b
)
256 && !EVP_KEYMGMT_is_a(a
->keymgmt
, OBJ_nid2sn(b
->type
)))
257 return -1; /* not the same key type */
260 * We've determined that they both are the same keytype, so the next
261 * step is to do a bit of cross export to ensure we have keydata for
262 * both keys in the same keymgmt.
264 keymgmt1
= a
->keymgmt
;
265 keydata1
= a
->keydata
;
266 keymgmt2
= b
->keymgmt
;
267 keydata2
= b
->keydata
;
269 if (keymgmt2
!= NULL
&& keymgmt2
->match
!= NULL
) {
271 evp_pkey_export_to_provider((EVP_PKEY
*)a
, NULL
, &keymgmt2
, NULL
);
272 if (tmp_keydata
!= NULL
) {
274 keydata1
= tmp_keydata
;
277 if (tmp_keydata
== NULL
&& keymgmt1
!= NULL
&& keymgmt1
->match
!= NULL
) {
279 evp_pkey_export_to_provider((EVP_PKEY
*)b
, NULL
, &keymgmt1
, NULL
);
280 if (tmp_keydata
!= NULL
) {
282 keydata2
= tmp_keydata
;
286 /* If we still don't have matching keymgmt implementations, we give up */
287 if (keymgmt1
!= keymgmt2
)
290 /* If the keymgmt implementations are NULL, the export failed */
291 if (keymgmt1
== NULL
)
294 return evp_keymgmt_match(keymgmt1
, keydata1
, keydata2
, selection
);
297 # ifndef OPENSSL_NO_DEPRECATED_3_0
298 int EVP_PKEY_cmp_parameters(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
300 return EVP_PKEY_parameters_eq(a
, b
);
304 int EVP_PKEY_parameters_eq(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
307 * This will just call evp_keymgmt_util_match when legacy support
311 if (a
->keymgmt
!= NULL
|| b
->keymgmt
!= NULL
)
312 return evp_pkey_cmp_any(a
, b
, SELECT_PARAMETERS
);
314 /* All legacy keys */
315 if (a
->type
!= b
->type
)
317 if (a
->ameth
!= NULL
&& a
->ameth
->param_cmp
!= NULL
)
318 return a
->ameth
->param_cmp(a
, b
);
322 # ifndef OPENSSL_NO_DEPRECATED_3_0
323 int EVP_PKEY_cmp(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
325 return EVP_PKEY_eq(a
, b
);
329 int EVP_PKEY_eq(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
332 * This will just call evp_keymgmt_util_match when legacy support
336 /* Trivial shortcuts */
339 if (a
== NULL
|| b
== NULL
)
342 if (a
->keymgmt
!= NULL
|| b
->keymgmt
!= NULL
) {
343 int selection
= SELECT_PARAMETERS
;
345 if (evp_keymgmt_util_has((EVP_PKEY
*)a
, OSSL_KEYMGMT_SELECT_PUBLIC_KEY
)
346 && evp_keymgmt_util_has((EVP_PKEY
*)b
, OSSL_KEYMGMT_SELECT_PUBLIC_KEY
))
347 selection
|= OSSL_KEYMGMT_SELECT_PUBLIC_KEY
;
349 selection
|= OSSL_KEYMGMT_SELECT_KEYPAIR
;
350 return evp_pkey_cmp_any(a
, b
, selection
);
353 /* All legacy keys */
354 if (a
->type
!= b
->type
)
357 if (a
->ameth
!= NULL
) {
359 /* Compare parameters if the algorithm has them */
360 if (a
->ameth
->param_cmp
!= NULL
) {
361 ret
= a
->ameth
->param_cmp(a
, b
);
366 if (a
->ameth
->pub_cmp
!= NULL
)
367 return a
->ameth
->pub_cmp(a
, b
);
374 static EVP_PKEY
*new_raw_key_int(OSSL_LIB_CTX
*libctx
,
379 const unsigned char *key
,
383 EVP_PKEY
*pkey
= NULL
;
384 EVP_PKEY_CTX
*ctx
= NULL
;
385 const EVP_PKEY_ASN1_METHOD
*ameth
= NULL
;
388 # ifndef OPENSSL_NO_ENGINE
389 /* Check if there is an Engine for this type */
394 ameth
= EVP_PKEY_asn1_find_str(&tmpe
, strtype
, -1);
395 else if (nidtype
!= EVP_PKEY_NONE
)
396 ameth
= EVP_PKEY_asn1_find(&tmpe
, nidtype
);
398 /* If tmpe is NULL then no engine is claiming to support this type */
406 if (e
== NULL
&& ameth
== NULL
) {
408 * No engine is claiming to support this type, so lets see if we have
411 ctx
= EVP_PKEY_CTX_new_from_name(libctx
,
412 strtype
!= NULL
? strtype
413 : OBJ_nid2sn(nidtype
),
417 /* May fail if no provider available */
419 if (EVP_PKEY_fromdata_init(ctx
) == 1) {
420 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
422 ERR_clear_last_mark();
423 params
[0] = OSSL_PARAM_construct_octet_string(
424 key_is_priv
? OSSL_PKEY_PARAM_PRIV_KEY
425 : OSSL_PKEY_PARAM_PUB_KEY
,
428 if (EVP_PKEY_fromdata(ctx
, &pkey
, EVP_PKEY_KEYPAIR
, params
) != 1) {
429 ERR_raise(ERR_LIB_EVP
, EVP_R_KEY_SETUP_FAILED
);
433 EVP_PKEY_CTX_free(ctx
);
438 /* else not supported so fallback to legacy */
441 /* Legacy code path */
443 pkey
= EVP_PKEY_new();
445 ERR_raise(ERR_LIB_EVP
, ERR_R_EVP_LIB
);
449 if (!pkey_set_type(pkey
, e
, nidtype
, strtype
, -1, NULL
)) {
450 /* ERR_raise(ERR_LIB_EVP, ...) already called */
454 if (!ossl_assert(pkey
->ameth
!= NULL
))
458 if (pkey
->ameth
->set_priv_key
== NULL
) {
459 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
463 if (!pkey
->ameth
->set_priv_key(pkey
, key
, len
)) {
464 ERR_raise(ERR_LIB_EVP
, EVP_R_KEY_SETUP_FAILED
);
468 if (pkey
->ameth
->set_pub_key
== NULL
) {
469 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
473 if (!pkey
->ameth
->set_pub_key(pkey
, key
, len
)) {
474 ERR_raise(ERR_LIB_EVP
, EVP_R_KEY_SETUP_FAILED
);
485 EVP_PKEY_CTX_free(ctx
);
489 EVP_PKEY
*EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX
*libctx
,
492 const unsigned char *priv
, size_t len
)
494 return new_raw_key_int(libctx
, keytype
, propq
, EVP_PKEY_NONE
, NULL
, priv
,
498 EVP_PKEY
*EVP_PKEY_new_raw_private_key(int type
, ENGINE
*e
,
499 const unsigned char *priv
,
502 return new_raw_key_int(NULL
, NULL
, NULL
, type
, e
, priv
, len
, 1);
505 EVP_PKEY
*EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX
*libctx
,
506 const char *keytype
, const char *propq
,
507 const unsigned char *pub
, size_t len
)
509 return new_raw_key_int(libctx
, keytype
, propq
, EVP_PKEY_NONE
, NULL
, pub
,
513 EVP_PKEY
*EVP_PKEY_new_raw_public_key(int type
, ENGINE
*e
,
514 const unsigned char *pub
,
517 return new_raw_key_int(NULL
, NULL
, NULL
, type
, e
, pub
, len
, 0);
520 struct raw_key_details_st
527 static OSSL_CALLBACK get_raw_key_details
;
528 static int get_raw_key_details(const OSSL_PARAM params
[], void *arg
)
530 const OSSL_PARAM
*p
= NULL
;
531 struct raw_key_details_st
*raw_key
= arg
;
533 if (raw_key
->selection
== OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) {
534 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PRIV_KEY
))
536 return OSSL_PARAM_get_octet_string(p
, (void **)raw_key
->key
,
537 raw_key
->key
== NULL
? 0 : *raw_key
->len
,
539 } else if (raw_key
->selection
== OSSL_KEYMGMT_SELECT_PUBLIC_KEY
) {
540 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PUB_KEY
))
542 return OSSL_PARAM_get_octet_string(p
, (void **)raw_key
->key
,
543 raw_key
->key
== NULL
? 0 : *raw_key
->len
,
550 int EVP_PKEY_get_raw_private_key(const EVP_PKEY
*pkey
, unsigned char *priv
,
553 if (pkey
->keymgmt
!= NULL
) {
554 struct raw_key_details_st raw_key
;
556 raw_key
.key
= priv
== NULL
? NULL
: &priv
;
558 raw_key
.selection
= OSSL_KEYMGMT_SELECT_PRIVATE_KEY
;
560 return evp_keymgmt_util_export(pkey
, OSSL_KEYMGMT_SELECT_PRIVATE_KEY
,
561 get_raw_key_details
, &raw_key
);
564 if (pkey
->ameth
== NULL
) {
565 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
569 if (pkey
->ameth
->get_priv_key
== NULL
) {
570 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
574 if (!pkey
->ameth
->get_priv_key(pkey
, priv
, len
)) {
575 ERR_raise(ERR_LIB_EVP
, EVP_R_GET_RAW_KEY_FAILED
);
582 int EVP_PKEY_get_raw_public_key(const EVP_PKEY
*pkey
, unsigned char *pub
,
585 if (pkey
->keymgmt
!= NULL
) {
586 struct raw_key_details_st raw_key
;
588 raw_key
.key
= pub
== NULL
? NULL
: &pub
;
590 raw_key
.selection
= OSSL_KEYMGMT_SELECT_PUBLIC_KEY
;
592 return evp_keymgmt_util_export(pkey
, OSSL_KEYMGMT_SELECT_PUBLIC_KEY
,
593 get_raw_key_details
, &raw_key
);
596 if (pkey
->ameth
== NULL
) {
597 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
601 if (pkey
->ameth
->get_pub_key
== NULL
) {
602 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
606 if (!pkey
->ameth
->get_pub_key(pkey
, pub
, len
)) {
607 ERR_raise(ERR_LIB_EVP
, EVP_R_GET_RAW_KEY_FAILED
);
614 static EVP_PKEY
*new_cmac_key_int(const unsigned char *priv
, size_t len
,
615 const char *cipher_name
,
616 const EVP_CIPHER
*cipher
,
617 OSSL_LIB_CTX
*libctx
,
618 const char *propq
, ENGINE
*e
)
620 # ifndef OPENSSL_NO_CMAC
621 # ifndef OPENSSL_NO_ENGINE
622 const char *engine_id
= e
!= NULL
? ENGINE_get_id(e
) : NULL
;
624 OSSL_PARAM params
[5], *p
= params
;
625 EVP_PKEY
*pkey
= NULL
;
629 cipher_name
= EVP_CIPHER_get0_name(cipher
);
631 if (cipher_name
== NULL
) {
632 ERR_raise(ERR_LIB_EVP
, EVP_R_KEY_SETUP_FAILED
);
636 ctx
= EVP_PKEY_CTX_new_from_name(libctx
, "CMAC", propq
);
640 if (EVP_PKEY_fromdata_init(ctx
) <= 0) {
641 ERR_raise(ERR_LIB_EVP
, EVP_R_KEY_SETUP_FAILED
);
645 *p
++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
,
647 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER
,
648 (char *)cipher_name
, 0);
650 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES
,
652 # ifndef OPENSSL_NO_ENGINE
653 if (engine_id
!= NULL
)
654 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE
,
655 (char *)engine_id
, 0);
657 *p
= OSSL_PARAM_construct_end();
659 if (EVP_PKEY_fromdata(ctx
, &pkey
, EVP_PKEY_KEYPAIR
, params
) <= 0) {
660 ERR_raise(ERR_LIB_EVP
, EVP_R_KEY_SETUP_FAILED
);
665 EVP_PKEY_CTX_free(ctx
);
669 ERR_raise(ERR_LIB_EVP
, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
674 EVP_PKEY
*EVP_PKEY_new_CMAC_key(ENGINE
*e
, const unsigned char *priv
,
675 size_t len
, const EVP_CIPHER
*cipher
)
677 return new_cmac_key_int(priv
, len
, NULL
, cipher
, NULL
, NULL
, e
);
680 int EVP_PKEY_set_type(EVP_PKEY
*pkey
, int type
)
682 return pkey_set_type(pkey
, NULL
, type
, NULL
, -1, NULL
);
685 int EVP_PKEY_set_type_str(EVP_PKEY
*pkey
, const char *str
, int len
)
687 return pkey_set_type(pkey
, NULL
, EVP_PKEY_NONE
, str
, len
, NULL
);
690 # ifndef OPENSSL_NO_ENGINE
691 int EVP_PKEY_set1_engine(EVP_PKEY
*pkey
, ENGINE
*e
)
694 if (!ENGINE_init(e
)) {
695 ERR_raise(ERR_LIB_EVP
, ERR_R_ENGINE_LIB
);
698 if (ENGINE_get_pkey_meth(e
, pkey
->type
) == NULL
) {
700 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_ALGORITHM
);
704 ENGINE_finish(pkey
->pmeth_engine
);
705 pkey
->pmeth_engine
= e
;
709 ENGINE
*EVP_PKEY_get0_engine(const EVP_PKEY
*pkey
)
715 # ifndef OPENSSL_NO_DEPRECATED_3_0
716 static void detect_foreign_key(EVP_PKEY
*pkey
)
718 switch (pkey
->type
) {
720 pkey
->foreign
= pkey
->pkey
.rsa
!= NULL
721 && ossl_rsa_is_foreign(pkey
->pkey
.rsa
);
723 # ifndef OPENSSL_NO_EC
727 pkey
->foreign
= pkey
->pkey
.ec
!= NULL
728 && ossl_ec_key_is_foreign(pkey
->pkey
.ec
);
731 # ifndef OPENSSL_NO_DSA
733 pkey
->foreign
= pkey
->pkey
.dsa
!= NULL
734 && ossl_dsa_is_foreign(pkey
->pkey
.dsa
);
737 # ifndef OPENSSL_NO_DH
739 pkey
->foreign
= pkey
->pkey
.dh
!= NULL
740 && ossl_dh_is_foreign(pkey
->pkey
.dh
);
749 int EVP_PKEY_assign(EVP_PKEY
*pkey
, int type
, void *key
)
751 # ifndef OPENSSL_NO_EC
754 pktype
= EVP_PKEY_type(type
);
755 if ((key
!= NULL
) && (pktype
== EVP_PKEY_EC
|| pktype
== EVP_PKEY_SM2
)) {
756 const EC_GROUP
*group
= EC_KEY_get0_group(key
);
759 int curve
= EC_GROUP_get_curve_name(group
);
762 * Regardless of what is requested the SM2 curve must be SM2 type,
763 * and non SM2 curves are EC type.
765 if (curve
== NID_sm2
&& pktype
== EVP_PKEY_EC
)
767 else if(curve
!= NID_sm2
&& pktype
== EVP_PKEY_SM2
)
773 if (pkey
== NULL
|| !EVP_PKEY_set_type(pkey
, type
))
776 pkey
->pkey
.ptr
= key
;
777 detect_foreign_key(pkey
);
779 return (key
!= NULL
);
783 void *EVP_PKEY_get0(const EVP_PKEY
*pkey
)
788 if (!evp_pkey_is_provided(pkey
))
789 return pkey
->pkey
.ptr
;
794 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY
*pkey
, size_t *len
)
796 const ASN1_OCTET_STRING
*os
= NULL
;
797 if (pkey
->type
!= EVP_PKEY_HMAC
) {
798 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_AN_HMAC_KEY
);
801 os
= evp_pkey_get_legacy((EVP_PKEY
*)pkey
);
809 # ifndef OPENSSL_NO_POLY1305
810 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY
*pkey
, size_t *len
)
812 const ASN1_OCTET_STRING
*os
= NULL
;
813 if (pkey
->type
!= EVP_PKEY_POLY1305
) {
814 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_A_POLY1305_KEY
);
817 os
= evp_pkey_get_legacy((EVP_PKEY
*)pkey
);
826 # ifndef OPENSSL_NO_SIPHASH
827 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY
*pkey
, size_t *len
)
829 const ASN1_OCTET_STRING
*os
= NULL
;
831 if (pkey
->type
!= EVP_PKEY_SIPHASH
) {
832 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_A_SIPHASH_KEY
);
835 os
= evp_pkey_get_legacy((EVP_PKEY
*)pkey
);
844 # ifndef OPENSSL_NO_DSA
845 static DSA
*evp_pkey_get0_DSA_int(const EVP_PKEY
*pkey
)
847 if (pkey
->type
!= EVP_PKEY_DSA
) {
848 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_A_DSA_KEY
);
851 return evp_pkey_get_legacy((EVP_PKEY
*)pkey
);
854 const DSA
*EVP_PKEY_get0_DSA(const EVP_PKEY
*pkey
)
856 return evp_pkey_get0_DSA_int(pkey
);
859 int EVP_PKEY_set1_DSA(EVP_PKEY
*pkey
, DSA
*key
)
861 int ret
= EVP_PKEY_assign_DSA(pkey
, key
);
866 DSA
*EVP_PKEY_get1_DSA(EVP_PKEY
*pkey
)
868 DSA
*ret
= evp_pkey_get0_DSA_int(pkey
);
874 # endif /* OPENSSL_NO_DSA */
876 # ifndef OPENSSL_NO_ECX
877 static const ECX_KEY
*evp_pkey_get0_ECX_KEY(const EVP_PKEY
*pkey
, int type
)
879 if (EVP_PKEY_get_base_id(pkey
) != type
) {
880 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_A_ECX_KEY
);
883 return evp_pkey_get_legacy((EVP_PKEY
*)pkey
);
886 static ECX_KEY
*evp_pkey_get1_ECX_KEY(EVP_PKEY
*pkey
, int type
)
888 ECX_KEY
*ret
= (ECX_KEY
*)evp_pkey_get0_ECX_KEY(pkey
, type
);
890 if (ret
!= NULL
&& !ossl_ecx_key_up_ref(ret
))
895 # define IMPLEMENT_ECX_VARIANT(NAME) \
896 ECX_KEY *ossl_evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
898 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
900 IMPLEMENT_ECX_VARIANT(X25519
)
901 IMPLEMENT_ECX_VARIANT(X448
)
902 IMPLEMENT_ECX_VARIANT(ED25519
)
903 IMPLEMENT_ECX_VARIANT(ED448
)
905 # endif /* OPENSSL_NO_ECX */
907 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
909 int EVP_PKEY_set1_DH(EVP_PKEY
*pkey
, DH
*dhkey
)
914 * ossl_dh_is_named_safe_prime_group() returns 1 for named safe prime groups
915 * related to ffdhe and modp (which cache q = (p - 1) / 2),
916 * and returns 0 for all other dh parameter generation types including
917 * RFC5114 named groups.
919 * The EVP_PKEY_DH type is used for dh parameter generation types:
920 * - named safe prime groups related to ffdhe and modp
921 * - safe prime generator
923 * The type EVP_PKEY_DHX is used for dh parameter generation types
924 * - fips186-4 and fips186-2
925 * - rfc5114 named groups.
927 * The EVP_PKEY_DH type is used to save PKCS#3 data than can be stored
929 * The EVP_PKEY_DHX type is used to save X9.42 data that requires the
930 * q value to be stored.
932 if (ossl_dh_is_named_safe_prime_group(dhkey
))
935 type
= DH_get0_q(dhkey
) == NULL
? EVP_PKEY_DH
: EVP_PKEY_DHX
;
937 ret
= EVP_PKEY_assign(pkey
, type
, dhkey
);
944 DH
*evp_pkey_get0_DH_int(const EVP_PKEY
*pkey
)
946 if (pkey
->type
!= EVP_PKEY_DH
&& pkey
->type
!= EVP_PKEY_DHX
) {
947 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_A_DH_KEY
);
950 return evp_pkey_get_legacy((EVP_PKEY
*)pkey
);
953 const DH
*EVP_PKEY_get0_DH(const EVP_PKEY
*pkey
)
955 return evp_pkey_get0_DH_int(pkey
);
958 DH
*EVP_PKEY_get1_DH(EVP_PKEY
*pkey
)
960 DH
*ret
= evp_pkey_get0_DH_int(pkey
);
968 int EVP_PKEY_type(int type
)
971 const EVP_PKEY_ASN1_METHOD
*ameth
;
973 ameth
= EVP_PKEY_asn1_find(&e
, type
);
975 ret
= ameth
->pkey_id
;
978 # ifndef OPENSSL_NO_ENGINE
984 int EVP_PKEY_get_id(const EVP_PKEY
*pkey
)
989 int EVP_PKEY_get_base_id(const EVP_PKEY
*pkey
)
991 return EVP_PKEY_type(pkey
->type
);
995 * These hard coded cases are pure hackery to get around the fact
996 * that names in crypto/objects/objects.txt are a mess. There is
997 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
998 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
999 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
1000 * "DSA" is accurate... but still, better be safe and hard-code
1001 * names that we know.
1002 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
1003 * EVP_PKEY_EC, because of aliasing.
1004 * This should be cleaned away along with all other #legacy support.
1006 static const OSSL_ITEM standard_name2type
[] = {
1007 { EVP_PKEY_RSA
, "RSA" },
1008 { EVP_PKEY_RSA_PSS
, "RSA-PSS" },
1009 { EVP_PKEY_EC
, "EC" },
1010 { EVP_PKEY_ED25519
, "ED25519" },
1011 { EVP_PKEY_ED448
, "ED448" },
1012 { EVP_PKEY_X25519
, "X25519" },
1013 { EVP_PKEY_X448
, "X448" },
1014 { EVP_PKEY_SM2
, "SM2" },
1015 { EVP_PKEY_DH
, "DH" },
1016 { EVP_PKEY_DHX
, "X9.42 DH" },
1017 { EVP_PKEY_DHX
, "DHX" },
1018 { EVP_PKEY_DSA
, "DSA" },
1021 int evp_pkey_name2type(const char *name
)
1026 for (i
= 0; i
< OSSL_NELEM(standard_name2type
); i
++) {
1027 if (OPENSSL_strcasecmp(name
, standard_name2type
[i
].ptr
) == 0)
1028 return (int)standard_name2type
[i
].id
;
1031 if ((type
= EVP_PKEY_type(OBJ_sn2nid(name
))) != NID_undef
)
1033 return EVP_PKEY_type(OBJ_ln2nid(name
));
1036 const char *evp_pkey_type2name(int type
)
1040 for (i
= 0; i
< OSSL_NELEM(standard_name2type
); i
++) {
1041 if (type
== (int)standard_name2type
[i
].id
)
1042 return standard_name2type
[i
].ptr
;
1045 return OBJ_nid2sn(type
);
1048 int EVP_PKEY_is_a(const EVP_PKEY
*pkey
, const char *name
)
1052 if (pkey
->keymgmt
== NULL
)
1053 return pkey
->type
== evp_pkey_name2type(name
);
1054 return EVP_KEYMGMT_is_a(pkey
->keymgmt
, name
);
1057 int EVP_PKEY_type_names_do_all(const EVP_PKEY
*pkey
,
1058 void (*fn
)(const char *name
, void *data
),
1061 if (!evp_pkey_is_typed(pkey
))
1064 if (!evp_pkey_is_provided(pkey
)) {
1065 const char *name
= OBJ_nid2sn(EVP_PKEY_get_id(pkey
));
1070 return EVP_KEYMGMT_names_do_all(pkey
->keymgmt
, fn
, data
);
1073 int EVP_PKEY_can_sign(const EVP_PKEY
*pkey
)
1075 if (pkey
->keymgmt
== NULL
) {
1076 switch (EVP_PKEY_get_base_id(pkey
)) {
1079 # ifndef OPENSSL_NO_DSA
1083 # ifndef OPENSSL_NO_EC
1084 case EVP_PKEY_ED25519
:
1085 case EVP_PKEY_ED448
:
1087 case EVP_PKEY_EC
: /* Including SM2 */
1088 return EC_KEY_can_sign(pkey
->pkey
.ec
);
1094 const OSSL_PROVIDER
*prov
= EVP_KEYMGMT_get0_provider(pkey
->keymgmt
);
1095 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(prov
);
1096 const char *supported_sig
=
1097 pkey
->keymgmt
->query_operation_name
!= NULL
1098 ? pkey
->keymgmt
->query_operation_name(OSSL_OP_SIGNATURE
)
1099 : EVP_KEYMGMT_get0_name(pkey
->keymgmt
);
1100 EVP_SIGNATURE
*signature
= NULL
;
1102 signature
= EVP_SIGNATURE_fetch(libctx
, supported_sig
, NULL
);
1103 if (signature
!= NULL
) {
1104 EVP_SIGNATURE_free(signature
);
1111 static int print_reset_indent(BIO
**out
, int pop_f_prefix
, long saved_indent
)
1113 BIO_set_indent(*out
, saved_indent
);
1115 BIO
*next
= BIO_pop(*out
);
1123 static int print_set_indent(BIO
**out
, int *pop_f_prefix
, long *saved_indent
,
1129 long i
= BIO_get_indent(*out
);
1131 *saved_indent
= (i
< 0 ? 0 : i
);
1132 if (BIO_set_indent(*out
, indent
) <= 0) {
1133 BIO
*prefbio
= BIO_new(BIO_f_prefix());
1135 if (prefbio
== NULL
)
1137 *out
= BIO_push(prefbio
, *out
);
1140 if (BIO_set_indent(*out
, indent
) <= 0) {
1141 print_reset_indent(out
, *pop_f_prefix
, *saved_indent
);
1148 static int unsup_alg(BIO
*out
, const EVP_PKEY
*pkey
, int indent
,
1151 return BIO_indent(out
, indent
, 128)
1152 && BIO_printf(out
, "%s algorithm \"%s\" unsupported\n",
1153 kstr
, OBJ_nid2ln(pkey
->type
)) > 0;
1156 static int print_pkey(const EVP_PKEY
*pkey
, BIO
*out
, int indent
,
1157 int selection
/* For provided encoding */,
1158 const char *propquery
/* For provided encoding */,
1159 int (*legacy_print
)(BIO
*out
, const EVP_PKEY
*pkey
,
1160 int indent
, ASN1_PCTX
*pctx
),
1161 ASN1_PCTX
*legacy_pctx
/* For legacy print */)
1165 OSSL_ENCODER_CTX
*ctx
= NULL
;
1166 int ret
= -2; /* default to unsupported */
1168 if (!print_set_indent(&out
, &pop_f_prefix
, &saved_indent
, indent
))
1171 ctx
= OSSL_ENCODER_CTX_new_for_pkey(pkey
, selection
, "TEXT", NULL
,
1173 if (OSSL_ENCODER_CTX_get_num_encoders(ctx
) != 0)
1174 ret
= OSSL_ENCODER_to_bio(ctx
, out
);
1175 OSSL_ENCODER_CTX_free(ctx
);
1180 /* legacy fallback */
1181 if (legacy_print
!= NULL
)
1182 ret
= legacy_print(out
, pkey
, 0, legacy_pctx
);
1184 ret
= unsup_alg(out
, pkey
, 0, "Public Key");
1187 print_reset_indent(&out
, pop_f_prefix
, saved_indent
);
1191 int EVP_PKEY_print_public(BIO
*out
, const EVP_PKEY
*pkey
,
1192 int indent
, ASN1_PCTX
*pctx
)
1194 return print_pkey(pkey
, out
, indent
, EVP_PKEY_PUBLIC_KEY
, NULL
,
1195 (pkey
->ameth
!= NULL
? pkey
->ameth
->pub_print
: NULL
),
1199 int EVP_PKEY_print_private(BIO
*out
, const EVP_PKEY
*pkey
,
1200 int indent
, ASN1_PCTX
*pctx
)
1202 return print_pkey(pkey
, out
, indent
, EVP_PKEY_KEYPAIR
, NULL
,
1203 (pkey
->ameth
!= NULL
? pkey
->ameth
->priv_print
: NULL
),
1207 int EVP_PKEY_print_params(BIO
*out
, const EVP_PKEY
*pkey
,
1208 int indent
, ASN1_PCTX
*pctx
)
1210 return print_pkey(pkey
, out
, indent
, EVP_PKEY_KEY_PARAMETERS
, NULL
,
1211 (pkey
->ameth
!= NULL
? pkey
->ameth
->param_print
: NULL
),
1215 # ifndef OPENSSL_NO_STDIO
1216 int EVP_PKEY_print_public_fp(FILE *fp
, const EVP_PKEY
*pkey
,
1217 int indent
, ASN1_PCTX
*pctx
)
1220 BIO
*b
= BIO_new_fp(fp
, BIO_NOCLOSE
);
1224 ret
= EVP_PKEY_print_public(b
, pkey
, indent
, pctx
);
1229 int EVP_PKEY_print_private_fp(FILE *fp
, const EVP_PKEY
*pkey
,
1230 int indent
, ASN1_PCTX
*pctx
)
1233 BIO
*b
= BIO_new_fp(fp
, BIO_NOCLOSE
);
1237 ret
= EVP_PKEY_print_private(b
, pkey
, indent
, pctx
);
1242 int EVP_PKEY_print_params_fp(FILE *fp
, const EVP_PKEY
*pkey
,
1243 int indent
, ASN1_PCTX
*pctx
)
1246 BIO
*b
= BIO_new_fp(fp
, BIO_NOCLOSE
);
1250 ret
= EVP_PKEY_print_params(b
, pkey
, indent
, pctx
);
1256 static void mdname2nid(const char *mdname
, void *data
)
1258 int *nid
= (int *)data
;
1260 if (*nid
!= NID_undef
)
1263 *nid
= OBJ_sn2nid(mdname
);
1264 if (*nid
== NID_undef
)
1265 *nid
= OBJ_ln2nid(mdname
);
1268 static int legacy_asn1_ctrl_to_param(EVP_PKEY
*pkey
, int op
,
1269 int arg1
, void *arg2
)
1271 if (pkey
->keymgmt
== NULL
)
1274 case ASN1_PKEY_CTRL_DEFAULT_MD_NID
:
1276 char mdname
[80] = "";
1277 int rv
= EVP_PKEY_get_default_digest_name(pkey
, mdname
,
1282 OSSL_LIB_CTX
*libctx
= ossl_provider_libctx(pkey
->keymgmt
->prov
);
1283 /* Make sure the MD is in the namemap if available */
1285 OSSL_NAMEMAP
*namemap
;
1286 int nid
= NID_undef
;
1288 (void)ERR_set_mark();
1289 md
= EVP_MD_fetch(libctx
, mdname
, NULL
);
1290 (void)ERR_pop_to_mark();
1291 namemap
= ossl_namemap_stored(libctx
);
1294 * The only reason to fetch the MD was to make sure it is in the
1295 * namemap. We can immediately free it.
1298 mdnum
= ossl_namemap_name2num(namemap
, mdname
);
1303 * We have the namemap number - now we need to find the
1306 if (!ossl_namemap_doall_names(namemap
, mdnum
, mdname2nid
, &nid
))
1317 static int evp_pkey_asn1_ctrl(EVP_PKEY
*pkey
, int op
, int arg1
, void *arg2
)
1319 if (pkey
->ameth
== NULL
)
1320 return legacy_asn1_ctrl_to_param(pkey
, op
, arg1
, arg2
);
1321 if (pkey
->ameth
->pkey_ctrl
== NULL
)
1323 return pkey
->ameth
->pkey_ctrl(pkey
, op
, arg1
, arg2
);
1326 int EVP_PKEY_get_default_digest_nid(EVP_PKEY
*pkey
, int *pnid
)
1330 return evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_DEFAULT_MD_NID
, 0, pnid
);
1333 int EVP_PKEY_get_default_digest_name(EVP_PKEY
*pkey
,
1334 char *mdname
, size_t mdname_sz
)
1336 if (pkey
->ameth
== NULL
)
1337 return evp_keymgmt_util_get_deflt_digest_name(pkey
->keymgmt
,
1342 int nid
= NID_undef
;
1343 int rv
= EVP_PKEY_get_default_digest_nid(pkey
, &nid
);
1344 const char *name
= rv
> 0 ? OBJ_nid2sn(nid
) : NULL
;
1347 OPENSSL_strlcpy(mdname
, name
, mdname_sz
);
1352 int EVP_PKEY_get_group_name(const EVP_PKEY
*pkey
, char *gname
, size_t gname_sz
,
1355 return EVP_PKEY_get_utf8_string_param(pkey
, OSSL_PKEY_PARAM_GROUP_NAME
,
1356 gname
, gname_sz
, gname_len
);
1359 int EVP_PKEY_digestsign_supports_digest(EVP_PKEY
*pkey
, OSSL_LIB_CTX
*libctx
,
1360 const char *name
, const char *propq
)
1363 EVP_MD_CTX
*ctx
= NULL
;
1365 if ((ctx
= EVP_MD_CTX_new()) == NULL
)
1369 rv
= EVP_DigestSignInit_ex(ctx
, NULL
, name
, libctx
,
1373 EVP_MD_CTX_free(ctx
);
1377 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY
*pkey
, const unsigned char *pub
,
1382 if (evp_pkey_is_provided(pkey
))
1384 EVP_PKEY_set_octet_string_param(pkey
,
1385 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY
,
1386 (unsigned char *)pub
, publen
);
1388 if (publen
> INT_MAX
)
1390 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1391 if (evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_SET1_TLS_ENCPT
, publen
,
1397 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY
*pkey
, unsigned char **ppub
)
1403 if (evp_pkey_is_provided(pkey
)) {
1404 size_t return_size
= OSSL_PARAM_UNMODIFIED
;
1408 * We know that this is going to fail, but it will give us a size
1411 EVP_PKEY_get_octet_string_param(pkey
,
1412 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY
,
1413 NULL
, 0, &return_size
);
1414 if (return_size
== OSSL_PARAM_UNMODIFIED
)
1418 buf
= OPENSSL_malloc(return_size
);
1422 if (!EVP_PKEY_get_octet_string_param(pkey
,
1423 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY
,
1424 buf
, return_size
, NULL
)) {
1433 rv
= evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_GET1_TLS_ENCPT
, 0, ppub
);
1439 #endif /* FIPS_MODULE */
1441 /*- All methods below can also be used in FIPS_MODULE */
1443 EVP_PKEY
*EVP_PKEY_new(void)
1445 EVP_PKEY
*ret
= OPENSSL_zalloc(sizeof(*ret
));
1450 ret
->type
= EVP_PKEY_NONE
;
1451 ret
->save_type
= EVP_PKEY_NONE
;
1453 if (!CRYPTO_NEW_REF(&ret
->references
, 1))
1456 ret
->lock
= CRYPTO_THREAD_lock_new();
1457 if (ret
->lock
== NULL
) {
1458 ERR_raise(ERR_LIB_EVP
, ERR_R_CRYPTO_LIB
);
1463 ret
->save_parameters
= 1;
1464 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY
, ret
, &ret
->ex_data
)) {
1465 ERR_raise(ERR_LIB_EVP
, ERR_R_CRYPTO_LIB
);
1472 CRYPTO_FREE_REF(&ret
->references
);
1473 CRYPTO_THREAD_lock_free(ret
->lock
);
1479 * Setup a public key management method.
1481 * For legacy keys, either |type| or |str| is expected to have the type
1482 * information. In this case, the setup consists of finding an ASN1 method
1483 * and potentially an ENGINE, and setting those fields in |pkey|.
1485 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1486 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1488 * If pkey is NULL just return 1 or 0 if the key management method exists.
1491 static int pkey_set_type(EVP_PKEY
*pkey
, ENGINE
*e
, int type
, const char *str
,
1492 int len
, EVP_KEYMGMT
*keymgmt
)
1495 const EVP_PKEY_ASN1_METHOD
*ameth
= NULL
;
1496 ENGINE
**eptr
= (e
== NULL
) ? &e
: NULL
;
1500 * The setups can't set both legacy and provider side methods.
1503 if (!ossl_assert(type
== EVP_PKEY_NONE
|| keymgmt
== NULL
)
1504 || !ossl_assert(e
== NULL
|| keymgmt
== NULL
)) {
1505 ERR_raise(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
);
1513 free_it
= free_it
|| pkey
->pkey
.ptr
!= NULL
;
1515 free_it
= free_it
|| pkey
->keydata
!= NULL
;
1517 evp_pkey_free_it(pkey
);
1520 * If key type matches and a method exists then this lookup has
1521 * succeeded once so just indicate success.
1523 if (pkey
->type
!= EVP_PKEY_NONE
1524 && type
== pkey
->save_type
1525 && pkey
->ameth
!= NULL
)
1527 # ifndef OPENSSL_NO_ENGINE
1528 /* If we have ENGINEs release them */
1529 ENGINE_finish(pkey
->engine
);
1530 pkey
->engine
= NULL
;
1531 ENGINE_finish(pkey
->pmeth_engine
);
1532 pkey
->pmeth_engine
= NULL
;
1538 ameth
= EVP_PKEY_asn1_find_str(eptr
, str
, len
);
1539 else if (type
!= EVP_PKEY_NONE
)
1540 ameth
= EVP_PKEY_asn1_find(eptr
, type
);
1541 # ifndef OPENSSL_NO_ENGINE
1542 if (pkey
== NULL
&& eptr
!= NULL
)
1552 check
= check
&& ameth
== NULL
;
1554 check
= check
&& keymgmt
== NULL
;
1556 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_ALGORITHM
);
1561 if (keymgmt
!= NULL
&& !EVP_KEYMGMT_up_ref(keymgmt
)) {
1562 ERR_raise(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
);
1566 pkey
->keymgmt
= keymgmt
;
1568 pkey
->save_type
= type
;
1573 * If the internal "origin" key is provider side, don't save |ameth|.
1574 * The main reason is that |ameth| is one factor to detect that the
1575 * internal "origin" key is a legacy one.
1577 if (keymgmt
== NULL
)
1578 pkey
->ameth
= ameth
;
1581 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1582 * for any key type that has a legacy implementation, regardless of
1583 * if the internal key is a legacy or a provider side one. When
1584 * there is no legacy implementation for the key, the type becomes
1585 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1586 * with functions that expect legacy internal keys.
1588 if (ameth
!= NULL
) {
1589 if (type
== EVP_PKEY_NONE
)
1590 pkey
->type
= ameth
->pkey_id
;
1592 pkey
->type
= EVP_PKEY_KEYMGMT
;
1594 # ifndef OPENSSL_NO_ENGINE
1595 if (eptr
== NULL
&& e
!= NULL
&& !ENGINE_init(e
)) {
1596 ERR_raise(ERR_LIB_EVP
, EVP_R_INITIALIZATION_ERROR
);
1607 static void find_ameth(const char *name
, void *data
)
1609 const char **str
= data
;
1612 * The error messages from pkey_set_type() are uninteresting here,
1617 if (pkey_set_type(NULL
, NULL
, EVP_PKEY_NONE
, name
, strlen(name
),
1621 else if (str
[1] == NULL
)
1629 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY
*pkey
, EVP_KEYMGMT
*keymgmt
)
1632 # define EVP_PKEY_TYPE_STR str[0]
1633 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1635 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1636 * Ideally, only one should be found. If two (or more) are found, the
1637 * match is ambiguous. This should never happen, but...
1639 const char *str
[2] = { NULL
, NULL
};
1641 if (!EVP_KEYMGMT_names_do_all(keymgmt
, find_ameth
, &str
)
1642 || str
[1] != NULL
) {
1643 ERR_raise(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
);
1647 # define EVP_PKEY_TYPE_STR NULL
1648 # define EVP_PKEY_TYPE_STRLEN -1
1650 return pkey_set_type(pkey
, NULL
, EVP_PKEY_NONE
,
1651 EVP_PKEY_TYPE_STR
, EVP_PKEY_TYPE_STRLEN
,
1654 #undef EVP_PKEY_TYPE_STR
1655 #undef EVP_PKEY_TYPE_STRLEN
1658 int EVP_PKEY_up_ref(EVP_PKEY
*pkey
)
1662 if (CRYPTO_UP_REF(&pkey
->references
, &i
) <= 0)
1665 REF_PRINT_COUNT("EVP_PKEY", pkey
);
1666 REF_ASSERT_ISNT(i
< 2);
1667 return ((i
> 1) ? 1 : 0);
1671 EVP_PKEY
*EVP_PKEY_dup(EVP_PKEY
*pkey
)
1676 ERR_raise(ERR_LIB_EVP
, ERR_R_PASSED_NULL_PARAMETER
);
1680 if ((dup_pk
= EVP_PKEY_new()) == NULL
)
1683 if (evp_pkey_is_blank(pkey
))
1686 if (evp_pkey_is_provided(pkey
)) {
1687 if (!evp_keymgmt_util_copy(dup_pk
, pkey
,
1688 OSSL_KEYMGMT_SELECT_ALL
))
1693 if (evp_pkey_is_legacy(pkey
)) {
1694 const EVP_PKEY_ASN1_METHOD
*ameth
= pkey
->ameth
;
1696 if (ameth
== NULL
|| ameth
->copy
== NULL
) {
1697 if (pkey
->pkey
.ptr
== NULL
/* empty key, just set type */
1698 && EVP_PKEY_set_type(dup_pk
, pkey
->type
) != 0)
1700 ERR_raise(ERR_LIB_EVP
, EVP_R_UNSUPPORTED_KEY_TYPE
);
1703 if (!ameth
->copy(dup_pk
, pkey
))
1710 /* copy auxiliary data */
1711 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EVP_PKEY
,
1712 &dup_pk
->ex_data
, &pkey
->ex_data
))
1715 if (pkey
->attributes
!= NULL
) {
1716 if ((dup_pk
->attributes
= ossl_x509at_dup(pkey
->attributes
)) == NULL
)
1721 EVP_PKEY_free(dup_pk
);
1725 void evp_pkey_free_legacy(EVP_PKEY
*x
)
1727 const EVP_PKEY_ASN1_METHOD
*ameth
= x
->ameth
;
1728 ENGINE
*tmpe
= NULL
;
1730 if (ameth
== NULL
&& x
->legacy_cache_pkey
.ptr
!= NULL
)
1731 ameth
= EVP_PKEY_asn1_find(&tmpe
, x
->type
);
1733 if (ameth
!= NULL
) {
1734 if (x
->legacy_cache_pkey
.ptr
!= NULL
) {
1736 * We should never have both a legacy origin key, and a key in the
1739 assert(x
->pkey
.ptr
== NULL
);
1741 * For the purposes of freeing we make the legacy cache look like
1742 * a legacy origin key.
1744 x
->pkey
= x
->legacy_cache_pkey
;
1745 x
->legacy_cache_pkey
.ptr
= NULL
;
1747 if (ameth
->pkey_free
!= NULL
)
1748 ameth
->pkey_free(x
);
1751 # ifndef OPENSSL_NO_ENGINE
1752 ENGINE_finish(tmpe
);
1753 ENGINE_finish(x
->engine
);
1755 ENGINE_finish(x
->pmeth_engine
);
1756 x
->pmeth_engine
= NULL
;
1759 #endif /* FIPS_MODULE */
1761 static void evp_pkey_free_it(EVP_PKEY
*x
)
1763 /* internal function; x is never NULL */
1764 evp_keymgmt_util_clear_operation_cache(x
);
1766 evp_pkey_free_legacy(x
);
1769 if (x
->keymgmt
!= NULL
) {
1770 evp_keymgmt_freedata(x
->keymgmt
, x
->keydata
);
1771 EVP_KEYMGMT_free(x
->keymgmt
);
1775 x
->type
= EVP_PKEY_NONE
;
1778 void EVP_PKEY_free(EVP_PKEY
*x
)
1785 CRYPTO_DOWN_REF(&x
->references
, &i
);
1786 REF_PRINT_COUNT("EVP_PKEY", x
);
1789 REF_ASSERT_ISNT(i
< 0);
1790 evp_pkey_free_it(x
);
1792 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY
, x
, &x
->ex_data
);
1794 CRYPTO_THREAD_lock_free(x
->lock
);
1795 CRYPTO_FREE_REF(&x
->references
);
1797 sk_X509_ATTRIBUTE_pop_free(x
->attributes
, X509_ATTRIBUTE_free
);
1802 int EVP_PKEY_get_size(const EVP_PKEY
*pkey
)
1807 size
= pkey
->cache
.size
;
1809 if (pkey
->ameth
!= NULL
&& pkey
->ameth
->pkey_size
!= NULL
)
1810 size
= pkey
->ameth
->pkey_size(pkey
);
1813 return size
< 0 ? 0 : size
;
1816 const char *EVP_PKEY_get0_description(const EVP_PKEY
*pkey
)
1818 if (!evp_pkey_is_assigned(pkey
))
1821 if (evp_pkey_is_provided(pkey
) && pkey
->keymgmt
->description
!= NULL
)
1822 return pkey
->keymgmt
->description
;
1824 if (pkey
->ameth
!= NULL
)
1825 return pkey
->ameth
->info
;
1830 void *evp_pkey_export_to_provider(EVP_PKEY
*pk
, OSSL_LIB_CTX
*libctx
,
1831 EVP_KEYMGMT
**keymgmt
,
1832 const char *propquery
)
1834 EVP_KEYMGMT
*allocated_keymgmt
= NULL
;
1835 EVP_KEYMGMT
*tmp_keymgmt
= NULL
;
1836 int selection
= OSSL_KEYMGMT_SELECT_ALL
;
1837 void *keydata
= NULL
;
1843 /* No key data => nothing to export */
1846 check
= check
&& pk
->pkey
.ptr
== NULL
;
1848 check
= check
&& pk
->keydata
== NULL
;
1853 if (pk
->pkey
.ptr
!= NULL
) {
1855 * If the legacy key doesn't have an dirty counter or export function,
1858 if (pk
->ameth
->dirty_cnt
== NULL
|| pk
->ameth
->export_to
== NULL
)
1863 if (keymgmt
!= NULL
) {
1864 tmp_keymgmt
= *keymgmt
;
1869 * If no keymgmt was given or found, get a default keymgmt. We do so by
1870 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1872 if (tmp_keymgmt
== NULL
) {
1873 EVP_PKEY_CTX
*ctx
= EVP_PKEY_CTX_new_from_pkey(libctx
, pk
, propquery
);
1877 allocated_keymgmt
= tmp_keymgmt
= ctx
->keymgmt
;
1878 ctx
->keymgmt
= NULL
;
1879 EVP_PKEY_CTX_free(ctx
);
1882 /* If there's still no keymgmt to be had, give up */
1883 if (tmp_keymgmt
== NULL
)
1887 if (pk
->pkey
.ptr
!= NULL
) {
1891 * If the legacy "origin" hasn't changed since last time, we try
1892 * to find our keymgmt in the operation cache. If it has changed,
1893 * |i| remains zero, and we will clear the cache further down.
1895 if (pk
->ameth
->dirty_cnt(pk
) == pk
->dirty_cnt_copy
) {
1896 if (!CRYPTO_THREAD_read_lock(pk
->lock
))
1898 op
= evp_keymgmt_util_find_operation_cache(pk
, tmp_keymgmt
,
1902 * If |tmp_keymgmt| is present in the operation cache, it means
1903 * that export doesn't need to be redone. In that case, we take
1904 * token copies of the cached pointers, to have token success
1907 if (op
!= NULL
&& op
->keymgmt
!= NULL
) {
1908 keydata
= op
->keydata
;
1909 CRYPTO_THREAD_unlock(pk
->lock
);
1912 CRYPTO_THREAD_unlock(pk
->lock
);
1915 /* Make sure that the keymgmt key type matches the legacy NID */
1916 if (!EVP_KEYMGMT_is_a(tmp_keymgmt
, OBJ_nid2sn(pk
->type
)))
1919 if ((keydata
= evp_keymgmt_newdata(tmp_keymgmt
)) == NULL
)
1922 if (!pk
->ameth
->export_to(pk
, keydata
, tmp_keymgmt
->import
,
1923 libctx
, propquery
)) {
1924 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1930 * If the dirty counter changed since last time, then clear the
1931 * operation cache. In that case, we know that |i| is zero. Just
1932 * in case this is a re-export, we increment then decrement the
1933 * keymgmt reference counter.
1935 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt
)) { /* refcnt++ */
1936 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1941 if (!CRYPTO_THREAD_write_lock(pk
->lock
))
1943 if (pk
->ameth
->dirty_cnt(pk
) != pk
->dirty_cnt_copy
1944 && !evp_keymgmt_util_clear_operation_cache(pk
)) {
1945 CRYPTO_THREAD_unlock(pk
->lock
);
1946 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1948 EVP_KEYMGMT_free(tmp_keymgmt
);
1951 EVP_KEYMGMT_free(tmp_keymgmt
); /* refcnt-- */
1953 /* Check to make sure some other thread didn't get there first */
1954 op
= evp_keymgmt_util_find_operation_cache(pk
, tmp_keymgmt
, selection
);
1955 if (op
!= NULL
&& op
->keymgmt
!= NULL
) {
1956 void *tmp_keydata
= op
->keydata
;
1958 CRYPTO_THREAD_unlock(pk
->lock
);
1959 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1960 keydata
= tmp_keydata
;
1964 /* Add the new export to the operation cache */
1965 if (!evp_keymgmt_util_cache_keydata(pk
, tmp_keymgmt
, keydata
,
1967 CRYPTO_THREAD_unlock(pk
->lock
);
1968 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1973 /* Synchronize the dirty count */
1974 pk
->dirty_cnt_copy
= pk
->ameth
->dirty_cnt(pk
);
1976 CRYPTO_THREAD_unlock(pk
->lock
);
1979 #endif /* FIPS_MODULE */
1981 keydata
= evp_keymgmt_util_export_to_provider(pk
, tmp_keymgmt
, selection
);
1985 * If nothing was exported, |tmp_keymgmt| might point at a freed
1986 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1987 * the caller either way in that case.
1989 if (keydata
== NULL
)
1992 if (keymgmt
!= NULL
&& tmp_keymgmt
!= NULL
) {
1993 *keymgmt
= tmp_keymgmt
;
1994 allocated_keymgmt
= NULL
;
1997 EVP_KEYMGMT_free(allocated_keymgmt
);
2002 int evp_pkey_copy_downgraded(EVP_PKEY
**dest
, const EVP_PKEY
*src
)
2004 EVP_PKEY
*allocpkey
= NULL
;
2006 if (!ossl_assert(dest
!= NULL
))
2009 if (evp_pkey_is_assigned(src
) && evp_pkey_is_provided(src
)) {
2010 EVP_KEYMGMT
*keymgmt
= src
->keymgmt
;
2011 void *keydata
= src
->keydata
;
2012 int type
= src
->type
;
2013 const char *keytype
= NULL
;
2015 keytype
= EVP_KEYMGMT_get0_name(keymgmt
);
2018 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
2019 * else in our code. If it's not one of the well known EVP_PKEY_xxx
2020 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
2021 * The check is kept as a safety measure.
2023 if (!ossl_assert(type
!= EVP_PKEY_NONE
)) {
2024 ERR_raise_data(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
,
2025 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
2030 /* Prefer the legacy key type name for error reporting */
2031 if (type
!= EVP_PKEY_KEYMGMT
)
2032 keytype
= OBJ_nid2sn(type
);
2034 /* Make sure we have a clean slate to copy into */
2035 if (*dest
== NULL
) {
2036 allocpkey
= *dest
= EVP_PKEY_new();
2037 if (*dest
== NULL
) {
2038 ERR_raise(ERR_LIB_EVP
, ERR_R_EVP_LIB
);
2042 evp_pkey_free_it(*dest
);
2045 if (EVP_PKEY_set_type(*dest
, type
)) {
2046 /* If the key is typed but empty, we're done */
2047 if (keydata
== NULL
)
2050 if ((*dest
)->ameth
->import_from
== NULL
) {
2051 ERR_raise_data(ERR_LIB_EVP
, EVP_R_NO_IMPORT_FUNCTION
,
2052 "key type = %s", keytype
);
2055 * We perform the export in the same libctx as the keymgmt
2056 * that we are using.
2058 OSSL_LIB_CTX
*libctx
=
2059 ossl_provider_libctx(keymgmt
->prov
);
2060 EVP_PKEY_CTX
*pctx
=
2061 EVP_PKEY_CTX_new_from_pkey(libctx
, *dest
, NULL
);
2064 ERR_raise(ERR_LIB_EVP
, ERR_R_EVP_LIB
);
2067 && evp_keymgmt_export(keymgmt
, keydata
,
2068 OSSL_KEYMGMT_SELECT_ALL
,
2069 (*dest
)->ameth
->import_from
,
2071 /* Synchronize the dirty count */
2072 (*dest
)->dirty_cnt_copy
= (*dest
)->ameth
->dirty_cnt(*dest
);
2074 EVP_PKEY_CTX_free(pctx
);
2077 EVP_PKEY_CTX_free(pctx
);
2080 ERR_raise_data(ERR_LIB_EVP
, EVP_R_KEYMGMT_EXPORT_FAILURE
,
2081 "key type = %s", keytype
);
2085 if (allocpkey
!= NULL
) {
2086 EVP_PKEY_free(allocpkey
);
2092 void *evp_pkey_get_legacy(EVP_PKEY
*pk
)
2094 EVP_PKEY
*tmp_copy
= NULL
;
2097 if (!ossl_assert(pk
!= NULL
))
2101 * If this isn't an assigned provider side key, we just use any existing
2102 * origin legacy key.
2104 if (!evp_pkey_is_assigned(pk
))
2106 if (!evp_pkey_is_provided(pk
))
2107 return pk
->pkey
.ptr
;
2109 if (!CRYPTO_THREAD_read_lock(pk
->lock
))
2112 ret
= pk
->legacy_cache_pkey
.ptr
;
2114 if (!CRYPTO_THREAD_unlock(pk
->lock
))
2120 if (!evp_pkey_copy_downgraded(&tmp_copy
, pk
))
2123 if (!CRYPTO_THREAD_write_lock(pk
->lock
))
2126 /* Check again in case some other thread has updated it in the meantime */
2127 ret
= pk
->legacy_cache_pkey
.ptr
;
2129 /* Steal the legacy key reference from the temporary copy */
2130 ret
= pk
->legacy_cache_pkey
.ptr
= tmp_copy
->pkey
.ptr
;
2131 tmp_copy
->pkey
.ptr
= NULL
;
2134 if (!CRYPTO_THREAD_unlock(pk
->lock
)) {
2140 EVP_PKEY_free(tmp_copy
);
2144 #endif /* FIPS_MODULE */
2146 int EVP_PKEY_get_bn_param(const EVP_PKEY
*pkey
, const char *key_name
,
2150 OSSL_PARAM params
[2];
2151 unsigned char buffer
[2048];
2152 unsigned char *buf
= NULL
;
2155 if (key_name
== NULL
2159 memset(buffer
, 0, sizeof(buffer
));
2160 params
[0] = OSSL_PARAM_construct_BN(key_name
, buffer
, sizeof(buffer
));
2161 params
[1] = OSSL_PARAM_construct_end();
2162 if (!EVP_PKEY_get_params(pkey
, params
)) {
2163 if (!OSSL_PARAM_modified(params
) || params
[0].return_size
== 0)
2165 buf_sz
= params
[0].return_size
;
2167 * If it failed because the buffer was too small then allocate the
2168 * required buffer size and retry.
2170 buf
= OPENSSL_zalloc(buf_sz
);
2173 params
[0].data
= buf
;
2174 params
[0].data_size
= buf_sz
;
2176 if (!EVP_PKEY_get_params(pkey
, params
))
2179 /* Fail if the param was not found */
2180 if (!OSSL_PARAM_modified(params
))
2182 ret
= OSSL_PARAM_get_BN(params
, bn
);
2185 if (OSSL_PARAM_modified(params
))
2186 OPENSSL_clear_free(buf
, buf_sz
);
2189 } else if (OSSL_PARAM_modified(params
)) {
2190 OPENSSL_cleanse(buffer
, params
[0].data_size
);
2195 int EVP_PKEY_get_octet_string_param(const EVP_PKEY
*pkey
, const char *key_name
,
2196 unsigned char *buf
, size_t max_buf_sz
,
2199 OSSL_PARAM params
[2];
2200 int ret1
= 0, ret2
= 0;
2202 if (key_name
== NULL
)
2205 params
[0] = OSSL_PARAM_construct_octet_string(key_name
, buf
, max_buf_sz
);
2206 params
[1] = OSSL_PARAM_construct_end();
2207 if ((ret1
= EVP_PKEY_get_params(pkey
, params
)))
2208 ret2
= OSSL_PARAM_modified(params
);
2209 if (ret2
&& out_len
!= NULL
)
2210 *out_len
= params
[0].return_size
;
2211 return ret1
&& ret2
;
2214 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY
*pkey
, const char *key_name
,
2215 char *str
, size_t max_buf_sz
,
2218 OSSL_PARAM params
[2];
2219 int ret1
= 0, ret2
= 0;
2221 if (key_name
== NULL
)
2224 params
[0] = OSSL_PARAM_construct_utf8_string(key_name
, str
, max_buf_sz
);
2225 params
[1] = OSSL_PARAM_construct_end();
2226 if ((ret1
= EVP_PKEY_get_params(pkey
, params
)))
2227 ret2
= OSSL_PARAM_modified(params
);
2228 if (ret2
&& out_len
!= NULL
)
2229 *out_len
= params
[0].return_size
;
2231 if (ret2
&& params
[0].return_size
== max_buf_sz
)
2232 /* There was no space for a NUL byte */
2234 /* Add a terminating NUL byte for good measure */
2235 if (ret2
&& str
!= NULL
)
2236 str
[params
[0].return_size
] = '\0';
2238 return ret1
&& ret2
;
2241 int EVP_PKEY_get_int_param(const EVP_PKEY
*pkey
, const char *key_name
,
2244 OSSL_PARAM params
[2];
2246 if (key_name
== NULL
)
2249 params
[0] = OSSL_PARAM_construct_int(key_name
, out
);
2250 params
[1] = OSSL_PARAM_construct_end();
2251 return EVP_PKEY_get_params(pkey
, params
)
2252 && OSSL_PARAM_modified(params
);
2255 int EVP_PKEY_get_size_t_param(const EVP_PKEY
*pkey
, const char *key_name
,
2258 OSSL_PARAM params
[2];
2260 if (key_name
== NULL
)
2263 params
[0] = OSSL_PARAM_construct_size_t(key_name
, out
);
2264 params
[1] = OSSL_PARAM_construct_end();
2265 return EVP_PKEY_get_params(pkey
, params
)
2266 && OSSL_PARAM_modified(params
);
2269 int EVP_PKEY_set_int_param(EVP_PKEY
*pkey
, const char *key_name
, int in
)
2271 OSSL_PARAM params
[2];
2273 if (key_name
== NULL
)
2276 params
[0] = OSSL_PARAM_construct_int(key_name
, &in
);
2277 params
[1] = OSSL_PARAM_construct_end();
2278 return EVP_PKEY_set_params(pkey
, params
);
2281 int EVP_PKEY_set_size_t_param(EVP_PKEY
*pkey
, const char *key_name
, size_t in
)
2283 OSSL_PARAM params
[2];
2285 if (key_name
== NULL
)
2288 params
[0] = OSSL_PARAM_construct_size_t(key_name
, &in
);
2289 params
[1] = OSSL_PARAM_construct_end();
2290 return EVP_PKEY_set_params(pkey
, params
);
2293 int EVP_PKEY_set_bn_param(EVP_PKEY
*pkey
, const char *key_name
,
2296 OSSL_PARAM params
[2];
2297 unsigned char buffer
[2048];
2300 if (key_name
== NULL
2303 || !evp_pkey_is_assigned(pkey
))
2306 bsize
= BN_num_bytes(bn
);
2307 if (!ossl_assert(bsize
<= (int)sizeof(buffer
)))
2310 if (BN_bn2nativepad(bn
, buffer
, bsize
) < 0)
2312 params
[0] = OSSL_PARAM_construct_BN(key_name
, buffer
, bsize
);
2313 params
[1] = OSSL_PARAM_construct_end();
2314 return EVP_PKEY_set_params(pkey
, params
);
2317 int EVP_PKEY_set_utf8_string_param(EVP_PKEY
*pkey
, const char *key_name
,
2320 OSSL_PARAM params
[2];
2322 if (key_name
== NULL
)
2325 params
[0] = OSSL_PARAM_construct_utf8_string(key_name
, (char *)str
, 0);
2326 params
[1] = OSSL_PARAM_construct_end();
2327 return EVP_PKEY_set_params(pkey
, params
);
2330 int EVP_PKEY_set_octet_string_param(EVP_PKEY
*pkey
, const char *key_name
,
2331 const unsigned char *buf
, size_t bsize
)
2333 OSSL_PARAM params
[2];
2335 if (key_name
== NULL
)
2338 params
[0] = OSSL_PARAM_construct_octet_string(key_name
,
2339 (unsigned char *)buf
, bsize
);
2340 params
[1] = OSSL_PARAM_construct_end();
2341 return EVP_PKEY_set_params(pkey
, params
);
2344 const OSSL_PARAM
*EVP_PKEY_settable_params(const EVP_PKEY
*pkey
)
2346 return (pkey
!= NULL
&& evp_pkey_is_provided(pkey
))
2347 ? EVP_KEYMGMT_settable_params(pkey
->keymgmt
)
2351 int EVP_PKEY_set_params(EVP_PKEY
*pkey
, OSSL_PARAM params
[])
2354 if (evp_pkey_is_provided(pkey
)) {
2356 return evp_keymgmt_set_params(pkey
->keymgmt
, pkey
->keydata
, params
);
2360 * We will hopefully never find the need to set individual data in
2361 * EVP_PKEYs with a legacy internal key, but we can't be entirely
2362 * sure. This bit of code can be enabled if we find the need. If
2363 * not, it can safely be removed when #legacy support is removed.
2366 else if (evp_pkey_is_legacy(pkey
)) {
2367 return evp_pkey_set_params_to_ctrl(pkey
, params
);
2372 ERR_raise(ERR_LIB_EVP
, EVP_R_INVALID_KEY
);
2376 const OSSL_PARAM
*EVP_PKEY_gettable_params(const EVP_PKEY
*pkey
)
2378 return (pkey
!= NULL
&& evp_pkey_is_provided(pkey
))
2379 ? EVP_KEYMGMT_gettable_params(pkey
->keymgmt
)
2383 int EVP_PKEY_get_params(const EVP_PKEY
*pkey
, OSSL_PARAM params
[])
2386 if (evp_pkey_is_provided(pkey
))
2387 return evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
) > 0;
2389 else if (evp_pkey_is_legacy(pkey
))
2390 return evp_pkey_get_params_to_ctrl(pkey
, params
) > 0;
2393 ERR_raise(ERR_LIB_EVP
, EVP_R_INVALID_KEY
);
2398 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY
*pkey
)
2406 if (pkey
->keymgmt
== NULL
2407 || pkey
->keydata
== NULL
) {
2408 # ifndef OPENSSL_NO_EC
2409 /* Might work through the legacy route */
2410 const EC_KEY
*ec
= EVP_PKEY_get0_EC_KEY(pkey
);
2415 return EC_KEY_get_conv_form(ec
);
2421 if (!EVP_PKEY_get_utf8_string_param(pkey
,
2422 OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT
,
2423 name
, sizeof(name
), &name_len
))
2426 if (strcmp(name
, "uncompressed") == 0)
2427 return POINT_CONVERSION_UNCOMPRESSED
;
2429 if (strcmp(name
, "compressed") == 0)
2430 return POINT_CONVERSION_COMPRESSED
;
2432 if (strcmp(name
, "hybrid") == 0)
2433 return POINT_CONVERSION_HYBRID
;
2438 int EVP_PKEY_get_field_type(const EVP_PKEY
*pkey
)
2446 if (pkey
->keymgmt
== NULL
2447 || pkey
->keydata
== NULL
) {
2448 # ifndef OPENSSL_NO_EC
2449 /* Might work through the legacy route */
2450 const EC_KEY
*ec
= EVP_PKEY_get0_EC_KEY(pkey
);
2451 const EC_GROUP
*grp
;
2455 grp
= EC_KEY_get0_group(ec
);
2459 return EC_GROUP_get_field_type(grp
);
2465 if (!EVP_PKEY_get_utf8_string_param(pkey
, OSSL_PKEY_PARAM_EC_FIELD_TYPE
,
2466 fstr
, sizeof(fstr
), &fstrlen
))
2469 if (strcmp(fstr
, SN_X9_62_prime_field
) == 0)
2470 return NID_X9_62_prime_field
;
2471 else if (strcmp(fstr
, SN_X9_62_characteristic_two_field
))
2472 return NID_X9_62_characteristic_two_field
;