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 "internal/evp.h"
38 #include "internal/provider.h"
39 #include "evp_local.h"
40 DEFINE_STACK_OF(X509_ATTRIBUTE)
42 #include "crypto/ec.h"
44 /* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
45 #include "e_os.h" /* strcasecmp on Windows */
47 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
48 int len, EVP_KEYMGMT *keymgmt);
49 static void evp_pkey_free_it(EVP_PKEY *key);
53 /* The type of parameters selected in key parameter functions */
54 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
56 int EVP_PKEY_bits(const EVP_PKEY *pkey)
59 if (pkey->ameth == NULL)
60 return pkey->cache.bits;
61 else if (pkey->ameth->pkey_bits)
62 return pkey->ameth->pkey_bits(pkey);
67 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
71 if (pkey->ameth == NULL)
72 return pkey->cache.security_bits;
73 if (pkey->ameth->pkey_security_bits == NULL)
75 return pkey->ameth->pkey_security_bits(pkey);
78 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
80 # ifndef OPENSSL_NO_DSA
81 if (pkey->type == EVP_PKEY_DSA) {
82 int ret = pkey->save_parameters;
85 pkey->save_parameters = mode;
89 # ifndef OPENSSL_NO_EC
90 if (pkey->type == EVP_PKEY_EC) {
91 int ret = pkey->save_parameters;
94 pkey->save_parameters = mode;
101 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
103 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
106 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
108 return CRYPTO_get_ex_data(&key->ex_data, idx);
111 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
114 * TODO: clean up legacy stuff from this function when legacy support
119 * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
120 * If that fails, this function fails.
122 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from))
123 if (!evp_pkey_downgrade((EVP_PKEY *)from))
127 * Make sure |to| is typed. Content is less important at this early
130 * 1. If |to| is untyped, assign |from|'s key type to it.
131 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
132 * (|from| was already downgraded above)
134 * If |to| is a provided key, there's nothing more to do here, functions
135 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
136 * further down help us find out if they are the same or not.
138 if (evp_pkey_is_blank(to)) {
139 if (evp_pkey_is_legacy(from)) {
140 if (EVP_PKEY_set_type(to, from->type) == 0)
143 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
146 } else if (evp_pkey_is_legacy(to)) {
147 if (to->type != from->type) {
148 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
153 if (EVP_PKEY_missing_parameters(from)) {
154 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
158 if (!EVP_PKEY_missing_parameters(to)) {
159 if (EVP_PKEY_cmp_parameters(to, from) == 1)
161 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
165 /* For purely provided keys, we just call the keymgmt utility */
166 if (to->keymgmt != NULL && from->keymgmt != NULL)
167 return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
170 * If |to| is provided, we know that |from| is legacy at this point.
171 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
172 * to copy the appropriate data to |to|'s keydata.
174 if (to->keymgmt != NULL) {
175 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
177 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
181 * If we get a NULL, it could be an internal error, or it could be
182 * that there's a key mismatch. We're pretending the latter...
184 if (from_keydata == NULL) {
185 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
188 return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
192 /* Both keys are legacy */
193 if (from->ameth != NULL && from->ameth->param_copy != NULL)
194 return from->ameth->param_copy(to, from);
199 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
202 if (pkey->keymgmt != NULL)
203 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
204 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
205 return pkey->ameth->param_missing(pkey);
211 * This function is called for any mixture of keys except pure legacy pair.
212 * TODO When legacy keys are gone, we replace a call to this functions with
213 * a call to evp_keymgmt_util_match().
215 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
218 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
219 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
221 /* If none of them are provided, this function shouldn't have been called */
222 if (!ossl_assert(a->keymgmt != NULL || b->keymgmt != NULL))
225 /* For purely provided keys, we just call the keymgmt utility */
226 if (a->keymgmt != NULL && b->keymgmt != NULL)
227 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
230 * At this point, one of them is provided, the other not. This allows
231 * us to compare types using legacy NIDs.
233 if ((a->type != EVP_PKEY_NONE
234 && (b->keymgmt == NULL
235 || !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type))))
236 || (b->type != EVP_PKEY_NONE
237 && (a->keymgmt == NULL
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 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
278 * TODO: clean up legacy stuff from this function when legacy support
282 if (a->keymgmt != NULL || b->keymgmt != NULL)
283 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
285 /* All legacy keys */
286 if (a->type != b->type)
288 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
289 return a->ameth->param_cmp(a, b);
293 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
296 * TODO: clean up legacy stuff from this function when legacy support
300 if (a->keymgmt != NULL || b->keymgmt != NULL)
301 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
302 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
304 /* All legacy keys */
305 if (a->type != b->type)
308 if (a->ameth != NULL) {
310 /* Compare parameters if the algorithm has them */
311 if (a->ameth->param_cmp != NULL) {
312 ret = a->ameth->param_cmp(a, b);
317 if (a->ameth->pub_cmp != NULL)
318 return a->ameth->pub_cmp(a, b);
325 static EVP_PKEY *new_raw_key_int(OPENSSL_CTX *libctx,
330 const unsigned char *key,
334 EVP_PKEY *pkey = NULL;
335 EVP_PKEY_CTX *ctx = NULL;
336 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
339 # ifndef OPENSSL_NO_ENGINE
340 /* Check if there is an Engine for this type */
345 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
346 else if (nidtype != EVP_PKEY_NONE)
347 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
349 /* If tmpe is NULL then no engine is claiming to support this type */
357 if (e == NULL && ameth == NULL) {
359 * No engine is claiming to support this type, so lets see if we have
362 ctx = EVP_PKEY_CTX_new_from_name(libctx,
363 strtype != NULL ? strtype
364 : OBJ_nid2sn(nidtype),
367 EVPerr(0, ERR_R_MALLOC_FAILURE);
370 /* May fail if no provider available */
372 if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
373 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
375 ERR_clear_last_mark();
376 params[0] = OSSL_PARAM_construct_octet_string(
377 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
378 : OSSL_PKEY_PARAM_PUB_KEY,
381 if (EVP_PKEY_fromdata(ctx, &pkey, params) != 1) {
382 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
386 EVP_PKEY_CTX_free(ctx);
391 /* else not supported so fallback to legacy */
394 /* Legacy code path */
396 pkey = EVP_PKEY_new();
398 EVPerr(0, ERR_R_MALLOC_FAILURE);
402 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
403 /* EVPerr already called */
407 if (!ossl_assert(pkey->ameth != NULL))
411 if (pkey->ameth->set_priv_key == NULL) {
412 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
416 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
417 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
421 if (pkey->ameth->set_pub_key == NULL) {
422 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
426 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
427 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
438 EVP_PKEY_CTX_free(ctx);
442 EVP_PKEY *EVP_PKEY_new_raw_private_key_with_libctx(OPENSSL_CTX *libctx,
445 const unsigned char *priv,
448 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
452 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
453 const unsigned char *priv,
456 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
459 EVP_PKEY *EVP_PKEY_new_raw_public_key_with_libctx(OPENSSL_CTX *libctx,
462 const unsigned char *pub,
465 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
469 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
470 const unsigned char *pub,
473 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
476 struct raw_key_details_st
483 static OSSL_CALLBACK get_raw_key_details;
484 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
486 const OSSL_PARAM *p = NULL;
487 struct raw_key_details_st *raw_key = arg;
489 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
490 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
492 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
493 SIZE_MAX, raw_key->len);
494 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
495 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
497 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
498 SIZE_MAX, raw_key->len);
504 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
507 if (pkey->keymgmt != NULL) {
508 struct raw_key_details_st raw_key;
510 raw_key.key = priv == NULL ? NULL : &priv;
512 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
514 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
515 OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
516 get_raw_key_details, &raw_key);
519 if (pkey->ameth == NULL) {
520 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
524 if (pkey->ameth->get_priv_key == NULL) {
525 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
529 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
530 EVPerr(0, EVP_R_GET_RAW_KEY_FAILED);
537 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
540 if (pkey->keymgmt != NULL) {
541 struct raw_key_details_st raw_key;
543 raw_key.key = pub == NULL ? NULL : &pub;
545 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
547 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
548 OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
549 get_raw_key_details, &raw_key);
552 if (pkey->ameth == NULL) {
553 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
557 if (pkey->ameth->get_pub_key == NULL) {
558 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
559 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
563 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
564 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
571 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
572 size_t len, const EVP_CIPHER *cipher)
574 # ifndef OPENSSL_NO_CMAC
575 # ifndef OPENSSL_NO_ENGINE
576 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
578 const char *cipher_name = EVP_CIPHER_name(cipher);
579 const OSSL_PROVIDER *prov = EVP_CIPHER_provider(cipher);
580 OPENSSL_CTX *libctx =
581 prov == NULL ? NULL : ossl_provider_library_context(prov);
582 EVP_PKEY *ret = EVP_PKEY_new();
583 EVP_MAC *cmac = EVP_MAC_fetch(libctx, OSSL_MAC_NAME_CMAC, NULL);
584 EVP_MAC_CTX *cmctx = cmac != NULL ? EVP_MAC_CTX_new(cmac) : NULL;
585 OSSL_PARAM params[4];
590 || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1, NULL)) {
591 /* EVPerr already called */
595 # ifndef OPENSSL_NO_ENGINE
596 if (engine_id != NULL)
598 OSSL_PARAM_construct_utf8_string("engine", (char *)engine_id, 0);
602 OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
603 (char *)cipher_name, 0);
605 OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
607 params[paramsn] = OSSL_PARAM_construct_end();
609 if (!EVP_MAC_CTX_set_params(cmctx, params)) {
610 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
614 ret->pkey.ptr = cmctx;
619 EVP_MAC_CTX_free(cmctx);
623 EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
624 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
629 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
631 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
634 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
636 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
639 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
641 if (pkey->type == type) {
642 return 1; /* it already is that type */
646 * The application is requesting to alias this to a different pkey type,
647 * but not one that resolves to the base type.
649 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
650 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
658 # ifndef OPENSSL_NO_ENGINE
659 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
662 if (!ENGINE_init(e)) {
663 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
666 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
668 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
672 ENGINE_finish(pkey->pmeth_engine);
673 pkey->pmeth_engine = e;
677 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
682 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
686 #ifndef OPENSSL_NO_EC
687 if (EVP_PKEY_type(type) == EVP_PKEY_EC) {
688 const EC_GROUP *group = EC_KEY_get0_group(key);
690 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
691 alias = EVP_PKEY_SM2;
695 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
697 if (!EVP_PKEY_set_alias_type(pkey, alias))
699 pkey->pkey.ptr = key;
700 return (key != NULL);
703 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
705 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
706 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
709 return pkey->pkey.ptr;
712 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
714 ASN1_OCTET_STRING *os = NULL;
715 if (pkey->type != EVP_PKEY_HMAC) {
716 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
719 os = EVP_PKEY_get0(pkey);
724 # ifndef OPENSSL_NO_POLY1305
725 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
727 ASN1_OCTET_STRING *os = NULL;
728 if (pkey->type != EVP_PKEY_POLY1305) {
729 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
732 os = EVP_PKEY_get0(pkey);
738 # ifndef OPENSSL_NO_SIPHASH
739 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
741 ASN1_OCTET_STRING *os = NULL;
743 if (pkey->type != EVP_PKEY_SIPHASH) {
744 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
747 os = EVP_PKEY_get0(pkey);
753 # ifndef OPENSSL_NO_RSA
754 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
756 int ret = EVP_PKEY_assign_RSA(pkey, key);
762 RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
764 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
765 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
768 if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
769 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
772 return pkey->pkey.rsa;
775 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
777 RSA *ret = EVP_PKEY_get0_RSA(pkey);
784 # ifndef OPENSSL_NO_DSA
785 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
787 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
788 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
791 if (pkey->type != EVP_PKEY_DSA) {
792 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
795 return pkey->pkey.dsa;
798 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
800 int ret = EVP_PKEY_assign_DSA(pkey, key);
805 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
807 DSA *ret = EVP_PKEY_get0_DSA(pkey);
812 # endif /* OPENSSL_NO_DSA */
813 #endif /* FIPS_MODULE */
816 # ifndef OPENSSL_NO_EC
817 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
819 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
825 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
827 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
828 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
831 if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
832 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
835 return pkey->pkey.ec;
838 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
840 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
847 # ifndef OPENSSL_NO_DH
849 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
851 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
852 int ret = EVP_PKEY_assign(pkey, type, key);
859 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
861 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
862 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
865 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
866 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
869 return pkey->pkey.dh;
872 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
874 DH *ret = EVP_PKEY_get0_DH(pkey);
881 int EVP_PKEY_type(int type)
884 const EVP_PKEY_ASN1_METHOD *ameth;
886 ameth = EVP_PKEY_asn1_find(&e, type);
888 ret = ameth->pkey_id;
891 # ifndef OPENSSL_NO_ENGINE
897 int EVP_PKEY_id(const EVP_PKEY *pkey)
902 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
904 return EVP_PKEY_type(pkey->type);
907 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
910 if (pkey->keymgmt == NULL) {
912 * These hard coded cases are pure hackery to get around the fact
913 * that names in crypto/objects/objects.txt are a mess. There is
914 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
915 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
916 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
917 * "DSA" is accurate... but still, better be safe and hard-code
918 * names that we know.
919 * TODO Clean this away along with all other #legacy support.
923 if (strcasecmp(name, "RSA") == 0)
925 #ifndef OPENSSL_NO_EC
926 else if (strcasecmp(name, "EC") == 0)
929 #ifndef OPENSSL_NO_DSA
930 else if (strcasecmp(name, "DSA") == 0)
934 type = EVP_PKEY_type(OBJ_sn2nid(name));
935 return EVP_PKEY_type(pkey->type) == type;
938 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
941 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
943 if (pkey->keymgmt == NULL) {
944 switch (EVP_PKEY_base_id(pkey)) {
947 #ifndef OPENSSL_NO_DSA
951 #ifndef OPENSSL_NO_EC
952 case EVP_PKEY_ED25519:
955 case EVP_PKEY_EC: /* Including SM2 */
956 return EC_KEY_can_sign(pkey->pkey.ec);
962 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
963 OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
964 const char *supported_sig =
965 pkey->keymgmt->query_operation_name != NULL
966 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
967 : evp_first_name(prov, pkey->keymgmt->name_id);
968 EVP_SIGNATURE *signature = NULL;
970 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
971 if (signature != NULL) {
972 EVP_SIGNATURE_free(signature);
979 #ifndef OPENSSL_NO_EC
981 * TODO rewrite when we have proper data extraction functions
982 * Note: an octet pointer would be desirable!
984 static OSSL_CALLBACK get_ec_curve_name_cb;
985 static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
987 const OSSL_PARAM *p = NULL;
989 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_EC_NAME)) != NULL)
990 return OSSL_PARAM_get_utf8_string(p, arg, 0);
992 /* If there is no curve name, this is not an EC key */
996 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
1000 if (pkey->keymgmt == NULL) {
1001 if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
1002 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1004 ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1006 } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
1007 char *curve_name = NULL;
1009 ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
1010 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
1011 get_ec_curve_name_cb, &curve_name);
1013 ret = ec_curve_name2nid(curve_name);
1014 OPENSSL_free(curve_name);
1021 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1023 BIO_set_indent(*out, saved_indent);
1025 BIO *next = BIO_pop(*out);
1033 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1039 long i = BIO_get_indent(*out);
1041 *saved_indent = (i < 0 ? 0 : i);
1042 if (BIO_set_indent(*out, indent) <= 0) {
1043 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1047 if (BIO_set_indent(*out, indent) <= 0) {
1048 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1055 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1058 return BIO_indent(out, indent, 128)
1059 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1060 kstr, OBJ_nid2ln(pkey->type)) > 0;
1063 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1064 const char *propquery /* For provided serialization */,
1065 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1066 int indent, ASN1_PCTX *pctx),
1067 ASN1_PCTX *legacy_pctx /* For legacy print */)
1071 OSSL_SERIALIZER_CTX *ctx = NULL;
1072 int ret = -2; /* default to unsupported */
1074 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1077 ctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, propquery);
1078 if (OSSL_SERIALIZER_CTX_get_serializer(ctx) != NULL)
1079 ret = OSSL_SERIALIZER_to_bio(ctx, out);
1080 OSSL_SERIALIZER_CTX_free(ctx);
1085 /* legacy fallback */
1086 if (legacy_print != NULL)
1087 ret = legacy_print(out, pkey, 0, legacy_pctx);
1089 ret = unsup_alg(out, pkey, 0, "Public Key");
1092 print_reset_indent(&out, pop_f_prefix, saved_indent);
1096 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1097 int indent, ASN1_PCTX *pctx)
1099 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PUBKEY_TO_TEXT_PQ,
1100 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1104 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1105 int indent, ASN1_PCTX *pctx)
1107 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PrivateKey_TO_TEXT_PQ,
1108 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1112 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1113 int indent, ASN1_PCTX *pctx)
1115 return print_pkey(pkey, out, indent, OSSL_SERIALIZER_Parameters_TO_TEXT_PQ,
1116 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1120 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1121 int arg1, void *arg2)
1123 if (pkey->keymgmt == NULL)
1126 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1128 char mdname[80] = "";
1130 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1135 nid = OBJ_sn2nid(mdname);
1136 if (nid == NID_undef)
1137 nid = OBJ_ln2nid(mdname);
1138 if (nid == NID_undef)
1148 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1150 if (pkey->ameth == NULL)
1151 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1152 if (pkey->ameth->pkey_ctrl == NULL)
1154 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1157 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1159 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1162 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1163 char *mdname, size_t mdname_sz)
1165 if (pkey->ameth == NULL)
1166 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1171 int nid = NID_undef;
1172 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1173 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1176 OPENSSL_strlcpy(mdname, name, mdname_sz);
1181 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1183 int rv, default_nid;
1185 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1188 * If there is a mandatory default digest and this isn't it, then
1189 * the answer is 'no'.
1191 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1193 return (nid == default_nid);
1194 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1201 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
1202 const unsigned char *pt, size_t ptlen)
1204 if (ptlen > INT_MAX)
1206 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
1212 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
1215 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
1221 #endif /* FIPS_MODULE */
1223 /*- All methods below can also be used in FIPS_MODULE */
1225 EVP_PKEY *EVP_PKEY_new(void)
1227 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1230 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1233 ret->type = EVP_PKEY_NONE;
1234 ret->save_type = EVP_PKEY_NONE;
1235 ret->references = 1;
1236 ret->save_parameters = 1;
1237 ret->lock = CRYPTO_THREAD_lock_new();
1238 if (ret->lock == NULL) {
1239 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1243 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1244 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1251 CRYPTO_THREAD_lock_free(ret->lock);
1257 * Setup a public key management method.
1259 * For legacy keys, either |type| or |str| is expected to have the type
1260 * information. In this case, the setup consists of finding an ASN1 method
1261 * and potentially an ENGINE, and setting those fields in |pkey|.
1263 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1264 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1266 * If pkey is NULL just return 1 or 0 if the key management method exists.
1269 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1270 int len, EVP_KEYMGMT *keymgmt)
1273 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1274 ENGINE **eptr = (e == NULL) ? &e : NULL;
1278 * The setups can't set both legacy and provider side methods.
1281 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1282 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1283 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1291 free_it = free_it || pkey->pkey.ptr != NULL;
1293 free_it = free_it || pkey->keydata != NULL;
1295 evp_pkey_free_it(pkey);
1298 * If key type matches and a method exists then this lookup has
1299 * succeeded once so just indicate success.
1301 if (pkey->type != EVP_PKEY_NONE
1302 && type == pkey->save_type
1303 && pkey->ameth != NULL)
1305 # ifndef OPENSSL_NO_ENGINE
1306 /* If we have ENGINEs release them */
1307 ENGINE_finish(pkey->engine);
1308 pkey->engine = NULL;
1309 ENGINE_finish(pkey->pmeth_engine);
1310 pkey->pmeth_engine = NULL;
1316 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1317 else if (type != EVP_PKEY_NONE)
1318 ameth = EVP_PKEY_asn1_find(eptr, type);
1319 # ifndef OPENSSL_NO_ENGINE
1320 if (pkey == NULL && eptr != NULL)
1330 check = check && ameth == NULL;
1332 check = check && keymgmt == NULL;
1334 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
1339 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1340 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1344 pkey->keymgmt = keymgmt;
1346 pkey->save_type = type;
1351 * If the internal "origin" key is provider side, don't save |ameth|.
1352 * The main reason is that |ameth| is one factor to detect that the
1353 * internal "origin" key is a legacy one.
1355 if (keymgmt == NULL)
1356 pkey->ameth = ameth;
1360 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1361 * for any key type that has a legacy implementation, regardless of
1362 * if the internal key is a legacy or a provider side one. When
1363 * there is no legacy implementation for the key, the type becomes
1364 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1365 * with functions that expect legacy internal keys.
1368 pkey->type = ameth->pkey_id;
1370 pkey->type = EVP_PKEY_KEYMGMT;
1377 static void find_ameth(const char *name, void *data)
1379 const char **str = data;
1382 * The error messages from pkey_set_type() are uninteresting here,
1387 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1391 else if (str[1] == NULL)
1399 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1402 # define EVP_PKEY_TYPE_STR str[0]
1403 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1405 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1406 * Ideally, only one should be found. If two (or more) are found, the
1407 * match is ambiguous. This should never happen, but...
1409 const char *str[2] = { NULL, NULL };
1411 EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1412 if (str[1] != NULL) {
1413 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1417 # define EVP_PKEY_TYPE_STR NULL
1418 # define EVP_PKEY_TYPE_STRLEN -1
1420 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1421 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1424 #undef EVP_PKEY_TYPE_STR
1425 #undef EVP_PKEY_TYPE_STRLEN
1428 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1432 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1435 REF_PRINT_COUNT("EVP_PKEY", pkey);
1436 REF_ASSERT_ISNT(i < 2);
1437 return ((i > 1) ? 1 : 0);
1441 void evp_pkey_free_legacy(EVP_PKEY *x)
1443 if (x->ameth != NULL) {
1444 if (x->ameth->pkey_free != NULL)
1445 x->ameth->pkey_free(x);
1448 # ifndef OPENSSL_NO_ENGINE
1449 ENGINE_finish(x->engine);
1451 ENGINE_finish(x->pmeth_engine);
1452 x->pmeth_engine = NULL;
1455 #endif /* FIPS_MODULE */
1457 static void evp_pkey_free_it(EVP_PKEY *x)
1459 /* internal function; x is never NULL */
1461 evp_keymgmt_util_clear_operation_cache(x);
1463 evp_pkey_free_legacy(x);
1466 if (x->keymgmt != NULL) {
1467 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1468 EVP_KEYMGMT_free(x->keymgmt);
1472 x->type = EVP_PKEY_NONE;
1475 void EVP_PKEY_free(EVP_PKEY *x)
1482 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1483 REF_PRINT_COUNT("EVP_PKEY", x);
1486 REF_ASSERT_ISNT(i < 0);
1487 evp_pkey_free_it(x);
1489 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1491 CRYPTO_THREAD_lock_free(x->lock);
1493 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1498 int EVP_PKEY_size(const EVP_PKEY *pkey)
1503 size = pkey->cache.size;
1505 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1506 size = pkey->ameth->pkey_size(pkey);
1512 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
1513 EVP_KEYMGMT **keymgmt,
1514 const char *propquery)
1516 EVP_KEYMGMT *allocated_keymgmt = NULL;
1517 EVP_KEYMGMT *tmp_keymgmt = NULL;
1518 void *keydata = NULL;
1524 /* No key data => nothing to export */
1527 check = check && pk->pkey.ptr == NULL;
1529 check = check && pk->keydata == NULL;
1534 if (pk->pkey.ptr != NULL) {
1536 * If the legacy key doesn't have an dirty counter or export function,
1539 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1544 if (keymgmt != NULL) {
1545 tmp_keymgmt = *keymgmt;
1550 * If no keymgmt was given or found, get a default keymgmt. We do so by
1551 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1553 if (tmp_keymgmt == NULL) {
1554 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1556 tmp_keymgmt = ctx->keymgmt;
1557 ctx->keymgmt = NULL;
1558 EVP_PKEY_CTX_free(ctx);
1561 /* If there's still no keymgmt to be had, give up */
1562 if (tmp_keymgmt == NULL)
1566 if (pk->pkey.ptr != NULL) {
1570 * If the legacy "origin" hasn't changed since last time, we try
1571 * to find our keymgmt in the operation cache. If it has changed,
1572 * |i| remains zero, and we will clear the cache further down.
1574 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1575 i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1578 * If |tmp_keymgmt| is present in the operation cache, it means
1579 * that export doesn't need to be redone. In that case, we take
1580 * token copies of the cached pointers, to have token success
1583 if (i < OSSL_NELEM(pk->operation_cache)
1584 && pk->operation_cache[i].keymgmt != NULL) {
1585 keydata = pk->operation_cache[i].keydata;
1591 * TODO(3.0) Right now, we assume we have ample space. We will have
1592 * to think about a cache aging scheme, though, if |i| indexes outside
1595 if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1598 /* Make sure that the keymgmt key type matches the legacy NID */
1599 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1602 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1605 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1606 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1612 * If the dirty counter changed since last time, then clear the
1613 * operation cache. In that case, we know that |i| is zero. Just
1614 * in case this is a re-export, we increment then decrement the
1615 * keymgmt reference counter.
1617 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1618 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1622 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1623 evp_keymgmt_util_clear_operation_cache(pk);
1624 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1626 /* Add the new export to the operation cache */
1627 if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1628 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1633 /* Synchronize the dirty count */
1634 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1637 #endif /* FIPS_MODULE */
1639 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1643 * If nothing was exported, |tmp_keymgmt| might point at a freed
1644 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1645 * the caller either way in that case.
1647 if (keydata == NULL)
1650 if (keymgmt != NULL)
1651 *keymgmt = tmp_keymgmt;
1653 EVP_KEYMGMT_free(allocated_keymgmt);
1658 int evp_pkey_downgrade(EVP_PKEY *pk)
1660 EVP_KEYMGMT *keymgmt = pk->keymgmt;
1661 void *keydata = pk->keydata;
1662 int type = pk->type;
1663 const char *keytype = NULL;
1665 /* If this isn't a provider side key, we're done */
1666 if (keymgmt == NULL)
1669 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
1672 * If the type is EVP_PKEY_NONE, then we have a problem somewhere else
1673 * in our code. If it's not one of the well known EVP_PKEY_xxx values,
1674 * it should at least be EVP_PKEY_KEYMGMT at this point.
1675 * TODO(3.0) remove this check when we're confident that the rest of the
1676 * code treats this correctly.
1678 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1679 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1680 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1685 /* Prefer the legacy key type name for error reporting */
1686 if (type != EVP_PKEY_KEYMGMT)
1687 keytype = OBJ_nid2sn(type);
1690 * To be able to downgrade, we steal the provider side "origin" keymgmt
1691 * and keydata. We've already grabbed the pointers, so all we need to
1692 * do is clear those pointers in |pk| and then call evp_pkey_free_it().
1693 * That way, we can restore |pk| if we need to.
1697 evp_pkey_free_it(pk);
1698 if (EVP_PKEY_set_type(pk, type)) {
1699 /* If the key is typed but empty, we're done */
1700 if (keydata == NULL) {
1701 /* We're dropping the EVP_KEYMGMT */
1702 EVP_KEYMGMT_free(keymgmt);
1706 if (pk->ameth->import_from == NULL) {
1707 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1708 "key type = %s", keytype);
1711 * We perform the export in the same libctx as the keymgmt that we
1714 OPENSSL_CTX *libctx = ossl_provider_library_context(keymgmt->prov);
1715 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, NULL);
1717 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1720 && evp_keymgmt_export(keymgmt, keydata,
1721 OSSL_KEYMGMT_SELECT_ALL,
1722 pk->ameth->import_from, pctx)) {
1724 * Save the provider side data in the operation cache, so they'll
1725 * find it again. evp_pkey_free_it() cleared the cache, so it's
1726 * safe to assume slot zero is free.
1727 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1730 evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
1731 EVP_PKEY_CTX_free(pctx);
1733 /* Synchronize the dirty count */
1734 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1736 /* evp_keymgmt_export() increased the refcount... */
1737 EVP_KEYMGMT_free(keymgmt);
1740 EVP_PKEY_CTX_free(pctx);
1743 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1744 "key type = %s", keytype);
1748 * Something went wrong. This could for example happen if the keymgmt
1749 * turns out to be an HSM implementation that refuses to let go of some
1750 * of the key data, typically the private bits. In this case, we restore
1751 * the provider side internal "origin" and leave it at that.
1753 if (!ossl_assert(EVP_PKEY_set_type_by_keymgmt(pk, keymgmt))) {
1754 /* This should not be impossible */
1755 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1758 /* EVP_PKEY_set_type_by_keymgmt() increased the refcount... */
1759 EVP_KEYMGMT_free(keymgmt);
1760 pk->keydata = keydata;
1761 evp_keymgmt_util_cache_keyinfo(pk);
1762 return 0; /* No downgrade, but at least the key is restored */
1764 #endif /* FIPS_MODULE */
1766 const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
1769 || pkey->keymgmt == NULL
1770 || pkey->keydata == NULL)
1772 return evp_keymgmt_gettable_params(pkey->keymgmt);
1775 int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
1778 OSSL_PARAM params[2];
1779 unsigned char buffer[2048];
1780 unsigned char *buf = NULL;
1784 || pkey->keymgmt == NULL
1785 || pkey->keydata == NULL
1790 memset(buffer, 0, sizeof(buffer));
1791 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1792 params[1] = OSSL_PARAM_construct_end();
1793 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
1794 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1796 buf_sz = params[0].return_size;
1798 * If it failed because the buffer was too small then allocate the
1799 * required buffer size and retry.
1801 buf = OPENSSL_zalloc(buf_sz);
1804 params[0].data = buf;
1805 params[0].data_size = buf_sz;
1807 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1810 /* Fail if the param was not found */
1811 if (!OSSL_PARAM_modified(params))
1813 ret = OSSL_PARAM_get_BN(params, bn);
1819 int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
1820 unsigned char *buf, size_t max_buf_sz,
1823 OSSL_PARAM params[2];
1826 || pkey->keymgmt == NULL
1827 || pkey->keydata == NULL
1828 || key_name == NULL)
1831 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1832 params[1] = OSSL_PARAM_construct_end();
1833 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1834 || !OSSL_PARAM_modified(params))
1837 *out_sz = params[0].return_size;
1841 int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
1842 char *str, size_t max_buf_sz,
1845 OSSL_PARAM params[2];
1848 || pkey->keymgmt == NULL
1849 || pkey->keydata == NULL
1850 || key_name == NULL)
1853 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
1854 params[1] = OSSL_PARAM_construct_end();
1855 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1856 || !OSSL_PARAM_modified(params))
1859 *out_sz = params[0].return_size;
1863 int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
1865 OSSL_PARAM params[2];
1868 || pkey->keymgmt == NULL
1869 || pkey->keydata == NULL
1870 || key_name == NULL)
1873 params[0] = OSSL_PARAM_construct_int(key_name, out);
1874 params[1] = OSSL_PARAM_construct_end();
1875 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1876 || !OSSL_PARAM_modified(params))
1881 int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
1883 OSSL_PARAM params[2];
1886 || pkey->keymgmt == NULL
1887 || pkey->keydata == NULL
1888 || key_name == NULL)
1891 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
1892 params[1] = OSSL_PARAM_construct_end();
1893 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1894 || !OSSL_PARAM_modified(params))