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/serializer.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),
385 EVPerr(0, ERR_R_MALLOC_FAILURE);
388 /* May fail if no provider available */
390 if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
391 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
393 ERR_clear_last_mark();
394 params[0] = OSSL_PARAM_construct_octet_string(
395 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
396 : OSSL_PKEY_PARAM_PUB_KEY,
399 if (EVP_PKEY_fromdata(ctx, &pkey, params) != 1) {
400 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
404 EVP_PKEY_CTX_free(ctx);
409 /* else not supported so fallback to legacy */
412 /* Legacy code path */
414 pkey = EVP_PKEY_new();
416 EVPerr(0, ERR_R_MALLOC_FAILURE);
420 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
421 /* EVPerr already called */
425 if (!ossl_assert(pkey->ameth != NULL))
429 if (pkey->ameth->set_priv_key == NULL) {
430 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
434 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
435 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
439 if (pkey->ameth->set_pub_key == NULL) {
440 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
444 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
445 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
456 EVP_PKEY_CTX_free(ctx);
460 EVP_PKEY *EVP_PKEY_new_raw_private_key_with_libctx(OPENSSL_CTX *libctx,
463 const unsigned char *priv,
466 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
470 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
471 const unsigned char *priv,
474 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
477 EVP_PKEY *EVP_PKEY_new_raw_public_key_with_libctx(OPENSSL_CTX *libctx,
480 const unsigned char *pub,
483 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
487 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
488 const unsigned char *pub,
491 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
494 struct raw_key_details_st
501 static OSSL_CALLBACK get_raw_key_details;
502 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
504 const OSSL_PARAM *p = NULL;
505 struct raw_key_details_st *raw_key = arg;
507 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
508 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
510 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
511 SIZE_MAX, raw_key->len);
512 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
513 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
515 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
516 SIZE_MAX, raw_key->len);
522 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
525 if (pkey->keymgmt != NULL) {
526 struct raw_key_details_st raw_key;
528 raw_key.key = priv == NULL ? NULL : &priv;
530 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
532 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
533 OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
534 get_raw_key_details, &raw_key);
537 if (pkey->ameth == NULL) {
538 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
542 if (pkey->ameth->get_priv_key == NULL) {
543 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
547 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
548 EVPerr(0, EVP_R_GET_RAW_KEY_FAILED);
555 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
558 if (pkey->keymgmt != NULL) {
559 struct raw_key_details_st raw_key;
561 raw_key.key = pub == NULL ? NULL : &pub;
563 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
565 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
566 OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
567 get_raw_key_details, &raw_key);
570 if (pkey->ameth == NULL) {
571 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
575 if (pkey->ameth->get_pub_key == NULL) {
576 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
577 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
581 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
582 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
589 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
590 size_t len, const EVP_CIPHER *cipher)
592 # ifndef OPENSSL_NO_CMAC
593 # ifndef OPENSSL_NO_ENGINE
594 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
596 const char *cipher_name = EVP_CIPHER_name(cipher);
597 const OSSL_PROVIDER *prov = EVP_CIPHER_provider(cipher);
598 OPENSSL_CTX *libctx =
599 prov == NULL ? NULL : ossl_provider_library_context(prov);
600 EVP_PKEY *ret = EVP_PKEY_new();
601 EVP_MAC *cmac = EVP_MAC_fetch(libctx, OSSL_MAC_NAME_CMAC, NULL);
602 EVP_MAC_CTX *cmctx = cmac != NULL ? EVP_MAC_CTX_new(cmac) : NULL;
603 OSSL_PARAM params[4];
608 || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1, NULL)) {
609 /* EVPerr already called */
613 # ifndef OPENSSL_NO_ENGINE
614 if (engine_id != NULL)
616 OSSL_PARAM_construct_utf8_string("engine", (char *)engine_id, 0);
620 OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
621 (char *)cipher_name, 0);
623 OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
625 params[paramsn] = OSSL_PARAM_construct_end();
627 if (!EVP_MAC_CTX_set_params(cmctx, params)) {
628 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
632 ret->pkey.ptr = cmctx;
637 EVP_MAC_CTX_free(cmctx);
641 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
642 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
647 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
649 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
652 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
654 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
657 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
659 if (pkey->type == type) {
660 return 1; /* it already is that type */
664 * The application is requesting to alias this to a different pkey type,
665 * but not one that resolves to the base type.
667 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
668 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
676 # ifndef OPENSSL_NO_ENGINE
677 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
680 if (!ENGINE_init(e)) {
681 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
684 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
686 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
690 ENGINE_finish(pkey->pmeth_engine);
691 pkey->pmeth_engine = e;
695 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
700 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
704 #ifndef OPENSSL_NO_EC
705 if (EVP_PKEY_type(type) == EVP_PKEY_EC) {
706 const EC_GROUP *group = EC_KEY_get0_group(key);
708 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
709 alias = EVP_PKEY_SM2;
713 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
715 if (!EVP_PKEY_set_alias_type(pkey, alias))
717 pkey->pkey.ptr = key;
718 return (key != NULL);
721 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
723 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
724 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
727 return pkey->pkey.ptr;
730 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
732 ASN1_OCTET_STRING *os = NULL;
733 if (pkey->type != EVP_PKEY_HMAC) {
734 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
737 os = EVP_PKEY_get0(pkey);
742 # ifndef OPENSSL_NO_POLY1305
743 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
745 ASN1_OCTET_STRING *os = NULL;
746 if (pkey->type != EVP_PKEY_POLY1305) {
747 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
750 os = EVP_PKEY_get0(pkey);
756 # ifndef OPENSSL_NO_SIPHASH
757 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
759 ASN1_OCTET_STRING *os = NULL;
761 if (pkey->type != EVP_PKEY_SIPHASH) {
762 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
765 os = EVP_PKEY_get0(pkey);
771 # ifndef OPENSSL_NO_RSA
772 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
774 int ret = EVP_PKEY_assign_RSA(pkey, key);
780 RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
782 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
783 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
786 if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
787 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
790 return pkey->pkey.rsa;
793 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
795 RSA *ret = EVP_PKEY_get0_RSA(pkey);
802 # ifndef OPENSSL_NO_DSA
803 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
805 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
806 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
809 if (pkey->type != EVP_PKEY_DSA) {
810 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
813 return pkey->pkey.dsa;
816 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
818 int ret = EVP_PKEY_assign_DSA(pkey, key);
823 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
825 DSA *ret = EVP_PKEY_get0_DSA(pkey);
830 # endif /* OPENSSL_NO_DSA */
831 #endif /* FIPS_MODULE */
834 # ifndef OPENSSL_NO_EC
835 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
837 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
843 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
845 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
846 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
849 if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
850 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
853 return pkey->pkey.ec;
856 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
858 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
864 static int EVP_PKEY_set1_ECX_KEY(EVP_PKEY *pkey, int type, ECX_KEY *key)
866 int ret = EVP_PKEY_assign(pkey, type, key);
872 static ECX_KEY *EVP_PKEY_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
874 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
875 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
878 if (EVP_PKEY_base_id(pkey) != type) {
879 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
882 return pkey->pkey.ecx;
885 static ECX_KEY *EVP_PKEY_get1_ECX_KEY(EVP_PKEY *pkey, int type)
887 ECX_KEY *ret = EVP_PKEY_get0_ECX_KEY(pkey, type);
893 # define IMPLEMENT_ECX_VARIANT(NAME) \
894 int EVP_PKEY_set1_##NAME(EVP_PKEY *pkey, ECX_KEY *key) \
896 return EVP_PKEY_set1_ECX_KEY(pkey, EVP_PKEY_##NAME, key); \
898 ECX_KEY *EVP_PKEY_get0_##NAME(const EVP_PKEY *pkey) \
900 return EVP_PKEY_get0_ECX_KEY(pkey, EVP_PKEY_##NAME); \
902 ECX_KEY *EVP_PKEY_get1_##NAME(EVP_PKEY *pkey) \
904 return EVP_PKEY_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
906 IMPLEMENT_ECX_VARIANT(X25519)
907 IMPLEMENT_ECX_VARIANT(X448)
908 IMPLEMENT_ECX_VARIANT(ED25519)
909 IMPLEMENT_ECX_VARIANT(ED448)
913 # ifndef OPENSSL_NO_DH
915 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
917 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
918 int ret = EVP_PKEY_assign(pkey, type, key);
925 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
927 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
928 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
931 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
932 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
935 return pkey->pkey.dh;
938 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
940 DH *ret = EVP_PKEY_get0_DH(pkey);
947 int EVP_PKEY_type(int type)
950 const EVP_PKEY_ASN1_METHOD *ameth;
952 ameth = EVP_PKEY_asn1_find(&e, type);
954 ret = ameth->pkey_id;
957 # ifndef OPENSSL_NO_ENGINE
963 int EVP_PKEY_id(const EVP_PKEY *pkey)
968 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
970 return EVP_PKEY_type(pkey->type);
973 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
976 if (pkey->keymgmt == NULL) {
978 * These hard coded cases are pure hackery to get around the fact
979 * that names in crypto/objects/objects.txt are a mess. There is
980 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
981 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
982 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
983 * "DSA" is accurate... but still, better be safe and hard-code
984 * names that we know.
985 * TODO Clean this away along with all other #legacy support.
989 if (strcasecmp(name, "RSA") == 0)
991 else if (strcasecmp(name, "RSA-PSS") == 0)
992 type = EVP_PKEY_RSA_PSS;
993 #ifndef OPENSSL_NO_EC
994 else if (strcasecmp(name, "EC") == 0)
996 else if (strcasecmp(name, "ED25519") == 0)
997 type = EVP_PKEY_ED25519;
998 else if (strcasecmp(name, "ED448") == 0)
999 type = EVP_PKEY_ED448;
1000 else if (strcasecmp(name, "X25519") == 0)
1001 type = EVP_PKEY_X25519;
1002 else if (strcasecmp(name, "X448") == 0)
1003 type = EVP_PKEY_X448;
1005 #ifndef OPENSSL_NO_DH
1006 else if (strcasecmp(name, "DH") == 0)
1008 else if (strcasecmp(name, "X9.42 DH") == 0)
1009 type = EVP_PKEY_DHX;
1011 #ifndef OPENSSL_NO_DSA
1012 else if (strcasecmp(name, "DSA") == 0)
1013 type = EVP_PKEY_DSA;
1016 type = EVP_PKEY_type(OBJ_sn2nid(name));
1017 return EVP_PKEY_type(pkey->type) == type;
1020 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
1023 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1025 if (pkey->keymgmt == NULL) {
1026 switch (EVP_PKEY_base_id(pkey)) {
1029 #ifndef OPENSSL_NO_DSA
1033 #ifndef OPENSSL_NO_EC
1034 case EVP_PKEY_ED25519:
1035 case EVP_PKEY_ED448:
1037 case EVP_PKEY_EC: /* Including SM2 */
1038 return EC_KEY_can_sign(pkey->pkey.ec);
1044 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1045 OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
1046 const char *supported_sig =
1047 pkey->keymgmt->query_operation_name != NULL
1048 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1049 : evp_first_name(prov, pkey->keymgmt->name_id);
1050 EVP_SIGNATURE *signature = NULL;
1052 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1053 if (signature != NULL) {
1054 EVP_SIGNATURE_free(signature);
1061 #ifndef OPENSSL_NO_EC
1063 * TODO rewrite when we have proper data extraction functions
1064 * Note: an octet pointer would be desirable!
1066 static OSSL_CALLBACK get_ec_curve_name_cb;
1067 static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
1069 const OSSL_PARAM *p = NULL;
1071 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME)) != NULL)
1072 return OSSL_PARAM_get_utf8_string(p, arg, 0);
1074 /* If there is no curve name, this is not an EC key */
1078 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
1080 int ret = NID_undef;
1082 if (pkey->keymgmt == NULL) {
1083 if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
1084 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1086 ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1088 } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
1089 char *curve_name = NULL;
1091 ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
1092 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
1093 get_ec_curve_name_cb, &curve_name);
1095 ret = ec_curve_name2nid(curve_name);
1096 OPENSSL_free(curve_name);
1103 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1105 BIO_set_indent(*out, saved_indent);
1107 BIO *next = BIO_pop(*out);
1115 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1121 long i = BIO_get_indent(*out);
1123 *saved_indent = (i < 0 ? 0 : i);
1124 if (BIO_set_indent(*out, indent) <= 0) {
1125 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1129 if (BIO_set_indent(*out, indent) <= 0) {
1130 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1137 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1140 return BIO_indent(out, indent, 128)
1141 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1142 kstr, OBJ_nid2ln(pkey->type)) > 0;
1145 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1146 const char *propquery /* For provided serialization */,
1147 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1148 int indent, ASN1_PCTX *pctx),
1149 ASN1_PCTX *legacy_pctx /* For legacy print */)
1153 OSSL_SERIALIZER_CTX *ctx = NULL;
1154 int ret = -2; /* default to unsupported */
1156 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1159 ctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, propquery);
1160 if (OSSL_SERIALIZER_CTX_get_serializer(ctx) != NULL)
1161 ret = OSSL_SERIALIZER_to_bio(ctx, out);
1162 OSSL_SERIALIZER_CTX_free(ctx);
1167 /* legacy fallback */
1168 if (legacy_print != NULL)
1169 ret = legacy_print(out, pkey, 0, legacy_pctx);
1171 ret = unsup_alg(out, pkey, 0, "Public Key");
1174 print_reset_indent(&out, pop_f_prefix, saved_indent);
1178 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1179 int indent, ASN1_PCTX *pctx)
1181 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PUBKEY_TO_TEXT_PQ,
1182 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1186 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1187 int indent, ASN1_PCTX *pctx)
1189 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PrivateKey_TO_TEXT_PQ,
1190 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1194 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1195 int indent, ASN1_PCTX *pctx)
1197 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_Parameters_TO_TEXT_PQ,
1198 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1202 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1203 int arg1, void *arg2)
1205 if (pkey->keymgmt == NULL)
1208 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1210 char mdname[80] = "";
1211 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1217 nid = OBJ_sn2nid(mdname);
1218 if (nid == NID_undef)
1219 nid = OBJ_ln2nid(mdname);
1229 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1231 if (pkey->ameth == NULL)
1232 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1233 if (pkey->ameth->pkey_ctrl == NULL)
1235 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1238 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1240 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1243 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1244 char *mdname, size_t mdname_sz)
1246 if (pkey->ameth == NULL)
1247 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1252 int nid = NID_undef;
1253 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1254 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1257 OPENSSL_strlcpy(mdname, name, mdname_sz);
1262 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1264 int rv, default_nid;
1266 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1269 * If there is a mandatory default digest and this isn't it, then
1270 * the answer is 'no'.
1272 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1274 return (nid == default_nid);
1275 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1282 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
1283 const unsigned char *pt, size_t ptlen)
1285 if (pkey->ameth == NULL) {
1286 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1288 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1292 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1293 (unsigned char *)pt, ptlen);
1294 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
1297 if (ptlen > INT_MAX)
1299 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
1305 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
1309 if (pkey->ameth == NULL) {
1310 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1312 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1316 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1318 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1321 *ppt = OPENSSL_malloc(params[0].return_size);
1326 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1327 *ppt, params[0].return_size);
1328 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1331 return params[0].return_size;
1335 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
1341 #endif /* FIPS_MODULE */
1343 /*- All methods below can also be used in FIPS_MODULE */
1345 EVP_PKEY *EVP_PKEY_new(void)
1347 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1350 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1353 ret->type = EVP_PKEY_NONE;
1354 ret->save_type = EVP_PKEY_NONE;
1355 ret->references = 1;
1356 ret->save_parameters = 1;
1357 ret->lock = CRYPTO_THREAD_lock_new();
1358 if (ret->lock == NULL) {
1359 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1363 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1364 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1371 CRYPTO_THREAD_lock_free(ret->lock);
1377 * Setup a public key management method.
1379 * For legacy keys, either |type| or |str| is expected to have the type
1380 * information. In this case, the setup consists of finding an ASN1 method
1381 * and potentially an ENGINE, and setting those fields in |pkey|.
1383 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1384 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1386 * If pkey is NULL just return 1 or 0 if the key management method exists.
1389 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1390 int len, EVP_KEYMGMT *keymgmt)
1393 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1394 ENGINE **eptr = (e == NULL) ? &e : NULL;
1398 * The setups can't set both legacy and provider side methods.
1401 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1402 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1403 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1411 free_it = free_it || pkey->pkey.ptr != NULL;
1413 free_it = free_it || pkey->keydata != NULL;
1415 evp_pkey_free_it(pkey);
1418 * If key type matches and a method exists then this lookup has
1419 * succeeded once so just indicate success.
1421 if (pkey->type != EVP_PKEY_NONE
1422 && type == pkey->save_type
1423 && pkey->ameth != NULL)
1425 # ifndef OPENSSL_NO_ENGINE
1426 /* If we have ENGINEs release them */
1427 ENGINE_finish(pkey->engine);
1428 pkey->engine = NULL;
1429 ENGINE_finish(pkey->pmeth_engine);
1430 pkey->pmeth_engine = NULL;
1436 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1437 else if (type != EVP_PKEY_NONE)
1438 ameth = EVP_PKEY_asn1_find(eptr, type);
1439 # ifndef OPENSSL_NO_ENGINE
1440 if (pkey == NULL && eptr != NULL)
1450 check = check && ameth == NULL;
1452 check = check && keymgmt == NULL;
1454 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
1459 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1460 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1464 pkey->keymgmt = keymgmt;
1466 pkey->save_type = type;
1471 * If the internal "origin" key is provider side, don't save |ameth|.
1472 * The main reason is that |ameth| is one factor to detect that the
1473 * internal "origin" key is a legacy one.
1475 if (keymgmt == NULL)
1476 pkey->ameth = ameth;
1480 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1481 * for any key type that has a legacy implementation, regardless of
1482 * if the internal key is a legacy or a provider side one. When
1483 * there is no legacy implementation for the key, the type becomes
1484 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1485 * with functions that expect legacy internal keys.
1488 pkey->type = ameth->pkey_id;
1490 pkey->type = EVP_PKEY_KEYMGMT;
1497 static void find_ameth(const char *name, void *data)
1499 const char **str = data;
1502 * The error messages from pkey_set_type() are uninteresting here,
1507 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1511 else if (str[1] == NULL)
1519 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1522 # define EVP_PKEY_TYPE_STR str[0]
1523 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1525 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1526 * Ideally, only one should be found. If two (or more) are found, the
1527 * match is ambiguous. This should never happen, but...
1529 const char *str[2] = { NULL, NULL };
1531 EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1532 if (str[1] != NULL) {
1533 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1537 # define EVP_PKEY_TYPE_STR NULL
1538 # define EVP_PKEY_TYPE_STRLEN -1
1540 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1541 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1544 #undef EVP_PKEY_TYPE_STR
1545 #undef EVP_PKEY_TYPE_STRLEN
1548 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1552 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1555 REF_PRINT_COUNT("EVP_PKEY", pkey);
1556 REF_ASSERT_ISNT(i < 2);
1557 return ((i > 1) ? 1 : 0);
1561 void evp_pkey_free_legacy(EVP_PKEY *x)
1563 if (x->ameth != NULL) {
1564 if (x->ameth->pkey_free != NULL)
1565 x->ameth->pkey_free(x);
1568 # ifndef OPENSSL_NO_ENGINE
1569 ENGINE_finish(x->engine);
1571 ENGINE_finish(x->pmeth_engine);
1572 x->pmeth_engine = NULL;
1575 #endif /* FIPS_MODULE */
1577 static void evp_pkey_free_it(EVP_PKEY *x)
1579 /* internal function; x is never NULL */
1581 evp_keymgmt_util_clear_operation_cache(x);
1583 evp_pkey_free_legacy(x);
1586 if (x->keymgmt != NULL) {
1587 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1588 EVP_KEYMGMT_free(x->keymgmt);
1592 x->type = EVP_PKEY_NONE;
1595 void EVP_PKEY_free(EVP_PKEY *x)
1602 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1603 REF_PRINT_COUNT("EVP_PKEY", x);
1606 REF_ASSERT_ISNT(i < 0);
1607 evp_pkey_free_it(x);
1609 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1611 CRYPTO_THREAD_lock_free(x->lock);
1613 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1618 int EVP_PKEY_size(const EVP_PKEY *pkey)
1623 size = pkey->cache.size;
1625 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1626 size = pkey->ameth->pkey_size(pkey);
1632 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
1633 EVP_KEYMGMT **keymgmt,
1634 const char *propquery)
1636 EVP_KEYMGMT *allocated_keymgmt = NULL;
1637 EVP_KEYMGMT *tmp_keymgmt = NULL;
1638 void *keydata = NULL;
1644 /* No key data => nothing to export */
1647 check = check && pk->pkey.ptr == NULL;
1649 check = check && pk->keydata == NULL;
1654 if (pk->pkey.ptr != NULL) {
1656 * If the legacy key doesn't have an dirty counter or export function,
1659 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1664 if (keymgmt != NULL) {
1665 tmp_keymgmt = *keymgmt;
1670 * If no keymgmt was given or found, get a default keymgmt. We do so by
1671 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1673 if (tmp_keymgmt == NULL) {
1674 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1676 tmp_keymgmt = ctx->keymgmt;
1677 ctx->keymgmt = NULL;
1678 EVP_PKEY_CTX_free(ctx);
1681 /* If there's still no keymgmt to be had, give up */
1682 if (tmp_keymgmt == NULL)
1686 if (pk->pkey.ptr != NULL) {
1690 * If the legacy "origin" hasn't changed since last time, we try
1691 * to find our keymgmt in the operation cache. If it has changed,
1692 * |i| remains zero, and we will clear the cache further down.
1694 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1695 i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1698 * If |tmp_keymgmt| is present in the operation cache, it means
1699 * that export doesn't need to be redone. In that case, we take
1700 * token copies of the cached pointers, to have token success
1703 if (i < OSSL_NELEM(pk->operation_cache)
1704 && pk->operation_cache[i].keymgmt != NULL) {
1705 keydata = pk->operation_cache[i].keydata;
1711 * TODO(3.0) Right now, we assume we have ample space. We will have
1712 * to think about a cache aging scheme, though, if |i| indexes outside
1715 if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1718 /* Make sure that the keymgmt key type matches the legacy NID */
1719 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1722 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1725 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1726 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1732 * If the dirty counter changed since last time, then clear the
1733 * operation cache. In that case, we know that |i| is zero. Just
1734 * in case this is a re-export, we increment then decrement the
1735 * keymgmt reference counter.
1737 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1738 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1742 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1743 evp_keymgmt_util_clear_operation_cache(pk);
1744 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1746 /* Add the new export to the operation cache */
1747 if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1748 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1753 /* Synchronize the dirty count */
1754 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1757 #endif /* FIPS_MODULE */
1759 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1763 * If nothing was exported, |tmp_keymgmt| might point at a freed
1764 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1765 * the caller either way in that case.
1767 if (keydata == NULL)
1770 if (keymgmt != NULL)
1771 *keymgmt = tmp_keymgmt;
1773 EVP_KEYMGMT_free(allocated_keymgmt);
1778 int evp_pkey_downgrade(EVP_PKEY *pk)
1780 EVP_KEYMGMT *keymgmt = pk->keymgmt;
1781 void *keydata = pk->keydata;
1782 int type = pk->type;
1783 const char *keytype = NULL;
1785 /* If this isn't a provider side key, we're done */
1786 if (keymgmt == NULL)
1789 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
1792 * If the type is EVP_PKEY_NONE, then we have a problem somewhere else
1793 * in our code. If it's not one of the well known EVP_PKEY_xxx values,
1794 * it should at least be EVP_PKEY_KEYMGMT at this point.
1795 * TODO(3.0) remove this check when we're confident that the rest of the
1796 * code treats this correctly.
1798 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1799 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1800 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1805 /* Prefer the legacy key type name for error reporting */
1806 if (type != EVP_PKEY_KEYMGMT)
1807 keytype = OBJ_nid2sn(type);
1810 * To be able to downgrade, we steal the provider side "origin" keymgmt
1811 * and keydata. We've already grabbed the pointers, so all we need to
1812 * do is clear those pointers in |pk| and then call evp_pkey_free_it().
1813 * That way, we can restore |pk| if we need to.
1817 evp_pkey_free_it(pk);
1818 if (EVP_PKEY_set_type(pk, type)) {
1819 /* If the key is typed but empty, we're done */
1820 if (keydata == NULL) {
1821 /* We're dropping the EVP_KEYMGMT */
1822 EVP_KEYMGMT_free(keymgmt);
1826 if (pk->ameth->import_from == NULL) {
1827 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1828 "key type = %s", keytype);
1831 * We perform the export in the same libctx as the keymgmt that we
1834 OPENSSL_CTX *libctx = ossl_provider_library_context(keymgmt->prov);
1835 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, NULL);
1837 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1840 && evp_keymgmt_export(keymgmt, keydata,
1841 OSSL_KEYMGMT_SELECT_ALL,
1842 pk->ameth->import_from, pctx)) {
1844 * Save the provider side data in the operation cache, so they'll
1845 * find it again. evp_pkey_free_it() cleared the cache, so it's
1846 * safe to assume slot zero is free.
1847 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1850 evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
1851 EVP_PKEY_CTX_free(pctx);
1853 /* Synchronize the dirty count */
1854 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1856 /* evp_keymgmt_export() increased the refcount... */
1857 EVP_KEYMGMT_free(keymgmt);
1860 EVP_PKEY_CTX_free(pctx);
1863 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1864 "key type = %s", keytype);
1868 * Something went wrong. This could for example happen if the keymgmt
1869 * turns out to be an HSM implementation that refuses to let go of some
1870 * of the key data, typically the private bits. In this case, we restore
1871 * the provider side internal "origin" and leave it at that.
1873 if (!ossl_assert(evp_keymgmt_util_assign_pkey(pk, keymgmt, keydata))) {
1874 /* This should not be impossible */
1875 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1878 /* evp_keymgmt_util_assign_pkey() increased the refcount... */
1879 EVP_KEYMGMT_free(keymgmt);
1880 return 0; /* No downgrade, but at least the key is restored */
1882 #endif /* FIPS_MODULE */
1884 const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
1887 || pkey->keymgmt == NULL
1888 || pkey->keydata == NULL)
1890 return EVP_KEYMGMT_gettable_params(pkey->keymgmt);
1893 int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
1896 OSSL_PARAM params[2];
1897 unsigned char buffer[2048];
1898 unsigned char *buf = NULL;
1902 || pkey->keymgmt == NULL
1903 || pkey->keydata == NULL
1908 memset(buffer, 0, sizeof(buffer));
1909 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1910 params[1] = OSSL_PARAM_construct_end();
1911 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
1912 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1914 buf_sz = params[0].return_size;
1916 * If it failed because the buffer was too small then allocate the
1917 * required buffer size and retry.
1919 buf = OPENSSL_zalloc(buf_sz);
1922 params[0].data = buf;
1923 params[0].data_size = buf_sz;
1925 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1928 /* Fail if the param was not found */
1929 if (!OSSL_PARAM_modified(params))
1931 ret = OSSL_PARAM_get_BN(params, bn);
1937 int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
1938 unsigned char *buf, size_t max_buf_sz,
1941 OSSL_PARAM params[2];
1944 || pkey->keymgmt == NULL
1945 || pkey->keydata == NULL
1946 || key_name == NULL)
1949 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1950 params[1] = OSSL_PARAM_construct_end();
1951 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1952 || !OSSL_PARAM_modified(params))
1955 *out_sz = params[0].return_size;
1959 int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
1960 char *str, size_t max_buf_sz,
1963 OSSL_PARAM params[2];
1966 || pkey->keymgmt == NULL
1967 || pkey->keydata == NULL
1968 || key_name == NULL)
1971 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
1972 params[1] = OSSL_PARAM_construct_end();
1973 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1974 || !OSSL_PARAM_modified(params))
1977 *out_sz = params[0].return_size;
1981 int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
1983 OSSL_PARAM params[2];
1986 || pkey->keymgmt == NULL
1987 || pkey->keydata == NULL
1988 || key_name == NULL)
1991 params[0] = OSSL_PARAM_construct_int(key_name, out);
1992 params[1] = OSSL_PARAM_construct_end();
1993 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1994 || !OSSL_PARAM_modified(params))
1999 int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
2001 OSSL_PARAM params[2];
2004 || pkey->keymgmt == NULL
2005 || pkey->keydata == NULL
2006 || key_name == NULL)
2009 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2010 params[1] = OSSL_PARAM_construct_end();
2011 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2012 || !OSSL_PARAM_modified(params))