2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
61 #include "internal/cryptlib.h"
62 #include <openssl/engine.h>
63 #include <openssl/evp.h>
64 #include <openssl/x509v3.h>
65 #include "internal/asn1_int.h"
66 #include "internal/evp_int.h"
67 #include "internal/numbers.h"
69 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
71 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
73 static const EVP_PKEY_METHOD *standard_methods[] = {
74 #ifndef OPENSSL_NO_RSA
80 #ifndef OPENSSL_NO_DSA
87 #ifndef OPENSSL_NO_CMAC
97 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
100 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
101 const EVP_PKEY_METHOD *const *b)
103 return ((*a)->pkey_id - (*b)->pkey_id);
106 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
109 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
112 const EVP_PKEY_METHOD *t = &tmp, **ret;
114 if (app_pkey_methods) {
116 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
118 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
120 ret = OBJ_bsearch_pmeth(&t, standard_methods,
121 sizeof(standard_methods) /
122 sizeof(EVP_PKEY_METHOD *));
128 static EVP_PKEY_CTX *int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
131 const EVP_PKEY_METHOD *pmeth;
133 if (!pkey || !pkey->ameth)
135 id = pkey->ameth->pkey_id;
137 #ifndef OPENSSL_NO_ENGINE
138 if (pkey && pkey->engine)
140 /* Try to find an ENGINE which implements this method */
142 if (!ENGINE_init(e)) {
143 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
147 e = ENGINE_get_pkey_meth_engine(id);
150 * If an ENGINE handled this method look it up. Otherwise use internal
155 pmeth = ENGINE_get_pkey_meth(e, id);
158 pmeth = EVP_PKEY_meth_find(id);
161 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
165 ret = OPENSSL_zalloc(sizeof(*ret));
167 #ifndef OPENSSL_NO_ENGINE
170 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
175 ret->operation = EVP_PKEY_OP_UNDEFINED;
178 EVP_PKEY_up_ref(pkey);
181 if (pmeth->init(ret) <= 0) {
182 EVP_PKEY_CTX_free(ret);
190 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
192 EVP_PKEY_METHOD *pmeth;
194 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
199 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
203 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
204 const EVP_PKEY_METHOD *meth)
207 *ppkey_id = meth->pkey_id;
209 *pflags = meth->flags;
212 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
215 dst->init = src->init;
216 dst->copy = src->copy;
217 dst->cleanup = src->cleanup;
219 dst->paramgen_init = src->paramgen_init;
220 dst->paramgen = src->paramgen;
222 dst->keygen_init = src->keygen_init;
223 dst->keygen = src->keygen;
225 dst->sign_init = src->sign_init;
226 dst->sign = src->sign;
228 dst->verify_init = src->verify_init;
229 dst->verify = src->verify;
231 dst->verify_recover_init = src->verify_recover_init;
232 dst->verify_recover = src->verify_recover;
234 dst->signctx_init = src->signctx_init;
235 dst->signctx = src->signctx;
237 dst->verifyctx_init = src->verifyctx_init;
238 dst->verifyctx = src->verifyctx;
240 dst->encrypt_init = src->encrypt_init;
241 dst->encrypt = src->encrypt;
243 dst->decrypt_init = src->decrypt_init;
244 dst->decrypt = src->decrypt;
246 dst->derive_init = src->derive_init;
247 dst->derive = src->derive;
249 dst->ctrl = src->ctrl;
250 dst->ctrl_str = src->ctrl_str;
253 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
255 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
259 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
261 return int_ctx_new(pkey, e, -1);
264 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
266 return int_ctx_new(NULL, e, id);
269 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
272 if (!pctx->pmeth || !pctx->pmeth->copy)
274 #ifndef OPENSSL_NO_ENGINE
275 /* Make sure it's safe to copy a pkey context using an ENGINE */
276 if (pctx->engine && !ENGINE_init(pctx->engine)) {
277 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
281 rctx = OPENSSL_malloc(sizeof(*rctx));
285 rctx->pmeth = pctx->pmeth;
286 #ifndef OPENSSL_NO_ENGINE
287 rctx->engine = pctx->engine;
291 EVP_PKEY_up_ref(pctx->pkey);
293 rctx->pkey = pctx->pkey;
296 EVP_PKEY_up_ref(pctx->peerkey);
298 rctx->peerkey = pctx->peerkey;
301 rctx->app_data = NULL;
302 rctx->operation = pctx->operation;
304 if (pctx->pmeth->copy(rctx, pctx) > 0)
307 EVP_PKEY_CTX_free(rctx);
312 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
314 if (app_pkey_methods == NULL) {
315 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
316 if (app_pkey_methods == NULL)
319 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
321 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
325 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
329 if (ctx->pmeth && ctx->pmeth->cleanup)
330 ctx->pmeth->cleanup(ctx);
331 EVP_PKEY_free(ctx->pkey);
332 EVP_PKEY_free(ctx->peerkey);
333 #ifndef OPENSSL_NO_ENGINE
334 ENGINE_finish(ctx->engine);
339 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
340 int cmd, int p1, void *p2)
343 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
344 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
347 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
350 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
351 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
355 if ((optype != -1) && !(ctx->operation & optype)) {
356 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
360 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
363 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
369 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
370 const char *name, const char *value)
372 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
373 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
376 if (strcmp(name, "digest") == 0) {
378 if (value == NULL || (md = EVP_get_digestbyname(value)) == NULL) {
379 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_INVALID_DIGEST);
382 return EVP_PKEY_CTX_set_signature_md(ctx, md);
384 return ctx->pmeth->ctrl_str(ctx, name, value);
387 /* Utility functions to send a string of hex string to a ctrl */
389 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
396 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
399 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
405 bin = OPENSSL_hexstr2buf(hex, &binlen);
408 if (binlen <= INT_MAX)
409 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
414 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
416 return ctx->operation;
419 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
421 ctx->keygen_info = dat;
422 ctx->keygen_info_count = datlen;
425 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
430 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
435 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
440 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
445 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
447 ctx->app_data = data;
450 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
452 return ctx->app_data;
455 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
456 int (*init) (EVP_PKEY_CTX *ctx))
461 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
462 int (*copy) (EVP_PKEY_CTX *dst,
468 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
469 void (*cleanup) (EVP_PKEY_CTX *ctx))
471 pmeth->cleanup = cleanup;
474 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
475 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
476 int (*paramgen) (EVP_PKEY_CTX *ctx,
479 pmeth->paramgen_init = paramgen_init;
480 pmeth->paramgen = paramgen;
483 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
484 int (*keygen_init) (EVP_PKEY_CTX *ctx),
485 int (*keygen) (EVP_PKEY_CTX *ctx,
488 pmeth->keygen_init = keygen_init;
489 pmeth->keygen = keygen;
492 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
493 int (*sign_init) (EVP_PKEY_CTX *ctx),
494 int (*sign) (EVP_PKEY_CTX *ctx,
495 unsigned char *sig, size_t *siglen,
496 const unsigned char *tbs,
499 pmeth->sign_init = sign_init;
503 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
504 int (*verify_init) (EVP_PKEY_CTX *ctx),
505 int (*verify) (EVP_PKEY_CTX *ctx,
506 const unsigned char *sig,
508 const unsigned char *tbs,
511 pmeth->verify_init = verify_init;
512 pmeth->verify = verify;
515 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
516 int (*verify_recover_init) (EVP_PKEY_CTX
518 int (*verify_recover) (EVP_PKEY_CTX
527 pmeth->verify_recover_init = verify_recover_init;
528 pmeth->verify_recover = verify_recover;
531 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
532 int (*signctx_init) (EVP_PKEY_CTX *ctx,
534 int (*signctx) (EVP_PKEY_CTX *ctx,
539 pmeth->signctx_init = signctx_init;
540 pmeth->signctx = signctx;
543 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
544 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
546 int (*verifyctx) (EVP_PKEY_CTX *ctx,
547 const unsigned char *sig,
551 pmeth->verifyctx_init = verifyctx_init;
552 pmeth->verifyctx = verifyctx;
555 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
556 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
557 int (*encryptfn) (EVP_PKEY_CTX *ctx,
560 const unsigned char *in,
563 pmeth->encrypt_init = encrypt_init;
564 pmeth->encrypt = encryptfn;
567 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
568 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
569 int (*decrypt) (EVP_PKEY_CTX *ctx,
572 const unsigned char *in,
575 pmeth->decrypt_init = decrypt_init;
576 pmeth->decrypt = decrypt;
579 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
580 int (*derive_init) (EVP_PKEY_CTX *ctx),
581 int (*derive) (EVP_PKEY_CTX *ctx,
585 pmeth->derive_init = derive_init;
586 pmeth->derive = derive;
589 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
590 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
592 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
597 pmeth->ctrl_str = ctrl_str;
600 void EVP_PKEY_meth_get_init(EVP_PKEY_METHOD *pmeth,
601 int (**pinit) (EVP_PKEY_CTX *ctx))
603 *pinit = pmeth->init;
606 void EVP_PKEY_meth_get_copy(EVP_PKEY_METHOD *pmeth,
607 int (**pcopy) (EVP_PKEY_CTX *dst,
610 *pcopy = pmeth->copy;
613 void EVP_PKEY_meth_get_cleanup(EVP_PKEY_METHOD *pmeth,
614 void (**pcleanup) (EVP_PKEY_CTX *ctx))
616 *pcleanup = pmeth->cleanup;
619 void EVP_PKEY_meth_get_paramgen(EVP_PKEY_METHOD *pmeth,
620 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
621 int (**pparamgen) (EVP_PKEY_CTX *ctx,
625 *pparamgen_init = pmeth->paramgen_init;
627 *pparamgen = pmeth->paramgen;
630 void EVP_PKEY_meth_get_keygen(EVP_PKEY_METHOD *pmeth,
631 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
632 int (**pkeygen) (EVP_PKEY_CTX *ctx,
636 *pkeygen_init = pmeth->keygen_init;
638 *pkeygen = pmeth->keygen;
641 void EVP_PKEY_meth_get_sign(EVP_PKEY_METHOD *pmeth,
642 int (**psign_init) (EVP_PKEY_CTX *ctx),
643 int (**psign) (EVP_PKEY_CTX *ctx,
644 unsigned char *sig, size_t *siglen,
645 const unsigned char *tbs,
649 *psign_init = pmeth->sign_init;
651 *psign = pmeth->sign;
654 void EVP_PKEY_meth_get_verify(EVP_PKEY_METHOD *pmeth,
655 int (**pverify_init) (EVP_PKEY_CTX *ctx),
656 int (**pverify) (EVP_PKEY_CTX *ctx,
657 const unsigned char *sig,
659 const unsigned char *tbs,
663 *pverify_init = pmeth->verify_init;
665 *pverify = pmeth->verify;
668 void EVP_PKEY_meth_get_verify_recover(EVP_PKEY_METHOD *pmeth,
669 int (**pverify_recover_init) (EVP_PKEY_CTX
671 int (**pverify_recover) (EVP_PKEY_CTX
680 if (pverify_recover_init)
681 *pverify_recover_init = pmeth->verify_recover_init;
683 *pverify_recover = pmeth->verify_recover;
686 void EVP_PKEY_meth_get_signctx(EVP_PKEY_METHOD *pmeth,
687 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
689 int (**psignctx) (EVP_PKEY_CTX *ctx,
695 *psignctx_init = pmeth->signctx_init;
697 *psignctx = pmeth->signctx;
700 void EVP_PKEY_meth_get_verifyctx(EVP_PKEY_METHOD *pmeth,
701 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
703 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
704 const unsigned char *sig,
709 *pverifyctx_init = pmeth->verifyctx_init;
711 *pverifyctx = pmeth->verifyctx;
714 void EVP_PKEY_meth_get_encrypt(EVP_PKEY_METHOD *pmeth,
715 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
716 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
719 const unsigned char *in,
723 *pencrypt_init = pmeth->encrypt_init;
725 *pencryptfn = pmeth->encrypt;
728 void EVP_PKEY_meth_get_decrypt(EVP_PKEY_METHOD *pmeth,
729 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
730 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
733 const unsigned char *in,
737 *pdecrypt_init = pmeth->decrypt_init;
739 *pdecrypt = pmeth->decrypt;
742 void EVP_PKEY_meth_get_derive(EVP_PKEY_METHOD *pmeth,
743 int (**pderive_init) (EVP_PKEY_CTX *ctx),
744 int (**pderive) (EVP_PKEY_CTX *ctx,
749 *pderive_init = pmeth->derive_init;
751 *pderive = pmeth->derive;
754 void EVP_PKEY_meth_get_ctrl(EVP_PKEY_METHOD *pmeth,
755 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
757 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
762 *pctrl = pmeth->ctrl;
764 *pctrl_str = pmeth->ctrl_str;