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 "internal/cryptlib.h"
19 #include "crypto/asn1.h"
20 #include "crypto/evp.h"
21 #include "internal/numbers.h"
22 #include "internal/provider.h"
23 #include "evp_local.h"
25 typedef const EVP_PKEY_METHOD
*(*pmeth_fn
)(void);
26 typedef int sk_cmp_fn_type(const char *const *a
, const char *const *b
);
28 static STACK_OF(EVP_PKEY_METHOD
) *app_pkey_methods
= NULL
;
30 /* This array needs to be in order of NIDs */
31 static pmeth_fn standard_methods
[] = {
32 #ifndef OPENSSL_NO_RSA
38 #ifndef OPENSSL_NO_DSA
45 #ifndef OPENSSL_NO_CMAC
48 #ifndef OPENSSL_NO_RSA
54 #ifndef OPENSSL_NO_SCRYPT
63 #ifndef OPENSSL_NO_POLY1305
66 #ifndef OPENSSL_NO_SIPHASH
73 #ifndef OPENSSL_NO_SM2
78 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD
*, pmeth_fn
, pmeth_func
);
80 static int pmeth_func_cmp(const EVP_PKEY_METHOD
*const *a
, pmeth_fn
const *b
)
82 return ((*a
)->pkey_id
- ((**b
)())->pkey_id
);
85 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD
*, pmeth_fn
, pmeth_func
);
87 static int pmeth_cmp(const EVP_PKEY_METHOD
*const *a
,
88 const EVP_PKEY_METHOD
*const *b
)
90 return ((*a
)->pkey_id
- (*b
)->pkey_id
);
93 const EVP_PKEY_METHOD
*EVP_PKEY_meth_find(int type
)
97 const EVP_PKEY_METHOD
*t
= &tmp
;
100 if (app_pkey_methods
) {
102 idx
= sk_EVP_PKEY_METHOD_find(app_pkey_methods
, &tmp
);
104 return sk_EVP_PKEY_METHOD_value(app_pkey_methods
, idx
);
106 ret
= OBJ_bsearch_pmeth_func(&t
, standard_methods
,
107 sizeof(standard_methods
) /
109 if (ret
== NULL
|| *ret
== NULL
)
114 static EVP_PKEY_CTX
*int_ctx_new(OPENSSL_CTX
*libctx
,
115 EVP_PKEY
*pkey
, ENGINE
*e
,
116 const char *name
, const char *propquery
,
120 const EVP_PKEY_METHOD
*pmeth
= NULL
;
123 * When using providers, the context is bound to the algo implementation
126 if (pkey
== NULL
&& e
== NULL
&& id
== -1)
129 /* TODO(3.0) Legacy code should be removed when all is provider based */
138 * Here, we extract what information we can for the purpose of
139 * supporting usage with implementations from providers, to make
140 * for a smooth transition from legacy stuff to provider based stuff.
142 * If an engine is given, this is entirely legacy, and we should not
143 * pretend anything else, so we only set the name when no engine is
144 * given. If both are already given, someone made a mistake, and
145 * since that can only happen internally, it's safe to make an
148 if (!ossl_assert(e
== NULL
|| name
== NULL
))
151 name
= OBJ_nid2sn(id
);
154 * We were called using legacy data, or an EVP_PKEY, but an EVP_PKEY
155 * isn't tied to a specific library context, so we fall back to the
156 * default library context.
157 * TODO(v3.0): an EVP_PKEY that doesn't originate from a leagacy key
158 * structure only has the pkeys[] cache, where the first element is
159 * considered the "origin". Investigate if that could be a suitable
160 * way to find a library context.
164 #ifndef OPENSSL_NO_ENGINE
165 if (e
== NULL
&& pkey
!= NULL
)
166 e
= pkey
->pmeth_engine
!= NULL
? pkey
->pmeth_engine
: pkey
->engine
;
167 /* Try to find an ENGINE which implements this method */
169 if (!ENGINE_init(e
)) {
170 EVPerr(EVP_F_INT_CTX_NEW
, ERR_R_ENGINE_LIB
);
174 e
= ENGINE_get_pkey_meth_engine(id
);
178 * If an ENGINE handled this method look it up. Otherwise use internal
182 pmeth
= ENGINE_get_pkey_meth(e
, id
);
185 pmeth
= EVP_PKEY_meth_find(id
);
188 #ifndef OPENSSL_NO_ENGINE
191 EVPerr(EVP_F_INT_CTX_NEW
, EVP_R_UNSUPPORTED_ALGORITHM
);
197 ret
= OPENSSL_zalloc(sizeof(*ret
));
199 #ifndef OPENSSL_NO_ENGINE
202 EVPerr(EVP_F_INT_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
205 ret
->libctx
= libctx
;
206 ret
->algorithm
= name
;
207 ret
->propquery
= propquery
;
210 ret
->operation
= EVP_PKEY_OP_UNDEFINED
;
213 EVP_PKEY_up_ref(pkey
);
215 if (pmeth
!= NULL
&& pmeth
->init
!= NULL
) {
216 if (pmeth
->init(ret
) <= 0) {
218 EVP_PKEY_CTX_free(ret
);
226 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX
*ctx
)
228 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx
)) {
229 if (ctx
->op
.kex
.exchprovctx
!= NULL
&& ctx
->op
.kex
.exchange
!= NULL
)
230 ctx
->op
.kex
.exchange
->freectx(ctx
->op
.kex
.exchprovctx
);
231 EVP_KEYEXCH_free(ctx
->op
.kex
.exchange
);
232 ctx
->op
.kex
.exchprovctx
= NULL
;
233 ctx
->op
.kex
.exchange
= NULL
;
234 } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)) {
235 if (ctx
->op
.sig
.sigprovctx
!= NULL
&& ctx
->op
.sig
.signature
!= NULL
)
236 ctx
->op
.sig
.signature
->freectx(ctx
->op
.sig
.sigprovctx
);
237 EVP_SIGNATURE_free(ctx
->op
.sig
.signature
);
238 ctx
->op
.sig
.sigprovctx
= NULL
;
239 ctx
->op
.sig
.signature
= NULL
;
240 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)) {
241 if (ctx
->op
.ciph
.ciphprovctx
!= NULL
&& ctx
->op
.ciph
.cipher
!= NULL
)
242 ctx
->op
.ciph
.cipher
->freectx(ctx
->op
.ciph
.ciphprovctx
);
243 EVP_ASYM_CIPHER_free(ctx
->op
.ciph
.cipher
);
244 ctx
->op
.ciph
.ciphprovctx
= NULL
;
245 ctx
->op
.ciph
.cipher
= NULL
;
249 EVP_PKEY_METHOD
*EVP_PKEY_meth_new(int id
, int flags
)
251 EVP_PKEY_METHOD
*pmeth
;
253 pmeth
= OPENSSL_zalloc(sizeof(*pmeth
));
255 EVPerr(EVP_F_EVP_PKEY_METH_NEW
, ERR_R_MALLOC_FAILURE
);
260 pmeth
->flags
= flags
| EVP_PKEY_FLAG_DYNAMIC
;
264 void EVP_PKEY_meth_get0_info(int *ppkey_id
, int *pflags
,
265 const EVP_PKEY_METHOD
*meth
)
268 *ppkey_id
= meth
->pkey_id
;
270 *pflags
= meth
->flags
;
273 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD
*dst
, const EVP_PKEY_METHOD
*src
)
276 dst
->init
= src
->init
;
277 dst
->copy
= src
->copy
;
278 dst
->cleanup
= src
->cleanup
;
280 dst
->paramgen_init
= src
->paramgen_init
;
281 dst
->paramgen
= src
->paramgen
;
283 dst
->keygen_init
= src
->keygen_init
;
284 dst
->keygen
= src
->keygen
;
286 dst
->sign_init
= src
->sign_init
;
287 dst
->sign
= src
->sign
;
289 dst
->verify_init
= src
->verify_init
;
290 dst
->verify
= src
->verify
;
292 dst
->verify_recover_init
= src
->verify_recover_init
;
293 dst
->verify_recover
= src
->verify_recover
;
295 dst
->signctx_init
= src
->signctx_init
;
296 dst
->signctx
= src
->signctx
;
298 dst
->verifyctx_init
= src
->verifyctx_init
;
299 dst
->verifyctx
= src
->verifyctx
;
301 dst
->encrypt_init
= src
->encrypt_init
;
302 dst
->encrypt
= src
->encrypt
;
304 dst
->decrypt_init
= src
->decrypt_init
;
305 dst
->decrypt
= src
->decrypt
;
307 dst
->derive_init
= src
->derive_init
;
308 dst
->derive
= src
->derive
;
310 dst
->ctrl
= src
->ctrl
;
311 dst
->ctrl_str
= src
->ctrl_str
;
313 dst
->check
= src
->check
;
316 void EVP_PKEY_meth_free(EVP_PKEY_METHOD
*pmeth
)
318 if (pmeth
&& (pmeth
->flags
& EVP_PKEY_FLAG_DYNAMIC
))
322 EVP_PKEY_CTX
*EVP_PKEY_CTX_new(EVP_PKEY
*pkey
, ENGINE
*e
)
324 return int_ctx_new(NULL
, pkey
, e
, NULL
, NULL
, -1);
327 EVP_PKEY_CTX
*EVP_PKEY_CTX_new_id(int id
, ENGINE
*e
)
329 return int_ctx_new(NULL
, NULL
, e
, NULL
, NULL
, id
);
332 EVP_PKEY_CTX
*EVP_PKEY_CTX_new_provided(OPENSSL_CTX
*libctx
,
334 const char *propquery
)
336 return int_ctx_new(libctx
, NULL
, NULL
, name
, propquery
, -1);
339 EVP_PKEY_CTX
*EVP_PKEY_CTX_dup(const EVP_PKEY_CTX
*pctx
)
343 if (((pctx
->pmeth
== NULL
) || (pctx
->pmeth
->copy
== NULL
))
344 && ((EVP_PKEY_CTX_IS_DERIVE_OP(pctx
)
345 && pctx
->op
.kex
.exchprovctx
== NULL
)
346 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx
)
347 && pctx
->op
.sig
.sigprovctx
== NULL
)))
349 #ifndef OPENSSL_NO_ENGINE
350 /* Make sure it's safe to copy a pkey context using an ENGINE */
351 if (pctx
->engine
&& !ENGINE_init(pctx
->engine
)) {
352 EVPerr(EVP_F_EVP_PKEY_CTX_DUP
, ERR_R_ENGINE_LIB
);
356 rctx
= OPENSSL_zalloc(sizeof(*rctx
));
358 EVPerr(EVP_F_EVP_PKEY_CTX_DUP
, ERR_R_MALLOC_FAILURE
);
362 if (pctx
->pkey
!= NULL
)
363 EVP_PKEY_up_ref(pctx
->pkey
);
364 rctx
->pkey
= pctx
->pkey
;
365 rctx
->operation
= pctx
->operation
;
366 rctx
->libctx
= pctx
->libctx
;
367 rctx
->algorithm
= pctx
->algorithm
;
368 rctx
->propquery
= pctx
->propquery
;
370 if (EVP_PKEY_CTX_IS_DERIVE_OP(pctx
)) {
371 if (pctx
->op
.kex
.exchange
!= NULL
) {
372 rctx
->op
.kex
.exchange
= pctx
->op
.kex
.exchange
;
373 if (!EVP_KEYEXCH_up_ref(rctx
->op
.kex
.exchange
)) {
378 if (pctx
->op
.kex
.exchprovctx
!= NULL
) {
379 if (!ossl_assert(pctx
->op
.kex
.exchange
!= NULL
))
381 rctx
->op
.kex
.exchprovctx
382 = pctx
->op
.kex
.exchange
->dupctx(pctx
->op
.kex
.exchprovctx
);
383 if (rctx
->op
.kex
.exchprovctx
== NULL
) {
384 EVP_KEYEXCH_free(rctx
->op
.kex
.exchange
);
390 } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx
)) {
391 if (pctx
->op
.sig
.signature
!= NULL
) {
392 rctx
->op
.sig
.signature
= pctx
->op
.sig
.signature
;
393 if (!EVP_SIGNATURE_up_ref(rctx
->op
.sig
.signature
)) {
398 if (pctx
->op
.sig
.sigprovctx
!= NULL
) {
399 if (!ossl_assert(pctx
->op
.sig
.signature
!= NULL
))
401 rctx
->op
.sig
.sigprovctx
402 = pctx
->op
.sig
.signature
->dupctx(pctx
->op
.sig
.sigprovctx
);
403 if (rctx
->op
.sig
.sigprovctx
== NULL
) {
404 EVP_SIGNATURE_free(rctx
->op
.sig
.signature
);
410 } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(pctx
)) {
411 if (pctx
->op
.ciph
.cipher
!= NULL
) {
412 rctx
->op
.ciph
.cipher
= pctx
->op
.ciph
.cipher
;
413 if (!EVP_ASYM_CIPHER_up_ref(rctx
->op
.ciph
.cipher
)) {
418 if (pctx
->op
.ciph
.ciphprovctx
!= NULL
) {
419 if (!ossl_assert(pctx
->op
.ciph
.cipher
!= NULL
))
421 rctx
->op
.ciph
.ciphprovctx
422 = pctx
->op
.ciph
.cipher
->dupctx(pctx
->op
.ciph
.ciphprovctx
);
423 if (rctx
->op
.ciph
.ciphprovctx
== NULL
) {
424 EVP_ASYM_CIPHER_free(rctx
->op
.ciph
.cipher
);
432 rctx
->pmeth
= pctx
->pmeth
;
433 #ifndef OPENSSL_NO_ENGINE
434 rctx
->engine
= pctx
->engine
;
438 EVP_PKEY_up_ref(pctx
->peerkey
);
439 rctx
->peerkey
= pctx
->peerkey
;
441 if (pctx
->pmeth
->copy(rctx
, pctx
) > 0)
445 EVP_PKEY_CTX_free(rctx
);
450 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD
*pmeth
)
452 if (app_pkey_methods
== NULL
) {
453 app_pkey_methods
= sk_EVP_PKEY_METHOD_new(pmeth_cmp
);
454 if (app_pkey_methods
== NULL
){
455 EVPerr(EVP_F_EVP_PKEY_METH_ADD0
, ERR_R_MALLOC_FAILURE
);
459 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods
, pmeth
)) {
460 EVPerr(EVP_F_EVP_PKEY_METH_ADD0
, ERR_R_MALLOC_FAILURE
);
463 sk_EVP_PKEY_METHOD_sort(app_pkey_methods
);
467 void evp_app_cleanup_int(void)
469 if (app_pkey_methods
!= NULL
)
470 sk_EVP_PKEY_METHOD_pop_free(app_pkey_methods
, EVP_PKEY_meth_free
);
473 int EVP_PKEY_meth_remove(const EVP_PKEY_METHOD
*pmeth
)
475 const EVP_PKEY_METHOD
*ret
;
477 ret
= sk_EVP_PKEY_METHOD_delete_ptr(app_pkey_methods
, pmeth
);
479 return ret
== NULL
? 0 : 1;
482 size_t EVP_PKEY_meth_get_count(void)
484 size_t rv
= OSSL_NELEM(standard_methods
);
486 if (app_pkey_methods
)
487 rv
+= sk_EVP_PKEY_METHOD_num(app_pkey_methods
);
491 const EVP_PKEY_METHOD
*EVP_PKEY_meth_get0(size_t idx
)
493 if (idx
< OSSL_NELEM(standard_methods
))
494 return (standard_methods
[idx
])();
495 if (app_pkey_methods
== NULL
)
497 idx
-= OSSL_NELEM(standard_methods
);
498 if (idx
>= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods
))
500 return sk_EVP_PKEY_METHOD_value(app_pkey_methods
, idx
);
503 void EVP_PKEY_CTX_free(EVP_PKEY_CTX
*ctx
)
507 if (ctx
->pmeth
&& ctx
->pmeth
->cleanup
)
508 ctx
->pmeth
->cleanup(ctx
);
510 evp_pkey_ctx_free_old_ops(ctx
);
511 EVP_KEYMGMT_free(ctx
->keymgmt
);
513 EVP_PKEY_free(ctx
->pkey
);
514 EVP_PKEY_free(ctx
->peerkey
);
515 #ifndef OPENSSL_NO_ENGINE
516 ENGINE_finish(ctx
->engine
);
521 int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
)
523 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)
524 && ctx
->op
.sig
.sigprovctx
!= NULL
525 && ctx
->op
.sig
.signature
!= NULL
526 && ctx
->op
.sig
.signature
->get_ctx_params
!= NULL
)
527 return ctx
->op
.sig
.signature
->get_ctx_params(ctx
->op
.sig
.sigprovctx
,
529 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)
530 && ctx
->op
.ciph
.ciphprovctx
!= NULL
531 && ctx
->op
.ciph
.cipher
!= NULL
532 && ctx
->op
.ciph
.cipher
->get_ctx_params
!= NULL
)
533 return ctx
->op
.ciph
.cipher
->get_ctx_params(ctx
->op
.ciph
.ciphprovctx
,
538 const OSSL_PARAM
*EVP_PKEY_CTX_gettable_params(EVP_PKEY_CTX
*ctx
)
540 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)
541 && ctx
->op
.sig
.signature
!= NULL
542 && ctx
->op
.sig
.signature
->gettable_ctx_params
!= NULL
)
543 return ctx
->op
.sig
.signature
->gettable_ctx_params();
545 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)
546 && ctx
->op
.ciph
.cipher
!= NULL
547 && ctx
->op
.ciph
.cipher
->gettable_ctx_params
!= NULL
)
548 return ctx
->op
.ciph
.cipher
->gettable_ctx_params();
553 int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX
*ctx
, OSSL_PARAM
*params
)
555 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx
)
556 && ctx
->op
.kex
.exchprovctx
!= NULL
557 && ctx
->op
.kex
.exchange
!= NULL
558 && ctx
->op
.kex
.exchange
->set_ctx_params
!= NULL
)
559 return ctx
->op
.kex
.exchange
->set_ctx_params(ctx
->op
.kex
.exchprovctx
,
561 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)
562 && ctx
->op
.sig
.sigprovctx
!= NULL
563 && ctx
->op
.sig
.signature
!= NULL
564 && ctx
->op
.sig
.signature
->set_ctx_params
!= NULL
)
565 return ctx
->op
.sig
.signature
->set_ctx_params(ctx
->op
.sig
.sigprovctx
,
567 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)
568 && ctx
->op
.ciph
.ciphprovctx
!= NULL
569 && ctx
->op
.ciph
.cipher
!= NULL
570 && ctx
->op
.ciph
.cipher
->set_ctx_params
!= NULL
)
571 return ctx
->op
.ciph
.cipher
->set_ctx_params(ctx
->op
.ciph
.ciphprovctx
,
576 const OSSL_PARAM
*EVP_PKEY_CTX_settable_params(EVP_PKEY_CTX
*ctx
)
578 if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx
)
579 && ctx
->op
.kex
.exchange
!= NULL
580 && ctx
->op
.kex
.exchange
->settable_ctx_params
!= NULL
)
581 return ctx
->op
.kex
.exchange
->settable_ctx_params();
582 if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)
583 && ctx
->op
.sig
.signature
!= NULL
584 && ctx
->op
.sig
.signature
->settable_ctx_params
!= NULL
)
585 return ctx
->op
.sig
.signature
->settable_ctx_params();
586 if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)
587 && ctx
->op
.ciph
.cipher
!= NULL
588 && ctx
->op
.ciph
.cipher
->settable_ctx_params
!= NULL
)
589 return ctx
->op
.ciph
.cipher
->settable_ctx_params();
594 #ifndef OPENSSL_NO_DH
595 int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX
*ctx
, int pad
)
597 OSSL_PARAM dh_pad_params
[2];
598 unsigned int upad
= pad
;
600 /* We use EVP_PKEY_CTX_ctrl return values */
601 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_DERIVE_OP(ctx
)) {
602 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
606 /* TODO(3.0): Remove this eventually when no more legacy */
607 if (ctx
->op
.kex
.exchprovctx
== NULL
)
608 return EVP_PKEY_CTX_ctrl(ctx
, EVP_PKEY_DH
, EVP_PKEY_OP_DERIVE
,
609 EVP_PKEY_CTRL_DH_PAD
, pad
, NULL
);
611 dh_pad_params
[0] = OSSL_PARAM_construct_uint(OSSL_EXCHANGE_PARAM_PAD
, &upad
);
612 dh_pad_params
[1] = OSSL_PARAM_construct_end();
614 return EVP_PKEY_CTX_set_params(ctx
, dh_pad_params
);
618 int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
**md
)
620 OSSL_PARAM sig_md_params
[3], *p
= sig_md_params
;
621 /* 80 should be big enough */
625 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)) {
626 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
627 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
631 /* TODO(3.0): Remove this eventually when no more legacy */
632 if (ctx
->op
.sig
.sigprovctx
== NULL
)
633 return EVP_PKEY_CTX_ctrl(ctx
, -1, EVP_PKEY_OP_TYPE_SIG
,
634 EVP_PKEY_CTRL_GET_MD
, 0, (void *)(md
));
636 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
,
639 *p
++ = OSSL_PARAM_construct_end();
641 if (!EVP_PKEY_CTX_get_params(ctx
, sig_md_params
))
644 tmp
= evp_get_digestbyname_ex(ctx
->libctx
, name
);
653 int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
)
655 OSSL_PARAM sig_md_params
[3], *p
= sig_md_params
;
659 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)) {
660 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
661 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
665 /* TODO(3.0): Remove this eventually when no more legacy */
666 if (ctx
->op
.sig
.sigprovctx
== NULL
)
667 return EVP_PKEY_CTX_ctrl(ctx
, -1, EVP_PKEY_OP_TYPE_SIG
,
668 EVP_PKEY_CTRL_MD
, 0, (void *)(md
));
674 mdsize
= EVP_MD_size(md
);
675 name
= EVP_MD_name(md
);
678 *p
++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST
,
680 * Cast away the const. This is read
681 * only so should be safe
685 *p
++ = OSSL_PARAM_construct_size_t(OSSL_SIGNATURE_PARAM_DIGEST_SIZE
,
687 *p
++ = OSSL_PARAM_construct_end();
689 return EVP_PKEY_CTX_set_params(ctx
, sig_md_params
);
692 static int legacy_ctrl_to_param(EVP_PKEY_CTX
*ctx
, int keytype
, int optype
,
693 int cmd
, int p1
, void *p2
)
696 #ifndef OPENSSL_NO_DH
697 case EVP_PKEY_CTRL_DH_PAD
:
698 return EVP_PKEY_CTX_set_dh_pad(ctx
, p1
);
700 case EVP_PKEY_CTRL_MD
:
701 return EVP_PKEY_CTX_set_signature_md(ctx
, p2
);
702 case EVP_PKEY_CTRL_GET_MD
:
703 return EVP_PKEY_CTX_get_signature_md(ctx
, p2
);
708 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX
*ctx
, int keytype
, int optype
,
709 int cmd
, int p1
, void *p2
)
714 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_COMMAND_NOT_SUPPORTED
);
718 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx
) && ctx
->op
.kex
.exchprovctx
!= NULL
)
719 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)
720 && ctx
->op
.sig
.sigprovctx
!= NULL
)
721 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)
722 && ctx
->op
.ciph
.ciphprovctx
!= NULL
))
723 return legacy_ctrl_to_param(ctx
, keytype
, optype
, cmd
, p1
, p2
);
725 if (ctx
->pmeth
== NULL
|| ctx
->pmeth
->ctrl
== NULL
) {
726 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_COMMAND_NOT_SUPPORTED
);
729 if ((keytype
!= -1) && (ctx
->pmeth
->pkey_id
!= keytype
))
732 /* Skip the operation checks since this is called in a very early stage */
733 if (ctx
->pmeth
->digest_custom
!= NULL
)
736 if (ctx
->operation
== EVP_PKEY_OP_UNDEFINED
) {
737 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_NO_OPERATION_SET
);
741 if ((optype
!= -1) && !(ctx
->operation
& optype
)) {
742 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_INVALID_OPERATION
);
747 ret
= ctx
->pmeth
->ctrl(ctx
, cmd
, p1
, p2
);
750 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_COMMAND_NOT_SUPPORTED
);
755 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX
*ctx
, int keytype
, int optype
,
756 int cmd
, uint64_t value
)
758 return EVP_PKEY_CTX_ctrl(ctx
, keytype
, optype
, cmd
, 0, &value
);
761 static int legacy_ctrl_str_to_param(EVP_PKEY_CTX
*ctx
, const char *name
,
764 #ifndef OPENSSL_NO_DH
765 if (strcmp(name
, "dh_pad") == 0) {
769 return EVP_PKEY_CTX_set_dh_pad(ctx
, pad
);
772 if (strcmp(name
, "digest") == 0) {
776 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
) || ctx
->op
.sig
.signature
== NULL
)
778 md
= EVP_MD_fetch(ossl_provider_library_context(ctx
->op
.sig
.signature
->prov
),
782 ret
= EVP_PKEY_CTX_set_signature_md(ctx
, md
);
783 EVP_MD_meth_free(md
);
790 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX
*ctx
,
791 const char *name
, const char *value
)
794 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR
, EVP_R_COMMAND_NOT_SUPPORTED
);
798 if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx
) && ctx
->op
.kex
.exchprovctx
!= NULL
)
799 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx
)
800 && ctx
->op
.sig
.sigprovctx
!= NULL
)
801 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)
802 && ctx
->op
.ciph
.ciphprovctx
!= NULL
))
803 return legacy_ctrl_str_to_param(ctx
, name
, value
);
805 if (!ctx
|| !ctx
->pmeth
|| !ctx
->pmeth
->ctrl_str
) {
806 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR
, EVP_R_COMMAND_NOT_SUPPORTED
);
809 if (strcmp(name
, "digest") == 0)
810 return EVP_PKEY_CTX_md(ctx
, EVP_PKEY_OP_TYPE_SIG
, EVP_PKEY_CTRL_MD
,
812 return ctx
->pmeth
->ctrl_str(ctx
, name
, value
);
815 /* Utility functions to send a string of hex string to a ctrl */
817 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX
*ctx
, int cmd
, const char *str
)
824 return ctx
->pmeth
->ctrl(ctx
, cmd
, len
, (void *)str
);
827 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX
*ctx
, int cmd
, const char *hex
)
833 bin
= OPENSSL_hexstr2buf(hex
, &binlen
);
836 if (binlen
<= INT_MAX
)
837 rv
= ctx
->pmeth
->ctrl(ctx
, cmd
, binlen
, bin
);
842 /* Pass a message digest to a ctrl */
843 int EVP_PKEY_CTX_md(EVP_PKEY_CTX
*ctx
, int optype
, int cmd
, const char *md
)
847 if (md
== NULL
|| (m
= EVP_get_digestbyname(md
)) == NULL
) {
848 EVPerr(EVP_F_EVP_PKEY_CTX_MD
, EVP_R_INVALID_DIGEST
);
851 return EVP_PKEY_CTX_ctrl(ctx
, -1, optype
, cmd
, 0, (void *)m
);
854 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX
*ctx
)
856 return ctx
->operation
;
859 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX
*ctx
, int *dat
, int datlen
)
861 ctx
->keygen_info
= dat
;
862 ctx
->keygen_info_count
= datlen
;
865 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX
*ctx
, void *data
)
870 void *EVP_PKEY_CTX_get_data(const EVP_PKEY_CTX
*ctx
)
875 EVP_PKEY
*EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX
*ctx
)
880 EVP_PKEY
*EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX
*ctx
)
885 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX
*ctx
, void *data
)
887 ctx
->app_data
= data
;
890 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX
*ctx
)
892 return ctx
->app_data
;
895 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD
*pmeth
,
896 int (*init
) (EVP_PKEY_CTX
*ctx
))
901 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD
*pmeth
,
902 int (*copy
) (EVP_PKEY_CTX
*dst
,
903 const EVP_PKEY_CTX
*src
))
908 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD
*pmeth
,
909 void (*cleanup
) (EVP_PKEY_CTX
*ctx
))
911 pmeth
->cleanup
= cleanup
;
914 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD
*pmeth
,
915 int (*paramgen_init
) (EVP_PKEY_CTX
*ctx
),
916 int (*paramgen
) (EVP_PKEY_CTX
*ctx
,
919 pmeth
->paramgen_init
= paramgen_init
;
920 pmeth
->paramgen
= paramgen
;
923 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD
*pmeth
,
924 int (*keygen_init
) (EVP_PKEY_CTX
*ctx
),
925 int (*keygen
) (EVP_PKEY_CTX
*ctx
,
928 pmeth
->keygen_init
= keygen_init
;
929 pmeth
->keygen
= keygen
;
932 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD
*pmeth
,
933 int (*sign_init
) (EVP_PKEY_CTX
*ctx
),
934 int (*sign
) (EVP_PKEY_CTX
*ctx
,
935 unsigned char *sig
, size_t *siglen
,
936 const unsigned char *tbs
,
939 pmeth
->sign_init
= sign_init
;
943 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD
*pmeth
,
944 int (*verify_init
) (EVP_PKEY_CTX
*ctx
),
945 int (*verify
) (EVP_PKEY_CTX
*ctx
,
946 const unsigned char *sig
,
948 const unsigned char *tbs
,
951 pmeth
->verify_init
= verify_init
;
952 pmeth
->verify
= verify
;
955 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD
*pmeth
,
956 int (*verify_recover_init
) (EVP_PKEY_CTX
958 int (*verify_recover
) (EVP_PKEY_CTX
967 pmeth
->verify_recover_init
= verify_recover_init
;
968 pmeth
->verify_recover
= verify_recover
;
971 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD
*pmeth
,
972 int (*signctx_init
) (EVP_PKEY_CTX
*ctx
,
974 int (*signctx
) (EVP_PKEY_CTX
*ctx
,
979 pmeth
->signctx_init
= signctx_init
;
980 pmeth
->signctx
= signctx
;
983 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD
*pmeth
,
984 int (*verifyctx_init
) (EVP_PKEY_CTX
*ctx
,
986 int (*verifyctx
) (EVP_PKEY_CTX
*ctx
,
987 const unsigned char *sig
,
991 pmeth
->verifyctx_init
= verifyctx_init
;
992 pmeth
->verifyctx
= verifyctx
;
995 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD
*pmeth
,
996 int (*encrypt_init
) (EVP_PKEY_CTX
*ctx
),
997 int (*encryptfn
) (EVP_PKEY_CTX
*ctx
,
1000 const unsigned char *in
,
1003 pmeth
->encrypt_init
= encrypt_init
;
1004 pmeth
->encrypt
= encryptfn
;
1007 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD
*pmeth
,
1008 int (*decrypt_init
) (EVP_PKEY_CTX
*ctx
),
1009 int (*decrypt
) (EVP_PKEY_CTX
*ctx
,
1012 const unsigned char *in
,
1015 pmeth
->decrypt_init
= decrypt_init
;
1016 pmeth
->decrypt
= decrypt
;
1019 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD
*pmeth
,
1020 int (*derive_init
) (EVP_PKEY_CTX
*ctx
),
1021 int (*derive
) (EVP_PKEY_CTX
*ctx
,
1025 pmeth
->derive_init
= derive_init
;
1026 pmeth
->derive
= derive
;
1029 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD
*pmeth
,
1030 int (*ctrl
) (EVP_PKEY_CTX
*ctx
, int type
, int p1
,
1032 int (*ctrl_str
) (EVP_PKEY_CTX
*ctx
,
1037 pmeth
->ctrl_str
= ctrl_str
;
1040 void EVP_PKEY_meth_set_check(EVP_PKEY_METHOD
*pmeth
,
1041 int (*check
) (EVP_PKEY
*pkey
))
1043 pmeth
->check
= check
;
1046 void EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD
*pmeth
,
1047 int (*check
) (EVP_PKEY
*pkey
))
1049 pmeth
->public_check
= check
;
1052 void EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD
*pmeth
,
1053 int (*check
) (EVP_PKEY
*pkey
))
1055 pmeth
->param_check
= check
;
1058 void EVP_PKEY_meth_set_digest_custom(EVP_PKEY_METHOD
*pmeth
,
1059 int (*digest_custom
) (EVP_PKEY_CTX
*ctx
,
1062 pmeth
->digest_custom
= digest_custom
;
1065 void EVP_PKEY_meth_get_init(const EVP_PKEY_METHOD
*pmeth
,
1066 int (**pinit
) (EVP_PKEY_CTX
*ctx
))
1068 *pinit
= pmeth
->init
;
1071 void EVP_PKEY_meth_get_copy(const EVP_PKEY_METHOD
*pmeth
,
1072 int (**pcopy
) (EVP_PKEY_CTX
*dst
,
1073 const EVP_PKEY_CTX
*src
))
1075 *pcopy
= pmeth
->copy
;
1078 void EVP_PKEY_meth_get_cleanup(const EVP_PKEY_METHOD
*pmeth
,
1079 void (**pcleanup
) (EVP_PKEY_CTX
*ctx
))
1081 *pcleanup
= pmeth
->cleanup
;
1084 void EVP_PKEY_meth_get_paramgen(const EVP_PKEY_METHOD
*pmeth
,
1085 int (**pparamgen_init
) (EVP_PKEY_CTX
*ctx
),
1086 int (**pparamgen
) (EVP_PKEY_CTX
*ctx
,
1090 *pparamgen_init
= pmeth
->paramgen_init
;
1092 *pparamgen
= pmeth
->paramgen
;
1095 void EVP_PKEY_meth_get_keygen(const EVP_PKEY_METHOD
*pmeth
,
1096 int (**pkeygen_init
) (EVP_PKEY_CTX
*ctx
),
1097 int (**pkeygen
) (EVP_PKEY_CTX
*ctx
,
1101 *pkeygen_init
= pmeth
->keygen_init
;
1103 *pkeygen
= pmeth
->keygen
;
1106 void EVP_PKEY_meth_get_sign(const EVP_PKEY_METHOD
*pmeth
,
1107 int (**psign_init
) (EVP_PKEY_CTX
*ctx
),
1108 int (**psign
) (EVP_PKEY_CTX
*ctx
,
1109 unsigned char *sig
, size_t *siglen
,
1110 const unsigned char *tbs
,
1114 *psign_init
= pmeth
->sign_init
;
1116 *psign
= pmeth
->sign
;
1119 void EVP_PKEY_meth_get_verify(const EVP_PKEY_METHOD
*pmeth
,
1120 int (**pverify_init
) (EVP_PKEY_CTX
*ctx
),
1121 int (**pverify
) (EVP_PKEY_CTX
*ctx
,
1122 const unsigned char *sig
,
1124 const unsigned char *tbs
,
1128 *pverify_init
= pmeth
->verify_init
;
1130 *pverify
= pmeth
->verify
;
1133 void EVP_PKEY_meth_get_verify_recover(const EVP_PKEY_METHOD
*pmeth
,
1134 int (**pverify_recover_init
) (EVP_PKEY_CTX
1136 int (**pverify_recover
) (EVP_PKEY_CTX
1145 if (pverify_recover_init
)
1146 *pverify_recover_init
= pmeth
->verify_recover_init
;
1147 if (pverify_recover
)
1148 *pverify_recover
= pmeth
->verify_recover
;
1151 void EVP_PKEY_meth_get_signctx(const EVP_PKEY_METHOD
*pmeth
,
1152 int (**psignctx_init
) (EVP_PKEY_CTX
*ctx
,
1154 int (**psignctx
) (EVP_PKEY_CTX
*ctx
,
1160 *psignctx_init
= pmeth
->signctx_init
;
1162 *psignctx
= pmeth
->signctx
;
1165 void EVP_PKEY_meth_get_verifyctx(const EVP_PKEY_METHOD
*pmeth
,
1166 int (**pverifyctx_init
) (EVP_PKEY_CTX
*ctx
,
1168 int (**pverifyctx
) (EVP_PKEY_CTX
*ctx
,
1169 const unsigned char *sig
,
1173 if (pverifyctx_init
)
1174 *pverifyctx_init
= pmeth
->verifyctx_init
;
1176 *pverifyctx
= pmeth
->verifyctx
;
1179 void EVP_PKEY_meth_get_encrypt(const EVP_PKEY_METHOD
*pmeth
,
1180 int (**pencrypt_init
) (EVP_PKEY_CTX
*ctx
),
1181 int (**pencryptfn
) (EVP_PKEY_CTX
*ctx
,
1184 const unsigned char *in
,
1188 *pencrypt_init
= pmeth
->encrypt_init
;
1190 *pencryptfn
= pmeth
->encrypt
;
1193 void EVP_PKEY_meth_get_decrypt(const EVP_PKEY_METHOD
*pmeth
,
1194 int (**pdecrypt_init
) (EVP_PKEY_CTX
*ctx
),
1195 int (**pdecrypt
) (EVP_PKEY_CTX
*ctx
,
1198 const unsigned char *in
,
1202 *pdecrypt_init
= pmeth
->decrypt_init
;
1204 *pdecrypt
= pmeth
->decrypt
;
1207 void EVP_PKEY_meth_get_derive(const EVP_PKEY_METHOD
*pmeth
,
1208 int (**pderive_init
) (EVP_PKEY_CTX
*ctx
),
1209 int (**pderive
) (EVP_PKEY_CTX
*ctx
,
1214 *pderive_init
= pmeth
->derive_init
;
1216 *pderive
= pmeth
->derive
;
1219 void EVP_PKEY_meth_get_ctrl(const EVP_PKEY_METHOD
*pmeth
,
1220 int (**pctrl
) (EVP_PKEY_CTX
*ctx
, int type
, int p1
,
1222 int (**pctrl_str
) (EVP_PKEY_CTX
*ctx
,
1227 *pctrl
= pmeth
->ctrl
;
1229 *pctrl_str
= pmeth
->ctrl_str
;
1232 void EVP_PKEY_meth_get_check(const EVP_PKEY_METHOD
*pmeth
,
1233 int (**pcheck
) (EVP_PKEY
*pkey
))
1236 *pcheck
= pmeth
->check
;
1239 void EVP_PKEY_meth_get_public_check(const EVP_PKEY_METHOD
*pmeth
,
1240 int (**pcheck
) (EVP_PKEY
*pkey
))
1243 *pcheck
= pmeth
->public_check
;
1246 void EVP_PKEY_meth_get_param_check(const EVP_PKEY_METHOD
*pmeth
,
1247 int (**pcheck
) (EVP_PKEY
*pkey
))
1250 *pcheck
= pmeth
->param_check
;
1253 void EVP_PKEY_meth_get_digest_custom(EVP_PKEY_METHOD
*pmeth
,
1254 int (**pdigest_custom
) (EVP_PKEY_CTX
*ctx
,
1257 if (pdigest_custom
!= NULL
)
1258 *pdigest_custom
= pmeth
->digest_custom
;