3 * Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
13 #include <openssl/engine.h>
14 #include <openssl/evp.h>
15 #include <openssl/x509v3.h>
16 #include <openssl/core_names.h>
17 #include <openssl/dh.h>
18 #include <openssl/rsa.h>
19 #include "internal/cryptlib.h"
20 #include "crypto/asn1.h"
21 #include "crypto/evp.h"
22 #include "internal/numbers.h"
23 #include "internal/provider.h"
24 #include "evp_local.h"
28 typedef const EVP_PKEY_METHOD *(*pmeth_fn)(void);
29 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
31 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
33 /* This array needs to be in order of NIDs */
34 static pmeth_fn standard_methods[] = {
35 # ifndef OPENSSL_NO_RSA
38 # ifndef OPENSSL_NO_DH
41 # ifndef OPENSSL_NO_DSA
44 # ifndef OPENSSL_NO_EC
48 # ifndef OPENSSL_NO_CMAC
51 # ifndef OPENSSL_NO_RSA
54 # ifndef OPENSSL_NO_DH
57 # ifndef OPENSSL_NO_SCRYPT
61 # ifndef OPENSSL_NO_EC
66 # ifndef OPENSSL_NO_POLY1305
69 # ifndef OPENSSL_NO_SIPHASH
72 # ifndef OPENSSL_NO_EC
76 # ifndef OPENSSL_NO_SM2
81 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
83 static int pmeth_func_cmp(const EVP_PKEY_METHOD *const *a, pmeth_fn const *b)
85 return ((*a)->pkey_id - ((**b)())->pkey_id);
88 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
90 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
91 const EVP_PKEY_METHOD *const *b)
93 return ((*a)->pkey_id - (*b)->pkey_id);
96 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
100 const EVP_PKEY_METHOD *t = &tmp;
103 if (app_pkey_methods) {
105 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
107 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
109 ret = OBJ_bsearch_pmeth_func(&t, standard_methods,
110 sizeof(standard_methods) /
112 if (ret == NULL || *ret == NULL)
117 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
119 EVP_PKEY_METHOD *pmeth;
121 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
123 EVPerr(EVP_F_EVP_PKEY_METH_NEW, ERR_R_MALLOC_FAILURE);
128 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
131 #endif /* FIPS_MODE */
133 static EVP_PKEY_CTX *int_ctx_new(OPENSSL_CTX *libctx,
134 EVP_PKEY *pkey, ENGINE *e,
135 const char *name, const char *propquery,
140 const EVP_PKEY_METHOD *pmeth = NULL;
143 * When using providers, the context is bound to the algo implementation
146 if (pkey == NULL && e == NULL && id == -1)
150 * If the key doesn't contain anything legacy, then it must be provided,
151 * so we extract the necessary information and use that.
153 if (pkey != NULL && pkey->pkey.ptr == NULL) {
154 /* If we have an engine, something went wrong somewhere... */
155 if (!ossl_assert(e == NULL))
157 name = evp_first_name(pkey->pkeys[0].keymgmt->prov,
158 pkey->pkeys[0].keymgmt->name_id);
160 * TODO: I wonder if the EVP_PKEY should have the name and propquery
161 * that were used when building it.... /RL
166 /* TODO(3.0) Legacy code should be removed when all is provider based */
175 * Here, we extract what information we can for the purpose of
176 * supporting usage with implementations from providers, to make
177 * for a smooth transition from legacy stuff to provider based stuff.
179 * If an engine is given, this is entirely legacy, and we should not
180 * pretend anything else, so we only set the name when no engine is
181 * given. If both are already given, someone made a mistake, and
182 * since that can only happen internally, it's safe to make an
185 if (!ossl_assert(e == NULL || name == NULL))
188 name = OBJ_nid2sn(id);
191 * We were called using legacy data, or an EVP_PKEY, but an EVP_PKEY
192 * isn't tied to a specific library context, so we fall back to the
193 * default library context.
194 * TODO(v3.0): an EVP_PKEY that doesn't originate from a leagacy key
195 * structure only has the pkeys[] cache, where the first element is
196 * considered the "origin". Investigate if that could be a suitable
197 * way to find a library context.
201 # ifndef OPENSSL_NO_ENGINE
202 if (e == NULL && pkey != NULL)
203 e = pkey->pmeth_engine != NULL ? pkey->pmeth_engine : pkey->engine;
204 /* Try to find an ENGINE which implements this method */
206 if (!ENGINE_init(e)) {
207 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
211 e = ENGINE_get_pkey_meth_engine(id);
215 * If an ENGINE handled this method look it up. Otherwise use internal
219 pmeth = ENGINE_get_pkey_meth(e, id);
222 pmeth = EVP_PKEY_meth_find(id);
225 # ifndef OPENSSL_NO_ENGINE
228 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
232 #endif /* FIPS_MODE */
234 ret = OPENSSL_zalloc(sizeof(*ret));
236 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
239 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
242 ret->libctx = libctx;
244 ret->propquery = propquery;
247 ret->operation = EVP_PKEY_OP_UNDEFINED;
250 EVP_PKEY_up_ref(pkey);
252 if (pmeth != NULL && pmeth->init != NULL) {
253 if (pmeth->init(ret) <= 0) {
255 EVP_PKEY_CTX_free(ret);
263 /*- All methods below can also be used in FIPS_MODE */
265 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_name(OPENSSL_CTX *libctx,
267 const char *propquery)
269 return int_ctx_new(libctx, NULL, NULL, name, propquery, -1);
272 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_pkey(OPENSSL_CTX *libctx, EVP_PKEY *pkey)
274 return int_ctx_new(libctx, pkey, NULL, NULL, NULL, -1);
277 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx)
279 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
280 if (ctx->op.sig.sigprovctx != NULL && ctx->op.sig.signature != NULL)
281 ctx->op.sig.signature->freectx(ctx->op.sig.sigprovctx);
282 EVP_SIGNATURE_free(ctx->op.sig.signature);
283 ctx->op.sig.sigprovctx = NULL;
284 ctx->op.sig.signature = NULL;
286 /* TODO(3.0): add dependancies and uncomment this when available for fips mode */
288 else if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
289 if (ctx->op.kex.exchprovctx != NULL && ctx->op.kex.exchange != NULL)
290 ctx->op.kex.exchange->freectx(ctx->op.kex.exchprovctx);
291 EVP_KEYEXCH_free(ctx->op.kex.exchange);
292 ctx->op.kex.exchprovctx = NULL;
293 ctx->op.kex.exchange = NULL;
294 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
295 if (ctx->op.ciph.ciphprovctx != NULL && ctx->op.ciph.cipher != NULL)
296 ctx->op.ciph.cipher->freectx(ctx->op.ciph.ciphprovctx);
297 EVP_ASYM_CIPHER_free(ctx->op.ciph.cipher);
298 ctx->op.ciph.ciphprovctx = NULL;
299 ctx->op.ciph.cipher = NULL;
304 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
308 if (ctx->pmeth && ctx->pmeth->cleanup)
309 ctx->pmeth->cleanup(ctx);
311 evp_pkey_ctx_free_old_ops(ctx);
312 EVP_KEYMGMT_free(ctx->keymgmt);
314 EVP_PKEY_free(ctx->pkey);
315 EVP_PKEY_free(ctx->peerkey);
316 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
317 ENGINE_finish(ctx->engine);
324 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
325 const EVP_PKEY_METHOD *meth)
328 *ppkey_id = meth->pkey_id;
330 *pflags = meth->flags;
333 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
336 dst->init = src->init;
337 dst->copy = src->copy;
338 dst->cleanup = src->cleanup;
340 dst->paramgen_init = src->paramgen_init;
341 dst->paramgen = src->paramgen;
343 dst->keygen_init = src->keygen_init;
344 dst->keygen = src->keygen;
346 dst->sign_init = src->sign_init;
347 dst->sign = src->sign;
349 dst->verify_init = src->verify_init;
350 dst->verify = src->verify;
352 dst->verify_recover_init = src->verify_recover_init;
353 dst->verify_recover = src->verify_recover;
355 dst->signctx_init = src->signctx_init;
356 dst->signctx = src->signctx;
358 dst->verifyctx_init = src->verifyctx_init;
359 dst->verifyctx = src->verifyctx;
361 dst->encrypt_init = src->encrypt_init;
362 dst->encrypt = src->encrypt;
364 dst->decrypt_init = src->decrypt_init;
365 dst->decrypt = src->decrypt;
367 dst->derive_init = src->derive_init;
368 dst->derive = src->derive;
370 dst->ctrl = src->ctrl;
371 dst->ctrl_str = src->ctrl_str;
373 dst->check = src->check;
376 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
378 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
382 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
384 return int_ctx_new(NULL, pkey, e, NULL, NULL, -1);
387 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
389 return int_ctx_new(NULL, NULL, e, NULL, NULL, id);
393 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *pctx)
397 if (((pctx->pmeth == NULL) || (pctx->pmeth->copy == NULL))
398 && ((EVP_PKEY_CTX_IS_DERIVE_OP(pctx)
399 && pctx->op.kex.exchprovctx == NULL)
400 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)
401 && pctx->op.sig.sigprovctx == NULL)))
403 # ifndef OPENSSL_NO_ENGINE
404 /* Make sure it's safe to copy a pkey context using an ENGINE */
405 if (pctx->engine && !ENGINE_init(pctx->engine)) {
406 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
410 rctx = OPENSSL_zalloc(sizeof(*rctx));
412 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_MALLOC_FAILURE);
416 if (pctx->pkey != NULL)
417 EVP_PKEY_up_ref(pctx->pkey);
418 rctx->pkey = pctx->pkey;
419 rctx->operation = pctx->operation;
420 rctx->libctx = pctx->libctx;
421 rctx->keytype = pctx->keytype;
422 rctx->propquery = pctx->propquery;
424 if (EVP_PKEY_CTX_IS_DERIVE_OP(pctx)) {
425 if (pctx->op.kex.exchange != NULL) {
426 rctx->op.kex.exchange = pctx->op.kex.exchange;
427 if (!EVP_KEYEXCH_up_ref(rctx->op.kex.exchange)) {
432 if (pctx->op.kex.exchprovctx != NULL) {
433 if (!ossl_assert(pctx->op.kex.exchange != NULL))
435 rctx->op.kex.exchprovctx
436 = pctx->op.kex.exchange->dupctx(pctx->op.kex.exchprovctx);
437 if (rctx->op.kex.exchprovctx == NULL) {
438 EVP_KEYEXCH_free(rctx->op.kex.exchange);
444 } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)) {
445 if (pctx->op.sig.signature != NULL) {
446 rctx->op.sig.signature = pctx->op.sig.signature;
447 if (!EVP_SIGNATURE_up_ref(rctx->op.sig.signature)) {
452 if (pctx->op.sig.sigprovctx != NULL) {
453 if (!ossl_assert(pctx->op.sig.signature != NULL))
455 rctx->op.sig.sigprovctx
456 = pctx->op.sig.signature->dupctx(pctx->op.sig.sigprovctx);
457 if (rctx->op.sig.sigprovctx == NULL) {
458 EVP_SIGNATURE_free(rctx->op.sig.signature);
464 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(pctx)) {
465 if (pctx->op.ciph.cipher != NULL) {
466 rctx->op.ciph.cipher = pctx->op.ciph.cipher;
467 if (!EVP_ASYM_CIPHER_up_ref(rctx->op.ciph.cipher)) {
472 if (pctx->op.ciph.ciphprovctx != NULL) {
473 if (!ossl_assert(pctx->op.ciph.cipher != NULL))
475 rctx->op.ciph.ciphprovctx
476 = pctx->op.ciph.cipher->dupctx(pctx->op.ciph.ciphprovctx);
477 if (rctx->op.ciph.ciphprovctx == NULL) {
478 EVP_ASYM_CIPHER_free(rctx->op.ciph.cipher);
486 rctx->pmeth = pctx->pmeth;
487 # ifndef OPENSSL_NO_ENGINE
488 rctx->engine = pctx->engine;
492 EVP_PKEY_up_ref(pctx->peerkey);
493 rctx->peerkey = pctx->peerkey;
495 if (pctx->pmeth->copy(rctx, pctx) > 0)
499 EVP_PKEY_CTX_free(rctx);
504 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
506 if (app_pkey_methods == NULL) {
507 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
508 if (app_pkey_methods == NULL){
509 EVPerr(EVP_F_EVP_PKEY_METH_ADD0, ERR_R_MALLOC_FAILURE);
513 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth)) {
514 EVPerr(EVP_F_EVP_PKEY_METH_ADD0, ERR_R_MALLOC_FAILURE);
517 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
521 void evp_app_cleanup_int(void)
523 if (app_pkey_methods != NULL)
524 sk_EVP_PKEY_METHOD_pop_free(app_pkey_methods, EVP_PKEY_meth_free);
527 int EVP_PKEY_meth_remove(const EVP_PKEY_METHOD *pmeth)
529 const EVP_PKEY_METHOD *ret;
531 ret = sk_EVP_PKEY_METHOD_delete_ptr(app_pkey_methods, pmeth);
533 return ret == NULL ? 0 : 1;
536 size_t EVP_PKEY_meth_get_count(void)
538 size_t rv = OSSL_NELEM(standard_methods);
540 if (app_pkey_methods)
541 rv += sk_EVP_PKEY_METHOD_num(app_pkey_methods);
545 const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx)
547 if (idx < OSSL_NELEM(standard_methods))
548 return (standard_methods[idx])();
549 if (app_pkey_methods == NULL)
551 idx -= OSSL_NELEM(standard_methods);
552 if (idx >= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods))
554 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
558 int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
560 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
561 && ctx->op.kex.exchprovctx != NULL
562 && ctx->op.kex.exchange != NULL
563 && ctx->op.kex.exchange->set_ctx_params != NULL)
564 return ctx->op.kex.exchange->set_ctx_params(ctx->op.kex.exchprovctx,
566 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
567 && ctx->op.sig.sigprovctx != NULL
568 && ctx->op.sig.signature != NULL
569 && ctx->op.sig.signature->set_ctx_params != NULL)
570 return ctx->op.sig.signature->set_ctx_params(ctx->op.sig.sigprovctx,
572 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
573 && ctx->op.ciph.ciphprovctx != NULL
574 && ctx->op.ciph.cipher != NULL
575 && ctx->op.ciph.cipher->set_ctx_params != NULL)
576 return ctx->op.ciph.cipher->set_ctx_params(ctx->op.ciph.ciphprovctx,
582 int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
584 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
585 && ctx->op.sig.sigprovctx != NULL
586 && ctx->op.sig.signature != NULL
587 && ctx->op.sig.signature->get_ctx_params != NULL)
588 return ctx->op.sig.signature->get_ctx_params(ctx->op.sig.sigprovctx,
590 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
591 && ctx->op.ciph.ciphprovctx != NULL
592 && ctx->op.ciph.cipher != NULL
593 && ctx->op.ciph.cipher->get_ctx_params != NULL)
594 return ctx->op.ciph.cipher->get_ctx_params(ctx->op.ciph.ciphprovctx,
599 const OSSL_PARAM *EVP_PKEY_CTX_gettable_params(EVP_PKEY_CTX *ctx)
601 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
602 && ctx->op.sig.signature != NULL
603 && ctx->op.sig.signature->gettable_ctx_params != NULL)
604 return ctx->op.sig.signature->gettable_ctx_params();
606 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
607 && ctx->op.ciph.cipher != NULL
608 && ctx->op.ciph.cipher->gettable_ctx_params != NULL)
609 return ctx->op.ciph.cipher->gettable_ctx_params();
614 const OSSL_PARAM *EVP_PKEY_CTX_settable_params(EVP_PKEY_CTX *ctx)
616 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
617 && ctx->op.kex.exchange != NULL
618 && ctx->op.kex.exchange->settable_ctx_params != NULL)
619 return ctx->op.kex.exchange->settable_ctx_params();
620 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
621 && ctx->op.sig.signature != NULL
622 && ctx->op.sig.signature->settable_ctx_params != NULL)
623 return ctx->op.sig.signature->settable_ctx_params();
624 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
625 && ctx->op.ciph.cipher != NULL
626 && ctx->op.ciph.cipher->settable_ctx_params != NULL)
627 return ctx->op.ciph.cipher->settable_ctx_params();
632 # ifndef OPENSSL_NO_DH
633 int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad)
635 OSSL_PARAM dh_pad_params[2];
636 unsigned int upad = pad;
638 /* We use EVP_PKEY_CTX_ctrl return values */
639 if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
640 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
644 /* TODO(3.0): Remove this eventually when no more legacy */
645 if (ctx->op.kex.exchprovctx == NULL)
646 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_DERIVE,
647 EVP_PKEY_CTRL_DH_PAD, pad, NULL);
649 dh_pad_params[0] = OSSL_PARAM_construct_uint(OSSL_EXCHANGE_PARAM_PAD, &upad);
650 dh_pad_params[1] = OSSL_PARAM_construct_end();
652 return EVP_PKEY_CTX_set_params(ctx, dh_pad_params);
656 int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
658 OSSL_PARAM sig_md_params[3], *p = sig_md_params;
659 /* 80 should be big enough */
663 if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
664 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
665 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
669 /* TODO(3.0): Remove this eventually when no more legacy */
670 if (ctx->op.sig.sigprovctx == NULL)
671 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
672 EVP_PKEY_CTRL_GET_MD, 0, (void *)(md));
674 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
677 *p++ = OSSL_PARAM_construct_end();
679 if (!EVP_PKEY_CTX_get_params(ctx, sig_md_params))
682 tmp = evp_get_digestbyname_ex(ctx->libctx, name);
691 int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
693 OSSL_PARAM sig_md_params[3], *p = sig_md_params;
697 if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
698 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
699 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
703 /* TODO(3.0): Remove this eventually when no more legacy */
704 if (ctx->op.sig.sigprovctx == NULL)
705 return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
706 EVP_PKEY_CTRL_MD, 0, (void *)(md));
712 mdsize = EVP_MD_size(md);
713 name = EVP_MD_name(md);
716 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
718 * Cast away the const. This is read
719 * only so should be safe
723 *p++ = OSSL_PARAM_construct_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE,
725 *p++ = OSSL_PARAM_construct_end();
727 return EVP_PKEY_CTX_set_params(ctx, sig_md_params);
730 static int legacy_ctrl_to_param(EVP_PKEY_CTX *ctx, int keytype, int optype,
731 int cmd, int p1, void *p2)
734 # ifndef OPENSSL_NO_DH
735 case EVP_PKEY_CTRL_DH_PAD:
736 return EVP_PKEY_CTX_set_dh_pad(ctx, p1);
738 case EVP_PKEY_CTRL_MD:
739 return EVP_PKEY_CTX_set_signature_md(ctx, p2);
740 case EVP_PKEY_CTRL_GET_MD:
741 return EVP_PKEY_CTX_get_signature_md(ctx, p2);
742 case EVP_PKEY_CTRL_RSA_PADDING:
743 return EVP_PKEY_CTX_set_rsa_padding(ctx, p1);
744 case EVP_PKEY_CTRL_GET_RSA_PADDING:
745 return EVP_PKEY_CTX_get_rsa_padding(ctx, p2);
746 case EVP_PKEY_CTRL_RSA_OAEP_MD:
747 return EVP_PKEY_CTX_set_rsa_oaep_md(ctx, p2);
748 case EVP_PKEY_CTRL_GET_RSA_OAEP_MD:
749 return EVP_PKEY_CTX_get_rsa_oaep_md(ctx, p2);
750 case EVP_PKEY_CTRL_RSA_MGF1_MD:
751 return EVP_PKEY_CTX_set_rsa_oaep_md(ctx, p2);
752 case EVP_PKEY_CTRL_GET_RSA_MGF1_MD:
753 return EVP_PKEY_CTX_get_rsa_oaep_md(ctx, p2);
754 case EVP_PKEY_CTRL_RSA_OAEP_LABEL:
755 return EVP_PKEY_CTX_set0_rsa_oaep_label(ctx, p2, p1);
756 case EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL:
757 return EVP_PKEY_CTX_get0_rsa_oaep_label(ctx, (unsigned char **)p2);
758 case EVP_PKEY_CTRL_PKCS7_ENCRYPT:
759 case EVP_PKEY_CTRL_PKCS7_DECRYPT:
760 # ifndef OPENSSL_NO_CMS
761 case EVP_PKEY_CTRL_CMS_DECRYPT:
762 case EVP_PKEY_CTRL_CMS_ENCRYPT:
764 if (ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
766 ERR_raise(ERR_LIB_EVP,
767 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
773 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
774 int cmd, int p1, void *p2)
779 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
783 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx) && ctx->op.kex.exchprovctx != NULL)
784 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
785 && ctx->op.sig.sigprovctx != NULL)
786 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
787 && ctx->op.ciph.ciphprovctx != NULL))
788 return legacy_ctrl_to_param(ctx, keytype, optype, cmd, p1, p2);
790 if (ctx->pmeth == NULL || ctx->pmeth->ctrl == NULL) {
791 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
794 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
797 /* Skip the operation checks since this is called in a very early stage */
798 if (ctx->pmeth->digest_custom != NULL)
801 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
802 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
806 if ((optype != -1) && !(ctx->operation & optype)) {
807 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
812 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
815 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
820 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
821 int cmd, uint64_t value)
823 return EVP_PKEY_CTX_ctrl(ctx, keytype, optype, cmd, 0, &value);
826 static int legacy_ctrl_str_to_param(EVP_PKEY_CTX *ctx, const char *name,
829 # ifndef OPENSSL_NO_DH
830 if (strcmp(name, "dh_pad") == 0) {
834 return EVP_PKEY_CTX_set_dh_pad(ctx, pad);
837 if (strcmp(name, "digest") == 0) {
841 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) || ctx->op.sig.signature == NULL)
843 md = EVP_MD_fetch(ossl_provider_library_context(ctx->op.sig.signature->prov),
847 ret = EVP_PKEY_CTX_set_signature_md(ctx, md);
848 EVP_MD_meth_free(md);
852 if (strcmp(name, "rsa_padding_mode") == 0) {
855 if (strcmp(value, "pkcs1") == 0) {
856 pm = RSA_PKCS1_PADDING;
857 } else if (strcmp(value, "sslv23") == 0) {
858 pm = RSA_SSLV23_PADDING;
859 } else if (strcmp(value, "none") == 0) {
861 } else if (strcmp(value, "oeap") == 0) {
862 pm = RSA_PKCS1_OAEP_PADDING;
863 } else if (strcmp(value, "oaep") == 0) {
864 pm = RSA_PKCS1_OAEP_PADDING;
865 } else if (strcmp(value, "x931") == 0) {
866 pm = RSA_X931_PADDING;
867 } else if (strcmp(value, "pss") == 0) {
868 pm = RSA_PKCS1_PSS_PADDING;
870 ERR_raise(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE);
873 return EVP_PKEY_CTX_set_rsa_padding(ctx, pm);
876 if (strcmp(name, "rsa_mgf1_md") == 0)
877 return EVP_PKEY_CTX_set_rsa_mgf1_md_name(ctx, value, NULL);
879 if (strcmp(name, "rsa_oaep_md") == 0)
880 return EVP_PKEY_CTX_set_rsa_oaep_md_name(ctx, value, NULL);
882 if (strcmp(name, "rsa_oaep_label") == 0) {
887 lab = OPENSSL_hexstr2buf(value, &lablen);
890 ret = EVP_PKEY_CTX_set0_rsa_oaep_label(ctx, lab, lablen);
901 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
902 const char *name, const char *value)
905 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
909 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx) && ctx->op.kex.exchprovctx != NULL)
910 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
911 && ctx->op.sig.sigprovctx != NULL)
912 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
913 && ctx->op.ciph.ciphprovctx != NULL))
914 return legacy_ctrl_str_to_param(ctx, name, value);
916 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
917 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
920 if (strcmp(name, "digest") == 0)
921 return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD,
923 return ctx->pmeth->ctrl_str(ctx, name, value);
926 /* Utility functions to send a string of hex string to a ctrl */
928 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
935 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
938 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
944 bin = OPENSSL_hexstr2buf(hex, &binlen);
947 if (binlen <= INT_MAX)
948 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
953 /* Pass a message digest to a ctrl */
954 int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md)
958 if (md == NULL || (m = EVP_get_digestbyname(md)) == NULL) {
959 EVPerr(EVP_F_EVP_PKEY_CTX_MD, EVP_R_INVALID_DIGEST);
962 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)m);
965 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
967 return ctx->operation;
970 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
972 ctx->keygen_info = dat;
973 ctx->keygen_info_count = datlen;
976 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
981 void *EVP_PKEY_CTX_get_data(const EVP_PKEY_CTX *ctx)
986 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
991 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
996 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
998 ctx->app_data = data;
1001 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
1003 return ctx->app_data;
1006 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
1007 int (*init) (EVP_PKEY_CTX *ctx))
1012 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
1013 int (*copy) (EVP_PKEY_CTX *dst,
1014 const EVP_PKEY_CTX *src))
1019 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
1020 void (*cleanup) (EVP_PKEY_CTX *ctx))
1022 pmeth->cleanup = cleanup;
1025 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
1026 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
1027 int (*paramgen) (EVP_PKEY_CTX *ctx,
1030 pmeth->paramgen_init = paramgen_init;
1031 pmeth->paramgen = paramgen;
1034 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
1035 int (*keygen_init) (EVP_PKEY_CTX *ctx),
1036 int (*keygen) (EVP_PKEY_CTX *ctx,
1039 pmeth->keygen_init = keygen_init;
1040 pmeth->keygen = keygen;
1043 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
1044 int (*sign_init) (EVP_PKEY_CTX *ctx),
1045 int (*sign) (EVP_PKEY_CTX *ctx,
1046 unsigned char *sig, size_t *siglen,
1047 const unsigned char *tbs,
1050 pmeth->sign_init = sign_init;
1054 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
1055 int (*verify_init) (EVP_PKEY_CTX *ctx),
1056 int (*verify) (EVP_PKEY_CTX *ctx,
1057 const unsigned char *sig,
1059 const unsigned char *tbs,
1062 pmeth->verify_init = verify_init;
1063 pmeth->verify = verify;
1066 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
1067 int (*verify_recover_init) (EVP_PKEY_CTX
1069 int (*verify_recover) (EVP_PKEY_CTX
1078 pmeth->verify_recover_init = verify_recover_init;
1079 pmeth->verify_recover = verify_recover;
1082 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
1083 int (*signctx_init) (EVP_PKEY_CTX *ctx,
1085 int (*signctx) (EVP_PKEY_CTX *ctx,
1090 pmeth->signctx_init = signctx_init;
1091 pmeth->signctx = signctx;
1094 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
1095 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
1097 int (*verifyctx) (EVP_PKEY_CTX *ctx,
1098 const unsigned char *sig,
1102 pmeth->verifyctx_init = verifyctx_init;
1103 pmeth->verifyctx = verifyctx;
1106 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
1107 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
1108 int (*encryptfn) (EVP_PKEY_CTX *ctx,
1111 const unsigned char *in,
1114 pmeth->encrypt_init = encrypt_init;
1115 pmeth->encrypt = encryptfn;
1118 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
1119 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
1120 int (*decrypt) (EVP_PKEY_CTX *ctx,
1123 const unsigned char *in,
1126 pmeth->decrypt_init = decrypt_init;
1127 pmeth->decrypt = decrypt;
1130 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
1131 int (*derive_init) (EVP_PKEY_CTX *ctx),
1132 int (*derive) (EVP_PKEY_CTX *ctx,
1136 pmeth->derive_init = derive_init;
1137 pmeth->derive = derive;
1140 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
1141 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1143 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
1148 pmeth->ctrl_str = ctrl_str;
1151 void EVP_PKEY_meth_set_digestsign(EVP_PKEY_METHOD *pmeth,
1152 int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1153 const unsigned char *tbs, size_t tbslen))
1155 pmeth->digestsign = digestsign;
1158 void EVP_PKEY_meth_set_digestverify(EVP_PKEY_METHOD *pmeth,
1159 int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1160 size_t siglen, const unsigned char *tbs,
1163 pmeth->digestverify = digestverify;
1166 void EVP_PKEY_meth_set_check(EVP_PKEY_METHOD *pmeth,
1167 int (*check) (EVP_PKEY *pkey))
1169 pmeth->check = check;
1172 void EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD *pmeth,
1173 int (*check) (EVP_PKEY *pkey))
1175 pmeth->public_check = check;
1178 void EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD *pmeth,
1179 int (*check) (EVP_PKEY *pkey))
1181 pmeth->param_check = check;
1184 void EVP_PKEY_meth_set_digest_custom(EVP_PKEY_METHOD *pmeth,
1185 int (*digest_custom) (EVP_PKEY_CTX *ctx,
1188 pmeth->digest_custom = digest_custom;
1191 void EVP_PKEY_meth_get_init(const EVP_PKEY_METHOD *pmeth,
1192 int (**pinit) (EVP_PKEY_CTX *ctx))
1194 *pinit = pmeth->init;
1197 void EVP_PKEY_meth_get_copy(const EVP_PKEY_METHOD *pmeth,
1198 int (**pcopy) (EVP_PKEY_CTX *dst,
1199 const EVP_PKEY_CTX *src))
1201 *pcopy = pmeth->copy;
1204 void EVP_PKEY_meth_get_cleanup(const EVP_PKEY_METHOD *pmeth,
1205 void (**pcleanup) (EVP_PKEY_CTX *ctx))
1207 *pcleanup = pmeth->cleanup;
1210 void EVP_PKEY_meth_get_paramgen(const EVP_PKEY_METHOD *pmeth,
1211 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
1212 int (**pparamgen) (EVP_PKEY_CTX *ctx,
1216 *pparamgen_init = pmeth->paramgen_init;
1218 *pparamgen = pmeth->paramgen;
1221 void EVP_PKEY_meth_get_keygen(const EVP_PKEY_METHOD *pmeth,
1222 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
1223 int (**pkeygen) (EVP_PKEY_CTX *ctx,
1227 *pkeygen_init = pmeth->keygen_init;
1229 *pkeygen = pmeth->keygen;
1232 void EVP_PKEY_meth_get_sign(const EVP_PKEY_METHOD *pmeth,
1233 int (**psign_init) (EVP_PKEY_CTX *ctx),
1234 int (**psign) (EVP_PKEY_CTX *ctx,
1235 unsigned char *sig, size_t *siglen,
1236 const unsigned char *tbs,
1240 *psign_init = pmeth->sign_init;
1242 *psign = pmeth->sign;
1245 void EVP_PKEY_meth_get_verify(const EVP_PKEY_METHOD *pmeth,
1246 int (**pverify_init) (EVP_PKEY_CTX *ctx),
1247 int (**pverify) (EVP_PKEY_CTX *ctx,
1248 const unsigned char *sig,
1250 const unsigned char *tbs,
1254 *pverify_init = pmeth->verify_init;
1256 *pverify = pmeth->verify;
1259 void EVP_PKEY_meth_get_verify_recover(const EVP_PKEY_METHOD *pmeth,
1260 int (**pverify_recover_init) (EVP_PKEY_CTX
1262 int (**pverify_recover) (EVP_PKEY_CTX
1271 if (pverify_recover_init)
1272 *pverify_recover_init = pmeth->verify_recover_init;
1273 if (pverify_recover)
1274 *pverify_recover = pmeth->verify_recover;
1277 void EVP_PKEY_meth_get_signctx(const EVP_PKEY_METHOD *pmeth,
1278 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
1280 int (**psignctx) (EVP_PKEY_CTX *ctx,
1286 *psignctx_init = pmeth->signctx_init;
1288 *psignctx = pmeth->signctx;
1291 void EVP_PKEY_meth_get_verifyctx(const EVP_PKEY_METHOD *pmeth,
1292 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
1294 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
1295 const unsigned char *sig,
1299 if (pverifyctx_init)
1300 *pverifyctx_init = pmeth->verifyctx_init;
1302 *pverifyctx = pmeth->verifyctx;
1305 void EVP_PKEY_meth_get_encrypt(const EVP_PKEY_METHOD *pmeth,
1306 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
1307 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
1310 const unsigned char *in,
1314 *pencrypt_init = pmeth->encrypt_init;
1316 *pencryptfn = pmeth->encrypt;
1319 void EVP_PKEY_meth_get_decrypt(const EVP_PKEY_METHOD *pmeth,
1320 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
1321 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
1324 const unsigned char *in,
1328 *pdecrypt_init = pmeth->decrypt_init;
1330 *pdecrypt = pmeth->decrypt;
1333 void EVP_PKEY_meth_get_derive(const EVP_PKEY_METHOD *pmeth,
1334 int (**pderive_init) (EVP_PKEY_CTX *ctx),
1335 int (**pderive) (EVP_PKEY_CTX *ctx,
1340 *pderive_init = pmeth->derive_init;
1342 *pderive = pmeth->derive;
1345 void EVP_PKEY_meth_get_ctrl(const EVP_PKEY_METHOD *pmeth,
1346 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1348 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
1353 *pctrl = pmeth->ctrl;
1355 *pctrl_str = pmeth->ctrl_str;
1358 void EVP_PKEY_meth_get_digestsign(EVP_PKEY_METHOD *pmeth,
1359 int (**digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1360 const unsigned char *tbs, size_t tbslen))
1363 *digestsign = pmeth->digestsign;
1366 void EVP_PKEY_meth_get_digestverify(EVP_PKEY_METHOD *pmeth,
1367 int (**digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1368 size_t siglen, const unsigned char *tbs,
1372 *digestverify = pmeth->digestverify;
1375 void EVP_PKEY_meth_get_check(const EVP_PKEY_METHOD *pmeth,
1376 int (**pcheck) (EVP_PKEY *pkey))
1379 *pcheck = pmeth->check;
1382 void EVP_PKEY_meth_get_public_check(const EVP_PKEY_METHOD *pmeth,
1383 int (**pcheck) (EVP_PKEY *pkey))
1386 *pcheck = pmeth->public_check;
1389 void EVP_PKEY_meth_get_param_check(const EVP_PKEY_METHOD *pmeth,
1390 int (**pcheck) (EVP_PKEY *pkey))
1393 *pcheck = pmeth->param_check;
1396 void EVP_PKEY_meth_get_digest_custom(EVP_PKEY_METHOD *pmeth,
1397 int (**pdigest_custom) (EVP_PKEY_CTX *ctx,
1400 if (pdigest_custom != NULL)
1401 *pdigest_custom = pmeth->digest_custom;
1404 #endif /* FIPS_MODE */