2 * Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
12 #include "internal/cryptlib.h"
13 #include <openssl/engine.h>
14 #include <openssl/evp.h>
15 #include <openssl/x509v3.h>
16 #include "internal/asn1_int.h"
17 #include "internal/evp_int.h"
18 #include "internal/numbers.h"
20 typedef int sk_cmp_fn_type(const char *const *a
, const char *const *b
);
22 static STACK_OF(EVP_PKEY_METHOD
) *app_pkey_methods
= NULL
;
24 /* This array needs to be in order of NIDs */
25 static const EVP_PKEY_METHOD
*standard_methods
[] = {
26 #ifndef OPENSSL_NO_RSA
32 #ifndef OPENSSL_NO_DSA
39 #ifndef OPENSSL_NO_CMAC
42 #ifndef OPENSSL_NO_RSA
48 #ifndef OPENSSL_NO_SCRYPT
56 #ifndef OPENSSL_NO_POLY1305
59 #ifndef OPENSSL_NO_SIPHASH
67 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD
*, const EVP_PKEY_METHOD
*,
70 static int pmeth_cmp(const EVP_PKEY_METHOD
*const *a
,
71 const EVP_PKEY_METHOD
*const *b
)
73 return ((*a
)->pkey_id
- (*b
)->pkey_id
);
76 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD
*, const EVP_PKEY_METHOD
*,
79 const EVP_PKEY_METHOD
*EVP_PKEY_meth_find(int type
)
82 const EVP_PKEY_METHOD
*t
= &tmp
, **ret
;
84 if (app_pkey_methods
) {
86 idx
= sk_EVP_PKEY_METHOD_find(app_pkey_methods
, &tmp
);
88 return sk_EVP_PKEY_METHOD_value(app_pkey_methods
, idx
);
90 ret
= OBJ_bsearch_pmeth(&t
, standard_methods
,
91 sizeof(standard_methods
) /
92 sizeof(EVP_PKEY_METHOD
*));
98 static EVP_PKEY_CTX
*int_ctx_new(EVP_PKEY
*pkey
, ENGINE
*e
, int id
)
101 const EVP_PKEY_METHOD
*pmeth
;
103 if (!pkey
|| !pkey
->ameth
)
105 id
= pkey
->ameth
->pkey_id
;
107 #ifndef OPENSSL_NO_ENGINE
108 if (pkey
&& pkey
->engine
)
110 /* Try to find an ENGINE which implements this method */
112 if (!ENGINE_init(e
)) {
113 EVPerr(EVP_F_INT_CTX_NEW
, ERR_R_ENGINE_LIB
);
117 e
= ENGINE_get_pkey_meth_engine(id
);
120 * If an ENGINE handled this method look it up. Otherwise use internal
125 pmeth
= ENGINE_get_pkey_meth(e
, id
);
128 pmeth
= EVP_PKEY_meth_find(id
);
131 EVPerr(EVP_F_INT_CTX_NEW
, EVP_R_UNSUPPORTED_ALGORITHM
);
135 ret
= OPENSSL_zalloc(sizeof(*ret
));
137 #ifndef OPENSSL_NO_ENGINE
140 EVPerr(EVP_F_INT_CTX_NEW
, ERR_R_MALLOC_FAILURE
);
145 ret
->operation
= EVP_PKEY_OP_UNDEFINED
;
148 EVP_PKEY_up_ref(pkey
);
151 if (pmeth
->init(ret
) <= 0) {
153 EVP_PKEY_CTX_free(ret
);
161 EVP_PKEY_METHOD
*EVP_PKEY_meth_new(int id
, int flags
)
163 EVP_PKEY_METHOD
*pmeth
;
165 pmeth
= OPENSSL_zalloc(sizeof(*pmeth
));
170 pmeth
->flags
= flags
| EVP_PKEY_FLAG_DYNAMIC
;
174 void EVP_PKEY_meth_get0_info(int *ppkey_id
, int *pflags
,
175 const EVP_PKEY_METHOD
*meth
)
178 *ppkey_id
= meth
->pkey_id
;
180 *pflags
= meth
->flags
;
183 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD
*dst
, const EVP_PKEY_METHOD
*src
)
186 dst
->init
= src
->init
;
187 dst
->copy
= src
->copy
;
188 dst
->cleanup
= src
->cleanup
;
190 dst
->paramgen_init
= src
->paramgen_init
;
191 dst
->paramgen
= src
->paramgen
;
193 dst
->keygen_init
= src
->keygen_init
;
194 dst
->keygen
= src
->keygen
;
196 dst
->sign_init
= src
->sign_init
;
197 dst
->sign
= src
->sign
;
199 dst
->verify_init
= src
->verify_init
;
200 dst
->verify
= src
->verify
;
202 dst
->verify_recover_init
= src
->verify_recover_init
;
203 dst
->verify_recover
= src
->verify_recover
;
205 dst
->signctx_init
= src
->signctx_init
;
206 dst
->signctx
= src
->signctx
;
208 dst
->verifyctx_init
= src
->verifyctx_init
;
209 dst
->verifyctx
= src
->verifyctx
;
211 dst
->encrypt_init
= src
->encrypt_init
;
212 dst
->encrypt
= src
->encrypt
;
214 dst
->decrypt_init
= src
->decrypt_init
;
215 dst
->decrypt
= src
->decrypt
;
217 dst
->derive_init
= src
->derive_init
;
218 dst
->derive
= src
->derive
;
220 dst
->ctrl
= src
->ctrl
;
221 dst
->ctrl_str
= src
->ctrl_str
;
224 void EVP_PKEY_meth_free(EVP_PKEY_METHOD
*pmeth
)
226 if (pmeth
&& (pmeth
->flags
& EVP_PKEY_FLAG_DYNAMIC
))
230 EVP_PKEY_CTX
*EVP_PKEY_CTX_new(EVP_PKEY
*pkey
, ENGINE
*e
)
232 return int_ctx_new(pkey
, e
, -1);
235 EVP_PKEY_CTX
*EVP_PKEY_CTX_new_id(int id
, ENGINE
*e
)
237 return int_ctx_new(NULL
, e
, id
);
240 EVP_PKEY_CTX
*EVP_PKEY_CTX_dup(EVP_PKEY_CTX
*pctx
)
243 if (!pctx
->pmeth
|| !pctx
->pmeth
->copy
)
245 #ifndef OPENSSL_NO_ENGINE
246 /* Make sure it's safe to copy a pkey context using an ENGINE */
247 if (pctx
->engine
&& !ENGINE_init(pctx
->engine
)) {
248 EVPerr(EVP_F_EVP_PKEY_CTX_DUP
, ERR_R_ENGINE_LIB
);
252 rctx
= OPENSSL_malloc(sizeof(*rctx
));
256 rctx
->pmeth
= pctx
->pmeth
;
257 #ifndef OPENSSL_NO_ENGINE
258 rctx
->engine
= pctx
->engine
;
262 EVP_PKEY_up_ref(pctx
->pkey
);
264 rctx
->pkey
= pctx
->pkey
;
267 EVP_PKEY_up_ref(pctx
->peerkey
);
269 rctx
->peerkey
= pctx
->peerkey
;
272 rctx
->app_data
= NULL
;
273 rctx
->operation
= pctx
->operation
;
275 if (pctx
->pmeth
->copy(rctx
, pctx
) > 0)
279 EVP_PKEY_CTX_free(rctx
);
284 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD
*pmeth
)
286 if (app_pkey_methods
== NULL
) {
287 app_pkey_methods
= sk_EVP_PKEY_METHOD_new(pmeth_cmp
);
288 if (app_pkey_methods
== NULL
)
291 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods
, pmeth
))
293 sk_EVP_PKEY_METHOD_sort(app_pkey_methods
);
297 size_t EVP_PKEY_meth_get_count(void)
299 size_t rv
= OSSL_NELEM(standard_methods
);
301 if (app_pkey_methods
)
302 rv
+= sk_EVP_PKEY_METHOD_num(app_pkey_methods
);
306 const EVP_PKEY_METHOD
*EVP_PKEY_meth_get0(size_t idx
)
308 if (idx
< OSSL_NELEM(standard_methods
))
309 return standard_methods
[idx
];
310 if (app_pkey_methods
== NULL
)
312 idx
-= OSSL_NELEM(standard_methods
);
313 if (idx
>= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods
))
315 return sk_EVP_PKEY_METHOD_value(app_pkey_methods
, idx
);
318 void EVP_PKEY_CTX_free(EVP_PKEY_CTX
*ctx
)
322 if (ctx
->pmeth
&& ctx
->pmeth
->cleanup
)
323 ctx
->pmeth
->cleanup(ctx
);
324 EVP_PKEY_free(ctx
->pkey
);
325 EVP_PKEY_free(ctx
->peerkey
);
326 #ifndef OPENSSL_NO_ENGINE
327 ENGINE_finish(ctx
->engine
);
332 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX
*ctx
, int keytype
, int optype
,
333 int cmd
, int p1
, void *p2
)
336 if (!ctx
|| !ctx
->pmeth
|| !ctx
->pmeth
->ctrl
) {
337 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_COMMAND_NOT_SUPPORTED
);
340 if ((keytype
!= -1) && (ctx
->pmeth
->pkey_id
!= keytype
))
343 if (ctx
->operation
== EVP_PKEY_OP_UNDEFINED
) {
344 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_NO_OPERATION_SET
);
348 if ((optype
!= -1) && !(ctx
->operation
& optype
)) {
349 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_INVALID_OPERATION
);
353 ret
= ctx
->pmeth
->ctrl(ctx
, cmd
, p1
, p2
);
356 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL
, EVP_R_COMMAND_NOT_SUPPORTED
);
362 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX
*ctx
, int keytype
, int optype
,
363 int cmd
, uint64_t value
)
365 return EVP_PKEY_CTX_ctrl(ctx
, keytype
, optype
, cmd
, 0, &value
);
368 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX
*ctx
,
369 const char *name
, const char *value
)
371 if (!ctx
|| !ctx
->pmeth
|| !ctx
->pmeth
->ctrl_str
) {
372 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR
, EVP_R_COMMAND_NOT_SUPPORTED
);
375 if (strcmp(name
, "digest") == 0)
376 return EVP_PKEY_CTX_md(ctx
, EVP_PKEY_OP_TYPE_SIG
, EVP_PKEY_CTRL_MD
,
378 return ctx
->pmeth
->ctrl_str(ctx
, name
, value
);
381 /* Utility functions to send a string of hex string to a ctrl */
383 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX
*ctx
, int cmd
, const char *str
)
390 return ctx
->pmeth
->ctrl(ctx
, cmd
, len
, (void *)str
);
393 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX
*ctx
, int cmd
, const char *hex
)
399 bin
= OPENSSL_hexstr2buf(hex
, &binlen
);
402 if (binlen
<= INT_MAX
)
403 rv
= ctx
->pmeth
->ctrl(ctx
, cmd
, binlen
, bin
);
408 /* Pass a message digest to a ctrl */
409 int EVP_PKEY_CTX_md(EVP_PKEY_CTX
*ctx
, int optype
, int cmd
, const char *md
)
413 if (md
== NULL
|| (m
= EVP_get_digestbyname(md
)) == NULL
) {
414 EVPerr(EVP_F_EVP_PKEY_CTX_MD
, EVP_R_INVALID_DIGEST
);
417 return EVP_PKEY_CTX_ctrl(ctx
, -1, optype
, cmd
, 0, (void *)m
);
420 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX
*ctx
)
422 return ctx
->operation
;
425 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX
*ctx
, int *dat
, int datlen
)
427 ctx
->keygen_info
= dat
;
428 ctx
->keygen_info_count
= datlen
;
431 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX
*ctx
, void *data
)
436 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX
*ctx
)
441 EVP_PKEY
*EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX
*ctx
)
446 EVP_PKEY
*EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX
*ctx
)
451 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX
*ctx
, void *data
)
453 ctx
->app_data
= data
;
456 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX
*ctx
)
458 return ctx
->app_data
;
461 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD
*pmeth
,
462 int (*init
) (EVP_PKEY_CTX
*ctx
))
467 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD
*pmeth
,
468 int (*copy
) (EVP_PKEY_CTX
*dst
,
474 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD
*pmeth
,
475 void (*cleanup
) (EVP_PKEY_CTX
*ctx
))
477 pmeth
->cleanup
= cleanup
;
480 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD
*pmeth
,
481 int (*paramgen_init
) (EVP_PKEY_CTX
*ctx
),
482 int (*paramgen
) (EVP_PKEY_CTX
*ctx
,
485 pmeth
->paramgen_init
= paramgen_init
;
486 pmeth
->paramgen
= paramgen
;
489 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD
*pmeth
,
490 int (*keygen_init
) (EVP_PKEY_CTX
*ctx
),
491 int (*keygen
) (EVP_PKEY_CTX
*ctx
,
494 pmeth
->keygen_init
= keygen_init
;
495 pmeth
->keygen
= keygen
;
498 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD
*pmeth
,
499 int (*sign_init
) (EVP_PKEY_CTX
*ctx
),
500 int (*sign
) (EVP_PKEY_CTX
*ctx
,
501 unsigned char *sig
, size_t *siglen
,
502 const unsigned char *tbs
,
505 pmeth
->sign_init
= sign_init
;
509 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD
*pmeth
,
510 int (*verify_init
) (EVP_PKEY_CTX
*ctx
),
511 int (*verify
) (EVP_PKEY_CTX
*ctx
,
512 const unsigned char *sig
,
514 const unsigned char *tbs
,
517 pmeth
->verify_init
= verify_init
;
518 pmeth
->verify
= verify
;
521 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD
*pmeth
,
522 int (*verify_recover_init
) (EVP_PKEY_CTX
524 int (*verify_recover
) (EVP_PKEY_CTX
533 pmeth
->verify_recover_init
= verify_recover_init
;
534 pmeth
->verify_recover
= verify_recover
;
537 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD
*pmeth
,
538 int (*signctx_init
) (EVP_PKEY_CTX
*ctx
,
540 int (*signctx
) (EVP_PKEY_CTX
*ctx
,
545 pmeth
->signctx_init
= signctx_init
;
546 pmeth
->signctx
= signctx
;
549 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD
*pmeth
,
550 int (*verifyctx_init
) (EVP_PKEY_CTX
*ctx
,
552 int (*verifyctx
) (EVP_PKEY_CTX
*ctx
,
553 const unsigned char *sig
,
557 pmeth
->verifyctx_init
= verifyctx_init
;
558 pmeth
->verifyctx
= verifyctx
;
561 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD
*pmeth
,
562 int (*encrypt_init
) (EVP_PKEY_CTX
*ctx
),
563 int (*encryptfn
) (EVP_PKEY_CTX
*ctx
,
566 const unsigned char *in
,
569 pmeth
->encrypt_init
= encrypt_init
;
570 pmeth
->encrypt
= encryptfn
;
573 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD
*pmeth
,
574 int (*decrypt_init
) (EVP_PKEY_CTX
*ctx
),
575 int (*decrypt
) (EVP_PKEY_CTX
*ctx
,
578 const unsigned char *in
,
581 pmeth
->decrypt_init
= decrypt_init
;
582 pmeth
->decrypt
= decrypt
;
585 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD
*pmeth
,
586 int (*derive_init
) (EVP_PKEY_CTX
*ctx
),
587 int (*derive
) (EVP_PKEY_CTX
*ctx
,
591 pmeth
->derive_init
= derive_init
;
592 pmeth
->derive
= derive
;
595 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD
*pmeth
,
596 int (*ctrl
) (EVP_PKEY_CTX
*ctx
, int type
, int p1
,
598 int (*ctrl_str
) (EVP_PKEY_CTX
*ctx
,
603 pmeth
->ctrl_str
= ctrl_str
;
606 void EVP_PKEY_meth_get_init(EVP_PKEY_METHOD
*pmeth
,
607 int (**pinit
) (EVP_PKEY_CTX
*ctx
))
609 *pinit
= pmeth
->init
;
612 void EVP_PKEY_meth_get_copy(EVP_PKEY_METHOD
*pmeth
,
613 int (**pcopy
) (EVP_PKEY_CTX
*dst
,
616 *pcopy
= pmeth
->copy
;
619 void EVP_PKEY_meth_get_cleanup(EVP_PKEY_METHOD
*pmeth
,
620 void (**pcleanup
) (EVP_PKEY_CTX
*ctx
))
622 *pcleanup
= pmeth
->cleanup
;
625 void EVP_PKEY_meth_get_paramgen(EVP_PKEY_METHOD
*pmeth
,
626 int (**pparamgen_init
) (EVP_PKEY_CTX
*ctx
),
627 int (**pparamgen
) (EVP_PKEY_CTX
*ctx
,
631 *pparamgen_init
= pmeth
->paramgen_init
;
633 *pparamgen
= pmeth
->paramgen
;
636 void EVP_PKEY_meth_get_keygen(EVP_PKEY_METHOD
*pmeth
,
637 int (**pkeygen_init
) (EVP_PKEY_CTX
*ctx
),
638 int (**pkeygen
) (EVP_PKEY_CTX
*ctx
,
642 *pkeygen_init
= pmeth
->keygen_init
;
644 *pkeygen
= pmeth
->keygen
;
647 void EVP_PKEY_meth_get_sign(EVP_PKEY_METHOD
*pmeth
,
648 int (**psign_init
) (EVP_PKEY_CTX
*ctx
),
649 int (**psign
) (EVP_PKEY_CTX
*ctx
,
650 unsigned char *sig
, size_t *siglen
,
651 const unsigned char *tbs
,
655 *psign_init
= pmeth
->sign_init
;
657 *psign
= pmeth
->sign
;
660 void EVP_PKEY_meth_get_verify(EVP_PKEY_METHOD
*pmeth
,
661 int (**pverify_init
) (EVP_PKEY_CTX
*ctx
),
662 int (**pverify
) (EVP_PKEY_CTX
*ctx
,
663 const unsigned char *sig
,
665 const unsigned char *tbs
,
669 *pverify_init
= pmeth
->verify_init
;
671 *pverify
= pmeth
->verify
;
674 void EVP_PKEY_meth_get_verify_recover(EVP_PKEY_METHOD
*pmeth
,
675 int (**pverify_recover_init
) (EVP_PKEY_CTX
677 int (**pverify_recover
) (EVP_PKEY_CTX
686 if (pverify_recover_init
)
687 *pverify_recover_init
= pmeth
->verify_recover_init
;
689 *pverify_recover
= pmeth
->verify_recover
;
692 void EVP_PKEY_meth_get_signctx(EVP_PKEY_METHOD
*pmeth
,
693 int (**psignctx_init
) (EVP_PKEY_CTX
*ctx
,
695 int (**psignctx
) (EVP_PKEY_CTX
*ctx
,
701 *psignctx_init
= pmeth
->signctx_init
;
703 *psignctx
= pmeth
->signctx
;
706 void EVP_PKEY_meth_get_verifyctx(EVP_PKEY_METHOD
*pmeth
,
707 int (**pverifyctx_init
) (EVP_PKEY_CTX
*ctx
,
709 int (**pverifyctx
) (EVP_PKEY_CTX
*ctx
,
710 const unsigned char *sig
,
715 *pverifyctx_init
= pmeth
->verifyctx_init
;
717 *pverifyctx
= pmeth
->verifyctx
;
720 void EVP_PKEY_meth_get_encrypt(EVP_PKEY_METHOD
*pmeth
,
721 int (**pencrypt_init
) (EVP_PKEY_CTX
*ctx
),
722 int (**pencryptfn
) (EVP_PKEY_CTX
*ctx
,
725 const unsigned char *in
,
729 *pencrypt_init
= pmeth
->encrypt_init
;
731 *pencryptfn
= pmeth
->encrypt
;
734 void EVP_PKEY_meth_get_decrypt(EVP_PKEY_METHOD
*pmeth
,
735 int (**pdecrypt_init
) (EVP_PKEY_CTX
*ctx
),
736 int (**pdecrypt
) (EVP_PKEY_CTX
*ctx
,
739 const unsigned char *in
,
743 *pdecrypt_init
= pmeth
->decrypt_init
;
745 *pdecrypt
= pmeth
->decrypt
;
748 void EVP_PKEY_meth_get_derive(EVP_PKEY_METHOD
*pmeth
,
749 int (**pderive_init
) (EVP_PKEY_CTX
*ctx
),
750 int (**pderive
) (EVP_PKEY_CTX
*ctx
,
755 *pderive_init
= pmeth
->derive_init
;
757 *pderive
= pmeth
->derive
;
760 void EVP_PKEY_meth_get_ctrl(EVP_PKEY_METHOD
*pmeth
,
761 int (**pctrl
) (EVP_PKEY_CTX
*ctx
, int type
, int p1
,
763 int (**pctrl_str
) (EVP_PKEY_CTX
*ctx
,
768 *pctrl
= pmeth
->ctrl
;
770 *pctrl_str
= pmeth
->ctrl_str
;