2 * Copyright 1995-2021 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/x509.h>
26 #include <openssl/rsa.h>
27 #include <openssl/dsa.h>
28 #include <openssl/dh.h>
29 #include <openssl/ec.h>
30 #include <openssl/cmac.h>
31 #include <openssl/engine.h>
32 #include <openssl/params.h>
33 #include <openssl/param_build.h>
34 #include <openssl/encoder.h>
35 #include <openssl/core_names.h>
37 #include "internal/ffc.h"
38 #include "crypto/asn1.h"
39 #include "crypto/evp.h"
40 #include "crypto/ec.h"
41 #include "crypto/ecx.h"
42 #include "internal/provider.h"
43 #include "evp_local.h"
45 #include "crypto/ec.h"
47 #include "e_os.h" /* strcasecmp on Windows */
49 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
50 int len, EVP_KEYMGMT *keymgmt);
51 static void evp_pkey_free_it(EVP_PKEY *key);
55 /* The type of parameters selected in key parameter functions */
56 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
58 int EVP_PKEY_bits(const EVP_PKEY *pkey)
63 size = pkey->cache.bits;
64 if (pkey->ameth != NULL && pkey->ameth->pkey_bits != NULL)
65 size = pkey->ameth->pkey_bits(pkey);
67 return size < 0 ? 0 : size;
70 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
75 size = pkey->cache.security_bits;
76 if (pkey->ameth != NULL && pkey->ameth->pkey_security_bits != NULL)
77 size = pkey->ameth->pkey_security_bits(pkey);
79 return size < 0 ? 0 : size;
82 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
84 # ifndef OPENSSL_NO_DSA
85 if (pkey->type == EVP_PKEY_DSA) {
86 int ret = pkey->save_parameters;
89 pkey->save_parameters = mode;
93 # ifndef OPENSSL_NO_EC
94 if (pkey->type == EVP_PKEY_EC) {
95 int ret = pkey->save_parameters;
98 pkey->save_parameters = mode;
105 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
107 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
110 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
112 return CRYPTO_get_ex_data(&key->ex_data, idx);
115 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
118 * Clean up legacy stuff from this function when legacy support is gone.
121 EVP_PKEY *downgraded_from = NULL;
125 * If |to| is a legacy key and |from| isn't, we must make a downgraded
126 * copy of |from|. If that fails, this function fails.
128 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from)) {
129 if (!evp_pkey_copy_downgraded(&downgraded_from, from))
131 from = downgraded_from;
135 * Make sure |to| is typed. Content is less important at this early
138 * 1. If |to| is untyped, assign |from|'s key type to it.
139 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
140 * (|from| was already downgraded above)
142 * If |to| is a provided key, there's nothing more to do here, functions
143 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
144 * further down help us find out if they are the same or not.
146 if (evp_pkey_is_blank(to)) {
147 if (evp_pkey_is_legacy(from)) {
148 if (EVP_PKEY_set_type(to, from->type) == 0)
151 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
154 } else if (evp_pkey_is_legacy(to)) {
155 if (to->type != from->type) {
156 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
161 if (EVP_PKEY_missing_parameters(from)) {
162 ERR_raise(ERR_LIB_EVP, EVP_R_MISSING_PARAMETERS);
166 if (!EVP_PKEY_missing_parameters(to)) {
167 if (EVP_PKEY_parameters_eq(to, from) == 1)
170 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_PARAMETERS);
174 /* For purely provided keys, we just call the keymgmt utility */
175 if (to->keymgmt != NULL && from->keymgmt != NULL) {
176 ok = evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
181 * If |to| is provided, we know that |from| is legacy at this point.
182 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
183 * to copy the appropriate data to |to|'s keydata.
185 if (to->keymgmt != NULL) {
186 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
188 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
192 * If we get a NULL, it could be an internal error, or it could be
193 * that there's a key mismatch. We're pretending the latter...
195 if (from_keydata == NULL)
196 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
198 ok = evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
203 /* Both keys are legacy */
204 if (from->ameth != NULL && from->ameth->param_copy != NULL)
205 ok = from->ameth->param_copy(to, from);
207 EVP_PKEY_free(downgraded_from);
211 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
214 if (pkey->keymgmt != NULL)
215 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
216 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
217 return pkey->ameth->param_missing(pkey);
223 * This function is called for any mixture of keys except pure legacy pair.
224 * TODO When legacy keys are gone, we replace a call to this functions with
225 * a call to evp_keymgmt_util_match().
227 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
230 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
231 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
233 /* If none of them are provided, this function shouldn't have been called */
234 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
237 /* For purely provided keys, we just call the keymgmt utility */
238 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
239 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
242 * At this point, one of them is provided, the other not. This allows
243 * us to compare types using legacy NIDs.
245 if (evp_pkey_is_legacy(a)
246 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
247 return -1; /* not the same key type */
248 if (evp_pkey_is_legacy(b)
249 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
250 return -1; /* not the same key type */
253 * We've determined that they both are the same keytype, so the next
254 * step is to do a bit of cross export to ensure we have keydata for
255 * both keys in the same keymgmt.
257 keymgmt1 = a->keymgmt;
258 keydata1 = a->keydata;
259 keymgmt2 = b->keymgmt;
260 keydata2 = b->keydata;
262 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
264 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
265 if (tmp_keydata != NULL) {
267 keydata1 = tmp_keydata;
270 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
272 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
273 if (tmp_keydata != NULL) {
275 keydata2 = tmp_keydata;
279 /* If we still don't have matching keymgmt implementations, we give up */
280 if (keymgmt1 != keymgmt2)
283 /* If the keymgmt implementations are NULL, the export failed */
284 if (keymgmt1 == NULL)
287 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
290 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
292 return EVP_PKEY_parameters_eq(a, b);
295 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
298 * TODO: clean up legacy stuff from this function when legacy support
302 if (a->keymgmt != NULL || b->keymgmt != NULL)
303 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
305 /* All legacy keys */
306 if (a->type != b->type)
308 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
309 return a->ameth->param_cmp(a, b);
313 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
315 return EVP_PKEY_eq(a, b);
318 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
321 * TODO: clean up legacy stuff from this function when legacy support
325 if (a->keymgmt != NULL || b->keymgmt != NULL)
326 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
327 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
329 /* All legacy keys */
330 if (a->type != b->type)
333 if (a->ameth != NULL) {
335 /* Compare parameters if the algorithm has them */
336 if (a->ameth->param_cmp != NULL) {
337 ret = a->ameth->param_cmp(a, b);
342 if (a->ameth->pub_cmp != NULL)
343 return a->ameth->pub_cmp(a, b);
350 static EVP_PKEY *new_raw_key_int(OSSL_LIB_CTX *libctx,
355 const unsigned char *key,
359 EVP_PKEY *pkey = NULL;
360 EVP_PKEY_CTX *ctx = NULL;
361 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
364 # ifndef OPENSSL_NO_ENGINE
365 /* Check if there is an Engine for this type */
370 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
371 else if (nidtype != EVP_PKEY_NONE)
372 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
374 /* If tmpe is NULL then no engine is claiming to support this type */
382 if (e == NULL && ameth == NULL) {
384 * No engine is claiming to support this type, so lets see if we have
387 ctx = EVP_PKEY_CTX_new_from_name(libctx,
388 strtype != NULL ? strtype
389 : OBJ_nid2sn(nidtype),
393 /* May fail if no provider available */
395 if (EVP_PKEY_fromdata_init(ctx) == 1) {
396 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
398 ERR_clear_last_mark();
399 params[0] = OSSL_PARAM_construct_octet_string(
400 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
401 : OSSL_PKEY_PARAM_PUB_KEY,
404 if (EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params) != 1) {
405 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
409 EVP_PKEY_CTX_free(ctx);
414 /* else not supported so fallback to legacy */
417 /* Legacy code path */
419 pkey = EVP_PKEY_new();
421 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
425 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
426 /* EVPerr already called */
430 if (!ossl_assert(pkey->ameth != NULL))
434 if (pkey->ameth->set_priv_key == NULL) {
435 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
439 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
440 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
444 if (pkey->ameth->set_pub_key == NULL) {
445 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
449 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
450 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
461 EVP_PKEY_CTX_free(ctx);
465 EVP_PKEY *EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX *libctx,
468 const unsigned char *priv, size_t len)
470 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
474 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
475 const unsigned char *priv,
478 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
481 EVP_PKEY *EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX *libctx,
482 const char *keytype, const char *propq,
483 const unsigned char *pub, size_t len)
485 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
489 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
490 const unsigned char *pub,
493 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
496 struct raw_key_details_st
503 static OSSL_CALLBACK get_raw_key_details;
504 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
506 const OSSL_PARAM *p = NULL;
507 struct raw_key_details_st *raw_key = arg;
509 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
510 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
512 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
513 SIZE_MAX, raw_key->len);
514 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
515 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
517 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
518 SIZE_MAX, raw_key->len);
524 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
527 if (pkey->keymgmt != NULL) {
528 struct raw_key_details_st raw_key;
530 raw_key.key = priv == NULL ? NULL : &priv;
532 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
534 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
535 get_raw_key_details, &raw_key);
538 if (pkey->ameth == NULL) {
539 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
543 if (pkey->ameth->get_priv_key == NULL) {
544 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
548 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
549 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
556 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
559 if (pkey->keymgmt != NULL) {
560 struct raw_key_details_st raw_key;
562 raw_key.key = pub == NULL ? NULL : &pub;
564 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
566 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
567 get_raw_key_details, &raw_key);
570 if (pkey->ameth == NULL) {
571 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
575 if (pkey->ameth->get_pub_key == NULL) {
576 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
580 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
581 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
588 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
589 const char *cipher_name,
590 const EVP_CIPHER *cipher,
591 OSSL_LIB_CTX *libctx,
592 const char *propq, ENGINE *e)
594 # ifndef OPENSSL_NO_CMAC
595 # ifndef OPENSSL_NO_ENGINE
596 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
598 OSSL_PARAM params[5], *p = params;
599 EVP_PKEY *pkey = NULL;
603 cipher_name = EVP_CIPHER_name(cipher);
605 if (cipher_name == NULL) {
606 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
610 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
614 if (!EVP_PKEY_fromdata_init(ctx)) {
615 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
619 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
621 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
622 (char *)cipher_name, 0);
624 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
626 # ifndef OPENSSL_NO_ENGINE
627 if (engine_id != NULL)
628 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
629 (char *)engine_id, 0);
631 *p = OSSL_PARAM_construct_end();
633 if (!EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params)) {
634 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
639 EVP_PKEY_CTX_free(ctx);
643 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
648 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
649 size_t len, const EVP_CIPHER *cipher)
651 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
654 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
656 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
659 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
661 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
664 #ifndef OPENSSL_NO_DEPRECATED_3_0
665 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
667 if (!evp_pkey_is_legacy(pkey)) {
668 const char *name = OBJ_nid2sn(type);
670 if (name != NULL && EVP_PKEY_is_a(pkey, name))
673 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
677 if (pkey->type == type) {
678 return 1; /* it already is that type */
682 * The application is requesting to alias this to a different pkey type,
683 * but not one that resolves to the base type.
685 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
686 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
695 # ifndef OPENSSL_NO_ENGINE
696 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
699 if (!ENGINE_init(e)) {
700 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
703 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
705 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
709 ENGINE_finish(pkey->pmeth_engine);
710 pkey->pmeth_engine = e;
714 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
719 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
723 #ifndef OPENSSL_NO_EC
724 if ((key != NULL) && (EVP_PKEY_type(type) == EVP_PKEY_EC)) {
725 const EC_GROUP *group = EC_KEY_get0_group(key);
727 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
728 alias = EVP_PKEY_SM2;
732 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
734 if (!EVP_PKEY_set_alias_type(pkey, alias))
736 pkey->pkey.ptr = key;
737 return (key != NULL);
740 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
745 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
748 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
750 ASN1_OCTET_STRING *os = NULL;
751 if (pkey->type != EVP_PKEY_HMAC) {
752 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_AN_HMAC_KEY);
755 os = EVP_PKEY_get0(pkey);
760 # ifndef OPENSSL_NO_POLY1305
761 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
763 ASN1_OCTET_STRING *os = NULL;
764 if (pkey->type != EVP_PKEY_POLY1305) {
765 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_POLY1305_KEY);
768 os = EVP_PKEY_get0(pkey);
774 # ifndef OPENSSL_NO_SIPHASH
775 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
777 ASN1_OCTET_STRING *os = NULL;
779 if (pkey->type != EVP_PKEY_SIPHASH) {
780 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_SIPHASH_KEY);
783 os = EVP_PKEY_get0(pkey);
789 # ifndef OPENSSL_NO_DSA
790 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
792 if (pkey->type != EVP_PKEY_DSA) {
793 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DSA_KEY);
796 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
799 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
801 int ret = EVP_PKEY_assign_DSA(pkey, key);
806 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
808 DSA *ret = EVP_PKEY_get0_DSA(pkey);
813 # endif /* OPENSSL_NO_DSA */
814 #endif /* FIPS_MODULE */
817 # ifndef OPENSSL_NO_EC
818 static ECX_KEY *evp_pkey_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
820 if (EVP_PKEY_base_id(pkey) != type) {
821 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
824 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
827 static ECX_KEY *evp_pkey_get1_ECX_KEY(EVP_PKEY *pkey, int type)
829 ECX_KEY *ret = evp_pkey_get0_ECX_KEY(pkey, type);
831 ossl_ecx_key_up_ref(ret);
835 # define IMPLEMENT_ECX_VARIANT(NAME) \
836 ECX_KEY *ossl_evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
838 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
840 IMPLEMENT_ECX_VARIANT(X25519)
841 IMPLEMENT_ECX_VARIANT(X448)
842 IMPLEMENT_ECX_VARIANT(ED25519)
843 IMPLEMENT_ECX_VARIANT(ED448)
847 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
849 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
851 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
852 int ret = EVP_PKEY_assign(pkey, type, key);
859 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
861 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
862 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DH_KEY);
865 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
868 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
870 DH *ret = EVP_PKEY_get0_DH(pkey);
877 int EVP_PKEY_type(int type)
880 const EVP_PKEY_ASN1_METHOD *ameth;
882 ameth = EVP_PKEY_asn1_find(&e, type);
884 ret = ameth->pkey_id;
887 # ifndef OPENSSL_NO_ENGINE
893 int EVP_PKEY_id(const EVP_PKEY *pkey)
898 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
900 return EVP_PKEY_type(pkey->type);
905 * These hard coded cases are pure hackery to get around the fact
906 * that names in crypto/objects/objects.txt are a mess. There is
907 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
908 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
909 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
910 * "DSA" is accurate... but still, better be safe and hard-code
911 * names that we know.
912 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
913 * EVP_PKEY_EC, because of aliasing.
914 * TODO Clean this away along with all other #legacy support.
916 static const OSSL_ITEM standard_name2type[] = {
917 { EVP_PKEY_RSA, "RSA" },
918 { EVP_PKEY_RSA_PSS, "RSA-PSS" },
919 { EVP_PKEY_EC, "EC" },
920 { EVP_PKEY_ED25519, "ED25519" },
921 { EVP_PKEY_ED448, "ED448" },
922 { EVP_PKEY_X25519, "X25519" },
923 { EVP_PKEY_X448, "X448" },
924 { EVP_PKEY_SM2, "SM2" },
925 { EVP_PKEY_DH, "DH" },
926 { EVP_PKEY_DHX, "X9.42 DH" },
927 { EVP_PKEY_DHX, "DHX" },
928 { EVP_PKEY_DSA, "DSA" },
931 int evp_pkey_name2type(const char *name)
936 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
937 if (strcasecmp(name, standard_name2type[i].ptr) == 0)
938 return (int)standard_name2type[i].id;
941 if ((type = EVP_PKEY_type(OBJ_sn2nid(name))) != NID_undef)
943 return EVP_PKEY_type(OBJ_ln2nid(name));
946 const char *evp_pkey_type2name(int type)
950 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
951 if (type == (int)standard_name2type[i].id)
952 return standard_name2type[i].ptr;
955 return OBJ_nid2sn(type);
959 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
962 if (pkey->keymgmt == NULL) {
963 int type = evp_pkey_name2type(name);
965 return pkey->type == type;
968 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
971 int EVP_PKEY_typenames_do_all(const EVP_PKEY *pkey,
972 void (*fn)(const char *name, void *data),
975 if (!evp_pkey_is_typed(pkey))
978 if (!evp_pkey_is_provided(pkey)) {
979 const char *name = OBJ_nid2sn(EVP_PKEY_id(pkey));
984 return EVP_KEYMGMT_names_do_all(pkey->keymgmt, fn, data);
987 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
989 if (pkey->keymgmt == NULL) {
990 switch (EVP_PKEY_base_id(pkey)) {
993 #ifndef OPENSSL_NO_DSA
997 #ifndef OPENSSL_NO_EC
998 case EVP_PKEY_ED25519:
1001 case EVP_PKEY_EC: /* Including SM2 */
1002 return EC_KEY_can_sign(pkey->pkey.ec);
1008 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1009 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
1010 const char *supported_sig =
1011 pkey->keymgmt->query_operation_name != NULL
1012 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1013 : evp_first_name(prov, pkey->keymgmt->name_id);
1014 EVP_SIGNATURE *signature = NULL;
1016 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1017 if (signature != NULL) {
1018 EVP_SIGNATURE_free(signature);
1025 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1027 BIO_set_indent(*out, saved_indent);
1029 BIO *next = BIO_pop(*out);
1037 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1043 long i = BIO_get_indent(*out);
1045 *saved_indent = (i < 0 ? 0 : i);
1046 if (BIO_set_indent(*out, indent) <= 0) {
1047 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1051 if (BIO_set_indent(*out, indent) <= 0) {
1052 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1059 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1062 return BIO_indent(out, indent, 128)
1063 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1064 kstr, OBJ_nid2ln(pkey->type)) > 0;
1067 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1068 int selection /* For provided encoding */,
1069 const char *propquery /* For provided encoding */,
1070 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1071 int indent, ASN1_PCTX *pctx),
1072 ASN1_PCTX *legacy_pctx /* For legacy print */)
1076 OSSL_ENCODER_CTX *ctx = NULL;
1077 int ret = -2; /* default to unsupported */
1079 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1082 ctx = OSSL_ENCODER_CTX_new_for_pkey(pkey, selection, "TEXT", NULL,
1084 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0)
1085 ret = OSSL_ENCODER_to_bio(ctx, out);
1086 OSSL_ENCODER_CTX_free(ctx);
1091 /* legacy fallback */
1092 if (legacy_print != NULL)
1093 ret = legacy_print(out, pkey, 0, legacy_pctx);
1095 ret = unsup_alg(out, pkey, 0, "Public Key");
1098 print_reset_indent(&out, pop_f_prefix, saved_indent);
1102 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1103 int indent, ASN1_PCTX *pctx)
1105 return print_pkey(pkey, out, indent, EVP_PKEY_PUBLIC_KEY, NULL,
1106 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1110 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1111 int indent, ASN1_PCTX *pctx)
1113 return print_pkey(pkey, out, indent, EVP_PKEY_KEYPAIR, NULL,
1114 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1118 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1119 int indent, ASN1_PCTX *pctx)
1121 return print_pkey(pkey, out, indent, EVP_PKEY_KEY_PARAMETERS, NULL,
1122 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1126 static void mdname2nid(const char *mdname, void *data)
1128 int *nid = (int *)data;
1130 if (*nid != NID_undef)
1133 *nid = OBJ_sn2nid(mdname);
1134 if (*nid == NID_undef)
1135 *nid = OBJ_ln2nid(mdname);
1138 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1139 int arg1, void *arg2)
1141 if (pkey->keymgmt == NULL)
1144 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1146 char mdname[80] = "";
1147 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1152 OSSL_LIB_CTX *libctx = ossl_provider_libctx(pkey->keymgmt->prov);
1153 /* Make sure the MD is in the namemap if available */
1154 EVP_MD *md = EVP_MD_fetch(libctx, mdname, NULL);
1155 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
1156 int nid = NID_undef;
1159 * The only reason to fetch the MD was to make sure it is in the
1160 * namemap. We can immediately free it.
1163 mdnum = ossl_namemap_name2num(namemap, mdname);
1168 * We have the namemap number - now we need to find the
1171 if (!ossl_namemap_doall_names(namemap, mdnum, mdname2nid, &nid))
1182 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1184 if (pkey->ameth == NULL)
1185 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1186 if (pkey->ameth->pkey_ctrl == NULL)
1188 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1191 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1193 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1196 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1197 char *mdname, size_t mdname_sz)
1199 if (pkey->ameth == NULL)
1200 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1205 int nid = NID_undef;
1206 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1207 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1210 OPENSSL_strlcpy(mdname, name, mdname_sz);
1215 int EVP_PKEY_get_group_name(const EVP_PKEY *pkey, char *gname, size_t gname_sz,
1218 return EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_GROUP_NAME,
1219 gname, gname_sz, gname_len);
1222 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1224 int rv, default_nid;
1226 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1229 * If there is a mandatory default digest and this isn't it, then
1230 * the answer is 'no'.
1232 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1234 return (nid == default_nid);
1235 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1242 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, const unsigned char *pub,
1245 if (pkey != NULL && evp_pkey_is_provided(pkey))
1247 EVP_PKEY_set_octet_string_param(pkey,
1248 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1249 (unsigned char *)pub, publen);
1251 if (publen > INT_MAX)
1253 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1254 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, publen,
1260 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub)
1264 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
1265 size_t return_size = OSSL_PARAM_UNMODIFIED;
1268 * We know that this is going to fail, but it will give us a size
1271 EVP_PKEY_get_octet_string_param(pkey,
1272 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1273 NULL, 0, &return_size);
1274 if (return_size == OSSL_PARAM_UNMODIFIED)
1277 *ppub = OPENSSL_malloc(return_size);
1281 if (!EVP_PKEY_get_octet_string_param(pkey,
1282 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1283 *ppub, return_size, NULL))
1289 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppub);
1295 #endif /* FIPS_MODULE */
1297 /*- All methods below can also be used in FIPS_MODULE */
1299 EVP_PKEY *EVP_PKEY_new(void)
1301 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1304 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1308 ret->type = EVP_PKEY_NONE;
1309 ret->save_type = EVP_PKEY_NONE;
1310 ret->references = 1;
1311 ret->save_parameters = 1;
1313 ret->lock = CRYPTO_THREAD_lock_new();
1314 if (ret->lock == NULL) {
1315 EVPerr(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1320 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1321 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1328 CRYPTO_THREAD_lock_free(ret->lock);
1334 * Setup a public key management method.
1336 * For legacy keys, either |type| or |str| is expected to have the type
1337 * information. In this case, the setup consists of finding an ASN1 method
1338 * and potentially an ENGINE, and setting those fields in |pkey|.
1340 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1341 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1343 * If pkey is NULL just return 1 or 0 if the key management method exists.
1346 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1347 int len, EVP_KEYMGMT *keymgmt)
1350 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1351 ENGINE **eptr = (e == NULL) ? &e : NULL;
1355 * The setups can't set both legacy and provider side methods.
1358 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1359 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1360 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1368 free_it = free_it || pkey->pkey.ptr != NULL;
1370 free_it = free_it || pkey->keydata != NULL;
1372 evp_pkey_free_it(pkey);
1375 * If key type matches and a method exists then this lookup has
1376 * succeeded once so just indicate success.
1378 if (pkey->type != EVP_PKEY_NONE
1379 && type == pkey->save_type
1380 && pkey->ameth != NULL)
1382 # ifndef OPENSSL_NO_ENGINE
1383 /* If we have ENGINEs release them */
1384 ENGINE_finish(pkey->engine);
1385 pkey->engine = NULL;
1386 ENGINE_finish(pkey->pmeth_engine);
1387 pkey->pmeth_engine = NULL;
1393 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1394 else if (type != EVP_PKEY_NONE)
1395 ameth = EVP_PKEY_asn1_find(eptr, type);
1396 # ifndef OPENSSL_NO_ENGINE
1397 if (pkey == NULL && eptr != NULL)
1407 check = check && ameth == NULL;
1409 check = check && keymgmt == NULL;
1411 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
1416 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1417 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1421 pkey->keymgmt = keymgmt;
1423 pkey->save_type = type;
1428 * If the internal "origin" key is provider side, don't save |ameth|.
1429 * The main reason is that |ameth| is one factor to detect that the
1430 * internal "origin" key is a legacy one.
1432 if (keymgmt == NULL)
1433 pkey->ameth = ameth;
1437 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1438 * for any key type that has a legacy implementation, regardless of
1439 * if the internal key is a legacy or a provider side one. When
1440 * there is no legacy implementation for the key, the type becomes
1441 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1442 * with functions that expect legacy internal keys.
1445 pkey->type = ameth->pkey_id;
1447 pkey->type = EVP_PKEY_KEYMGMT;
1454 static void find_ameth(const char *name, void *data)
1456 const char **str = data;
1459 * The error messages from pkey_set_type() are uninteresting here,
1464 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1468 else if (str[1] == NULL)
1476 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1479 # define EVP_PKEY_TYPE_STR str[0]
1480 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1482 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1483 * Ideally, only one should be found. If two (or more) are found, the
1484 * match is ambiguous. This should never happen, but...
1486 const char *str[2] = { NULL, NULL };
1488 if (!EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str)
1489 || str[1] != NULL) {
1490 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1494 # define EVP_PKEY_TYPE_STR NULL
1495 # define EVP_PKEY_TYPE_STRLEN -1
1497 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1498 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1501 #undef EVP_PKEY_TYPE_STR
1502 #undef EVP_PKEY_TYPE_STRLEN
1505 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1509 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1512 REF_PRINT_COUNT("EVP_PKEY", pkey);
1513 REF_ASSERT_ISNT(i < 2);
1514 return ((i > 1) ? 1 : 0);
1518 void evp_pkey_free_legacy(EVP_PKEY *x)
1520 const EVP_PKEY_ASN1_METHOD *ameth = x->ameth;
1521 ENGINE *tmpe = NULL;
1523 if (ameth == NULL && x->legacy_cache_pkey.ptr != NULL)
1524 ameth = EVP_PKEY_asn1_find(&tmpe, x->type);
1526 if (ameth != NULL) {
1527 if (x->legacy_cache_pkey.ptr != NULL) {
1529 * We should never have both a legacy origin key, and a key in the
1532 assert(x->pkey.ptr == NULL);
1534 * For the purposes of freeing we make the legacy cache look like
1535 * a legacy origin key.
1537 x->pkey = x->legacy_cache_pkey;
1538 x->legacy_cache_pkey.ptr = NULL;
1540 if (ameth->pkey_free != NULL)
1541 ameth->pkey_free(x);
1544 # ifndef OPENSSL_NO_ENGINE
1545 ENGINE_finish(tmpe);
1546 ENGINE_finish(x->engine);
1548 ENGINE_finish(x->pmeth_engine);
1549 x->pmeth_engine = NULL;
1552 #endif /* FIPS_MODULE */
1554 static void evp_pkey_free_it(EVP_PKEY *x)
1556 /* internal function; x is never NULL */
1557 evp_keymgmt_util_clear_operation_cache(x, 1);
1559 evp_pkey_free_legacy(x);
1562 if (x->keymgmt != NULL) {
1563 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1564 EVP_KEYMGMT_free(x->keymgmt);
1568 x->type = EVP_PKEY_NONE;
1571 void EVP_PKEY_free(EVP_PKEY *x)
1578 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1579 REF_PRINT_COUNT("EVP_PKEY", x);
1582 REF_ASSERT_ISNT(i < 0);
1583 evp_pkey_free_it(x);
1585 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1587 CRYPTO_THREAD_lock_free(x->lock);
1589 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1594 int EVP_PKEY_size(const EVP_PKEY *pkey)
1599 size = pkey->cache.size;
1601 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1602 size = pkey->ameth->pkey_size(pkey);
1605 return size < 0 ? 0 : size;
1608 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OSSL_LIB_CTX *libctx,
1609 EVP_KEYMGMT **keymgmt,
1610 const char *propquery)
1612 EVP_KEYMGMT *allocated_keymgmt = NULL;
1613 EVP_KEYMGMT *tmp_keymgmt = NULL;
1614 void *keydata = NULL;
1620 /* No key data => nothing to export */
1623 check = check && pk->pkey.ptr == NULL;
1625 check = check && pk->keydata == NULL;
1630 if (pk->pkey.ptr != NULL) {
1632 * If the legacy key doesn't have an dirty counter or export function,
1635 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1640 if (keymgmt != NULL) {
1641 tmp_keymgmt = *keymgmt;
1646 * If no keymgmt was given or found, get a default keymgmt. We do so by
1647 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1649 if (tmp_keymgmt == NULL) {
1650 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1652 tmp_keymgmt = ctx->keymgmt;
1653 ctx->keymgmt = NULL;
1654 EVP_PKEY_CTX_free(ctx);
1657 /* If there's still no keymgmt to be had, give up */
1658 if (tmp_keymgmt == NULL)
1662 if (pk->pkey.ptr != NULL) {
1666 * If the legacy "origin" hasn't changed since last time, we try
1667 * to find our keymgmt in the operation cache. If it has changed,
1668 * |i| remains zero, and we will clear the cache further down.
1670 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1671 if (!CRYPTO_THREAD_read_lock(pk->lock))
1673 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1676 * If |tmp_keymgmt| is present in the operation cache, it means
1677 * that export doesn't need to be redone. In that case, we take
1678 * token copies of the cached pointers, to have token success
1681 if (op != NULL && op->keymgmt != NULL) {
1682 keydata = op->keydata;
1683 CRYPTO_THREAD_unlock(pk->lock);
1686 CRYPTO_THREAD_unlock(pk->lock);
1689 /* Make sure that the keymgmt key type matches the legacy NID */
1690 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1693 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1696 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1697 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1703 * If the dirty counter changed since last time, then clear the
1704 * operation cache. In that case, we know that |i| is zero. Just
1705 * in case this is a re-export, we increment then decrement the
1706 * keymgmt reference counter.
1708 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1709 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1714 if (!CRYPTO_THREAD_write_lock(pk->lock))
1716 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy
1717 && !evp_keymgmt_util_clear_operation_cache(pk, 0)) {
1718 CRYPTO_THREAD_unlock(pk->lock);
1719 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1721 EVP_KEYMGMT_free(tmp_keymgmt);
1724 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1726 /* Check to make sure some other thread didn't get there first */
1727 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1728 if (op != NULL && op->keymgmt != NULL) {
1729 void *tmp_keydata = op->keydata;
1731 CRYPTO_THREAD_unlock(pk->lock);
1732 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1733 keydata = tmp_keydata;
1737 /* Add the new export to the operation cache */
1738 if (!evp_keymgmt_util_cache_keydata(pk, tmp_keymgmt, keydata)) {
1739 CRYPTO_THREAD_unlock(pk->lock);
1740 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1745 /* Synchronize the dirty count */
1746 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1748 CRYPTO_THREAD_unlock(pk->lock);
1751 #endif /* FIPS_MODULE */
1753 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1757 * If nothing was exported, |tmp_keymgmt| might point at a freed
1758 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1759 * the caller either way in that case.
1761 if (keydata == NULL)
1764 if (keymgmt != NULL)
1765 *keymgmt = tmp_keymgmt;
1767 EVP_KEYMGMT_free(allocated_keymgmt);
1772 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1774 if (!ossl_assert(dest != NULL))
1777 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1778 EVP_KEYMGMT *keymgmt = src->keymgmt;
1779 void *keydata = src->keydata;
1780 int type = src->type;
1781 const char *keytype = NULL;
1783 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
1787 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1788 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1789 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1790 * TODO(3.0) remove this check when we're confident that the rest
1791 * of the code treats this correctly.
1793 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1794 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1795 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1800 /* Prefer the legacy key type name for error reporting */
1801 if (type != EVP_PKEY_KEYMGMT)
1802 keytype = OBJ_nid2sn(type);
1804 /* Make sure we have a clean slate to copy into */
1805 if (*dest == NULL) {
1806 *dest = EVP_PKEY_new();
1807 if (*dest == NULL) {
1808 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1812 evp_pkey_free_it(*dest);
1815 if (EVP_PKEY_set_type(*dest, type)) {
1816 /* If the key is typed but empty, we're done */
1817 if (keydata == NULL)
1820 if ((*dest)->ameth->import_from == NULL) {
1821 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1822 "key type = %s", keytype);
1825 * We perform the export in the same libctx as the keymgmt
1826 * that we are using.
1828 OSSL_LIB_CTX *libctx =
1829 ossl_provider_libctx(keymgmt->prov);
1830 EVP_PKEY_CTX *pctx =
1831 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
1834 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1837 && evp_keymgmt_export(keymgmt, keydata,
1838 OSSL_KEYMGMT_SELECT_ALL,
1839 (*dest)->ameth->import_from,
1841 /* Synchronize the dirty count */
1842 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
1844 EVP_PKEY_CTX_free(pctx);
1847 EVP_PKEY_CTX_free(pctx);
1850 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1851 "key type = %s", keytype);
1858 void *evp_pkey_get_legacy(EVP_PKEY *pk)
1860 EVP_PKEY *tmp_copy = NULL;
1863 if (!ossl_assert(pk != NULL))
1867 * If this isn't an assigned provider side key, we just use any existing
1868 * origin legacy key.
1870 if (!evp_pkey_is_assigned(pk))
1872 if (!evp_pkey_is_provided(pk))
1873 return pk->pkey.ptr;
1875 if (!CRYPTO_THREAD_read_lock(pk->lock))
1878 ret = pk->legacy_cache_pkey.ptr;
1880 if (!CRYPTO_THREAD_unlock(pk->lock))
1886 if (!evp_pkey_copy_downgraded(&tmp_copy, pk))
1889 if (!CRYPTO_THREAD_write_lock(pk->lock))
1892 /* Check again in case some other thread has updated it in the meantime */
1893 ret = pk->legacy_cache_pkey.ptr;
1895 /* Steal the legacy key reference from the temporary copy */
1896 ret = pk->legacy_cache_pkey.ptr = tmp_copy->pkey.ptr;
1897 tmp_copy->pkey.ptr = NULL;
1900 if (!CRYPTO_THREAD_unlock(pk->lock)) {
1906 EVP_PKEY_free(tmp_copy);
1910 #endif /* FIPS_MODULE */
1912 int EVP_PKEY_get_bn_param(const EVP_PKEY *pkey, const char *key_name,
1916 OSSL_PARAM params[2];
1917 unsigned char buffer[2048];
1918 unsigned char *buf = NULL;
1921 if (key_name == NULL
1924 || !evp_pkey_is_provided(pkey))
1927 memset(buffer, 0, sizeof(buffer));
1928 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1929 params[1] = OSSL_PARAM_construct_end();
1930 if (!EVP_PKEY_get_params(pkey, params)) {
1931 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1933 buf_sz = params[0].return_size;
1935 * If it failed because the buffer was too small then allocate the
1936 * required buffer size and retry.
1938 buf = OPENSSL_zalloc(buf_sz);
1941 params[0].data = buf;
1942 params[0].data_size = buf_sz;
1944 if (!EVP_PKEY_get_params(pkey, params))
1947 /* Fail if the param was not found */
1948 if (!OSSL_PARAM_modified(params))
1950 ret = OSSL_PARAM_get_BN(params, bn);
1956 int EVP_PKEY_get_octet_string_param(const EVP_PKEY *pkey, const char *key_name,
1957 unsigned char *buf, size_t max_buf_sz,
1960 OSSL_PARAM params[2];
1961 int ret1 = 0, ret2 = 0;
1963 if (key_name == NULL
1965 || !evp_pkey_is_provided(pkey))
1968 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1969 params[1] = OSSL_PARAM_construct_end();
1970 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
1971 ret2 = OSSL_PARAM_modified(params);
1972 if (ret2 && out_sz != NULL)
1973 *out_sz = params[0].return_size;
1974 return ret1 && ret2;
1977 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY *pkey, const char *key_name,
1978 char *str, size_t max_buf_sz,
1981 OSSL_PARAM params[2];
1982 int ret1 = 0, ret2 = 0;
1984 if (key_name == NULL)
1987 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
1988 params[1] = OSSL_PARAM_construct_end();
1989 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
1990 ret2 = OSSL_PARAM_modified(params);
1991 if (ret2 && out_sz != NULL)
1992 *out_sz = params[0].return_size;
1993 return ret1 && ret2;
1996 int EVP_PKEY_get_int_param(const EVP_PKEY *pkey, const char *key_name,
1999 OSSL_PARAM params[2];
2001 if (key_name == NULL)
2004 params[0] = OSSL_PARAM_construct_int(key_name, out);
2005 params[1] = OSSL_PARAM_construct_end();
2006 return EVP_PKEY_get_params(pkey, params)
2007 && OSSL_PARAM_modified(params);
2010 int EVP_PKEY_get_size_t_param(const EVP_PKEY *pkey, const char *key_name,
2013 OSSL_PARAM params[2];
2015 if (key_name == NULL)
2018 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2019 params[1] = OSSL_PARAM_construct_end();
2020 return EVP_PKEY_get_params(pkey, params)
2021 && OSSL_PARAM_modified(params);
2024 int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in)
2026 OSSL_PARAM params[2];
2028 if (key_name == NULL)
2031 params[0] = OSSL_PARAM_construct_int(key_name, &in);
2032 params[1] = OSSL_PARAM_construct_end();
2033 return EVP_PKEY_set_params(pkey, params);
2036 int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in)
2038 OSSL_PARAM params[2];
2040 if (key_name == NULL)
2043 params[0] = OSSL_PARAM_construct_size_t(key_name, &in);
2044 params[1] = OSSL_PARAM_construct_end();
2045 return EVP_PKEY_set_params(pkey, params);
2048 int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
2051 OSSL_PARAM params[2];
2052 unsigned char buffer[2048];
2055 if (key_name == NULL
2058 || !evp_pkey_is_assigned(pkey))
2061 bsize = BN_num_bytes(bn);
2062 if (!ossl_assert(bsize <= (int)sizeof(buffer)))
2065 if (BN_bn2nativepad(bn, buffer, bsize) < 0)
2067 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, bsize);
2068 params[1] = OSSL_PARAM_construct_end();
2069 return EVP_PKEY_set_params(pkey, params);
2072 int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
2075 OSSL_PARAM params[2];
2077 if (key_name == NULL)
2080 params[0] = OSSL_PARAM_construct_utf8_string(key_name, (char *)str, 0);
2081 params[1] = OSSL_PARAM_construct_end();
2082 return EVP_PKEY_set_params(pkey, params);
2085 int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
2086 const unsigned char *buf, size_t bsize)
2088 OSSL_PARAM params[2];
2090 if (key_name == NULL)
2093 params[0] = OSSL_PARAM_construct_octet_string(key_name,
2094 (unsigned char *)buf, bsize);
2095 params[1] = OSSL_PARAM_construct_end();
2096 return EVP_PKEY_set_params(pkey, params);
2099 const OSSL_PARAM *EVP_PKEY_settable_params(const EVP_PKEY *pkey)
2101 return (pkey != NULL && evp_pkey_is_provided(pkey))
2102 ? EVP_KEYMGMT_settable_params(pkey->keymgmt)
2106 int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[])
2109 if (evp_pkey_is_provided(pkey)) {
2111 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
2116 * We will hopefully never find the need to set individual data in
2117 * EVP_PKEYs with a legacy internal key, but we can't be entirely
2118 * sure. This bit of code can be enabled if we find the need. If
2119 * not, it can safely be removed when #legacy support is removed.
2122 else if (evp_pkey_is_legacy(pkey)) {
2123 return evp_pkey_set_params_to_ctrl(pkey, params);
2128 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2132 const OSSL_PARAM *EVP_PKEY_gettable_params(const EVP_PKEY *pkey)
2134 return (pkey != NULL && evp_pkey_is_provided(pkey))
2135 ? EVP_KEYMGMT_gettable_params(pkey->keymgmt)
2139 int EVP_PKEY_get_params(const EVP_PKEY *pkey, OSSL_PARAM params[])
2142 if (evp_pkey_is_provided(pkey))
2143 return evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params);
2145 else if (evp_pkey_is_legacy(pkey))
2146 return evp_pkey_get_params_to_ctrl(pkey, params);
2149 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2154 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey)
2162 if (pkey->keymgmt == NULL
2163 || pkey->keydata == NULL) {
2164 #ifndef OPENSSL_NO_EC
2165 /* Might work through the legacy route */
2166 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2171 return EC_KEY_get_conv_form(ec);
2177 if (!EVP_PKEY_get_utf8_string_param(pkey,
2178 OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
2179 name, sizeof(name), &name_len))
2182 if (strcmp(name, "uncompressed") == 0)
2183 return POINT_CONVERSION_UNCOMPRESSED;
2185 if (strcmp(name, "compressed") == 0)
2186 return POINT_CONVERSION_COMPRESSED;
2188 if (strcmp(name, "hybrid") == 0)
2189 return POINT_CONVERSION_HYBRID;
2194 int EVP_PKEY_get_field_type(const EVP_PKEY *pkey)
2202 if (pkey->keymgmt == NULL
2203 || pkey->keydata == NULL) {
2204 #ifndef OPENSSL_NO_EC
2205 /* Might work through the legacy route */
2206 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2207 const EC_GROUP *grp;
2211 grp = EC_KEY_get0_group(ec);
2215 return EC_GROUP_get_field_type(grp);
2221 if (!EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_EC_FIELD_TYPE,
2222 fstr, sizeof(fstr), &fstrlen))
2225 if (strcmp(fstr, SN_X9_62_prime_field) == 0)
2226 return NID_X9_62_prime_field;
2227 else if (strcmp(fstr, SN_X9_62_characteristic_two_field))
2228 return NID_X9_62_characteristic_two_field;