2 * Copyright 1995-2020 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"
17 #include "internal/cryptlib.h"
18 #include "internal/refcount.h"
19 #include <openssl/bn.h>
20 #include <openssl/err.h>
21 #include <openssl/objects.h>
22 #include <openssl/evp.h>
23 #include <openssl/x509.h>
24 #include <openssl/rsa.h>
25 #include <openssl/dsa.h>
26 #include <openssl/dh.h>
27 #include <openssl/ec.h>
28 #include <openssl/cmac.h>
29 #include <openssl/engine.h>
30 #include <openssl/params.h>
31 #include <openssl/param_build.h>
32 #include <openssl/encoder.h>
33 #include <openssl/core_names.h>
35 #include "crypto/asn1.h"
36 #include "crypto/evp.h"
37 #include "crypto/ecx.h"
38 #include "internal/evp.h"
39 #include "internal/provider.h"
40 #include "evp_local.h"
41 DEFINE_STACK_OF(X509_ATTRIBUTE)
43 #include "crypto/ec.h"
45 /* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
46 #include "e_os.h" /* strcasecmp on Windows */
48 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
49 int len, EVP_KEYMGMT *keymgmt);
50 static void evp_pkey_free_it(EVP_PKEY *key);
54 /* The type of parameters selected in key parameter functions */
55 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
57 int EVP_PKEY_bits(const EVP_PKEY *pkey)
60 if (pkey->ameth == NULL)
61 return pkey->cache.bits;
62 else if (pkey->ameth->pkey_bits)
63 return pkey->ameth->pkey_bits(pkey);
68 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
72 if (pkey->ameth == NULL)
73 return pkey->cache.security_bits;
74 if (pkey->ameth->pkey_security_bits == NULL)
76 return pkey->ameth->pkey_security_bits(pkey);
79 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
81 # ifndef OPENSSL_NO_DSA
82 if (pkey->type == EVP_PKEY_DSA) {
83 int ret = pkey->save_parameters;
86 pkey->save_parameters = mode;
90 # ifndef OPENSSL_NO_EC
91 if (pkey->type == EVP_PKEY_EC) {
92 int ret = pkey->save_parameters;
95 pkey->save_parameters = mode;
102 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
104 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
107 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
109 return CRYPTO_get_ex_data(&key->ex_data, idx);
112 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
115 * TODO: clean up legacy stuff from this function when legacy support
120 * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
121 * If that fails, this function fails.
123 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from))
124 if (!evp_pkey_downgrade((EVP_PKEY *)from))
128 * Make sure |to| is typed. Content is less important at this early
131 * 1. If |to| is untyped, assign |from|'s key type to it.
132 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
133 * (|from| was already downgraded above)
135 * If |to| is a provided key, there's nothing more to do here, functions
136 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
137 * further down help us find out if they are the same or not.
139 if (evp_pkey_is_blank(to)) {
140 if (evp_pkey_is_legacy(from)) {
141 if (EVP_PKEY_set_type(to, from->type) == 0)
144 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
147 } else if (evp_pkey_is_legacy(to)) {
148 if (to->type != from->type) {
149 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
154 if (EVP_PKEY_missing_parameters(from)) {
155 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
159 if (!EVP_PKEY_missing_parameters(to)) {
160 if (EVP_PKEY_parameters_eq(to, from) == 1)
162 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
166 /* For purely provided keys, we just call the keymgmt utility */
167 if (to->keymgmt != NULL && from->keymgmt != NULL)
168 return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
171 * If |to| is provided, we know that |from| is legacy at this point.
172 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
173 * to copy the appropriate data to |to|'s keydata.
175 if (to->keymgmt != NULL) {
176 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
178 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
182 * If we get a NULL, it could be an internal error, or it could be
183 * that there's a key mismatch. We're pretending the latter...
185 if (from_keydata == NULL) {
186 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
189 return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
193 /* Both keys are legacy */
194 if (from->ameth != NULL && from->ameth->param_copy != NULL)
195 return from->ameth->param_copy(to, from);
200 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
203 if (pkey->keymgmt != NULL)
204 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
205 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
206 return pkey->ameth->param_missing(pkey);
212 * This function is called for any mixture of keys except pure legacy pair.
213 * TODO When legacy keys are gone, we replace a call to this functions with
214 * a call to evp_keymgmt_util_match().
216 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
219 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
220 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
222 /* If none of them are provided, this function shouldn't have been called */
223 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
226 /* For purely provided keys, we just call the keymgmt utility */
227 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
228 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
231 * At this point, one of them is provided, the other not. This allows
232 * us to compare types using legacy NIDs.
234 if (evp_pkey_is_legacy(a)
235 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
236 return -1; /* not the same key type */
237 if (evp_pkey_is_legacy(b)
238 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
239 return -1; /* not the same key type */
242 * We've determined that they both are the same keytype, so the next
243 * step is to do a bit of cross export to ensure we have keydata for
244 * both keys in the same keymgmt.
246 keymgmt1 = a->keymgmt;
247 keydata1 = a->keydata;
248 keymgmt2 = b->keymgmt;
249 keydata2 = b->keydata;
251 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
253 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
254 if (tmp_keydata != NULL) {
256 keydata1 = tmp_keydata;
259 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
261 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
262 if (tmp_keydata != NULL) {
264 keydata2 = tmp_keydata;
268 /* If we still don't have matching keymgmt implementations, we give up */
269 if (keymgmt1 != keymgmt2)
272 /* If the keymgmt implementations are NULL, the export failed */
273 if (keymgmt1 == NULL)
276 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
279 #ifndef OPENSSL_NO_DEPRECATED_3_0
280 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
282 return EVP_PKEY_parameters_eq(a, b);
286 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
289 * TODO: clean up legacy stuff from this function when legacy support
293 if (a->keymgmt != NULL || b->keymgmt != NULL)
294 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
296 /* All legacy keys */
297 if (a->type != b->type)
299 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
300 return a->ameth->param_cmp(a, b);
304 #ifndef OPENSSL_NO_DEPRECATED_3_0
305 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
307 return EVP_PKEY_eq(a, b);
311 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
314 * TODO: clean up legacy stuff from this function when legacy support
318 if (a->keymgmt != NULL || b->keymgmt != NULL)
319 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
320 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
322 /* All legacy keys */
323 if (a->type != b->type)
326 if (a->ameth != NULL) {
328 /* Compare parameters if the algorithm has them */
329 if (a->ameth->param_cmp != NULL) {
330 ret = a->ameth->param_cmp(a, b);
335 if (a->ameth->pub_cmp != NULL)
336 return a->ameth->pub_cmp(a, b);
343 static EVP_PKEY *new_raw_key_int(OPENSSL_CTX *libctx,
348 const unsigned char *key,
352 EVP_PKEY *pkey = NULL;
353 EVP_PKEY_CTX *ctx = NULL;
354 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
357 # ifndef OPENSSL_NO_ENGINE
358 /* Check if there is an Engine for this type */
363 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
364 else if (nidtype != EVP_PKEY_NONE)
365 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
367 /* If tmpe is NULL then no engine is claiming to support this type */
375 if (e == NULL && ameth == NULL) {
377 * No engine is claiming to support this type, so lets see if we have
380 ctx = EVP_PKEY_CTX_new_from_name(libctx,
381 strtype != NULL ? strtype
382 : OBJ_nid2sn(nidtype),
386 /* May fail if no provider available */
388 if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
389 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
391 ERR_clear_last_mark();
392 params[0] = OSSL_PARAM_construct_octet_string(
393 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
394 : OSSL_PKEY_PARAM_PUB_KEY,
397 if (EVP_PKEY_fromdata(ctx, &pkey, params) != 1) {
398 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
402 EVP_PKEY_CTX_free(ctx);
407 /* else not supported so fallback to legacy */
410 /* Legacy code path */
412 pkey = EVP_PKEY_new();
414 EVPerr(0, ERR_R_MALLOC_FAILURE);
418 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
419 /* EVPerr already called */
423 if (!ossl_assert(pkey->ameth != NULL))
427 if (pkey->ameth->set_priv_key == NULL) {
428 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
432 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
433 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
437 if (pkey->ameth->set_pub_key == NULL) {
438 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
442 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
443 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
454 EVP_PKEY_CTX_free(ctx);
458 EVP_PKEY *EVP_PKEY_new_raw_private_key_with_libctx(OPENSSL_CTX *libctx,
461 const unsigned char *priv,
464 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
468 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
469 const unsigned char *priv,
472 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
475 EVP_PKEY *EVP_PKEY_new_raw_public_key_with_libctx(OPENSSL_CTX *libctx,
478 const unsigned char *pub,
481 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
485 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
486 const unsigned char *pub,
489 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
492 struct raw_key_details_st
499 static OSSL_CALLBACK get_raw_key_details;
500 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
502 const OSSL_PARAM *p = NULL;
503 struct raw_key_details_st *raw_key = arg;
505 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
506 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
508 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
509 SIZE_MAX, raw_key->len);
510 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
511 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
513 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
514 SIZE_MAX, raw_key->len);
520 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
523 if (pkey->keymgmt != NULL) {
524 struct raw_key_details_st raw_key;
526 raw_key.key = priv == NULL ? NULL : &priv;
528 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
530 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
531 OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
532 get_raw_key_details, &raw_key);
535 if (pkey->ameth == NULL) {
536 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
540 if (pkey->ameth->get_priv_key == NULL) {
541 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
545 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
546 EVPerr(0, EVP_R_GET_RAW_KEY_FAILED);
553 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
556 if (pkey->keymgmt != NULL) {
557 struct raw_key_details_st raw_key;
559 raw_key.key = pub == NULL ? NULL : &pub;
561 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
563 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
564 OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
565 get_raw_key_details, &raw_key);
568 if (pkey->ameth == NULL) {
569 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
573 if (pkey->ameth->get_pub_key == NULL) {
574 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
575 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
579 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
580 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
587 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
588 const char *cipher_name,
589 const EVP_CIPHER *cipher, OPENSSL_CTX *libctx,
590 const char *propq, ENGINE *e)
592 # ifndef OPENSSL_NO_CMAC
593 # ifndef OPENSSL_NO_ENGINE
594 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
596 OSSL_PARAM params[5], *p = params;
597 EVP_PKEY *pkey = NULL;
601 cipher_name = EVP_CIPHER_name(cipher);
603 if (cipher_name == NULL) {
604 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
608 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
612 if (!EVP_PKEY_key_fromdata_init(ctx)) {
613 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
617 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
619 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
620 (char *)cipher_name, 0);
622 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
624 # ifndef OPENSSL_NO_ENGINE
625 if (engine_id != NULL)
626 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
627 (char *)engine_id, 0);
629 *p = OSSL_PARAM_construct_end();
631 if (!EVP_PKEY_fromdata(ctx, &pkey, params)) {
632 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
637 EVP_PKEY_CTX_free(ctx);
641 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
646 EVP_PKEY *EVP_PKEY_new_CMAC_key_with_libctx(const unsigned char *priv,
648 const char *cipher_name,
652 return new_cmac_key_int(priv, len, cipher_name, NULL, libctx, propq, NULL);
655 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
656 size_t len, const EVP_CIPHER *cipher)
658 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
661 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
663 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
666 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
668 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
671 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
673 if (pkey->type == type) {
674 return 1; /* it already is that type */
678 * The application is requesting to alias this to a different pkey type,
679 * but not one that resolves to the base type.
681 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
682 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
690 # ifndef OPENSSL_NO_ENGINE
691 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
694 if (!ENGINE_init(e)) {
695 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
698 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
700 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, 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)
714 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
718 #ifndef OPENSSL_NO_EC
719 if (EVP_PKEY_type(type) == EVP_PKEY_EC) {
720 const EC_GROUP *group = EC_KEY_get0_group(key);
722 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
723 alias = EVP_PKEY_SM2;
727 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
729 if (!EVP_PKEY_set_alias_type(pkey, alias))
731 pkey->pkey.ptr = key;
732 return (key != NULL);
735 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
739 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
740 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
743 return pkey->pkey.ptr;
746 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
748 ASN1_OCTET_STRING *os = NULL;
749 if (pkey->type != EVP_PKEY_HMAC) {
750 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
753 os = EVP_PKEY_get0(pkey);
758 # ifndef OPENSSL_NO_POLY1305
759 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
761 ASN1_OCTET_STRING *os = NULL;
762 if (pkey->type != EVP_PKEY_POLY1305) {
763 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
766 os = EVP_PKEY_get0(pkey);
772 # ifndef OPENSSL_NO_SIPHASH
773 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
775 ASN1_OCTET_STRING *os = NULL;
777 if (pkey->type != EVP_PKEY_SIPHASH) {
778 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
781 os = EVP_PKEY_get0(pkey);
787 # ifndef OPENSSL_NO_RSA
788 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
790 int ret = EVP_PKEY_assign_RSA(pkey, key);
796 RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
798 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
799 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
802 if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
803 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
806 return pkey->pkey.rsa;
809 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
811 RSA *ret = EVP_PKEY_get0_RSA(pkey);
818 # ifndef OPENSSL_NO_DSA
819 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
821 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
822 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
825 if (pkey->type != EVP_PKEY_DSA) {
826 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
829 return pkey->pkey.dsa;
832 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
834 int ret = EVP_PKEY_assign_DSA(pkey, key);
839 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
841 DSA *ret = EVP_PKEY_get0_DSA(pkey);
846 # endif /* OPENSSL_NO_DSA */
847 #endif /* FIPS_MODULE */
850 # ifndef OPENSSL_NO_EC
851 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
853 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
859 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
861 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
862 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
865 if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
866 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
869 return pkey->pkey.ec;
872 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
874 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
880 static int EVP_PKEY_set1_ECX_KEY(EVP_PKEY *pkey, int type, ECX_KEY *key)
882 int ret = EVP_PKEY_assign(pkey, type, key);
888 static ECX_KEY *EVP_PKEY_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
890 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
891 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
894 if (EVP_PKEY_base_id(pkey) != type) {
895 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
898 return pkey->pkey.ecx;
901 static ECX_KEY *EVP_PKEY_get1_ECX_KEY(EVP_PKEY *pkey, int type)
903 ECX_KEY *ret = EVP_PKEY_get0_ECX_KEY(pkey, type);
909 # define IMPLEMENT_ECX_VARIANT(NAME) \
910 int EVP_PKEY_set1_##NAME(EVP_PKEY *pkey, ECX_KEY *key) \
912 return EVP_PKEY_set1_ECX_KEY(pkey, EVP_PKEY_##NAME, key); \
914 ECX_KEY *EVP_PKEY_get0_##NAME(const EVP_PKEY *pkey) \
916 return EVP_PKEY_get0_ECX_KEY(pkey, EVP_PKEY_##NAME); \
918 ECX_KEY *EVP_PKEY_get1_##NAME(EVP_PKEY *pkey) \
920 return EVP_PKEY_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
922 IMPLEMENT_ECX_VARIANT(X25519)
923 IMPLEMENT_ECX_VARIANT(X448)
924 IMPLEMENT_ECX_VARIANT(ED25519)
925 IMPLEMENT_ECX_VARIANT(ED448)
929 # ifndef OPENSSL_NO_DH
931 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
933 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
934 int ret = EVP_PKEY_assign(pkey, type, key);
941 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
943 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
944 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
947 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
948 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
951 return pkey->pkey.dh;
954 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
956 DH *ret = EVP_PKEY_get0_DH(pkey);
963 int EVP_PKEY_type(int type)
966 const EVP_PKEY_ASN1_METHOD *ameth;
968 ameth = EVP_PKEY_asn1_find(&e, type);
970 ret = ameth->pkey_id;
973 # ifndef OPENSSL_NO_ENGINE
979 int EVP_PKEY_id(const EVP_PKEY *pkey)
984 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
986 return EVP_PKEY_type(pkey->type);
990 int evp_pkey_name2type(const char *name)
993 * These hard coded cases are pure hackery to get around the fact
994 * that names in crypto/objects/objects.txt are a mess. There is
995 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
996 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
997 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
998 * "DSA" is accurate... but still, better be safe and hard-code
999 * names that we know.
1000 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
1001 * EVP_PKEY_EC, because of aliasing.
1002 * TODO Clean this away along with all other #legacy support.
1004 int type = NID_undef;
1006 if (strcasecmp(name, "RSA") == 0)
1007 type = EVP_PKEY_RSA;
1008 else if (strcasecmp(name, "RSA-PSS") == 0)
1009 type = EVP_PKEY_RSA_PSS;
1010 else if (strcasecmp(name, "EC") == 0)
1012 else if (strcasecmp(name, "ED25519") == 0)
1013 type = EVP_PKEY_ED25519;
1014 else if (strcasecmp(name, "ED448") == 0)
1015 type = EVP_PKEY_ED448;
1016 else if (strcasecmp(name, "X25519") == 0)
1017 type = EVP_PKEY_X25519;
1018 else if (strcasecmp(name, "X448") == 0)
1019 type = EVP_PKEY_X448;
1020 else if (strcasecmp(name, "SM2") == 0)
1021 type = EVP_PKEY_SM2;
1022 else if (strcasecmp(name, "DH") == 0)
1024 else if (strcasecmp(name, "X9.42 DH") == 0)
1025 type = EVP_PKEY_DHX;
1026 else if (strcasecmp(name, "DSA") == 0)
1027 type = EVP_PKEY_DSA;
1029 if (type == NID_undef)
1030 type = EVP_PKEY_type(OBJ_sn2nid(name));
1031 if (type == NID_undef)
1032 type = EVP_PKEY_type(OBJ_ln2nid(name));
1038 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
1041 if (pkey->keymgmt == NULL) {
1042 int type = evp_pkey_name2type(name);
1044 return pkey->type == type;
1047 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
1050 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1052 if (pkey->keymgmt == NULL) {
1053 switch (EVP_PKEY_base_id(pkey)) {
1056 #ifndef OPENSSL_NO_DSA
1060 #ifndef OPENSSL_NO_EC
1061 case EVP_PKEY_ED25519:
1062 case EVP_PKEY_ED448:
1064 case EVP_PKEY_EC: /* Including SM2 */
1065 return EC_KEY_can_sign(pkey->pkey.ec);
1071 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1072 OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
1073 const char *supported_sig =
1074 pkey->keymgmt->query_operation_name != NULL
1075 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1076 : evp_first_name(prov, pkey->keymgmt->name_id);
1077 EVP_SIGNATURE *signature = NULL;
1079 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1080 if (signature != NULL) {
1081 EVP_SIGNATURE_free(signature);
1088 #ifndef OPENSSL_NO_EC
1090 * TODO rewrite when we have proper data extraction functions
1091 * Note: an octet pointer would be desirable!
1093 static OSSL_CALLBACK get_ec_curve_name_cb;
1094 static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
1096 const OSSL_PARAM *p = NULL;
1098 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME)) != NULL)
1099 return OSSL_PARAM_get_utf8_string(p, arg, 0);
1101 /* If there is no curve name, this is not an EC key */
1105 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
1107 int ret = NID_undef;
1109 if (pkey->keymgmt == NULL) {
1110 if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
1111 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1113 ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1115 } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
1116 char *curve_name = NULL;
1118 ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
1119 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
1120 get_ec_curve_name_cb, &curve_name);
1122 ret = ec_curve_name2nid(curve_name);
1123 OPENSSL_free(curve_name);
1130 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1132 BIO_set_indent(*out, saved_indent);
1134 BIO *next = BIO_pop(*out);
1142 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1148 long i = BIO_get_indent(*out);
1150 *saved_indent = (i < 0 ? 0 : i);
1151 if (BIO_set_indent(*out, indent) <= 0) {
1152 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1156 if (BIO_set_indent(*out, indent) <= 0) {
1157 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1164 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1167 return BIO_indent(out, indent, 128)
1168 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1169 kstr, OBJ_nid2ln(pkey->type)) > 0;
1172 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1173 const char *propquery /* For provided encoding */,
1174 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1175 int indent, ASN1_PCTX *pctx),
1176 ASN1_PCTX *legacy_pctx /* For legacy print */)
1180 OSSL_ENCODER_CTX *ctx = NULL;
1181 int ret = -2; /* default to unsupported */
1183 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1186 ctx = OSSL_ENCODER_CTX_new_by_EVP_PKEY(pkey, propquery);
1187 if (OSSL_ENCODER_CTX_get_encoder(ctx) != NULL)
1188 ret = OSSL_ENCODER_to_bio(ctx, out);
1189 OSSL_ENCODER_CTX_free(ctx);
1194 /* legacy fallback */
1195 if (legacy_print != NULL)
1196 ret = legacy_print(out, pkey, 0, legacy_pctx);
1198 ret = unsup_alg(out, pkey, 0, "Public Key");
1201 print_reset_indent(&out, pop_f_prefix, saved_indent);
1205 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1206 int indent, ASN1_PCTX *pctx)
1208 return print_pkey(pkey, out, indent, OSSL_ENCODER_PUBKEY_TO_TEXT_PQ,
1209 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1213 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1214 int indent, ASN1_PCTX *pctx)
1216 return print_pkey(pkey, out, indent, OSSL_ENCODER_PrivateKey_TO_TEXT_PQ,
1217 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1221 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1222 int indent, ASN1_PCTX *pctx)
1224 return print_pkey(pkey, out, indent, OSSL_ENCODER_Parameters_TO_TEXT_PQ,
1225 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1229 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1230 int arg1, void *arg2)
1232 if (pkey->keymgmt == NULL)
1235 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1237 char mdname[80] = "";
1238 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1244 nid = OBJ_sn2nid(mdname);
1245 if (nid == NID_undef)
1246 nid = OBJ_ln2nid(mdname);
1256 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1258 if (pkey->ameth == NULL)
1259 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1260 if (pkey->ameth->pkey_ctrl == NULL)
1262 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1265 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1267 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1270 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1271 char *mdname, size_t mdname_sz)
1273 if (pkey->ameth == NULL)
1274 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1279 int nid = NID_undef;
1280 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1281 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1284 OPENSSL_strlcpy(mdname, name, mdname_sz);
1289 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1291 int rv, default_nid;
1293 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1296 * If there is a mandatory default digest and this isn't it, then
1297 * the answer is 'no'.
1299 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1301 return (nid == default_nid);
1302 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1309 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
1310 const unsigned char *pt, size_t ptlen)
1312 if (pkey->ameth == NULL) {
1313 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1315 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1319 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1320 (unsigned char *)pt, ptlen);
1321 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
1324 if (ptlen > INT_MAX)
1326 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
1332 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
1336 if (pkey->ameth == NULL) {
1337 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1339 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1343 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1345 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1348 *ppt = OPENSSL_malloc(params[0].return_size);
1353 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1354 *ppt, params[0].return_size);
1355 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1358 return params[0].return_size;
1362 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
1368 #endif /* FIPS_MODULE */
1370 /*- All methods below can also be used in FIPS_MODULE */
1372 static int evp_pkey_reset_unlocked(EVP_PKEY *pk)
1377 memset(pk, 0, sizeof(*pk));
1378 pk->type = EVP_PKEY_NONE;
1379 pk->save_type = EVP_PKEY_NONE;
1381 pk->save_parameters = 1;
1385 EVP_PKEY *EVP_PKEY_new(void)
1387 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1390 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1394 if (!evp_pkey_reset_unlocked(ret))
1397 ret->lock = CRYPTO_THREAD_lock_new();
1398 if (ret->lock == NULL) {
1399 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1403 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1404 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1411 CRYPTO_THREAD_lock_free(ret->lock);
1417 * Setup a public key management method.
1419 * For legacy keys, either |type| or |str| is expected to have the type
1420 * information. In this case, the setup consists of finding an ASN1 method
1421 * and potentially an ENGINE, and setting those fields in |pkey|.
1423 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1424 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1426 * If pkey is NULL just return 1 or 0 if the key management method exists.
1429 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1430 int len, EVP_KEYMGMT *keymgmt)
1433 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1434 ENGINE **eptr = (e == NULL) ? &e : NULL;
1438 * The setups can't set both legacy and provider side methods.
1441 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1442 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1443 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1451 free_it = free_it || pkey->pkey.ptr != NULL;
1453 free_it = free_it || pkey->keydata != NULL;
1455 evp_pkey_free_it(pkey);
1458 * If key type matches and a method exists then this lookup has
1459 * succeeded once so just indicate success.
1461 if (pkey->type != EVP_PKEY_NONE
1462 && type == pkey->save_type
1463 && pkey->ameth != NULL)
1465 # ifndef OPENSSL_NO_ENGINE
1466 /* If we have ENGINEs release them */
1467 ENGINE_finish(pkey->engine);
1468 pkey->engine = NULL;
1469 ENGINE_finish(pkey->pmeth_engine);
1470 pkey->pmeth_engine = NULL;
1476 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1477 else if (type != EVP_PKEY_NONE)
1478 ameth = EVP_PKEY_asn1_find(eptr, type);
1479 # ifndef OPENSSL_NO_ENGINE
1480 if (pkey == NULL && eptr != NULL)
1490 check = check && ameth == NULL;
1492 check = check && keymgmt == NULL;
1494 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
1499 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1500 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1504 pkey->keymgmt = keymgmt;
1506 pkey->save_type = type;
1511 * If the internal "origin" key is provider side, don't save |ameth|.
1512 * The main reason is that |ameth| is one factor to detect that the
1513 * internal "origin" key is a legacy one.
1515 if (keymgmt == NULL)
1516 pkey->ameth = ameth;
1520 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1521 * for any key type that has a legacy implementation, regardless of
1522 * if the internal key is a legacy or a provider side one. When
1523 * there is no legacy implementation for the key, the type becomes
1524 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1525 * with functions that expect legacy internal keys.
1528 pkey->type = ameth->pkey_id;
1530 pkey->type = EVP_PKEY_KEYMGMT;
1537 static void find_ameth(const char *name, void *data)
1539 const char **str = data;
1542 * The error messages from pkey_set_type() are uninteresting here,
1547 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1551 else if (str[1] == NULL)
1559 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1562 # define EVP_PKEY_TYPE_STR str[0]
1563 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1565 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1566 * Ideally, only one should be found. If two (or more) are found, the
1567 * match is ambiguous. This should never happen, but...
1569 const char *str[2] = { NULL, NULL };
1571 EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1572 if (str[1] != NULL) {
1573 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1577 # define EVP_PKEY_TYPE_STR NULL
1578 # define EVP_PKEY_TYPE_STRLEN -1
1580 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1581 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1584 #undef EVP_PKEY_TYPE_STR
1585 #undef EVP_PKEY_TYPE_STRLEN
1588 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1592 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1595 REF_PRINT_COUNT("EVP_PKEY", pkey);
1596 REF_ASSERT_ISNT(i < 2);
1597 return ((i > 1) ? 1 : 0);
1601 void evp_pkey_free_legacy(EVP_PKEY *x)
1603 if (x->ameth != NULL) {
1604 if (x->ameth->pkey_free != NULL)
1605 x->ameth->pkey_free(x);
1608 # ifndef OPENSSL_NO_ENGINE
1609 ENGINE_finish(x->engine);
1611 ENGINE_finish(x->pmeth_engine);
1612 x->pmeth_engine = NULL;
1615 #endif /* FIPS_MODULE */
1617 static void evp_pkey_free_it(EVP_PKEY *x)
1619 /* internal function; x is never NULL */
1621 evp_keymgmt_util_clear_operation_cache(x);
1623 evp_pkey_free_legacy(x);
1626 if (x->keymgmt != NULL) {
1627 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1628 EVP_KEYMGMT_free(x->keymgmt);
1632 x->type = EVP_PKEY_NONE;
1635 void EVP_PKEY_free(EVP_PKEY *x)
1642 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1643 REF_PRINT_COUNT("EVP_PKEY", x);
1646 REF_ASSERT_ISNT(i < 0);
1647 evp_pkey_free_it(x);
1649 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1651 CRYPTO_THREAD_lock_free(x->lock);
1653 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1658 int EVP_PKEY_size(const EVP_PKEY *pkey)
1663 size = pkey->cache.size;
1665 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1666 size = pkey->ameth->pkey_size(pkey);
1672 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
1673 EVP_KEYMGMT **keymgmt,
1674 const char *propquery)
1676 EVP_KEYMGMT *allocated_keymgmt = NULL;
1677 EVP_KEYMGMT *tmp_keymgmt = NULL;
1678 void *keydata = NULL;
1684 /* No key data => nothing to export */
1687 check = check && pk->pkey.ptr == NULL;
1689 check = check && pk->keydata == NULL;
1694 if (pk->pkey.ptr != NULL) {
1696 * If the legacy key doesn't have an dirty counter or export function,
1699 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1704 if (keymgmt != NULL) {
1705 tmp_keymgmt = *keymgmt;
1710 * If no keymgmt was given or found, get a default keymgmt. We do so by
1711 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1713 if (tmp_keymgmt == NULL) {
1714 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1716 tmp_keymgmt = ctx->keymgmt;
1717 ctx->keymgmt = NULL;
1718 EVP_PKEY_CTX_free(ctx);
1721 /* If there's still no keymgmt to be had, give up */
1722 if (tmp_keymgmt == NULL)
1726 if (pk->pkey.ptr != NULL) {
1730 * If the legacy "origin" hasn't changed since last time, we try
1731 * to find our keymgmt in the operation cache. If it has changed,
1732 * |i| remains zero, and we will clear the cache further down.
1734 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1735 i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1738 * If |tmp_keymgmt| is present in the operation cache, it means
1739 * that export doesn't need to be redone. In that case, we take
1740 * token copies of the cached pointers, to have token success
1743 if (i < OSSL_NELEM(pk->operation_cache)
1744 && pk->operation_cache[i].keymgmt != NULL) {
1745 keydata = pk->operation_cache[i].keydata;
1751 * TODO(3.0) Right now, we assume we have ample space. We will have
1752 * to think about a cache aging scheme, though, if |i| indexes outside
1755 if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1758 /* Make sure that the keymgmt key type matches the legacy NID */
1759 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1762 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1765 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1766 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1772 * If the dirty counter changed since last time, then clear the
1773 * operation cache. In that case, we know that |i| is zero. Just
1774 * in case this is a re-export, we increment then decrement the
1775 * keymgmt reference counter.
1777 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1778 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1782 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1783 evp_keymgmt_util_clear_operation_cache(pk);
1784 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1786 /* Add the new export to the operation cache */
1787 if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1788 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1793 /* Synchronize the dirty count */
1794 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1797 #endif /* FIPS_MODULE */
1799 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1803 * If nothing was exported, |tmp_keymgmt| might point at a freed
1804 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1805 * the caller either way in that case.
1807 if (keydata == NULL)
1810 if (keymgmt != NULL)
1811 *keymgmt = tmp_keymgmt;
1813 EVP_KEYMGMT_free(allocated_keymgmt);
1818 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1820 if (!ossl_assert(dest != NULL))
1823 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1824 EVP_KEYMGMT *keymgmt = src->keymgmt;
1825 void *keydata = src->keydata;
1826 int type = src->type;
1827 const char *keytype = NULL;
1829 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
1833 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1834 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1835 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1836 * TODO(3.0) remove this check when we're confident that the rest
1837 * of the code treats this correctly.
1839 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1840 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1841 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1846 /* Prefer the legacy key type name for error reporting */
1847 if (type != EVP_PKEY_KEYMGMT)
1848 keytype = OBJ_nid2sn(type);
1850 /* Make sure we have a clean slate to copy into */
1852 *dest = EVP_PKEY_new();
1854 evp_pkey_free_it(*dest);
1856 if (EVP_PKEY_set_type(*dest, type)) {
1857 /* If the key is typed but empty, we're done */
1858 if (keydata == NULL)
1861 if ((*dest)->ameth->import_from == NULL) {
1862 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1863 "key type = %s", keytype);
1866 * We perform the export in the same libctx as the keymgmt
1867 * that we are using.
1869 OPENSSL_CTX *libctx =
1870 ossl_provider_library_context(keymgmt->prov);
1871 EVP_PKEY_CTX *pctx =
1872 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
1875 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1878 && evp_keymgmt_export(keymgmt, keydata,
1879 OSSL_KEYMGMT_SELECT_ALL,
1880 (*dest)->ameth->import_from,
1882 /* Synchronize the dirty count */
1883 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
1885 EVP_PKEY_CTX_free(pctx);
1888 EVP_PKEY_CTX_free(pctx);
1891 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1892 "key type = %s", keytype);
1899 int evp_pkey_downgrade(EVP_PKEY *pk)
1901 EVP_PKEY tmp_copy; /* Stack allocated! */
1903 /* If this isn't an assigned provider side key, we're done */
1904 if (!evp_pkey_is_assigned(pk) || !evp_pkey_is_provided(pk))
1908 * To be able to downgrade, we steal the contents of |pk|, then reset
1909 * it, and finally try to make it a downgraded copy. If any of that
1910 * fails, we restore the copied contents into |pk|.
1914 if (evp_pkey_reset_unlocked(pk)
1915 && evp_pkey_copy_downgraded(&pk, &tmp_copy)) {
1916 /* Restore the common attributes, then empty |tmp_copy| */
1917 pk->references = tmp_copy.references;
1918 pk->lock = tmp_copy.lock;
1919 pk->attributes = tmp_copy.attributes;
1920 pk->save_parameters = tmp_copy.save_parameters;
1921 pk->ex_data = tmp_copy.ex_data;
1923 /* Ensure that stuff we've copied won't be freed */
1924 tmp_copy.lock = NULL;
1925 tmp_copy.attributes = NULL;
1926 memset(&tmp_copy.ex_data, 0, sizeof(tmp_copy.ex_data));
1929 * Save the provider side data in the operation cache, so they'll
1930 * find it again. |pk| is new, so it's safe to assume slot zero
1932 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1933 * reference count, so we need to decrement it, or there will be a
1936 evp_keymgmt_util_cache_keydata(pk, 0, tmp_copy.keymgmt,
1938 EVP_KEYMGMT_free(tmp_copy.keymgmt);
1941 * Clear keymgmt and keydata from |tmp_copy|, or they'll get
1942 * inadvertently freed.
1944 tmp_copy.keymgmt = NULL;
1945 tmp_copy.keydata = NULL;
1947 evp_pkey_free_it(&tmp_copy);
1955 #endif /* FIPS_MODULE */
1957 const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
1960 || pkey->keymgmt == NULL
1961 || pkey->keydata == NULL)
1963 return EVP_KEYMGMT_gettable_params(pkey->keymgmt);
1966 int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
1969 OSSL_PARAM params[2];
1970 unsigned char buffer[2048];
1971 unsigned char *buf = NULL;
1975 || pkey->keymgmt == NULL
1976 || pkey->keydata == NULL
1981 memset(buffer, 0, sizeof(buffer));
1982 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1983 params[1] = OSSL_PARAM_construct_end();
1984 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
1985 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1987 buf_sz = params[0].return_size;
1989 * If it failed because the buffer was too small then allocate the
1990 * required buffer size and retry.
1992 buf = OPENSSL_zalloc(buf_sz);
1995 params[0].data = buf;
1996 params[0].data_size = buf_sz;
1998 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
2001 /* Fail if the param was not found */
2002 if (!OSSL_PARAM_modified(params))
2004 ret = OSSL_PARAM_get_BN(params, bn);
2010 int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
2011 unsigned char *buf, size_t max_buf_sz,
2014 OSSL_PARAM params[2];
2017 || pkey->keymgmt == NULL
2018 || pkey->keydata == NULL
2019 || key_name == NULL)
2022 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
2023 params[1] = OSSL_PARAM_construct_end();
2024 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2025 || !OSSL_PARAM_modified(params))
2028 *out_sz = params[0].return_size;
2032 int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
2033 char *str, size_t max_buf_sz,
2036 OSSL_PARAM params[2];
2039 || pkey->keymgmt == NULL
2040 || pkey->keydata == NULL
2041 || key_name == NULL)
2044 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2045 params[1] = OSSL_PARAM_construct_end();
2046 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2047 || !OSSL_PARAM_modified(params))
2050 *out_sz = params[0].return_size;
2054 int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
2056 OSSL_PARAM params[2];
2059 || pkey->keymgmt == NULL
2060 || pkey->keydata == NULL
2061 || key_name == NULL)
2064 params[0] = OSSL_PARAM_construct_int(key_name, out);
2065 params[1] = OSSL_PARAM_construct_end();
2066 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2067 || !OSSL_PARAM_modified(params))
2072 int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
2074 OSSL_PARAM params[2];
2077 || pkey->keymgmt == NULL
2078 || pkey->keydata == NULL
2079 || key_name == NULL)
2082 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2083 params[1] = OSSL_PARAM_construct_end();
2084 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2085 || !OSSL_PARAM_modified(params))