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)
720 # ifndef OPENSSL_NO_DEPRECATED_3_0
721 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
725 # ifndef OPENSSL_NO_EC
726 if ((key != NULL) && (EVP_PKEY_type(type) == EVP_PKEY_EC)) {
727 const EC_GROUP *group = EC_KEY_get0_group(key);
729 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
730 alias = EVP_PKEY_SM2;
734 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
736 if (!EVP_PKEY_set_alias_type(pkey, alias))
738 pkey->pkey.ptr = key;
739 return (key != NULL);
743 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
748 if (!evp_pkey_is_provided(pkey))
749 return pkey->pkey.ptr;
754 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
756 const ASN1_OCTET_STRING *os = NULL;
757 if (pkey->type != EVP_PKEY_HMAC) {
758 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_AN_HMAC_KEY);
761 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
769 # ifndef OPENSSL_NO_POLY1305
770 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
772 const ASN1_OCTET_STRING *os = NULL;
773 if (pkey->type != EVP_PKEY_POLY1305) {
774 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_POLY1305_KEY);
777 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
786 # ifndef OPENSSL_NO_SIPHASH
787 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
789 const ASN1_OCTET_STRING *os = NULL;
791 if (pkey->type != EVP_PKEY_SIPHASH) {
792 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_SIPHASH_KEY);
795 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
804 # ifndef OPENSSL_NO_DSA
805 static DSA *evp_pkey_get0_DSA_int(const EVP_PKEY *pkey)
807 if (pkey->type != EVP_PKEY_DSA) {
808 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DSA_KEY);
811 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
814 const DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
816 return evp_pkey_get0_DSA_int(pkey);
819 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
821 int ret = EVP_PKEY_assign_DSA(pkey, key);
826 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
828 DSA *ret = evp_pkey_get0_DSA_int(pkey);
834 # endif /* OPENSSL_NO_DSA */
835 #endif /* FIPS_MODULE */
838 # ifndef OPENSSL_NO_EC
839 static const ECX_KEY *evp_pkey_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
841 if (EVP_PKEY_base_id(pkey) != type) {
842 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
845 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
848 static ECX_KEY *evp_pkey_get1_ECX_KEY(EVP_PKEY *pkey, int type)
850 ECX_KEY *ret = (ECX_KEY *)evp_pkey_get0_ECX_KEY(pkey, type);
852 ossl_ecx_key_up_ref(ret);
856 # define IMPLEMENT_ECX_VARIANT(NAME) \
857 ECX_KEY *ossl_evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
859 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
861 IMPLEMENT_ECX_VARIANT(X25519)
862 IMPLEMENT_ECX_VARIANT(X448)
863 IMPLEMENT_ECX_VARIANT(ED25519)
864 IMPLEMENT_ECX_VARIANT(ED448)
868 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
870 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
872 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
873 int ret = EVP_PKEY_assign(pkey, type, key);
880 DH *evp_pkey_get0_DH_int(const EVP_PKEY *pkey)
882 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
883 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DH_KEY);
886 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
889 const DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
891 return evp_pkey_get0_DH_int(pkey);
894 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
896 DH *ret = evp_pkey_get0_DH_int(pkey);
904 int EVP_PKEY_type(int type)
907 const EVP_PKEY_ASN1_METHOD *ameth;
909 ameth = EVP_PKEY_asn1_find(&e, type);
911 ret = ameth->pkey_id;
914 # ifndef OPENSSL_NO_ENGINE
920 int EVP_PKEY_id(const EVP_PKEY *pkey)
925 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
927 return EVP_PKEY_type(pkey->type);
932 * These hard coded cases are pure hackery to get around the fact
933 * that names in crypto/objects/objects.txt are a mess. There is
934 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
935 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
936 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
937 * "DSA" is accurate... but still, better be safe and hard-code
938 * names that we know.
939 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
940 * EVP_PKEY_EC, because of aliasing.
941 * TODO Clean this away along with all other #legacy support.
943 static const OSSL_ITEM standard_name2type[] = {
944 { EVP_PKEY_RSA, "RSA" },
945 { EVP_PKEY_RSA_PSS, "RSA-PSS" },
946 { EVP_PKEY_EC, "EC" },
947 { EVP_PKEY_ED25519, "ED25519" },
948 { EVP_PKEY_ED448, "ED448" },
949 { EVP_PKEY_X25519, "X25519" },
950 { EVP_PKEY_X448, "X448" },
951 { EVP_PKEY_SM2, "SM2" },
952 { EVP_PKEY_DH, "DH" },
953 { EVP_PKEY_DHX, "X9.42 DH" },
954 { EVP_PKEY_DHX, "DHX" },
955 { EVP_PKEY_DSA, "DSA" },
958 int evp_pkey_name2type(const char *name)
963 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
964 if (strcasecmp(name, standard_name2type[i].ptr) == 0)
965 return (int)standard_name2type[i].id;
968 if ((type = EVP_PKEY_type(OBJ_sn2nid(name))) != NID_undef)
970 return EVP_PKEY_type(OBJ_ln2nid(name));
973 const char *evp_pkey_type2name(int type)
977 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
978 if (type == (int)standard_name2type[i].id)
979 return standard_name2type[i].ptr;
982 return OBJ_nid2sn(type);
986 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
989 if (pkey->keymgmt == NULL) {
990 int type = evp_pkey_name2type(name);
992 return pkey->type == type;
995 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
998 int EVP_PKEY_typenames_do_all(const EVP_PKEY *pkey,
999 void (*fn)(const char *name, void *data),
1002 if (!evp_pkey_is_typed(pkey))
1005 if (!evp_pkey_is_provided(pkey)) {
1006 const char *name = OBJ_nid2sn(EVP_PKEY_id(pkey));
1011 return EVP_KEYMGMT_names_do_all(pkey->keymgmt, fn, data);
1014 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1016 if (pkey->keymgmt == NULL) {
1017 switch (EVP_PKEY_base_id(pkey)) {
1020 #ifndef OPENSSL_NO_DSA
1024 #ifndef OPENSSL_NO_EC
1025 case EVP_PKEY_ED25519:
1026 case EVP_PKEY_ED448:
1028 case EVP_PKEY_EC: /* Including SM2 */
1029 return EC_KEY_can_sign(pkey->pkey.ec);
1035 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1036 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
1037 const char *supported_sig =
1038 pkey->keymgmt->query_operation_name != NULL
1039 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1040 : evp_first_name(prov, pkey->keymgmt->name_id);
1041 EVP_SIGNATURE *signature = NULL;
1043 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1044 if (signature != NULL) {
1045 EVP_SIGNATURE_free(signature);
1052 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1054 BIO_set_indent(*out, saved_indent);
1056 BIO *next = BIO_pop(*out);
1064 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1070 long i = BIO_get_indent(*out);
1072 *saved_indent = (i < 0 ? 0 : i);
1073 if (BIO_set_indent(*out, indent) <= 0) {
1074 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1078 if (BIO_set_indent(*out, indent) <= 0) {
1079 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1086 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1089 return BIO_indent(out, indent, 128)
1090 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1091 kstr, OBJ_nid2ln(pkey->type)) > 0;
1094 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1095 int selection /* For provided encoding */,
1096 const char *propquery /* For provided encoding */,
1097 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1098 int indent, ASN1_PCTX *pctx),
1099 ASN1_PCTX *legacy_pctx /* For legacy print */)
1103 OSSL_ENCODER_CTX *ctx = NULL;
1104 int ret = -2; /* default to unsupported */
1106 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1109 ctx = OSSL_ENCODER_CTX_new_for_pkey(pkey, selection, "TEXT", NULL,
1111 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0)
1112 ret = OSSL_ENCODER_to_bio(ctx, out);
1113 OSSL_ENCODER_CTX_free(ctx);
1118 /* legacy fallback */
1119 if (legacy_print != NULL)
1120 ret = legacy_print(out, pkey, 0, legacy_pctx);
1122 ret = unsup_alg(out, pkey, 0, "Public Key");
1125 print_reset_indent(&out, pop_f_prefix, saved_indent);
1129 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1130 int indent, ASN1_PCTX *pctx)
1132 return print_pkey(pkey, out, indent, EVP_PKEY_PUBLIC_KEY, NULL,
1133 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1137 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1138 int indent, ASN1_PCTX *pctx)
1140 return print_pkey(pkey, out, indent, EVP_PKEY_KEYPAIR, NULL,
1141 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1145 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1146 int indent, ASN1_PCTX *pctx)
1148 return print_pkey(pkey, out, indent, EVP_PKEY_KEY_PARAMETERS, NULL,
1149 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1153 static void mdname2nid(const char *mdname, void *data)
1155 int *nid = (int *)data;
1157 if (*nid != NID_undef)
1160 *nid = OBJ_sn2nid(mdname);
1161 if (*nid == NID_undef)
1162 *nid = OBJ_ln2nid(mdname);
1165 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1166 int arg1, void *arg2)
1168 if (pkey->keymgmt == NULL)
1171 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1173 char mdname[80] = "";
1174 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1179 OSSL_LIB_CTX *libctx = ossl_provider_libctx(pkey->keymgmt->prov);
1180 /* Make sure the MD is in the namemap if available */
1181 EVP_MD *md = EVP_MD_fetch(libctx, mdname, NULL);
1182 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
1183 int nid = NID_undef;
1186 * The only reason to fetch the MD was to make sure it is in the
1187 * namemap. We can immediately free it.
1190 mdnum = ossl_namemap_name2num(namemap, mdname);
1195 * We have the namemap number - now we need to find the
1198 if (!ossl_namemap_doall_names(namemap, mdnum, mdname2nid, &nid))
1209 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1211 if (pkey->ameth == NULL)
1212 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1213 if (pkey->ameth->pkey_ctrl == NULL)
1215 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1218 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1220 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1223 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1224 char *mdname, size_t mdname_sz)
1226 if (pkey->ameth == NULL)
1227 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1232 int nid = NID_undef;
1233 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1234 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1237 OPENSSL_strlcpy(mdname, name, mdname_sz);
1242 int EVP_PKEY_get_group_name(const EVP_PKEY *pkey, char *gname, size_t gname_sz,
1245 return EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_GROUP_NAME,
1246 gname, gname_sz, gname_len);
1249 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1251 int rv, default_nid;
1253 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1256 * If there is a mandatory default digest and this isn't it, then
1257 * the answer is 'no'.
1259 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1261 return (nid == default_nid);
1262 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1269 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, const unsigned char *pub,
1272 if (pkey != NULL && evp_pkey_is_provided(pkey))
1274 EVP_PKEY_set_octet_string_param(pkey,
1275 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1276 (unsigned char *)pub, publen);
1278 if (publen > INT_MAX)
1280 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1281 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, publen,
1287 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub)
1291 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
1292 size_t return_size = OSSL_PARAM_UNMODIFIED;
1295 * We know that this is going to fail, but it will give us a size
1298 EVP_PKEY_get_octet_string_param(pkey,
1299 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1300 NULL, 0, &return_size);
1301 if (return_size == OSSL_PARAM_UNMODIFIED)
1304 *ppub = OPENSSL_malloc(return_size);
1308 if (!EVP_PKEY_get_octet_string_param(pkey,
1309 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1310 *ppub, return_size, NULL))
1316 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppub);
1322 #endif /* FIPS_MODULE */
1324 /*- All methods below can also be used in FIPS_MODULE */
1326 EVP_PKEY *EVP_PKEY_new(void)
1328 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1331 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1335 ret->type = EVP_PKEY_NONE;
1336 ret->save_type = EVP_PKEY_NONE;
1337 ret->references = 1;
1338 ret->save_parameters = 1;
1340 ret->lock = CRYPTO_THREAD_lock_new();
1341 if (ret->lock == NULL) {
1342 EVPerr(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1347 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1348 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1355 CRYPTO_THREAD_lock_free(ret->lock);
1361 * Setup a public key management method.
1363 * For legacy keys, either |type| or |str| is expected to have the type
1364 * information. In this case, the setup consists of finding an ASN1 method
1365 * and potentially an ENGINE, and setting those fields in |pkey|.
1367 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1368 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1370 * If pkey is NULL just return 1 or 0 if the key management method exists.
1373 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1374 int len, EVP_KEYMGMT *keymgmt)
1377 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1378 ENGINE **eptr = (e == NULL) ? &e : NULL;
1382 * The setups can't set both legacy and provider side methods.
1385 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1386 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1387 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1395 free_it = free_it || pkey->pkey.ptr != NULL;
1397 free_it = free_it || pkey->keydata != NULL;
1399 evp_pkey_free_it(pkey);
1402 * If key type matches and a method exists then this lookup has
1403 * succeeded once so just indicate success.
1405 if (pkey->type != EVP_PKEY_NONE
1406 && type == pkey->save_type
1407 && pkey->ameth != NULL)
1409 # ifndef OPENSSL_NO_ENGINE
1410 /* If we have ENGINEs release them */
1411 ENGINE_finish(pkey->engine);
1412 pkey->engine = NULL;
1413 ENGINE_finish(pkey->pmeth_engine);
1414 pkey->pmeth_engine = NULL;
1420 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1421 else if (type != EVP_PKEY_NONE)
1422 ameth = EVP_PKEY_asn1_find(eptr, type);
1423 # ifndef OPENSSL_NO_ENGINE
1424 if (pkey == NULL && eptr != NULL)
1434 check = check && ameth == NULL;
1436 check = check && keymgmt == NULL;
1438 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
1443 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1444 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1448 pkey->keymgmt = keymgmt;
1450 pkey->save_type = type;
1455 * If the internal "origin" key is provider side, don't save |ameth|.
1456 * The main reason is that |ameth| is one factor to detect that the
1457 * internal "origin" key is a legacy one.
1459 if (keymgmt == NULL)
1460 pkey->ameth = ameth;
1464 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1465 * for any key type that has a legacy implementation, regardless of
1466 * if the internal key is a legacy or a provider side one. When
1467 * there is no legacy implementation for the key, the type becomes
1468 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1469 * with functions that expect legacy internal keys.
1472 pkey->type = ameth->pkey_id;
1474 pkey->type = EVP_PKEY_KEYMGMT;
1481 static void find_ameth(const char *name, void *data)
1483 const char **str = data;
1486 * The error messages from pkey_set_type() are uninteresting here,
1491 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1495 else if (str[1] == NULL)
1503 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1506 # define EVP_PKEY_TYPE_STR str[0]
1507 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1509 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1510 * Ideally, only one should be found. If two (or more) are found, the
1511 * match is ambiguous. This should never happen, but...
1513 const char *str[2] = { NULL, NULL };
1515 if (!EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str)
1516 || str[1] != NULL) {
1517 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1521 # define EVP_PKEY_TYPE_STR NULL
1522 # define EVP_PKEY_TYPE_STRLEN -1
1524 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1525 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1528 #undef EVP_PKEY_TYPE_STR
1529 #undef EVP_PKEY_TYPE_STRLEN
1532 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1536 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1539 REF_PRINT_COUNT("EVP_PKEY", pkey);
1540 REF_ASSERT_ISNT(i < 2);
1541 return ((i > 1) ? 1 : 0);
1545 void evp_pkey_free_legacy(EVP_PKEY *x)
1547 const EVP_PKEY_ASN1_METHOD *ameth = x->ameth;
1548 ENGINE *tmpe = NULL;
1550 if (ameth == NULL && x->legacy_cache_pkey.ptr != NULL)
1551 ameth = EVP_PKEY_asn1_find(&tmpe, x->type);
1553 if (ameth != NULL) {
1554 if (x->legacy_cache_pkey.ptr != NULL) {
1556 * We should never have both a legacy origin key, and a key in the
1559 assert(x->pkey.ptr == NULL);
1561 * For the purposes of freeing we make the legacy cache look like
1562 * a legacy origin key.
1564 x->pkey = x->legacy_cache_pkey;
1565 x->legacy_cache_pkey.ptr = NULL;
1567 if (ameth->pkey_free != NULL)
1568 ameth->pkey_free(x);
1571 # ifndef OPENSSL_NO_ENGINE
1572 ENGINE_finish(tmpe);
1573 ENGINE_finish(x->engine);
1575 ENGINE_finish(x->pmeth_engine);
1576 x->pmeth_engine = NULL;
1579 #endif /* FIPS_MODULE */
1581 static void evp_pkey_free_it(EVP_PKEY *x)
1583 /* internal function; x is never NULL */
1584 evp_keymgmt_util_clear_operation_cache(x, 1);
1586 evp_pkey_free_legacy(x);
1589 if (x->keymgmt != NULL) {
1590 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1591 EVP_KEYMGMT_free(x->keymgmt);
1595 x->type = EVP_PKEY_NONE;
1598 void EVP_PKEY_free(EVP_PKEY *x)
1605 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1606 REF_PRINT_COUNT("EVP_PKEY", x);
1609 REF_ASSERT_ISNT(i < 0);
1610 evp_pkey_free_it(x);
1612 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1614 CRYPTO_THREAD_lock_free(x->lock);
1616 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1621 int EVP_PKEY_size(const EVP_PKEY *pkey)
1626 size = pkey->cache.size;
1628 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1629 size = pkey->ameth->pkey_size(pkey);
1632 return size < 0 ? 0 : size;
1635 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OSSL_LIB_CTX *libctx,
1636 EVP_KEYMGMT **keymgmt,
1637 const char *propquery)
1639 EVP_KEYMGMT *allocated_keymgmt = NULL;
1640 EVP_KEYMGMT *tmp_keymgmt = NULL;
1641 void *keydata = NULL;
1647 /* No key data => nothing to export */
1650 check = check && pk->pkey.ptr == NULL;
1652 check = check && pk->keydata == NULL;
1657 if (pk->pkey.ptr != NULL) {
1659 * If the legacy key doesn't have an dirty counter or export function,
1662 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1667 if (keymgmt != NULL) {
1668 tmp_keymgmt = *keymgmt;
1673 * If no keymgmt was given or found, get a default keymgmt. We do so by
1674 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1676 if (tmp_keymgmt == NULL) {
1677 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1679 tmp_keymgmt = ctx->keymgmt;
1680 ctx->keymgmt = NULL;
1681 EVP_PKEY_CTX_free(ctx);
1684 /* If there's still no keymgmt to be had, give up */
1685 if (tmp_keymgmt == NULL)
1689 if (pk->pkey.ptr != NULL) {
1693 * If the legacy "origin" hasn't changed since last time, we try
1694 * to find our keymgmt in the operation cache. If it has changed,
1695 * |i| remains zero, and we will clear the cache further down.
1697 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1698 if (!CRYPTO_THREAD_read_lock(pk->lock))
1700 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1703 * If |tmp_keymgmt| is present in the operation cache, it means
1704 * that export doesn't need to be redone. In that case, we take
1705 * token copies of the cached pointers, to have token success
1708 if (op != NULL && op->keymgmt != NULL) {
1709 keydata = op->keydata;
1710 CRYPTO_THREAD_unlock(pk->lock);
1713 CRYPTO_THREAD_unlock(pk->lock);
1716 /* Make sure that the keymgmt key type matches the legacy NID */
1717 if (!EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type)))
1720 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1723 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1724 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1730 * If the dirty counter changed since last time, then clear the
1731 * operation cache. In that case, we know that |i| is zero. Just
1732 * in case this is a re-export, we increment then decrement the
1733 * keymgmt reference counter.
1735 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1736 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1741 if (!CRYPTO_THREAD_write_lock(pk->lock))
1743 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy
1744 && !evp_keymgmt_util_clear_operation_cache(pk, 0)) {
1745 CRYPTO_THREAD_unlock(pk->lock);
1746 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1748 EVP_KEYMGMT_free(tmp_keymgmt);
1751 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1753 /* Check to make sure some other thread didn't get there first */
1754 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1755 if (op != NULL && op->keymgmt != NULL) {
1756 void *tmp_keydata = op->keydata;
1758 CRYPTO_THREAD_unlock(pk->lock);
1759 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1760 keydata = tmp_keydata;
1764 /* Add the new export to the operation cache */
1765 if (!evp_keymgmt_util_cache_keydata(pk, tmp_keymgmt, keydata)) {
1766 CRYPTO_THREAD_unlock(pk->lock);
1767 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1772 /* Synchronize the dirty count */
1773 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1775 CRYPTO_THREAD_unlock(pk->lock);
1778 #endif /* FIPS_MODULE */
1780 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1784 * If nothing was exported, |tmp_keymgmt| might point at a freed
1785 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1786 * the caller either way in that case.
1788 if (keydata == NULL)
1791 if (keymgmt != NULL)
1792 *keymgmt = tmp_keymgmt;
1794 EVP_KEYMGMT_free(allocated_keymgmt);
1799 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1801 if (!ossl_assert(dest != NULL))
1804 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1805 EVP_KEYMGMT *keymgmt = src->keymgmt;
1806 void *keydata = src->keydata;
1807 int type = src->type;
1808 const char *keytype = NULL;
1810 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
1814 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1815 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1816 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1817 * TODO(3.0) remove this check when we're confident that the rest
1818 * of the code treats this correctly.
1820 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1821 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1822 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1827 /* Prefer the legacy key type name for error reporting */
1828 if (type != EVP_PKEY_KEYMGMT)
1829 keytype = OBJ_nid2sn(type);
1831 /* Make sure we have a clean slate to copy into */
1832 if (*dest == NULL) {
1833 *dest = EVP_PKEY_new();
1834 if (*dest == NULL) {
1835 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1839 evp_pkey_free_it(*dest);
1842 if (EVP_PKEY_set_type(*dest, type)) {
1843 /* If the key is typed but empty, we're done */
1844 if (keydata == NULL)
1847 if ((*dest)->ameth->import_from == NULL) {
1848 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1849 "key type = %s", keytype);
1852 * We perform the export in the same libctx as the keymgmt
1853 * that we are using.
1855 OSSL_LIB_CTX *libctx =
1856 ossl_provider_libctx(keymgmt->prov);
1857 EVP_PKEY_CTX *pctx =
1858 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
1861 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1864 && evp_keymgmt_export(keymgmt, keydata,
1865 OSSL_KEYMGMT_SELECT_ALL,
1866 (*dest)->ameth->import_from,
1868 /* Synchronize the dirty count */
1869 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
1871 EVP_PKEY_CTX_free(pctx);
1874 EVP_PKEY_CTX_free(pctx);
1877 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1878 "key type = %s", keytype);
1885 void *evp_pkey_get_legacy(EVP_PKEY *pk)
1887 EVP_PKEY *tmp_copy = NULL;
1890 if (!ossl_assert(pk != NULL))
1894 * If this isn't an assigned provider side key, we just use any existing
1895 * origin legacy key.
1897 if (!evp_pkey_is_assigned(pk))
1899 if (!evp_pkey_is_provided(pk))
1900 return pk->pkey.ptr;
1902 if (!CRYPTO_THREAD_read_lock(pk->lock))
1905 ret = pk->legacy_cache_pkey.ptr;
1907 if (!CRYPTO_THREAD_unlock(pk->lock))
1913 if (!evp_pkey_copy_downgraded(&tmp_copy, pk))
1916 if (!CRYPTO_THREAD_write_lock(pk->lock))
1919 /* Check again in case some other thread has updated it in the meantime */
1920 ret = pk->legacy_cache_pkey.ptr;
1922 /* Steal the legacy key reference from the temporary copy */
1923 ret = pk->legacy_cache_pkey.ptr = tmp_copy->pkey.ptr;
1924 tmp_copy->pkey.ptr = NULL;
1927 if (!CRYPTO_THREAD_unlock(pk->lock)) {
1933 EVP_PKEY_free(tmp_copy);
1937 #endif /* FIPS_MODULE */
1939 int EVP_PKEY_get_bn_param(const EVP_PKEY *pkey, const char *key_name,
1943 OSSL_PARAM params[2];
1944 unsigned char buffer[2048];
1945 unsigned char *buf = NULL;
1948 if (key_name == NULL
1951 || !evp_pkey_is_provided(pkey))
1954 memset(buffer, 0, sizeof(buffer));
1955 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1956 params[1] = OSSL_PARAM_construct_end();
1957 if (!EVP_PKEY_get_params(pkey, params)) {
1958 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1960 buf_sz = params[0].return_size;
1962 * If it failed because the buffer was too small then allocate the
1963 * required buffer size and retry.
1965 buf = OPENSSL_zalloc(buf_sz);
1968 params[0].data = buf;
1969 params[0].data_size = buf_sz;
1971 if (!EVP_PKEY_get_params(pkey, params))
1974 /* Fail if the param was not found */
1975 if (!OSSL_PARAM_modified(params))
1977 ret = OSSL_PARAM_get_BN(params, bn);
1983 int EVP_PKEY_get_octet_string_param(const EVP_PKEY *pkey, const char *key_name,
1984 unsigned char *buf, size_t max_buf_sz,
1987 OSSL_PARAM params[2];
1988 int ret1 = 0, ret2 = 0;
1990 if (key_name == NULL
1992 || !evp_pkey_is_provided(pkey))
1995 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1996 params[1] = OSSL_PARAM_construct_end();
1997 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
1998 ret2 = OSSL_PARAM_modified(params);
1999 if (ret2 && out_sz != NULL)
2000 *out_sz = params[0].return_size;
2001 return ret1 && ret2;
2004 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY *pkey, const char *key_name,
2005 char *str, size_t max_buf_sz,
2008 OSSL_PARAM params[2];
2009 int ret1 = 0, ret2 = 0;
2011 if (key_name == NULL)
2014 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2015 params[1] = OSSL_PARAM_construct_end();
2016 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2017 ret2 = OSSL_PARAM_modified(params);
2018 if (ret2 && out_sz != NULL)
2019 *out_sz = params[0].return_size;
2020 return ret1 && ret2;
2023 int EVP_PKEY_get_int_param(const EVP_PKEY *pkey, const char *key_name,
2026 OSSL_PARAM params[2];
2028 if (key_name == NULL)
2031 params[0] = OSSL_PARAM_construct_int(key_name, out);
2032 params[1] = OSSL_PARAM_construct_end();
2033 return EVP_PKEY_get_params(pkey, params)
2034 && OSSL_PARAM_modified(params);
2037 int EVP_PKEY_get_size_t_param(const EVP_PKEY *pkey, const char *key_name,
2040 OSSL_PARAM params[2];
2042 if (key_name == NULL)
2045 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2046 params[1] = OSSL_PARAM_construct_end();
2047 return EVP_PKEY_get_params(pkey, params)
2048 && OSSL_PARAM_modified(params);
2051 int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in)
2053 OSSL_PARAM params[2];
2055 if (key_name == NULL)
2058 params[0] = OSSL_PARAM_construct_int(key_name, &in);
2059 params[1] = OSSL_PARAM_construct_end();
2060 return EVP_PKEY_set_params(pkey, params);
2063 int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in)
2065 OSSL_PARAM params[2];
2067 if (key_name == NULL)
2070 params[0] = OSSL_PARAM_construct_size_t(key_name, &in);
2071 params[1] = OSSL_PARAM_construct_end();
2072 return EVP_PKEY_set_params(pkey, params);
2075 int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
2078 OSSL_PARAM params[2];
2079 unsigned char buffer[2048];
2082 if (key_name == NULL
2085 || !evp_pkey_is_assigned(pkey))
2088 bsize = BN_num_bytes(bn);
2089 if (!ossl_assert(bsize <= (int)sizeof(buffer)))
2092 if (BN_bn2nativepad(bn, buffer, bsize) < 0)
2094 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, bsize);
2095 params[1] = OSSL_PARAM_construct_end();
2096 return EVP_PKEY_set_params(pkey, params);
2099 int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
2102 OSSL_PARAM params[2];
2104 if (key_name == NULL)
2107 params[0] = OSSL_PARAM_construct_utf8_string(key_name, (char *)str, 0);
2108 params[1] = OSSL_PARAM_construct_end();
2109 return EVP_PKEY_set_params(pkey, params);
2112 int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
2113 const unsigned char *buf, size_t bsize)
2115 OSSL_PARAM params[2];
2117 if (key_name == NULL)
2120 params[0] = OSSL_PARAM_construct_octet_string(key_name,
2121 (unsigned char *)buf, bsize);
2122 params[1] = OSSL_PARAM_construct_end();
2123 return EVP_PKEY_set_params(pkey, params);
2126 const OSSL_PARAM *EVP_PKEY_settable_params(const EVP_PKEY *pkey)
2128 return (pkey != NULL && evp_pkey_is_provided(pkey))
2129 ? EVP_KEYMGMT_settable_params(pkey->keymgmt)
2133 int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[])
2136 if (evp_pkey_is_provided(pkey)) {
2138 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
2143 * We will hopefully never find the need to set individual data in
2144 * EVP_PKEYs with a legacy internal key, but we can't be entirely
2145 * sure. This bit of code can be enabled if we find the need. If
2146 * not, it can safely be removed when #legacy support is removed.
2149 else if (evp_pkey_is_legacy(pkey)) {
2150 return evp_pkey_set_params_to_ctrl(pkey, params);
2155 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2159 const OSSL_PARAM *EVP_PKEY_gettable_params(const EVP_PKEY *pkey)
2161 return (pkey != NULL && evp_pkey_is_provided(pkey))
2162 ? EVP_KEYMGMT_gettable_params(pkey->keymgmt)
2166 int EVP_PKEY_get_params(const EVP_PKEY *pkey, OSSL_PARAM params[])
2169 if (evp_pkey_is_provided(pkey))
2170 return evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params);
2172 else if (evp_pkey_is_legacy(pkey))
2173 return evp_pkey_get_params_to_ctrl(pkey, params);
2176 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2181 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey)
2189 if (pkey->keymgmt == NULL
2190 || pkey->keydata == NULL) {
2191 #ifndef OPENSSL_NO_EC
2192 /* Might work through the legacy route */
2193 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2198 return EC_KEY_get_conv_form(ec);
2204 if (!EVP_PKEY_get_utf8_string_param(pkey,
2205 OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
2206 name, sizeof(name), &name_len))
2209 if (strcmp(name, "uncompressed") == 0)
2210 return POINT_CONVERSION_UNCOMPRESSED;
2212 if (strcmp(name, "compressed") == 0)
2213 return POINT_CONVERSION_COMPRESSED;
2215 if (strcmp(name, "hybrid") == 0)
2216 return POINT_CONVERSION_HYBRID;
2221 int EVP_PKEY_get_field_type(const EVP_PKEY *pkey)
2229 if (pkey->keymgmt == NULL
2230 || pkey->keydata == NULL) {
2231 #ifndef OPENSSL_NO_EC
2232 /* Might work through the legacy route */
2233 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2234 const EC_GROUP *grp;
2238 grp = EC_KEY_get0_group(ec);
2242 return EC_GROUP_get_field_type(grp);
2248 if (!EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_EC_FIELD_TYPE,
2249 fstr, sizeof(fstr), &fstrlen))
2252 if (strcmp(fstr, SN_X9_62_prime_field) == 0)
2253 return NID_X9_62_prime_field;
2254 else if (strcmp(fstr, SN_X9_62_characteristic_two_field))
2255 return NID_X9_62_characteristic_two_field;