2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * DSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
17 #include "internal/cryptlib.h"
18 #include "internal/refcount.h"
19 #include <openssl/bn.h>
20 #include <openssl/err.h>
21 #include <openssl/objects.h>
22 #include <openssl/evp.h>
23 #include <openssl/x509.h>
24 #include <openssl/rsa.h>
25 #include <openssl/dsa.h>
26 #include <openssl/dh.h>
27 #include <openssl/ec.h>
28 #include <openssl/cmac.h>
29 #include <openssl/engine.h>
30 #include <openssl/params.h>
31 #include <openssl/param_build.h>
32 #include <openssl/encoder.h>
33 #include <openssl/core_names.h>
35 #include "crypto/asn1.h"
36 #include "crypto/evp.h"
37 #include "crypto/ecx.h"
38 #include "internal/evp.h"
39 #include "internal/provider.h"
40 #include "evp_local.h"
42 #include "crypto/ec.h"
44 /* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
45 #include "e_os.h" /* strcasecmp on Windows */
47 static int pkey_set_type(EVP_PKEY
*pkey
, ENGINE
*e
, int type
, const char *str
,
48 int len
, EVP_KEYMGMT
*keymgmt
);
49 static void evp_pkey_free_it(EVP_PKEY
*key
);
53 /* The type of parameters selected in key parameter functions */
54 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
56 int EVP_PKEY_bits(const EVP_PKEY
*pkey
)
59 if (pkey
->ameth
== NULL
)
60 return pkey
->cache
.bits
;
61 else if (pkey
->ameth
->pkey_bits
)
62 return pkey
->ameth
->pkey_bits(pkey
);
67 int EVP_PKEY_security_bits(const EVP_PKEY
*pkey
)
71 if (pkey
->ameth
== NULL
)
72 return pkey
->cache
.security_bits
;
73 if (pkey
->ameth
->pkey_security_bits
== NULL
)
75 return pkey
->ameth
->pkey_security_bits(pkey
);
78 int EVP_PKEY_save_parameters(EVP_PKEY
*pkey
, int mode
)
80 # ifndef OPENSSL_NO_DSA
81 if (pkey
->type
== EVP_PKEY_DSA
) {
82 int ret
= pkey
->save_parameters
;
85 pkey
->save_parameters
= mode
;
89 # ifndef OPENSSL_NO_EC
90 if (pkey
->type
== EVP_PKEY_EC
) {
91 int ret
= pkey
->save_parameters
;
94 pkey
->save_parameters
= mode
;
101 int EVP_PKEY_set_ex_data(EVP_PKEY
*key
, int idx
, void *arg
)
103 return CRYPTO_set_ex_data(&key
->ex_data
, idx
, arg
);
106 void *EVP_PKEY_get_ex_data(const EVP_PKEY
*key
, int idx
)
108 return CRYPTO_get_ex_data(&key
->ex_data
, idx
);
111 int EVP_PKEY_copy_parameters(EVP_PKEY
*to
, const EVP_PKEY
*from
)
114 * TODO: clean up legacy stuff from this function when legacy support
119 * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
120 * If that fails, this function fails.
122 if (evp_pkey_is_legacy(to
) && evp_pkey_is_provided(from
))
123 if (!evp_pkey_downgrade((EVP_PKEY
*)from
))
127 * Make sure |to| is typed. Content is less important at this early
130 * 1. If |to| is untyped, assign |from|'s key type to it.
131 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
132 * (|from| was already downgraded above)
134 * If |to| is a provided key, there's nothing more to do here, functions
135 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
136 * further down help us find out if they are the same or not.
138 if (evp_pkey_is_blank(to
)) {
139 if (evp_pkey_is_legacy(from
)) {
140 if (EVP_PKEY_set_type(to
, from
->type
) == 0)
143 if (EVP_PKEY_set_type_by_keymgmt(to
, from
->keymgmt
) == 0)
146 } else if (evp_pkey_is_legacy(to
)) {
147 if (to
->type
!= from
->type
) {
148 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS
, EVP_R_DIFFERENT_KEY_TYPES
);
153 if (EVP_PKEY_missing_parameters(from
)) {
154 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS
, EVP_R_MISSING_PARAMETERS
);
158 if (!EVP_PKEY_missing_parameters(to
)) {
159 if (EVP_PKEY_parameters_eq(to
, from
) == 1)
161 EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS
, EVP_R_DIFFERENT_PARAMETERS
);
165 /* For purely provided keys, we just call the keymgmt utility */
166 if (to
->keymgmt
!= NULL
&& from
->keymgmt
!= NULL
)
167 return evp_keymgmt_util_copy(to
, (EVP_PKEY
*)from
, SELECT_PARAMETERS
);
170 * If |to| is provided, we know that |from| is legacy at this point.
171 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
172 * to copy the appropriate data to |to|'s keydata.
174 if (to
->keymgmt
!= NULL
) {
175 EVP_KEYMGMT
*to_keymgmt
= to
->keymgmt
;
177 evp_pkey_export_to_provider((EVP_PKEY
*)from
, NULL
, &to_keymgmt
,
181 * If we get a NULL, it could be an internal error, or it could be
182 * that there's a key mismatch. We're pretending the latter...
184 if (from_keydata
== NULL
) {
185 ERR_raise(ERR_LIB_EVP
, EVP_R_DIFFERENT_KEY_TYPES
);
188 return evp_keymgmt_copy(to
->keymgmt
, to
->keydata
, from_keydata
,
192 /* Both keys are legacy */
193 if (from
->ameth
!= NULL
&& from
->ameth
->param_copy
!= NULL
)
194 return from
->ameth
->param_copy(to
, from
);
199 int EVP_PKEY_missing_parameters(const EVP_PKEY
*pkey
)
202 if (pkey
->keymgmt
!= NULL
)
203 return !evp_keymgmt_util_has((EVP_PKEY
*)pkey
, SELECT_PARAMETERS
);
204 else if (pkey
->ameth
!= NULL
&& pkey
->ameth
->param_missing
!= NULL
)
205 return pkey
->ameth
->param_missing(pkey
);
211 * This function is called for any mixture of keys except pure legacy pair.
212 * TODO When legacy keys are gone, we replace a call to this functions with
213 * a call to evp_keymgmt_util_match().
215 static int evp_pkey_cmp_any(const EVP_PKEY
*a
, const EVP_PKEY
*b
,
218 EVP_KEYMGMT
*keymgmt1
= NULL
, *keymgmt2
= NULL
;
219 void *keydata1
= NULL
, *keydata2
= NULL
, *tmp_keydata
= NULL
;
221 /* If none of them are provided, this function shouldn't have been called */
222 if (!ossl_assert(evp_pkey_is_provided(a
) || evp_pkey_is_provided(b
)))
225 /* For purely provided keys, we just call the keymgmt utility */
226 if (evp_pkey_is_provided(a
) && evp_pkey_is_provided(b
))
227 return evp_keymgmt_util_match((EVP_PKEY
*)a
, (EVP_PKEY
*)b
, selection
);
230 * At this point, one of them is provided, the other not. This allows
231 * us to compare types using legacy NIDs.
233 if (evp_pkey_is_legacy(a
)
234 && !EVP_KEYMGMT_is_a(b
->keymgmt
, OBJ_nid2sn(a
->type
)))
235 return -1; /* not the same key type */
236 if (evp_pkey_is_legacy(b
)
237 && !EVP_KEYMGMT_is_a(a
->keymgmt
, OBJ_nid2sn(b
->type
)))
238 return -1; /* not the same key type */
241 * We've determined that they both are the same keytype, so the next
242 * step is to do a bit of cross export to ensure we have keydata for
243 * both keys in the same keymgmt.
245 keymgmt1
= a
->keymgmt
;
246 keydata1
= a
->keydata
;
247 keymgmt2
= b
->keymgmt
;
248 keydata2
= b
->keydata
;
250 if (keymgmt2
!= NULL
&& keymgmt2
->match
!= NULL
) {
252 evp_pkey_export_to_provider((EVP_PKEY
*)a
, NULL
, &keymgmt2
, NULL
);
253 if (tmp_keydata
!= NULL
) {
255 keydata1
= tmp_keydata
;
258 if (tmp_keydata
== NULL
&& keymgmt1
!= NULL
&& keymgmt1
->match
!= NULL
) {
260 evp_pkey_export_to_provider((EVP_PKEY
*)b
, NULL
, &keymgmt1
, NULL
);
261 if (tmp_keydata
!= NULL
) {
263 keydata2
= tmp_keydata
;
267 /* If we still don't have matching keymgmt implementations, we give up */
268 if (keymgmt1
!= keymgmt2
)
271 /* If the keymgmt implementations are NULL, the export failed */
272 if (keymgmt1
== NULL
)
275 return evp_keymgmt_match(keymgmt1
, keydata1
, keydata2
, selection
);
278 int EVP_PKEY_cmp_parameters(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
280 return EVP_PKEY_parameters_eq(a
, b
);
283 int EVP_PKEY_parameters_eq(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
286 * TODO: clean up legacy stuff from this function when legacy support
290 if (a
->keymgmt
!= NULL
|| b
->keymgmt
!= NULL
)
291 return evp_pkey_cmp_any(a
, b
, SELECT_PARAMETERS
);
293 /* All legacy keys */
294 if (a
->type
!= b
->type
)
296 if (a
->ameth
!= NULL
&& a
->ameth
->param_cmp
!= NULL
)
297 return a
->ameth
->param_cmp(a
, b
);
301 int EVP_PKEY_cmp(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
303 return EVP_PKEY_eq(a
, b
);
306 int EVP_PKEY_eq(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
309 * TODO: clean up legacy stuff from this function when legacy support
313 if (a
->keymgmt
!= NULL
|| b
->keymgmt
!= NULL
)
314 return evp_pkey_cmp_any(a
, b
, (SELECT_PARAMETERS
315 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY
));
317 /* All legacy keys */
318 if (a
->type
!= b
->type
)
321 if (a
->ameth
!= NULL
) {
323 /* Compare parameters if the algorithm has them */
324 if (a
->ameth
->param_cmp
!= NULL
) {
325 ret
= a
->ameth
->param_cmp(a
, b
);
330 if (a
->ameth
->pub_cmp
!= NULL
)
331 return a
->ameth
->pub_cmp(a
, b
);
338 static EVP_PKEY
*new_raw_key_int(OSSL_LIB_CTX
*libctx
,
343 const unsigned char *key
,
347 EVP_PKEY
*pkey
= NULL
;
348 EVP_PKEY_CTX
*ctx
= NULL
;
349 const EVP_PKEY_ASN1_METHOD
*ameth
= NULL
;
352 # ifndef OPENSSL_NO_ENGINE
353 /* Check if there is an Engine for this type */
358 ameth
= EVP_PKEY_asn1_find_str(&tmpe
, strtype
, -1);
359 else if (nidtype
!= EVP_PKEY_NONE
)
360 ameth
= EVP_PKEY_asn1_find(&tmpe
, nidtype
);
362 /* If tmpe is NULL then no engine is claiming to support this type */
370 if (e
== NULL
&& ameth
== NULL
) {
372 * No engine is claiming to support this type, so lets see if we have
375 ctx
= EVP_PKEY_CTX_new_from_name(libctx
,
376 strtype
!= NULL
? strtype
377 : OBJ_nid2sn(nidtype
),
381 /* May fail if no provider available */
383 if (EVP_PKEY_key_fromdata_init(ctx
) == 1) {
384 OSSL_PARAM params
[] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
386 ERR_clear_last_mark();
387 params
[0] = OSSL_PARAM_construct_octet_string(
388 key_is_priv
? OSSL_PKEY_PARAM_PRIV_KEY
389 : OSSL_PKEY_PARAM_PUB_KEY
,
392 if (EVP_PKEY_fromdata(ctx
, &pkey
, params
) != 1) {
393 EVPerr(0, EVP_R_KEY_SETUP_FAILED
);
397 EVP_PKEY_CTX_free(ctx
);
402 /* else not supported so fallback to legacy */
405 /* Legacy code path */
407 pkey
= EVP_PKEY_new();
409 EVPerr(0, ERR_R_MALLOC_FAILURE
);
413 if (!pkey_set_type(pkey
, e
, nidtype
, strtype
, -1, NULL
)) {
414 /* EVPerr already called */
418 if (!ossl_assert(pkey
->ameth
!= NULL
))
422 if (pkey
->ameth
->set_priv_key
== NULL
) {
423 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
427 if (!pkey
->ameth
->set_priv_key(pkey
, key
, len
)) {
428 EVPerr(0, EVP_R_KEY_SETUP_FAILED
);
432 if (pkey
->ameth
->set_pub_key
== NULL
) {
433 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
437 if (!pkey
->ameth
->set_pub_key(pkey
, key
, len
)) {
438 EVPerr(0, EVP_R_KEY_SETUP_FAILED
);
449 EVP_PKEY_CTX_free(ctx
);
453 EVP_PKEY
*EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX
*libctx
,
456 const unsigned char *priv
, size_t len
)
458 return new_raw_key_int(libctx
, keytype
, propq
, EVP_PKEY_NONE
, NULL
, priv
,
462 EVP_PKEY
*EVP_PKEY_new_raw_private_key(int type
, ENGINE
*e
,
463 const unsigned char *priv
,
466 return new_raw_key_int(NULL
, NULL
, NULL
, type
, e
, priv
, len
, 1);
469 EVP_PKEY
*EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX
*libctx
,
470 const char *keytype
, const char *propq
,
471 const unsigned char *pub
, size_t len
)
473 return new_raw_key_int(libctx
, keytype
, propq
, EVP_PKEY_NONE
, NULL
, pub
,
477 EVP_PKEY
*EVP_PKEY_new_raw_public_key(int type
, ENGINE
*e
,
478 const unsigned char *pub
,
481 return new_raw_key_int(NULL
, NULL
, NULL
, type
, e
, pub
, len
, 0);
484 struct raw_key_details_st
491 static OSSL_CALLBACK get_raw_key_details
;
492 static int get_raw_key_details(const OSSL_PARAM params
[], void *arg
)
494 const OSSL_PARAM
*p
= NULL
;
495 struct raw_key_details_st
*raw_key
= arg
;
497 if (raw_key
->selection
== OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) {
498 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PRIV_KEY
))
500 return OSSL_PARAM_get_octet_string(p
, (void **)raw_key
->key
,
501 SIZE_MAX
, raw_key
->len
);
502 } else if (raw_key
->selection
== OSSL_KEYMGMT_SELECT_PUBLIC_KEY
) {
503 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PUB_KEY
))
505 return OSSL_PARAM_get_octet_string(p
, (void **)raw_key
->key
,
506 SIZE_MAX
, raw_key
->len
);
512 int EVP_PKEY_get_raw_private_key(const EVP_PKEY
*pkey
, unsigned char *priv
,
515 if (pkey
->keymgmt
!= NULL
) {
516 struct raw_key_details_st raw_key
;
518 raw_key
.key
= priv
== NULL
? NULL
: &priv
;
520 raw_key
.selection
= OSSL_KEYMGMT_SELECT_PRIVATE_KEY
;
522 return evp_keymgmt_util_export(pkey
, OSSL_KEYMGMT_SELECT_PRIVATE_KEY
,
523 get_raw_key_details
, &raw_key
);
526 if (pkey
->ameth
== NULL
) {
527 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
531 if (pkey
->ameth
->get_priv_key
== NULL
) {
532 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
536 if (!pkey
->ameth
->get_priv_key(pkey
, priv
, len
)) {
537 EVPerr(0, EVP_R_GET_RAW_KEY_FAILED
);
544 int EVP_PKEY_get_raw_public_key(const EVP_PKEY
*pkey
, unsigned char *pub
,
547 if (pkey
->keymgmt
!= NULL
) {
548 struct raw_key_details_st raw_key
;
550 raw_key
.key
= pub
== NULL
? NULL
: &pub
;
552 raw_key
.selection
= OSSL_KEYMGMT_SELECT_PUBLIC_KEY
;
554 return evp_keymgmt_util_export(pkey
, OSSL_KEYMGMT_SELECT_PUBLIC_KEY
,
555 get_raw_key_details
, &raw_key
);
558 if (pkey
->ameth
== NULL
) {
559 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
563 if (pkey
->ameth
->get_pub_key
== NULL
) {
564 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY
,
565 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
569 if (!pkey
->ameth
->get_pub_key(pkey
, pub
, len
)) {
570 EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY
, EVP_R_GET_RAW_KEY_FAILED
);
577 static EVP_PKEY
*new_cmac_key_int(const unsigned char *priv
, size_t len
,
578 const char *cipher_name
,
579 const EVP_CIPHER
*cipher
,
580 OSSL_LIB_CTX
*libctx
,
581 const char *propq
, ENGINE
*e
)
583 # ifndef OPENSSL_NO_CMAC
584 # ifndef OPENSSL_NO_ENGINE
585 const char *engine_id
= e
!= NULL
? ENGINE_get_id(e
) : NULL
;
587 OSSL_PARAM params
[5], *p
= params
;
588 EVP_PKEY
*pkey
= NULL
;
592 cipher_name
= EVP_CIPHER_name(cipher
);
594 if (cipher_name
== NULL
) {
595 EVPerr(0, EVP_R_KEY_SETUP_FAILED
);
599 ctx
= EVP_PKEY_CTX_new_from_name(libctx
, "CMAC", propq
);
603 if (!EVP_PKEY_key_fromdata_init(ctx
)) {
604 EVPerr(0, EVP_R_KEY_SETUP_FAILED
);
608 *p
++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
,
610 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER
,
611 (char *)cipher_name
, 0);
613 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES
,
615 # ifndef OPENSSL_NO_ENGINE
616 if (engine_id
!= NULL
)
617 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE
,
618 (char *)engine_id
, 0);
620 *p
= OSSL_PARAM_construct_end();
622 if (!EVP_PKEY_fromdata(ctx
, &pkey
, params
)) {
623 EVPerr(0, EVP_R_KEY_SETUP_FAILED
);
628 EVP_PKEY_CTX_free(ctx
);
632 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
637 EVP_PKEY
*EVP_PKEY_new_CMAC_key_ex(const unsigned char *priv
, size_t len
,
638 const char *cipher_name
, OSSL_LIB_CTX
*libctx
,
641 return new_cmac_key_int(priv
, len
, cipher_name
, NULL
, libctx
, propq
, NULL
);
644 EVP_PKEY
*EVP_PKEY_new_CMAC_key(ENGINE
*e
, const unsigned char *priv
,
645 size_t len
, const EVP_CIPHER
*cipher
)
647 return new_cmac_key_int(priv
, len
, NULL
, cipher
, NULL
, NULL
, e
);
650 int EVP_PKEY_set_type(EVP_PKEY
*pkey
, int type
)
652 return pkey_set_type(pkey
, NULL
, type
, NULL
, -1, NULL
);
655 int EVP_PKEY_set_type_str(EVP_PKEY
*pkey
, const char *str
, int len
)
657 return pkey_set_type(pkey
, NULL
, EVP_PKEY_NONE
, str
, len
, NULL
);
660 #ifndef OPENSSL_NO_DEPRECATED_3_0
661 int EVP_PKEY_set_alias_type(EVP_PKEY
*pkey
, int type
)
663 if (!evp_pkey_is_legacy(pkey
)) {
664 const char *name
= OBJ_nid2sn(type
);
666 if (name
!= NULL
&& EVP_PKEY_is_a(pkey
, name
))
669 ERR_raise(ERR_LIB_EVP
, EVP_R_INVALID_OPERATION
);
673 if (pkey
->type
== type
) {
674 return 1; /* it already is that type */
678 * The application is requesting to alias this to a different pkey type,
679 * but not one that resolves to the base type.
681 if (EVP_PKEY_type(type
) != EVP_PKEY_base_id(pkey
)) {
682 EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE
, EVP_R_UNSUPPORTED_ALGORITHM
);
691 # ifndef OPENSSL_NO_ENGINE
692 int EVP_PKEY_set1_engine(EVP_PKEY
*pkey
, ENGINE
*e
)
695 if (!ENGINE_init(e
)) {
696 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE
, ERR_R_ENGINE_LIB
);
699 if (ENGINE_get_pkey_meth(e
, pkey
->type
) == NULL
) {
701 EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE
, EVP_R_UNSUPPORTED_ALGORITHM
);
705 ENGINE_finish(pkey
->pmeth_engine
);
706 pkey
->pmeth_engine
= e
;
710 ENGINE
*EVP_PKEY_get0_engine(const EVP_PKEY
*pkey
)
715 int EVP_PKEY_assign(EVP_PKEY
*pkey
, int type
, void *key
)
719 #ifndef OPENSSL_NO_EC
720 if ((key
!= NULL
) && (EVP_PKEY_type(type
) == EVP_PKEY_EC
)) {
721 const EC_GROUP
*group
= EC_KEY_get0_group(key
);
723 if (group
!= NULL
&& EC_GROUP_get_curve_name(group
) == NID_sm2
)
724 alias
= EVP_PKEY_SM2
;
728 if (pkey
== NULL
|| !EVP_PKEY_set_type(pkey
, type
))
730 if (!EVP_PKEY_set_alias_type(pkey
, alias
))
732 pkey
->pkey
.ptr
= key
;
733 return (key
!= NULL
);
736 void *EVP_PKEY_get0(const EVP_PKEY
*pkey
)
740 if (!evp_pkey_downgrade((EVP_PKEY
*)pkey
)) {
741 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_KEY
);
744 return pkey
->pkey
.ptr
;
747 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY
*pkey
, size_t *len
)
749 ASN1_OCTET_STRING
*os
= NULL
;
750 if (pkey
->type
!= EVP_PKEY_HMAC
) {
751 EVPerr(EVP_F_EVP_PKEY_GET0_HMAC
, EVP_R_EXPECTING_AN_HMAC_KEY
);
754 os
= EVP_PKEY_get0(pkey
);
759 # ifndef OPENSSL_NO_POLY1305
760 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY
*pkey
, size_t *len
)
762 ASN1_OCTET_STRING
*os
= NULL
;
763 if (pkey
->type
!= EVP_PKEY_POLY1305
) {
764 EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305
, EVP_R_EXPECTING_A_POLY1305_KEY
);
767 os
= EVP_PKEY_get0(pkey
);
773 # ifndef OPENSSL_NO_SIPHASH
774 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY
*pkey
, size_t *len
)
776 ASN1_OCTET_STRING
*os
= NULL
;
778 if (pkey
->type
!= EVP_PKEY_SIPHASH
) {
779 EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH
, EVP_R_EXPECTING_A_SIPHASH_KEY
);
782 os
= EVP_PKEY_get0(pkey
);
788 # ifndef OPENSSL_NO_RSA
789 int EVP_PKEY_set1_RSA(EVP_PKEY
*pkey
, RSA
*key
)
791 int ret
= EVP_PKEY_assign_RSA(pkey
, key
);
797 RSA
*EVP_PKEY_get0_RSA(const EVP_PKEY
*pkey
)
799 if (!evp_pkey_downgrade((EVP_PKEY
*)pkey
)) {
800 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_KEY
);
803 if (pkey
->type
!= EVP_PKEY_RSA
&& pkey
->type
!= EVP_PKEY_RSA_PSS
) {
804 EVPerr(EVP_F_EVP_PKEY_GET0_RSA
, EVP_R_EXPECTING_AN_RSA_KEY
);
807 return pkey
->pkey
.rsa
;
810 RSA
*EVP_PKEY_get1_RSA(EVP_PKEY
*pkey
)
812 RSA
*ret
= EVP_PKEY_get0_RSA(pkey
);
819 # ifndef OPENSSL_NO_DSA
820 DSA
*EVP_PKEY_get0_DSA(const EVP_PKEY
*pkey
)
822 if (!evp_pkey_downgrade((EVP_PKEY
*)pkey
)) {
823 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_KEY
);
826 if (pkey
->type
!= EVP_PKEY_DSA
) {
827 EVPerr(EVP_F_EVP_PKEY_GET0_DSA
, EVP_R_EXPECTING_A_DSA_KEY
);
830 return pkey
->pkey
.dsa
;
833 int EVP_PKEY_set1_DSA(EVP_PKEY
*pkey
, DSA
*key
)
835 int ret
= EVP_PKEY_assign_DSA(pkey
, key
);
840 DSA
*EVP_PKEY_get1_DSA(EVP_PKEY
*pkey
)
842 DSA
*ret
= EVP_PKEY_get0_DSA(pkey
);
847 # endif /* OPENSSL_NO_DSA */
848 #endif /* FIPS_MODULE */
851 # ifndef OPENSSL_NO_EC
852 int EVP_PKEY_set1_EC_KEY(EVP_PKEY
*pkey
, EC_KEY
*key
)
854 int ret
= EVP_PKEY_assign_EC_KEY(pkey
, key
);
860 EC_KEY
*EVP_PKEY_get0_EC_KEY(const EVP_PKEY
*pkey
)
862 if (!evp_pkey_downgrade((EVP_PKEY
*)pkey
)) {
863 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_KEY
);
866 if (EVP_PKEY_base_id(pkey
) != EVP_PKEY_EC
) {
867 EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY
, EVP_R_EXPECTING_A_EC_KEY
);
870 return pkey
->pkey
.ec
;
873 EC_KEY
*EVP_PKEY_get1_EC_KEY(EVP_PKEY
*pkey
)
875 EC_KEY
*ret
= EVP_PKEY_get0_EC_KEY(pkey
);
881 static ECX_KEY
*evp_pkey_get0_ECX_KEY(const EVP_PKEY
*pkey
, int type
)
883 if (!evp_pkey_downgrade((EVP_PKEY
*)pkey
)) {
884 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_KEY
);
887 if (EVP_PKEY_base_id(pkey
) != type
) {
888 ERR_raise(ERR_LIB_EVP
, EVP_R_EXPECTING_A_ECX_KEY
);
891 return pkey
->pkey
.ecx
;
894 static ECX_KEY
*evp_pkey_get1_ECX_KEY(EVP_PKEY
*pkey
, int type
)
896 ECX_KEY
*ret
= evp_pkey_get0_ECX_KEY(pkey
, type
);
902 # define IMPLEMENT_ECX_VARIANT(NAME) \
903 ECX_KEY *evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
905 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
907 IMPLEMENT_ECX_VARIANT(X25519
)
908 IMPLEMENT_ECX_VARIANT(X448
)
909 IMPLEMENT_ECX_VARIANT(ED25519
)
910 IMPLEMENT_ECX_VARIANT(ED448
)
914 # ifndef OPENSSL_NO_DH
916 int EVP_PKEY_set1_DH(EVP_PKEY
*pkey
, DH
*key
)
918 int type
= DH_get0_q(key
) == NULL
? EVP_PKEY_DH
: EVP_PKEY_DHX
;
919 int ret
= EVP_PKEY_assign(pkey
, type
, key
);
926 DH
*EVP_PKEY_get0_DH(const EVP_PKEY
*pkey
)
928 if (!evp_pkey_downgrade((EVP_PKEY
*)pkey
)) {
929 ERR_raise(ERR_LIB_EVP
, EVP_R_INACCESSIBLE_KEY
);
932 if (pkey
->type
!= EVP_PKEY_DH
&& pkey
->type
!= EVP_PKEY_DHX
) {
933 EVPerr(EVP_F_EVP_PKEY_GET0_DH
, EVP_R_EXPECTING_A_DH_KEY
);
936 return pkey
->pkey
.dh
;
939 DH
*EVP_PKEY_get1_DH(EVP_PKEY
*pkey
)
941 DH
*ret
= EVP_PKEY_get0_DH(pkey
);
948 int EVP_PKEY_type(int type
)
951 const EVP_PKEY_ASN1_METHOD
*ameth
;
953 ameth
= EVP_PKEY_asn1_find(&e
, type
);
955 ret
= ameth
->pkey_id
;
958 # ifndef OPENSSL_NO_ENGINE
964 int EVP_PKEY_id(const EVP_PKEY
*pkey
)
969 int EVP_PKEY_base_id(const EVP_PKEY
*pkey
)
971 return EVP_PKEY_type(pkey
->type
);
975 int evp_pkey_name2type(const char *name
)
978 * These hard coded cases are pure hackery to get around the fact
979 * that names in crypto/objects/objects.txt are a mess. There is
980 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
981 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
982 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
983 * "DSA" is accurate... but still, better be safe and hard-code
984 * names that we know.
985 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
986 * EVP_PKEY_EC, because of aliasing.
987 * TODO Clean this away along with all other #legacy support.
989 int type
= NID_undef
;
991 if (strcasecmp(name
, "RSA") == 0)
993 else if (strcasecmp(name
, "RSA-PSS") == 0)
994 type
= EVP_PKEY_RSA_PSS
;
995 else if (strcasecmp(name
, "EC") == 0)
997 else if (strcasecmp(name
, "ED25519") == 0)
998 type
= EVP_PKEY_ED25519
;
999 else if (strcasecmp(name
, "ED448") == 0)
1000 type
= EVP_PKEY_ED448
;
1001 else if (strcasecmp(name
, "X25519") == 0)
1002 type
= EVP_PKEY_X25519
;
1003 else if (strcasecmp(name
, "X448") == 0)
1004 type
= EVP_PKEY_X448
;
1005 else if (strcasecmp(name
, "SM2") == 0)
1006 type
= EVP_PKEY_SM2
;
1007 else if (strcasecmp(name
, "DH") == 0)
1009 else if (strcasecmp(name
, "X9.42 DH") == 0)
1010 type
= EVP_PKEY_DHX
;
1011 else if (strcasecmp(name
, "DSA") == 0)
1012 type
= EVP_PKEY_DSA
;
1014 if (type
== NID_undef
)
1015 type
= EVP_PKEY_type(OBJ_sn2nid(name
));
1016 if (type
== NID_undef
)
1017 type
= EVP_PKEY_type(OBJ_ln2nid(name
));
1023 int EVP_PKEY_is_a(const EVP_PKEY
*pkey
, const char *name
)
1026 if (pkey
->keymgmt
== NULL
) {
1027 int type
= evp_pkey_name2type(name
);
1029 return pkey
->type
== type
;
1032 return EVP_KEYMGMT_is_a(pkey
->keymgmt
, name
);
1035 void EVP_PKEY_typenames_do_all(const EVP_PKEY
*pkey
,
1036 void (*fn
)(const char *name
, void *data
),
1039 if (!evp_pkey_is_typed(pkey
))
1042 if (!evp_pkey_is_provided(pkey
)) {
1043 const char *name
= OBJ_nid2sn(EVP_PKEY_id(pkey
));
1048 EVP_KEYMGMT_names_do_all(pkey
->keymgmt
, fn
, data
);
1051 int EVP_PKEY_can_sign(const EVP_PKEY
*pkey
)
1053 if (pkey
->keymgmt
== NULL
) {
1054 switch (EVP_PKEY_base_id(pkey
)) {
1057 #ifndef OPENSSL_NO_DSA
1061 #ifndef OPENSSL_NO_EC
1062 case EVP_PKEY_ED25519
:
1063 case EVP_PKEY_ED448
:
1065 case EVP_PKEY_EC
: /* Including SM2 */
1066 return EC_KEY_can_sign(pkey
->pkey
.ec
);
1072 const OSSL_PROVIDER
*prov
= EVP_KEYMGMT_provider(pkey
->keymgmt
);
1073 OSSL_LIB_CTX
*libctx
= ossl_provider_library_context(prov
);
1074 const char *supported_sig
=
1075 pkey
->keymgmt
->query_operation_name
!= NULL
1076 ? pkey
->keymgmt
->query_operation_name(OSSL_OP_SIGNATURE
)
1077 : evp_first_name(prov
, pkey
->keymgmt
->name_id
);
1078 EVP_SIGNATURE
*signature
= NULL
;
1080 signature
= EVP_SIGNATURE_fetch(libctx
, supported_sig
, NULL
);
1081 if (signature
!= NULL
) {
1082 EVP_SIGNATURE_free(signature
);
1089 #ifndef OPENSSL_NO_EC
1091 * TODO rewrite when we have proper data extraction functions
1092 * Note: an octet pointer would be desirable!
1094 static OSSL_CALLBACK get_ec_curve_name_cb
;
1095 static int get_ec_curve_name_cb(const OSSL_PARAM params
[], void *arg
)
1097 const OSSL_PARAM
*p
= NULL
;
1099 if ((p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_GROUP_NAME
)) != NULL
)
1100 return OSSL_PARAM_get_utf8_string(p
, arg
, 0);
1102 /* If there is no curve name, this is not an EC key */
1106 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY
*pkey
)
1108 int ret
= NID_undef
;
1110 if (pkey
->keymgmt
== NULL
) {
1111 if (EVP_PKEY_base_id(pkey
) == EVP_PKEY_EC
) {
1112 EC_KEY
*ec
= EVP_PKEY_get0_EC_KEY(pkey
);
1114 ret
= EC_GROUP_get_curve_name(EC_KEY_get0_group(ec
));
1116 } else if (EVP_PKEY_is_a(pkey
, "EC") || EVP_PKEY_is_a(pkey
, "SM2")) {
1117 char *curve_name
= NULL
;
1119 ret
= evp_keymgmt_util_export(pkey
,
1120 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
,
1121 get_ec_curve_name_cb
, &curve_name
);
1123 ret
= ec_curve_name2nid(curve_name
);
1124 OPENSSL_free(curve_name
);
1131 static int print_reset_indent(BIO
**out
, int pop_f_prefix
, long saved_indent
)
1133 BIO_set_indent(*out
, saved_indent
);
1135 BIO
*next
= BIO_pop(*out
);
1143 static int print_set_indent(BIO
**out
, int *pop_f_prefix
, long *saved_indent
,
1149 long i
= BIO_get_indent(*out
);
1151 *saved_indent
= (i
< 0 ? 0 : i
);
1152 if (BIO_set_indent(*out
, indent
) <= 0) {
1153 if ((*out
= BIO_push(BIO_new(BIO_f_prefix()), *out
)) == NULL
)
1157 if (BIO_set_indent(*out
, indent
) <= 0) {
1158 print_reset_indent(out
, *pop_f_prefix
, *saved_indent
);
1165 static int unsup_alg(BIO
*out
, const EVP_PKEY
*pkey
, int indent
,
1168 return BIO_indent(out
, indent
, 128)
1169 && BIO_printf(out
, "%s algorithm \"%s\" unsupported\n",
1170 kstr
, OBJ_nid2ln(pkey
->type
)) > 0;
1173 static int print_pkey(const EVP_PKEY
*pkey
, BIO
*out
, int indent
,
1174 int selection
/* For provided encoding */,
1175 OSSL_LIB_CTX
*libctx
/* For provided encoding */,
1176 const char *propquery
/* For provided encoding */,
1177 int (*legacy_print
)(BIO
*out
, const EVP_PKEY
*pkey
,
1178 int indent
, ASN1_PCTX
*pctx
),
1179 ASN1_PCTX
*legacy_pctx
/* For legacy print */)
1183 OSSL_ENCODER_CTX
*ctx
= NULL
;
1184 int ret
= -2; /* default to unsupported */
1186 if (!print_set_indent(&out
, &pop_f_prefix
, &saved_indent
, indent
))
1189 ctx
= OSSL_ENCODER_CTX_new_by_EVP_PKEY(pkey
, "TEXT", selection
,
1191 if (OSSL_ENCODER_CTX_get_num_encoders(ctx
) != 0)
1192 ret
= OSSL_ENCODER_to_bio(ctx
, out
);
1193 OSSL_ENCODER_CTX_free(ctx
);
1198 /* legacy fallback */
1199 if (legacy_print
!= NULL
)
1200 ret
= legacy_print(out
, pkey
, 0, legacy_pctx
);
1202 ret
= unsup_alg(out
, pkey
, 0, "Public Key");
1205 print_reset_indent(&out
, pop_f_prefix
, saved_indent
);
1209 int EVP_PKEY_print_public(BIO
*out
, const EVP_PKEY
*pkey
,
1210 int indent
, ASN1_PCTX
*pctx
)
1212 return print_pkey(pkey
, out
, indent
,
1213 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
1214 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY
,
1216 (pkey
->ameth
!= NULL
? pkey
->ameth
->pub_print
: NULL
),
1220 int EVP_PKEY_print_private(BIO
*out
, const EVP_PKEY
*pkey
,
1221 int indent
, ASN1_PCTX
*pctx
)
1223 return print_pkey(pkey
, out
, indent
,
1224 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
1225 | OSSL_KEYMGMT_SELECT_KEYPAIR
,
1227 (pkey
->ameth
!= NULL
? pkey
->ameth
->priv_print
: NULL
),
1231 int EVP_PKEY_print_params(BIO
*out
, const EVP_PKEY
*pkey
,
1232 int indent
, ASN1_PCTX
*pctx
)
1234 return print_pkey(pkey
, out
, indent
, OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
,
1236 (pkey
->ameth
!= NULL
? pkey
->ameth
->param_print
: NULL
),
1240 static int legacy_asn1_ctrl_to_param(EVP_PKEY
*pkey
, int op
,
1241 int arg1
, void *arg2
)
1243 if (pkey
->keymgmt
== NULL
)
1246 case ASN1_PKEY_CTRL_DEFAULT_MD_NID
:
1248 char mdname
[80] = "";
1249 int rv
= EVP_PKEY_get_default_digest_name(pkey
, mdname
,
1255 nid
= OBJ_sn2nid(mdname
);
1256 if (nid
== NID_undef
)
1257 nid
= OBJ_ln2nid(mdname
);
1267 static int evp_pkey_asn1_ctrl(EVP_PKEY
*pkey
, int op
, int arg1
, void *arg2
)
1269 if (pkey
->ameth
== NULL
)
1270 return legacy_asn1_ctrl_to_param(pkey
, op
, arg1
, arg2
);
1271 if (pkey
->ameth
->pkey_ctrl
== NULL
)
1273 return pkey
->ameth
->pkey_ctrl(pkey
, op
, arg1
, arg2
);
1276 int EVP_PKEY_get_default_digest_nid(EVP_PKEY
*pkey
, int *pnid
)
1278 return evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_DEFAULT_MD_NID
, 0, pnid
);
1281 int EVP_PKEY_get_default_digest_name(EVP_PKEY
*pkey
,
1282 char *mdname
, size_t mdname_sz
)
1284 if (pkey
->ameth
== NULL
)
1285 return evp_keymgmt_util_get_deflt_digest_name(pkey
->keymgmt
,
1290 int nid
= NID_undef
;
1291 int rv
= EVP_PKEY_get_default_digest_nid(pkey
, &nid
);
1292 const char *name
= rv
> 0 ? OBJ_nid2sn(nid
) : NULL
;
1295 OPENSSL_strlcpy(mdname
, name
, mdname_sz
);
1300 int EVP_PKEY_supports_digest_nid(EVP_PKEY
*pkey
, int nid
)
1302 int rv
, default_nid
;
1304 rv
= evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_SUPPORTS_MD_NID
, nid
, NULL
);
1307 * If there is a mandatory default digest and this isn't it, then
1308 * the answer is 'no'.
1310 rv
= EVP_PKEY_get_default_digest_nid(pkey
, &default_nid
);
1312 return (nid
== default_nid
);
1313 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1320 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY
*pkey
,
1321 const unsigned char *pt
, size_t ptlen
)
1323 if (pkey
->ameth
== NULL
) {
1324 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1326 if (pkey
->keymgmt
== NULL
|| pkey
->keydata
== NULL
)
1330 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT
,
1331 (unsigned char *)pt
, ptlen
);
1332 return evp_keymgmt_set_params(pkey
->keymgmt
, pkey
->keydata
, params
);
1335 if (ptlen
> INT_MAX
)
1337 if (evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_SET1_TLS_ENCPT
, ptlen
,
1343 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY
*pkey
, unsigned char **ppt
)
1347 if (pkey
->ameth
== NULL
) {
1348 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1350 if (pkey
->keymgmt
== NULL
|| pkey
->keydata
== NULL
)
1354 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT
,
1356 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
))
1359 *ppt
= OPENSSL_malloc(params
[0].return_size
);
1364 OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_TLS_ENCODED_PT
,
1365 *ppt
, params
[0].return_size
);
1366 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
))
1369 return params
[0].return_size
;
1373 rv
= evp_pkey_asn1_ctrl(pkey
, ASN1_PKEY_CTRL_GET1_TLS_ENCPT
, 0, ppt
);
1379 #endif /* FIPS_MODULE */
1381 /*- All methods below can also be used in FIPS_MODULE */
1384 * This reset function must be used very carefully, as it literally throws
1385 * away everything in an EVP_PKEY without freeing them, and may cause leaks
1386 * of memory, locks, what have you.
1387 * The only reason we have this is to have the same code for EVP_PKEY_new()
1388 * and evp_pkey_downgrade().
1390 static int evp_pkey_reset_unlocked(EVP_PKEY
*pk
)
1395 memset(pk
, 0, sizeof(*pk
));
1396 pk
->type
= EVP_PKEY_NONE
;
1397 pk
->save_type
= EVP_PKEY_NONE
;
1399 pk
->save_parameters
= 1;
1401 pk
->lock
= CRYPTO_THREAD_lock_new();
1402 if (pk
->lock
== NULL
) {
1403 EVPerr(0, ERR_R_MALLOC_FAILURE
);
1409 EVP_PKEY
*EVP_PKEY_new(void)
1411 EVP_PKEY
*ret
= OPENSSL_zalloc(sizeof(*ret
));
1414 EVPerr(EVP_F_EVP_PKEY_NEW
, ERR_R_MALLOC_FAILURE
);
1418 if (!evp_pkey_reset_unlocked(ret
))
1422 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY
, ret
, &ret
->ex_data
)) {
1423 EVPerr(EVP_F_EVP_PKEY_NEW
, ERR_R_MALLOC_FAILURE
);
1430 CRYPTO_THREAD_lock_free(ret
->lock
);
1436 * Setup a public key management method.
1438 * For legacy keys, either |type| or |str| is expected to have the type
1439 * information. In this case, the setup consists of finding an ASN1 method
1440 * and potentially an ENGINE, and setting those fields in |pkey|.
1442 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1443 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1445 * If pkey is NULL just return 1 or 0 if the key management method exists.
1448 static int pkey_set_type(EVP_PKEY
*pkey
, ENGINE
*e
, int type
, const char *str
,
1449 int len
, EVP_KEYMGMT
*keymgmt
)
1452 const EVP_PKEY_ASN1_METHOD
*ameth
= NULL
;
1453 ENGINE
**eptr
= (e
== NULL
) ? &e
: NULL
;
1457 * The setups can't set both legacy and provider side methods.
1460 if (!ossl_assert(type
== EVP_PKEY_NONE
|| keymgmt
== NULL
)
1461 || !ossl_assert(e
== NULL
|| keymgmt
== NULL
)) {
1462 ERR_raise(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
);
1470 free_it
= free_it
|| pkey
->pkey
.ptr
!= NULL
;
1472 free_it
= free_it
|| pkey
->keydata
!= NULL
;
1474 evp_pkey_free_it(pkey
);
1477 * If key type matches and a method exists then this lookup has
1478 * succeeded once so just indicate success.
1480 if (pkey
->type
!= EVP_PKEY_NONE
1481 && type
== pkey
->save_type
1482 && pkey
->ameth
!= NULL
)
1484 # ifndef OPENSSL_NO_ENGINE
1485 /* If we have ENGINEs release them */
1486 ENGINE_finish(pkey
->engine
);
1487 pkey
->engine
= NULL
;
1488 ENGINE_finish(pkey
->pmeth_engine
);
1489 pkey
->pmeth_engine
= NULL
;
1495 ameth
= EVP_PKEY_asn1_find_str(eptr
, str
, len
);
1496 else if (type
!= EVP_PKEY_NONE
)
1497 ameth
= EVP_PKEY_asn1_find(eptr
, type
);
1498 # ifndef OPENSSL_NO_ENGINE
1499 if (pkey
== NULL
&& eptr
!= NULL
)
1509 check
= check
&& ameth
== NULL
;
1511 check
= check
&& keymgmt
== NULL
;
1513 EVPerr(EVP_F_PKEY_SET_TYPE
, EVP_R_UNSUPPORTED_ALGORITHM
);
1518 if (keymgmt
!= NULL
&& !EVP_KEYMGMT_up_ref(keymgmt
)) {
1519 ERR_raise(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
);
1523 pkey
->keymgmt
= keymgmt
;
1525 pkey
->save_type
= type
;
1530 * If the internal "origin" key is provider side, don't save |ameth|.
1531 * The main reason is that |ameth| is one factor to detect that the
1532 * internal "origin" key is a legacy one.
1534 if (keymgmt
== NULL
)
1535 pkey
->ameth
= ameth
;
1539 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1540 * for any key type that has a legacy implementation, regardless of
1541 * if the internal key is a legacy or a provider side one. When
1542 * there is no legacy implementation for the key, the type becomes
1543 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1544 * with functions that expect legacy internal keys.
1547 pkey
->type
= ameth
->pkey_id
;
1549 pkey
->type
= EVP_PKEY_KEYMGMT
;
1556 static void find_ameth(const char *name
, void *data
)
1558 const char **str
= data
;
1561 * The error messages from pkey_set_type() are uninteresting here,
1566 if (pkey_set_type(NULL
, NULL
, EVP_PKEY_NONE
, name
, strlen(name
),
1570 else if (str
[1] == NULL
)
1578 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY
*pkey
, EVP_KEYMGMT
*keymgmt
)
1581 # define EVP_PKEY_TYPE_STR str[0]
1582 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1584 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1585 * Ideally, only one should be found. If two (or more) are found, the
1586 * match is ambiguous. This should never happen, but...
1588 const char *str
[2] = { NULL
, NULL
};
1590 EVP_KEYMGMT_names_do_all(keymgmt
, find_ameth
, &str
);
1591 if (str
[1] != NULL
) {
1592 ERR_raise(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
);
1596 # define EVP_PKEY_TYPE_STR NULL
1597 # define EVP_PKEY_TYPE_STRLEN -1
1599 return pkey_set_type(pkey
, NULL
, EVP_PKEY_NONE
,
1600 EVP_PKEY_TYPE_STR
, EVP_PKEY_TYPE_STRLEN
,
1603 #undef EVP_PKEY_TYPE_STR
1604 #undef EVP_PKEY_TYPE_STRLEN
1607 int EVP_PKEY_up_ref(EVP_PKEY
*pkey
)
1611 if (CRYPTO_UP_REF(&pkey
->references
, &i
, pkey
->lock
) <= 0)
1614 REF_PRINT_COUNT("EVP_PKEY", pkey
);
1615 REF_ASSERT_ISNT(i
< 2);
1616 return ((i
> 1) ? 1 : 0);
1620 void evp_pkey_free_legacy(EVP_PKEY
*x
)
1622 if (x
->ameth
!= NULL
) {
1623 if (x
->ameth
->pkey_free
!= NULL
)
1624 x
->ameth
->pkey_free(x
);
1627 # ifndef OPENSSL_NO_ENGINE
1628 ENGINE_finish(x
->engine
);
1630 ENGINE_finish(x
->pmeth_engine
);
1631 x
->pmeth_engine
= NULL
;
1634 #endif /* FIPS_MODULE */
1636 static void evp_pkey_free_it(EVP_PKEY
*x
)
1638 /* internal function; x is never NULL */
1640 evp_keymgmt_util_clear_operation_cache(x
);
1642 evp_pkey_free_legacy(x
);
1645 if (x
->keymgmt
!= NULL
) {
1646 evp_keymgmt_freedata(x
->keymgmt
, x
->keydata
);
1647 EVP_KEYMGMT_free(x
->keymgmt
);
1651 x
->type
= EVP_PKEY_NONE
;
1654 void EVP_PKEY_free(EVP_PKEY
*x
)
1661 CRYPTO_DOWN_REF(&x
->references
, &i
, x
->lock
);
1662 REF_PRINT_COUNT("EVP_PKEY", x
);
1665 REF_ASSERT_ISNT(i
< 0);
1666 evp_pkey_free_it(x
);
1668 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY
, x
, &x
->ex_data
);
1670 CRYPTO_THREAD_lock_free(x
->lock
);
1672 sk_X509_ATTRIBUTE_pop_free(x
->attributes
, X509_ATTRIBUTE_free
);
1677 int EVP_PKEY_size(const EVP_PKEY
*pkey
)
1682 size
= pkey
->cache
.size
;
1684 if (pkey
->ameth
!= NULL
&& pkey
->ameth
->pkey_size
!= NULL
)
1685 size
= pkey
->ameth
->pkey_size(pkey
);
1691 void *evp_pkey_export_to_provider(EVP_PKEY
*pk
, OSSL_LIB_CTX
*libctx
,
1692 EVP_KEYMGMT
**keymgmt
,
1693 const char *propquery
)
1695 EVP_KEYMGMT
*allocated_keymgmt
= NULL
;
1696 EVP_KEYMGMT
*tmp_keymgmt
= NULL
;
1697 void *keydata
= NULL
;
1703 /* No key data => nothing to export */
1706 check
= check
&& pk
->pkey
.ptr
== NULL
;
1708 check
= check
&& pk
->keydata
== NULL
;
1713 if (pk
->pkey
.ptr
!= NULL
) {
1715 * If the legacy key doesn't have an dirty counter or export function,
1718 if (pk
->ameth
->dirty_cnt
== NULL
|| pk
->ameth
->export_to
== NULL
)
1723 if (keymgmt
!= NULL
) {
1724 tmp_keymgmt
= *keymgmt
;
1729 * If no keymgmt was given or found, get a default keymgmt. We do so by
1730 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1732 if (tmp_keymgmt
== NULL
) {
1733 EVP_PKEY_CTX
*ctx
= EVP_PKEY_CTX_new_from_pkey(libctx
, pk
, propquery
);
1735 tmp_keymgmt
= ctx
->keymgmt
;
1736 ctx
->keymgmt
= NULL
;
1737 EVP_PKEY_CTX_free(ctx
);
1740 /* If there's still no keymgmt to be had, give up */
1741 if (tmp_keymgmt
== NULL
)
1745 if (pk
->pkey
.ptr
!= NULL
) {
1749 * If the legacy "origin" hasn't changed since last time, we try
1750 * to find our keymgmt in the operation cache. If it has changed,
1751 * |i| remains zero, and we will clear the cache further down.
1753 if (pk
->ameth
->dirty_cnt(pk
) == pk
->dirty_cnt_copy
) {
1754 i
= evp_keymgmt_util_find_operation_cache_index(pk
, tmp_keymgmt
);
1757 * If |tmp_keymgmt| is present in the operation cache, it means
1758 * that export doesn't need to be redone. In that case, we take
1759 * token copies of the cached pointers, to have token success
1762 if (i
< OSSL_NELEM(pk
->operation_cache
)
1763 && pk
->operation_cache
[i
].keymgmt
!= NULL
) {
1764 keydata
= pk
->operation_cache
[i
].keydata
;
1770 * TODO(3.0) Right now, we assume we have ample space. We will have
1771 * to think about a cache aging scheme, though, if |i| indexes outside
1774 if (!ossl_assert(i
< OSSL_NELEM(pk
->operation_cache
)))
1777 /* Make sure that the keymgmt key type matches the legacy NID */
1778 if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt
, OBJ_nid2sn(pk
->type
))))
1781 if ((keydata
= evp_keymgmt_newdata(tmp_keymgmt
)) == NULL
)
1784 if (!pk
->ameth
->export_to(pk
, keydata
, tmp_keymgmt
, libctx
, propquery
)) {
1785 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1791 * If the dirty counter changed since last time, then clear the
1792 * operation cache. In that case, we know that |i| is zero. Just
1793 * in case this is a re-export, we increment then decrement the
1794 * keymgmt reference counter.
1796 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt
)) { /* refcnt++ */
1797 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1801 if (pk
->ameth
->dirty_cnt(pk
) != pk
->dirty_cnt_copy
)
1802 evp_keymgmt_util_clear_operation_cache(pk
);
1803 EVP_KEYMGMT_free(tmp_keymgmt
); /* refcnt-- */
1805 /* Add the new export to the operation cache */
1806 if (!evp_keymgmt_util_cache_keydata(pk
, i
, tmp_keymgmt
, keydata
)) {
1807 evp_keymgmt_freedata(tmp_keymgmt
, keydata
);
1812 /* Synchronize the dirty count */
1813 pk
->dirty_cnt_copy
= pk
->ameth
->dirty_cnt(pk
);
1816 #endif /* FIPS_MODULE */
1818 keydata
= evp_keymgmt_util_export_to_provider(pk
, tmp_keymgmt
);
1822 * If nothing was exported, |tmp_keymgmt| might point at a freed
1823 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1824 * the caller either way in that case.
1826 if (keydata
== NULL
)
1829 if (keymgmt
!= NULL
)
1830 *keymgmt
= tmp_keymgmt
;
1832 EVP_KEYMGMT_free(allocated_keymgmt
);
1837 int evp_pkey_copy_downgraded(EVP_PKEY
**dest
, const EVP_PKEY
*src
)
1839 if (!ossl_assert(dest
!= NULL
))
1842 if (evp_pkey_is_assigned(src
) && evp_pkey_is_provided(src
)) {
1843 EVP_KEYMGMT
*keymgmt
= src
->keymgmt
;
1844 void *keydata
= src
->keydata
;
1845 int type
= src
->type
;
1846 const char *keytype
= NULL
;
1848 keytype
= evp_first_name(EVP_KEYMGMT_provider(keymgmt
),
1852 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1853 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1854 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1855 * TODO(3.0) remove this check when we're confident that the rest
1856 * of the code treats this correctly.
1858 if (!ossl_assert(type
!= EVP_PKEY_NONE
)) {
1859 ERR_raise_data(ERR_LIB_EVP
, ERR_R_INTERNAL_ERROR
,
1860 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1865 /* Prefer the legacy key type name for error reporting */
1866 if (type
!= EVP_PKEY_KEYMGMT
)
1867 keytype
= OBJ_nid2sn(type
);
1869 /* Make sure we have a clean slate to copy into */
1871 *dest
= EVP_PKEY_new();
1873 evp_pkey_free_it(*dest
);
1875 if (EVP_PKEY_set_type(*dest
, type
)) {
1876 /* If the key is typed but empty, we're done */
1877 if (keydata
== NULL
)
1880 if ((*dest
)->ameth
->import_from
== NULL
) {
1881 ERR_raise_data(ERR_LIB_EVP
, EVP_R_NO_IMPORT_FUNCTION
,
1882 "key type = %s", keytype
);
1885 * We perform the export in the same libctx as the keymgmt
1886 * that we are using.
1888 OSSL_LIB_CTX
*libctx
=
1889 ossl_provider_library_context(keymgmt
->prov
);
1890 EVP_PKEY_CTX
*pctx
=
1891 EVP_PKEY_CTX_new_from_pkey(libctx
, *dest
, NULL
);
1894 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
1897 && evp_keymgmt_export(keymgmt
, keydata
,
1898 OSSL_KEYMGMT_SELECT_ALL
,
1899 (*dest
)->ameth
->import_from
,
1901 /* Synchronize the dirty count */
1902 (*dest
)->dirty_cnt_copy
= (*dest
)->ameth
->dirty_cnt(*dest
);
1904 EVP_PKEY_CTX_free(pctx
);
1907 EVP_PKEY_CTX_free(pctx
);
1910 ERR_raise_data(ERR_LIB_EVP
, EVP_R_KEYMGMT_EXPORT_FAILURE
,
1911 "key type = %s", keytype
);
1918 int evp_pkey_downgrade(EVP_PKEY
*pk
)
1920 EVP_PKEY tmp_copy
; /* Stack allocated! */
1921 CRYPTO_RWLOCK
*tmp_lock
= NULL
; /* Temporary lock */
1924 if (!ossl_assert(pk
!= NULL
))
1928 * Throughout this whole function, we must ensure that we lock / unlock
1929 * the exact same lock. Note that we do pass it around a bit.
1931 if (!CRYPTO_THREAD_write_lock(pk
->lock
))
1934 /* If this isn't an assigned provider side key, we're done */
1935 if (!evp_pkey_is_assigned(pk
) || !evp_pkey_is_provided(pk
)) {
1941 * To be able to downgrade, we steal the contents of |pk|, then reset
1942 * it, and finally try to make it a downgraded copy. If any of that
1943 * fails, we restore the copied contents into |pk|.
1945 tmp_copy
= *pk
; /* |tmp_copy| now owns THE lock */
1947 if (evp_pkey_reset_unlocked(pk
)
1948 && evp_pkey_copy_downgraded(&pk
, &tmp_copy
)) {
1949 /* Grab the temporary lock to avoid lock leak */
1950 tmp_lock
= pk
->lock
;
1952 /* Restore the common attributes, then empty |tmp_copy| */
1953 pk
->references
= tmp_copy
.references
;
1954 pk
->lock
= tmp_copy
.lock
; /* |pk| now owns THE lock */
1955 pk
->attributes
= tmp_copy
.attributes
;
1956 pk
->save_parameters
= tmp_copy
.save_parameters
;
1957 pk
->ex_data
= tmp_copy
.ex_data
;
1959 /* Ensure that stuff we've copied won't be freed */
1960 tmp_copy
.lock
= NULL
;
1961 tmp_copy
.attributes
= NULL
;
1962 memset(&tmp_copy
.ex_data
, 0, sizeof(tmp_copy
.ex_data
));
1965 * Save the provider side data in the operation cache, so they'll
1966 * find it again. |pk| is new, so it's safe to assume slot zero
1968 * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1969 * reference count, so we need to decrement it, or there will be a
1972 evp_keymgmt_util_cache_keydata(pk
, 0, tmp_copy
.keymgmt
,
1974 EVP_KEYMGMT_free(tmp_copy
.keymgmt
);
1977 * Clear keymgmt and keydata from |tmp_copy|, or they'll get
1978 * inadvertently freed.
1980 tmp_copy
.keymgmt
= NULL
;
1981 tmp_copy
.keydata
= NULL
;
1983 evp_pkey_free_it(&tmp_copy
);
1986 /* Grab the temporary lock to avoid lock leak */
1987 tmp_lock
= pk
->lock
;
1989 /* Restore the original key */
1990 *pk
= tmp_copy
; /* |pk| now owns THE lock */
1993 /* Free the temporary lock. It should never be NULL */
1994 CRYPTO_THREAD_lock_free(tmp_lock
);
1997 if (!CRYPTO_THREAD_unlock(pk
->lock
))
2001 #endif /* FIPS_MODULE */
2003 const OSSL_PARAM
*EVP_PKEY_gettable_params(EVP_PKEY
*pkey
)
2006 || pkey
->keymgmt
== NULL
2007 || pkey
->keydata
== NULL
)
2009 return EVP_KEYMGMT_gettable_params(pkey
->keymgmt
);
2012 int EVP_PKEY_get_bn_param(EVP_PKEY
*pkey
, const char *key_name
, BIGNUM
**bn
)
2015 OSSL_PARAM params
[2];
2016 unsigned char buffer
[2048];
2017 unsigned char *buf
= NULL
;
2021 || pkey
->keymgmt
== NULL
2022 || pkey
->keydata
== NULL
2027 memset(buffer
, 0, sizeof(buffer
));
2028 params
[0] = OSSL_PARAM_construct_BN(key_name
, buffer
, sizeof(buffer
));
2029 params
[1] = OSSL_PARAM_construct_end();
2030 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
)) {
2031 if (!OSSL_PARAM_modified(params
) || params
[0].return_size
== 0)
2033 buf_sz
= params
[0].return_size
;
2035 * If it failed because the buffer was too small then allocate the
2036 * required buffer size and retry.
2038 buf
= OPENSSL_zalloc(buf_sz
);
2041 params
[0].data
= buf
;
2042 params
[0].data_size
= buf_sz
;
2044 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
))
2047 /* Fail if the param was not found */
2048 if (!OSSL_PARAM_modified(params
))
2050 ret
= OSSL_PARAM_get_BN(params
, bn
);
2056 int EVP_PKEY_get_octet_string_param(EVP_PKEY
*pkey
, const char *key_name
,
2057 unsigned char *buf
, size_t max_buf_sz
,
2060 OSSL_PARAM params
[2];
2063 || pkey
->keymgmt
== NULL
2064 || pkey
->keydata
== NULL
2065 || key_name
== NULL
)
2068 params
[0] = OSSL_PARAM_construct_octet_string(key_name
, buf
, max_buf_sz
);
2069 params
[1] = OSSL_PARAM_construct_end();
2070 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
)
2071 || !OSSL_PARAM_modified(params
))
2074 *out_sz
= params
[0].return_size
;
2078 int EVP_PKEY_get_utf8_string_param(EVP_PKEY
*pkey
, const char *key_name
,
2079 char *str
, size_t max_buf_sz
,
2082 OSSL_PARAM params
[2];
2085 || pkey
->keymgmt
== NULL
2086 || pkey
->keydata
== NULL
2087 || key_name
== NULL
)
2090 params
[0] = OSSL_PARAM_construct_utf8_string(key_name
, str
, max_buf_sz
);
2091 params
[1] = OSSL_PARAM_construct_end();
2092 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
)
2093 || !OSSL_PARAM_modified(params
))
2096 *out_sz
= params
[0].return_size
;
2100 int EVP_PKEY_get_int_param(EVP_PKEY
*pkey
, const char *key_name
, int *out
)
2102 OSSL_PARAM params
[2];
2105 || pkey
->keymgmt
== NULL
2106 || pkey
->keydata
== NULL
2107 || key_name
== NULL
)
2110 params
[0] = OSSL_PARAM_construct_int(key_name
, out
);
2111 params
[1] = OSSL_PARAM_construct_end();
2112 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
)
2113 || !OSSL_PARAM_modified(params
))
2118 int EVP_PKEY_get_size_t_param(EVP_PKEY
*pkey
, const char *key_name
, size_t *out
)
2120 OSSL_PARAM params
[2];
2123 || pkey
->keymgmt
== NULL
2124 || pkey
->keydata
== NULL
2125 || key_name
== NULL
)
2128 params
[0] = OSSL_PARAM_construct_size_t(key_name
, out
);
2129 params
[1] = OSSL_PARAM_construct_end();
2130 if (!evp_keymgmt_get_params(pkey
->keymgmt
, pkey
->keydata
, params
)
2131 || !OSSL_PARAM_modified(params
))