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 "crypto/asn1.h"
36 #include "crypto/evp.h"
37 #include "crypto/ecx.h"
38 #include "internal/evp.h"
39 #include "internal/provider.h"
40 #include "evp_local.h"
41 DEFINE_STACK_OF(X509_ATTRIBUTE)
43 #include "crypto/ec.h"
45 /* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
46 #include "e_os.h" /* strcasecmp on Windows */
48 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
49 int len, EVP_KEYMGMT *keymgmt);
50 static void evp_pkey_free_it(EVP_PKEY *key);
54 /* The type of parameters selected in key parameter functions */
55 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
57 int EVP_PKEY_bits(const EVP_PKEY *pkey)
60 if (pkey->ameth == NULL)
61 return pkey->cache.bits;
62 else if (pkey->ameth->pkey_bits)
63 return pkey->ameth->pkey_bits(pkey);
68 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
72 if (pkey->ameth == NULL)
73 return pkey->cache.security_bits;
74 if (pkey->ameth->pkey_security_bits == NULL)
76 return pkey->ameth->pkey_security_bits(pkey);
79 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
81 # ifndef OPENSSL_NO_DSA
82 if (pkey->type == EVP_PKEY_DSA) {
83 int ret = pkey->save_parameters;
86 pkey->save_parameters = mode;
90 # ifndef OPENSSL_NO_EC
91 if (pkey->type == EVP_PKEY_EC) {
92 int ret = pkey->save_parameters;
95 pkey->save_parameters = mode;
102 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
104 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
107 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
109 return CRYPTO_get_ex_data(&key->ex_data, idx);
112 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
115 * TODO: clean up legacy stuff from this function when legacy support
120 * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
121 * If that fails, this function fails.
123 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from))
124 if (!evp_pkey_downgrade((EVP_PKEY *)from))
128 * Make sure |to| is typed. Content is less important at this early
131 * 1. If |to| is untyped, assign |from|'s key type to it.
132 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
133 * (|from| was already downgraded above)
135 * If |to| is a provided key, there's nothing more to do here, functions
136 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
137 * further down help us find out if they are the same or not.
139 if (evp_pkey_is_blank(to)) {
140 if (evp_pkey_is_legacy(from)) {
141 if (EVP_PKEY_set_type(to, from->type) == 0)
144 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
147 } else if (evp_pkey_is_legacy(to)) {
148 if (to->type != from->type) {
149 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
154 if (EVP_PKEY_missing_parameters(from)) {
155 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
159 if (!EVP_PKEY_missing_parameters(to)) {
160 if (EVP_PKEY_parameters_eq(to, from) == 1)
162 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
166 /* For purely provided keys, we just call the keymgmt utility */
167 if (to->keymgmt != NULL && from->keymgmt != NULL)
168 return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
171 * If |to| is provided, we know that |from| is legacy at this point.
172 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
173 * to copy the appropriate data to |to|'s keydata.
175 if (to->keymgmt != NULL) {
176 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
178 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
182 * If we get a NULL, it could be an internal error, or it could be
183 * that there's a key mismatch. We're pretending the latter...
185 if (from_keydata == NULL) {
186 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
189 return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
193 /* Both keys are legacy */
194 if (from->ameth != NULL && from->ameth->param_copy != NULL)
195 return from->ameth->param_copy(to, from);
200 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
203 if (pkey->keymgmt != NULL)
204 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
205 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
206 return pkey->ameth->param_missing(pkey);
212 * This function is called for any mixture of keys except pure legacy pair.
213 * TODO When legacy keys are gone, we replace a call to this functions with
214 * a call to evp_keymgmt_util_match().
216 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
219 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
220 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
222 /* If none of them are provided, this function shouldn't have been called */
223 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
226 /* For purely provided keys, we just call the keymgmt utility */
227 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
228 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
231 * At this point, one of them is provided, the other not. This allows
232 * us to compare types using legacy NIDs.
234 if (evp_pkey_is_legacy(a)
235 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
236 return -1; /* not the same key type */
237 if (evp_pkey_is_legacy(b)
238 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
239 return -1; /* not the same key type */
242 * We've determined that they both are the same keytype, so the next
243 * step is to do a bit of cross export to ensure we have keydata for
244 * both keys in the same keymgmt.
246 keymgmt1 = a->keymgmt;
247 keydata1 = a->keydata;
248 keymgmt2 = b->keymgmt;
249 keydata2 = b->keydata;
251 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
253 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
254 if (tmp_keydata != NULL) {
256 keydata1 = tmp_keydata;
259 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
261 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
262 if (tmp_keydata != NULL) {
264 keydata2 = tmp_keydata;
268 /* If we still don't have matching keymgmt implementations, we give up */
269 if (keymgmt1 != keymgmt2)
272 /* If the keymgmt implementations are NULL, the export failed */
273 if (keymgmt1 == NULL)
276 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
279 #ifndef OPENSSL_NO_DEPRECATED_3_0
280 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
282 return EVP_PKEY_parameters_eq(a, b);
286 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
289 * TODO: clean up legacy stuff from this function when legacy support
293 if (a->keymgmt != NULL || b->keymgmt != NULL)
294 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
296 /* All legacy keys */
297 if (a->type != b->type)
299 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
300 return a->ameth->param_cmp(a, b);
304 #ifndef OPENSSL_NO_DEPRECATED_3_0
305 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
307 return EVP_PKEY_eq(a, b);
311 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
314 * TODO: clean up legacy stuff from this function when legacy support
318 if (a->keymgmt != NULL || b->keymgmt != NULL)
319 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
320 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
322 /* All legacy keys */
323 if (a->type != b->type)
326 if (a->ameth != NULL) {
328 /* Compare parameters if the algorithm has them */
329 if (a->ameth->param_cmp != NULL) {
330 ret = a->ameth->param_cmp(a, b);
335 if (a->ameth->pub_cmp != NULL)
336 return a->ameth->pub_cmp(a, b);
343 static EVP_PKEY *new_raw_key_int(OPENSSL_CTX *libctx,
348 const unsigned char *key,
352 EVP_PKEY *pkey = NULL;
353 EVP_PKEY_CTX *ctx = NULL;
354 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
357 # ifndef OPENSSL_NO_ENGINE
358 /* Check if there is an Engine for this type */
363 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
364 else if (nidtype != EVP_PKEY_NONE)
365 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
367 /* If tmpe is NULL then no engine is claiming to support this type */
375 if (e == NULL && ameth == NULL) {
377 * No engine is claiming to support this type, so lets see if we have
380 ctx = EVP_PKEY_CTX_new_from_name(libctx,
381 strtype != NULL ? strtype
382 : OBJ_nid2sn(nidtype),
386 /* May fail if no provider available */
388 if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
389 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
391 ERR_clear_last_mark();
392 params[0] = OSSL_PARAM_construct_octet_string(
393 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
394 : OSSL_PKEY_PARAM_PUB_KEY,
397 if (EVP_PKEY_fromdata(ctx, &pkey, params) != 1) {
398 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
402 EVP_PKEY_CTX_free(ctx);
407 /* else not supported so fallback to legacy */
410 /* Legacy code path */
412 pkey = EVP_PKEY_new();
414 EVPerr(0, ERR_R_MALLOC_FAILURE);
418 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
419 /* EVPerr already called */
423 if (!ossl_assert(pkey->ameth != NULL))
427 if (pkey->ameth->set_priv_key == NULL) {
428 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
432 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
433 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
437 if (pkey->ameth->set_pub_key == NULL) {
438 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
442 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
443 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
454 EVP_PKEY_CTX_free(ctx);
458 EVP_PKEY *EVP_PKEY_new_raw_private_key_with_libctx(OPENSSL_CTX *libctx,
461 const unsigned char *priv,
464 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
468 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
469 const unsigned char *priv,
472 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
475 EVP_PKEY *EVP_PKEY_new_raw_public_key_with_libctx(OPENSSL_CTX *libctx,
478 const unsigned char *pub,
481 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
485 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
486 const unsigned char *pub,
489 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
492 struct raw_key_details_st
499 static OSSL_CALLBACK get_raw_key_details;
500 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
502 const OSSL_PARAM *p = NULL;
503 struct raw_key_details_st *raw_key = arg;
505 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
506 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
508 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
509 SIZE_MAX, raw_key->len);
510 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
511 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
513 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
514 SIZE_MAX, raw_key->len);
520 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
523 if (pkey->keymgmt != NULL) {
524 struct raw_key_details_st raw_key;
526 raw_key.key = priv == NULL ? NULL : &priv;
528 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
530 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
531 OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
532 get_raw_key_details, &raw_key);
535 if (pkey->ameth == NULL) {
536 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
540 if (pkey->ameth->get_priv_key == NULL) {
541 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
545 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
546 EVPerr(0, EVP_R_GET_RAW_KEY_FAILED);
553 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
556 if (pkey->keymgmt != NULL) {
557 struct raw_key_details_st raw_key;
559 raw_key.key = pub == NULL ? NULL : &pub;
561 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
563 return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
564 OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
565 get_raw_key_details, &raw_key);
568 if (pkey->ameth == NULL) {
569 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
573 if (pkey->ameth->get_pub_key == NULL) {
574 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
575 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
579 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
580 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
587 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
588 const char *cipher_name,
589 const EVP_CIPHER *cipher, OPENSSL_CTX *libctx,
590 const char *propq, ENGINE *e)
592 # ifndef OPENSSL_NO_CMAC
593 # ifndef OPENSSL_NO_ENGINE
594 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
596 OSSL_PARAM params[5], *p = params;
597 EVP_PKEY *pkey = NULL;
601 cipher_name = EVP_CIPHER_name(cipher);
603 if (cipher_name == NULL) {
604 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
608 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
610 EVPerr(0, ERR_R_MALLOC_FAILURE);
614 if (!EVP_PKEY_key_fromdata_init(ctx)) {
615 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
619 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
621 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
622 (char *)cipher_name, 0);
624 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
626 # ifndef OPENSSL_NO_ENGINE
627 if (engine_id != NULL)
628 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
629 (char *)engine_id, 0);
631 *p = OSSL_PARAM_construct_end();
633 if (!EVP_PKEY_fromdata(ctx, &pkey, params)) {
634 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
639 EVP_PKEY_CTX_free(ctx);
643 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
648 EVP_PKEY *EVP_PKEY_new_CMAC_key_with_libctx(const unsigned char *priv,
650 const char *cipher_name,
654 return new_cmac_key_int(priv, len, cipher_name, NULL, libctx, propq, NULL);
657 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
658 size_t len, const EVP_CIPHER *cipher)
660 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
663 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
665 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
668 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
670 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
673 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
675 if (pkey->type == type) {
676 return 1; /* it already is that type */
680 * The application is requesting to alias this to a different pkey type,
681 * but not one that resolves to the base type.
683 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
684 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
692 # ifndef OPENSSL_NO_ENGINE
693 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
696 if (!ENGINE_init(e)) {
697 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
700 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
702 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
706 ENGINE_finish(pkey->pmeth_engine);
707 pkey->pmeth_engine = e;
711 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
716 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
720 #ifndef OPENSSL_NO_EC
721 if (EVP_PKEY_type(type) == EVP_PKEY_EC) {
722 const EC_GROUP *group = EC_KEY_get0_group(key);
724 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
725 alias = EVP_PKEY_SM2;
729 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
731 if (!EVP_PKEY_set_alias_type(pkey, alias))
733 pkey->pkey.ptr = key;
734 return (key != NULL);
737 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
741 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
742 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
745 return pkey->pkey.ptr;
748 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
750 ASN1_OCTET_STRING *os = NULL;
751 if (pkey->type != EVP_PKEY_HMAC) {
752 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
755 os = EVP_PKEY_get0(pkey);
760 # ifndef OPENSSL_NO_POLY1305
761 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
763 ASN1_OCTET_STRING *os = NULL;
764 if (pkey->type != EVP_PKEY_POLY1305) {
765 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
768 os = EVP_PKEY_get0(pkey);
774 # ifndef OPENSSL_NO_SIPHASH
775 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
777 ASN1_OCTET_STRING *os = NULL;
779 if (pkey->type != EVP_PKEY_SIPHASH) {
780 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
783 os = EVP_PKEY_get0(pkey);
789 # ifndef OPENSSL_NO_RSA
790 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
792 int ret = EVP_PKEY_assign_RSA(pkey, key);
798 RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
800 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
801 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
804 if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
805 EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
808 return pkey->pkey.rsa;
811 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
813 RSA *ret = EVP_PKEY_get0_RSA(pkey);
820 # ifndef OPENSSL_NO_DSA
821 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
823 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
824 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
827 if (pkey->type != EVP_PKEY_DSA) {
828 EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
831 return pkey->pkey.dsa;
834 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
836 int ret = EVP_PKEY_assign_DSA(pkey, key);
841 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
843 DSA *ret = EVP_PKEY_get0_DSA(pkey);
848 # endif /* OPENSSL_NO_DSA */
849 #endif /* FIPS_MODULE */
852 # ifndef OPENSSL_NO_EC
853 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
855 int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
861 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
863 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
864 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
867 if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
868 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
871 return pkey->pkey.ec;
874 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
876 EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
882 static int EVP_PKEY_set1_ECX_KEY(EVP_PKEY *pkey, int type, ECX_KEY *key)
884 int ret = EVP_PKEY_assign(pkey, type, key);
890 static ECX_KEY *EVP_PKEY_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
892 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
893 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
896 if (EVP_PKEY_base_id(pkey) != type) {
897 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
900 return pkey->pkey.ecx;
903 static ECX_KEY *EVP_PKEY_get1_ECX_KEY(EVP_PKEY *pkey, int type)
905 ECX_KEY *ret = EVP_PKEY_get0_ECX_KEY(pkey, type);
911 # define IMPLEMENT_ECX_VARIANT(NAME) \
912 int EVP_PKEY_set1_##NAME(EVP_PKEY *pkey, ECX_KEY *key) \
914 return EVP_PKEY_set1_ECX_KEY(pkey, EVP_PKEY_##NAME, key); \
916 ECX_KEY *EVP_PKEY_get0_##NAME(const EVP_PKEY *pkey) \
918 return EVP_PKEY_get0_ECX_KEY(pkey, EVP_PKEY_##NAME); \
920 ECX_KEY *EVP_PKEY_get1_##NAME(EVP_PKEY *pkey) \
922 return EVP_PKEY_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
924 IMPLEMENT_ECX_VARIANT(X25519)
925 IMPLEMENT_ECX_VARIANT(X448)
926 IMPLEMENT_ECX_VARIANT(ED25519)
927 IMPLEMENT_ECX_VARIANT(ED448)
931 # ifndef OPENSSL_NO_DH
933 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
935 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
936 int ret = EVP_PKEY_assign(pkey, type, key);
943 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
945 if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
946 ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
949 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
950 EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
953 return pkey->pkey.dh;
956 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
958 DH *ret = EVP_PKEY_get0_DH(pkey);
965 int EVP_PKEY_type(int type)
968 const EVP_PKEY_ASN1_METHOD *ameth;
970 ameth = EVP_PKEY_asn1_find(&e, type);
972 ret = ameth->pkey_id;
975 # ifndef OPENSSL_NO_ENGINE
981 int EVP_PKEY_id(const EVP_PKEY *pkey)
986 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
988 return EVP_PKEY_type(pkey->type);
992 int evp_pkey_name2type(const char *name)
995 * These hard coded cases are pure hackery to get around the fact
996 * that names in crypto/objects/objects.txt are a mess. There is
997 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
998 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
999 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
1000 * "DSA" is accurate... but still, better be safe and hard-code
1001 * names that we know.
1002 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
1003 * EVP_PKEY_EC, because of aliasing.
1004 * TODO Clean this away along with all other #legacy support.
1006 int type = NID_undef;
1008 if (strcasecmp(name, "RSA") == 0)
1009 type = EVP_PKEY_RSA;
1010 else if (strcasecmp(name, "RSA-PSS") == 0)
1011 type = EVP_PKEY_RSA_PSS;
1012 else if (strcasecmp(name, "EC") == 0)
1014 else if (strcasecmp(name, "ED25519") == 0)
1015 type = EVP_PKEY_ED25519;
1016 else if (strcasecmp(name, "ED448") == 0)
1017 type = EVP_PKEY_ED448;
1018 else if (strcasecmp(name, "X25519") == 0)
1019 type = EVP_PKEY_X25519;
1020 else if (strcasecmp(name, "X448") == 0)
1021 type = EVP_PKEY_X448;
1022 else if (strcasecmp(name, "SM2") == 0)
1023 type = EVP_PKEY_SM2;
1024 else if (strcasecmp(name, "DH") == 0)
1026 else if (strcasecmp(name, "X9.42 DH") == 0)
1027 type = EVP_PKEY_DHX;
1028 else if (strcasecmp(name, "DSA") == 0)
1029 type = EVP_PKEY_DSA;
1031 if (type == NID_undef)
1032 type = EVP_PKEY_type(OBJ_sn2nid(name));
1033 if (type == NID_undef)
1034 type = EVP_PKEY_type(OBJ_ln2nid(name));
1040 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
1043 if (pkey->keymgmt == NULL) {
1044 int type = evp_pkey_name2type(name);
1046 return pkey->type == type;
1049 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
1052 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1054 if (pkey->keymgmt == NULL) {
1055 switch (EVP_PKEY_base_id(pkey)) {
1058 #ifndef OPENSSL_NO_DSA
1062 #ifndef OPENSSL_NO_EC
1063 case EVP_PKEY_ED25519:
1064 case EVP_PKEY_ED448:
1066 case EVP_PKEY_EC: /* Including SM2 */
1067 return EC_KEY_can_sign(pkey->pkey.ec);
1073 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1074 OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
1075 const char *supported_sig =
1076 pkey->keymgmt->query_operation_name != NULL
1077 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1078 : evp_first_name(prov, pkey->keymgmt->name_id);
1079 EVP_SIGNATURE *signature = NULL;
1081 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1082 if (signature != NULL) {
1083 EVP_SIGNATURE_free(signature);
1090 #ifndef OPENSSL_NO_EC
1092 * TODO rewrite when we have proper data extraction functions
1093 * Note: an octet pointer would be desirable!
1095 static OSSL_CALLBACK get_ec_curve_name_cb;
1096 static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
1098 const OSSL_PARAM *p = NULL;
1100 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_GROUP_NAME)) != NULL)
1101 return OSSL_PARAM_get_utf8_string(p, arg, 0);
1103 /* If there is no curve name, this is not an EC key */
1107 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
1109 int ret = NID_undef;
1111 if (pkey->keymgmt == NULL) {
1112 if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
1113 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1115 ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1117 } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
1118 char *curve_name = NULL;
1120 ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
1121 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
1122 get_ec_curve_name_cb, &curve_name);
1124 ret = ec_curve_name2nid(curve_name);
1125 OPENSSL_free(curve_name);
1132 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1134 BIO_set_indent(*out, saved_indent);
1136 BIO *next = BIO_pop(*out);
1144 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1150 long i = BIO_get_indent(*out);
1152 *saved_indent = (i < 0 ? 0 : i);
1153 if (BIO_set_indent(*out, indent) <= 0) {
1154 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1158 if (BIO_set_indent(*out, indent) <= 0) {
1159 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1166 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1169 return BIO_indent(out, indent, 128)
1170 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1171 kstr, OBJ_nid2ln(pkey->type)) > 0;
1174 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1175 const char *propquery /* For provided encoding */,
1176 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1177 int indent, ASN1_PCTX *pctx),
1178 ASN1_PCTX *legacy_pctx /* For legacy print */)
1182 OSSL_ENCODER_CTX *ctx = NULL;
1183 int ret = -2; /* default to unsupported */
1185 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1188 ctx = OSSL_ENCODER_CTX_new_by_EVP_PKEY(pkey, propquery);
1189 if (OSSL_ENCODER_CTX_get_encoder(ctx) != NULL)
1190 ret = OSSL_ENCODER_to_bio(ctx, out);
1191 OSSL_ENCODER_CTX_free(ctx);
1196 /* legacy fallback */
1197 if (legacy_print != NULL)
1198 ret = legacy_print(out, pkey, 0, legacy_pctx);
1200 ret = unsup_alg(out, pkey, 0, "Public Key");
1203 print_reset_indent(&out, pop_f_prefix, saved_indent);
1207 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1208 int indent, ASN1_PCTX *pctx)
1210 return print_pkey(pkey, out, indent, OSSL_ENCODER_PUBKEY_TO_TEXT_PQ,
1211 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1215 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1216 int indent, ASN1_PCTX *pctx)
1218 return print_pkey(pkey, out, indent, OSSL_ENCODER_PrivateKey_TO_TEXT_PQ,
1219 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1223 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1224 int indent, ASN1_PCTX *pctx)
1226 return print_pkey(pkey, out, indent, OSSL_ENCODER_Parameters_TO_TEXT_PQ,
1227 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1231 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1232 int arg1, void *arg2)
1234 if (pkey->keymgmt == NULL)
1237 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1239 char mdname[80] = "";
1240 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1246 nid = OBJ_sn2nid(mdname);
1247 if (nid == NID_undef)
1248 nid = OBJ_ln2nid(mdname);
1258 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1260 if (pkey->ameth == NULL)
1261 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1262 if (pkey->ameth->pkey_ctrl == NULL)
1264 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1267 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1269 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1272 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1273 char *mdname, size_t mdname_sz)
1275 if (pkey->ameth == NULL)
1276 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1281 int nid = NID_undef;
1282 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1283 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1286 OPENSSL_strlcpy(mdname, name, mdname_sz);
1291 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1293 int rv, default_nid;
1295 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1298 * If there is a mandatory default digest and this isn't it, then
1299 * the answer is 'no'.
1301 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1303 return (nid == default_nid);
1304 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1311 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
1312 const unsigned char *pt, size_t ptlen)
1314 if (pkey->ameth == NULL) {
1315 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1317 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1321 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1322 (unsigned char *)pt, ptlen);
1323 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
1326 if (ptlen > INT_MAX)
1328 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
1334 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
1338 if (pkey->ameth == NULL) {
1339 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1341 if (pkey->keymgmt == NULL || pkey->keydata == NULL)
1345 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1347 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1350 *ppt = OPENSSL_malloc(params[0].return_size);
1355 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT,
1356 *ppt, params[0].return_size);
1357 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1360 return params[0].return_size;
1364 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
1370 #endif /* FIPS_MODULE */
1372 /*- All methods below can also be used in FIPS_MODULE */
1374 EVP_PKEY *EVP_PKEY_new(void)
1376 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1379 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1382 ret->type = EVP_PKEY_NONE;
1383 ret->save_type = EVP_PKEY_NONE;
1384 ret->references = 1;
1385 ret->save_parameters = 1;
1386 ret->lock = CRYPTO_THREAD_lock_new();
1387 if (ret->lock == NULL) {
1388 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1392 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1393 EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1400 CRYPTO_THREAD_lock_free(ret->lock);
1406 * Setup a public key management method.
1408 * For legacy keys, either |type| or |str| is expected to have the type
1409 * information. In this case, the setup consists of finding an ASN1 method
1410 * and potentially an ENGINE, and setting those fields in |pkey|.
1412 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1413 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1415 * If pkey is NULL just return 1 or 0 if the key management method exists.
1418 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1419 int len, EVP_KEYMGMT *keymgmt)
1422 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1423 ENGINE **eptr = (e == NULL) ? &e : NULL;
1427 * The setups can't set both legacy and provider side methods.
1430 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1431 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1432 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1440 free_it = free_it || pkey->pkey.ptr != NULL;
1442 free_it = free_it || pkey->keydata != NULL;
1444 evp_pkey_free_it(pkey);
1447 * If key type matches and a method exists then this lookup has
1448 * succeeded once so just indicate success.
1450 if (pkey->type != EVP_PKEY_NONE
1451 && type == pkey->save_type
1452 && pkey->ameth != NULL)
1454 # ifndef OPENSSL_NO_ENGINE
1455 /* If we have ENGINEs release them */
1456 ENGINE_finish(pkey->engine);
1457 pkey->engine = NULL;
1458 ENGINE_finish(pkey->pmeth_engine);
1459 pkey->pmeth_engine = NULL;
1465 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1466 else if (type != EVP_PKEY_NONE)
1467 ameth = EVP_PKEY_asn1_find(eptr, type);
1468 # ifndef OPENSSL_NO_ENGINE
1469 if (pkey == NULL && eptr != NULL)
1479 check = check && ameth == NULL;
1481 check = check && keymgmt == NULL;
1483 EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
1488 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1489 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1493 pkey->keymgmt = keymgmt;
1495 pkey->save_type = type;
1500 * If the internal "origin" key is provider side, don't save |ameth|.
1501 * The main reason is that |ameth| is one factor to detect that the
1502 * internal "origin" key is a legacy one.
1504 if (keymgmt == NULL)
1505 pkey->ameth = ameth;
1509 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1510 * for any key type that has a legacy implementation, regardless of
1511 * if the internal key is a legacy or a provider side one. When
1512 * there is no legacy implementation for the key, the type becomes
1513 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1514 * with functions that expect legacy internal keys.
1517 pkey->type = ameth->pkey_id;
1519 pkey->type = EVP_PKEY_KEYMGMT;
1526 static void find_ameth(const char *name, void *data)
1528 const char **str = data;
1531 * The error messages from pkey_set_type() are uninteresting here,
1536 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1540 else if (str[1] == NULL)
1548 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1551 # define EVP_PKEY_TYPE_STR str[0]
1552 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1554 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1555 * Ideally, only one should be found. If two (or more) are found, the
1556 * match is ambiguous. This should never happen, but...
1558 const char *str[2] = { NULL, NULL };
1560 EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1561 if (str[1] != NULL) {
1562 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1566 # define EVP_PKEY_TYPE_STR NULL
1567 # define EVP_PKEY_TYPE_STRLEN -1
1569 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1570 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1573 #undef EVP_PKEY_TYPE_STR
1574 #undef EVP_PKEY_TYPE_STRLEN
1577 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1581 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1584 REF_PRINT_COUNT("EVP_PKEY", pkey);
1585 REF_ASSERT_ISNT(i < 2);
1586 return ((i > 1) ? 1 : 0);
1590 void evp_pkey_free_legacy(EVP_PKEY *x)
1592 if (x->ameth != NULL) {
1593 if (x->ameth->pkey_free != NULL)
1594 x->ameth->pkey_free(x);
1597 # ifndef OPENSSL_NO_ENGINE
1598 ENGINE_finish(x->engine);
1600 ENGINE_finish(x->pmeth_engine);
1601 x->pmeth_engine = NULL;
1604 #endif /* FIPS_MODULE */
1606 static void evp_pkey_free_it(EVP_PKEY *x)
1608 /* internal function; x is never NULL */
1610 evp_keymgmt_util_clear_operation_cache(x);
1612 evp_pkey_free_legacy(x);
1615 if (x->keymgmt != NULL) {
1616 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1617 EVP_KEYMGMT_free(x->keymgmt);
1621 x->type = EVP_PKEY_NONE;
1624 void EVP_PKEY_free(EVP_PKEY *x)
1631 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1632 REF_PRINT_COUNT("EVP_PKEY", x);
1635 REF_ASSERT_ISNT(i < 0);
1636 evp_pkey_free_it(x);
1638 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1640 CRYPTO_THREAD_lock_free(x->lock);
1642 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1647 int EVP_PKEY_size(const EVP_PKEY *pkey)
1652 size = pkey->cache.size;
1654 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1655 size = pkey->ameth->pkey_size(pkey);
1661 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
1662 EVP_KEYMGMT **keymgmt,
1663 const char *propquery)
1665 EVP_KEYMGMT *allocated_keymgmt = NULL;
1666 EVP_KEYMGMT *tmp_keymgmt = NULL;
1667 void *keydata = NULL;
1673 /* No key data => nothing to export */
1676 check = check && pk->pkey.ptr == NULL;
1678 check = check && pk->keydata == NULL;
1683 if (pk->pkey.ptr != NULL) {
1685 * If the legacy key doesn't have an dirty counter or export function,
1688 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1693 if (keymgmt != NULL) {
1694 tmp_keymgmt = *keymgmt;
1699 * If no keymgmt was given or found, get a default keymgmt. We do so by
1700 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1702 if (tmp_keymgmt == NULL) {
1703 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1705 tmp_keymgmt = ctx->keymgmt;
1706 ctx->keymgmt = NULL;
1707 EVP_PKEY_CTX_free(ctx);
1710 /* If there's still no keymgmt to be had, give up */
1711 if (tmp_keymgmt == NULL)
1715 if (pk->pkey.ptr != NULL) {
1719 * If the legacy "origin" hasn't changed since last time, we try
1720 * to find our keymgmt in the operation cache. If it has changed,
1721 * |i| remains zero, and we will clear the cache further down.
1723 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1724 i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1727 * If |tmp_keymgmt| is present in the operation cache, it means
1728 * that export doesn't need to be redone. In that case, we take
1729 * token copies of the cached pointers, to have token success
1732 if (i < OSSL_NELEM(pk->operation_cache)
1733 && pk->operation_cache[i].keymgmt != NULL) {
1734 keydata = pk->operation_cache[i].keydata;
1740 * TODO(3.0) Right now, we assume we have ample space. We will have
1741 * to think about a cache aging scheme, though, if |i| indexes outside
1744 if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1747 /* Make sure that the keymgmt key type matches the legacy NID */
1748 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1751 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1754 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1755 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1761 * If the dirty counter changed since last time, then clear the
1762 * operation cache. In that case, we know that |i| is zero. Just
1763 * in case this is a re-export, we increment then decrement the
1764 * keymgmt reference counter.
1766 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1767 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1771 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1772 evp_keymgmt_util_clear_operation_cache(pk);
1773 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1775 /* Add the new export to the operation cache */
1776 if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1777 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1782 /* Synchronize the dirty count */
1783 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1786 #endif /* FIPS_MODULE */
1788 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1792 * If nothing was exported, |tmp_keymgmt| might point at a freed
1793 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1794 * the caller either way in that case.
1796 if (keydata == NULL)
1799 if (keymgmt != NULL)
1800 *keymgmt = tmp_keymgmt;
1802 EVP_KEYMGMT_free(allocated_keymgmt);
1807 int evp_pkey_downgrade(EVP_PKEY *pk)
1809 EVP_KEYMGMT *keymgmt = pk->keymgmt;
1810 void *keydata = pk->keydata;
1811 int type = pk->type;
1812 const char *keytype = NULL;
1814 /* If this isn't a provider side key, we're done */
1815 if (keymgmt == NULL)
1818 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
1821 * If the type is EVP_PKEY_NONE, then we have a problem somewhere else
1822 * in our code. If it's not one of the well known EVP_PKEY_xxx values,
1823 * it should at least be EVP_PKEY_KEYMGMT at this point.
1824 * TODO(3.0) remove this check when we're confident that the rest of the
1825 * code treats this correctly.
1827 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1828 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1829 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1834 /* Prefer the legacy key type name for error reporting */
1835 if (type != EVP_PKEY_KEYMGMT)
1836 keytype = OBJ_nid2sn(type);
1839 * To be able to downgrade, we steal the provider side "origin" keymgmt
1840 * and keydata. We've already grabbed the pointers, so all we need to
1841 * do is clear those pointers in |pk| and then call evp_pkey_free_it().
1842 * That way, we can restore |pk| if we need to.
1846 evp_pkey_free_it(pk);
1847 if (EVP_PKEY_set_type(pk, type)) {
1848 /* If the key is typed but empty, we're done */
1849 if (keydata == NULL) {
1850 /* We're dropping the EVP_KEYMGMT */
1851 EVP_KEYMGMT_free(keymgmt);
1855 if (pk->ameth->import_from == NULL) {
1856 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1857 "key type = %s", keytype);
1860 * We perform the export in the same libctx as the keymgmt that we
1863 OPENSSL_CTX *libctx = ossl_provider_library_context(keymgmt->prov);
1864 EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, NULL);
1866 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1869 && evp_keymgmt_export(keymgmt, keydata,
1870 OSSL_KEYMGMT_SELECT_ALL,
1871 pk->ameth->import_from, pctx)) {
1873 * Save the provider side data in the operation cache, so they'll
1874 * find it again. evp_pkey_free_it() cleared the cache, so it's
1875 * safe to assume slot zero is free.
1876 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1879 evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
1880 EVP_PKEY_CTX_free(pctx);
1882 /* Synchronize the dirty count */
1883 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1885 /* evp_keymgmt_export() increased the refcount... */
1886 EVP_KEYMGMT_free(keymgmt);
1889 EVP_PKEY_CTX_free(pctx);
1892 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1893 "key type = %s", keytype);
1897 * Something went wrong. This could for example happen if the keymgmt
1898 * turns out to be an HSM implementation that refuses to let go of some
1899 * of the key data, typically the private bits. In this case, we restore
1900 * the provider side internal "origin" and leave it at that.
1902 if (!ossl_assert(evp_keymgmt_util_assign_pkey(pk, keymgmt, keydata))) {
1903 /* This should not be impossible */
1904 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1907 /* evp_keymgmt_util_assign_pkey() increased the refcount... */
1908 EVP_KEYMGMT_free(keymgmt);
1909 return 0; /* No downgrade, but at least the key is restored */
1911 #endif /* FIPS_MODULE */
1913 const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
1916 || pkey->keymgmt == NULL
1917 || pkey->keydata == NULL)
1919 return EVP_KEYMGMT_gettable_params(pkey->keymgmt);
1922 int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
1925 OSSL_PARAM params[2];
1926 unsigned char buffer[2048];
1927 unsigned char *buf = NULL;
1931 || pkey->keymgmt == NULL
1932 || pkey->keydata == NULL
1937 memset(buffer, 0, sizeof(buffer));
1938 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1939 params[1] = OSSL_PARAM_construct_end();
1940 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
1941 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1943 buf_sz = params[0].return_size;
1945 * If it failed because the buffer was too small then allocate the
1946 * required buffer size and retry.
1948 buf = OPENSSL_zalloc(buf_sz);
1951 params[0].data = buf;
1952 params[0].data_size = buf_sz;
1954 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1957 /* Fail if the param was not found */
1958 if (!OSSL_PARAM_modified(params))
1960 ret = OSSL_PARAM_get_BN(params, bn);
1966 int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
1967 unsigned char *buf, size_t max_buf_sz,
1970 OSSL_PARAM params[2];
1973 || pkey->keymgmt == NULL
1974 || pkey->keydata == NULL
1975 || key_name == NULL)
1978 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1979 params[1] = OSSL_PARAM_construct_end();
1980 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1981 || !OSSL_PARAM_modified(params))
1984 *out_sz = params[0].return_size;
1988 int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
1989 char *str, size_t max_buf_sz,
1992 OSSL_PARAM params[2];
1995 || pkey->keymgmt == NULL
1996 || pkey->keydata == NULL
1997 || key_name == NULL)
2000 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2001 params[1] = OSSL_PARAM_construct_end();
2002 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2003 || !OSSL_PARAM_modified(params))
2006 *out_sz = params[0].return_size;
2010 int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
2012 OSSL_PARAM params[2];
2015 || pkey->keymgmt == NULL
2016 || pkey->keydata == NULL
2017 || key_name == NULL)
2020 params[0] = OSSL_PARAM_construct_int(key_name, out);
2021 params[1] = OSSL_PARAM_construct_end();
2022 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2023 || !OSSL_PARAM_modified(params))
2028 int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
2030 OSSL_PARAM params[2];
2033 || pkey->keymgmt == NULL
2034 || pkey->keydata == NULL
2035 || key_name == NULL)
2038 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2039 params[1] = OSSL_PARAM_construct_end();
2040 if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
2041 || !OSSL_PARAM_modified(params))