2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * DSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
18 #include "internal/cryptlib.h"
19 #include "internal/refcount.h"
20 #include "internal/namemap.h"
21 #include <openssl/bn.h>
22 #include <openssl/err.h>
23 #include <openssl/objects.h>
24 #include <openssl/evp.h>
25 #include <openssl/x509.h>
26 #include <openssl/rsa.h>
27 #include <openssl/dsa.h>
28 #include <openssl/dh.h>
29 #include <openssl/ec.h>
30 #include <openssl/cmac.h>
31 #include <openssl/engine.h>
32 #include <openssl/params.h>
33 #include <openssl/param_build.h>
34 #include <openssl/encoder.h>
35 #include <openssl/core_names.h>
37 #include "internal/ffc.h"
38 #include "crypto/asn1.h"
39 #include "crypto/evp.h"
40 #include "crypto/ec.h"
41 #include "crypto/ecx.h"
42 #include "crypto/x509.h"
43 #include "internal/provider.h"
44 #include "evp_local.h"
46 #include "crypto/ec.h"
48 #include "e_os.h" /* strcasecmp on Windows */
50 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
51 int len, EVP_KEYMGMT *keymgmt);
52 static void evp_pkey_free_it(EVP_PKEY *key);
56 /* The type of parameters selected in key parameter functions */
57 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
59 int EVP_PKEY_bits(const EVP_PKEY *pkey)
64 size = pkey->cache.bits;
65 if (pkey->ameth != NULL && pkey->ameth->pkey_bits != NULL)
66 size = pkey->ameth->pkey_bits(pkey);
68 return size < 0 ? 0 : size;
71 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
76 size = pkey->cache.security_bits;
77 if (pkey->ameth != NULL && pkey->ameth->pkey_security_bits != NULL)
78 size = pkey->ameth->pkey_security_bits(pkey);
80 return size < 0 ? 0 : size;
83 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
85 # ifndef OPENSSL_NO_DSA
86 if (pkey->type == EVP_PKEY_DSA) {
87 int ret = pkey->save_parameters;
90 pkey->save_parameters = mode;
94 # ifndef OPENSSL_NO_EC
95 if (pkey->type == EVP_PKEY_EC) {
96 int ret = pkey->save_parameters;
99 pkey->save_parameters = mode;
106 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
108 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
111 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
113 return CRYPTO_get_ex_data(&key->ex_data, idx);
116 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
119 * Clean up legacy stuff from this function when legacy support is gone.
122 EVP_PKEY *downgraded_from = NULL;
126 * If |to| is a legacy key and |from| isn't, we must make a downgraded
127 * copy of |from|. If that fails, this function fails.
129 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from)) {
130 if (!evp_pkey_copy_downgraded(&downgraded_from, from))
132 from = downgraded_from;
136 * Make sure |to| is typed. Content is less important at this early
139 * 1. If |to| is untyped, assign |from|'s key type to it.
140 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
141 * (|from| was already downgraded above)
143 * If |to| is a provided key, there's nothing more to do here, functions
144 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
145 * further down help us find out if they are the same or not.
147 if (evp_pkey_is_blank(to)) {
148 if (evp_pkey_is_legacy(from)) {
149 if (EVP_PKEY_set_type(to, from->type) == 0)
152 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
155 } else if (evp_pkey_is_legacy(to)) {
156 if (to->type != from->type) {
157 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
162 if (EVP_PKEY_missing_parameters(from)) {
163 ERR_raise(ERR_LIB_EVP, EVP_R_MISSING_PARAMETERS);
167 if (!EVP_PKEY_missing_parameters(to)) {
168 if (EVP_PKEY_parameters_eq(to, from) == 1)
171 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_PARAMETERS);
175 /* For purely provided keys, we just call the keymgmt utility */
176 if (to->keymgmt != NULL && from->keymgmt != NULL) {
177 ok = evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
182 * If |to| is provided, we know that |from| is legacy at this point.
183 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_dup()
184 * to copy the appropriate data to |to|'s keydata.
185 * We cannot override existing data so do it only if there is no keydata
188 if (to->keymgmt != NULL && to->keydata == NULL) {
189 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
191 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
195 * If we get a NULL, it could be an internal error, or it could be
196 * that there's a key mismatch. We're pretending the latter...
198 if (from_keydata == NULL)
199 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
201 ok = (to->keydata = evp_keymgmt_dup(to->keymgmt,
203 SELECT_PARAMETERS)) != NULL;
207 /* Both keys are legacy */
208 if (from->ameth != NULL && from->ameth->param_copy != NULL)
209 ok = from->ameth->param_copy(to, from);
211 EVP_PKEY_free(downgraded_from);
215 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
218 if (pkey->keymgmt != NULL)
219 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
220 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
221 return pkey->ameth->param_missing(pkey);
227 * This function is called for any mixture of keys except pure legacy pair.
228 * When legacy keys are gone, we replace a call to this functions with
229 * a call to evp_keymgmt_util_match().
231 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
234 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
235 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
237 /* If none of them are provided, this function shouldn't have been called */
238 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
241 /* For purely provided keys, we just call the keymgmt utility */
242 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
243 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
246 * At this point, one of them is provided, the other not. This allows
247 * us to compare types using legacy NIDs.
249 if (evp_pkey_is_legacy(a)
250 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
251 return -1; /* not the same key type */
252 if (evp_pkey_is_legacy(b)
253 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
254 return -1; /* not the same key type */
257 * We've determined that they both are the same keytype, so the next
258 * step is to do a bit of cross export to ensure we have keydata for
259 * both keys in the same keymgmt.
261 keymgmt1 = a->keymgmt;
262 keydata1 = a->keydata;
263 keymgmt2 = b->keymgmt;
264 keydata2 = b->keydata;
266 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
268 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
269 if (tmp_keydata != NULL) {
271 keydata1 = tmp_keydata;
274 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
276 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
277 if (tmp_keydata != NULL) {
279 keydata2 = tmp_keydata;
283 /* If we still don't have matching keymgmt implementations, we give up */
284 if (keymgmt1 != keymgmt2)
287 /* If the keymgmt implementations are NULL, the export failed */
288 if (keymgmt1 == NULL)
291 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
294 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
296 return EVP_PKEY_parameters_eq(a, b);
299 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
302 * This will just call evp_keymgmt_util_match when legacy support
306 if (a->keymgmt != NULL || b->keymgmt != NULL)
307 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
309 /* All legacy keys */
310 if (a->type != b->type)
312 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
313 return a->ameth->param_cmp(a, b);
317 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
319 return EVP_PKEY_eq(a, b);
322 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
325 * This will just call evp_keymgmt_util_match when legacy support
329 if (a->keymgmt != NULL || b->keymgmt != NULL)
330 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
331 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
333 /* All legacy keys */
334 if (a->type != b->type)
337 if (a->ameth != NULL) {
339 /* Compare parameters if the algorithm has them */
340 if (a->ameth->param_cmp != NULL) {
341 ret = a->ameth->param_cmp(a, b);
346 if (a->ameth->pub_cmp != NULL)
347 return a->ameth->pub_cmp(a, b);
354 static EVP_PKEY *new_raw_key_int(OSSL_LIB_CTX *libctx,
359 const unsigned char *key,
363 EVP_PKEY *pkey = NULL;
364 EVP_PKEY_CTX *ctx = NULL;
365 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
368 # ifndef OPENSSL_NO_ENGINE
369 /* Check if there is an Engine for this type */
374 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
375 else if (nidtype != EVP_PKEY_NONE)
376 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
378 /* If tmpe is NULL then no engine is claiming to support this type */
386 if (e == NULL && ameth == NULL) {
388 * No engine is claiming to support this type, so lets see if we have
391 ctx = EVP_PKEY_CTX_new_from_name(libctx,
392 strtype != NULL ? strtype
393 : OBJ_nid2sn(nidtype),
397 /* May fail if no provider available */
399 if (EVP_PKEY_fromdata_init(ctx) == 1) {
400 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
402 ERR_clear_last_mark();
403 params[0] = OSSL_PARAM_construct_octet_string(
404 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
405 : OSSL_PKEY_PARAM_PUB_KEY,
408 if (EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params) != 1) {
409 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
413 EVP_PKEY_CTX_free(ctx);
418 /* else not supported so fallback to legacy */
421 /* Legacy code path */
423 pkey = EVP_PKEY_new();
425 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
429 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
430 /* EVPerr already called */
434 if (!ossl_assert(pkey->ameth != NULL))
438 if (pkey->ameth->set_priv_key == NULL) {
439 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
443 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
444 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
448 if (pkey->ameth->set_pub_key == NULL) {
449 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
453 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
454 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
465 EVP_PKEY_CTX_free(ctx);
469 EVP_PKEY *EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX *libctx,
472 const unsigned char *priv, size_t len)
474 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
478 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
479 const unsigned char *priv,
482 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
485 EVP_PKEY *EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX *libctx,
486 const char *keytype, const char *propq,
487 const unsigned char *pub, size_t len)
489 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
493 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
494 const unsigned char *pub,
497 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
500 struct raw_key_details_st
507 static OSSL_CALLBACK get_raw_key_details;
508 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
510 const OSSL_PARAM *p = NULL;
511 struct raw_key_details_st *raw_key = arg;
513 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
514 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
516 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
517 SIZE_MAX, raw_key->len);
518 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
519 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
521 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
522 SIZE_MAX, raw_key->len);
528 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
531 if (pkey->keymgmt != NULL) {
532 struct raw_key_details_st raw_key;
534 raw_key.key = priv == NULL ? NULL : &priv;
536 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
538 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
539 get_raw_key_details, &raw_key);
542 if (pkey->ameth == NULL) {
543 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
547 if (pkey->ameth->get_priv_key == NULL) {
548 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
552 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
553 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
560 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
563 if (pkey->keymgmt != NULL) {
564 struct raw_key_details_st raw_key;
566 raw_key.key = pub == NULL ? NULL : &pub;
568 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
570 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
571 get_raw_key_details, &raw_key);
574 if (pkey->ameth == NULL) {
575 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
579 if (pkey->ameth->get_pub_key == NULL) {
580 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
584 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
585 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
592 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
593 const char *cipher_name,
594 const EVP_CIPHER *cipher,
595 OSSL_LIB_CTX *libctx,
596 const char *propq, ENGINE *e)
598 # ifndef OPENSSL_NO_CMAC
599 # ifndef OPENSSL_NO_ENGINE
600 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
602 OSSL_PARAM params[5], *p = params;
603 EVP_PKEY *pkey = NULL;
607 cipher_name = EVP_CIPHER_name(cipher);
609 if (cipher_name == NULL) {
610 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
614 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
618 if (!EVP_PKEY_fromdata_init(ctx)) {
619 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
623 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
625 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
626 (char *)cipher_name, 0);
628 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
630 # ifndef OPENSSL_NO_ENGINE
631 if (engine_id != NULL)
632 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
633 (char *)engine_id, 0);
635 *p = OSSL_PARAM_construct_end();
637 if (!EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params)) {
638 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
643 EVP_PKEY_CTX_free(ctx);
647 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
652 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
653 size_t len, const EVP_CIPHER *cipher)
655 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
658 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
660 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
663 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
665 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
668 # ifndef OPENSSL_NO_ENGINE
669 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
672 if (!ENGINE_init(e)) {
673 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
676 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
678 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
682 ENGINE_finish(pkey->pmeth_engine);
683 pkey->pmeth_engine = e;
687 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
693 # ifndef OPENSSL_NO_DEPRECATED_3_0
694 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
696 # ifndef OPENSSL_NO_EC
699 pktype = EVP_PKEY_type(type);
700 if ((key != NULL) && (pktype == EVP_PKEY_EC || pktype == EVP_PKEY_SM2)) {
701 const EC_GROUP *group = EC_KEY_get0_group(key);
704 int curve = EC_GROUP_get_curve_name(group);
707 * Regardless of what is requested the SM2 curve must be SM2 type,
708 * and non SM2 curves are EC type.
710 if (curve == NID_sm2 && pktype == EVP_PKEY_EC)
712 else if(curve != NID_sm2 && pktype == EVP_PKEY_SM2)
718 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
721 pkey->pkey.ptr = key;
722 return (key != NULL);
726 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
731 if (!evp_pkey_is_provided(pkey))
732 return pkey->pkey.ptr;
737 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
739 const ASN1_OCTET_STRING *os = NULL;
740 if (pkey->type != EVP_PKEY_HMAC) {
741 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_AN_HMAC_KEY);
744 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
752 # ifndef OPENSSL_NO_POLY1305
753 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
755 const ASN1_OCTET_STRING *os = NULL;
756 if (pkey->type != EVP_PKEY_POLY1305) {
757 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_POLY1305_KEY);
760 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
769 # ifndef OPENSSL_NO_SIPHASH
770 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
772 const ASN1_OCTET_STRING *os = NULL;
774 if (pkey->type != EVP_PKEY_SIPHASH) {
775 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_SIPHASH_KEY);
778 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
787 # ifndef OPENSSL_NO_DSA
788 static DSA *evp_pkey_get0_DSA_int(const EVP_PKEY *pkey)
790 if (pkey->type != EVP_PKEY_DSA) {
791 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DSA_KEY);
794 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
797 const DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
799 return evp_pkey_get0_DSA_int(pkey);
802 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
804 int ret = EVP_PKEY_assign_DSA(pkey, key);
809 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
811 DSA *ret = evp_pkey_get0_DSA_int(pkey);
817 # endif /* OPENSSL_NO_DSA */
819 # ifndef OPENSSL_NO_EC
820 static const ECX_KEY *evp_pkey_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
822 if (EVP_PKEY_base_id(pkey) != type) {
823 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
826 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
829 static ECX_KEY *evp_pkey_get1_ECX_KEY(EVP_PKEY *pkey, int type)
831 ECX_KEY *ret = (ECX_KEY *)evp_pkey_get0_ECX_KEY(pkey, type);
833 if (ret != NULL && !ossl_ecx_key_up_ref(ret))
838 # define IMPLEMENT_ECX_VARIANT(NAME) \
839 ECX_KEY *ossl_evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
841 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
843 IMPLEMENT_ECX_VARIANT(X25519)
844 IMPLEMENT_ECX_VARIANT(X448)
845 IMPLEMENT_ECX_VARIANT(ED25519)
846 IMPLEMENT_ECX_VARIANT(ED448)
850 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
852 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
854 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
855 int ret = EVP_PKEY_assign(pkey, type, key);
862 DH *evp_pkey_get0_DH_int(const EVP_PKEY *pkey)
864 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
865 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DH_KEY);
868 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
871 const DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
873 return evp_pkey_get0_DH_int(pkey);
876 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
878 DH *ret = evp_pkey_get0_DH_int(pkey);
886 int EVP_PKEY_type(int type)
889 const EVP_PKEY_ASN1_METHOD *ameth;
891 ameth = EVP_PKEY_asn1_find(&e, type);
893 ret = ameth->pkey_id;
896 # ifndef OPENSSL_NO_ENGINE
902 int EVP_PKEY_id(const EVP_PKEY *pkey)
907 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
909 return EVP_PKEY_type(pkey->type);
913 * These hard coded cases are pure hackery to get around the fact
914 * that names in crypto/objects/objects.txt are a mess. There is
915 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
916 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
917 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
918 * "DSA" is accurate... but still, better be safe and hard-code
919 * names that we know.
920 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
921 * EVP_PKEY_EC, because of aliasing.
922 * This should be cleaned away along with all other #legacy support.
924 static const OSSL_ITEM standard_name2type[] = {
925 { EVP_PKEY_RSA, "RSA" },
926 { EVP_PKEY_RSA_PSS, "RSA-PSS" },
927 { EVP_PKEY_EC, "EC" },
928 { EVP_PKEY_ED25519, "ED25519" },
929 { EVP_PKEY_ED448, "ED448" },
930 { EVP_PKEY_X25519, "X25519" },
931 { EVP_PKEY_X448, "X448" },
932 { EVP_PKEY_SM2, "SM2" },
933 { EVP_PKEY_DH, "DH" },
934 { EVP_PKEY_DHX, "X9.42 DH" },
935 { EVP_PKEY_DHX, "DHX" },
936 { EVP_PKEY_DSA, "DSA" },
939 int evp_pkey_name2type(const char *name)
944 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
945 if (strcasecmp(name, standard_name2type[i].ptr) == 0)
946 return (int)standard_name2type[i].id;
949 if ((type = EVP_PKEY_type(OBJ_sn2nid(name))) != NID_undef)
951 return EVP_PKEY_type(OBJ_ln2nid(name));
954 const char *evp_pkey_type2name(int type)
958 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
959 if (type == (int)standard_name2type[i].id)
960 return standard_name2type[i].ptr;
963 return OBJ_nid2sn(type);
966 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
968 if (pkey->keymgmt == NULL) {
969 int type = evp_pkey_name2type(name);
971 return pkey->type == type;
973 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
976 int EVP_PKEY_type_names_do_all(const EVP_PKEY *pkey,
977 void (*fn)(const char *name, void *data),
980 if (!evp_pkey_is_typed(pkey))
983 if (!evp_pkey_is_provided(pkey)) {
984 const char *name = OBJ_nid2sn(EVP_PKEY_id(pkey));
989 return EVP_KEYMGMT_names_do_all(pkey->keymgmt, fn, data);
992 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
994 if (pkey->keymgmt == NULL) {
995 switch (EVP_PKEY_base_id(pkey)) {
998 # ifndef OPENSSL_NO_DSA
1002 # ifndef OPENSSL_NO_EC
1003 case EVP_PKEY_ED25519:
1004 case EVP_PKEY_ED448:
1006 case EVP_PKEY_EC: /* Including SM2 */
1007 return EC_KEY_can_sign(pkey->pkey.ec);
1013 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1014 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
1015 const char *supported_sig =
1016 pkey->keymgmt->query_operation_name != NULL
1017 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1018 : evp_first_name(prov, pkey->keymgmt->name_id);
1019 EVP_SIGNATURE *signature = NULL;
1021 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1022 if (signature != NULL) {
1023 EVP_SIGNATURE_free(signature);
1030 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1032 BIO_set_indent(*out, saved_indent);
1034 BIO *next = BIO_pop(*out);
1042 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1048 long i = BIO_get_indent(*out);
1050 *saved_indent = (i < 0 ? 0 : i);
1051 if (BIO_set_indent(*out, indent) <= 0) {
1052 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1056 if (BIO_set_indent(*out, indent) <= 0) {
1057 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1064 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1067 return BIO_indent(out, indent, 128)
1068 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1069 kstr, OBJ_nid2ln(pkey->type)) > 0;
1072 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1073 int selection /* For provided encoding */,
1074 const char *propquery /* For provided encoding */,
1075 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1076 int indent, ASN1_PCTX *pctx),
1077 ASN1_PCTX *legacy_pctx /* For legacy print */)
1081 OSSL_ENCODER_CTX *ctx = NULL;
1082 int ret = -2; /* default to unsupported */
1084 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1087 ctx = OSSL_ENCODER_CTX_new_for_pkey(pkey, selection, "TEXT", NULL,
1089 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0)
1090 ret = OSSL_ENCODER_to_bio(ctx, out);
1091 OSSL_ENCODER_CTX_free(ctx);
1096 /* legacy fallback */
1097 if (legacy_print != NULL)
1098 ret = legacy_print(out, pkey, 0, legacy_pctx);
1100 ret = unsup_alg(out, pkey, 0, "Public Key");
1103 print_reset_indent(&out, pop_f_prefix, saved_indent);
1107 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1108 int indent, ASN1_PCTX *pctx)
1110 return print_pkey(pkey, out, indent, EVP_PKEY_PUBLIC_KEY, NULL,
1111 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1115 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1116 int indent, ASN1_PCTX *pctx)
1118 return print_pkey(pkey, out, indent, EVP_PKEY_KEYPAIR, NULL,
1119 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1123 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1124 int indent, ASN1_PCTX *pctx)
1126 return print_pkey(pkey, out, indent, EVP_PKEY_KEY_PARAMETERS, NULL,
1127 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1131 # ifndef OPENSSL_NO_STDIO
1132 int EVP_PKEY_print_public_fp(FILE *fp, const EVP_PKEY *pkey,
1133 int indent, ASN1_PCTX *pctx)
1136 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1140 ret = EVP_PKEY_print_public(b, pkey, indent, pctx);
1145 int EVP_PKEY_print_private_fp(FILE *fp, const EVP_PKEY *pkey,
1146 int indent, ASN1_PCTX *pctx)
1149 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1153 ret = EVP_PKEY_print_private(b, pkey, indent, pctx);
1158 int EVP_PKEY_print_params_fp(FILE *fp, const EVP_PKEY *pkey,
1159 int indent, ASN1_PCTX *pctx)
1162 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1166 ret = EVP_PKEY_print_params(b, pkey, indent, pctx);
1172 static void mdname2nid(const char *mdname, void *data)
1174 int *nid = (int *)data;
1176 if (*nid != NID_undef)
1179 *nid = OBJ_sn2nid(mdname);
1180 if (*nid == NID_undef)
1181 *nid = OBJ_ln2nid(mdname);
1184 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1185 int arg1, void *arg2)
1187 if (pkey->keymgmt == NULL)
1190 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1192 char mdname[80] = "";
1193 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1198 OSSL_LIB_CTX *libctx = ossl_provider_libctx(pkey->keymgmt->prov);
1199 /* Make sure the MD is in the namemap if available */
1200 EVP_MD *md = EVP_MD_fetch(libctx, mdname, NULL);
1201 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
1202 int nid = NID_undef;
1205 * The only reason to fetch the MD was to make sure it is in the
1206 * namemap. We can immediately free it.
1209 mdnum = ossl_namemap_name2num(namemap, mdname);
1214 * We have the namemap number - now we need to find the
1217 if (!ossl_namemap_doall_names(namemap, mdnum, mdname2nid, &nid))
1228 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1230 if (pkey->ameth == NULL)
1231 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1232 if (pkey->ameth->pkey_ctrl == NULL)
1234 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1237 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1239 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1242 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1243 char *mdname, size_t mdname_sz)
1245 if (pkey->ameth == NULL)
1246 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1251 int nid = NID_undef;
1252 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1253 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1256 OPENSSL_strlcpy(mdname, name, mdname_sz);
1261 int EVP_PKEY_get_group_name(const EVP_PKEY *pkey, char *gname, size_t gname_sz,
1264 return EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_GROUP_NAME,
1265 gname, gname_sz, gname_len);
1268 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1270 int rv, default_nid;
1272 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1275 * If there is a mandatory default digest and this isn't it, then
1276 * the answer is 'no'.
1278 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1280 return (nid == default_nid);
1281 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1288 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, const unsigned char *pub,
1291 if (pkey != NULL && evp_pkey_is_provided(pkey))
1293 EVP_PKEY_set_octet_string_param(pkey,
1294 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1295 (unsigned char *)pub, publen);
1297 if (publen > INT_MAX)
1299 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1300 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, publen,
1306 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub)
1310 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
1311 size_t return_size = OSSL_PARAM_UNMODIFIED;
1314 * We know that this is going to fail, but it will give us a size
1317 EVP_PKEY_get_octet_string_param(pkey,
1318 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1319 NULL, 0, &return_size);
1320 if (return_size == OSSL_PARAM_UNMODIFIED)
1323 *ppub = OPENSSL_malloc(return_size);
1327 if (!EVP_PKEY_get_octet_string_param(pkey,
1328 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1329 *ppub, return_size, NULL))
1335 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppub);
1341 #endif /* FIPS_MODULE */
1343 /*- All methods below can also be used in FIPS_MODULE */
1345 EVP_PKEY *EVP_PKEY_new(void)
1347 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1350 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1354 ret->type = EVP_PKEY_NONE;
1355 ret->save_type = EVP_PKEY_NONE;
1356 ret->references = 1;
1357 ret->save_parameters = 1;
1359 ret->lock = CRYPTO_THREAD_lock_new();
1360 if (ret->lock == NULL) {
1361 EVPerr(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1366 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1367 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1374 CRYPTO_THREAD_lock_free(ret->lock);
1380 * Setup a public key management method.
1382 * For legacy keys, either |type| or |str| is expected to have the type
1383 * information. In this case, the setup consists of finding an ASN1 method
1384 * and potentially an ENGINE, and setting those fields in |pkey|.
1386 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1387 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1389 * If pkey is NULL just return 1 or 0 if the key management method exists.
1392 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1393 int len, EVP_KEYMGMT *keymgmt)
1396 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1397 ENGINE **eptr = (e == NULL) ? &e : NULL;
1401 * The setups can't set both legacy and provider side methods.
1404 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1405 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1406 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1414 free_it = free_it || pkey->pkey.ptr != NULL;
1416 free_it = free_it || pkey->keydata != NULL;
1418 evp_pkey_free_it(pkey);
1421 * If key type matches and a method exists then this lookup has
1422 * succeeded once so just indicate success.
1424 if (pkey->type != EVP_PKEY_NONE
1425 && type == pkey->save_type
1426 && pkey->ameth != NULL)
1428 # ifndef OPENSSL_NO_ENGINE
1429 /* If we have ENGINEs release them */
1430 ENGINE_finish(pkey->engine);
1431 pkey->engine = NULL;
1432 ENGINE_finish(pkey->pmeth_engine);
1433 pkey->pmeth_engine = NULL;
1439 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1440 else if (type != EVP_PKEY_NONE)
1441 ameth = EVP_PKEY_asn1_find(eptr, type);
1442 # ifndef OPENSSL_NO_ENGINE
1443 if (pkey == NULL && eptr != NULL)
1453 check = check && ameth == NULL;
1455 check = check && keymgmt == NULL;
1457 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
1462 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1463 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1467 pkey->keymgmt = keymgmt;
1469 pkey->save_type = type;
1474 * If the internal "origin" key is provider side, don't save |ameth|.
1475 * The main reason is that |ameth| is one factor to detect that the
1476 * internal "origin" key is a legacy one.
1478 if (keymgmt == NULL)
1479 pkey->ameth = ameth;
1483 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1484 * for any key type that has a legacy implementation, regardless of
1485 * if the internal key is a legacy or a provider side one. When
1486 * there is no legacy implementation for the key, the type becomes
1487 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1488 * with functions that expect legacy internal keys.
1490 if (ameth != NULL) {
1491 if (type == EVP_PKEY_NONE)
1492 pkey->type = ameth->pkey_id;
1494 pkey->type = EVP_PKEY_KEYMGMT;
1502 static void find_ameth(const char *name, void *data)
1504 const char **str = data;
1507 * The error messages from pkey_set_type() are uninteresting here,
1512 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1516 else if (str[1] == NULL)
1524 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1527 # define EVP_PKEY_TYPE_STR str[0]
1528 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1530 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1531 * Ideally, only one should be found. If two (or more) are found, the
1532 * match is ambiguous. This should never happen, but...
1534 const char *str[2] = { NULL, NULL };
1536 if (!EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str)
1537 || str[1] != NULL) {
1538 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1542 # define EVP_PKEY_TYPE_STR NULL
1543 # define EVP_PKEY_TYPE_STRLEN -1
1545 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1546 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1549 #undef EVP_PKEY_TYPE_STR
1550 #undef EVP_PKEY_TYPE_STRLEN
1553 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1557 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1560 REF_PRINT_COUNT("EVP_PKEY", pkey);
1561 REF_ASSERT_ISNT(i < 2);
1562 return ((i > 1) ? 1 : 0);
1566 EVP_PKEY *EVP_PKEY_dup(EVP_PKEY *pkey)
1571 ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
1575 if ((dup_pk = EVP_PKEY_new()) == NULL)
1578 if (evp_pkey_is_blank(pkey))
1581 if (evp_pkey_is_provided(pkey)) {
1582 if (!evp_keymgmt_util_copy(dup_pk, pkey,
1583 OSSL_KEYMGMT_SELECT_ALL))
1588 if (evp_pkey_is_legacy(pkey)) {
1589 const EVP_PKEY_ASN1_METHOD *ameth = pkey->ameth;
1591 if (ameth == NULL || ameth->copy == NULL) {
1592 if (pkey->pkey.ptr == NULL /* empty key, just set type */
1593 && EVP_PKEY_set_type(dup_pk, pkey->type) != 0)
1595 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1598 if (!ameth->copy(dup_pk, pkey))
1605 /* copy auxiliary data */
1606 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EVP_PKEY,
1607 &dup_pk->ex_data, &pkey->ex_data))
1610 if (pkey->attributes != NULL) {
1611 if ((dup_pk->attributes = ossl_x509at_dup(pkey->attributes)) == NULL)
1616 EVP_PKEY_free(dup_pk);
1620 void evp_pkey_free_legacy(EVP_PKEY *x)
1622 const EVP_PKEY_ASN1_METHOD *ameth = x->ameth;
1623 ENGINE *tmpe = NULL;
1625 if (ameth == NULL && x->legacy_cache_pkey.ptr != NULL)
1626 ameth = EVP_PKEY_asn1_find(&tmpe, x->type);
1628 if (ameth != NULL) {
1629 if (x->legacy_cache_pkey.ptr != NULL) {
1631 * We should never have both a legacy origin key, and a key in the
1634 assert(x->pkey.ptr == NULL);
1636 * For the purposes of freeing we make the legacy cache look like
1637 * a legacy origin key.
1639 x->pkey = x->legacy_cache_pkey;
1640 x->legacy_cache_pkey.ptr = NULL;
1642 if (ameth->pkey_free != NULL)
1643 ameth->pkey_free(x);
1646 # ifndef OPENSSL_NO_ENGINE
1647 ENGINE_finish(tmpe);
1648 ENGINE_finish(x->engine);
1650 ENGINE_finish(x->pmeth_engine);
1651 x->pmeth_engine = NULL;
1654 #endif /* FIPS_MODULE */
1656 static void evp_pkey_free_it(EVP_PKEY *x)
1658 /* internal function; x is never NULL */
1659 evp_keymgmt_util_clear_operation_cache(x, 1);
1661 evp_pkey_free_legacy(x);
1664 if (x->keymgmt != NULL) {
1665 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1666 EVP_KEYMGMT_free(x->keymgmt);
1670 x->type = EVP_PKEY_NONE;
1673 void EVP_PKEY_free(EVP_PKEY *x)
1680 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1681 REF_PRINT_COUNT("EVP_PKEY", x);
1684 REF_ASSERT_ISNT(i < 0);
1685 evp_pkey_free_it(x);
1687 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1689 CRYPTO_THREAD_lock_free(x->lock);
1691 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1696 int EVP_PKEY_size(const EVP_PKEY *pkey)
1701 size = pkey->cache.size;
1703 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1704 size = pkey->ameth->pkey_size(pkey);
1707 return size < 0 ? 0 : size;
1710 const char *EVP_PKEY_description(const EVP_PKEY *pkey)
1712 if (!evp_pkey_is_assigned(pkey))
1715 if (evp_pkey_is_provided(pkey) && pkey->keymgmt->description != NULL)
1716 return pkey->keymgmt->description;
1718 if (pkey->ameth != NULL)
1719 return pkey->ameth->info;
1724 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OSSL_LIB_CTX *libctx,
1725 EVP_KEYMGMT **keymgmt,
1726 const char *propquery)
1728 EVP_KEYMGMT *allocated_keymgmt = NULL;
1729 EVP_KEYMGMT *tmp_keymgmt = NULL;
1730 void *keydata = NULL;
1736 /* No key data => nothing to export */
1739 check = check && pk->pkey.ptr == NULL;
1741 check = check && pk->keydata == NULL;
1746 if (pk->pkey.ptr != NULL) {
1748 * If the legacy key doesn't have an dirty counter or export function,
1751 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1756 if (keymgmt != NULL) {
1757 tmp_keymgmt = *keymgmt;
1762 * If no keymgmt was given or found, get a default keymgmt. We do so by
1763 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1765 if (tmp_keymgmt == NULL) {
1766 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1768 tmp_keymgmt = ctx->keymgmt;
1769 ctx->keymgmt = NULL;
1770 EVP_PKEY_CTX_free(ctx);
1773 /* If there's still no keymgmt to be had, give up */
1774 if (tmp_keymgmt == NULL)
1778 if (pk->pkey.ptr != NULL) {
1782 * If the legacy "origin" hasn't changed since last time, we try
1783 * to find our keymgmt in the operation cache. If it has changed,
1784 * |i| remains zero, and we will clear the cache further down.
1786 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1787 if (!CRYPTO_THREAD_read_lock(pk->lock))
1789 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1792 * If |tmp_keymgmt| is present in the operation cache, it means
1793 * that export doesn't need to be redone. In that case, we take
1794 * token copies of the cached pointers, to have token success
1797 if (op != NULL && op->keymgmt != NULL) {
1798 keydata = op->keydata;
1799 CRYPTO_THREAD_unlock(pk->lock);
1802 CRYPTO_THREAD_unlock(pk->lock);
1805 /* Make sure that the keymgmt key type matches the legacy NID */
1806 if (!EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type)))
1809 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1812 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1813 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1819 * If the dirty counter changed since last time, then clear the
1820 * operation cache. In that case, we know that |i| is zero. Just
1821 * in case this is a re-export, we increment then decrement the
1822 * keymgmt reference counter.
1824 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1825 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1830 if (!CRYPTO_THREAD_write_lock(pk->lock))
1832 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy
1833 && !evp_keymgmt_util_clear_operation_cache(pk, 0)) {
1834 CRYPTO_THREAD_unlock(pk->lock);
1835 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1837 EVP_KEYMGMT_free(tmp_keymgmt);
1840 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1842 /* Check to make sure some other thread didn't get there first */
1843 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1844 if (op != NULL && op->keymgmt != NULL) {
1845 void *tmp_keydata = op->keydata;
1847 CRYPTO_THREAD_unlock(pk->lock);
1848 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1849 keydata = tmp_keydata;
1853 /* Add the new export to the operation cache */
1854 if (!evp_keymgmt_util_cache_keydata(pk, tmp_keymgmt, keydata)) {
1855 CRYPTO_THREAD_unlock(pk->lock);
1856 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1861 /* Synchronize the dirty count */
1862 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1864 CRYPTO_THREAD_unlock(pk->lock);
1867 #endif /* FIPS_MODULE */
1869 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1873 * If nothing was exported, |tmp_keymgmt| might point at a freed
1874 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1875 * the caller either way in that case.
1877 if (keydata == NULL)
1880 if (keymgmt != NULL)
1881 *keymgmt = tmp_keymgmt;
1883 EVP_KEYMGMT_free(allocated_keymgmt);
1888 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1890 if (!ossl_assert(dest != NULL))
1893 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1894 EVP_KEYMGMT *keymgmt = src->keymgmt;
1895 void *keydata = src->keydata;
1896 int type = src->type;
1897 const char *keytype = NULL;
1899 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
1903 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1904 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1905 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1906 * The check is kept as a safety measure.
1908 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1909 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1910 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1915 /* Prefer the legacy key type name for error reporting */
1916 if (type != EVP_PKEY_KEYMGMT)
1917 keytype = OBJ_nid2sn(type);
1919 /* Make sure we have a clean slate to copy into */
1920 if (*dest == NULL) {
1921 *dest = EVP_PKEY_new();
1922 if (*dest == NULL) {
1923 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1927 evp_pkey_free_it(*dest);
1930 if (EVP_PKEY_set_type(*dest, type)) {
1931 /* If the key is typed but empty, we're done */
1932 if (keydata == NULL)
1935 if ((*dest)->ameth->import_from == NULL) {
1936 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1937 "key type = %s", keytype);
1940 * We perform the export in the same libctx as the keymgmt
1941 * that we are using.
1943 OSSL_LIB_CTX *libctx =
1944 ossl_provider_libctx(keymgmt->prov);
1945 EVP_PKEY_CTX *pctx =
1946 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
1949 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1952 && evp_keymgmt_export(keymgmt, keydata,
1953 OSSL_KEYMGMT_SELECT_ALL,
1954 (*dest)->ameth->import_from,
1956 /* Synchronize the dirty count */
1957 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
1959 EVP_PKEY_CTX_free(pctx);
1962 EVP_PKEY_CTX_free(pctx);
1965 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1966 "key type = %s", keytype);
1973 void *evp_pkey_get_legacy(EVP_PKEY *pk)
1975 EVP_PKEY *tmp_copy = NULL;
1978 if (!ossl_assert(pk != NULL))
1982 * If this isn't an assigned provider side key, we just use any existing
1983 * origin legacy key.
1985 if (!evp_pkey_is_assigned(pk))
1987 if (!evp_pkey_is_provided(pk))
1988 return pk->pkey.ptr;
1990 if (!CRYPTO_THREAD_read_lock(pk->lock))
1993 ret = pk->legacy_cache_pkey.ptr;
1995 if (!CRYPTO_THREAD_unlock(pk->lock))
2001 if (!evp_pkey_copy_downgraded(&tmp_copy, pk))
2004 if (!CRYPTO_THREAD_write_lock(pk->lock))
2007 /* Check again in case some other thread has updated it in the meantime */
2008 ret = pk->legacy_cache_pkey.ptr;
2010 /* Steal the legacy key reference from the temporary copy */
2011 ret = pk->legacy_cache_pkey.ptr = tmp_copy->pkey.ptr;
2012 tmp_copy->pkey.ptr = NULL;
2015 if (!CRYPTO_THREAD_unlock(pk->lock)) {
2021 EVP_PKEY_free(tmp_copy);
2025 #endif /* FIPS_MODULE */
2027 int EVP_PKEY_get_bn_param(const EVP_PKEY *pkey, const char *key_name,
2031 OSSL_PARAM params[2];
2032 unsigned char buffer[2048];
2033 unsigned char *buf = NULL;
2036 if (key_name == NULL
2040 memset(buffer, 0, sizeof(buffer));
2041 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
2042 params[1] = OSSL_PARAM_construct_end();
2043 if (!EVP_PKEY_get_params(pkey, params)) {
2044 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
2046 buf_sz = params[0].return_size;
2048 * If it failed because the buffer was too small then allocate the
2049 * required buffer size and retry.
2051 buf = OPENSSL_zalloc(buf_sz);
2054 params[0].data = buf;
2055 params[0].data_size = buf_sz;
2057 if (!EVP_PKEY_get_params(pkey, params))
2060 /* Fail if the param was not found */
2061 if (!OSSL_PARAM_modified(params))
2063 ret = OSSL_PARAM_get_BN(params, bn);
2069 int EVP_PKEY_get_octet_string_param(const EVP_PKEY *pkey, const char *key_name,
2070 unsigned char *buf, size_t max_buf_sz,
2073 OSSL_PARAM params[2];
2074 int ret1 = 0, ret2 = 0;
2076 if (key_name == NULL)
2079 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
2080 params[1] = OSSL_PARAM_construct_end();
2081 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2082 ret2 = OSSL_PARAM_modified(params);
2083 if (ret2 && out_sz != NULL)
2084 *out_sz = params[0].return_size;
2085 return ret1 && ret2;
2088 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY *pkey, const char *key_name,
2089 char *str, size_t max_buf_sz,
2092 OSSL_PARAM params[2];
2093 int ret1 = 0, ret2 = 0;
2095 if (key_name == NULL)
2098 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2099 params[1] = OSSL_PARAM_construct_end();
2100 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2101 ret2 = OSSL_PARAM_modified(params);
2102 if (ret2 && out_sz != NULL)
2103 *out_sz = params[0].return_size;
2104 return ret1 && ret2;
2107 int EVP_PKEY_get_int_param(const EVP_PKEY *pkey, const char *key_name,
2110 OSSL_PARAM params[2];
2112 if (key_name == NULL)
2115 params[0] = OSSL_PARAM_construct_int(key_name, out);
2116 params[1] = OSSL_PARAM_construct_end();
2117 return EVP_PKEY_get_params(pkey, params)
2118 && OSSL_PARAM_modified(params);
2121 int EVP_PKEY_get_size_t_param(const EVP_PKEY *pkey, const char *key_name,
2124 OSSL_PARAM params[2];
2126 if (key_name == NULL)
2129 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2130 params[1] = OSSL_PARAM_construct_end();
2131 return EVP_PKEY_get_params(pkey, params)
2132 && OSSL_PARAM_modified(params);
2135 int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in)
2137 OSSL_PARAM params[2];
2139 if (key_name == NULL)
2142 params[0] = OSSL_PARAM_construct_int(key_name, &in);
2143 params[1] = OSSL_PARAM_construct_end();
2144 return EVP_PKEY_set_params(pkey, params);
2147 int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in)
2149 OSSL_PARAM params[2];
2151 if (key_name == NULL)
2154 params[0] = OSSL_PARAM_construct_size_t(key_name, &in);
2155 params[1] = OSSL_PARAM_construct_end();
2156 return EVP_PKEY_set_params(pkey, params);
2159 int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
2162 OSSL_PARAM params[2];
2163 unsigned char buffer[2048];
2166 if (key_name == NULL
2169 || !evp_pkey_is_assigned(pkey))
2172 bsize = BN_num_bytes(bn);
2173 if (!ossl_assert(bsize <= (int)sizeof(buffer)))
2176 if (BN_bn2nativepad(bn, buffer, bsize) < 0)
2178 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, bsize);
2179 params[1] = OSSL_PARAM_construct_end();
2180 return EVP_PKEY_set_params(pkey, params);
2183 int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
2186 OSSL_PARAM params[2];
2188 if (key_name == NULL)
2191 params[0] = OSSL_PARAM_construct_utf8_string(key_name, (char *)str, 0);
2192 params[1] = OSSL_PARAM_construct_end();
2193 return EVP_PKEY_set_params(pkey, params);
2196 int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
2197 const unsigned char *buf, size_t bsize)
2199 OSSL_PARAM params[2];
2201 if (key_name == NULL)
2204 params[0] = OSSL_PARAM_construct_octet_string(key_name,
2205 (unsigned char *)buf, bsize);
2206 params[1] = OSSL_PARAM_construct_end();
2207 return EVP_PKEY_set_params(pkey, params);
2210 const OSSL_PARAM *EVP_PKEY_settable_params(const EVP_PKEY *pkey)
2212 return (pkey != NULL && evp_pkey_is_provided(pkey))
2213 ? EVP_KEYMGMT_settable_params(pkey->keymgmt)
2217 int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[])
2220 if (evp_pkey_is_provided(pkey)) {
2222 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
2226 * We will hopefully never find the need to set individual data in
2227 * EVP_PKEYs with a legacy internal key, but we can't be entirely
2228 * sure. This bit of code can be enabled if we find the need. If
2229 * not, it can safely be removed when #legacy support is removed.
2232 else if (evp_pkey_is_legacy(pkey)) {
2233 return evp_pkey_set_params_to_ctrl(pkey, params);
2238 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2242 const OSSL_PARAM *EVP_PKEY_gettable_params(const EVP_PKEY *pkey)
2244 return (pkey != NULL && evp_pkey_is_provided(pkey))
2245 ? EVP_KEYMGMT_gettable_params(pkey->keymgmt)
2249 int EVP_PKEY_get_params(const EVP_PKEY *pkey, OSSL_PARAM params[])
2252 if (evp_pkey_is_provided(pkey))
2253 return evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params);
2255 else if (evp_pkey_is_legacy(pkey))
2256 return evp_pkey_get_params_to_ctrl(pkey, params);
2259 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2264 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey)
2272 if (pkey->keymgmt == NULL
2273 || pkey->keydata == NULL) {
2274 # ifndef OPENSSL_NO_EC
2275 /* Might work through the legacy route */
2276 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2281 return EC_KEY_get_conv_form(ec);
2287 if (!EVP_PKEY_get_utf8_string_param(pkey,
2288 OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
2289 name, sizeof(name), &name_len))
2292 if (strcmp(name, "uncompressed") == 0)
2293 return POINT_CONVERSION_UNCOMPRESSED;
2295 if (strcmp(name, "compressed") == 0)
2296 return POINT_CONVERSION_COMPRESSED;
2298 if (strcmp(name, "hybrid") == 0)
2299 return POINT_CONVERSION_HYBRID;
2304 int EVP_PKEY_get_field_type(const EVP_PKEY *pkey)
2312 if (pkey->keymgmt == NULL
2313 || pkey->keydata == NULL) {
2314 # ifndef OPENSSL_NO_EC
2315 /* Might work through the legacy route */
2316 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2317 const EC_GROUP *grp;
2321 grp = EC_KEY_get0_group(ec);
2325 return EC_GROUP_get_field_type(grp);
2331 if (!EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_EC_FIELD_TYPE,
2332 fstr, sizeof(fstr), &fstrlen))
2335 if (strcmp(fstr, SN_X9_62_prime_field) == 0)
2336 return NID_X9_62_prime_field;
2337 else if (strcmp(fstr, SN_X9_62_characteristic_two_field))
2338 return NID_X9_62_characteristic_two_field;