2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * DSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
17 #include "internal/cryptlib.h"
18 #include "internal/refcount.h"
19 #include <openssl/bn.h>
20 #include <openssl/err.h>
21 #include <openssl/objects.h>
22 #include <openssl/evp.h>
23 #include <openssl/x509.h>
24 #include <openssl/rsa.h>
25 #include <openssl/dsa.h>
26 #include <openssl/dh.h>
27 #include <openssl/ec.h>
28 #include <openssl/cmac.h>
29 #include <openssl/engine.h>
30 #include <openssl/params.h>
31 #include <openssl/param_build.h>
32 #include <openssl/encoder.h>
33 #include <openssl/core_names.h>
35 #include "internal/ffc.h"
36 #include "crypto/asn1.h"
37 #include "crypto/evp.h"
38 #include "crypto/ec.h"
39 #include "crypto/ecx.h"
40 #include "internal/provider.h"
41 #include "evp_local.h"
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)
62 size = pkey->cache.bits;
63 if (pkey->ameth != NULL && pkey->ameth->pkey_bits != NULL)
64 size = pkey->ameth->pkey_bits(pkey);
66 return size < 0 ? 0 : size;
69 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
74 size = pkey->cache.security_bits;
75 if (pkey->ameth != NULL && pkey->ameth->pkey_security_bits != NULL)
76 size = pkey->ameth->pkey_security_bits(pkey);
78 return size < 0 ? 0 : size;
81 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
83 # ifndef OPENSSL_NO_DSA
84 if (pkey->type == EVP_PKEY_DSA) {
85 int ret = pkey->save_parameters;
88 pkey->save_parameters = mode;
92 # ifndef OPENSSL_NO_EC
93 if (pkey->type == EVP_PKEY_EC) {
94 int ret = pkey->save_parameters;
97 pkey->save_parameters = mode;
104 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
106 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
109 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
111 return CRYPTO_get_ex_data(&key->ex_data, idx);
114 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
117 * TODO: clean up legacy stuff from this function when legacy support
122 * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
123 * If that fails, this function fails.
125 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from))
126 if (!evp_pkey_downgrade((EVP_PKEY *)from))
130 * Make sure |to| is typed. Content is less important at this early
133 * 1. If |to| is untyped, assign |from|'s key type to it.
134 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
135 * (|from| was already downgraded above)
137 * If |to| is a provided key, there's nothing more to do here, functions
138 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
139 * further down help us find out if they are the same or not.
141 if (evp_pkey_is_blank(to)) {
142 if (evp_pkey_is_legacy(from)) {
143 if (EVP_PKEY_set_type(to, from->type) == 0)
146 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
149 } else if (evp_pkey_is_legacy(to)) {
150 if (to->type != from->type) {
151 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
156 if (EVP_PKEY_missing_parameters(from)) {
157 ERR_raise(ERR_LIB_EVP, EVP_R_MISSING_PARAMETERS);
161 if (!EVP_PKEY_missing_parameters(to)) {
162 if (EVP_PKEY_parameters_eq(to, from) == 1)
164 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_PARAMETERS);
168 /* For purely provided keys, we just call the keymgmt utility */
169 if (to->keymgmt != NULL && from->keymgmt != NULL)
170 return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
173 * If |to| is provided, we know that |from| is legacy at this point.
174 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
175 * to copy the appropriate data to |to|'s keydata.
177 if (to->keymgmt != NULL) {
178 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
180 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
184 * If we get a NULL, it could be an internal error, or it could be
185 * that there's a key mismatch. We're pretending the latter...
187 if (from_keydata == NULL) {
188 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
191 return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
195 /* Both keys are legacy */
196 if (from->ameth != NULL && from->ameth->param_copy != NULL)
197 return from->ameth->param_copy(to, from);
202 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
205 if (pkey->keymgmt != NULL)
206 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
207 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
208 return pkey->ameth->param_missing(pkey);
214 * This function is called for any mixture of keys except pure legacy pair.
215 * TODO When legacy keys are gone, we replace a call to this functions with
216 * a call to evp_keymgmt_util_match().
218 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
221 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
222 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
224 /* If none of them are provided, this function shouldn't have been called */
225 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
228 /* For purely provided keys, we just call the keymgmt utility */
229 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
230 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
233 * At this point, one of them is provided, the other not. This allows
234 * us to compare types using legacy NIDs.
236 if (evp_pkey_is_legacy(a)
237 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
238 return -1; /* not the same key type */
239 if (evp_pkey_is_legacy(b)
240 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
241 return -1; /* not the same key type */
244 * We've determined that they both are the same keytype, so the next
245 * step is to do a bit of cross export to ensure we have keydata for
246 * both keys in the same keymgmt.
248 keymgmt1 = a->keymgmt;
249 keydata1 = a->keydata;
250 keymgmt2 = b->keymgmt;
251 keydata2 = b->keydata;
253 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
255 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
256 if (tmp_keydata != NULL) {
258 keydata1 = tmp_keydata;
261 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
263 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
264 if (tmp_keydata != NULL) {
266 keydata2 = tmp_keydata;
270 /* If we still don't have matching keymgmt implementations, we give up */
271 if (keymgmt1 != keymgmt2)
274 /* If the keymgmt implementations are NULL, the export failed */
275 if (keymgmt1 == NULL)
278 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
281 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
283 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 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
306 return EVP_PKEY_eq(a, b);
309 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
312 * TODO: clean up legacy stuff from this function when legacy support
316 if (a->keymgmt != NULL || b->keymgmt != NULL)
317 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
318 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
320 /* All legacy keys */
321 if (a->type != b->type)
324 if (a->ameth != NULL) {
326 /* Compare parameters if the algorithm has them */
327 if (a->ameth->param_cmp != NULL) {
328 ret = a->ameth->param_cmp(a, b);
333 if (a->ameth->pub_cmp != NULL)
334 return a->ameth->pub_cmp(a, b);
341 static EVP_PKEY *new_raw_key_int(OSSL_LIB_CTX *libctx,
346 const unsigned char *key,
350 EVP_PKEY *pkey = NULL;
351 EVP_PKEY_CTX *ctx = NULL;
352 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
355 # ifndef OPENSSL_NO_ENGINE
356 /* Check if there is an Engine for this type */
361 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
362 else if (nidtype != EVP_PKEY_NONE)
363 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
365 /* If tmpe is NULL then no engine is claiming to support this type */
373 if (e == NULL && ameth == NULL) {
375 * No engine is claiming to support this type, so lets see if we have
378 ctx = EVP_PKEY_CTX_new_from_name(libctx,
379 strtype != NULL ? strtype
380 : OBJ_nid2sn(nidtype),
384 /* May fail if no provider available */
386 if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
387 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
389 ERR_clear_last_mark();
390 params[0] = OSSL_PARAM_construct_octet_string(
391 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
392 : OSSL_PKEY_PARAM_PUB_KEY,
395 if (EVP_PKEY_fromdata(ctx, &pkey, params) != 1) {
396 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
400 EVP_PKEY_CTX_free(ctx);
405 /* else not supported so fallback to legacy */
408 /* Legacy code path */
410 pkey = EVP_PKEY_new();
412 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
416 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
417 /* EVPerr already called */
421 if (!ossl_assert(pkey->ameth != NULL))
425 if (pkey->ameth->set_priv_key == NULL) {
426 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
430 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
431 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
435 if (pkey->ameth->set_pub_key == NULL) {
436 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
440 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
441 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
452 EVP_PKEY_CTX_free(ctx);
456 EVP_PKEY *EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX *libctx,
459 const unsigned char *priv, size_t len)
461 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
465 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
466 const unsigned char *priv,
469 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
472 EVP_PKEY *EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX *libctx,
473 const char *keytype, const char *propq,
474 const unsigned char *pub, size_t len)
476 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
480 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
481 const unsigned char *pub,
484 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
487 struct raw_key_details_st
494 static OSSL_CALLBACK get_raw_key_details;
495 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
497 const OSSL_PARAM *p = NULL;
498 struct raw_key_details_st *raw_key = arg;
500 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
501 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
503 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
504 SIZE_MAX, raw_key->len);
505 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
506 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
508 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
509 SIZE_MAX, raw_key->len);
515 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
518 if (pkey->keymgmt != NULL) {
519 struct raw_key_details_st raw_key;
521 raw_key.key = priv == NULL ? NULL : &priv;
523 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
525 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
526 get_raw_key_details, &raw_key);
529 if (pkey->ameth == NULL) {
530 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
534 if (pkey->ameth->get_priv_key == NULL) {
535 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
539 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
540 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
547 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
550 if (pkey->keymgmt != NULL) {
551 struct raw_key_details_st raw_key;
553 raw_key.key = pub == NULL ? NULL : &pub;
555 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
557 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
558 get_raw_key_details, &raw_key);
561 if (pkey->ameth == NULL) {
562 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
566 if (pkey->ameth->get_pub_key == NULL) {
567 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
571 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
572 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
579 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
580 const char *cipher_name,
581 const EVP_CIPHER *cipher,
582 OSSL_LIB_CTX *libctx,
583 const char *propq, ENGINE *e)
585 # ifndef OPENSSL_NO_CMAC
586 # ifndef OPENSSL_NO_ENGINE
587 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
589 OSSL_PARAM params[5], *p = params;
590 EVP_PKEY *pkey = NULL;
594 cipher_name = EVP_CIPHER_name(cipher);
596 if (cipher_name == NULL) {
597 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
601 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
605 if (!EVP_PKEY_key_fromdata_init(ctx)) {
606 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
610 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
612 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
613 (char *)cipher_name, 0);
615 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
617 # ifndef OPENSSL_NO_ENGINE
618 if (engine_id != NULL)
619 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
620 (char *)engine_id, 0);
622 *p = OSSL_PARAM_construct_end();
624 if (!EVP_PKEY_fromdata(ctx, &pkey, params)) {
625 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
630 EVP_PKEY_CTX_free(ctx);
634 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
639 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
640 size_t len, const EVP_CIPHER *cipher)
642 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
645 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
647 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
650 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
652 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
655 #ifndef OPENSSL_NO_DEPRECATED_3_0
656 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
658 if (!evp_pkey_is_legacy(pkey)) {
659 const char *name = OBJ_nid2sn(type);
661 if (name != NULL && EVP_PKEY_is_a(pkey, name))
664 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
668 if (pkey->type == type) {
669 return 1; /* it already is that type */
673 * The application is requesting to alias this to a different pkey type,
674 * but not one that resolves to the base type.
676 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
677 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
686 # ifndef OPENSSL_NO_ENGINE
687 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
690 if (!ENGINE_init(e)) {
691 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
694 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
696 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
700 ENGINE_finish(pkey->pmeth_engine);
701 pkey->pmeth_engine = e;
705 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
710 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
714 #ifndef OPENSSL_NO_EC
715 if ((key != NULL) && (EVP_PKEY_type(type) == EVP_PKEY_EC)) {
716 const EC_GROUP *group = EC_KEY_get0_group(key);
718 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
719 alias = EVP_PKEY_SM2;
723 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
725 if (!EVP_PKEY_set_alias_type(pkey, alias))
727 pkey->pkey.ptr = key;
728 return (key != NULL);
731 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
735 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
736 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
739 return pkey->pkey.ptr;
742 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
744 ASN1_OCTET_STRING *os = NULL;
745 if (pkey->type != EVP_PKEY_HMAC) {
746 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_AN_HMAC_KEY);
749 os = EVP_PKEY_get0(pkey);
754 # ifndef OPENSSL_NO_POLY1305
755 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
757 ASN1_OCTET_STRING *os = NULL;
758 if (pkey->type != EVP_PKEY_POLY1305) {
759 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_POLY1305_KEY);
762 os = EVP_PKEY_get0(pkey);
768 # ifndef OPENSSL_NO_SIPHASH
769 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
771 ASN1_OCTET_STRING *os = NULL;
773 if (pkey->type != EVP_PKEY_SIPHASH) {
774 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_SIPHASH_KEY);
777 os = EVP_PKEY_get0(pkey);
783 # ifndef OPENSSL_NO_DSA
784 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
786 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
787 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
790 if (pkey->type != EVP_PKEY_DSA) {
791 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DSA_KEY);
794 return pkey->pkey.dsa;
797 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
799 int ret = EVP_PKEY_assign_DSA(pkey, key);
804 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
806 DSA *ret = EVP_PKEY_get0_DSA(pkey);
811 # endif /* OPENSSL_NO_DSA */
812 #endif /* FIPS_MODULE */
815 # ifndef OPENSSL_NO_EC
816 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
818 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
824 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
826 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
827 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
830 if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
831 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_EC_KEY);
834 return pkey->pkey.ec;
837 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
839 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
845 static ECX_KEY *evp_pkey_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
847 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
848 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
851 if (EVP_PKEY_base_id(pkey) != type) {
852 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
855 return pkey->pkey.ecx;
858 static ECX_KEY *evp_pkey_get1_ECX_KEY(EVP_PKEY *pkey, int type)
860 ECX_KEY *ret = evp_pkey_get0_ECX_KEY(pkey, type);
866 # define IMPLEMENT_ECX_VARIANT(NAME) \
867 ECX_KEY *evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
869 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
871 IMPLEMENT_ECX_VARIANT(X25519)
872 IMPLEMENT_ECX_VARIANT(X448)
873 IMPLEMENT_ECX_VARIANT(ED25519)
874 IMPLEMENT_ECX_VARIANT(ED448)
878 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
880 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
882 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
883 int ret = EVP_PKEY_assign(pkey, type, key);
890 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
892 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
893 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
896 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
897 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DH_KEY);
900 return pkey->pkey.dh;
903 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
905 DH *ret = EVP_PKEY_get0_DH(pkey);
912 int EVP_PKEY_type(int type)
915 const EVP_PKEY_ASN1_METHOD *ameth;
917 ameth = EVP_PKEY_asn1_find(&e, type);
919 ret = ameth->pkey_id;
922 # ifndef OPENSSL_NO_ENGINE
928 int EVP_PKEY_id(const EVP_PKEY *pkey)
933 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
935 return EVP_PKEY_type(pkey->type);
939 int evp_pkey_name2type(const char *name)
942 * These hard coded cases are pure hackery to get around the fact
943 * that names in crypto/objects/objects.txt are a mess. There is
944 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
945 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
946 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
947 * "DSA" is accurate... but still, better be safe and hard-code
948 * names that we know.
949 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
950 * EVP_PKEY_EC, because of aliasing.
951 * TODO Clean this away along with all other #legacy support.
953 int type = NID_undef;
955 if (strcasecmp(name, "RSA") == 0)
957 else if (strcasecmp(name, "RSA-PSS") == 0)
958 type = EVP_PKEY_RSA_PSS;
959 else if (strcasecmp(name, "EC") == 0)
961 else if (strcasecmp(name, "ED25519") == 0)
962 type = EVP_PKEY_ED25519;
963 else if (strcasecmp(name, "ED448") == 0)
964 type = EVP_PKEY_ED448;
965 else if (strcasecmp(name, "X25519") == 0)
966 type = EVP_PKEY_X25519;
967 else if (strcasecmp(name, "X448") == 0)
968 type = EVP_PKEY_X448;
969 else if (strcasecmp(name, "SM2") == 0)
971 else if (strcasecmp(name, "DH") == 0)
973 else if (strcasecmp(name, "X9.42 DH") == 0)
975 else if (strcasecmp(name, "DSA") == 0)
978 if (type == NID_undef)
979 type = EVP_PKEY_type(OBJ_sn2nid(name));
980 if (type == NID_undef)
981 type = EVP_PKEY_type(OBJ_ln2nid(name));
987 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
990 if (pkey->keymgmt == NULL) {
991 int type = evp_pkey_name2type(name);
993 return pkey->type == type;
996 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
999 void EVP_PKEY_typenames_do_all(const EVP_PKEY *pkey,
1000 void (*fn)(const char *name, void *data),
1003 if (!evp_pkey_is_typed(pkey))
1006 if (!evp_pkey_is_provided(pkey)) {
1007 const char *name = OBJ_nid2sn(EVP_PKEY_id(pkey));
1012 EVP_KEYMGMT_names_do_all(pkey->keymgmt, fn, data);
1015 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1017 if (pkey->keymgmt == NULL) {
1018 switch (EVP_PKEY_base_id(pkey)) {
1021 #ifndef OPENSSL_NO_DSA
1025 #ifndef OPENSSL_NO_EC
1026 case EVP_PKEY_ED25519:
1027 case EVP_PKEY_ED448:
1029 case EVP_PKEY_EC: /* Including SM2 */
1030 return EC_KEY_can_sign(pkey->pkey.ec);
1036 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1037 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
1038 const char *supported_sig =
1039 pkey->keymgmt->query_operation_name != NULL
1040 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1041 : evp_first_name(prov, pkey->keymgmt->name_id);
1042 EVP_SIGNATURE *signature = NULL;
1044 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1045 if (signature != NULL) {
1046 EVP_SIGNATURE_free(signature);
1053 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1055 BIO_set_indent(*out, saved_indent);
1057 BIO *next = BIO_pop(*out);
1065 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1071 long i = BIO_get_indent(*out);
1073 *saved_indent = (i < 0 ? 0 : i);
1074 if (BIO_set_indent(*out, indent) <= 0) {
1075 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1079 if (BIO_set_indent(*out, indent) <= 0) {
1080 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1087 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1090 return BIO_indent(out, indent, 128)
1091 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1092 kstr, OBJ_nid2ln(pkey->type)) > 0;
1095 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1096 int selection /* For provided encoding */,
1097 const char *propquery /* For provided encoding */,
1098 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1099 int indent, ASN1_PCTX *pctx),
1100 ASN1_PCTX *legacy_pctx /* For legacy print */)
1104 OSSL_ENCODER_CTX *ctx = NULL;
1105 int ret = -2; /* default to unsupported */
1107 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1110 ctx = OSSL_ENCODER_CTX_new_by_EVP_PKEY(pkey, selection, "TEXT", NULL,
1112 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0)
1113 ret = OSSL_ENCODER_to_bio(ctx, out);
1114 OSSL_ENCODER_CTX_free(ctx);
1119 /* legacy fallback */
1120 if (legacy_print != NULL)
1121 ret = legacy_print(out, pkey, 0, legacy_pctx);
1123 ret = unsup_alg(out, pkey, 0, "Public Key");
1126 print_reset_indent(&out, pop_f_prefix, saved_indent);
1130 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1131 int indent, ASN1_PCTX *pctx)
1133 return print_pkey(pkey, out, indent, EVP_PKEY_PUBLIC_KEY, NULL,
1134 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1138 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1139 int indent, ASN1_PCTX *pctx)
1141 return print_pkey(pkey, out, indent, EVP_PKEY_KEYPAIR, NULL,
1142 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1146 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1147 int indent, ASN1_PCTX *pctx)
1149 return print_pkey(pkey, out, indent, EVP_PKEY_KEY_PARAMETERS, NULL,
1150 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1154 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1155 int arg1, void *arg2)
1157 if (pkey->keymgmt == NULL)
1160 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1162 char mdname[80] = "";
1163 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1169 nid = OBJ_sn2nid(mdname);
1170 if (nid == NID_undef)
1171 nid = OBJ_ln2nid(mdname);
1181 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1183 if (pkey->ameth == NULL)
1184 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1185 if (pkey->ameth->pkey_ctrl == NULL)
1187 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1190 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1192 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1195 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1196 char *mdname, size_t mdname_sz)
1198 if (pkey->ameth == NULL)
1199 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1204 int nid = NID_undef;
1205 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1206 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1209 OPENSSL_strlcpy(mdname, name, mdname_sz);
1214 int EVP_PKEY_get_group_name(const EVP_PKEY *pkey, char *gname, size_t gname_sz,
1217 if (evp_pkey_is_legacy(pkey)) {
1218 const char *name = NULL;
1220 switch (EVP_PKEY_base_id(pkey)) {
1221 #ifndef OPENSSL_NO_EC
1224 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1225 int nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1227 if (nid != NID_undef)
1228 name = ec_curve_nid2name(nid);
1232 #ifndef OPENSSL_NO_DH
1235 DH *dh = EVP_PKEY_get0_DH(pkey);
1236 int uid = DH_get_nid(dh);
1238 if (uid != NID_undef) {
1239 const DH_NAMED_GROUP *dh_group =
1240 ossl_ffc_uid_to_dh_named_group(uid);
1242 name = ossl_ffc_named_group_get_name(dh_group);
1251 if (gname_len != NULL)
1252 *gname_len = (name == NULL ? 0 : strlen(name));
1255 OPENSSL_strlcpy(gname, name, gname_sz);
1258 } else if (evp_pkey_is_provided(pkey)) {
1259 if (EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_GROUP_NAME,
1260 gname, gname_sz, gname_len))
1263 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
1267 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1271 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1273 int rv, default_nid;
1275 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1278 * If there is a mandatory default digest and this isn't it, then
1279 * the answer is 'no'.
1281 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1283 return (nid == default_nid);
1284 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1291 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, const unsigned char *pub,
1294 if (pkey->ameth == NULL) {
1295 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1297 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1301 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1302 (unsigned char *)pub, publen);
1303 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
1306 if (publen > INT_MAX)
1308 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1309 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, publen,
1315 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub)
1319 if (pkey->ameth == NULL) {
1320 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1322 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1326 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1328 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1331 *ppub = OPENSSL_malloc(params[0].return_size);
1336 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1337 *ppub, params[0].return_size);
1338 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1341 return params[0].return_size;
1345 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppub);
1351 #endif /* FIPS_MODULE */
1353 /*- All methods below can also be used in FIPS_MODULE */
1356 * This reset function must be used very carefully, as it literally throws
1357 * away everything in an EVP_PKEY without freeing them, and may cause leaks
1358 * of memory, what have you.
1359 * The only reason we have this is to have the same code for EVP_PKEY_new()
1360 * and evp_pkey_downgrade().
1362 static int evp_pkey_reset_unlocked(EVP_PKEY *pk)
1367 if (pk->lock != NULL) {
1368 const size_t offset = (unsigned char *)&pk->lock - (unsigned char *)pk;
1370 memset(pk, 0, offset);
1371 memset((unsigned char *)pk + offset + sizeof(pk->lock),
1373 sizeof(*pk) - offset - sizeof(pk->lock));
1375 /* EVP_PKEY_new uses zalloc so no need to call memset if pk->lock is NULL */
1377 pk->type = EVP_PKEY_NONE;
1378 pk->save_type = EVP_PKEY_NONE;
1380 pk->save_parameters = 1;
1385 EVP_PKEY *EVP_PKEY_new(void)
1387 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1390 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1394 if (!evp_pkey_reset_unlocked(ret))
1397 ret->lock = CRYPTO_THREAD_lock_new();
1398 if (ret->lock == NULL) {
1399 EVPerr(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1404 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1405 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1412 CRYPTO_THREAD_lock_free(ret->lock);
1418 * Setup a public key management method.
1420 * For legacy keys, either |type| or |str| is expected to have the type
1421 * information. In this case, the setup consists of finding an ASN1 method
1422 * and potentially an ENGINE, and setting those fields in |pkey|.
1424 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1425 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1427 * If pkey is NULL just return 1 or 0 if the key management method exists.
1430 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1431 int len, EVP_KEYMGMT *keymgmt)
1434 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1435 ENGINE **eptr = (e == NULL) ? &e : NULL;
1439 * The setups can't set both legacy and provider side methods.
1442 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1443 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1444 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1452 free_it = free_it || pkey->pkey.ptr != NULL;
1454 free_it = free_it || pkey->keydata != NULL;
1456 evp_pkey_free_it(pkey);
1459 * If key type matches and a method exists then this lookup has
1460 * succeeded once so just indicate success.
1462 if (pkey->type != EVP_PKEY_NONE
1463 && type == pkey->save_type
1464 && pkey->ameth != NULL)
1466 # ifndef OPENSSL_NO_ENGINE
1467 /* If we have ENGINEs release them */
1468 ENGINE_finish(pkey->engine);
1469 pkey->engine = NULL;
1470 ENGINE_finish(pkey->pmeth_engine);
1471 pkey->pmeth_engine = NULL;
1477 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1478 else if (type != EVP_PKEY_NONE)
1479 ameth = EVP_PKEY_asn1_find(eptr, type);
1480 # ifndef OPENSSL_NO_ENGINE
1481 if (pkey == NULL && eptr != NULL)
1491 check = check && ameth == NULL;
1493 check = check && keymgmt == NULL;
1495 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
1500 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1501 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1505 pkey->keymgmt = keymgmt;
1507 pkey->save_type = type;
1512 * If the internal "origin" key is provider side, don't save |ameth|.
1513 * The main reason is that |ameth| is one factor to detect that the
1514 * internal "origin" key is a legacy one.
1516 if (keymgmt == NULL)
1517 pkey->ameth = ameth;
1521 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1522 * for any key type that has a legacy implementation, regardless of
1523 * if the internal key is a legacy or a provider side one. When
1524 * there is no legacy implementation for the key, the type becomes
1525 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1526 * with functions that expect legacy internal keys.
1529 pkey->type = ameth->pkey_id;
1531 pkey->type = EVP_PKEY_KEYMGMT;
1538 static void find_ameth(const char *name, void *data)
1540 const char **str = data;
1543 * The error messages from pkey_set_type() are uninteresting here,
1548 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1552 else if (str[1] == NULL)
1560 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1563 # define EVP_PKEY_TYPE_STR str[0]
1564 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1566 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1567 * Ideally, only one should be found. If two (or more) are found, the
1568 * match is ambiguous. This should never happen, but...
1570 const char *str[2] = { NULL, NULL };
1572 EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1573 if (str[1] != NULL) {
1574 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1578 # define EVP_PKEY_TYPE_STR NULL
1579 # define EVP_PKEY_TYPE_STRLEN -1
1581 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1582 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1585 #undef EVP_PKEY_TYPE_STR
1586 #undef EVP_PKEY_TYPE_STRLEN
1589 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1593 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1596 REF_PRINT_COUNT("EVP_PKEY", pkey);
1597 REF_ASSERT_ISNT(i < 2);
1598 return ((i > 1) ? 1 : 0);
1602 void evp_pkey_free_legacy(EVP_PKEY *x)
1604 if (x->ameth != NULL) {
1605 if (x->ameth->pkey_free != NULL)
1606 x->ameth->pkey_free(x);
1609 # ifndef OPENSSL_NO_ENGINE
1610 ENGINE_finish(x->engine);
1612 ENGINE_finish(x->pmeth_engine);
1613 x->pmeth_engine = NULL;
1616 #endif /* FIPS_MODULE */
1618 static void evp_pkey_free_it(EVP_PKEY *x)
1620 /* internal function; x is never NULL */
1622 evp_keymgmt_util_clear_operation_cache(x);
1624 evp_pkey_free_legacy(x);
1627 if (x->keymgmt != NULL) {
1628 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1629 EVP_KEYMGMT_free(x->keymgmt);
1633 x->type = EVP_PKEY_NONE;
1636 void EVP_PKEY_free(EVP_PKEY *x)
1643 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1644 REF_PRINT_COUNT("EVP_PKEY", x);
1647 REF_ASSERT_ISNT(i < 0);
1648 evp_pkey_free_it(x);
1650 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1652 CRYPTO_THREAD_lock_free(x->lock);
1654 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1659 int EVP_PKEY_size(const EVP_PKEY *pkey)
1664 size = pkey->cache.size;
1666 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1667 size = pkey->ameth->pkey_size(pkey);
1670 return size < 0 ? 0 : size;
1673 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OSSL_LIB_CTX *libctx,
1674 EVP_KEYMGMT **keymgmt,
1675 const char *propquery)
1677 EVP_KEYMGMT *allocated_keymgmt = NULL;
1678 EVP_KEYMGMT *tmp_keymgmt = NULL;
1679 void *keydata = NULL;
1685 /* No key data => nothing to export */
1688 check = check && pk->pkey.ptr == NULL;
1690 check = check && pk->keydata == NULL;
1695 if (pk->pkey.ptr != NULL) {
1697 * If the legacy key doesn't have an dirty counter or export function,
1700 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1705 if (keymgmt != NULL) {
1706 tmp_keymgmt = *keymgmt;
1711 * If no keymgmt was given or found, get a default keymgmt. We do so by
1712 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1714 if (tmp_keymgmt == NULL) {
1715 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1717 tmp_keymgmt = ctx->keymgmt;
1718 ctx->keymgmt = NULL;
1719 EVP_PKEY_CTX_free(ctx);
1722 /* If there's still no keymgmt to be had, give up */
1723 if (tmp_keymgmt == NULL)
1727 if (pk->pkey.ptr != NULL) {
1731 * If the legacy "origin" hasn't changed since last time, we try
1732 * to find our keymgmt in the operation cache. If it has changed,
1733 * |i| remains zero, and we will clear the cache further down.
1735 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1736 i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1739 * If |tmp_keymgmt| is present in the operation cache, it means
1740 * that export doesn't need to be redone. In that case, we take
1741 * token copies of the cached pointers, to have token success
1744 if (i < OSSL_NELEM(pk->operation_cache)
1745 && pk->operation_cache[i].keymgmt != NULL) {
1746 keydata = pk->operation_cache[i].keydata;
1752 * TODO(3.0) Right now, we assume we have ample space. We will have
1753 * to think about a cache aging scheme, though, if |i| indexes outside
1756 if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1759 /* Make sure that the keymgmt key type matches the legacy NID */
1760 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1763 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1766 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1767 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1773 * If the dirty counter changed since last time, then clear the
1774 * operation cache. In that case, we know that |i| is zero. Just
1775 * in case this is a re-export, we increment then decrement the
1776 * keymgmt reference counter.
1778 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1779 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1783 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1784 evp_keymgmt_util_clear_operation_cache(pk);
1785 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1787 /* Add the new export to the operation cache */
1788 if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1789 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1794 /* Synchronize the dirty count */
1795 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1798 #endif /* FIPS_MODULE */
1800 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1804 * If nothing was exported, |tmp_keymgmt| might point at a freed
1805 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1806 * the caller either way in that case.
1808 if (keydata == NULL)
1811 if (keymgmt != NULL)
1812 *keymgmt = tmp_keymgmt;
1814 EVP_KEYMGMT_free(allocated_keymgmt);
1819 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1821 if (!ossl_assert(dest != NULL))
1824 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1825 EVP_KEYMGMT *keymgmt = src->keymgmt;
1826 void *keydata = src->keydata;
1827 int type = src->type;
1828 const char *keytype = NULL;
1830 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
1834 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1835 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1836 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1837 * TODO(3.0) remove this check when we're confident that the rest
1838 * of the code treats this correctly.
1840 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1841 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1842 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1847 /* Prefer the legacy key type name for error reporting */
1848 if (type != EVP_PKEY_KEYMGMT)
1849 keytype = OBJ_nid2sn(type);
1851 /* Make sure we have a clean slate to copy into */
1853 *dest = EVP_PKEY_new();
1855 evp_pkey_free_it(*dest);
1857 if (EVP_PKEY_set_type(*dest, type)) {
1858 /* If the key is typed but empty, we're done */
1859 if (keydata == NULL)
1862 if ((*dest)->ameth->import_from == NULL) {
1863 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1864 "key type = %s", keytype);
1867 * We perform the export in the same libctx as the keymgmt
1868 * that we are using.
1870 OSSL_LIB_CTX *libctx =
1871 ossl_provider_libctx(keymgmt->prov);
1872 EVP_PKEY_CTX *pctx =
1873 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
1876 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1879 && evp_keymgmt_export(keymgmt, keydata,
1880 OSSL_KEYMGMT_SELECT_ALL,
1881 (*dest)->ameth->import_from,
1883 /* Synchronize the dirty count */
1884 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
1886 EVP_PKEY_CTX_free(pctx);
1889 EVP_PKEY_CTX_free(pctx);
1892 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1893 "key type = %s", keytype);
1900 int evp_pkey_downgrade(EVP_PKEY *pk)
1902 EVP_PKEY tmp_copy; /* Stack allocated! */
1905 if (!ossl_assert(pk != NULL))
1909 * Throughout this whole function, we must ensure that we lock / unlock
1910 * the exact same lock. Note that we do pass it around a bit.
1912 if (!CRYPTO_THREAD_write_lock(pk->lock))
1915 /* If this isn't an assigned provider side key, we're done */
1916 if (!evp_pkey_is_assigned(pk) || !evp_pkey_is_provided(pk)) {
1922 * To be able to downgrade, we steal the contents of |pk|, then reset
1923 * it, and finally try to make it a downgraded copy. If any of that
1924 * fails, we restore the copied contents into |pk|.
1926 tmp_copy = *pk; /* |tmp_copy| now owns THE lock */
1928 if (evp_pkey_reset_unlocked(pk)
1929 && evp_pkey_copy_downgraded(&pk, &tmp_copy)) {
1931 /* Restore the common attributes, then empty |tmp_copy| */
1932 pk->references = tmp_copy.references;
1933 pk->attributes = tmp_copy.attributes;
1934 pk->save_parameters = tmp_copy.save_parameters;
1935 pk->ex_data = tmp_copy.ex_data;
1937 /* Ensure that stuff we've copied won't be freed */
1938 tmp_copy.lock = NULL;
1939 tmp_copy.attributes = NULL;
1940 memset(&tmp_copy.ex_data, 0, sizeof(tmp_copy.ex_data));
1943 * Save the provider side data in the operation cache, so they'll
1944 * find it again. |pk| is new, so it's safe to assume slot zero
1946 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1947 * reference count, so we need to decrement it, or there will be a
1950 evp_keymgmt_util_cache_keydata(pk, 0, tmp_copy.keymgmt,
1952 EVP_KEYMGMT_free(tmp_copy.keymgmt);
1955 * Clear keymgmt and keydata from |tmp_copy|, or they'll get
1956 * inadvertently freed.
1958 tmp_copy.keymgmt = NULL;
1959 tmp_copy.keydata = NULL;
1961 evp_pkey_free_it(&tmp_copy);
1964 /* Restore the original key */
1969 if (!CRYPTO_THREAD_unlock(pk->lock))
1973 #endif /* FIPS_MODULE */
1975 const OSSL_PARAM *EVP_PKEY_gettable_params(const EVP_PKEY *pkey)
1978 || pkey->keymgmt == NULL
1979 || pkey->keydata == NULL)
1981 return EVP_KEYMGMT_gettable_params(pkey->keymgmt);
1984 int EVP_PKEY_get_bn_param(const EVP_PKEY *pkey, const char *key_name,
1988 OSSL_PARAM params[2];
1989 unsigned char buffer[2048];
1990 unsigned char *buf = NULL;
1994 || pkey->keymgmt == NULL
1995 || pkey->keydata == NULL
2000 memset(buffer, 0, sizeof(buffer));
2001 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
2002 params[1] = OSSL_PARAM_construct_end();
2003 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
2004 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
2006 buf_sz = params[0].return_size;
2008 * If it failed because the buffer was too small then allocate the
2009 * required buffer size and retry.
2011 buf = OPENSSL_zalloc(buf_sz);
2014 params[0].data = buf;
2015 params[0].data_size = buf_sz;
2017 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
2020 /* Fail if the param was not found */
2021 if (!OSSL_PARAM_modified(params))
2023 ret = OSSL_PARAM_get_BN(params, bn);
2029 int EVP_PKEY_get_octet_string_param(const EVP_PKEY *pkey, const char *key_name,
2030 unsigned char *buf, size_t max_buf_sz,
2033 OSSL_PARAM params[2];
2036 || pkey->keymgmt == NULL
2037 || pkey->keydata == NULL
2038 || key_name == NULL)
2041 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
2042 params[1] = OSSL_PARAM_construct_end();
2043 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2044 || !OSSL_PARAM_modified(params))
2047 *out_sz = params[0].return_size;
2051 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY *pkey, const char *key_name,
2052 char *str, size_t max_buf_sz,
2055 OSSL_PARAM params[2];
2058 || pkey->keymgmt == NULL
2059 || pkey->keydata == NULL
2060 || key_name == NULL)
2063 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2064 params[1] = OSSL_PARAM_construct_end();
2065 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2066 || !OSSL_PARAM_modified(params))
2069 *out_sz = params[0].return_size;
2073 int EVP_PKEY_get_int_param(const EVP_PKEY *pkey, const char *key_name,
2076 OSSL_PARAM params[2];
2079 || pkey->keymgmt == NULL
2080 || pkey->keydata == NULL
2081 || key_name == NULL)
2084 params[0] = OSSL_PARAM_construct_int(key_name, out);
2085 params[1] = OSSL_PARAM_construct_end();
2086 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2087 || !OSSL_PARAM_modified(params))
2092 int EVP_PKEY_get_size_t_param(const EVP_PKEY *pkey, const char *key_name,
2095 OSSL_PARAM params[2];
2098 || pkey->keymgmt == NULL
2099 || pkey->keydata == NULL
2100 || key_name == NULL)
2103 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2104 params[1] = OSSL_PARAM_construct_end();
2105 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2106 || !OSSL_PARAM_modified(params))