2 * Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * 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 "internal/ffc.h"
30 #include "internal/numbers.h"
31 #include "internal/provider.h"
32 #include "evp_local.h"
36 typedef const EVP_PKEY_METHOD *(*pmeth_fn)(void);
37 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
39 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
41 /* This array needs to be in order of NIDs */
42 static pmeth_fn standard_methods[] = {
43 # ifndef OPENSSL_NO_RSA
46 # ifndef OPENSSL_NO_DH
49 # ifndef OPENSSL_NO_DSA
52 # ifndef OPENSSL_NO_EC
56 # ifndef OPENSSL_NO_CMAC
59 # ifndef OPENSSL_NO_RSA
62 # ifndef OPENSSL_NO_DH
65 # ifndef OPENSSL_NO_SCRYPT
69 # ifndef OPENSSL_NO_EC
74 # ifndef OPENSSL_NO_POLY1305
77 # ifndef OPENSSL_NO_SIPHASH
80 # ifndef OPENSSL_NO_EC
84 # ifndef OPENSSL_NO_SM2
89 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
91 static int pmeth_func_cmp(const EVP_PKEY_METHOD *const *a, pmeth_fn const *b)
93 return ((*a)->pkey_id - ((**b)())->pkey_id);
96 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
98 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
99 const EVP_PKEY_METHOD *const *b)
101 return ((*a)->pkey_id - (*b)->pkey_id);
104 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
108 const EVP_PKEY_METHOD *t = &tmp;
111 if (app_pkey_methods) {
113 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
115 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
117 ret = OBJ_bsearch_pmeth_func(&t, standard_methods,
118 sizeof(standard_methods) /
120 if (ret == NULL || *ret == NULL)
125 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
127 EVP_PKEY_METHOD *pmeth;
129 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
131 EVPerr(EVP_F_EVP_PKEY_METH_NEW, ERR_R_MALLOC_FAILURE);
136 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
139 #endif /* FIPS_MODULE */
141 static int is_legacy_alg(int id, const char *keytype)
144 /* Certain EVP_PKEY keytypes are only available in legacy form */
146 id = OBJ_sn2nid(keytype);
148 id = OBJ_ln2nid(keytype);
154 * TODO(3.0): Remove SM2 and DHX when they are converted to have provider
159 case EVP_PKEY_SCRYPT:
162 case EVP_PKEY_SIPHASH:
163 case EVP_PKEY_POLY1305:
173 static EVP_PKEY_CTX *int_ctx_new(OPENSSL_CTX *libctx,
174 EVP_PKEY *pkey, ENGINE *e,
175 const char *keytype, const char *propquery,
180 const EVP_PKEY_METHOD *pmeth = NULL;
181 EVP_KEYMGMT *keymgmt = NULL;
184 * When using providers, the context is bound to the algo implementation
187 if (pkey == NULL && e == NULL && id == -1)
191 * If the internal key is provided, we extract the keytype from its
192 * keymgmt and skip over the legacy code.
194 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
195 /* If we have an engine, something went wrong somewhere... */
196 if (!ossl_assert(e == NULL))
198 keytype = evp_first_name(pkey->keymgmt->prov, pkey->keymgmt->name_id);
202 /* TODO(3.0) Legacy code should be removed when all is provider based */
211 * Here, we extract what information we can for the purpose of
212 * supporting usage with implementations from providers, to make
213 * for a smooth transition from legacy stuff to provider based stuff.
215 * If an engine is given, this is entirely legacy, and we should not
216 * pretend anything else, so we only set the name when no engine is
217 * given. If both are already given, someone made a mistake, and
218 * since that can only happen internally, it's safe to make an
221 if (!ossl_assert(e == NULL || keytype == NULL))
224 keytype = OBJ_nid2sn(id);
226 # ifndef OPENSSL_NO_ENGINE
227 if (e == NULL && pkey != NULL)
228 e = pkey->pmeth_engine != NULL ? pkey->pmeth_engine : pkey->engine;
229 /* Try to find an ENGINE which implements this method */
231 if (!ENGINE_init(e)) {
232 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
236 e = ENGINE_get_pkey_meth_engine(id);
240 * If an ENGINE handled this method look it up. Otherwise use internal
244 pmeth = ENGINE_get_pkey_meth(e, id);
247 pmeth = EVP_PKEY_meth_find(id);
250 # ifndef OPENSSL_NO_ENGINE
253 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
257 #endif /* FIPS_MODULE */
260 * If there's no engine and there's a name, we try fetching a provider
263 if (e == NULL && keytype != NULL) {
264 int legacy = is_legacy_alg(id, keytype);
267 /* This could fail so ignore errors */
271 keymgmt = EVP_KEYMGMT_fetch(libctx, keytype, propquery);
274 } else if (keymgmt == NULL) {
275 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_FETCH_FAILED);
280 ret = OPENSSL_zalloc(sizeof(*ret));
282 EVP_KEYMGMT_free(keymgmt);
283 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
286 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
289 ret->libctx = libctx;
290 ret->propquery = propquery;
291 ret->keytype = keytype;
292 ret->keymgmt = keymgmt;
295 ret->operation = EVP_PKEY_OP_UNDEFINED;
298 EVP_PKEY_up_ref(pkey);
300 if (pmeth != NULL && pmeth->init != NULL) {
301 if (pmeth->init(ret) <= 0) {
303 EVP_PKEY_CTX_free(ret);
311 /*- All methods below can also be used in FIPS_MODULE */
313 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_name(OPENSSL_CTX *libctx,
315 const char *propquery)
317 return int_ctx_new(libctx, NULL, NULL, name, propquery, -1);
320 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_pkey(OPENSSL_CTX *libctx, EVP_PKEY *pkey,
321 const char *propquery)
323 return int_ctx_new(libctx, pkey, NULL, NULL, propquery, -1);
326 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx)
328 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
329 if (ctx->op.sig.sigprovctx != NULL && ctx->op.sig.signature != NULL)
330 ctx->op.sig.signature->freectx(ctx->op.sig.sigprovctx);
331 EVP_SIGNATURE_free(ctx->op.sig.signature);
332 ctx->op.sig.sigprovctx = NULL;
333 ctx->op.sig.signature = NULL;
334 } else if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
335 if (ctx->op.kex.exchprovctx != NULL && ctx->op.kex.exchange != NULL)
336 ctx->op.kex.exchange->freectx(ctx->op.kex.exchprovctx);
337 EVP_KEYEXCH_free(ctx->op.kex.exchange);
338 ctx->op.kex.exchprovctx = NULL;
339 ctx->op.kex.exchange = NULL;
341 /* TODO(3.0): add dependancies and uncomment this when available for fips mode */
343 else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
344 if (ctx->op.ciph.ciphprovctx != NULL && ctx->op.ciph.cipher != NULL)
345 ctx->op.ciph.cipher->freectx(ctx->op.ciph.ciphprovctx);
346 EVP_ASYM_CIPHER_free(ctx->op.ciph.cipher);
347 ctx->op.ciph.ciphprovctx = NULL;
348 ctx->op.ciph.cipher = NULL;
349 } else if (EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
350 if (ctx->op.keymgmt.genctx != NULL && ctx->keymgmt != NULL)
351 evp_keymgmt_gen_cleanup(ctx->keymgmt, ctx->op.keymgmt.genctx);
356 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
360 if (ctx->pmeth && ctx->pmeth->cleanup)
361 ctx->pmeth->cleanup(ctx);
363 evp_pkey_ctx_free_old_ops(ctx);
364 EVP_KEYMGMT_free(ctx->keymgmt);
366 EVP_PKEY_free(ctx->pkey);
367 EVP_PKEY_free(ctx->peerkey);
368 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
369 ENGINE_finish(ctx->engine);
376 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
377 const EVP_PKEY_METHOD *meth)
380 *ppkey_id = meth->pkey_id;
382 *pflags = meth->flags;
385 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
387 int pkey_id = dst->pkey_id;
388 int flags = dst->flags;
392 /* We only copy the function pointers so restore the other values */
393 dst->pkey_id = pkey_id;
397 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
399 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
403 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
405 return int_ctx_new(NULL, pkey, e, NULL, NULL, -1);
408 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
410 return int_ctx_new(NULL, NULL, e, NULL, NULL, id);
413 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *pctx)
417 if (((pctx->pmeth == NULL) || (pctx->pmeth->copy == NULL))
418 && ((EVP_PKEY_CTX_IS_DERIVE_OP(pctx)
419 && pctx->op.kex.exchprovctx == NULL)
420 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)
421 && pctx->op.sig.sigprovctx == NULL)))
423 # ifndef OPENSSL_NO_ENGINE
424 /* Make sure it's safe to copy a pkey context using an ENGINE */
425 if (pctx->engine && !ENGINE_init(pctx->engine)) {
426 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
430 rctx = OPENSSL_zalloc(sizeof(*rctx));
432 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_MALLOC_FAILURE);
436 if (pctx->pkey != NULL)
437 EVP_PKEY_up_ref(pctx->pkey);
438 rctx->pkey = pctx->pkey;
439 rctx->operation = pctx->operation;
440 rctx->libctx = pctx->libctx;
441 rctx->keytype = pctx->keytype;
442 rctx->propquery = pctx->propquery;
444 if (EVP_PKEY_CTX_IS_DERIVE_OP(pctx)) {
445 if (pctx->op.kex.exchange != NULL) {
446 rctx->op.kex.exchange = pctx->op.kex.exchange;
447 if (!EVP_KEYEXCH_up_ref(rctx->op.kex.exchange)) {
452 if (pctx->op.kex.exchprovctx != NULL) {
453 if (!ossl_assert(pctx->op.kex.exchange != NULL))
455 rctx->op.kex.exchprovctx
456 = pctx->op.kex.exchange->dupctx(pctx->op.kex.exchprovctx);
457 if (rctx->op.kex.exchprovctx == NULL) {
458 EVP_KEYEXCH_free(rctx->op.kex.exchange);
464 } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)) {
465 if (pctx->op.sig.signature != NULL) {
466 rctx->op.sig.signature = pctx->op.sig.signature;
467 if (!EVP_SIGNATURE_up_ref(rctx->op.sig.signature)) {
472 if (pctx->op.sig.sigprovctx != NULL) {
473 if (!ossl_assert(pctx->op.sig.signature != NULL))
475 rctx->op.sig.sigprovctx
476 = pctx->op.sig.signature->dupctx(pctx->op.sig.sigprovctx);
477 if (rctx->op.sig.sigprovctx == NULL) {
478 EVP_SIGNATURE_free(rctx->op.sig.signature);
484 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(pctx)) {
485 if (pctx->op.ciph.cipher != NULL) {
486 rctx->op.ciph.cipher = pctx->op.ciph.cipher;
487 if (!EVP_ASYM_CIPHER_up_ref(rctx->op.ciph.cipher)) {
492 if (pctx->op.ciph.ciphprovctx != NULL) {
493 if (!ossl_assert(pctx->op.ciph.cipher != NULL))
495 rctx->op.ciph.ciphprovctx
496 = pctx->op.ciph.cipher->dupctx(pctx->op.ciph.ciphprovctx);
497 if (rctx->op.ciph.ciphprovctx == NULL) {
498 EVP_ASYM_CIPHER_free(rctx->op.ciph.cipher);
506 rctx->pmeth = pctx->pmeth;
507 # ifndef OPENSSL_NO_ENGINE
508 rctx->engine = pctx->engine;
512 EVP_PKEY_up_ref(pctx->peerkey);
513 rctx->peerkey = pctx->peerkey;
515 if (pctx->pmeth->copy(rctx, pctx) > 0)
519 EVP_PKEY_CTX_free(rctx);
524 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
526 if (app_pkey_methods == NULL) {
527 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
528 if (app_pkey_methods == NULL){
529 EVPerr(EVP_F_EVP_PKEY_METH_ADD0, ERR_R_MALLOC_FAILURE);
533 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth)) {
534 EVPerr(EVP_F_EVP_PKEY_METH_ADD0, ERR_R_MALLOC_FAILURE);
537 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
541 void evp_app_cleanup_int(void)
543 if (app_pkey_methods != NULL)
544 sk_EVP_PKEY_METHOD_pop_free(app_pkey_methods, EVP_PKEY_meth_free);
547 int EVP_PKEY_meth_remove(const EVP_PKEY_METHOD *pmeth)
549 const EVP_PKEY_METHOD *ret;
551 ret = sk_EVP_PKEY_METHOD_delete_ptr(app_pkey_methods, pmeth);
553 return ret == NULL ? 0 : 1;
556 size_t EVP_PKEY_meth_get_count(void)
558 size_t rv = OSSL_NELEM(standard_methods);
560 if (app_pkey_methods)
561 rv += sk_EVP_PKEY_METHOD_num(app_pkey_methods);
565 const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx)
567 if (idx < OSSL_NELEM(standard_methods))
568 return (standard_methods[idx])();
569 if (app_pkey_methods == NULL)
571 idx -= OSSL_NELEM(standard_methods);
572 if (idx >= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods))
574 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
578 int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
580 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
581 && ctx->op.kex.exchprovctx != NULL
582 && ctx->op.kex.exchange != NULL
583 && ctx->op.kex.exchange->set_ctx_params != NULL)
584 return ctx->op.kex.exchange->set_ctx_params(ctx->op.kex.exchprovctx,
586 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
587 && ctx->op.sig.sigprovctx != NULL
588 && ctx->op.sig.signature != NULL
589 && ctx->op.sig.signature->set_ctx_params != NULL)
590 return ctx->op.sig.signature->set_ctx_params(ctx->op.sig.sigprovctx,
592 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
593 && ctx->op.ciph.ciphprovctx != NULL
594 && ctx->op.ciph.cipher != NULL
595 && ctx->op.ciph.cipher->set_ctx_params != NULL)
596 return ctx->op.ciph.cipher->set_ctx_params(ctx->op.ciph.ciphprovctx,
598 if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
599 && ctx->op.keymgmt.genctx != NULL
600 && ctx->keymgmt != NULL
601 && ctx->keymgmt->gen_set_params != NULL)
602 return evp_keymgmt_gen_set_params(ctx->keymgmt, ctx->op.keymgmt.genctx,
607 int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
609 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
610 && ctx->op.kex.exchprovctx != NULL
611 && ctx->op.kex.exchange != NULL
612 && ctx->op.kex.exchange->get_ctx_params != NULL)
613 return ctx->op.kex.exchange->get_ctx_params(ctx->op.kex.exchprovctx,
615 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
616 && ctx->op.sig.sigprovctx != NULL
617 && ctx->op.sig.signature != NULL
618 && ctx->op.sig.signature->get_ctx_params != NULL)
619 return ctx->op.sig.signature->get_ctx_params(ctx->op.sig.sigprovctx,
621 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
622 && ctx->op.ciph.ciphprovctx != NULL
623 && ctx->op.ciph.cipher != NULL
624 && ctx->op.ciph.cipher->get_ctx_params != NULL)
625 return ctx->op.ciph.cipher->get_ctx_params(ctx->op.ciph.ciphprovctx,
631 const OSSL_PARAM *EVP_PKEY_CTX_gettable_params(EVP_PKEY_CTX *ctx)
635 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
636 && ctx->op.kex.exchange != NULL
637 && ctx->op.kex.exchange->gettable_ctx_params != NULL) {
638 provctx = ossl_provider_ctx(EVP_KEYEXCH_provider(ctx->op.kex.exchange));
639 return ctx->op.kex.exchange->gettable_ctx_params(provctx);
641 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
642 && ctx->op.sig.signature != NULL
643 && ctx->op.sig.signature->gettable_ctx_params != NULL) {
644 provctx = ossl_provider_ctx(
645 EVP_SIGNATURE_provider(ctx->op.sig.signature));
646 return ctx->op.sig.signature->gettable_ctx_params(provctx);
648 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
649 && ctx->op.ciph.cipher != NULL
650 && ctx->op.ciph.cipher->gettable_ctx_params != NULL) {
651 provctx = ossl_provider_ctx(
652 EVP_ASYM_CIPHER_provider(ctx->op.ciph.cipher));
653 return ctx->op.ciph.cipher->gettable_ctx_params(provctx);
658 const OSSL_PARAM *EVP_PKEY_CTX_settable_params(EVP_PKEY_CTX *ctx)
662 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
663 && ctx->op.kex.exchange != NULL
664 && ctx->op.kex.exchange->settable_ctx_params != NULL) {
665 provctx = ossl_provider_ctx(EVP_KEYEXCH_provider(ctx->op.kex.exchange));
666 return ctx->op.kex.exchange->settable_ctx_params(provctx);
668 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
669 && ctx->op.sig.signature != NULL
670 && ctx->op.sig.signature->settable_ctx_params != NULL) {
671 provctx = ossl_provider_ctx(
672 EVP_SIGNATURE_provider(ctx->op.sig.signature));
673 return ctx->op.sig.signature->settable_ctx_params(provctx);
675 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
676 && ctx->op.ciph.cipher != NULL
677 && ctx->op.ciph.cipher->settable_ctx_params != NULL) {
678 provctx = ossl_provider_ctx(
679 EVP_ASYM_CIPHER_provider(ctx->op.ciph.cipher));
680 return ctx->op.ciph.cipher->settable_ctx_params(provctx);
682 if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
683 && ctx->keymgmt != NULL)
684 return evp_keymgmt_gen_settable_params(ctx->keymgmt);
690 * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
692 * Return 1 on success, 0 or negative for errors.
694 * In particular they return -2 if any of the params is not supported.
696 * They are not available in FIPS_MODULE as they depend on
697 * - EVP_PKEY_CTX_{get,set}_params()
698 * - EVP_PKEY_CTX_{gettable,settable}_params()
701 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
705 if (ctx == NULL || params == NULL)
708 for (p = params; p->key != NULL; p++) {
709 /* Check the ctx actually understands this parameter */
710 if (OSSL_PARAM_locate_const(EVP_PKEY_CTX_settable_params(ctx),
715 return EVP_PKEY_CTX_set_params(ctx, params);
718 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
722 if (ctx == NULL || params == NULL)
725 for (p = params; p->key != NULL; p++ ) {
726 /* Check the ctx actually understands this parameter */
727 if (OSSL_PARAM_locate_const(EVP_PKEY_CTX_gettable_params(ctx),
732 return EVP_PKEY_CTX_get_params(ctx, params);
735 # ifndef OPENSSL_NO_DH
736 int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad)
738 OSSL_PARAM dh_pad_params[2];
739 unsigned int upad = pad;
741 /* We use EVP_PKEY_CTX_ctrl return values */
742 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
743 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
747 /* TODO(3.0): Remove this eventually when no more legacy */
748 if (ctx->op.kex.exchprovctx == NULL)
749 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_DERIVE,
750 EVP_PKEY_CTRL_DH_PAD, pad, NULL);
752 dh_pad_params[0] = OSSL_PARAM_construct_uint(OSSL_EXCHANGE_PARAM_PAD, &upad);
753 dh_pad_params[1] = OSSL_PARAM_construct_end();
755 return EVP_PKEY_CTX_set_params(ctx, dh_pad_params);
759 int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
761 OSSL_PARAM sig_md_params[2], *p = sig_md_params;
762 /* 80 should be big enough */
766 if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
767 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
768 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
772 /* TODO(3.0): Remove this eventually when no more legacy */
773 if (ctx->op.sig.sigprovctx == NULL)
774 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
775 EVP_PKEY_CTRL_GET_MD, 0, (void *)(md));
777 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
780 *p = OSSL_PARAM_construct_end();
782 if (!EVP_PKEY_CTX_get_params(ctx, sig_md_params))
785 tmp = evp_get_digestbyname_ex(ctx->libctx, name);
794 static int evp_pkey_ctx_set_md(EVP_PKEY_CTX *ctx, const EVP_MD *md,
795 int fallback, const char *param, int op,
798 OSSL_PARAM md_params[2], *p = md_params;
801 if (ctx == NULL || (ctx->operation & op) == 0) {
802 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
803 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
807 /* TODO(3.0): Remove this eventually when no more legacy */
809 return EVP_PKEY_CTX_ctrl(ctx, -1, op, ctrl, 0, (void *)(md));
814 name = EVP_MD_name(md);
817 *p++ = OSSL_PARAM_construct_utf8_string(param,
819 * Cast away the const. This is read
820 * only so should be safe
823 *p = OSSL_PARAM_construct_end();
825 return EVP_PKEY_CTX_set_params(ctx, md_params);
828 int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
830 return evp_pkey_ctx_set_md(ctx, md, ctx->op.sig.sigprovctx == NULL,
831 OSSL_SIGNATURE_PARAM_DIGEST,
832 EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD);
835 int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
837 return evp_pkey_ctx_set_md(ctx, md, ctx->op.kex.exchprovctx == NULL,
838 OSSL_KDF_PARAM_DIGEST,
839 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_TLS_MD);
842 static int evp_pkey_ctx_set1_octet_string(EVP_PKEY_CTX *ctx, int fallback,
843 const char *param, int op, int ctrl,
844 const unsigned char *data,
847 OSSL_PARAM octet_string_params[2], *p = octet_string_params;
849 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
850 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
851 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
855 /* TODO(3.0): Remove this eventually when no more legacy */
857 return EVP_PKEY_CTX_ctrl(ctx, -1, op, ctrl, datalen, (void *)(data));
860 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_LENGTH);
864 *p++ = OSSL_PARAM_construct_octet_string(param,
866 * Cast away the const. This is read
867 * only so should be safe
869 (unsigned char *)data,
871 *p++ = OSSL_PARAM_construct_end();
873 return EVP_PKEY_CTX_set_params(ctx, octet_string_params);
876 int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX *ctx,
877 const unsigned char *sec, int seclen)
879 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
880 OSSL_KDF_PARAM_SECRET,
882 EVP_PKEY_CTRL_TLS_SECRET,
886 int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX *ctx,
887 const unsigned char *seed, int seedlen)
889 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
892 EVP_PKEY_CTRL_TLS_SEED,
896 int EVP_PKEY_CTX_set_hkdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
898 return evp_pkey_ctx_set_md(ctx, md, ctx->op.kex.exchprovctx == NULL,
899 OSSL_KDF_PARAM_DIGEST,
900 EVP_PKEY_OP_DERIVE, EVP_PKEY_CTRL_HKDF_MD);
903 int EVP_PKEY_CTX_set1_hkdf_salt(EVP_PKEY_CTX *ctx,
904 const unsigned char *salt, int saltlen)
906 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
909 EVP_PKEY_CTRL_HKDF_SALT,
913 int EVP_PKEY_CTX_set1_hkdf_key(EVP_PKEY_CTX *ctx,
914 const unsigned char *key, int keylen)
916 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
919 EVP_PKEY_CTRL_HKDF_KEY,
923 int EVP_PKEY_CTX_add1_hkdf_info(EVP_PKEY_CTX *ctx,
924 const unsigned char *info, int infolen)
926 return evp_pkey_ctx_set1_octet_string(ctx, ctx->op.kex.exchprovctx == NULL,
929 EVP_PKEY_CTRL_HKDF_INFO,
933 int EVP_PKEY_CTX_hkdf_mode(EVP_PKEY_CTX *ctx, int mode)
935 OSSL_PARAM int_params[2], *p = int_params;
937 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
938 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
939 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
943 /* TODO(3.0): Remove this eventually when no more legacy */
944 if (ctx->op.kex.exchprovctx == NULL)
945 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_DERIVE,
946 EVP_PKEY_CTRL_HKDF_MODE, mode, NULL);
950 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_VALUE);
954 *p++ = OSSL_PARAM_construct_int(OSSL_KDF_PARAM_MODE, &mode);
955 *p++ = OSSL_PARAM_construct_end();
957 return EVP_PKEY_CTX_set_params(ctx, int_params);
960 static int legacy_ctrl_to_param(EVP_PKEY_CTX *ctx, int keytype, int optype,
961 int cmd, int p1, void *p2)
964 * GOST CMS format is different for different cipher algorithms.
965 * Most of other algorithms don't have such a difference
966 * so this ctrl is just ignored.
968 if (cmd == EVP_PKEY_CTRL_CIPHER)
971 # ifndef OPENSSL_NO_DH
972 if (keytype == EVP_PKEY_DH) {
974 case EVP_PKEY_CTRL_DH_PAD:
975 return EVP_PKEY_CTX_set_dh_pad(ctx, p1);
976 case EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN:
977 return EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, p1);
978 case EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN:
979 return EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, p1);
980 case EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR:
981 return EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, p1);
982 case EVP_PKEY_CTRL_DH_PARAMGEN_TYPE:
983 return EVP_PKEY_CTX_set_dh_paramgen_type(ctx, p1);
984 case EVP_PKEY_CTRL_DH_RFC5114:
985 return EVP_PKEY_CTX_set_dh_rfc5114(ctx, p1);
989 # ifndef OPENSSL_NO_DSA
990 if (keytype == EVP_PKEY_DSA) {
992 case EVP_PKEY_CTRL_DSA_PARAMGEN_BITS:
993 return EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, p1);
994 case EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS:
995 return EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, p1);
996 case EVP_PKEY_CTRL_DSA_PARAMGEN_MD:
997 return EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, p2);
1001 # ifndef OPENSSL_NO_EC
1002 if (keytype == EVP_PKEY_EC) {
1004 case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
1005 return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, p1);
1006 case EVP_PKEY_CTRL_EC_ECDH_COFACTOR:
1008 return EVP_PKEY_CTX_get_ecdh_cofactor_mode(ctx);
1009 } else if (p1 < -1 || p1 > 1) {
1010 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1013 return EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, p1);
1015 case EVP_PKEY_CTRL_EC_KDF_TYPE:
1017 return EVP_PKEY_CTX_get_ecdh_kdf_type(ctx);
1019 return EVP_PKEY_CTX_set_ecdh_kdf_type(ctx, p1);
1021 case EVP_PKEY_CTRL_GET_EC_KDF_MD:
1022 return EVP_PKEY_CTX_get_ecdh_kdf_md(ctx, p2);
1023 case EVP_PKEY_CTRL_EC_KDF_MD:
1024 return EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, p2);
1025 case EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN:
1026 return EVP_PKEY_CTX_get_ecdh_kdf_outlen(ctx, p2);
1027 case EVP_PKEY_CTRL_EC_KDF_OUTLEN:
1028 return EVP_PKEY_CTX_set_ecdh_kdf_outlen(ctx, p1);
1029 case EVP_PKEY_CTRL_GET_EC_KDF_UKM:
1030 return EVP_PKEY_CTX_get0_ecdh_kdf_ukm(ctx, p2);
1031 case EVP_PKEY_CTRL_EC_KDF_UKM:
1032 return EVP_PKEY_CTX_set0_ecdh_kdf_ukm(ctx, p2, p1);
1036 if (keytype == EVP_PKEY_RSA) {
1038 case EVP_PKEY_CTRL_RSA_OAEP_MD:
1039 return EVP_PKEY_CTX_set_rsa_oaep_md(ctx, p2);
1040 case EVP_PKEY_CTRL_GET_RSA_OAEP_MD:
1041 return EVP_PKEY_CTX_get_rsa_oaep_md(ctx, p2);
1042 case EVP_PKEY_CTRL_RSA_MGF1_MD:
1043 return EVP_PKEY_CTX_set_rsa_oaep_md(ctx, p2);
1044 case EVP_PKEY_CTRL_RSA_OAEP_LABEL:
1045 return EVP_PKEY_CTX_set0_rsa_oaep_label(ctx, p2, p1);
1046 case EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL:
1047 return EVP_PKEY_CTX_get0_rsa_oaep_label(ctx, (unsigned char **)p2);
1048 case EVP_PKEY_CTRL_RSA_KEYGEN_BITS:
1049 return EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, p1);
1050 case EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP:
1051 return EVP_PKEY_CTX_set_rsa_keygen_pubexp(ctx, p2);
1052 case EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES:
1053 return EVP_PKEY_CTX_set_rsa_keygen_primes(ctx, p1);
1057 * keytype == -1 is used when several key types share the same structure,
1058 * or for generic controls that are the same across multiple key types.
1060 if (keytype == -1) {
1061 if (optype == EVP_PKEY_OP_DERIVE) {
1064 case EVP_PKEY_CTRL_TLS_MD:
1065 return EVP_PKEY_CTX_set_tls1_prf_md(ctx, p2);
1066 case EVP_PKEY_CTRL_TLS_SECRET:
1067 return EVP_PKEY_CTX_set1_tls1_prf_secret(ctx, p2, p1);
1068 case EVP_PKEY_CTRL_TLS_SEED:
1069 return EVP_PKEY_CTX_add1_tls1_prf_seed(ctx, p2, p1);
1072 case EVP_PKEY_CTRL_HKDF_MD:
1073 return EVP_PKEY_CTX_set_hkdf_md(ctx, p2);
1074 case EVP_PKEY_CTRL_HKDF_SALT :
1075 return EVP_PKEY_CTX_set1_hkdf_salt(ctx, p2, p1);
1076 case EVP_PKEY_CTRL_HKDF_KEY:
1077 return EVP_PKEY_CTX_set1_hkdf_key(ctx, p2, p1);
1078 case EVP_PKEY_CTRL_HKDF_INFO:
1079 return EVP_PKEY_CTX_add1_hkdf_info(ctx, p2, p1);
1080 case EVP_PKEY_CTRL_HKDF_MODE:
1081 return EVP_PKEY_CTX_hkdf_mode(ctx, p1);
1085 case EVP_PKEY_CTRL_MD:
1086 return EVP_PKEY_CTX_set_signature_md(ctx, p2);
1087 case EVP_PKEY_CTRL_GET_MD:
1088 return EVP_PKEY_CTX_get_signature_md(ctx, p2);
1089 case EVP_PKEY_CTRL_RSA_PADDING:
1090 return EVP_PKEY_CTX_set_rsa_padding(ctx, p1);
1091 case EVP_PKEY_CTRL_GET_RSA_PADDING:
1092 return EVP_PKEY_CTX_get_rsa_padding(ctx, p2);
1093 case EVP_PKEY_CTRL_GET_RSA_MGF1_MD:
1094 return EVP_PKEY_CTX_get_rsa_oaep_md(ctx, p2);
1095 case EVP_PKEY_CTRL_RSA_PSS_SALTLEN:
1096 return EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, p1);
1097 case EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN:
1098 return EVP_PKEY_CTX_get_rsa_pss_saltlen(ctx, p2);
1099 case EVP_PKEY_CTRL_PKCS7_ENCRYPT:
1100 case EVP_PKEY_CTRL_PKCS7_DECRYPT:
1101 # ifndef OPENSSL_NO_CMS
1102 case EVP_PKEY_CTRL_CMS_DECRYPT:
1103 case EVP_PKEY_CTRL_CMS_ENCRYPT:
1105 /* TODO (3.0) Temporary hack, this should probe */
1106 if (!EVP_PKEY_is_a(EVP_PKEY_CTX_get0_pkey(ctx), "RSASSA-PSS"))
1108 ERR_raise(ERR_LIB_EVP,
1109 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
1116 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
1117 int cmd, int p1, void *p2)
1122 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
1126 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx) && ctx->op.kex.exchprovctx != NULL)
1127 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1128 && ctx->op.sig.sigprovctx != NULL)
1129 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1130 && ctx->op.ciph.ciphprovctx != NULL)
1131 || (EVP_PKEY_CTX_IS_GEN_OP(ctx)
1132 && ctx->op.keymgmt.genctx != NULL))
1133 return legacy_ctrl_to_param(ctx, keytype, optype, cmd, p1, p2);
1135 if (ctx->pmeth == NULL || ctx->pmeth->ctrl == NULL) {
1136 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
1139 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
1142 /* Skip the operation checks since this is called in a very early stage */
1143 if (ctx->pmeth->digest_custom != NULL)
1146 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
1147 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
1151 if ((optype != -1) && !(ctx->operation & optype)) {
1152 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
1157 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
1160 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
1165 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
1166 int cmd, uint64_t value)
1168 return EVP_PKEY_CTX_ctrl(ctx, keytype, optype, cmd, 0, &value);
1171 static int legacy_ctrl_str_to_param(EVP_PKEY_CTX *ctx, const char *name,
1175 /* Special cases that we intercept */
1176 # ifndef OPENSSL_NO_EC
1178 * We don't support encoding settings for providers, i.e. the only
1179 * possible encoding is "named_curve", so we simply fail when something
1180 * else is given, and otherwise just pretend all is fine.
1182 if (strcmp(name, "ec_param_enc") == 0) {
1183 if (strcmp(value, "named_curve") == 0) {
1186 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1192 if (strcmp(name, "md") == 0)
1193 name = OSSL_ALG_PARAM_DIGEST;
1194 else if (strcmp(name, "rsa_padding_mode") == 0)
1195 name = OSSL_ASYM_CIPHER_PARAM_PAD_MODE;
1196 else if (strcmp(name, "rsa_mgf1_md") == 0)
1197 name = OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST;
1198 else if (strcmp(name, "rsa_oaep_md") == 0)
1199 name = OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST;
1200 else if (strcmp(name, "rsa_oaep_label") == 0)
1201 name = OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL;
1202 else if (strcmp(name, "rsa_pss_saltlen") == 0)
1203 name = OSSL_SIGNATURE_PARAM_PSS_SALTLEN;
1204 else if (strcmp(name, "rsa_keygen_bits") == 0)
1205 name = OSSL_PKEY_PARAM_RSA_BITS;
1206 else if (strcmp(name, "rsa_keygen_pubexp") == 0)
1207 name = OSSL_PKEY_PARAM_RSA_E;
1208 else if (strcmp(name, "rsa_keygen_primes") == 0)
1209 name = OSSL_PKEY_PARAM_RSA_PRIMES;
1210 else if (strcmp(name, "rsa_pss_keygen_md") == 0)
1211 name = OSSL_PKEY_PARAM_RSA_DIGEST;
1212 else if (strcmp(name, "rsa_pss_keygen_mgf1_md") == 0)
1213 name = OSSL_PKEY_PARAM_RSA_MGF1_DIGEST;
1214 else if (strcmp(name, "rsa_pss_keygen_saltlen") == 0)
1215 name = OSSL_PKEY_PARAM_RSA_PSS_SALTLEN;
1216 # ifndef OPENSSL_NO_DSA
1217 else if (strcmp(name, "dsa_paramgen_bits") == 0)
1218 name = OSSL_PKEY_PARAM_FFC_PBITS;
1219 else if (strcmp(name, "dsa_paramgen_q_bits") == 0)
1220 name = OSSL_PKEY_PARAM_FFC_QBITS;
1221 else if (strcmp(name, "dsa_paramgen_md") == 0)
1222 name = OSSL_PKEY_PARAM_FFC_DIGEST;
1224 # ifndef OPENSSL_NO_DH
1225 else if (strcmp(name, "dh_paramgen_generator") == 0)
1226 name = OSSL_PKEY_PARAM_DH_GENERATOR;
1227 else if (strcmp(name, "dh_paramgen_prime_len") == 0)
1228 name = OSSL_PKEY_PARAM_FFC_PBITS;
1229 else if (strcmp(name, "dh_paramgen_subprime_len") == 0)
1230 name = OSSL_PKEY_PARAM_FFC_QBITS;
1231 else if (strcmp(name, "dh_paramgen_type") == 0) {
1232 name = OSSL_PKEY_PARAM_FFC_TYPE;
1233 value = dh_gen_type_id2name(atoi(value));
1234 } else if (strcmp(name, "dh_param") == 0)
1235 name = OSSL_PKEY_PARAM_GROUP_NAME;
1236 else if (strcmp(name, "dh_rfc5114") == 0) {
1237 name = OSSL_PKEY_PARAM_GROUP_NAME;
1238 value = ffc_named_group_from_uid(atoi(value));
1239 } else if (strcmp(name, "dh_pad") == 0)
1240 name = OSSL_EXCHANGE_PARAM_PAD;
1242 # ifndef OPENSSL_NO_EC
1243 else if (strcmp(name, "ec_paramgen_curve") == 0)
1244 name = OSSL_PKEY_PARAM_GROUP_NAME;
1245 else if (strcmp(name, "ecdh_cofactor_mode") == 0)
1246 name = OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE;
1247 else if (strcmp(name, "ecdh_kdf_md") == 0)
1248 name = OSSL_EXCHANGE_PARAM_KDF_DIGEST;
1253 * TODO(3.0) reduce the code above to only translate known legacy
1254 * string to the corresponding core name (see core_names.h), but
1255 * otherwise leave it to this code block to do the actual work.
1257 const OSSL_PARAM *settable = EVP_PKEY_CTX_settable_params(ctx);
1258 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1262 if (!OSSL_PARAM_allocate_from_text(¶ms[0], settable, name, value,
1263 strlen(value), &exists)) {
1265 ERR_raise_data(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED,
1266 "name=%s,value=%s", name, value);
1271 if (EVP_PKEY_CTX_set_params(ctx, params))
1273 OPENSSL_free(params[0].data);
1278 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
1279 const char *name, const char *value)
1282 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
1286 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx) && ctx->op.kex.exchprovctx != NULL)
1287 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1288 && ctx->op.sig.sigprovctx != NULL)
1289 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1290 && ctx->op.ciph.ciphprovctx != NULL)
1291 || (EVP_PKEY_CTX_IS_GEN_OP(ctx)
1292 && ctx->op.keymgmt.genctx != NULL))
1293 return legacy_ctrl_str_to_param(ctx, name, value);
1295 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
1296 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
1299 if (strcmp(name, "digest") == 0)
1300 return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD,
1302 return ctx->pmeth->ctrl_str(ctx, name, value);
1305 /* Utility functions to send a string of hex string to a ctrl */
1307 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
1314 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
1317 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
1323 bin = OPENSSL_hexstr2buf(hex, &binlen);
1326 if (binlen <= INT_MAX)
1327 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
1332 /* Pass a message digest to a ctrl */
1333 int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md)
1337 if (md == NULL || (m = EVP_get_digestbyname(md)) == NULL) {
1338 EVPerr(EVP_F_EVP_PKEY_CTX_MD, EVP_R_INVALID_DIGEST);
1341 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)m);
1344 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
1346 return ctx->operation;
1349 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
1351 ctx->keygen_info = dat;
1352 ctx->keygen_info_count = datlen;
1355 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
1360 void *EVP_PKEY_CTX_get_data(const EVP_PKEY_CTX *ctx)
1365 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
1370 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
1372 return ctx->peerkey;
1375 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
1377 ctx->app_data = data;
1380 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
1382 return ctx->app_data;
1385 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
1386 int (*init) (EVP_PKEY_CTX *ctx))
1391 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
1392 int (*copy) (EVP_PKEY_CTX *dst,
1393 const EVP_PKEY_CTX *src))
1398 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
1399 void (*cleanup) (EVP_PKEY_CTX *ctx))
1401 pmeth->cleanup = cleanup;
1404 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
1405 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
1406 int (*paramgen) (EVP_PKEY_CTX *ctx,
1409 pmeth->paramgen_init = paramgen_init;
1410 pmeth->paramgen = paramgen;
1413 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
1414 int (*keygen_init) (EVP_PKEY_CTX *ctx),
1415 int (*keygen) (EVP_PKEY_CTX *ctx,
1418 pmeth->keygen_init = keygen_init;
1419 pmeth->keygen = keygen;
1422 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
1423 int (*sign_init) (EVP_PKEY_CTX *ctx),
1424 int (*sign) (EVP_PKEY_CTX *ctx,
1425 unsigned char *sig, size_t *siglen,
1426 const unsigned char *tbs,
1429 pmeth->sign_init = sign_init;
1433 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
1434 int (*verify_init) (EVP_PKEY_CTX *ctx),
1435 int (*verify) (EVP_PKEY_CTX *ctx,
1436 const unsigned char *sig,
1438 const unsigned char *tbs,
1441 pmeth->verify_init = verify_init;
1442 pmeth->verify = verify;
1445 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
1446 int (*verify_recover_init) (EVP_PKEY_CTX
1448 int (*verify_recover) (EVP_PKEY_CTX
1457 pmeth->verify_recover_init = verify_recover_init;
1458 pmeth->verify_recover = verify_recover;
1461 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
1462 int (*signctx_init) (EVP_PKEY_CTX *ctx,
1464 int (*signctx) (EVP_PKEY_CTX *ctx,
1469 pmeth->signctx_init = signctx_init;
1470 pmeth->signctx = signctx;
1473 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
1474 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
1476 int (*verifyctx) (EVP_PKEY_CTX *ctx,
1477 const unsigned char *sig,
1481 pmeth->verifyctx_init = verifyctx_init;
1482 pmeth->verifyctx = verifyctx;
1485 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
1486 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
1487 int (*encryptfn) (EVP_PKEY_CTX *ctx,
1490 const unsigned char *in,
1493 pmeth->encrypt_init = encrypt_init;
1494 pmeth->encrypt = encryptfn;
1497 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
1498 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
1499 int (*decrypt) (EVP_PKEY_CTX *ctx,
1502 const unsigned char *in,
1505 pmeth->decrypt_init = decrypt_init;
1506 pmeth->decrypt = decrypt;
1509 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
1510 int (*derive_init) (EVP_PKEY_CTX *ctx),
1511 int (*derive) (EVP_PKEY_CTX *ctx,
1515 pmeth->derive_init = derive_init;
1516 pmeth->derive = derive;
1519 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
1520 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1522 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
1527 pmeth->ctrl_str = ctrl_str;
1530 void EVP_PKEY_meth_set_digestsign(EVP_PKEY_METHOD *pmeth,
1531 int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1532 const unsigned char *tbs, size_t tbslen))
1534 pmeth->digestsign = digestsign;
1537 void EVP_PKEY_meth_set_digestverify(EVP_PKEY_METHOD *pmeth,
1538 int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1539 size_t siglen, const unsigned char *tbs,
1542 pmeth->digestverify = digestverify;
1545 void EVP_PKEY_meth_set_check(EVP_PKEY_METHOD *pmeth,
1546 int (*check) (EVP_PKEY *pkey))
1548 pmeth->check = check;
1551 void EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD *pmeth,
1552 int (*check) (EVP_PKEY *pkey))
1554 pmeth->public_check = check;
1557 void EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD *pmeth,
1558 int (*check) (EVP_PKEY *pkey))
1560 pmeth->param_check = check;
1563 void EVP_PKEY_meth_set_digest_custom(EVP_PKEY_METHOD *pmeth,
1564 int (*digest_custom) (EVP_PKEY_CTX *ctx,
1567 pmeth->digest_custom = digest_custom;
1570 void EVP_PKEY_meth_get_init(const EVP_PKEY_METHOD *pmeth,
1571 int (**pinit) (EVP_PKEY_CTX *ctx))
1573 *pinit = pmeth->init;
1576 void EVP_PKEY_meth_get_copy(const EVP_PKEY_METHOD *pmeth,
1577 int (**pcopy) (EVP_PKEY_CTX *dst,
1578 const EVP_PKEY_CTX *src))
1580 *pcopy = pmeth->copy;
1583 void EVP_PKEY_meth_get_cleanup(const EVP_PKEY_METHOD *pmeth,
1584 void (**pcleanup) (EVP_PKEY_CTX *ctx))
1586 *pcleanup = pmeth->cleanup;
1589 void EVP_PKEY_meth_get_paramgen(const EVP_PKEY_METHOD *pmeth,
1590 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
1591 int (**pparamgen) (EVP_PKEY_CTX *ctx,
1595 *pparamgen_init = pmeth->paramgen_init;
1597 *pparamgen = pmeth->paramgen;
1600 void EVP_PKEY_meth_get_keygen(const EVP_PKEY_METHOD *pmeth,
1601 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
1602 int (**pkeygen) (EVP_PKEY_CTX *ctx,
1606 *pkeygen_init = pmeth->keygen_init;
1608 *pkeygen = pmeth->keygen;
1611 void EVP_PKEY_meth_get_sign(const EVP_PKEY_METHOD *pmeth,
1612 int (**psign_init) (EVP_PKEY_CTX *ctx),
1613 int (**psign) (EVP_PKEY_CTX *ctx,
1614 unsigned char *sig, size_t *siglen,
1615 const unsigned char *tbs,
1619 *psign_init = pmeth->sign_init;
1621 *psign = pmeth->sign;
1624 void EVP_PKEY_meth_get_verify(const EVP_PKEY_METHOD *pmeth,
1625 int (**pverify_init) (EVP_PKEY_CTX *ctx),
1626 int (**pverify) (EVP_PKEY_CTX *ctx,
1627 const unsigned char *sig,
1629 const unsigned char *tbs,
1633 *pverify_init = pmeth->verify_init;
1635 *pverify = pmeth->verify;
1638 void EVP_PKEY_meth_get_verify_recover(const EVP_PKEY_METHOD *pmeth,
1639 int (**pverify_recover_init) (EVP_PKEY_CTX
1641 int (**pverify_recover) (EVP_PKEY_CTX
1650 if (pverify_recover_init)
1651 *pverify_recover_init = pmeth->verify_recover_init;
1652 if (pverify_recover)
1653 *pverify_recover = pmeth->verify_recover;
1656 void EVP_PKEY_meth_get_signctx(const EVP_PKEY_METHOD *pmeth,
1657 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
1659 int (**psignctx) (EVP_PKEY_CTX *ctx,
1665 *psignctx_init = pmeth->signctx_init;
1667 *psignctx = pmeth->signctx;
1670 void EVP_PKEY_meth_get_verifyctx(const EVP_PKEY_METHOD *pmeth,
1671 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
1673 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
1674 const unsigned char *sig,
1678 if (pverifyctx_init)
1679 *pverifyctx_init = pmeth->verifyctx_init;
1681 *pverifyctx = pmeth->verifyctx;
1684 void EVP_PKEY_meth_get_encrypt(const EVP_PKEY_METHOD *pmeth,
1685 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
1686 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
1689 const unsigned char *in,
1693 *pencrypt_init = pmeth->encrypt_init;
1695 *pencryptfn = pmeth->encrypt;
1698 void EVP_PKEY_meth_get_decrypt(const EVP_PKEY_METHOD *pmeth,
1699 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
1700 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
1703 const unsigned char *in,
1707 *pdecrypt_init = pmeth->decrypt_init;
1709 *pdecrypt = pmeth->decrypt;
1712 void EVP_PKEY_meth_get_derive(const EVP_PKEY_METHOD *pmeth,
1713 int (**pderive_init) (EVP_PKEY_CTX *ctx),
1714 int (**pderive) (EVP_PKEY_CTX *ctx,
1719 *pderive_init = pmeth->derive_init;
1721 *pderive = pmeth->derive;
1724 void EVP_PKEY_meth_get_ctrl(const EVP_PKEY_METHOD *pmeth,
1725 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1727 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
1732 *pctrl = pmeth->ctrl;
1734 *pctrl_str = pmeth->ctrl_str;
1737 void EVP_PKEY_meth_get_digestsign(EVP_PKEY_METHOD *pmeth,
1738 int (**digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1739 const unsigned char *tbs, size_t tbslen))
1742 *digestsign = pmeth->digestsign;
1745 void EVP_PKEY_meth_get_digestverify(EVP_PKEY_METHOD *pmeth,
1746 int (**digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1747 size_t siglen, const unsigned char *tbs,
1751 *digestverify = pmeth->digestverify;
1754 void EVP_PKEY_meth_get_check(const EVP_PKEY_METHOD *pmeth,
1755 int (**pcheck) (EVP_PKEY *pkey))
1758 *pcheck = pmeth->check;
1761 void EVP_PKEY_meth_get_public_check(const EVP_PKEY_METHOD *pmeth,
1762 int (**pcheck) (EVP_PKEY *pkey))
1765 *pcheck = pmeth->public_check;
1768 void EVP_PKEY_meth_get_param_check(const EVP_PKEY_METHOD *pmeth,
1769 int (**pcheck) (EVP_PKEY *pkey))
1772 *pcheck = pmeth->param_check;
1775 void EVP_PKEY_meth_get_digest_custom(EVP_PKEY_METHOD *pmeth,
1776 int (**pdigest_custom) (EVP_PKEY_CTX *ctx,
1779 if (pdigest_custom != NULL)
1780 *pdigest_custom = pmeth->digest_custom;
1783 #endif /* FIPS_MODULE */