2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * DSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
17 #include "internal/cryptlib.h"
18 #include "internal/refcount.h"
19 #include <openssl/bn.h>
20 #include <openssl/err.h>
21 #include <openssl/objects.h>
22 #include <openssl/evp.h>
23 #include <openssl/x509.h>
24 #include <openssl/rsa.h>
25 #include <openssl/dsa.h>
26 #include <openssl/dh.h>
27 #include <openssl/ec.h>
28 #include <openssl/cmac.h>
29 #include <openssl/engine.h>
30 #include <openssl/params.h>
31 #include <openssl/param_build.h>
32 #include <openssl/serializer.h>
33 #include <openssl/core_names.h>
35 #include "crypto/asn1.h"
36 #include "crypto/evp.h"
37 #include "crypto/ecx.h"
38 #include "internal/evp.h"
39 #include "internal/provider.h"
40 #include "evp_local.h"
41 DEFINE_STACK_OF(X509_ATTRIBUTE)
43 #include "crypto/ec.h"
45 /* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
46 #include "e_os.h" /* strcasecmp on Windows */
48 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
49 int len, EVP_KEYMGMT *keymgmt);
50 static void evp_pkey_free_it(EVP_PKEY *key);
54 /* The type of parameters selected in key parameter functions */
55 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
57 int EVP_PKEY_bits(const EVP_PKEY *pkey)
60 if (pkey->ameth == NULL)
61 return pkey->cache.bits;
62 else if (pkey->ameth->pkey_bits)
63 return pkey->ameth->pkey_bits(pkey);
68 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
72 if (pkey->ameth == NULL)
73 return pkey->cache.security_bits;
74 if (pkey->ameth->pkey_security_bits == NULL)
76 return pkey->ameth->pkey_security_bits(pkey);
79 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
81 # ifndef OPENSSL_NO_DSA
82 if (pkey->type == EVP_PKEY_DSA) {
83 int ret = pkey->save_parameters;
86 pkey->save_parameters = mode;
90 # ifndef OPENSSL_NO_EC
91 if (pkey->type == EVP_PKEY_EC) {
92 int ret = pkey->save_parameters;
95 pkey->save_parameters = mode;
102 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
104 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
107 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
109 return CRYPTO_get_ex_data(&key->ex_data, idx);
112 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
115 * TODO: clean up legacy stuff from this function when legacy support
120 * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
121 * If that fails, this function fails.
123 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from))
124 if (!evp_pkey_downgrade((EVP_PKEY *)from))
128 * Make sure |to| is typed. Content is less important at this early
131 * 1. If |to| is untyped, assign |from|'s key type to it.
132 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
133 * (|from| was already downgraded above)
135 * If |to| is a provided key, there's nothing more to do here, functions
136 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
137 * further down help us find out if they are the same or not.
139 if (evp_pkey_is_blank(to)) {
140 if (evp_pkey_is_legacy(from)) {
141 if (EVP_PKEY_set_type(to, from->type) == 0)
144 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
147 } else if (evp_pkey_is_legacy(to)) {
148 if (to->type != from->type) {
149 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
154 if (EVP_PKEY_missing_parameters(from)) {
155 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
159 if (!EVP_PKEY_missing_parameters(to)) {
160 if (EVP_PKEY_parameters_eq(to, from) == 1)
162 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
166 /* For purely provided keys, we just call the keymgmt utility */
167 if (to->keymgmt != NULL && from->keymgmt != NULL)
168 return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
171 * If |to| is provided, we know that |from| is legacy at this point.
172 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
173 * to copy the appropriate data to |to|'s keydata.
175 if (to->keymgmt != NULL) {
176 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
178 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
182 * If we get a NULL, it could be an internal error, or it could be
183 * that there's a key mismatch. We're pretending the latter...
185 if (from_keydata == NULL) {
186 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
189 return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
193 /* Both keys are legacy */
194 if (from->ameth != NULL && from->ameth->param_copy != NULL)
195 return from->ameth->param_copy(to, from);
200 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
203 if (pkey->keymgmt != NULL)
204 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
205 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
206 return pkey->ameth->param_missing(pkey);
212 * This function is called for any mixture of keys except pure legacy pair.
213 * TODO When legacy keys are gone, we replace a call to this functions with
214 * a call to evp_keymgmt_util_match().
216 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
219 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
220 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
222 /* If none of them are provided, this function shouldn't have been called */
223 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
226 /* For purely provided keys, we just call the keymgmt utility */
227 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
228 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
231 * At this point, one of them is provided, the other not. This allows
232 * us to compare types using legacy NIDs.
234 if (evp_pkey_is_legacy(a)
235 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
236 return -1; /* not the same key type */
237 if (evp_pkey_is_legacy(b)
238 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
239 return -1; /* not the same key type */
242 * We've determined that they both are the same keytype, so the next
243 * step is to do a bit of cross export to ensure we have keydata for
244 * both keys in the same keymgmt.
246 keymgmt1 = a->keymgmt;
247 keydata1 = a->keydata;
248 keymgmt2 = b->keymgmt;
249 keydata2 = b->keydata;
251 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
253 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
254 if (tmp_keydata != NULL) {
256 keydata1 = tmp_keydata;
259 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
261 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
262 if (tmp_keydata != NULL) {
264 keydata2 = tmp_keydata;
268 /* If we still don't have matching keymgmt implementations, we give up */
269 if (keymgmt1 != keymgmt2)
272 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
275 #ifndef OPENSSL_NO_DEPRECATED_3_0
276 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
278 return EVP_PKEY_parameters_eq(a, b);
282 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
285 * TODO: clean up legacy stuff from this function when legacy support
289 if (a->keymgmt != NULL || b->keymgmt != NULL)
290 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
292 /* All legacy keys */
293 if (a->type != b->type)
295 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
296 return a->ameth->param_cmp(a, b);
300 #ifndef OPENSSL_NO_DEPRECATED_3_0
301 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
303 return EVP_PKEY_eq(a, b);
307 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
310 * TODO: clean up legacy stuff from this function when legacy support
314 if (a->keymgmt != NULL || b->keymgmt != NULL)
315 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
316 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
318 /* All legacy keys */
319 if (a->type != b->type)
322 if (a->ameth != NULL) {
324 /* Compare parameters if the algorithm has them */
325 if (a->ameth->param_cmp != NULL) {
326 ret = a->ameth->param_cmp(a, b);
331 if (a->ameth->pub_cmp != NULL)
332 return a->ameth->pub_cmp(a, b);
339 static EVP_PKEY *new_raw_key_int(OPENSSL_CTX *libctx,
344 const unsigned char *key,
348 EVP_PKEY *pkey = NULL;
349 EVP_PKEY_CTX *ctx = NULL;
350 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
353 # ifndef OPENSSL_NO_ENGINE
354 /* Check if there is an Engine for this type */
359 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
360 else if (nidtype != EVP_PKEY_NONE)
361 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
363 /* If tmpe is NULL then no engine is claiming to support this type */
371 if (e == NULL && ameth == NULL) {
373 * No engine is claiming to support this type, so lets see if we have
376 ctx = EVP_PKEY_CTX_new_from_name(libctx,
377 strtype != NULL ? strtype
378 : OBJ_nid2sn(nidtype),
381 EVPerr(0, ERR_R_MALLOC_FAILURE);
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 EVPerr(0, 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 EVPerr(0, 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 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
430 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
431 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
435 if (pkey->ameth->set_pub_key == NULL) {
436 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
440 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
441 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
452 EVP_PKEY_CTX_free(ctx);
456 EVP_PKEY *EVP_PKEY_new_raw_private_key_with_libctx(OPENSSL_CTX *libctx,
459 const unsigned char *priv,
462 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
466 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
467 const unsigned char *priv,
470 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
473 EVP_PKEY *EVP_PKEY_new_raw_public_key_with_libctx(OPENSSL_CTX *libctx,
476 const unsigned char *pub,
479 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
483 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
484 const unsigned char *pub,
487 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
490 struct raw_key_details_st
497 static OSSL_CALLBACK get_raw_key_details;
498 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
500 const OSSL_PARAM *p = NULL;
501 struct raw_key_details_st *raw_key = arg;
503 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
504 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
506 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
507 SIZE_MAX, raw_key->len);
508 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
509 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
511 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
512 SIZE_MAX, raw_key->len);
518 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
521 if (pkey->keymgmt != NULL) {
522 struct raw_key_details_st raw_key;
524 raw_key.key = priv == NULL ? NULL : &priv;
526 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
528 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
529 OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
530 get_raw_key_details, &raw_key);
533 if (pkey->ameth == NULL) {
534 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
538 if (pkey->ameth->get_priv_key == NULL) {
539 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
543 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
544 EVPerr(0, EVP_R_GET_RAW_KEY_FAILED);
551 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
554 if (pkey->keymgmt != NULL) {
555 struct raw_key_details_st raw_key;
557 raw_key.key = pub == NULL ? NULL : &pub;
559 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
561 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
562 OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
563 get_raw_key_details, &raw_key);
566 if (pkey->ameth == NULL) {
567 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
571 if (pkey->ameth->get_pub_key == NULL) {
572 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
573 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
577 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
578 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
585 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
586 size_t len, const EVP_CIPHER *cipher)
588 # ifndef OPENSSL_NO_CMAC
589 # ifndef OPENSSL_NO_ENGINE
590 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
592 const char *cipher_name = EVP_CIPHER_name(cipher);
593 const OSSL_PROVIDER *prov = EVP_CIPHER_provider(cipher);
594 OPENSSL_CTX *libctx =
595 prov == NULL ? NULL : ossl_provider_library_context(prov);
596 EVP_PKEY *ret = EVP_PKEY_new();
597 EVP_MAC *cmac = EVP_MAC_fetch(libctx, OSSL_MAC_NAME_CMAC, NULL);
598 EVP_MAC_CTX *cmctx = cmac != NULL ? EVP_MAC_CTX_new(cmac) : NULL;
599 OSSL_PARAM params[4];
604 || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1, NULL)) {
605 /* EVPerr already called */
609 # ifndef OPENSSL_NO_ENGINE
610 if (engine_id != NULL)
612 OSSL_PARAM_construct_utf8_string("engine", (char *)engine_id, 0);
616 OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
617 (char *)cipher_name, 0);
619 OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
621 params[paramsn] = OSSL_PARAM_construct_end();
623 if (!EVP_MAC_CTX_set_params(cmctx, params)) {
624 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
628 ret->pkey.ptr = cmctx;
633 EVP_MAC_CTX_free(cmctx);
637 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
638 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
643 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
645 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
648 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
650 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
653 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
655 if (pkey->type == type) {
656 return 1; /* it already is that type */
660 * The application is requesting to alias this to a different pkey type,
661 * but not one that resolves to the base type.
663 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
664 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
672 # ifndef OPENSSL_NO_ENGINE
673 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
676 if (!ENGINE_init(e)) {
677 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
680 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
682 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
686 ENGINE_finish(pkey->pmeth_engine);
687 pkey->pmeth_engine = e;
691 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
696 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
700 #ifndef OPENSSL_NO_EC
701 if (EVP_PKEY_type(type) == EVP_PKEY_EC) {
702 const EC_GROUP *group = EC_KEY_get0_group(key);
704 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
705 alias = EVP_PKEY_SM2;
709 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
711 if (!EVP_PKEY_set_alias_type(pkey, alias))
713 pkey->pkey.ptr = key;
714 return (key != NULL);
717 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
719 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
720 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
723 return pkey->pkey.ptr;
726 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
728 ASN1_OCTET_STRING *os = NULL;
729 if (pkey->type != EVP_PKEY_HMAC) {
730 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
733 os = EVP_PKEY_get0(pkey);
738 # ifndef OPENSSL_NO_POLY1305
739 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
741 ASN1_OCTET_STRING *os = NULL;
742 if (pkey->type != EVP_PKEY_POLY1305) {
743 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
746 os = EVP_PKEY_get0(pkey);
752 # ifndef OPENSSL_NO_SIPHASH
753 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
755 ASN1_OCTET_STRING *os = NULL;
757 if (pkey->type != EVP_PKEY_SIPHASH) {
758 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
761 os = EVP_PKEY_get0(pkey);
767 # ifndef OPENSSL_NO_RSA
768 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
770 int ret = EVP_PKEY_assign_RSA(pkey, key);
776 RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
778 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
779 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
782 if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
783 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
786 return pkey->pkey.rsa;
789 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
791 RSA *ret = EVP_PKEY_get0_RSA(pkey);
798 # ifndef OPENSSL_NO_DSA
799 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
801 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
802 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
805 if (pkey->type != EVP_PKEY_DSA) {
806 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
809 return pkey->pkey.dsa;
812 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
814 int ret = EVP_PKEY_assign_DSA(pkey, key);
819 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
821 DSA *ret = EVP_PKEY_get0_DSA(pkey);
826 # endif /* OPENSSL_NO_DSA */
827 #endif /* FIPS_MODULE */
830 # ifndef OPENSSL_NO_EC
831 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
833 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
839 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
841 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
842 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
845 if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
846 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
849 return pkey->pkey.ec;
852 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
854 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
860 static int EVP_PKEY_set1_ECX_KEY(EVP_PKEY *pkey, int type, ECX_KEY *key)
862 int ret = EVP_PKEY_assign(pkey, type, key);
868 static ECX_KEY *EVP_PKEY_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
870 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
871 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
874 if (EVP_PKEY_base_id(pkey) != type) {
875 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
878 return pkey->pkey.ecx;
881 static ECX_KEY *EVP_PKEY_get1_ECX_KEY(EVP_PKEY *pkey, int type)
883 ECX_KEY *ret = EVP_PKEY_get0_ECX_KEY(pkey, type);
889 # define IMPLEMENT_ECX_VARIANT(NAME) \
890 int EVP_PKEY_set1_##NAME(EVP_PKEY *pkey, ECX_KEY *key) \
892 return EVP_PKEY_set1_ECX_KEY(pkey, EVP_PKEY_##NAME, key); \
894 ECX_KEY *EVP_PKEY_get0_##NAME(const EVP_PKEY *pkey) \
896 return EVP_PKEY_get0_ECX_KEY(pkey, EVP_PKEY_##NAME); \
898 ECX_KEY *EVP_PKEY_get1_##NAME(EVP_PKEY *pkey) \
900 return EVP_PKEY_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
902 IMPLEMENT_ECX_VARIANT(X25519)
903 IMPLEMENT_ECX_VARIANT(X448)
904 IMPLEMENT_ECX_VARIANT(ED25519)
905 IMPLEMENT_ECX_VARIANT(ED448)
909 # ifndef OPENSSL_NO_DH
911 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
913 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
914 int ret = EVP_PKEY_assign(pkey, type, key);
921 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
923 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
924 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
927 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
928 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
931 return pkey->pkey.dh;
934 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
936 DH *ret = EVP_PKEY_get0_DH(pkey);
943 int EVP_PKEY_type(int type)
946 const EVP_PKEY_ASN1_METHOD *ameth;
948 ameth = EVP_PKEY_asn1_find(&e, type);
950 ret = ameth->pkey_id;
953 # ifndef OPENSSL_NO_ENGINE
959 int EVP_PKEY_id(const EVP_PKEY *pkey)
964 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
966 return EVP_PKEY_type(pkey->type);
969 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
972 if (pkey->keymgmt == NULL) {
974 * These hard coded cases are pure hackery to get around the fact
975 * that names in crypto/objects/objects.txt are a mess. There is
976 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
977 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
978 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
979 * "DSA" is accurate... but still, better be safe and hard-code
980 * names that we know.
981 * TODO Clean this away along with all other #legacy support.
985 if (strcasecmp(name, "RSA") == 0)
987 else if (strcasecmp(name, "RSA-PSS") == 0)
988 type = EVP_PKEY_RSA_PSS;
989 #ifndef OPENSSL_NO_EC
990 else if (strcasecmp(name, "EC") == 0)
992 else if (strcasecmp(name, "ED25519") == 0)
993 type = EVP_PKEY_ED25519;
994 else if (strcasecmp(name, "ED448") == 0)
995 type = EVP_PKEY_ED448;
996 else if (strcasecmp(name, "X25519") == 0)
997 type = EVP_PKEY_X25519;
998 else if (strcasecmp(name, "X448") == 0)
999 type = EVP_PKEY_X448;
1001 #ifndef OPENSSL_NO_DH
1002 else if (strcasecmp(name, "DH") == 0)
1005 #ifndef OPENSSL_NO_DSA
1006 else if (strcasecmp(name, "DSA") == 0)
1007 type = EVP_PKEY_DSA;
1010 type = EVP_PKEY_type(OBJ_sn2nid(name));
1011 return EVP_PKEY_type(pkey->type) == type;
1014 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
1017 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1019 if (pkey->keymgmt == NULL) {
1020 switch (EVP_PKEY_base_id(pkey)) {
1023 #ifndef OPENSSL_NO_DSA
1027 #ifndef OPENSSL_NO_EC
1028 case EVP_PKEY_ED25519:
1029 case EVP_PKEY_ED448:
1031 case EVP_PKEY_EC: /* Including SM2 */
1032 return EC_KEY_can_sign(pkey->pkey.ec);
1038 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1039 OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
1040 const char *supported_sig =
1041 pkey->keymgmt->query_operation_name != NULL
1042 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1043 : evp_first_name(prov, pkey->keymgmt->name_id);
1044 EVP_SIGNATURE *signature = NULL;
1046 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1047 if (signature != NULL) {
1048 EVP_SIGNATURE_free(signature);
1055 #ifndef OPENSSL_NO_EC
1057 * TODO rewrite when we have proper data extraction functions
1058 * Note: an octet pointer would be desirable!
1060 static OSSL_CALLBACK get_ec_curve_name_cb;
1061 static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
1063 const OSSL_PARAM *p = NULL;
1065 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME)) != NULL)
1066 return OSSL_PARAM_get_utf8_string(p, arg, 0);
1068 /* If there is no curve name, this is not an EC key */
1072 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
1074 int ret = NID_undef;
1076 if (pkey->keymgmt == NULL) {
1077 if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
1078 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1080 ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1082 } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
1083 char *curve_name = NULL;
1085 ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
1086 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
1087 get_ec_curve_name_cb, &curve_name);
1089 ret = ec_curve_name2nid(curve_name);
1090 OPENSSL_free(curve_name);
1097 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1099 BIO_set_indent(*out, saved_indent);
1101 BIO *next = BIO_pop(*out);
1109 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1115 long i = BIO_get_indent(*out);
1117 *saved_indent = (i < 0 ? 0 : i);
1118 if (BIO_set_indent(*out, indent) <= 0) {
1119 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1123 if (BIO_set_indent(*out, indent) <= 0) {
1124 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1131 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1134 return BIO_indent(out, indent, 128)
1135 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1136 kstr, OBJ_nid2ln(pkey->type)) > 0;
1139 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1140 const char *propquery /* For provided serialization */,
1141 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1142 int indent, ASN1_PCTX *pctx),
1143 ASN1_PCTX *legacy_pctx /* For legacy print */)
1147 OSSL_SERIALIZER_CTX *ctx = NULL;
1148 int ret = -2; /* default to unsupported */
1150 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1153 ctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, propquery);
1154 if (OSSL_SERIALIZER_CTX_get_serializer(ctx) != NULL)
1155 ret = OSSL_SERIALIZER_to_bio(ctx, out);
1156 OSSL_SERIALIZER_CTX_free(ctx);
1161 /* legacy fallback */
1162 if (legacy_print != NULL)
1163 ret = legacy_print(out, pkey, 0, legacy_pctx);
1165 ret = unsup_alg(out, pkey, 0, "Public Key");
1168 print_reset_indent(&out, pop_f_prefix, saved_indent);
1172 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1173 int indent, ASN1_PCTX *pctx)
1175 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PUBKEY_TO_TEXT_PQ,
1176 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1180 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1181 int indent, ASN1_PCTX *pctx)
1183 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PrivateKey_TO_TEXT_PQ,
1184 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1188 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1189 int indent, ASN1_PCTX *pctx)
1191 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_Parameters_TO_TEXT_PQ,
1192 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1196 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1197 int arg1, void *arg2)
1199 if (pkey->keymgmt == NULL)
1202 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1204 char mdname[80] = "";
1206 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1211 nid = OBJ_sn2nid(mdname);
1212 if (nid == NID_undef)
1213 nid = OBJ_ln2nid(mdname);
1214 if (nid == NID_undef)
1224 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1226 if (pkey->ameth == NULL)
1227 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1228 if (pkey->ameth->pkey_ctrl == NULL)
1230 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1233 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1235 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1238 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1239 char *mdname, size_t mdname_sz)
1241 if (pkey->ameth == NULL)
1242 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1247 int nid = NID_undef;
1248 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1249 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1252 OPENSSL_strlcpy(mdname, name, mdname_sz);
1257 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1259 int rv, default_nid;
1261 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1264 * If there is a mandatory default digest and this isn't it, then
1265 * the answer is 'no'.
1267 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1269 return (nid == default_nid);
1270 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1277 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
1278 const unsigned char *pt, size_t ptlen)
1280 if (pkey->ameth == NULL) {
1281 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1283 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1287 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1288 (unsigned char *)pt, ptlen);
1289 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
1292 if (ptlen > INT_MAX)
1294 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
1300 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
1304 if (pkey->ameth == NULL) {
1305 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1307 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1311 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1313 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1316 *ppt = OPENSSL_malloc(params[0].return_size);
1321 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1322 *ppt, params[0].return_size);
1323 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1326 return params[0].return_size;
1330 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
1336 #endif /* FIPS_MODULE */
1338 /*- All methods below can also be used in FIPS_MODULE */
1340 EVP_PKEY *EVP_PKEY_new(void)
1342 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1345 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1348 ret->type = EVP_PKEY_NONE;
1349 ret->save_type = EVP_PKEY_NONE;
1350 ret->references = 1;
1351 ret->save_parameters = 1;
1352 ret->lock = CRYPTO_THREAD_lock_new();
1353 if (ret->lock == NULL) {
1354 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1358 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1359 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1366 CRYPTO_THREAD_lock_free(ret->lock);
1372 * Setup a public key management method.
1374 * For legacy keys, either |type| or |str| is expected to have the type
1375 * information. In this case, the setup consists of finding an ASN1 method
1376 * and potentially an ENGINE, and setting those fields in |pkey|.
1378 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1379 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1381 * If pkey is NULL just return 1 or 0 if the key management method exists.
1384 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1385 int len, EVP_KEYMGMT *keymgmt)
1388 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1389 ENGINE **eptr = (e == NULL) ? &e : NULL;
1393 * The setups can't set both legacy and provider side methods.
1396 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1397 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1398 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1406 free_it = free_it || pkey->pkey.ptr != NULL;
1408 free_it = free_it || pkey->keydata != NULL;
1410 evp_pkey_free_it(pkey);
1413 * If key type matches and a method exists then this lookup has
1414 * succeeded once so just indicate success.
1416 if (pkey->type != EVP_PKEY_NONE
1417 && type == pkey->save_type
1418 && pkey->ameth != NULL)
1420 # ifndef OPENSSL_NO_ENGINE
1421 /* If we have ENGINEs release them */
1422 ENGINE_finish(pkey->engine);
1423 pkey->engine = NULL;
1424 ENGINE_finish(pkey->pmeth_engine);
1425 pkey->pmeth_engine = NULL;
1431 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1432 else if (type != EVP_PKEY_NONE)
1433 ameth = EVP_PKEY_asn1_find(eptr, type);
1434 # ifndef OPENSSL_NO_ENGINE
1435 if (pkey == NULL && eptr != NULL)
1445 check = check && ameth == NULL;
1447 check = check && keymgmt == NULL;
1449 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
1454 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1455 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1459 pkey->keymgmt = keymgmt;
1461 pkey->save_type = type;
1466 * If the internal "origin" key is provider side, don't save |ameth|.
1467 * The main reason is that |ameth| is one factor to detect that the
1468 * internal "origin" key is a legacy one.
1470 if (keymgmt == NULL)
1471 pkey->ameth = ameth;
1475 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1476 * for any key type that has a legacy implementation, regardless of
1477 * if the internal key is a legacy or a provider side one. When
1478 * there is no legacy implementation for the key, the type becomes
1479 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1480 * with functions that expect legacy internal keys.
1483 pkey->type = ameth->pkey_id;
1485 pkey->type = EVP_PKEY_KEYMGMT;
1492 static void find_ameth(const char *name, void *data)
1494 const char **str = data;
1497 * The error messages from pkey_set_type() are uninteresting here,
1502 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1506 else if (str[1] == NULL)
1514 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1517 # define EVP_PKEY_TYPE_STR str[0]
1518 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1520 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1521 * Ideally, only one should be found. If two (or more) are found, the
1522 * match is ambiguous. This should never happen, but...
1524 const char *str[2] = { NULL, NULL };
1526 EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1527 if (str[1] != NULL) {
1528 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1532 # define EVP_PKEY_TYPE_STR NULL
1533 # define EVP_PKEY_TYPE_STRLEN -1
1535 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1536 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1539 #undef EVP_PKEY_TYPE_STR
1540 #undef EVP_PKEY_TYPE_STRLEN
1543 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1547 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1550 REF_PRINT_COUNT("EVP_PKEY", pkey);
1551 REF_ASSERT_ISNT(i < 2);
1552 return ((i > 1) ? 1 : 0);
1556 void evp_pkey_free_legacy(EVP_PKEY *x)
1558 if (x->ameth != NULL) {
1559 if (x->ameth->pkey_free != NULL)
1560 x->ameth->pkey_free(x);
1563 # ifndef OPENSSL_NO_ENGINE
1564 ENGINE_finish(x->engine);
1566 ENGINE_finish(x->pmeth_engine);
1567 x->pmeth_engine = NULL;
1570 #endif /* FIPS_MODULE */
1572 static void evp_pkey_free_it(EVP_PKEY *x)
1574 /* internal function; x is never NULL */
1576 evp_keymgmt_util_clear_operation_cache(x);
1578 evp_pkey_free_legacy(x);
1581 if (x->keymgmt != NULL) {
1582 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1583 EVP_KEYMGMT_free(x->keymgmt);
1587 x->type = EVP_PKEY_NONE;
1590 void EVP_PKEY_free(EVP_PKEY *x)
1597 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1598 REF_PRINT_COUNT("EVP_PKEY", x);
1601 REF_ASSERT_ISNT(i < 0);
1602 evp_pkey_free_it(x);
1604 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1606 CRYPTO_THREAD_lock_free(x->lock);
1608 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1613 int EVP_PKEY_size(const EVP_PKEY *pkey)
1618 size = pkey->cache.size;
1620 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1621 size = pkey->ameth->pkey_size(pkey);
1627 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
1628 EVP_KEYMGMT **keymgmt,
1629 const char *propquery)
1631 EVP_KEYMGMT *allocated_keymgmt = NULL;
1632 EVP_KEYMGMT *tmp_keymgmt = NULL;
1633 void *keydata = NULL;
1639 /* No key data => nothing to export */
1642 check = check && pk->pkey.ptr == NULL;
1644 check = check && pk->keydata == NULL;
1649 if (pk->pkey.ptr != NULL) {
1651 * If the legacy key doesn't have an dirty counter or export function,
1654 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1659 if (keymgmt != NULL) {
1660 tmp_keymgmt = *keymgmt;
1665 * If no keymgmt was given or found, get a default keymgmt. We do so by
1666 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1668 if (tmp_keymgmt == NULL) {
1669 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1671 tmp_keymgmt = ctx->keymgmt;
1672 ctx->keymgmt = NULL;
1673 EVP_PKEY_CTX_free(ctx);
1676 /* If there's still no keymgmt to be had, give up */
1677 if (tmp_keymgmt == NULL)
1681 if (pk->pkey.ptr != NULL) {
1685 * If the legacy "origin" hasn't changed since last time, we try
1686 * to find our keymgmt in the operation cache. If it has changed,
1687 * |i| remains zero, and we will clear the cache further down.
1689 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1690 i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1693 * If |tmp_keymgmt| is present in the operation cache, it means
1694 * that export doesn't need to be redone. In that case, we take
1695 * token copies of the cached pointers, to have token success
1698 if (i < OSSL_NELEM(pk->operation_cache)
1699 && pk->operation_cache[i].keymgmt != NULL) {
1700 keydata = pk->operation_cache[i].keydata;
1706 * TODO(3.0) Right now, we assume we have ample space. We will have
1707 * to think about a cache aging scheme, though, if |i| indexes outside
1710 if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1713 /* Make sure that the keymgmt key type matches the legacy NID */
1714 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1717 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1720 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1721 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1727 * If the dirty counter changed since last time, then clear the
1728 * operation cache. In that case, we know that |i| is zero. Just
1729 * in case this is a re-export, we increment then decrement the
1730 * keymgmt reference counter.
1732 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1733 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1737 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1738 evp_keymgmt_util_clear_operation_cache(pk);
1739 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1741 /* Add the new export to the operation cache */
1742 if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1743 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1748 /* Synchronize the dirty count */
1749 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1752 #endif /* FIPS_MODULE */
1754 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1758 * If nothing was exported, |tmp_keymgmt| might point at a freed
1759 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1760 * the caller either way in that case.
1762 if (keydata == NULL)
1765 if (keymgmt != NULL)
1766 *keymgmt = tmp_keymgmt;
1768 EVP_KEYMGMT_free(allocated_keymgmt);
1773 int evp_pkey_downgrade(EVP_PKEY *pk)
1775 EVP_KEYMGMT *keymgmt = pk->keymgmt;
1776 void *keydata = pk->keydata;
1777 int type = pk->type;
1778 const char *keytype = NULL;
1780 /* If this isn't a provider side key, we're done */
1781 if (keymgmt == NULL)
1784 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
1787 * If the type is EVP_PKEY_NONE, then we have a problem somewhere else
1788 * in our code. If it's not one of the well known EVP_PKEY_xxx values,
1789 * it should at least be EVP_PKEY_KEYMGMT at this point.
1790 * TODO(3.0) remove this check when we're confident that the rest of the
1791 * code treats this correctly.
1793 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1794 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1795 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1800 /* Prefer the legacy key type name for error reporting */
1801 if (type != EVP_PKEY_KEYMGMT)
1802 keytype = OBJ_nid2sn(type);
1805 * To be able to downgrade, we steal the provider side "origin" keymgmt
1806 * and keydata. We've already grabbed the pointers, so all we need to
1807 * do is clear those pointers in |pk| and then call evp_pkey_free_it().
1808 * That way, we can restore |pk| if we need to.
1812 evp_pkey_free_it(pk);
1813 if (EVP_PKEY_set_type(pk, type)) {
1814 /* If the key is typed but empty, we're done */
1815 if (keydata == NULL) {
1816 /* We're dropping the EVP_KEYMGMT */
1817 EVP_KEYMGMT_free(keymgmt);
1821 if (pk->ameth->import_from == NULL) {
1822 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1823 "key type = %s", keytype);
1826 * We perform the export in the same libctx as the keymgmt that we
1829 OPENSSL_CTX *libctx = ossl_provider_library_context(keymgmt->prov);
1830 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, NULL);
1832 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1835 && evp_keymgmt_export(keymgmt, keydata,
1836 OSSL_KEYMGMT_SELECT_ALL,
1837 pk->ameth->import_from, pctx)) {
1839 * Save the provider side data in the operation cache, so they'll
1840 * find it again. evp_pkey_free_it() cleared the cache, so it's
1841 * safe to assume slot zero is free.
1842 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1845 evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
1846 EVP_PKEY_CTX_free(pctx);
1848 /* Synchronize the dirty count */
1849 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1851 /* evp_keymgmt_export() increased the refcount... */
1852 EVP_KEYMGMT_free(keymgmt);
1855 EVP_PKEY_CTX_free(pctx);
1858 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1859 "key type = %s", keytype);
1863 * Something went wrong. This could for example happen if the keymgmt
1864 * turns out to be an HSM implementation that refuses to let go of some
1865 * of the key data, typically the private bits. In this case, we restore
1866 * the provider side internal "origin" and leave it at that.
1868 if (!ossl_assert(evp_keymgmt_util_assign_pkey(pk, keymgmt, keydata))) {
1869 /* This should not be impossible */
1870 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1873 /* evp_keymgmt_util_assign_pkey() increased the refcount... */
1874 EVP_KEYMGMT_free(keymgmt);
1875 return 0; /* No downgrade, but at least the key is restored */
1877 #endif /* FIPS_MODULE */
1879 const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
1882 || pkey->keymgmt == NULL
1883 || pkey->keydata == NULL)
1885 return evp_keymgmt_gettable_params(pkey->keymgmt);
1888 int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
1891 OSSL_PARAM params[2];
1892 unsigned char buffer[2048];
1893 unsigned char *buf = NULL;
1897 || pkey->keymgmt == NULL
1898 || pkey->keydata == NULL
1903 memset(buffer, 0, sizeof(buffer));
1904 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1905 params[1] = OSSL_PARAM_construct_end();
1906 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
1907 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1909 buf_sz = params[0].return_size;
1911 * If it failed because the buffer was too small then allocate the
1912 * required buffer size and retry.
1914 buf = OPENSSL_zalloc(buf_sz);
1917 params[0].data = buf;
1918 params[0].data_size = buf_sz;
1920 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1923 /* Fail if the param was not found */
1924 if (!OSSL_PARAM_modified(params))
1926 ret = OSSL_PARAM_get_BN(params, bn);
1932 int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
1933 unsigned char *buf, size_t max_buf_sz,
1936 OSSL_PARAM params[2];
1939 || pkey->keymgmt == NULL
1940 || pkey->keydata == NULL
1941 || key_name == NULL)
1944 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1945 params[1] = OSSL_PARAM_construct_end();
1946 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1947 || !OSSL_PARAM_modified(params))
1950 *out_sz = params[0].return_size;
1954 int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
1955 char *str, size_t max_buf_sz,
1958 OSSL_PARAM params[2];
1961 || pkey->keymgmt == NULL
1962 || pkey->keydata == NULL
1963 || key_name == NULL)
1966 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
1967 params[1] = OSSL_PARAM_construct_end();
1968 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1969 || !OSSL_PARAM_modified(params))
1972 *out_sz = params[0].return_size;
1976 int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
1978 OSSL_PARAM params[2];
1981 || pkey->keymgmt == NULL
1982 || pkey->keydata == NULL
1983 || key_name == NULL)
1986 params[0] = OSSL_PARAM_construct_int(key_name, out);
1987 params[1] = OSSL_PARAM_construct_end();
1988 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1989 || !OSSL_PARAM_modified(params))
1994 int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
1996 OSSL_PARAM params[2];
1999 || pkey->keymgmt == NULL
2000 || pkey->keydata == NULL
2001 || key_name == NULL)
2004 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2005 params[1] = OSSL_PARAM_construct_end();
2006 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2007 || !OSSL_PARAM_modified(params))