2 * Copyright 1995-2022 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/rsa.h>
26 #include <openssl/dsa.h>
27 #include <openssl/dh.h>
28 #include <openssl/ec.h>
29 #include <openssl/cmac.h>
31 # include <openssl/engine.h>
33 #include <openssl/params.h>
34 #include <openssl/param_build.h>
35 #include <openssl/encoder.h>
36 #include <openssl/core_names.h>
38 #include "internal/numbers.h" /* includes SIZE_MAX */
39 #include "internal/ffc.h"
40 #include "crypto/evp.h"
41 #include "crypto/dh.h"
42 #include "crypto/dsa.h"
43 #include "crypto/ec.h"
44 #include "crypto/ecx.h"
45 #include "crypto/rsa.h"
47 # include "crypto/asn1.h"
48 # include "crypto/x509.h"
50 #include "internal/provider.h"
51 #include "evp_local.h"
53 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
54 int len, EVP_KEYMGMT *keymgmt);
55 static void evp_pkey_free_it(EVP_PKEY *key);
59 /* The type of parameters selected in key parameter functions */
60 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
62 int EVP_PKEY_get_bits(const EVP_PKEY *pkey)
67 size = pkey->cache.bits;
68 if (pkey->ameth != NULL && pkey->ameth->pkey_bits != NULL)
69 size = pkey->ameth->pkey_bits(pkey);
71 return size < 0 ? 0 : size;
74 int EVP_PKEY_get_security_bits(const EVP_PKEY *pkey)
79 size = pkey->cache.security_bits;
80 if (pkey->ameth != NULL && pkey->ameth->pkey_security_bits != NULL)
81 size = pkey->ameth->pkey_security_bits(pkey);
83 return size < 0 ? 0 : size;
86 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
88 # ifndef OPENSSL_NO_DSA
89 if (pkey->type == EVP_PKEY_DSA) {
90 int ret = pkey->save_parameters;
93 pkey->save_parameters = mode;
97 # ifndef OPENSSL_NO_EC
98 if (pkey->type == EVP_PKEY_EC) {
99 int ret = pkey->save_parameters;
102 pkey->save_parameters = mode;
109 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
111 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
114 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
116 return CRYPTO_get_ex_data(&key->ex_data, idx);
119 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
122 * Clean up legacy stuff from this function when legacy support is gone.
125 EVP_PKEY *downgraded_from = NULL;
129 * If |to| is a legacy key and |from| isn't, we must make a downgraded
130 * copy of |from|. If that fails, this function fails.
132 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from)) {
133 if (!evp_pkey_copy_downgraded(&downgraded_from, from))
135 from = downgraded_from;
139 * Make sure |to| is typed. Content is less important at this early
142 * 1. If |to| is untyped, assign |from|'s key type to it.
143 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
144 * (|from| was already downgraded above)
146 * If |to| is a provided key, there's nothing more to do here, functions
147 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
148 * further down help us find out if they are the same or not.
150 if (evp_pkey_is_blank(to)) {
151 if (evp_pkey_is_legacy(from)) {
152 if (EVP_PKEY_set_type(to, from->type) == 0)
155 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
158 } else if (evp_pkey_is_legacy(to)) {
159 if (to->type != from->type) {
160 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
165 if (EVP_PKEY_missing_parameters(from)) {
166 ERR_raise(ERR_LIB_EVP, EVP_R_MISSING_PARAMETERS);
170 if (!EVP_PKEY_missing_parameters(to)) {
171 if (EVP_PKEY_parameters_eq(to, from) == 1)
174 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_PARAMETERS);
178 /* For purely provided keys, we just call the keymgmt utility */
179 if (to->keymgmt != NULL && from->keymgmt != NULL) {
180 ok = evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
185 * If |to| is provided, we know that |from| is legacy at this point.
186 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_dup()
187 * to copy the appropriate data to |to|'s keydata.
188 * We cannot override existing data so do it only if there is no keydata
191 if (to->keymgmt != NULL && to->keydata == NULL) {
192 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
194 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
198 * If we get a NULL, it could be an internal error, or it could be
199 * that there's a key mismatch. We're pretending the latter...
201 if (from_keydata == NULL)
202 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
204 ok = (to->keydata = evp_keymgmt_dup(to->keymgmt,
206 SELECT_PARAMETERS)) != NULL;
210 /* Both keys are legacy */
211 if (from->ameth != NULL && from->ameth->param_copy != NULL)
212 ok = from->ameth->param_copy(to, from);
214 EVP_PKEY_free(downgraded_from);
218 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
221 if (pkey->keymgmt != NULL)
222 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
223 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
224 return pkey->ameth->param_missing(pkey);
230 * This function is called for any mixture of keys except pure legacy pair.
231 * When legacy keys are gone, we replace a call to this functions with
232 * a call to evp_keymgmt_util_match().
234 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
237 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
238 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
240 /* If none of them are provided, this function shouldn't have been called */
241 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
244 /* For purely provided keys, we just call the keymgmt utility */
245 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
246 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
249 * At this point, one of them is provided, the other not. This allows
250 * us to compare types using legacy NIDs.
252 if (evp_pkey_is_legacy(a)
253 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
254 return -1; /* not the same key type */
255 if (evp_pkey_is_legacy(b)
256 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
257 return -1; /* not the same key type */
260 * We've determined that they both are the same keytype, so the next
261 * step is to do a bit of cross export to ensure we have keydata for
262 * both keys in the same keymgmt.
264 keymgmt1 = a->keymgmt;
265 keydata1 = a->keydata;
266 keymgmt2 = b->keymgmt;
267 keydata2 = b->keydata;
269 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
271 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
272 if (tmp_keydata != NULL) {
274 keydata1 = tmp_keydata;
277 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
279 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
280 if (tmp_keydata != NULL) {
282 keydata2 = tmp_keydata;
286 /* If we still don't have matching keymgmt implementations, we give up */
287 if (keymgmt1 != keymgmt2)
290 /* If the keymgmt implementations are NULL, the export failed */
291 if (keymgmt1 == NULL)
294 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
297 # ifndef OPENSSL_NO_DEPRECATED_3_0
298 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
300 return EVP_PKEY_parameters_eq(a, b);
304 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
307 * This will just call evp_keymgmt_util_match when legacy support
311 if (a->keymgmt != NULL || b->keymgmt != NULL)
312 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
314 /* All legacy keys */
315 if (a->type != b->type)
317 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
318 return a->ameth->param_cmp(a, b);
322 # ifndef OPENSSL_NO_DEPRECATED_3_0
323 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
325 return EVP_PKEY_eq(a, b);
329 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
332 * This will just call evp_keymgmt_util_match when legacy support
336 /* Trivial shortcuts */
339 if (a == NULL || b == NULL)
342 if (a->keymgmt != NULL || b->keymgmt != NULL) {
343 int selection = SELECT_PARAMETERS;
345 if (evp_keymgmt_util_has((EVP_PKEY *)a, OSSL_KEYMGMT_SELECT_PUBLIC_KEY)
346 && evp_keymgmt_util_has((EVP_PKEY *)b, OSSL_KEYMGMT_SELECT_PUBLIC_KEY))
347 selection |= OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
349 selection |= OSSL_KEYMGMT_SELECT_KEYPAIR;
350 return evp_pkey_cmp_any(a, b, selection);
353 /* All legacy keys */
354 if (a->type != b->type)
357 if (a->ameth != NULL) {
359 /* Compare parameters if the algorithm has them */
360 if (a->ameth->param_cmp != NULL) {
361 ret = a->ameth->param_cmp(a, b);
366 if (a->ameth->pub_cmp != NULL)
367 return a->ameth->pub_cmp(a, b);
374 static EVP_PKEY *new_raw_key_int(OSSL_LIB_CTX *libctx,
379 const unsigned char *key,
383 EVP_PKEY *pkey = NULL;
384 EVP_PKEY_CTX *ctx = NULL;
385 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
388 # ifndef OPENSSL_NO_ENGINE
389 /* Check if there is an Engine for this type */
394 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
395 else if (nidtype != EVP_PKEY_NONE)
396 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
398 /* If tmpe is NULL then no engine is claiming to support this type */
406 if (e == NULL && ameth == NULL) {
408 * No engine is claiming to support this type, so lets see if we have
411 ctx = EVP_PKEY_CTX_new_from_name(libctx,
412 strtype != NULL ? strtype
413 : OBJ_nid2sn(nidtype),
417 /* May fail if no provider available */
419 if (EVP_PKEY_fromdata_init(ctx) == 1) {
420 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
422 ERR_clear_last_mark();
423 params[0] = OSSL_PARAM_construct_octet_string(
424 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
425 : OSSL_PKEY_PARAM_PUB_KEY,
428 if (EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params) != 1) {
429 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
433 EVP_PKEY_CTX_free(ctx);
438 /* else not supported so fallback to legacy */
441 /* Legacy code path */
443 pkey = EVP_PKEY_new();
445 ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
449 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
450 /* ERR_raise(ERR_LIB_EVP, ...) already called */
454 if (!ossl_assert(pkey->ameth != NULL))
458 if (pkey->ameth->set_priv_key == NULL) {
459 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
463 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
464 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
468 if (pkey->ameth->set_pub_key == NULL) {
469 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
473 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
474 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
485 EVP_PKEY_CTX_free(ctx);
489 EVP_PKEY *EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX *libctx,
492 const unsigned char *priv, size_t len)
494 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
498 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
499 const unsigned char *priv,
502 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
505 EVP_PKEY *EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX *libctx,
506 const char *keytype, const char *propq,
507 const unsigned char *pub, size_t len)
509 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
513 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
514 const unsigned char *pub,
517 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
520 struct raw_key_details_st
527 static OSSL_CALLBACK get_raw_key_details;
528 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
530 const OSSL_PARAM *p = NULL;
531 struct raw_key_details_st *raw_key = arg;
533 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
534 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
536 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
537 raw_key->key == NULL ? 0 : *raw_key->len,
539 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
540 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
542 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
543 raw_key->key == NULL ? 0 : *raw_key->len,
550 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
553 if (pkey->keymgmt != NULL) {
554 struct raw_key_details_st raw_key;
556 raw_key.key = priv == NULL ? NULL : &priv;
558 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
560 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
561 get_raw_key_details, &raw_key);
564 if (pkey->ameth == NULL) {
565 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
569 if (pkey->ameth->get_priv_key == NULL) {
570 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
574 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
575 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
582 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
585 if (pkey->keymgmt != NULL) {
586 struct raw_key_details_st raw_key;
588 raw_key.key = pub == NULL ? NULL : &pub;
590 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
592 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
593 get_raw_key_details, &raw_key);
596 if (pkey->ameth == NULL) {
597 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
601 if (pkey->ameth->get_pub_key == NULL) {
602 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
606 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
607 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
614 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
615 const char *cipher_name,
616 const EVP_CIPHER *cipher,
617 OSSL_LIB_CTX *libctx,
618 const char *propq, ENGINE *e)
620 # ifndef OPENSSL_NO_CMAC
621 # ifndef OPENSSL_NO_ENGINE
622 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
624 OSSL_PARAM params[5], *p = params;
625 EVP_PKEY *pkey = NULL;
629 cipher_name = EVP_CIPHER_get0_name(cipher);
631 if (cipher_name == NULL) {
632 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
636 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
640 if (EVP_PKEY_fromdata_init(ctx) <= 0) {
641 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
645 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
647 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
648 (char *)cipher_name, 0);
650 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
652 # ifndef OPENSSL_NO_ENGINE
653 if (engine_id != NULL)
654 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
655 (char *)engine_id, 0);
657 *p = OSSL_PARAM_construct_end();
659 if (EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params) <= 0) {
660 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
665 EVP_PKEY_CTX_free(ctx);
669 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
674 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
675 size_t len, const EVP_CIPHER *cipher)
677 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
680 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
682 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
685 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
687 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
690 # ifndef OPENSSL_NO_ENGINE
691 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
694 if (!ENGINE_init(e)) {
695 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
698 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
700 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
704 ENGINE_finish(pkey->pmeth_engine);
705 pkey->pmeth_engine = e;
709 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
715 # ifndef OPENSSL_NO_DEPRECATED_3_0
716 static void detect_foreign_key(EVP_PKEY *pkey)
718 switch (pkey->type) {
720 pkey->foreign = pkey->pkey.rsa != NULL
721 && ossl_rsa_is_foreign(pkey->pkey.rsa);
723 # ifndef OPENSSL_NO_EC
726 pkey->foreign = pkey->pkey.ec != NULL
727 && ossl_ec_key_is_foreign(pkey->pkey.ec);
730 # ifndef OPENSSL_NO_DSA
732 pkey->foreign = pkey->pkey.dsa != NULL
733 && ossl_dsa_is_foreign(pkey->pkey.dsa);
736 # ifndef OPENSSL_NO_DH
738 pkey->foreign = pkey->pkey.dh != NULL
739 && ossl_dh_is_foreign(pkey->pkey.dh);
748 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
750 # ifndef OPENSSL_NO_EC
753 pktype = EVP_PKEY_type(type);
754 if ((key != NULL) && (pktype == EVP_PKEY_EC || pktype == EVP_PKEY_SM2)) {
755 const EC_GROUP *group = EC_KEY_get0_group(key);
758 int curve = EC_GROUP_get_curve_name(group);
761 * Regardless of what is requested the SM2 curve must be SM2 type,
762 * and non SM2 curves are EC type.
764 if (curve == NID_sm2 && pktype == EVP_PKEY_EC)
766 else if(curve != NID_sm2 && pktype == EVP_PKEY_SM2)
772 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
775 pkey->pkey.ptr = key;
776 detect_foreign_key(pkey);
778 return (key != NULL);
782 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
787 if (!evp_pkey_is_provided(pkey))
788 return pkey->pkey.ptr;
793 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
795 const ASN1_OCTET_STRING *os = NULL;
796 if (pkey->type != EVP_PKEY_HMAC) {
797 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_AN_HMAC_KEY);
800 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
808 # ifndef OPENSSL_NO_POLY1305
809 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
811 const ASN1_OCTET_STRING *os = NULL;
812 if (pkey->type != EVP_PKEY_POLY1305) {
813 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_POLY1305_KEY);
816 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
825 # ifndef OPENSSL_NO_SIPHASH
826 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
828 const ASN1_OCTET_STRING *os = NULL;
830 if (pkey->type != EVP_PKEY_SIPHASH) {
831 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_SIPHASH_KEY);
834 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
843 # ifndef OPENSSL_NO_DSA
844 static DSA *evp_pkey_get0_DSA_int(const EVP_PKEY *pkey)
846 if (pkey->type != EVP_PKEY_DSA) {
847 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DSA_KEY);
850 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
853 const DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
855 return evp_pkey_get0_DSA_int(pkey);
858 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
860 int ret = EVP_PKEY_assign_DSA(pkey, key);
865 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
867 DSA *ret = evp_pkey_get0_DSA_int(pkey);
873 # endif /* OPENSSL_NO_DSA */
875 # ifndef OPENSSL_NO_EC
876 static const ECX_KEY *evp_pkey_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
878 if (EVP_PKEY_get_base_id(pkey) != type) {
879 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
882 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
885 static ECX_KEY *evp_pkey_get1_ECX_KEY(EVP_PKEY *pkey, int type)
887 ECX_KEY *ret = (ECX_KEY *)evp_pkey_get0_ECX_KEY(pkey, type);
889 if (ret != NULL && !ossl_ecx_key_up_ref(ret))
894 # define IMPLEMENT_ECX_VARIANT(NAME) \
895 ECX_KEY *ossl_evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
897 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
899 IMPLEMENT_ECX_VARIANT(X25519)
900 IMPLEMENT_ECX_VARIANT(X448)
901 IMPLEMENT_ECX_VARIANT(ED25519)
902 IMPLEMENT_ECX_VARIANT(ED448)
906 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
908 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *dhkey)
913 * ossl_dh_is_named_safe_prime_group() returns 1 for named safe prime groups
914 * related to ffdhe and modp (which cache q = (p - 1) / 2),
915 * and returns 0 for all other dh parameter generation types including
916 * RFC5114 named groups.
918 * The EVP_PKEY_DH type is used for dh parameter generation types:
919 * - named safe prime groups related to ffdhe and modp
920 * - safe prime generator
922 * The type EVP_PKEY_DHX is used for dh parameter generation types
923 * - fips186-4 and fips186-2
924 * - rfc5114 named groups.
926 * The EVP_PKEY_DH type is used to save PKCS#3 data than can be stored
928 * The EVP_PKEY_DHX type is used to save X9.42 data that requires the
929 * q value to be stored.
931 if (ossl_dh_is_named_safe_prime_group(dhkey))
934 type = DH_get0_q(dhkey) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
936 ret = EVP_PKEY_assign(pkey, type, dhkey);
943 DH *evp_pkey_get0_DH_int(const EVP_PKEY *pkey)
945 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
946 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DH_KEY);
949 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
952 const DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
954 return evp_pkey_get0_DH_int(pkey);
957 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
959 DH *ret = evp_pkey_get0_DH_int(pkey);
967 int EVP_PKEY_type(int type)
970 const EVP_PKEY_ASN1_METHOD *ameth;
972 ameth = EVP_PKEY_asn1_find(&e, type);
974 ret = ameth->pkey_id;
977 # ifndef OPENSSL_NO_ENGINE
983 int EVP_PKEY_get_id(const EVP_PKEY *pkey)
988 int EVP_PKEY_get_base_id(const EVP_PKEY *pkey)
990 return EVP_PKEY_type(pkey->type);
994 * These hard coded cases are pure hackery to get around the fact
995 * that names in crypto/objects/objects.txt are a mess. There is
996 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
997 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
998 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
999 * "DSA" is accurate... but still, better be safe and hard-code
1000 * names that we know.
1001 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
1002 * EVP_PKEY_EC, because of aliasing.
1003 * This should be cleaned away along with all other #legacy support.
1005 static const OSSL_ITEM standard_name2type[] = {
1006 { EVP_PKEY_RSA, "RSA" },
1007 { EVP_PKEY_RSA_PSS, "RSA-PSS" },
1008 { EVP_PKEY_EC, "EC" },
1009 { EVP_PKEY_ED25519, "ED25519" },
1010 { EVP_PKEY_ED448, "ED448" },
1011 { EVP_PKEY_X25519, "X25519" },
1012 { EVP_PKEY_X448, "X448" },
1013 { EVP_PKEY_SM2, "SM2" },
1014 { EVP_PKEY_DH, "DH" },
1015 { EVP_PKEY_DHX, "X9.42 DH" },
1016 { EVP_PKEY_DHX, "DHX" },
1017 { EVP_PKEY_DSA, "DSA" },
1020 int evp_pkey_name2type(const char *name)
1025 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
1026 if (OPENSSL_strcasecmp(name, standard_name2type[i].ptr) == 0)
1027 return (int)standard_name2type[i].id;
1030 if ((type = EVP_PKEY_type(OBJ_sn2nid(name))) != NID_undef)
1032 return EVP_PKEY_type(OBJ_ln2nid(name));
1035 const char *evp_pkey_type2name(int type)
1039 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
1040 if (type == (int)standard_name2type[i].id)
1041 return standard_name2type[i].ptr;
1044 return OBJ_nid2sn(type);
1047 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
1051 if (pkey->keymgmt == NULL)
1052 return pkey->type == evp_pkey_name2type(name);
1053 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
1056 int EVP_PKEY_type_names_do_all(const EVP_PKEY *pkey,
1057 void (*fn)(const char *name, void *data),
1060 if (!evp_pkey_is_typed(pkey))
1063 if (!evp_pkey_is_provided(pkey)) {
1064 const char *name = OBJ_nid2sn(EVP_PKEY_get_id(pkey));
1069 return EVP_KEYMGMT_names_do_all(pkey->keymgmt, fn, data);
1072 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1074 if (pkey->keymgmt == NULL) {
1075 switch (EVP_PKEY_get_base_id(pkey)) {
1078 # ifndef OPENSSL_NO_DSA
1082 # ifndef OPENSSL_NO_EC
1083 case EVP_PKEY_ED25519:
1084 case EVP_PKEY_ED448:
1086 case EVP_PKEY_EC: /* Including SM2 */
1087 return EC_KEY_can_sign(pkey->pkey.ec);
1093 const OSSL_PROVIDER *prov = EVP_KEYMGMT_get0_provider(pkey->keymgmt);
1094 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
1095 const char *supported_sig =
1096 pkey->keymgmt->query_operation_name != NULL
1097 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1098 : EVP_KEYMGMT_get0_name(pkey->keymgmt);
1099 EVP_SIGNATURE *signature = NULL;
1101 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1102 if (signature != NULL) {
1103 EVP_SIGNATURE_free(signature);
1110 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1112 BIO_set_indent(*out, saved_indent);
1114 BIO *next = BIO_pop(*out);
1122 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1128 long i = BIO_get_indent(*out);
1130 *saved_indent = (i < 0 ? 0 : i);
1131 if (BIO_set_indent(*out, indent) <= 0) {
1132 BIO *prefbio = BIO_new(BIO_f_prefix());
1134 if (prefbio == NULL)
1136 *out = BIO_push(prefbio, *out);
1139 if (BIO_set_indent(*out, indent) <= 0) {
1140 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1147 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1150 return BIO_indent(out, indent, 128)
1151 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1152 kstr, OBJ_nid2ln(pkey->type)) > 0;
1155 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1156 int selection /* For provided encoding */,
1157 const char *propquery /* For provided encoding */,
1158 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1159 int indent, ASN1_PCTX *pctx),
1160 ASN1_PCTX *legacy_pctx /* For legacy print */)
1164 OSSL_ENCODER_CTX *ctx = NULL;
1165 int ret = -2; /* default to unsupported */
1167 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1170 ctx = OSSL_ENCODER_CTX_new_for_pkey(pkey, selection, "TEXT", NULL,
1172 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0)
1173 ret = OSSL_ENCODER_to_bio(ctx, out);
1174 OSSL_ENCODER_CTX_free(ctx);
1179 /* legacy fallback */
1180 if (legacy_print != NULL)
1181 ret = legacy_print(out, pkey, 0, legacy_pctx);
1183 ret = unsup_alg(out, pkey, 0, "Public Key");
1186 print_reset_indent(&out, pop_f_prefix, saved_indent);
1190 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1191 int indent, ASN1_PCTX *pctx)
1193 return print_pkey(pkey, out, indent, EVP_PKEY_PUBLIC_KEY, NULL,
1194 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1198 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1199 int indent, ASN1_PCTX *pctx)
1201 return print_pkey(pkey, out, indent, EVP_PKEY_KEYPAIR, NULL,
1202 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1206 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1207 int indent, ASN1_PCTX *pctx)
1209 return print_pkey(pkey, out, indent, EVP_PKEY_KEY_PARAMETERS, NULL,
1210 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1214 # ifndef OPENSSL_NO_STDIO
1215 int EVP_PKEY_print_public_fp(FILE *fp, const EVP_PKEY *pkey,
1216 int indent, ASN1_PCTX *pctx)
1219 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1223 ret = EVP_PKEY_print_public(b, pkey, indent, pctx);
1228 int EVP_PKEY_print_private_fp(FILE *fp, const EVP_PKEY *pkey,
1229 int indent, ASN1_PCTX *pctx)
1232 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1236 ret = EVP_PKEY_print_private(b, pkey, indent, pctx);
1241 int EVP_PKEY_print_params_fp(FILE *fp, const EVP_PKEY *pkey,
1242 int indent, ASN1_PCTX *pctx)
1245 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1249 ret = EVP_PKEY_print_params(b, pkey, indent, pctx);
1255 static void mdname2nid(const char *mdname, void *data)
1257 int *nid = (int *)data;
1259 if (*nid != NID_undef)
1262 *nid = OBJ_sn2nid(mdname);
1263 if (*nid == NID_undef)
1264 *nid = OBJ_ln2nid(mdname);
1267 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1268 int arg1, void *arg2)
1270 if (pkey->keymgmt == NULL)
1273 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1275 char mdname[80] = "";
1276 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1281 OSSL_LIB_CTX *libctx = ossl_provider_libctx(pkey->keymgmt->prov);
1282 /* Make sure the MD is in the namemap if available */
1284 OSSL_NAMEMAP *namemap;
1285 int nid = NID_undef;
1287 (void)ERR_set_mark();
1288 md = EVP_MD_fetch(libctx, mdname, NULL);
1289 (void)ERR_pop_to_mark();
1290 namemap = ossl_namemap_stored(libctx);
1293 * The only reason to fetch the MD was to make sure it is in the
1294 * namemap. We can immediately free it.
1297 mdnum = ossl_namemap_name2num(namemap, mdname);
1302 * We have the namemap number - now we need to find the
1305 if (!ossl_namemap_doall_names(namemap, mdnum, mdname2nid, &nid))
1316 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1318 if (pkey->ameth == NULL)
1319 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1320 if (pkey->ameth->pkey_ctrl == NULL)
1322 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1325 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1327 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1330 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1331 char *mdname, size_t mdname_sz)
1333 if (pkey->ameth == NULL)
1334 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1339 int nid = NID_undef;
1340 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1341 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1344 OPENSSL_strlcpy(mdname, name, mdname_sz);
1349 int EVP_PKEY_get_group_name(const EVP_PKEY *pkey, char *gname, size_t gname_sz,
1352 return EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_GROUP_NAME,
1353 gname, gname_sz, gname_len);
1356 int EVP_PKEY_digestsign_supports_digest(EVP_PKEY *pkey, OSSL_LIB_CTX *libctx,
1357 const char *name, const char *propq)
1360 EVP_MD_CTX *ctx = NULL;
1362 if ((ctx = EVP_MD_CTX_new()) == NULL)
1366 rv = EVP_DigestSignInit_ex(ctx, NULL, name, libctx,
1370 EVP_MD_CTX_free(ctx);
1374 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, const unsigned char *pub,
1377 if (pkey != NULL && evp_pkey_is_provided(pkey))
1379 EVP_PKEY_set_octet_string_param(pkey,
1380 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1381 (unsigned char *)pub, publen);
1383 if (publen > INT_MAX)
1385 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1386 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, publen,
1392 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub)
1396 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
1397 size_t return_size = OSSL_PARAM_UNMODIFIED;
1401 * We know that this is going to fail, but it will give us a size
1404 EVP_PKEY_get_octet_string_param(pkey,
1405 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1406 NULL, 0, &return_size);
1407 if (return_size == OSSL_PARAM_UNMODIFIED)
1411 buf = OPENSSL_malloc(return_size);
1415 if (!EVP_PKEY_get_octet_string_param(pkey,
1416 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1417 buf, return_size, NULL)) {
1426 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppub);
1432 #endif /* FIPS_MODULE */
1434 /*- All methods below can also be used in FIPS_MODULE */
1436 EVP_PKEY *EVP_PKEY_new(void)
1438 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1443 ret->type = EVP_PKEY_NONE;
1444 ret->save_type = EVP_PKEY_NONE;
1445 ret->references = 1;
1447 ret->lock = CRYPTO_THREAD_lock_new();
1448 if (ret->lock == NULL) {
1449 ERR_raise(ERR_LIB_EVP, ERR_R_CRYPTO_LIB);
1454 ret->save_parameters = 1;
1455 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1456 ERR_raise(ERR_LIB_EVP, ERR_R_CRYPTO_LIB);
1463 CRYPTO_THREAD_lock_free(ret->lock);
1469 * Setup a public key management method.
1471 * For legacy keys, either |type| or |str| is expected to have the type
1472 * information. In this case, the setup consists of finding an ASN1 method
1473 * and potentially an ENGINE, and setting those fields in |pkey|.
1475 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1476 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1478 * If pkey is NULL just return 1 or 0 if the key management method exists.
1481 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1482 int len, EVP_KEYMGMT *keymgmt)
1485 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1486 ENGINE **eptr = (e == NULL) ? &e : NULL;
1490 * The setups can't set both legacy and provider side methods.
1493 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1494 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1495 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1503 free_it = free_it || pkey->pkey.ptr != NULL;
1505 free_it = free_it || pkey->keydata != NULL;
1507 evp_pkey_free_it(pkey);
1510 * If key type matches and a method exists then this lookup has
1511 * succeeded once so just indicate success.
1513 if (pkey->type != EVP_PKEY_NONE
1514 && type == pkey->save_type
1515 && pkey->ameth != NULL)
1517 # ifndef OPENSSL_NO_ENGINE
1518 /* If we have ENGINEs release them */
1519 ENGINE_finish(pkey->engine);
1520 pkey->engine = NULL;
1521 ENGINE_finish(pkey->pmeth_engine);
1522 pkey->pmeth_engine = NULL;
1528 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1529 else if (type != EVP_PKEY_NONE)
1530 ameth = EVP_PKEY_asn1_find(eptr, type);
1531 # ifndef OPENSSL_NO_ENGINE
1532 if (pkey == NULL && eptr != NULL)
1542 check = check && ameth == NULL;
1544 check = check && keymgmt == NULL;
1546 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
1551 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1552 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1556 pkey->keymgmt = keymgmt;
1558 pkey->save_type = type;
1563 * If the internal "origin" key is provider side, don't save |ameth|.
1564 * The main reason is that |ameth| is one factor to detect that the
1565 * internal "origin" key is a legacy one.
1567 if (keymgmt == NULL)
1568 pkey->ameth = ameth;
1571 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1572 * for any key type that has a legacy implementation, regardless of
1573 * if the internal key is a legacy or a provider side one. When
1574 * there is no legacy implementation for the key, the type becomes
1575 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1576 * with functions that expect legacy internal keys.
1578 if (ameth != NULL) {
1579 if (type == EVP_PKEY_NONE)
1580 pkey->type = ameth->pkey_id;
1582 pkey->type = EVP_PKEY_KEYMGMT;
1584 # ifndef OPENSSL_NO_ENGINE
1585 if (eptr == NULL && e != NULL && !ENGINE_init(e)) {
1586 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
1597 static void find_ameth(const char *name, void *data)
1599 const char **str = data;
1602 * The error messages from pkey_set_type() are uninteresting here,
1607 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1611 else if (str[1] == NULL)
1619 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1622 # define EVP_PKEY_TYPE_STR str[0]
1623 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1625 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1626 * Ideally, only one should be found. If two (or more) are found, the
1627 * match is ambiguous. This should never happen, but...
1629 const char *str[2] = { NULL, NULL };
1631 if (!EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str)
1632 || str[1] != NULL) {
1633 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1637 # define EVP_PKEY_TYPE_STR NULL
1638 # define EVP_PKEY_TYPE_STRLEN -1
1640 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1641 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1644 #undef EVP_PKEY_TYPE_STR
1645 #undef EVP_PKEY_TYPE_STRLEN
1648 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1652 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1655 REF_PRINT_COUNT("EVP_PKEY", pkey);
1656 REF_ASSERT_ISNT(i < 2);
1657 return ((i > 1) ? 1 : 0);
1661 EVP_PKEY *EVP_PKEY_dup(EVP_PKEY *pkey)
1666 ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
1670 if ((dup_pk = EVP_PKEY_new()) == NULL)
1673 if (evp_pkey_is_blank(pkey))
1676 if (evp_pkey_is_provided(pkey)) {
1677 if (!evp_keymgmt_util_copy(dup_pk, pkey,
1678 OSSL_KEYMGMT_SELECT_ALL))
1683 if (evp_pkey_is_legacy(pkey)) {
1684 const EVP_PKEY_ASN1_METHOD *ameth = pkey->ameth;
1686 if (ameth == NULL || ameth->copy == NULL) {
1687 if (pkey->pkey.ptr == NULL /* empty key, just set type */
1688 && EVP_PKEY_set_type(dup_pk, pkey->type) != 0)
1690 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1693 if (!ameth->copy(dup_pk, pkey))
1700 /* copy auxiliary data */
1701 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EVP_PKEY,
1702 &dup_pk->ex_data, &pkey->ex_data))
1705 if (pkey->attributes != NULL) {
1706 if ((dup_pk->attributes = ossl_x509at_dup(pkey->attributes)) == NULL)
1711 EVP_PKEY_free(dup_pk);
1715 void evp_pkey_free_legacy(EVP_PKEY *x)
1717 const EVP_PKEY_ASN1_METHOD *ameth = x->ameth;
1718 ENGINE *tmpe = NULL;
1720 if (ameth == NULL && x->legacy_cache_pkey.ptr != NULL)
1721 ameth = EVP_PKEY_asn1_find(&tmpe, x->type);
1723 if (ameth != NULL) {
1724 if (x->legacy_cache_pkey.ptr != NULL) {
1726 * We should never have both a legacy origin key, and a key in the
1729 assert(x->pkey.ptr == NULL);
1731 * For the purposes of freeing we make the legacy cache look like
1732 * a legacy origin key.
1734 x->pkey = x->legacy_cache_pkey;
1735 x->legacy_cache_pkey.ptr = NULL;
1737 if (ameth->pkey_free != NULL)
1738 ameth->pkey_free(x);
1741 # ifndef OPENSSL_NO_ENGINE
1742 ENGINE_finish(tmpe);
1743 ENGINE_finish(x->engine);
1745 ENGINE_finish(x->pmeth_engine);
1746 x->pmeth_engine = NULL;
1749 #endif /* FIPS_MODULE */
1751 static void evp_pkey_free_it(EVP_PKEY *x)
1753 /* internal function; x is never NULL */
1754 evp_keymgmt_util_clear_operation_cache(x, 1);
1756 evp_pkey_free_legacy(x);
1759 if (x->keymgmt != NULL) {
1760 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1761 EVP_KEYMGMT_free(x->keymgmt);
1765 x->type = EVP_PKEY_NONE;
1768 void EVP_PKEY_free(EVP_PKEY *x)
1775 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1776 REF_PRINT_COUNT("EVP_PKEY", x);
1779 REF_ASSERT_ISNT(i < 0);
1780 evp_pkey_free_it(x);
1782 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1784 CRYPTO_THREAD_lock_free(x->lock);
1786 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1791 int EVP_PKEY_get_size(const EVP_PKEY *pkey)
1796 size = pkey->cache.size;
1798 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1799 size = pkey->ameth->pkey_size(pkey);
1802 return size < 0 ? 0 : size;
1805 const char *EVP_PKEY_get0_description(const EVP_PKEY *pkey)
1807 if (!evp_pkey_is_assigned(pkey))
1810 if (evp_pkey_is_provided(pkey) && pkey->keymgmt->description != NULL)
1811 return pkey->keymgmt->description;
1813 if (pkey->ameth != NULL)
1814 return pkey->ameth->info;
1819 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OSSL_LIB_CTX *libctx,
1820 EVP_KEYMGMT **keymgmt,
1821 const char *propquery)
1823 EVP_KEYMGMT *allocated_keymgmt = NULL;
1824 EVP_KEYMGMT *tmp_keymgmt = NULL;
1825 int selection = OSSL_KEYMGMT_SELECT_ALL;
1826 void *keydata = NULL;
1832 /* No key data => nothing to export */
1835 check = check && pk->pkey.ptr == NULL;
1837 check = check && pk->keydata == NULL;
1842 if (pk->pkey.ptr != NULL) {
1844 * If the legacy key doesn't have an dirty counter or export function,
1847 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1852 if (keymgmt != NULL) {
1853 tmp_keymgmt = *keymgmt;
1858 * If no keymgmt was given or found, get a default keymgmt. We do so by
1859 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1861 if (tmp_keymgmt == NULL) {
1862 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1866 allocated_keymgmt = tmp_keymgmt = ctx->keymgmt;
1867 ctx->keymgmt = NULL;
1868 EVP_PKEY_CTX_free(ctx);
1871 /* If there's still no keymgmt to be had, give up */
1872 if (tmp_keymgmt == NULL)
1876 if (pk->pkey.ptr != NULL) {
1880 * If the legacy "origin" hasn't changed since last time, we try
1881 * to find our keymgmt in the operation cache. If it has changed,
1882 * |i| remains zero, and we will clear the cache further down.
1884 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1885 if (!CRYPTO_THREAD_read_lock(pk->lock))
1887 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt,
1891 * If |tmp_keymgmt| is present in the operation cache, it means
1892 * that export doesn't need to be redone. In that case, we take
1893 * token copies of the cached pointers, to have token success
1896 if (op != NULL && op->keymgmt != NULL) {
1897 keydata = op->keydata;
1898 CRYPTO_THREAD_unlock(pk->lock);
1901 CRYPTO_THREAD_unlock(pk->lock);
1904 /* Make sure that the keymgmt key type matches the legacy NID */
1905 if (!EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type)))
1908 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1911 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt->import,
1912 libctx, propquery)) {
1913 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1919 * If the dirty counter changed since last time, then clear the
1920 * operation cache. In that case, we know that |i| is zero. Just
1921 * in case this is a re-export, we increment then decrement the
1922 * keymgmt reference counter.
1924 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1925 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1930 if (!CRYPTO_THREAD_write_lock(pk->lock))
1932 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy
1933 && !evp_keymgmt_util_clear_operation_cache(pk, 0)) {
1934 CRYPTO_THREAD_unlock(pk->lock);
1935 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1937 EVP_KEYMGMT_free(tmp_keymgmt);
1940 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1942 /* Check to make sure some other thread didn't get there first */
1943 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt, selection);
1944 if (op != NULL && op->keymgmt != NULL) {
1945 void *tmp_keydata = op->keydata;
1947 CRYPTO_THREAD_unlock(pk->lock);
1948 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1949 keydata = tmp_keydata;
1953 /* Add the new export to the operation cache */
1954 if (!evp_keymgmt_util_cache_keydata(pk, tmp_keymgmt, keydata,
1956 CRYPTO_THREAD_unlock(pk->lock);
1957 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1962 /* Synchronize the dirty count */
1963 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1965 CRYPTO_THREAD_unlock(pk->lock);
1968 #endif /* FIPS_MODULE */
1970 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt, selection);
1974 * If nothing was exported, |tmp_keymgmt| might point at a freed
1975 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1976 * the caller either way in that case.
1978 if (keydata == NULL)
1981 if (keymgmt != NULL && tmp_keymgmt != NULL) {
1982 *keymgmt = tmp_keymgmt;
1983 allocated_keymgmt = NULL;
1986 EVP_KEYMGMT_free(allocated_keymgmt);
1991 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1993 EVP_PKEY *allocpkey = NULL;
1995 if (!ossl_assert(dest != NULL))
1998 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1999 EVP_KEYMGMT *keymgmt = src->keymgmt;
2000 void *keydata = src->keydata;
2001 int type = src->type;
2002 const char *keytype = NULL;
2004 keytype = EVP_KEYMGMT_get0_name(keymgmt);
2007 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
2008 * else in our code. If it's not one of the well known EVP_PKEY_xxx
2009 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
2010 * The check is kept as a safety measure.
2012 if (!ossl_assert(type != EVP_PKEY_NONE)) {
2013 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
2014 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
2019 /* Prefer the legacy key type name for error reporting */
2020 if (type != EVP_PKEY_KEYMGMT)
2021 keytype = OBJ_nid2sn(type);
2023 /* Make sure we have a clean slate to copy into */
2024 if (*dest == NULL) {
2025 allocpkey = *dest = EVP_PKEY_new();
2026 if (*dest == NULL) {
2027 ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
2031 evp_pkey_free_it(*dest);
2034 if (EVP_PKEY_set_type(*dest, type)) {
2035 /* If the key is typed but empty, we're done */
2036 if (keydata == NULL)
2039 if ((*dest)->ameth->import_from == NULL) {
2040 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
2041 "key type = %s", keytype);
2044 * We perform the export in the same libctx as the keymgmt
2045 * that we are using.
2047 OSSL_LIB_CTX *libctx =
2048 ossl_provider_libctx(keymgmt->prov);
2049 EVP_PKEY_CTX *pctx =
2050 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
2053 ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
2056 && evp_keymgmt_export(keymgmt, keydata,
2057 OSSL_KEYMGMT_SELECT_ALL,
2058 (*dest)->ameth->import_from,
2060 /* Synchronize the dirty count */
2061 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
2063 EVP_PKEY_CTX_free(pctx);
2066 EVP_PKEY_CTX_free(pctx);
2069 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
2070 "key type = %s", keytype);
2074 if (allocpkey != NULL) {
2075 EVP_PKEY_free(allocpkey);
2081 void *evp_pkey_get_legacy(EVP_PKEY *pk)
2083 EVP_PKEY *tmp_copy = NULL;
2086 if (!ossl_assert(pk != NULL))
2090 * If this isn't an assigned provider side key, we just use any existing
2091 * origin legacy key.
2093 if (!evp_pkey_is_assigned(pk))
2095 if (!evp_pkey_is_provided(pk))
2096 return pk->pkey.ptr;
2098 if (!CRYPTO_THREAD_read_lock(pk->lock))
2101 ret = pk->legacy_cache_pkey.ptr;
2103 if (!CRYPTO_THREAD_unlock(pk->lock))
2109 if (!evp_pkey_copy_downgraded(&tmp_copy, pk))
2112 if (!CRYPTO_THREAD_write_lock(pk->lock))
2115 /* Check again in case some other thread has updated it in the meantime */
2116 ret = pk->legacy_cache_pkey.ptr;
2118 /* Steal the legacy key reference from the temporary copy */
2119 ret = pk->legacy_cache_pkey.ptr = tmp_copy->pkey.ptr;
2120 tmp_copy->pkey.ptr = NULL;
2123 if (!CRYPTO_THREAD_unlock(pk->lock)) {
2129 EVP_PKEY_free(tmp_copy);
2133 #endif /* FIPS_MODULE */
2135 int EVP_PKEY_get_bn_param(const EVP_PKEY *pkey, const char *key_name,
2139 OSSL_PARAM params[2];
2140 unsigned char buffer[2048];
2141 unsigned char *buf = NULL;
2144 if (key_name == NULL
2148 memset(buffer, 0, sizeof(buffer));
2149 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
2150 params[1] = OSSL_PARAM_construct_end();
2151 if (!EVP_PKEY_get_params(pkey, params)) {
2152 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
2154 buf_sz = params[0].return_size;
2156 * If it failed because the buffer was too small then allocate the
2157 * required buffer size and retry.
2159 buf = OPENSSL_zalloc(buf_sz);
2162 params[0].data = buf;
2163 params[0].data_size = buf_sz;
2165 if (!EVP_PKEY_get_params(pkey, params))
2168 /* Fail if the param was not found */
2169 if (!OSSL_PARAM_modified(params))
2171 ret = OSSL_PARAM_get_BN(params, bn);
2177 int EVP_PKEY_get_octet_string_param(const EVP_PKEY *pkey, const char *key_name,
2178 unsigned char *buf, size_t max_buf_sz,
2181 OSSL_PARAM params[2];
2182 int ret1 = 0, ret2 = 0;
2184 if (key_name == NULL)
2187 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
2188 params[1] = OSSL_PARAM_construct_end();
2189 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2190 ret2 = OSSL_PARAM_modified(params);
2191 if (ret2 && out_len != NULL)
2192 *out_len = params[0].return_size;
2193 return ret1 && ret2;
2196 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY *pkey, const char *key_name,
2197 char *str, size_t max_buf_sz,
2200 OSSL_PARAM params[2];
2201 int ret1 = 0, ret2 = 0;
2203 if (key_name == NULL)
2206 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2207 params[1] = OSSL_PARAM_construct_end();
2208 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2209 ret2 = OSSL_PARAM_modified(params);
2210 if (ret2 && out_len != NULL)
2211 *out_len = params[0].return_size;
2213 if (ret2 && params[0].return_size == max_buf_sz)
2214 /* There was no space for a NUL byte */
2216 /* Add a terminating NUL byte for good measure */
2217 if (ret2 && str != NULL)
2218 str[params[0].return_size] = '\0';
2220 return ret1 && ret2;
2223 int EVP_PKEY_get_int_param(const EVP_PKEY *pkey, const char *key_name,
2226 OSSL_PARAM params[2];
2228 if (key_name == NULL)
2231 params[0] = OSSL_PARAM_construct_int(key_name, out);
2232 params[1] = OSSL_PARAM_construct_end();
2233 return EVP_PKEY_get_params(pkey, params)
2234 && OSSL_PARAM_modified(params);
2237 int EVP_PKEY_get_size_t_param(const EVP_PKEY *pkey, const char *key_name,
2240 OSSL_PARAM params[2];
2242 if (key_name == NULL)
2245 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2246 params[1] = OSSL_PARAM_construct_end();
2247 return EVP_PKEY_get_params(pkey, params)
2248 && OSSL_PARAM_modified(params);
2251 int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in)
2253 OSSL_PARAM params[2];
2255 if (key_name == NULL)
2258 params[0] = OSSL_PARAM_construct_int(key_name, &in);
2259 params[1] = OSSL_PARAM_construct_end();
2260 return EVP_PKEY_set_params(pkey, params);
2263 int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in)
2265 OSSL_PARAM params[2];
2267 if (key_name == NULL)
2270 params[0] = OSSL_PARAM_construct_size_t(key_name, &in);
2271 params[1] = OSSL_PARAM_construct_end();
2272 return EVP_PKEY_set_params(pkey, params);
2275 int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
2278 OSSL_PARAM params[2];
2279 unsigned char buffer[2048];
2282 if (key_name == NULL
2285 || !evp_pkey_is_assigned(pkey))
2288 bsize = BN_num_bytes(bn);
2289 if (!ossl_assert(bsize <= (int)sizeof(buffer)))
2292 if (BN_bn2nativepad(bn, buffer, bsize) < 0)
2294 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, bsize);
2295 params[1] = OSSL_PARAM_construct_end();
2296 return EVP_PKEY_set_params(pkey, params);
2299 int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
2302 OSSL_PARAM params[2];
2304 if (key_name == NULL)
2307 params[0] = OSSL_PARAM_construct_utf8_string(key_name, (char *)str, 0);
2308 params[1] = OSSL_PARAM_construct_end();
2309 return EVP_PKEY_set_params(pkey, params);
2312 int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
2313 const unsigned char *buf, size_t bsize)
2315 OSSL_PARAM params[2];
2317 if (key_name == NULL)
2320 params[0] = OSSL_PARAM_construct_octet_string(key_name,
2321 (unsigned char *)buf, bsize);
2322 params[1] = OSSL_PARAM_construct_end();
2323 return EVP_PKEY_set_params(pkey, params);
2326 const OSSL_PARAM *EVP_PKEY_settable_params(const EVP_PKEY *pkey)
2328 return (pkey != NULL && evp_pkey_is_provided(pkey))
2329 ? EVP_KEYMGMT_settable_params(pkey->keymgmt)
2333 int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[])
2336 if (evp_pkey_is_provided(pkey)) {
2338 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
2342 * We will hopefully never find the need to set individual data in
2343 * EVP_PKEYs with a legacy internal key, but we can't be entirely
2344 * sure. This bit of code can be enabled if we find the need. If
2345 * not, it can safely be removed when #legacy support is removed.
2348 else if (evp_pkey_is_legacy(pkey)) {
2349 return evp_pkey_set_params_to_ctrl(pkey, params);
2354 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2358 const OSSL_PARAM *EVP_PKEY_gettable_params(const EVP_PKEY *pkey)
2360 return (pkey != NULL && evp_pkey_is_provided(pkey))
2361 ? EVP_KEYMGMT_gettable_params(pkey->keymgmt)
2365 int EVP_PKEY_get_params(const EVP_PKEY *pkey, OSSL_PARAM params[])
2368 if (evp_pkey_is_provided(pkey))
2369 return evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params) > 0;
2371 else if (evp_pkey_is_legacy(pkey))
2372 return evp_pkey_get_params_to_ctrl(pkey, params) > 0;
2375 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2380 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey)
2388 if (pkey->keymgmt == NULL
2389 || pkey->keydata == NULL) {
2390 # ifndef OPENSSL_NO_EC
2391 /* Might work through the legacy route */
2392 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2397 return EC_KEY_get_conv_form(ec);
2403 if (!EVP_PKEY_get_utf8_string_param(pkey,
2404 OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
2405 name, sizeof(name), &name_len))
2408 if (strcmp(name, "uncompressed") == 0)
2409 return POINT_CONVERSION_UNCOMPRESSED;
2411 if (strcmp(name, "compressed") == 0)
2412 return POINT_CONVERSION_COMPRESSED;
2414 if (strcmp(name, "hybrid") == 0)
2415 return POINT_CONVERSION_HYBRID;
2420 int EVP_PKEY_get_field_type(const EVP_PKEY *pkey)
2428 if (pkey->keymgmt == NULL
2429 || pkey->keydata == NULL) {
2430 # ifndef OPENSSL_NO_EC
2431 /* Might work through the legacy route */
2432 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2433 const EC_GROUP *grp;
2437 grp = EC_KEY_get0_group(ec);
2441 return EC_GROUP_get_field_type(grp);
2447 if (!EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_EC_FIELD_TYPE,
2448 fstr, sizeof(fstr), &fstrlen))
2451 if (strcmp(fstr, SN_X9_62_prime_field) == 0)
2452 return NID_X9_62_prime_field;
2453 else if (strcmp(fstr, SN_X9_62_characteristic_two_field))
2454 return NID_X9_62_characteristic_two_field;