2 * Copyright 2006-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 * Low level key APIs (DH etc) are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
19 # include <openssl/engine.h>
21 #include <openssl/evp.h>
22 #include <openssl/core_names.h>
23 #include <openssl/dh.h>
24 #include <openssl/rsa.h>
25 #include <openssl/kdf.h>
26 #include "crypto/cryptlib.h"
28 # include "crypto/asn1.h"
30 #include "crypto/evp.h"
31 #include "crypto/dh.h"
32 #include "crypto/ec.h"
33 #include "internal/ffc.h"
34 #include "internal/numbers.h"
35 #include "internal/provider.h"
36 #include "evp_local.h"
40 static int evp_pkey_ctx_store_cached_data(EVP_PKEY_CTX *ctx,
41 int keytype, int optype,
42 int cmd, const char *name,
43 const void *data, size_t data_len);
44 static void evp_pkey_ctx_free_cached_data(EVP_PKEY_CTX *ctx,
45 int cmd, const char *name);
46 static void evp_pkey_ctx_free_all_cached_data(EVP_PKEY_CTX *ctx);
48 typedef const EVP_PKEY_METHOD *(*pmeth_fn)(void);
49 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
51 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
53 /* This array needs to be in order of NIDs */
54 static pmeth_fn standard_methods[] = {
56 # ifndef OPENSSL_NO_DH
59 # ifndef OPENSSL_NO_DSA
62 # ifndef OPENSSL_NO_EC
65 ossl_rsa_pss_pkey_method,
66 # ifndef OPENSSL_NO_DH
69 # ifndef OPENSSL_NO_EC
70 ossl_ecx25519_pkey_method,
71 ossl_ecx448_pkey_method,
73 # ifndef OPENSSL_NO_EC
74 ossl_ed25519_pkey_method,
75 ossl_ed448_pkey_method,
79 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
81 static int pmeth_func_cmp(const EVP_PKEY_METHOD *const *a, pmeth_fn const *b)
83 return ((*a)->pkey_id - ((**b)())->pkey_id);
86 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
88 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
89 const EVP_PKEY_METHOD *const *b)
91 return ((*a)->pkey_id - (*b)->pkey_id);
94 static const EVP_PKEY_METHOD *evp_pkey_meth_find_added_by_application(int type)
96 if (app_pkey_methods != NULL) {
101 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
103 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
108 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
112 const EVP_PKEY_METHOD *t;
114 if ((t = evp_pkey_meth_find_added_by_application(type)) != NULL)
119 ret = OBJ_bsearch_pmeth_func(&t, standard_methods,
120 OSSL_NELEM(standard_methods));
121 if (ret == NULL || *ret == NULL)
126 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
128 EVP_PKEY_METHOD *pmeth;
130 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
132 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
137 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
141 static void help_get_legacy_alg_type_from_keymgmt(const char *keytype,
146 if (*type == NID_undef)
147 *type = evp_pkey_name2type(keytype);
150 static int get_legacy_alg_type_from_keymgmt(const EVP_KEYMGMT *keymgmt)
152 int type = NID_undef;
154 EVP_KEYMGMT_names_do_all(keymgmt, help_get_legacy_alg_type_from_keymgmt,
158 #endif /* FIPS_MODULE */
160 int evp_pkey_ctx_state(const EVP_PKEY_CTX *ctx)
162 if (ctx->operation == EVP_PKEY_OP_UNDEFINED)
163 return EVP_PKEY_STATE_UNKNOWN;
165 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
166 && ctx->op.kex.algctx != NULL)
167 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
168 && ctx->op.sig.algctx != NULL)
169 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
170 && ctx->op.ciph.algctx != NULL)
171 || (EVP_PKEY_CTX_IS_GEN_OP(ctx)
172 && ctx->op.keymgmt.genctx != NULL)
173 || (EVP_PKEY_CTX_IS_KEM_OP(ctx)
174 && ctx->op.encap.algctx != NULL))
175 return EVP_PKEY_STATE_PROVIDER;
177 return EVP_PKEY_STATE_LEGACY;
180 static EVP_PKEY_CTX *int_ctx_new(OSSL_LIB_CTX *libctx,
181 EVP_PKEY *pkey, ENGINE *e,
182 const char *keytype, const char *propquery,
186 EVP_PKEY_CTX *ret = NULL;
187 const EVP_PKEY_METHOD *pmeth = NULL, *app_pmeth = NULL;
188 EVP_KEYMGMT *keymgmt = NULL;
190 /* Code below to be removed when legacy support is dropped. */
193 if (pkey != NULL && !evp_pkey_is_provided(pkey)) {
197 /* Must be provided if we get here */
198 keytype = EVP_KEYMGMT_get0_name(pkey->keymgmt);
201 if (keytype != NULL) {
202 OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL);
203 id = evp_pkey_name2type(keytype);
210 /* If no ID was found here, we can only resort to find a keymgmt */
213 /* Using engine with a key without id will not work */
215 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
224 * Here, we extract what information we can for the purpose of
225 * supporting usage with implementations from providers, to make
226 * for a smooth transition from legacy stuff to provider based stuff.
228 * If an engine is given, this is entirely legacy, and we should not
229 * pretend anything else, so we clear the name.
233 if (e == NULL && (pkey == NULL || pkey->foreign == 0))
234 keytype = OBJ_nid2sn(id);
236 # ifndef OPENSSL_NO_ENGINE
237 if (e == NULL && pkey != NULL)
238 e = pkey->pmeth_engine != NULL ? pkey->pmeth_engine : pkey->engine;
239 /* Try to find an ENGINE which implements this method */
241 if (!ENGINE_init(e)) {
242 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
246 e = ENGINE_get_pkey_meth_engine(id);
250 * If an ENGINE handled this method look it up. Otherwise use internal
254 pmeth = ENGINE_get_pkey_meth(e, id);
255 else if (pkey != NULL && pkey->foreign)
256 pmeth = EVP_PKEY_meth_find(id);
259 app_pmeth = pmeth = evp_pkey_meth_find_added_by_application(id);
262 #endif /* FIPS_MODULE */
265 * If there's no engine and no app supplied pmeth and there's a name, we try
266 * fetching a provider implementation.
268 if (e == NULL && app_pmeth == NULL && keytype != NULL) {
270 * If |pkey| is given and is provided, we take a reference to its
271 * keymgmt. Otherwise, we fetch one for the keytype we got. This
272 * is to ensure that operation init functions can access what they
273 * need through this single pointer.
275 if (pkey != NULL && pkey->keymgmt != NULL) {
276 if (!EVP_KEYMGMT_up_ref(pkey->keymgmt))
277 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
279 keymgmt = pkey->keymgmt;
281 keymgmt = EVP_KEYMGMT_fetch(libctx, keytype, propquery);
284 return NULL; /* EVP_KEYMGMT_fetch() recorded an error */
288 * Chase down the legacy NID, as that might be needed for diverse
289 * purposes, such as ensure that EVP_PKEY_type() can return sensible
290 * values. We go through all keymgmt names, because the keytype
291 * that's passed to this function doesn't necessarily translate
294 if (keymgmt != NULL) {
295 int tmp_id = get_legacy_alg_type_from_keymgmt(keymgmt);
297 if (tmp_id != NID_undef) {
302 * It really really shouldn't differ. If it still does,
303 * something is very wrong.
305 if (!ossl_assert(id == tmp_id)) {
306 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
307 EVP_KEYMGMT_free(keymgmt);
316 if (pmeth == NULL && keymgmt == NULL) {
317 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
319 ret = OPENSSL_zalloc(sizeof(*ret));
321 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
324 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
325 if ((ret == NULL || pmeth == NULL) && e != NULL)
330 EVP_KEYMGMT_free(keymgmt);
333 if (propquery != NULL) {
334 ret->propquery = OPENSSL_strdup(propquery);
335 if (ret->propquery == NULL) {
337 EVP_KEYMGMT_free(keymgmt);
341 ret->libctx = libctx;
342 ret->keytype = keytype;
343 ret->keymgmt = keymgmt;
344 ret->legacy_keytype = id;
347 ret->operation = EVP_PKEY_OP_UNDEFINED;
350 EVP_PKEY_up_ref(pkey);
352 if (pmeth != NULL && pmeth->init != NULL) {
353 if (pmeth->init(ret) <= 0) {
355 EVP_PKEY_CTX_free(ret);
363 /*- All methods below can also be used in FIPS_MODULE */
365 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_name(OSSL_LIB_CTX *libctx,
367 const char *propquery)
369 return int_ctx_new(libctx, NULL, NULL, name, propquery, -1);
372 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_pkey(OSSL_LIB_CTX *libctx, EVP_PKEY *pkey,
373 const char *propquery)
375 return int_ctx_new(libctx, pkey, NULL, NULL, propquery, -1);
378 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx)
380 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
381 if (ctx->op.sig.algctx != NULL && ctx->op.sig.signature != NULL)
382 ctx->op.sig.signature->freectx(ctx->op.sig.algctx);
383 EVP_SIGNATURE_free(ctx->op.sig.signature);
384 ctx->op.sig.algctx = NULL;
385 ctx->op.sig.signature = NULL;
386 } else if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
387 if (ctx->op.kex.algctx != NULL && ctx->op.kex.exchange != NULL)
388 ctx->op.kex.exchange->freectx(ctx->op.kex.algctx);
389 EVP_KEYEXCH_free(ctx->op.kex.exchange);
390 ctx->op.kex.algctx = NULL;
391 ctx->op.kex.exchange = NULL;
392 } else if (EVP_PKEY_CTX_IS_KEM_OP(ctx)) {
393 if (ctx->op.encap.algctx != NULL && ctx->op.encap.kem != NULL)
394 ctx->op.encap.kem->freectx(ctx->op.encap.algctx);
395 EVP_KEM_free(ctx->op.encap.kem);
396 ctx->op.encap.algctx = NULL;
397 ctx->op.encap.kem = NULL;
399 else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
400 if (ctx->op.ciph.algctx != NULL && ctx->op.ciph.cipher != NULL)
401 ctx->op.ciph.cipher->freectx(ctx->op.ciph.algctx);
402 EVP_ASYM_CIPHER_free(ctx->op.ciph.cipher);
403 ctx->op.ciph.algctx = NULL;
404 ctx->op.ciph.cipher = NULL;
405 } else if (EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
406 if (ctx->op.keymgmt.genctx != NULL && ctx->keymgmt != NULL)
407 evp_keymgmt_gen_cleanup(ctx->keymgmt, ctx->op.keymgmt.genctx);
411 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
415 if (ctx->pmeth && ctx->pmeth->cleanup)
416 ctx->pmeth->cleanup(ctx);
418 evp_pkey_ctx_free_old_ops(ctx);
420 evp_pkey_ctx_free_all_cached_data(ctx);
422 EVP_KEYMGMT_free(ctx->keymgmt);
424 OPENSSL_free(ctx->propquery);
425 EVP_PKEY_free(ctx->pkey);
426 EVP_PKEY_free(ctx->peerkey);
427 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
428 ENGINE_finish(ctx->engine);
430 BN_free(ctx->rsa_pubexp);
436 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
437 const EVP_PKEY_METHOD *meth)
440 *ppkey_id = meth->pkey_id;
442 *pflags = meth->flags;
445 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
447 int pkey_id = dst->pkey_id;
448 int flags = dst->flags;
452 /* We only copy the function pointers so restore the other values */
453 dst->pkey_id = pkey_id;
457 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
459 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
463 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
465 return int_ctx_new(NULL, pkey, e, NULL, NULL, -1);
468 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
470 return int_ctx_new(NULL, NULL, e, NULL, NULL, id);
473 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *pctx)
477 # ifndef OPENSSL_NO_ENGINE
478 /* Make sure it's safe to copy a pkey context using an ENGINE */
479 if (pctx->engine && !ENGINE_init(pctx->engine)) {
480 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
484 rctx = OPENSSL_zalloc(sizeof(*rctx));
486 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
490 if (pctx->pkey != NULL)
491 EVP_PKEY_up_ref(pctx->pkey);
492 rctx->pkey = pctx->pkey;
493 rctx->operation = pctx->operation;
494 rctx->libctx = pctx->libctx;
495 rctx->keytype = pctx->keytype;
496 rctx->propquery = NULL;
497 if (pctx->propquery != NULL) {
498 rctx->propquery = OPENSSL_strdup(pctx->propquery);
499 if (rctx->propquery == NULL)
502 rctx->legacy_keytype = pctx->legacy_keytype;
504 if (EVP_PKEY_CTX_IS_DERIVE_OP(pctx)) {
505 if (pctx->op.kex.exchange != NULL) {
506 rctx->op.kex.exchange = pctx->op.kex.exchange;
507 if (!EVP_KEYEXCH_up_ref(rctx->op.kex.exchange))
510 if (pctx->op.kex.algctx != NULL) {
511 if (!ossl_assert(pctx->op.kex.exchange != NULL))
514 = pctx->op.kex.exchange->dupctx(pctx->op.kex.algctx);
515 if (rctx->op.kex.algctx == NULL) {
516 EVP_KEYEXCH_free(rctx->op.kex.exchange);
517 rctx->op.kex.exchange = NULL;
522 } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)) {
523 if (pctx->op.sig.signature != NULL) {
524 rctx->op.sig.signature = pctx->op.sig.signature;
525 if (!EVP_SIGNATURE_up_ref(rctx->op.sig.signature))
528 if (pctx->op.sig.algctx != NULL) {
529 if (!ossl_assert(pctx->op.sig.signature != NULL))
532 = pctx->op.sig.signature->dupctx(pctx->op.sig.algctx);
533 if (rctx->op.sig.algctx == NULL) {
534 EVP_SIGNATURE_free(rctx->op.sig.signature);
535 rctx->op.sig.signature = NULL;
540 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(pctx)) {
541 if (pctx->op.ciph.cipher != NULL) {
542 rctx->op.ciph.cipher = pctx->op.ciph.cipher;
543 if (!EVP_ASYM_CIPHER_up_ref(rctx->op.ciph.cipher))
546 if (pctx->op.ciph.algctx != NULL) {
547 if (!ossl_assert(pctx->op.ciph.cipher != NULL))
550 = pctx->op.ciph.cipher->dupctx(pctx->op.ciph.algctx);
551 if (rctx->op.ciph.algctx == NULL) {
552 EVP_ASYM_CIPHER_free(rctx->op.ciph.cipher);
553 rctx->op.ciph.cipher = NULL;
558 } else if (EVP_PKEY_CTX_IS_KEM_OP(pctx)) {
559 if (pctx->op.encap.kem != NULL) {
560 rctx->op.encap.kem = pctx->op.encap.kem;
561 if (!EVP_KEM_up_ref(rctx->op.encap.kem))
564 if (pctx->op.encap.algctx != NULL) {
565 if (!ossl_assert(pctx->op.encap.kem != NULL))
567 rctx->op.encap.algctx
568 = pctx->op.encap.kem->dupctx(pctx->op.encap.algctx);
569 if (rctx->op.encap.algctx == NULL) {
570 EVP_KEM_free(rctx->op.encap.kem);
571 rctx->op.encap.kem = NULL;
576 } else if (EVP_PKEY_CTX_IS_GEN_OP(pctx)) {
577 /* Not supported - This would need a gen_dupctx() to work */
581 rctx->pmeth = pctx->pmeth;
582 # ifndef OPENSSL_NO_ENGINE
583 rctx->engine = pctx->engine;
586 if (pctx->peerkey != NULL)
587 EVP_PKEY_up_ref(pctx->peerkey);
588 rctx->peerkey = pctx->peerkey;
590 if (pctx->pmeth == NULL) {
591 if (rctx->operation == EVP_PKEY_OP_UNDEFINED) {
592 EVP_KEYMGMT *tmp_keymgmt = pctx->keymgmt;
595 provkey = evp_pkey_export_to_provider(pctx->pkey, pctx->libctx,
596 &tmp_keymgmt, pctx->propquery);
599 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt))
601 EVP_KEYMGMT_free(rctx->keymgmt);
602 rctx->keymgmt = tmp_keymgmt;
605 } else if (pctx->pmeth->copy(rctx, pctx) > 0) {
610 EVP_PKEY_CTX_free(rctx);
614 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
616 if (app_pkey_methods == NULL) {
617 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
618 if (app_pkey_methods == NULL) {
619 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
623 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth)) {
624 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
627 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
631 void evp_app_cleanup_int(void)
633 if (app_pkey_methods != NULL)
634 sk_EVP_PKEY_METHOD_pop_free(app_pkey_methods, EVP_PKEY_meth_free);
637 int EVP_PKEY_meth_remove(const EVP_PKEY_METHOD *pmeth)
639 const EVP_PKEY_METHOD *ret;
641 ret = sk_EVP_PKEY_METHOD_delete_ptr(app_pkey_methods, pmeth);
643 return ret == NULL ? 0 : 1;
646 size_t EVP_PKEY_meth_get_count(void)
648 size_t rv = OSSL_NELEM(standard_methods);
650 if (app_pkey_methods)
651 rv += sk_EVP_PKEY_METHOD_num(app_pkey_methods);
655 const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx)
657 if (idx < OSSL_NELEM(standard_methods))
658 return (standard_methods[idx])();
659 if (app_pkey_methods == NULL)
661 idx -= OSSL_NELEM(standard_methods);
662 if (idx >= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods))
664 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
668 int EVP_PKEY_CTX_is_a(EVP_PKEY_CTX *ctx, const char *keytype)
671 if (evp_pkey_ctx_is_legacy(ctx))
672 return (ctx->pmeth->pkey_id == evp_pkey_name2type(keytype));
674 return EVP_KEYMGMT_is_a(ctx->keymgmt, keytype);
677 int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, const OSSL_PARAM *params)
679 switch (evp_pkey_ctx_state(ctx)) {
680 case EVP_PKEY_STATE_PROVIDER:
681 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
682 && ctx->op.kex.exchange != NULL
683 && ctx->op.kex.exchange->set_ctx_params != NULL)
685 ctx->op.kex.exchange->set_ctx_params(ctx->op.kex.algctx,
687 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
688 && ctx->op.sig.signature != NULL
689 && ctx->op.sig.signature->set_ctx_params != NULL)
691 ctx->op.sig.signature->set_ctx_params(ctx->op.sig.algctx,
693 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
694 && ctx->op.ciph.cipher != NULL
695 && ctx->op.ciph.cipher->set_ctx_params != NULL)
697 ctx->op.ciph.cipher->set_ctx_params(ctx->op.ciph.algctx,
699 if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
700 && ctx->keymgmt != NULL
701 && ctx->keymgmt->gen_set_params != NULL)
703 evp_keymgmt_gen_set_params(ctx->keymgmt, ctx->op.keymgmt.genctx,
705 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
706 && ctx->op.encap.kem != NULL
707 && ctx->op.encap.kem->set_ctx_params != NULL)
709 ctx->op.encap.kem->set_ctx_params(ctx->op.encap.algctx,
713 case EVP_PKEY_STATE_UNKNOWN:
714 case EVP_PKEY_STATE_LEGACY:
715 return evp_pkey_ctx_set_params_to_ctrl(ctx, params);
721 int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
723 switch (evp_pkey_ctx_state(ctx)) {
724 case EVP_PKEY_STATE_PROVIDER:
725 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
726 && ctx->op.kex.exchange != NULL
727 && ctx->op.kex.exchange->get_ctx_params != NULL)
729 ctx->op.kex.exchange->get_ctx_params(ctx->op.kex.algctx,
731 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
732 && ctx->op.sig.signature != NULL
733 && ctx->op.sig.signature->get_ctx_params != NULL)
735 ctx->op.sig.signature->get_ctx_params(ctx->op.sig.algctx,
737 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
738 && ctx->op.ciph.cipher != NULL
739 && ctx->op.ciph.cipher->get_ctx_params != NULL)
741 ctx->op.ciph.cipher->get_ctx_params(ctx->op.ciph.algctx,
743 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
744 && ctx->op.encap.kem != NULL
745 && ctx->op.encap.kem->get_ctx_params != NULL)
747 ctx->op.encap.kem->get_ctx_params(ctx->op.encap.algctx,
751 case EVP_PKEY_STATE_UNKNOWN:
752 case EVP_PKEY_STATE_LEGACY:
753 return evp_pkey_ctx_get_params_to_ctrl(ctx, params);
760 const OSSL_PARAM *EVP_PKEY_CTX_gettable_params(const EVP_PKEY_CTX *ctx)
764 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
765 && ctx->op.kex.exchange != NULL
766 && ctx->op.kex.exchange->gettable_ctx_params != NULL) {
767 provctx = ossl_provider_ctx(EVP_KEYEXCH_get0_provider(ctx->op.kex.exchange));
768 return ctx->op.kex.exchange->gettable_ctx_params(ctx->op.kex.algctx,
771 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
772 && ctx->op.sig.signature != NULL
773 && ctx->op.sig.signature->gettable_ctx_params != NULL) {
774 provctx = ossl_provider_ctx(
775 EVP_SIGNATURE_get0_provider(ctx->op.sig.signature));
776 return ctx->op.sig.signature->gettable_ctx_params(ctx->op.sig.algctx,
779 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
780 && ctx->op.ciph.cipher != NULL
781 && ctx->op.ciph.cipher->gettable_ctx_params != NULL) {
782 provctx = ossl_provider_ctx(
783 EVP_ASYM_CIPHER_get0_provider(ctx->op.ciph.cipher));
784 return ctx->op.ciph.cipher->gettable_ctx_params(ctx->op.ciph.algctx,
787 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
788 && ctx->op.encap.kem != NULL
789 && ctx->op.encap.kem->gettable_ctx_params != NULL) {
790 provctx = ossl_provider_ctx(EVP_KEM_get0_provider(ctx->op.encap.kem));
791 return ctx->op.encap.kem->gettable_ctx_params(ctx->op.encap.algctx,
797 const OSSL_PARAM *EVP_PKEY_CTX_settable_params(const EVP_PKEY_CTX *ctx)
801 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
802 && ctx->op.kex.exchange != NULL
803 && ctx->op.kex.exchange->settable_ctx_params != NULL) {
804 provctx = ossl_provider_ctx(EVP_KEYEXCH_get0_provider(ctx->op.kex.exchange));
805 return ctx->op.kex.exchange->settable_ctx_params(ctx->op.kex.algctx,
808 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
809 && ctx->op.sig.signature != NULL
810 && ctx->op.sig.signature->settable_ctx_params != NULL) {
811 provctx = ossl_provider_ctx(
812 EVP_SIGNATURE_get0_provider(ctx->op.sig.signature));
813 return ctx->op.sig.signature->settable_ctx_params(ctx->op.sig.algctx,
816 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
817 && ctx->op.ciph.cipher != NULL
818 && ctx->op.ciph.cipher->settable_ctx_params != NULL) {
819 provctx = ossl_provider_ctx(
820 EVP_ASYM_CIPHER_get0_provider(ctx->op.ciph.cipher));
821 return ctx->op.ciph.cipher->settable_ctx_params(ctx->op.ciph.algctx,
824 if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
825 && ctx->keymgmt != NULL
826 && ctx->keymgmt->gen_settable_params != NULL) {
827 provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(ctx->keymgmt));
828 return ctx->keymgmt->gen_settable_params(ctx->op.keymgmt.genctx,
831 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
832 && ctx->op.encap.kem != NULL
833 && ctx->op.encap.kem->settable_ctx_params != NULL) {
834 provctx = ossl_provider_ctx(EVP_KEM_get0_provider(ctx->op.encap.kem));
835 return ctx->op.encap.kem->settable_ctx_params(ctx->op.encap.algctx,
842 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
844 * Return 1 on success, 0 or negative for errors.
846 * In particular they return -2 if any of the params is not supported.
848 * They are not available in FIPS_MODULE as they depend on
849 * - EVP_PKEY_CTX_{get,set}_params()
850 * - EVP_PKEY_CTX_{gettable,settable}_params()
853 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
855 if (ctx == NULL || params == NULL)
859 * We only check for provider side EVP_PKEY_CTX. For #legacy, we
860 * depend on the translation that happens in EVP_PKEY_CTX_set_params()
861 * call, and that the resulting ctrl call will return -2 if it doesn't
862 * known the ctrl command number.
864 if (evp_pkey_ctx_is_provided(ctx)) {
865 const OSSL_PARAM *settable = EVP_PKEY_CTX_settable_params(ctx);
868 for (p = params; p->key != NULL; p++) {
869 /* Check the ctx actually understands this parameter */
870 if (OSSL_PARAM_locate_const(settable, p->key) == NULL)
875 return EVP_PKEY_CTX_set_params(ctx, params);
878 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
880 if (ctx == NULL || params == NULL)
884 * We only check for provider side EVP_PKEY_CTX. For #legacy, we
885 * depend on the translation that happens in EVP_PKEY_CTX_get_params()
886 * call, and that the resulting ctrl call will return -2 if it doesn't
887 * known the ctrl command number.
889 if (evp_pkey_ctx_is_provided(ctx)) {
890 const OSSL_PARAM *gettable = EVP_PKEY_CTX_gettable_params(ctx);
893 for (p = params; p->key != NULL; p++) {
894 /* Check the ctx actually understands this parameter */
895 if (OSSL_PARAM_locate_const(gettable, p->key) == NULL)
900 return EVP_PKEY_CTX_get_params(ctx, params);
903 int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
905 OSSL_PARAM sig_md_params[2], *p = sig_md_params;
906 /* 80 should be big enough */
910 if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
911 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
912 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
916 if (ctx->op.sig.algctx == NULL)
917 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
918 EVP_PKEY_CTRL_GET_MD, 0, (void *)(md));
920 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
923 *p = OSSL_PARAM_construct_end();
925 if (!EVP_PKEY_CTX_get_params(ctx, sig_md_params))
928 tmp = evp_get_digestbyname_ex(ctx->libctx, name);
937 static int evp_pkey_ctx_set_md(EVP_PKEY_CTX *ctx, const EVP_MD *md,
938 int fallback, const char *param, int op,
941 OSSL_PARAM md_params[2], *p = md_params;
944 if (ctx == NULL || (ctx->operation & op) == 0) {
945 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
946 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
951 return EVP_PKEY_CTX_ctrl(ctx, -1, op, ctrl, 0, (void *)(md));
956 name = EVP_MD_get0_name(md);
959 *p++ = OSSL_PARAM_construct_utf8_string(param,
961 * Cast away the const. This is read
962 * only so should be safe
965 *p = OSSL_PARAM_construct_end();
967 return EVP_PKEY_CTX_set_params(ctx, md_params);
970 int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
972 return evp_pkey_ctx_set_md(ctx, md, ctx->op.sig.algctx == NULL,
973 OSSL_SIGNATURE_PARAM_DIGEST,
974 EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD);
977 int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
979 return evp_pkey_ctx_set_md(ctx, md, ctx->op.kex.algctx == NULL,
980 OSSL_KDF_PARAM_DIGEST,
981 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_TLS_MD);
984 static int evp_pkey_ctx_set1_octet_string(EVP_PKEY_CTX *ctx, int fallback,
985 const char *param, int op, int ctrl,
986 const unsigned char *data,
989 OSSL_PARAM octet_string_params[2], *p = octet_string_params;
991 if (ctx == NULL || (ctx->operation & op) == 0) {
992 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
993 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
997 /* Code below to be removed when legacy support is dropped. */
999 return EVP_PKEY_CTX_ctrl(ctx, -1, op, ctrl, datalen, (void *)(data));
1000 /* end of legacy support */
1003 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_LENGTH);
1007 *p++ = OSSL_PARAM_construct_octet_string(param,
1009 * Cast away the const. This is read
1010 * only so should be safe
1012 (unsigned char *)data,
1014 *p = OSSL_PARAM_construct_end();
1016 return EVP_PKEY_CTX_set_params(ctx, octet_string_params);
1019 int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX *ctx,
1020 const unsigned char *sec, int seclen)
1022 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1023 OSSL_KDF_PARAM_SECRET,
1025 EVP_PKEY_CTRL_TLS_SECRET,
1029 int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX *ctx,
1030 const unsigned char *seed, int seedlen)
1032 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1033 OSSL_KDF_PARAM_SEED,
1035 EVP_PKEY_CTRL_TLS_SEED,
1039 int EVP_PKEY_CTX_set_hkdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
1041 return evp_pkey_ctx_set_md(ctx, md, ctx->op.kex.algctx == NULL,
1042 OSSL_KDF_PARAM_DIGEST,
1043 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_HKDF_MD);
1046 int EVP_PKEY_CTX_set1_hkdf_salt(EVP_PKEY_CTX *ctx,
1047 const unsigned char *salt, int saltlen)
1049 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1050 OSSL_KDF_PARAM_SALT,
1052 EVP_PKEY_CTRL_HKDF_SALT,
1056 int EVP_PKEY_CTX_set1_hkdf_key(EVP_PKEY_CTX *ctx,
1057 const unsigned char *key, int keylen)
1059 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1062 EVP_PKEY_CTRL_HKDF_KEY,
1066 int EVP_PKEY_CTX_add1_hkdf_info(EVP_PKEY_CTX *ctx,
1067 const unsigned char *info, int infolen)
1069 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1070 OSSL_KDF_PARAM_INFO,
1072 EVP_PKEY_CTRL_HKDF_INFO,
1076 int EVP_PKEY_CTX_set_hkdf_mode(EVP_PKEY_CTX *ctx, int mode)
1078 OSSL_PARAM int_params[2], *p = int_params;
1080 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
1081 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1082 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1086 /* Code below to be removed when legacy support is dropped. */
1087 if (ctx->op.kex.algctx == NULL)
1088 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_DERIVE,
1089 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL);
1090 /* end of legacy support */
1093 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1097 *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
1098 *p = OSSL_PARAM_construct_end();
1100 return EVP_PKEY_CTX_set_params(ctx, int_params);
1103 int EVP_PKEY_CTX_set1_pbe_pass(EVP_PKEY_CTX *ctx, const char *pass,
1106 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1107 OSSL_KDF_PARAM_PASSWORD,
1110 (const unsigned char *)pass, passlen);
1113 int EVP_PKEY_CTX_set1_scrypt_salt(EVP_PKEY_CTX *ctx,
1114 const unsigned char *salt, int saltlen)
1116 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.algctx == NULL,
1117 OSSL_KDF_PARAM_SALT,
1119 EVP_PKEY_CTRL_SCRYPT_SALT,
1123 static int evp_pkey_ctx_set_uint64(EVP_PKEY_CTX *ctx, const char *param,
1124 int op, int ctrl, uint64_t val)
1126 OSSL_PARAM uint64_params[2], *p = uint64_params;
1128 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
1129 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1130 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1134 /* Code below to be removed when legacy support is dropped. */
1135 if (ctx->op.kex.algctx == NULL)
1136 return EVP_PKEY_CTX_ctrl_uint64(ctx, -1, op, ctrl, val);
1137 /* end of legacy support */
1139 *p++ = OSSL_PARAM_construct_uint64(param, &val);
1140 *p = OSSL_PARAM_construct_end();
1142 return EVP_PKEY_CTX_set_params(ctx, uint64_params);
1145 int EVP_PKEY_CTX_set_scrypt_N(EVP_PKEY_CTX *ctx, uint64_t n)
1147 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_N,
1148 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_SCRYPT_N,
1152 int EVP_PKEY_CTX_set_scrypt_r(EVP_PKEY_CTX *ctx, uint64_t r)
1154 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_R,
1155 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_SCRYPT_R,
1159 int EVP_PKEY_CTX_set_scrypt_p(EVP_PKEY_CTX *ctx, uint64_t p)
1161 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_P,
1162 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_SCRYPT_P,
1166 int EVP_PKEY_CTX_set_scrypt_maxmem_bytes(EVP_PKEY_CTX *ctx,
1167 uint64_t maxmem_bytes)
1169 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_MAXMEM,
1171 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES,
1175 int EVP_PKEY_CTX_set_mac_key(EVP_PKEY_CTX *ctx, const unsigned char *key,
1178 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.keymgmt.genctx == NULL,
1179 OSSL_PKEY_PARAM_PRIV_KEY,
1181 EVP_PKEY_CTRL_SET_MAC_KEY,
1185 int EVP_PKEY_CTX_set_kem_op(EVP_PKEY_CTX *ctx, const char *op)
1187 OSSL_PARAM params[2], *p = params;
1189 if (ctx == NULL || op == NULL) {
1190 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1193 if (!EVP_PKEY_CTX_IS_KEM_OP(ctx)) {
1194 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1197 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KEM_PARAM_OPERATION,
1199 *p = OSSL_PARAM_construct_end();
1200 return EVP_PKEY_CTX_set_params(ctx, params);
1203 int evp_pkey_ctx_set1_id_prov(EVP_PKEY_CTX *ctx, const void *id, int len)
1205 OSSL_PARAM params[2], *p = params;
1208 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
1209 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1210 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1214 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_DIST_ID,
1216 * Cast away the const. This is
1217 * read only so should be safe
1219 (void *)id, (size_t)len);
1220 *p++ = OSSL_PARAM_construct_end();
1222 ret = evp_pkey_ctx_set_params_strict(ctx, params);
1224 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1228 int EVP_PKEY_CTX_set1_id(EVP_PKEY_CTX *ctx, const void *id, int len)
1230 return EVP_PKEY_CTX_ctrl(ctx, -1, -1,
1231 EVP_PKEY_CTRL_SET1_ID, (int)len, (void*)(id));
1234 static int get1_id_data(EVP_PKEY_CTX *ctx, void *id, size_t *id_len)
1237 void *tmp_id = NULL;
1238 OSSL_PARAM params[2], *p = params;
1240 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
1241 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1242 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1246 *p++ = OSSL_PARAM_construct_octet_ptr(OSSL_PKEY_PARAM_DIST_ID,
1248 *p++ = OSSL_PARAM_construct_end();
1250 ret = evp_pkey_ctx_get_params_strict(ctx, params);
1252 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1253 } else if (ret > 0) {
1254 size_t tmp_id_len = params[0].return_size;
1257 memcpy(id, tmp_id, tmp_id_len);
1259 *id_len = tmp_id_len;
1264 int evp_pkey_ctx_get1_id_prov(EVP_PKEY_CTX *ctx, void *id)
1266 return get1_id_data(ctx, id, NULL);
1269 int evp_pkey_ctx_get1_id_len_prov(EVP_PKEY_CTX *ctx, size_t *id_len)
1271 return get1_id_data(ctx, NULL, id_len);
1274 int EVP_PKEY_CTX_get1_id(EVP_PKEY_CTX *ctx, void *id)
1276 return EVP_PKEY_CTX_ctrl(ctx, -1, -1, EVP_PKEY_CTRL_GET1_ID, 0, (void*)id);
1279 int EVP_PKEY_CTX_get1_id_len(EVP_PKEY_CTX *ctx, size_t *id_len)
1281 return EVP_PKEY_CTX_ctrl(ctx, -1, -1,
1282 EVP_PKEY_CTRL_GET1_ID_LEN, 0, (void*)id_len);
1285 static int evp_pkey_ctx_ctrl_int(EVP_PKEY_CTX *ctx, int keytype, int optype,
1286 int cmd, int p1, void *p2)
1291 * If the method has a |digest_custom| function, we can relax the
1292 * operation type check, since this can be called before the operation
1295 if (ctx->pmeth == NULL || ctx->pmeth->digest_custom == NULL) {
1296 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
1297 ERR_raise(ERR_LIB_EVP, EVP_R_NO_OPERATION_SET);
1301 if ((optype != -1) && !(ctx->operation & optype)) {
1302 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1307 switch (evp_pkey_ctx_state(ctx)) {
1308 case EVP_PKEY_STATE_PROVIDER:
1309 return evp_pkey_ctx_ctrl_to_param(ctx, keytype, optype, cmd, p1, p2);
1310 case EVP_PKEY_STATE_UNKNOWN:
1311 case EVP_PKEY_STATE_LEGACY:
1312 if (ctx->pmeth == NULL || ctx->pmeth->ctrl == NULL) {
1313 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1316 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
1319 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
1322 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1328 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
1329 int cmd, int p1, void *p2)
1334 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1337 /* If unsupported, we don't want that reported here */
1339 ret = evp_pkey_ctx_store_cached_data(ctx, keytype, optype,
1344 ERR_clear_last_mark();
1346 * If there was an error, there was an error.
1347 * If the operation isn't initialized yet, we also return, as
1348 * the saved values will be used then anyway.
1350 if (ret < 1 || ctx->operation == EVP_PKEY_OP_UNDEFINED)
1353 return evp_pkey_ctx_ctrl_int(ctx, keytype, optype, cmd, p1, p2);
1356 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
1357 int cmd, uint64_t value)
1359 return EVP_PKEY_CTX_ctrl(ctx, keytype, optype, cmd, 0, &value);
1363 static int evp_pkey_ctx_ctrl_str_int(EVP_PKEY_CTX *ctx,
1364 const char *name, const char *value)
1369 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1373 switch (evp_pkey_ctx_state(ctx)) {
1374 case EVP_PKEY_STATE_PROVIDER:
1375 return evp_pkey_ctx_ctrl_str_to_param(ctx, name, value);
1376 case EVP_PKEY_STATE_UNKNOWN:
1377 case EVP_PKEY_STATE_LEGACY:
1378 if (ctx == NULL || ctx->pmeth == NULL || ctx->pmeth->ctrl_str == NULL) {
1379 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1382 if (strcmp(name, "digest") == 0)
1383 ret = EVP_PKEY_CTX_md(ctx,
1384 EVP_PKEY_OP_TYPE_SIG | EVP_PKEY_OP_TYPE_CRYPT,
1385 EVP_PKEY_CTRL_MD, value);
1387 ret = ctx->pmeth->ctrl_str(ctx, name, value);
1394 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
1395 const char *name, const char *value)
1399 /* If unsupported, we don't want that reported here */
1401 ret = evp_pkey_ctx_store_cached_data(ctx, -1, -1, -1,
1402 name, value, strlen(value) + 1);
1406 ERR_clear_last_mark();
1408 * If there was an error, there was an error.
1409 * If the operation isn't initialized yet, we also return, as
1410 * the saved values will be used then anyway.
1412 if (ret < 1 || ctx->operation == EVP_PKEY_OP_UNDEFINED)
1416 return evp_pkey_ctx_ctrl_str_int(ctx, name, value);
1419 static int decode_cmd(int cmd, const char *name)
1423 * The consequence of the assertion not being true is that this
1424 * function will return -1, which will cause the calling functions
1425 * to signal that the command is unsupported... in non-debug mode.
1427 if (ossl_assert(name != NULL))
1428 if (strcmp(name, "distid") == 0 || strcmp(name, "hexdistid") == 0)
1429 cmd = EVP_PKEY_CTRL_SET1_ID;
1435 static int evp_pkey_ctx_store_cached_data(EVP_PKEY_CTX *ctx,
1436 int keytype, int optype,
1437 int cmd, const char *name,
1438 const void *data, size_t data_len)
1441 * Check that it's one of the supported commands. The ctrl commands
1442 * number cases here must correspond to the cases in the bottom switch
1445 switch (cmd = decode_cmd(cmd, name)) {
1446 case EVP_PKEY_CTRL_SET1_ID:
1449 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1453 if (keytype != -1) {
1454 switch (evp_pkey_ctx_state(ctx)) {
1455 case EVP_PKEY_STATE_PROVIDER:
1456 if (ctx->keymgmt == NULL) {
1457 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1460 if (!EVP_KEYMGMT_is_a(ctx->keymgmt,
1461 evp_pkey_type2name(keytype))) {
1462 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1466 case EVP_PKEY_STATE_UNKNOWN:
1467 case EVP_PKEY_STATE_LEGACY:
1468 if (ctx->pmeth == NULL) {
1469 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1472 if (EVP_PKEY_type(ctx->pmeth->pkey_id) != EVP_PKEY_type(keytype)) {
1473 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1479 if (optype != -1 && (ctx->operation & optype) == 0) {
1480 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1485 case EVP_PKEY_CTRL_SET1_ID:
1486 evp_pkey_ctx_free_cached_data(ctx, cmd, name);
1488 ctx->cached_parameters.dist_id_name = OPENSSL_strdup(name);
1489 if (ctx->cached_parameters.dist_id_name == NULL) {
1490 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1495 ctx->cached_parameters.dist_id = OPENSSL_memdup(data, data_len);
1496 if (ctx->cached_parameters.dist_id == NULL) {
1497 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1501 ctx->cached_parameters.dist_id_set = 1;
1502 ctx->cached_parameters.dist_id_len = data_len;
1508 static void evp_pkey_ctx_free_cached_data(EVP_PKEY_CTX *ctx,
1509 int cmd, const char *name)
1511 cmd = decode_cmd(cmd, name);
1513 case EVP_PKEY_CTRL_SET1_ID:
1514 OPENSSL_free(ctx->cached_parameters.dist_id);
1515 OPENSSL_free(ctx->cached_parameters.dist_id_name);
1516 ctx->cached_parameters.dist_id = NULL;
1517 ctx->cached_parameters.dist_id_name = NULL;
1522 static void evp_pkey_ctx_free_all_cached_data(EVP_PKEY_CTX *ctx)
1524 evp_pkey_ctx_free_cached_data(ctx, EVP_PKEY_CTRL_SET1_ID, NULL);
1527 int evp_pkey_ctx_use_cached_data(EVP_PKEY_CTX *ctx)
1531 if (ret && ctx->cached_parameters.dist_id_set) {
1532 const char *name = ctx->cached_parameters.dist_id_name;
1533 const void *val = ctx->cached_parameters.dist_id;
1534 size_t len = ctx->cached_parameters.dist_id_len;
1537 ret = evp_pkey_ctx_ctrl_str_int(ctx, name, val);
1539 ret = evp_pkey_ctx_ctrl_int(ctx, -1, ctx->operation,
1540 EVP_PKEY_CTRL_SET1_ID,
1541 (int)len, (void *)val);
1547 OSSL_LIB_CTX *EVP_PKEY_CTX_get0_libctx(EVP_PKEY_CTX *ctx)
1552 const char *EVP_PKEY_CTX_get0_propq(const EVP_PKEY_CTX *ctx)
1554 return ctx->propquery;
1557 const OSSL_PROVIDER *EVP_PKEY_CTX_get0_provider(const EVP_PKEY_CTX *ctx)
1559 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
1560 if (ctx->op.sig.signature != NULL)
1561 return EVP_SIGNATURE_get0_provider(ctx->op.sig.signature);
1562 } else if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
1563 if (ctx->op.kex.exchange != NULL)
1564 return EVP_KEYEXCH_get0_provider(ctx->op.kex.exchange);
1565 } else if (EVP_PKEY_CTX_IS_KEM_OP(ctx)) {
1566 if (ctx->op.encap.kem != NULL)
1567 return EVP_KEM_get0_provider(ctx->op.encap.kem);
1568 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
1569 if (ctx->op.ciph.cipher != NULL)
1570 return EVP_ASYM_CIPHER_get0_provider(ctx->op.ciph.cipher);
1571 } else if (EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
1572 if (ctx->keymgmt != NULL)
1573 return EVP_KEYMGMT_get0_provider(ctx->keymgmt);
1579 /* Utility functions to send a string of hex string to a ctrl */
1581 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
1588 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
1591 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
1597 bin = OPENSSL_hexstr2buf(hex, &binlen);
1600 if (binlen <= INT_MAX)
1601 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
1606 /* Pass a message digest to a ctrl */
1607 int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md)
1611 if (md == NULL || (m = EVP_get_digestbyname(md)) == NULL) {
1612 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_DIGEST);
1615 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)m);
1618 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
1620 return ctx->operation;
1623 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
1625 ctx->keygen_info = dat;
1626 ctx->keygen_info_count = datlen;
1629 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
1634 void *EVP_PKEY_CTX_get_data(const EVP_PKEY_CTX *ctx)
1639 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
1644 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
1646 return ctx->peerkey;
1649 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
1651 ctx->app_data = data;
1654 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
1656 return ctx->app_data;
1659 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
1660 int (*init) (EVP_PKEY_CTX *ctx))
1665 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
1666 int (*copy) (EVP_PKEY_CTX *dst,
1667 const EVP_PKEY_CTX *src))
1672 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
1673 void (*cleanup) (EVP_PKEY_CTX *ctx))
1675 pmeth->cleanup = cleanup;
1678 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
1679 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
1680 int (*paramgen) (EVP_PKEY_CTX *ctx,
1683 pmeth->paramgen_init = paramgen_init;
1684 pmeth->paramgen = paramgen;
1687 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
1688 int (*keygen_init) (EVP_PKEY_CTX *ctx),
1689 int (*keygen) (EVP_PKEY_CTX *ctx,
1692 pmeth->keygen_init = keygen_init;
1693 pmeth->keygen = keygen;
1696 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
1697 int (*sign_init) (EVP_PKEY_CTX *ctx),
1698 int (*sign) (EVP_PKEY_CTX *ctx,
1699 unsigned char *sig, size_t *siglen,
1700 const unsigned char *tbs,
1703 pmeth->sign_init = sign_init;
1707 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
1708 int (*verify_init) (EVP_PKEY_CTX *ctx),
1709 int (*verify) (EVP_PKEY_CTX *ctx,
1710 const unsigned char *sig,
1712 const unsigned char *tbs,
1715 pmeth->verify_init = verify_init;
1716 pmeth->verify = verify;
1719 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
1720 int (*verify_recover_init) (EVP_PKEY_CTX
1722 int (*verify_recover) (EVP_PKEY_CTX
1731 pmeth->verify_recover_init = verify_recover_init;
1732 pmeth->verify_recover = verify_recover;
1735 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
1736 int (*signctx_init) (EVP_PKEY_CTX *ctx,
1738 int (*signctx) (EVP_PKEY_CTX *ctx,
1743 pmeth->signctx_init = signctx_init;
1744 pmeth->signctx = signctx;
1747 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
1748 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
1750 int (*verifyctx) (EVP_PKEY_CTX *ctx,
1751 const unsigned char *sig,
1755 pmeth->verifyctx_init = verifyctx_init;
1756 pmeth->verifyctx = verifyctx;
1759 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
1760 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
1761 int (*encryptfn) (EVP_PKEY_CTX *ctx,
1764 const unsigned char *in,
1767 pmeth->encrypt_init = encrypt_init;
1768 pmeth->encrypt = encryptfn;
1771 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
1772 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
1773 int (*decrypt) (EVP_PKEY_CTX *ctx,
1776 const unsigned char *in,
1779 pmeth->decrypt_init = decrypt_init;
1780 pmeth->decrypt = decrypt;
1783 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
1784 int (*derive_init) (EVP_PKEY_CTX *ctx),
1785 int (*derive) (EVP_PKEY_CTX *ctx,
1789 pmeth->derive_init = derive_init;
1790 pmeth->derive = derive;
1793 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
1794 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1796 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
1801 pmeth->ctrl_str = ctrl_str;
1804 void EVP_PKEY_meth_set_digestsign(EVP_PKEY_METHOD *pmeth,
1805 int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1806 const unsigned char *tbs, size_t tbslen))
1808 pmeth->digestsign = digestsign;
1811 void EVP_PKEY_meth_set_digestverify(EVP_PKEY_METHOD *pmeth,
1812 int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1813 size_t siglen, const unsigned char *tbs,
1816 pmeth->digestverify = digestverify;
1819 void EVP_PKEY_meth_set_check(EVP_PKEY_METHOD *pmeth,
1820 int (*check) (EVP_PKEY *pkey))
1822 pmeth->check = check;
1825 void EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD *pmeth,
1826 int (*check) (EVP_PKEY *pkey))
1828 pmeth->public_check = check;
1831 void EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD *pmeth,
1832 int (*check) (EVP_PKEY *pkey))
1834 pmeth->param_check = check;
1837 void EVP_PKEY_meth_set_digest_custom(EVP_PKEY_METHOD *pmeth,
1838 int (*digest_custom) (EVP_PKEY_CTX *ctx,
1841 pmeth->digest_custom = digest_custom;
1844 void EVP_PKEY_meth_get_init(const EVP_PKEY_METHOD *pmeth,
1845 int (**pinit) (EVP_PKEY_CTX *ctx))
1847 *pinit = pmeth->init;
1850 void EVP_PKEY_meth_get_copy(const EVP_PKEY_METHOD *pmeth,
1851 int (**pcopy) (EVP_PKEY_CTX *dst,
1852 const EVP_PKEY_CTX *src))
1854 *pcopy = pmeth->copy;
1857 void EVP_PKEY_meth_get_cleanup(const EVP_PKEY_METHOD *pmeth,
1858 void (**pcleanup) (EVP_PKEY_CTX *ctx))
1860 *pcleanup = pmeth->cleanup;
1863 void EVP_PKEY_meth_get_paramgen(const EVP_PKEY_METHOD *pmeth,
1864 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
1865 int (**pparamgen) (EVP_PKEY_CTX *ctx,
1869 *pparamgen_init = pmeth->paramgen_init;
1871 *pparamgen = pmeth->paramgen;
1874 void EVP_PKEY_meth_get_keygen(const EVP_PKEY_METHOD *pmeth,
1875 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
1876 int (**pkeygen) (EVP_PKEY_CTX *ctx,
1880 *pkeygen_init = pmeth->keygen_init;
1882 *pkeygen = pmeth->keygen;
1885 void EVP_PKEY_meth_get_sign(const EVP_PKEY_METHOD *pmeth,
1886 int (**psign_init) (EVP_PKEY_CTX *ctx),
1887 int (**psign) (EVP_PKEY_CTX *ctx,
1888 unsigned char *sig, size_t *siglen,
1889 const unsigned char *tbs,
1893 *psign_init = pmeth->sign_init;
1895 *psign = pmeth->sign;
1898 void EVP_PKEY_meth_get_verify(const EVP_PKEY_METHOD *pmeth,
1899 int (**pverify_init) (EVP_PKEY_CTX *ctx),
1900 int (**pverify) (EVP_PKEY_CTX *ctx,
1901 const unsigned char *sig,
1903 const unsigned char *tbs,
1907 *pverify_init = pmeth->verify_init;
1909 *pverify = pmeth->verify;
1912 void EVP_PKEY_meth_get_verify_recover(const EVP_PKEY_METHOD *pmeth,
1913 int (**pverify_recover_init) (EVP_PKEY_CTX
1915 int (**pverify_recover) (EVP_PKEY_CTX
1924 if (pverify_recover_init)
1925 *pverify_recover_init = pmeth->verify_recover_init;
1926 if (pverify_recover)
1927 *pverify_recover = pmeth->verify_recover;
1930 void EVP_PKEY_meth_get_signctx(const EVP_PKEY_METHOD *pmeth,
1931 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
1933 int (**psignctx) (EVP_PKEY_CTX *ctx,
1939 *psignctx_init = pmeth->signctx_init;
1941 *psignctx = pmeth->signctx;
1944 void EVP_PKEY_meth_get_verifyctx(const EVP_PKEY_METHOD *pmeth,
1945 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
1947 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
1948 const unsigned char *sig,
1952 if (pverifyctx_init)
1953 *pverifyctx_init = pmeth->verifyctx_init;
1955 *pverifyctx = pmeth->verifyctx;
1958 void EVP_PKEY_meth_get_encrypt(const EVP_PKEY_METHOD *pmeth,
1959 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
1960 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
1963 const unsigned char *in,
1967 *pencrypt_init = pmeth->encrypt_init;
1969 *pencryptfn = pmeth->encrypt;
1972 void EVP_PKEY_meth_get_decrypt(const EVP_PKEY_METHOD *pmeth,
1973 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
1974 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
1977 const unsigned char *in,
1981 *pdecrypt_init = pmeth->decrypt_init;
1983 *pdecrypt = pmeth->decrypt;
1986 void EVP_PKEY_meth_get_derive(const EVP_PKEY_METHOD *pmeth,
1987 int (**pderive_init) (EVP_PKEY_CTX *ctx),
1988 int (**pderive) (EVP_PKEY_CTX *ctx,
1993 *pderive_init = pmeth->derive_init;
1995 *pderive = pmeth->derive;
1998 void EVP_PKEY_meth_get_ctrl(const EVP_PKEY_METHOD *pmeth,
1999 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
2001 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
2006 *pctrl = pmeth->ctrl;
2008 *pctrl_str = pmeth->ctrl_str;
2011 void EVP_PKEY_meth_get_digestsign(const EVP_PKEY_METHOD *pmeth,
2012 int (**digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
2013 const unsigned char *tbs, size_t tbslen))
2016 *digestsign = pmeth->digestsign;
2019 void EVP_PKEY_meth_get_digestverify(const EVP_PKEY_METHOD *pmeth,
2020 int (**digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
2021 size_t siglen, const unsigned char *tbs,
2025 *digestverify = pmeth->digestverify;
2028 void EVP_PKEY_meth_get_check(const EVP_PKEY_METHOD *pmeth,
2029 int (**pcheck) (EVP_PKEY *pkey))
2032 *pcheck = pmeth->check;
2035 void EVP_PKEY_meth_get_public_check(const EVP_PKEY_METHOD *pmeth,
2036 int (**pcheck) (EVP_PKEY *pkey))
2039 *pcheck = pmeth->public_check;
2042 void EVP_PKEY_meth_get_param_check(const EVP_PKEY_METHOD *pmeth,
2043 int (**pcheck) (EVP_PKEY *pkey))
2046 *pcheck = pmeth->param_check;
2049 void EVP_PKEY_meth_get_digest_custom(const EVP_PKEY_METHOD *pmeth,
2050 int (**pdigest_custom) (EVP_PKEY_CTX *ctx,
2053 if (pdigest_custom != NULL)
2054 *pdigest_custom = pmeth->digest_custom;
2057 #endif /* FIPS_MODULE */