2 * Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * Low level key APIs (DH etc) are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
18 #include <openssl/engine.h>
19 #include <openssl/evp.h>
20 #include <openssl/x509v3.h>
21 #include <openssl/core_names.h>
22 #include <openssl/dh.h>
23 #include <openssl/rsa.h>
24 #include <openssl/kdf.h>
25 #include "internal/cryptlib.h"
26 #include "crypto/asn1.h"
27 #include "crypto/evp.h"
28 #include "crypto/dh.h"
29 #include "crypto/ec.h"
30 #include "internal/ffc.h"
31 #include "internal/numbers.h"
32 #include "internal/provider.h"
33 #include "evp_local.h"
37 static int evp_pkey_ctx_store_cached_data(EVP_PKEY_CTX *ctx,
38 int keytype, int optype,
39 int cmd, const char *name,
40 const void *data, size_t data_len);
41 static void evp_pkey_ctx_free_cached_data(EVP_PKEY_CTX *ctx,
42 int cmd, const char *name);
43 static void evp_pkey_ctx_free_all_cached_data(EVP_PKEY_CTX *ctx);
45 typedef const EVP_PKEY_METHOD *(*pmeth_fn)(void);
46 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
48 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
50 /* This array needs to be in order of NIDs */
51 static pmeth_fn standard_methods[] = {
53 # ifndef OPENSSL_NO_DH
56 # ifndef OPENSSL_NO_DSA
59 # ifndef OPENSSL_NO_EC
62 ossl_rsa_pss_pkey_method,
63 # ifndef OPENSSL_NO_DH
66 # ifndef OPENSSL_NO_EC
67 ossl_ecx25519_pkey_method,
68 ossl_ecx448_pkey_method,
70 # ifndef OPENSSL_NO_EC
71 ossl_ed25519_pkey_method,
72 ossl_ed448_pkey_method,
76 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
78 static int pmeth_func_cmp(const EVP_PKEY_METHOD *const *a, pmeth_fn const *b)
80 return ((*a)->pkey_id - ((**b)())->pkey_id);
83 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
85 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
86 const EVP_PKEY_METHOD *const *b)
88 return ((*a)->pkey_id - (*b)->pkey_id);
91 static const EVP_PKEY_METHOD *evp_pkey_meth_find_added_by_application(int type)
93 if (app_pkey_methods != NULL) {
98 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
100 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
105 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
109 const EVP_PKEY_METHOD *t;
111 if ((t = evp_pkey_meth_find_added_by_application(type)) != NULL)
116 ret = OBJ_bsearch_pmeth_func(&t, standard_methods,
117 OSSL_NELEM(standard_methods));
118 if (ret == NULL || *ret == NULL)
123 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
125 EVP_PKEY_METHOD *pmeth;
127 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
129 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
134 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
138 static void help_get_legacy_alg_type_from_keymgmt(const char *keytype,
143 if (*type == NID_undef)
144 *type = evp_pkey_name2type(keytype);
147 static int get_legacy_alg_type_from_keymgmt(const EVP_KEYMGMT *keymgmt)
149 int type = NID_undef;
151 EVP_KEYMGMT_names_do_all(keymgmt, help_get_legacy_alg_type_from_keymgmt,
155 #endif /* FIPS_MODULE */
157 int evp_pkey_ctx_state(const EVP_PKEY_CTX *ctx)
159 if (ctx->operation == EVP_PKEY_OP_UNDEFINED)
160 return EVP_PKEY_STATE_UNKNOWN;
162 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
163 && ctx->op.kex.exchprovctx != NULL)
164 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
165 && ctx->op.sig.sigprovctx != NULL)
166 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
167 && ctx->op.ciph.ciphprovctx != NULL)
168 || (EVP_PKEY_CTX_IS_GEN_OP(ctx)
169 && ctx->op.keymgmt.genctx != NULL)
170 || (EVP_PKEY_CTX_IS_KEM_OP(ctx)
171 && ctx->op.encap.kemprovctx != NULL))
172 return EVP_PKEY_STATE_PROVIDER;
174 return EVP_PKEY_STATE_LEGACY;
177 static EVP_PKEY_CTX *int_ctx_new(OSSL_LIB_CTX *libctx,
178 EVP_PKEY *pkey, ENGINE *e,
179 const char *keytype, const char *propquery,
183 EVP_PKEY_CTX *ret = NULL;
184 const EVP_PKEY_METHOD *pmeth = NULL;
185 EVP_KEYMGMT *keymgmt = NULL;
188 * If the given |pkey| is provided, we extract the keytype from its
189 * keymgmt and skip over the legacy code.
191 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
192 /* If we have an engine, something went wrong somewhere... */
193 if (!ossl_assert(e == NULL))
195 keytype = EVP_KEYMGMT_name(pkey->keymgmt);
200 /* Code below to be removed when legacy support is dropped. */
205 else if (keytype != NULL)
206 id = evp_pkey_name2type(keytype);
210 /* If no ID was found here, we can only resort to find a keymgmt */
215 * Here, we extract what information we can for the purpose of
216 * supporting usage with implementations from providers, to make
217 * for a smooth transition from legacy stuff to provider based stuff.
219 * If an engine is given, this is entirely legacy, and we should not
220 * pretend anything else, so we only set the name when no engine is
221 * given. If both are already given, someone made a mistake, and
222 * since that can only happen internally, it's safe to make an
225 if (!ossl_assert(e == NULL || keytype == NULL))
227 if (e == NULL && (pkey == NULL || pkey->foreign == 0))
228 keytype = OBJ_nid2sn(id);
230 # ifndef OPENSSL_NO_ENGINE
231 if (e == NULL && pkey != NULL)
232 e = pkey->pmeth_engine != NULL ? pkey->pmeth_engine : pkey->engine;
233 /* Try to find an ENGINE which implements this method */
235 if (!ENGINE_init(e)) {
236 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
240 e = ENGINE_get_pkey_meth_engine(id);
244 * If an ENGINE handled this method look it up. Otherwise use internal
248 pmeth = ENGINE_get_pkey_meth(e, id);
249 else if (pkey != NULL && pkey->foreign)
250 pmeth = EVP_PKEY_meth_find(id);
253 pmeth = evp_pkey_meth_find_added_by_application(id);
256 #endif /* FIPS_MODULE */
259 * If there's no engine and there's a name, we try fetching a provider
262 if (e == NULL && keytype != NULL) {
263 keymgmt = EVP_KEYMGMT_fetch(libctx, keytype, propquery);
265 return NULL; /* EVP_KEYMGMT_fetch() recorded an error */
269 * Chase down the legacy NID, as that might be needed for diverse
270 * purposes, such as ensure that EVP_PKEY_type() can return sensible
271 * values. We go through all keymgmt names, because the keytype
272 * that's passed to this function doesn't necessarily translate
274 * TODO: Remove this when #legacy keys are gone.
276 if (keymgmt != NULL) {
277 int tmp_id = get_legacy_alg_type_from_keymgmt(keymgmt);
279 if (tmp_id != NID_undef) {
284 * It really really shouldn't differ. If it still does,
285 * something is very wrong.
287 if (!ossl_assert(id == tmp_id)) {
288 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
289 EVP_KEYMGMT_free(keymgmt);
298 if (pmeth == NULL && keymgmt == NULL) {
299 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
301 ret = OPENSSL_zalloc(sizeof(*ret));
303 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
306 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
307 if ((ret == NULL || pmeth == NULL) && e != NULL)
312 EVP_KEYMGMT_free(keymgmt);
315 if (propquery != NULL) {
316 ret->propquery = OPENSSL_strdup(propquery);
317 if (ret->propquery == NULL) {
319 EVP_KEYMGMT_free(keymgmt);
323 ret->libctx = libctx;
324 ret->keytype = keytype;
325 ret->keymgmt = keymgmt;
326 ret->legacy_keytype = id; /* TODO: Remove when #legacy key are gone */
329 ret->operation = EVP_PKEY_OP_UNDEFINED;
332 EVP_PKEY_up_ref(pkey);
334 if (pmeth != NULL && pmeth->init != NULL) {
335 if (pmeth->init(ret) <= 0) {
337 EVP_PKEY_CTX_free(ret);
345 /*- All methods below can also be used in FIPS_MODULE */
347 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_name(OSSL_LIB_CTX *libctx,
349 const char *propquery)
351 return int_ctx_new(libctx, NULL, NULL, name, propquery, -1);
354 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_pkey(OSSL_LIB_CTX *libctx, EVP_PKEY *pkey,
355 const char *propquery)
357 return int_ctx_new(libctx, pkey, NULL, NULL, propquery, -1);
360 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx)
362 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
363 if (ctx->op.sig.sigprovctx != NULL && ctx->op.sig.signature != NULL)
364 ctx->op.sig.signature->freectx(ctx->op.sig.sigprovctx);
365 EVP_SIGNATURE_free(ctx->op.sig.signature);
366 ctx->op.sig.sigprovctx = NULL;
367 ctx->op.sig.signature = NULL;
368 } else if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
369 if (ctx->op.kex.exchprovctx != NULL && ctx->op.kex.exchange != NULL)
370 ctx->op.kex.exchange->freectx(ctx->op.kex.exchprovctx);
371 EVP_KEYEXCH_free(ctx->op.kex.exchange);
372 ctx->op.kex.exchprovctx = NULL;
373 ctx->op.kex.exchange = NULL;
374 } else if (EVP_PKEY_CTX_IS_KEM_OP(ctx)) {
375 if (ctx->op.encap.kemprovctx != NULL && ctx->op.encap.kem != NULL)
376 ctx->op.encap.kem->freectx(ctx->op.encap.kemprovctx);
377 EVP_KEM_free(ctx->op.encap.kem);
378 ctx->op.encap.kemprovctx = NULL;
379 ctx->op.encap.kem = NULL;
381 else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
382 if (ctx->op.ciph.ciphprovctx != NULL && ctx->op.ciph.cipher != NULL)
383 ctx->op.ciph.cipher->freectx(ctx->op.ciph.ciphprovctx);
384 EVP_ASYM_CIPHER_free(ctx->op.ciph.cipher);
385 ctx->op.ciph.ciphprovctx = NULL;
386 ctx->op.ciph.cipher = NULL;
387 } else if (EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
388 if (ctx->op.keymgmt.genctx != NULL && ctx->keymgmt != NULL)
389 evp_keymgmt_gen_cleanup(ctx->keymgmt, ctx->op.keymgmt.genctx);
393 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
397 if (ctx->pmeth && ctx->pmeth->cleanup)
398 ctx->pmeth->cleanup(ctx);
400 evp_pkey_ctx_free_old_ops(ctx);
402 evp_pkey_ctx_free_all_cached_data(ctx);
404 EVP_KEYMGMT_free(ctx->keymgmt);
406 OPENSSL_free(ctx->propquery);
407 EVP_PKEY_free(ctx->pkey);
408 EVP_PKEY_free(ctx->peerkey);
409 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
410 ENGINE_finish(ctx->engine);
412 BN_free(ctx->rsa_pubexp);
418 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
419 const EVP_PKEY_METHOD *meth)
422 *ppkey_id = meth->pkey_id;
424 *pflags = meth->flags;
427 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
429 int pkey_id = dst->pkey_id;
430 int flags = dst->flags;
434 /* We only copy the function pointers so restore the other values */
435 dst->pkey_id = pkey_id;
439 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
441 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
445 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
447 return int_ctx_new(NULL, pkey, e, NULL, NULL, -1);
450 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
452 return int_ctx_new(NULL, NULL, e, NULL, NULL, id);
455 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *pctx)
459 # ifndef OPENSSL_NO_ENGINE
460 /* Make sure it's safe to copy a pkey context using an ENGINE */
461 if (pctx->engine && !ENGINE_init(pctx->engine)) {
462 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
466 rctx = OPENSSL_zalloc(sizeof(*rctx));
468 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
472 if (pctx->pkey != NULL)
473 EVP_PKEY_up_ref(pctx->pkey);
474 rctx->pkey = pctx->pkey;
475 rctx->operation = pctx->operation;
476 rctx->libctx = pctx->libctx;
477 rctx->keytype = pctx->keytype;
478 rctx->propquery = NULL;
479 if (pctx->propquery != NULL) {
480 rctx->propquery = OPENSSL_strdup(pctx->propquery);
481 if (rctx->propquery == NULL)
484 rctx->legacy_keytype = pctx->legacy_keytype;
486 if (EVP_PKEY_CTX_IS_DERIVE_OP(pctx)) {
487 if (pctx->op.kex.exchange != NULL) {
488 rctx->op.kex.exchange = pctx->op.kex.exchange;
489 if (!EVP_KEYEXCH_up_ref(rctx->op.kex.exchange))
492 if (pctx->op.kex.exchprovctx != NULL) {
493 if (!ossl_assert(pctx->op.kex.exchange != NULL))
495 rctx->op.kex.exchprovctx
496 = pctx->op.kex.exchange->dupctx(pctx->op.kex.exchprovctx);
497 if (rctx->op.kex.exchprovctx == NULL) {
498 EVP_KEYEXCH_free(rctx->op.kex.exchange);
503 } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)) {
504 if (pctx->op.sig.signature != NULL) {
505 rctx->op.sig.signature = pctx->op.sig.signature;
506 if (!EVP_SIGNATURE_up_ref(rctx->op.sig.signature))
509 if (pctx->op.sig.sigprovctx != NULL) {
510 if (!ossl_assert(pctx->op.sig.signature != NULL))
512 rctx->op.sig.sigprovctx
513 = pctx->op.sig.signature->dupctx(pctx->op.sig.sigprovctx);
514 if (rctx->op.sig.sigprovctx == NULL) {
515 EVP_SIGNATURE_free(rctx->op.sig.signature);
520 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(pctx)) {
521 if (pctx->op.ciph.cipher != NULL) {
522 rctx->op.ciph.cipher = pctx->op.ciph.cipher;
523 if (!EVP_ASYM_CIPHER_up_ref(rctx->op.ciph.cipher))
526 if (pctx->op.ciph.ciphprovctx != NULL) {
527 if (!ossl_assert(pctx->op.ciph.cipher != NULL))
529 rctx->op.ciph.ciphprovctx
530 = pctx->op.ciph.cipher->dupctx(pctx->op.ciph.ciphprovctx);
531 if (rctx->op.ciph.ciphprovctx == NULL) {
532 EVP_ASYM_CIPHER_free(rctx->op.ciph.cipher);
537 } else if (EVP_PKEY_CTX_IS_KEM_OP(pctx)) {
538 if (pctx->op.encap.kem != NULL) {
539 rctx->op.encap.kem = pctx->op.encap.kem;
540 if (!EVP_KEM_up_ref(rctx->op.encap.kem))
543 if (pctx->op.encap.kemprovctx != NULL) {
544 if (!ossl_assert(pctx->op.encap.kem != NULL))
546 rctx->op.encap.kemprovctx
547 = pctx->op.encap.kem->dupctx(pctx->op.encap.kemprovctx);
548 if (rctx->op.encap.kemprovctx == NULL) {
549 EVP_KEM_free(rctx->op.encap.kem);
554 } else if (EVP_PKEY_CTX_IS_GEN_OP(pctx)) {
555 /* Not supported - This would need a gen_dupctx() to work */
559 rctx->pmeth = pctx->pmeth;
560 # ifndef OPENSSL_NO_ENGINE
561 rctx->engine = pctx->engine;
564 if (pctx->peerkey != NULL)
565 EVP_PKEY_up_ref(pctx->peerkey);
566 rctx->peerkey = pctx->peerkey;
568 if (pctx->pmeth == NULL) {
569 if (rctx->operation == EVP_PKEY_OP_UNDEFINED) {
570 EVP_KEYMGMT *tmp_keymgmt = pctx->keymgmt;
573 provkey = evp_pkey_export_to_provider(pctx->pkey, pctx->libctx,
574 &tmp_keymgmt, pctx->propquery);
577 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt))
579 EVP_KEYMGMT_free(rctx->keymgmt);
580 rctx->keymgmt = tmp_keymgmt;
583 } else if (pctx->pmeth->copy(rctx, pctx) > 0) {
588 EVP_PKEY_CTX_free(rctx);
592 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
594 if (app_pkey_methods == NULL) {
595 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
596 if (app_pkey_methods == NULL){
597 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
601 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth)) {
602 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
605 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
609 void evp_app_cleanup_int(void)
611 if (app_pkey_methods != NULL)
612 sk_EVP_PKEY_METHOD_pop_free(app_pkey_methods, EVP_PKEY_meth_free);
615 int EVP_PKEY_meth_remove(const EVP_PKEY_METHOD *pmeth)
617 const EVP_PKEY_METHOD *ret;
619 ret = sk_EVP_PKEY_METHOD_delete_ptr(app_pkey_methods, pmeth);
621 return ret == NULL ? 0 : 1;
624 size_t EVP_PKEY_meth_get_count(void)
626 size_t rv = OSSL_NELEM(standard_methods);
628 if (app_pkey_methods)
629 rv += sk_EVP_PKEY_METHOD_num(app_pkey_methods);
633 const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx)
635 if (idx < OSSL_NELEM(standard_methods))
636 return (standard_methods[idx])();
637 if (app_pkey_methods == NULL)
639 idx -= OSSL_NELEM(standard_methods);
640 if (idx >= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods))
642 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
646 int EVP_PKEY_CTX_is_a(EVP_PKEY_CTX *ctx, const char *keytype)
649 if (evp_pkey_ctx_is_legacy(ctx))
650 return (ctx->pmeth->pkey_id == evp_pkey_name2type(keytype));
652 return EVP_KEYMGMT_is_a(ctx->keymgmt, keytype);
655 int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, const OSSL_PARAM *params)
657 switch (evp_pkey_ctx_state(ctx)) {
658 case EVP_PKEY_STATE_PROVIDER:
659 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
660 && ctx->op.kex.exchange != NULL
661 && ctx->op.kex.exchange->set_ctx_params != NULL)
663 ctx->op.kex.exchange->set_ctx_params(ctx->op.kex.exchprovctx,
665 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
666 && ctx->op.sig.signature != NULL
667 && ctx->op.sig.signature->set_ctx_params != NULL)
669 ctx->op.sig.signature->set_ctx_params(ctx->op.sig.sigprovctx,
671 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
672 && ctx->op.ciph.cipher != NULL
673 && ctx->op.ciph.cipher->set_ctx_params != NULL)
675 ctx->op.ciph.cipher->set_ctx_params(ctx->op.ciph.ciphprovctx,
677 if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
678 && ctx->keymgmt != NULL
679 && ctx->keymgmt->gen_set_params != NULL)
681 evp_keymgmt_gen_set_params(ctx->keymgmt, ctx->op.keymgmt.genctx,
683 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
684 && ctx->op.encap.kem != NULL
685 && ctx->op.encap.kem->set_ctx_params != NULL)
687 ctx->op.encap.kem->set_ctx_params(ctx->op.encap.kemprovctx,
691 case EVP_PKEY_STATE_UNKNOWN:
692 case EVP_PKEY_STATE_LEGACY:
693 return evp_pkey_ctx_set_params_to_ctrl(ctx, params);
699 int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
701 switch (evp_pkey_ctx_state(ctx)) {
702 case EVP_PKEY_STATE_PROVIDER:
703 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
704 && ctx->op.kex.exchange != NULL
705 && ctx->op.kex.exchange->get_ctx_params != NULL)
707 ctx->op.kex.exchange->get_ctx_params(ctx->op.kex.exchprovctx,
709 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
710 && ctx->op.sig.signature != NULL
711 && ctx->op.sig.signature->get_ctx_params != NULL)
713 ctx->op.sig.signature->get_ctx_params(ctx->op.sig.sigprovctx,
715 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
716 && ctx->op.ciph.cipher != NULL
717 && ctx->op.ciph.cipher->get_ctx_params != NULL)
719 ctx->op.ciph.cipher->get_ctx_params(ctx->op.ciph.ciphprovctx,
721 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
722 && ctx->op.encap.kem != NULL
723 && ctx->op.encap.kem->get_ctx_params != NULL)
725 ctx->op.encap.kem->get_ctx_params(ctx->op.encap.kemprovctx,
729 case EVP_PKEY_STATE_UNKNOWN:
730 case EVP_PKEY_STATE_LEGACY:
731 return evp_pkey_ctx_get_params_to_ctrl(ctx, params);
738 const OSSL_PARAM *EVP_PKEY_CTX_gettable_params(const EVP_PKEY_CTX *ctx)
742 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
743 && ctx->op.kex.exchange != NULL
744 && ctx->op.kex.exchange->gettable_ctx_params != NULL) {
745 provctx = ossl_provider_ctx(EVP_KEYEXCH_provider(ctx->op.kex.exchange));
746 return ctx->op.kex.exchange->gettable_ctx_params(ctx->op.kex.exchprovctx,
749 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
750 && ctx->op.sig.signature != NULL
751 && ctx->op.sig.signature->gettable_ctx_params != NULL) {
752 provctx = ossl_provider_ctx(
753 EVP_SIGNATURE_provider(ctx->op.sig.signature));
754 return ctx->op.sig.signature->gettable_ctx_params(ctx->op.sig.sigprovctx,
757 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
758 && ctx->op.ciph.cipher != NULL
759 && ctx->op.ciph.cipher->gettable_ctx_params != NULL) {
760 provctx = ossl_provider_ctx(
761 EVP_ASYM_CIPHER_provider(ctx->op.ciph.cipher));
762 return ctx->op.ciph.cipher->gettable_ctx_params(ctx->op.ciph.ciphprovctx,
765 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
766 && ctx->op.encap.kem != NULL
767 && ctx->op.encap.kem->gettable_ctx_params != NULL) {
768 provctx = ossl_provider_ctx(EVP_KEM_provider(ctx->op.encap.kem));
769 return ctx->op.encap.kem->gettable_ctx_params(ctx->op.encap.kemprovctx,
775 const OSSL_PARAM *EVP_PKEY_CTX_settable_params(const EVP_PKEY_CTX *ctx)
779 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
780 && ctx->op.kex.exchange != NULL
781 && ctx->op.kex.exchange->settable_ctx_params != NULL) {
782 provctx = ossl_provider_ctx(EVP_KEYEXCH_provider(ctx->op.kex.exchange));
783 return ctx->op.kex.exchange->settable_ctx_params(ctx->op.kex.exchprovctx,
786 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
787 && ctx->op.sig.signature != NULL
788 && ctx->op.sig.signature->settable_ctx_params != NULL) {
789 provctx = ossl_provider_ctx(
790 EVP_SIGNATURE_provider(ctx->op.sig.signature));
791 return ctx->op.sig.signature->settable_ctx_params(ctx->op.sig.sigprovctx,
794 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
795 && ctx->op.ciph.cipher != NULL
796 && ctx->op.ciph.cipher->settable_ctx_params != NULL) {
797 provctx = ossl_provider_ctx(
798 EVP_ASYM_CIPHER_provider(ctx->op.ciph.cipher));
799 return ctx->op.ciph.cipher->settable_ctx_params(ctx->op.ciph.ciphprovctx,
802 if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
803 && ctx->keymgmt != NULL
804 && ctx->keymgmt->gen_settable_params != NULL) {
805 provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(ctx->keymgmt));
806 return ctx->keymgmt->gen_settable_params(ctx->op.keymgmt.genctx,
809 if (EVP_PKEY_CTX_IS_KEM_OP(ctx)
810 && ctx->op.encap.kem != NULL
811 && ctx->op.encap.kem->settable_ctx_params != NULL) {
812 provctx = ossl_provider_ctx(EVP_KEM_provider(ctx->op.encap.kem));
813 return ctx->op.encap.kem->settable_ctx_params(ctx->op.encap.kemprovctx,
820 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
822 * Return 1 on success, 0 or negative for errors.
824 * In particular they return -2 if any of the params is not supported.
826 * They are not available in FIPS_MODULE as they depend on
827 * - EVP_PKEY_CTX_{get,set}_params()
828 * - EVP_PKEY_CTX_{gettable,settable}_params()
831 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
833 if (ctx == NULL || params == NULL)
837 * We only check for provider side EVP_PKEY_CTX. For #legacy, we
838 * depend on the translation that happens in EVP_PKEY_CTX_set_params()
839 * call, and that the resulting ctrl call will return -2 if it doesn't
840 * known the ctrl command number.
842 if (evp_pkey_ctx_is_provided(ctx)) {
843 const OSSL_PARAM *settable = EVP_PKEY_CTX_settable_params(ctx);
846 for (p = params; p->key != NULL; p++) {
847 /* Check the ctx actually understands this parameter */
848 if (OSSL_PARAM_locate_const(settable, p->key) == NULL )
853 return EVP_PKEY_CTX_set_params(ctx, params);
856 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
858 if (ctx == NULL || params == NULL)
862 * We only check for provider side EVP_PKEY_CTX. For #legacy, we
863 * depend on the translation that happens in EVP_PKEY_CTX_get_params()
864 * call, and that the resulting ctrl call will return -2 if it doesn't
865 * known the ctrl command number.
867 if (evp_pkey_ctx_is_provided(ctx)) {
868 const OSSL_PARAM *gettable = EVP_PKEY_CTX_gettable_params(ctx);
871 for (p = params; p->key != NULL; p++ ) {
872 /* Check the ctx actually understands this parameter */
873 if (OSSL_PARAM_locate_const(gettable, p->key) == NULL )
878 return EVP_PKEY_CTX_get_params(ctx, params);
881 int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
883 OSSL_PARAM sig_md_params[2], *p = sig_md_params;
884 /* 80 should be big enough */
888 if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
889 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
890 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
894 if (ctx->op.sig.sigprovctx == NULL)
895 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
896 EVP_PKEY_CTRL_GET_MD, 0, (void *)(md));
898 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
901 *p = OSSL_PARAM_construct_end();
903 if (!EVP_PKEY_CTX_get_params(ctx, sig_md_params))
906 tmp = evp_get_digestbyname_ex(ctx->libctx, name);
915 static int evp_pkey_ctx_set_md(EVP_PKEY_CTX *ctx, const EVP_MD *md,
916 int fallback, const char *param, int op,
919 OSSL_PARAM md_params[2], *p = md_params;
922 if (ctx == NULL || (ctx->operation & op) == 0) {
923 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
924 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
929 return EVP_PKEY_CTX_ctrl(ctx, -1, op, ctrl, 0, (void *)(md));
934 name = EVP_MD_name(md);
937 *p++ = OSSL_PARAM_construct_utf8_string(param,
939 * Cast away the const. This is read
940 * only so should be safe
943 *p = OSSL_PARAM_construct_end();
945 return EVP_PKEY_CTX_set_params(ctx, md_params);
948 int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
950 return evp_pkey_ctx_set_md(ctx, md, ctx->op.sig.sigprovctx == NULL,
951 OSSL_SIGNATURE_PARAM_DIGEST,
952 EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD);
955 int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
957 return evp_pkey_ctx_set_md(ctx, md, ctx->op.kex.exchprovctx == NULL,
958 OSSL_KDF_PARAM_DIGEST,
959 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_TLS_MD);
962 static int evp_pkey_ctx_set1_octet_string(EVP_PKEY_CTX *ctx, int fallback,
963 const char *param, int op, int ctrl,
964 const unsigned char *data,
967 OSSL_PARAM octet_string_params[2], *p = octet_string_params;
969 if (ctx == NULL || (ctx->operation & op) == 0) {
970 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
971 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
975 /* Code below to be removed when legacy support is dropped. */
977 return EVP_PKEY_CTX_ctrl(ctx, -1, op, ctrl, datalen, (void *)(data));
978 /* end of legacy support */
981 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_LENGTH);
985 *p++ = OSSL_PARAM_construct_octet_string(param,
987 * Cast away the const. This is read
988 * only so should be safe
990 (unsigned char *)data,
992 *p = OSSL_PARAM_construct_end();
994 return EVP_PKEY_CTX_set_params(ctx, octet_string_params);
997 int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX *ctx,
998 const unsigned char *sec, int seclen)
1000 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1001 OSSL_KDF_PARAM_SECRET,
1003 EVP_PKEY_CTRL_TLS_SECRET,
1007 int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX *ctx,
1008 const unsigned char *seed, int seedlen)
1010 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1011 OSSL_KDF_PARAM_SEED,
1013 EVP_PKEY_CTRL_TLS_SEED,
1017 int EVP_PKEY_CTX_set_hkdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
1019 return evp_pkey_ctx_set_md(ctx, md, ctx->op.kex.exchprovctx == NULL,
1020 OSSL_KDF_PARAM_DIGEST,
1021 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_HKDF_MD);
1024 int EVP_PKEY_CTX_set1_hkdf_salt(EVP_PKEY_CTX *ctx,
1025 const unsigned char *salt, int saltlen)
1027 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1028 OSSL_KDF_PARAM_SALT,
1030 EVP_PKEY_CTRL_HKDF_SALT,
1034 int EVP_PKEY_CTX_set1_hkdf_key(EVP_PKEY_CTX *ctx,
1035 const unsigned char *key, int keylen)
1037 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1040 EVP_PKEY_CTRL_HKDF_KEY,
1044 int EVP_PKEY_CTX_add1_hkdf_info(EVP_PKEY_CTX *ctx,
1045 const unsigned char *info, int infolen)
1047 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1048 OSSL_KDF_PARAM_INFO,
1050 EVP_PKEY_CTRL_HKDF_INFO,
1054 int EVP_PKEY_CTX_hkdf_mode(EVP_PKEY_CTX *ctx, int mode)
1056 OSSL_PARAM int_params[2], *p = int_params;
1058 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
1059 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1060 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1064 /* Code below to be removed when legacy support is dropped. */
1065 if (ctx->op.kex.exchprovctx == NULL)
1066 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_DERIVE,
1067 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL);
1068 /* end of legacy support */
1071 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1075 *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
1076 *p = OSSL_PARAM_construct_end();
1078 return EVP_PKEY_CTX_set_params(ctx, int_params);
1081 int EVP_PKEY_CTX_set1_pbe_pass(EVP_PKEY_CTX *ctx, const char *pass,
1084 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1085 OSSL_KDF_PARAM_PASSWORD,
1088 (const unsigned char *)pass, passlen);
1091 int EVP_PKEY_CTX_set1_scrypt_salt(EVP_PKEY_CTX *ctx,
1092 const unsigned char *salt, int saltlen)
1094 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
1095 OSSL_KDF_PARAM_SALT,
1097 EVP_PKEY_CTRL_SCRYPT_SALT,
1101 static int evp_pkey_ctx_set_uint64(EVP_PKEY_CTX *ctx, const char *param,
1102 int op, int ctrl, uint64_t val)
1104 OSSL_PARAM uint64_params[2], *p = uint64_params;
1106 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
1107 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1108 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1112 /* Code below to be removed when legacy support is dropped. */
1113 if (ctx->op.kex.exchprovctx == NULL)
1114 return EVP_PKEY_CTX_ctrl_uint64(ctx, -1, op, ctrl, val);
1115 /* end of legacy support */
1117 *p++ = OSSL_PARAM_construct_uint64(param, &val);
1118 *p = OSSL_PARAM_construct_end();
1120 return EVP_PKEY_CTX_set_params(ctx, uint64_params);
1123 int EVP_PKEY_CTX_set_scrypt_N(EVP_PKEY_CTX *ctx, uint64_t n)
1125 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_N,
1126 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_SCRYPT_N,
1130 int EVP_PKEY_CTX_set_scrypt_r(EVP_PKEY_CTX *ctx, uint64_t r)
1132 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_R,
1133 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_SCRYPT_R,
1137 int EVP_PKEY_CTX_set_scrypt_p(EVP_PKEY_CTX *ctx, uint64_t p)
1139 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_P,
1140 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_SCRYPT_P,
1144 int EVP_PKEY_CTX_set_scrypt_maxmem_bytes(EVP_PKEY_CTX *ctx,
1145 uint64_t maxmem_bytes)
1147 return evp_pkey_ctx_set_uint64(ctx, OSSL_KDF_PARAM_SCRYPT_MAXMEM,
1149 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES,
1153 int EVP_PKEY_CTX_set_mac_key(EVP_PKEY_CTX *ctx, const unsigned char *key,
1156 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.keymgmt.genctx == NULL,
1157 OSSL_PKEY_PARAM_PRIV_KEY,
1159 EVP_PKEY_CTRL_SET_MAC_KEY,
1163 int EVP_PKEY_CTX_set_kem_op(EVP_PKEY_CTX *ctx, const char *op)
1165 OSSL_PARAM params[2], *p = params;
1167 if (ctx == NULL || op == NULL) {
1168 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
1171 if (!EVP_PKEY_CTX_IS_KEM_OP(ctx)) {
1172 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1175 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KEM_PARAM_OPERATION,
1177 *p = OSSL_PARAM_construct_end();
1178 return EVP_PKEY_CTX_set_params(ctx, params);
1181 int evp_pkey_ctx_set1_id_prov(EVP_PKEY_CTX *ctx, const void *id, int len)
1183 OSSL_PARAM params[2], *p = params;
1186 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
1187 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1188 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1192 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_DIST_ID,
1194 * Cast away the const. This is
1195 * read only so should be safe
1197 (void *)id, (size_t)len);
1198 *p++ = OSSL_PARAM_construct_end();
1200 ret = evp_pkey_ctx_set_params_strict(ctx, params);
1202 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1206 int EVP_PKEY_CTX_set1_id(EVP_PKEY_CTX *ctx, const void *id, int len)
1208 return EVP_PKEY_CTX_ctrl(ctx, -1, -1,
1209 EVP_PKEY_CTRL_SET1_ID, (int)len, (void*)(id));
1212 static int get1_id_data(EVP_PKEY_CTX *ctx, void *id, size_t *id_len)
1215 void *tmp_id = NULL;
1216 OSSL_PARAM params[2], *p = params;
1218 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
1219 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1220 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1224 *p++ = OSSL_PARAM_construct_octet_ptr(OSSL_PKEY_PARAM_DIST_ID,
1226 *p++ = OSSL_PARAM_construct_end();
1228 ret = evp_pkey_ctx_get_params_strict(ctx, params);
1230 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1231 } else if (ret > 0) {
1232 size_t tmp_id_len = params[0].return_size;
1235 memcpy(id, tmp_id, tmp_id_len);
1237 *id_len = tmp_id_len;
1242 int evp_pkey_ctx_get1_id_prov(EVP_PKEY_CTX *ctx, void *id)
1244 return get1_id_data(ctx, id, NULL);
1247 int evp_pkey_ctx_get1_id_len_prov(EVP_PKEY_CTX *ctx, size_t *id_len)
1249 return get1_id_data(ctx, NULL, id_len);
1252 int EVP_PKEY_CTX_get1_id(EVP_PKEY_CTX *ctx, void *id)
1254 return EVP_PKEY_CTX_ctrl(ctx, -1, -1, EVP_PKEY_CTRL_GET1_ID, 0, (void*)id);
1257 int EVP_PKEY_CTX_get1_id_len(EVP_PKEY_CTX *ctx, size_t *id_len)
1259 return EVP_PKEY_CTX_ctrl(ctx, -1, -1,
1260 EVP_PKEY_CTRL_GET1_ID_LEN, 0, (void*)id_len);
1263 static int evp_pkey_ctx_ctrl_int(EVP_PKEY_CTX *ctx, int keytype, int optype,
1264 int cmd, int p1, void *p2)
1269 * If the method has a |digest_custom| function, we can relax the
1270 * operation type check, since this can be called before the operation
1273 if (ctx->pmeth == NULL || ctx->pmeth->digest_custom == NULL) {
1274 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
1275 ERR_raise(ERR_LIB_EVP, EVP_R_NO_OPERATION_SET);
1279 if ((optype != -1) && !(ctx->operation & optype)) {
1280 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1285 switch (evp_pkey_ctx_state(ctx)) {
1286 case EVP_PKEY_STATE_PROVIDER:
1287 return evp_pkey_ctx_ctrl_to_param(ctx, keytype, optype, cmd, p1, p2);
1288 case EVP_PKEY_STATE_UNKNOWN:
1289 case EVP_PKEY_STATE_LEGACY:
1290 if (ctx->pmeth == NULL || ctx->pmeth->ctrl == NULL) {
1291 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1294 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
1297 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
1300 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1306 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
1307 int cmd, int p1, void *p2)
1312 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1315 /* If unsupported, we don't want that reported here */
1317 ret = evp_pkey_ctx_store_cached_data(ctx, keytype, optype,
1322 ERR_clear_last_mark();
1324 * If there was an error, there was an error.
1325 * If the operation isn't initialized yet, we also return, as
1326 * the saved values will be used then anyway.
1328 if (ret < 1 || ctx->operation == EVP_PKEY_OP_UNDEFINED)
1331 return evp_pkey_ctx_ctrl_int(ctx, keytype, optype, cmd, p1, p2);
1334 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
1335 int cmd, uint64_t value)
1337 return EVP_PKEY_CTX_ctrl(ctx, keytype, optype, cmd, 0, &value);
1341 static int evp_pkey_ctx_ctrl_str_int(EVP_PKEY_CTX *ctx,
1342 const char *name, const char *value)
1347 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1351 switch (evp_pkey_ctx_state(ctx)) {
1352 case EVP_PKEY_STATE_PROVIDER:
1353 return evp_pkey_ctx_ctrl_str_to_param(ctx, name, value);
1354 case EVP_PKEY_STATE_UNKNOWN:
1355 case EVP_PKEY_STATE_LEGACY:
1356 if (ctx == NULL || ctx->pmeth == NULL || ctx->pmeth->ctrl_str == NULL) {
1357 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1360 if (strcmp(name, "digest") == 0)
1361 ret = EVP_PKEY_CTX_md(ctx,
1362 EVP_PKEY_OP_TYPE_SIG | EVP_PKEY_OP_TYPE_CRYPT,
1363 EVP_PKEY_CTRL_MD, value);
1365 ret = ctx->pmeth->ctrl_str(ctx, name, value);
1372 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
1373 const char *name, const char *value)
1377 /* If unsupported, we don't want that reported here */
1379 ret = evp_pkey_ctx_store_cached_data(ctx, -1, -1, -1,
1380 name, value, strlen(value) + 1);
1384 ERR_clear_last_mark();
1386 * If there was an error, there was an error.
1387 * If the operation isn't initialized yet, we also return, as
1388 * the saved values will be used then anyway.
1390 if (ret < 1 || ctx->operation == EVP_PKEY_OP_UNDEFINED)
1394 return evp_pkey_ctx_ctrl_str_int(ctx, name, value);
1397 static int decode_cmd(int cmd, const char *name)
1401 * The consequence of the assertion not being true is that this
1402 * function will return -1, which will cause the calling functions
1403 * to signal that the command is unsupported... in non-debug mode.
1405 if (ossl_assert(name != NULL))
1406 if (strcmp(name, "distid") == 0 || strcmp(name, "hexdistid") == 0)
1407 cmd = EVP_PKEY_CTRL_SET1_ID;
1413 static int evp_pkey_ctx_store_cached_data(EVP_PKEY_CTX *ctx,
1414 int keytype, int optype,
1415 int cmd, const char *name,
1416 const void *data, size_t data_len)
1419 * Check that it's one of the supported commands. The ctrl commands
1420 * number cases here must correspond to the cases in the bottom switch
1423 switch (cmd = decode_cmd(cmd, name)) {
1424 case EVP_PKEY_CTRL_SET1_ID:
1427 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1431 if (keytype != -1) {
1432 switch (evp_pkey_ctx_state(ctx)) {
1433 case EVP_PKEY_STATE_PROVIDER:
1434 if (ctx->keymgmt == NULL) {
1435 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1438 if (!EVP_KEYMGMT_is_a(ctx->keymgmt,
1439 evp_pkey_type2name(keytype))) {
1440 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1444 case EVP_PKEY_STATE_UNKNOWN:
1445 case EVP_PKEY_STATE_LEGACY:
1446 if (ctx->pmeth == NULL) {
1447 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1450 if (EVP_PKEY_type(ctx->pmeth->pkey_id) != EVP_PKEY_type(keytype)) {
1451 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1457 if (optype != -1 && (ctx->operation & optype) == 0) {
1458 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
1463 case EVP_PKEY_CTRL_SET1_ID:
1464 evp_pkey_ctx_free_cached_data(ctx, cmd, name);
1466 ctx->cached_parameters.dist_id_name = OPENSSL_strdup(name);
1467 if (ctx->cached_parameters.dist_id_name == NULL) {
1468 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1473 ctx->cached_parameters.dist_id = OPENSSL_memdup(data, data_len);
1474 if (ctx->cached_parameters.dist_id == NULL) {
1475 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1479 ctx->cached_parameters.dist_id_set = 1;
1480 ctx->cached_parameters.dist_id_len = data_len;
1486 static void evp_pkey_ctx_free_cached_data(EVP_PKEY_CTX *ctx,
1487 int cmd, const char *name)
1489 cmd = decode_cmd(cmd, name);
1491 case EVP_PKEY_CTRL_SET1_ID:
1492 OPENSSL_free(ctx->cached_parameters.dist_id);
1493 OPENSSL_free(ctx->cached_parameters.dist_id_name);
1494 ctx->cached_parameters.dist_id = NULL;
1495 ctx->cached_parameters.dist_id_name = NULL;
1500 static void evp_pkey_ctx_free_all_cached_data(EVP_PKEY_CTX *ctx)
1502 evp_pkey_ctx_free_cached_data(ctx, EVP_PKEY_CTRL_SET1_ID, NULL);
1505 int evp_pkey_ctx_use_cached_data(EVP_PKEY_CTX *ctx)
1509 if (ret && ctx->cached_parameters.dist_id_set) {
1510 const char *name = ctx->cached_parameters.dist_id_name;
1511 const void *val = ctx->cached_parameters.dist_id;
1512 size_t len = ctx->cached_parameters.dist_id_len;
1515 ret = evp_pkey_ctx_ctrl_str_int(ctx, name, val);
1517 ret = evp_pkey_ctx_ctrl_int(ctx, -1, ctx->operation,
1518 EVP_PKEY_CTRL_SET1_ID,
1519 (int)len, (void *)val);
1525 OSSL_LIB_CTX *EVP_PKEY_CTX_get0_libctx(EVP_PKEY_CTX *ctx)
1530 const char *EVP_PKEY_CTX_get0_propq(EVP_PKEY_CTX *ctx)
1532 return ctx->propquery;
1535 /* Utility functions to send a string of hex string to a ctrl */
1537 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
1544 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
1547 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
1553 bin = OPENSSL_hexstr2buf(hex, &binlen);
1556 if (binlen <= INT_MAX)
1557 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
1562 /* Pass a message digest to a ctrl */
1563 int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md)
1567 if (md == NULL || (m = EVP_get_digestbyname(md)) == NULL) {
1568 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_DIGEST);
1571 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)m);
1574 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
1576 return ctx->operation;
1579 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
1581 ctx->keygen_info = dat;
1582 ctx->keygen_info_count = datlen;
1585 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
1590 void *EVP_PKEY_CTX_get_data(const EVP_PKEY_CTX *ctx)
1595 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
1600 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
1602 return ctx->peerkey;
1605 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
1607 ctx->app_data = data;
1610 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
1612 return ctx->app_data;
1615 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
1616 int (*init) (EVP_PKEY_CTX *ctx))
1621 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
1622 int (*copy) (EVP_PKEY_CTX *dst,
1623 const EVP_PKEY_CTX *src))
1628 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
1629 void (*cleanup) (EVP_PKEY_CTX *ctx))
1631 pmeth->cleanup = cleanup;
1634 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
1635 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
1636 int (*paramgen) (EVP_PKEY_CTX *ctx,
1639 pmeth->paramgen_init = paramgen_init;
1640 pmeth->paramgen = paramgen;
1643 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
1644 int (*keygen_init) (EVP_PKEY_CTX *ctx),
1645 int (*keygen) (EVP_PKEY_CTX *ctx,
1648 pmeth->keygen_init = keygen_init;
1649 pmeth->keygen = keygen;
1652 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
1653 int (*sign_init) (EVP_PKEY_CTX *ctx),
1654 int (*sign) (EVP_PKEY_CTX *ctx,
1655 unsigned char *sig, size_t *siglen,
1656 const unsigned char *tbs,
1659 pmeth->sign_init = sign_init;
1663 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
1664 int (*verify_init) (EVP_PKEY_CTX *ctx),
1665 int (*verify) (EVP_PKEY_CTX *ctx,
1666 const unsigned char *sig,
1668 const unsigned char *tbs,
1671 pmeth->verify_init = verify_init;
1672 pmeth->verify = verify;
1675 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
1676 int (*verify_recover_init) (EVP_PKEY_CTX
1678 int (*verify_recover) (EVP_PKEY_CTX
1687 pmeth->verify_recover_init = verify_recover_init;
1688 pmeth->verify_recover = verify_recover;
1691 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
1692 int (*signctx_init) (EVP_PKEY_CTX *ctx,
1694 int (*signctx) (EVP_PKEY_CTX *ctx,
1699 pmeth->signctx_init = signctx_init;
1700 pmeth->signctx = signctx;
1703 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
1704 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
1706 int (*verifyctx) (EVP_PKEY_CTX *ctx,
1707 const unsigned char *sig,
1711 pmeth->verifyctx_init = verifyctx_init;
1712 pmeth->verifyctx = verifyctx;
1715 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
1716 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
1717 int (*encryptfn) (EVP_PKEY_CTX *ctx,
1720 const unsigned char *in,
1723 pmeth->encrypt_init = encrypt_init;
1724 pmeth->encrypt = encryptfn;
1727 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
1728 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
1729 int (*decrypt) (EVP_PKEY_CTX *ctx,
1732 const unsigned char *in,
1735 pmeth->decrypt_init = decrypt_init;
1736 pmeth->decrypt = decrypt;
1739 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
1740 int (*derive_init) (EVP_PKEY_CTX *ctx),
1741 int (*derive) (EVP_PKEY_CTX *ctx,
1745 pmeth->derive_init = derive_init;
1746 pmeth->derive = derive;
1749 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
1750 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1752 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
1757 pmeth->ctrl_str = ctrl_str;
1760 void EVP_PKEY_meth_set_digestsign(EVP_PKEY_METHOD *pmeth,
1761 int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1762 const unsigned char *tbs, size_t tbslen))
1764 pmeth->digestsign = digestsign;
1767 void EVP_PKEY_meth_set_digestverify(EVP_PKEY_METHOD *pmeth,
1768 int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1769 size_t siglen, const unsigned char *tbs,
1772 pmeth->digestverify = digestverify;
1775 void EVP_PKEY_meth_set_check(EVP_PKEY_METHOD *pmeth,
1776 int (*check) (EVP_PKEY *pkey))
1778 pmeth->check = check;
1781 void EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD *pmeth,
1782 int (*check) (EVP_PKEY *pkey))
1784 pmeth->public_check = check;
1787 void EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD *pmeth,
1788 int (*check) (EVP_PKEY *pkey))
1790 pmeth->param_check = check;
1793 void EVP_PKEY_meth_set_digest_custom(EVP_PKEY_METHOD *pmeth,
1794 int (*digest_custom) (EVP_PKEY_CTX *ctx,
1797 pmeth->digest_custom = digest_custom;
1800 void EVP_PKEY_meth_get_init(const EVP_PKEY_METHOD *pmeth,
1801 int (**pinit) (EVP_PKEY_CTX *ctx))
1803 *pinit = pmeth->init;
1806 void EVP_PKEY_meth_get_copy(const EVP_PKEY_METHOD *pmeth,
1807 int (**pcopy) (EVP_PKEY_CTX *dst,
1808 const EVP_PKEY_CTX *src))
1810 *pcopy = pmeth->copy;
1813 void EVP_PKEY_meth_get_cleanup(const EVP_PKEY_METHOD *pmeth,
1814 void (**pcleanup) (EVP_PKEY_CTX *ctx))
1816 *pcleanup = pmeth->cleanup;
1819 void EVP_PKEY_meth_get_paramgen(const EVP_PKEY_METHOD *pmeth,
1820 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
1821 int (**pparamgen) (EVP_PKEY_CTX *ctx,
1825 *pparamgen_init = pmeth->paramgen_init;
1827 *pparamgen = pmeth->paramgen;
1830 void EVP_PKEY_meth_get_keygen(const EVP_PKEY_METHOD *pmeth,
1831 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
1832 int (**pkeygen) (EVP_PKEY_CTX *ctx,
1836 *pkeygen_init = pmeth->keygen_init;
1838 *pkeygen = pmeth->keygen;
1841 void EVP_PKEY_meth_get_sign(const EVP_PKEY_METHOD *pmeth,
1842 int (**psign_init) (EVP_PKEY_CTX *ctx),
1843 int (**psign) (EVP_PKEY_CTX *ctx,
1844 unsigned char *sig, size_t *siglen,
1845 const unsigned char *tbs,
1849 *psign_init = pmeth->sign_init;
1851 *psign = pmeth->sign;
1854 void EVP_PKEY_meth_get_verify(const EVP_PKEY_METHOD *pmeth,
1855 int (**pverify_init) (EVP_PKEY_CTX *ctx),
1856 int (**pverify) (EVP_PKEY_CTX *ctx,
1857 const unsigned char *sig,
1859 const unsigned char *tbs,
1863 *pverify_init = pmeth->verify_init;
1865 *pverify = pmeth->verify;
1868 void EVP_PKEY_meth_get_verify_recover(const EVP_PKEY_METHOD *pmeth,
1869 int (**pverify_recover_init) (EVP_PKEY_CTX
1871 int (**pverify_recover) (EVP_PKEY_CTX
1880 if (pverify_recover_init)
1881 *pverify_recover_init = pmeth->verify_recover_init;
1882 if (pverify_recover)
1883 *pverify_recover = pmeth->verify_recover;
1886 void EVP_PKEY_meth_get_signctx(const EVP_PKEY_METHOD *pmeth,
1887 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
1889 int (**psignctx) (EVP_PKEY_CTX *ctx,
1895 *psignctx_init = pmeth->signctx_init;
1897 *psignctx = pmeth->signctx;
1900 void EVP_PKEY_meth_get_verifyctx(const EVP_PKEY_METHOD *pmeth,
1901 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
1903 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
1904 const unsigned char *sig,
1908 if (pverifyctx_init)
1909 *pverifyctx_init = pmeth->verifyctx_init;
1911 *pverifyctx = pmeth->verifyctx;
1914 void EVP_PKEY_meth_get_encrypt(const EVP_PKEY_METHOD *pmeth,
1915 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
1916 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
1919 const unsigned char *in,
1923 *pencrypt_init = pmeth->encrypt_init;
1925 *pencryptfn = pmeth->encrypt;
1928 void EVP_PKEY_meth_get_decrypt(const EVP_PKEY_METHOD *pmeth,
1929 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
1930 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
1933 const unsigned char *in,
1937 *pdecrypt_init = pmeth->decrypt_init;
1939 *pdecrypt = pmeth->decrypt;
1942 void EVP_PKEY_meth_get_derive(const EVP_PKEY_METHOD *pmeth,
1943 int (**pderive_init) (EVP_PKEY_CTX *ctx),
1944 int (**pderive) (EVP_PKEY_CTX *ctx,
1949 *pderive_init = pmeth->derive_init;
1951 *pderive = pmeth->derive;
1954 void EVP_PKEY_meth_get_ctrl(const EVP_PKEY_METHOD *pmeth,
1955 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1957 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
1962 *pctrl = pmeth->ctrl;
1964 *pctrl_str = pmeth->ctrl_str;
1967 void EVP_PKEY_meth_get_digestsign(EVP_PKEY_METHOD *pmeth,
1968 int (**digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1969 const unsigned char *tbs, size_t tbslen))
1972 *digestsign = pmeth->digestsign;
1975 void EVP_PKEY_meth_get_digestverify(EVP_PKEY_METHOD *pmeth,
1976 int (**digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1977 size_t siglen, const unsigned char *tbs,
1981 *digestverify = pmeth->digestverify;
1984 void EVP_PKEY_meth_get_check(const EVP_PKEY_METHOD *pmeth,
1985 int (**pcheck) (EVP_PKEY *pkey))
1988 *pcheck = pmeth->check;
1991 void EVP_PKEY_meth_get_public_check(const EVP_PKEY_METHOD *pmeth,
1992 int (**pcheck) (EVP_PKEY *pkey))
1995 *pcheck = pmeth->public_check;
1998 void EVP_PKEY_meth_get_param_check(const EVP_PKEY_METHOD *pmeth,
1999 int (**pcheck) (EVP_PKEY *pkey))
2002 *pcheck = pmeth->param_check;
2005 void EVP_PKEY_meth_get_digest_custom(EVP_PKEY_METHOD *pmeth,
2006 int (**pdigest_custom) (EVP_PKEY_CTX *ctx,
2009 if (pdigest_custom != NULL)
2010 *pdigest_custom = pmeth->digest_custom;
2013 #endif /* FIPS_MODULE */