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 #ifndef OPENSSL_NO_ENGINE
63 # include <openssl/engine.h>
65 #include <openssl/evp.h>
66 #include <openssl/x509v3.h>
67 #include "internal/asn1_int.h"
68 #include "internal/evp_int.h"
69 #include "internal/numbers.h"
71 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
73 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
75 static const EVP_PKEY_METHOD *standard_methods[] = {
76 #ifndef OPENSSL_NO_RSA
82 #ifndef OPENSSL_NO_DSA
96 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
99 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
100 const EVP_PKEY_METHOD *const *b)
102 return ((*a)->pkey_id - (*b)->pkey_id);
105 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
108 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
111 const EVP_PKEY_METHOD *t = &tmp, **ret;
113 if (app_pkey_methods) {
115 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
117 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
119 ret = OBJ_bsearch_pmeth(&t, standard_methods,
120 sizeof(standard_methods) /
121 sizeof(EVP_PKEY_METHOD *));
127 static EVP_PKEY_CTX *int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
130 const EVP_PKEY_METHOD *pmeth;
132 if (!pkey || !pkey->ameth)
134 id = pkey->ameth->pkey_id;
136 #ifndef OPENSSL_NO_ENGINE
137 if (pkey && pkey->engine)
139 /* Try to find an ENGINE which implements this method */
141 if (!ENGINE_init(e)) {
142 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
146 e = ENGINE_get_pkey_meth_engine(id);
149 * If an ENGINE handled this method look it up. Otherwise use internal
154 pmeth = ENGINE_get_pkey_meth(e, id);
157 pmeth = EVP_PKEY_meth_find(id);
160 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
164 ret = OPENSSL_zalloc(sizeof(*ret));
166 #ifndef OPENSSL_NO_ENGINE
169 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
174 ret->operation = EVP_PKEY_OP_UNDEFINED;
177 CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
180 if (pmeth->init(ret) <= 0) {
181 EVP_PKEY_CTX_free(ret);
189 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
191 EVP_PKEY_METHOD *pmeth;
193 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
198 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
202 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
203 const EVP_PKEY_METHOD *meth)
206 *ppkey_id = meth->pkey_id;
208 *pflags = meth->flags;
211 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
214 dst->init = src->init;
215 dst->copy = src->copy;
216 dst->cleanup = src->cleanup;
218 dst->paramgen_init = src->paramgen_init;
219 dst->paramgen = src->paramgen;
221 dst->keygen_init = src->keygen_init;
222 dst->keygen = src->keygen;
224 dst->sign_init = src->sign_init;
225 dst->sign = src->sign;
227 dst->verify_init = src->verify_init;
228 dst->verify = src->verify;
230 dst->verify_recover_init = src->verify_recover_init;
231 dst->verify_recover = src->verify_recover;
233 dst->signctx_init = src->signctx_init;
234 dst->signctx = src->signctx;
236 dst->verifyctx_init = src->verifyctx_init;
237 dst->verifyctx = src->verifyctx;
239 dst->encrypt_init = src->encrypt_init;
240 dst->encrypt = src->encrypt;
242 dst->decrypt_init = src->decrypt_init;
243 dst->decrypt = src->decrypt;
245 dst->derive_init = src->derive_init;
246 dst->derive = src->derive;
248 dst->ctrl = src->ctrl;
249 dst->ctrl_str = src->ctrl_str;
252 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
254 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
258 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
260 return int_ctx_new(pkey, e, -1);
263 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
265 return int_ctx_new(NULL, e, id);
268 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
271 if (!pctx->pmeth || !pctx->pmeth->copy)
273 #ifndef OPENSSL_NO_ENGINE
274 /* Make sure it's safe to copy a pkey context using an ENGINE */
275 if (pctx->engine && !ENGINE_init(pctx->engine)) {
276 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
280 rctx = OPENSSL_malloc(sizeof(*rctx));
284 rctx->pmeth = pctx->pmeth;
285 #ifndef OPENSSL_NO_ENGINE
286 rctx->engine = pctx->engine;
290 CRYPTO_add(&pctx->pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
292 rctx->pkey = pctx->pkey;
295 CRYPTO_add(&pctx->peerkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
297 rctx->peerkey = pctx->peerkey;
300 rctx->app_data = NULL;
301 rctx->operation = pctx->operation;
303 if (pctx->pmeth->copy(rctx, pctx) > 0)
306 EVP_PKEY_CTX_free(rctx);
311 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
313 if (app_pkey_methods == NULL) {
314 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
315 if (app_pkey_methods == NULL)
318 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
320 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
324 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
328 if (ctx->pmeth && ctx->pmeth->cleanup)
329 ctx->pmeth->cleanup(ctx);
330 EVP_PKEY_free(ctx->pkey);
331 EVP_PKEY_free(ctx->peerkey);
332 #ifndef OPENSSL_NO_ENGINE
333 ENGINE_finish(ctx->engine);
338 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
339 int cmd, int p1, void *p2)
342 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
343 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
346 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
349 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
350 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
354 if ((optype != -1) && !(ctx->operation & optype)) {
355 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
359 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
362 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
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) {
377 if (value == NULL || (md = EVP_get_digestbyname(value)) == NULL) {
378 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_INVALID_DIGEST);
381 return EVP_PKEY_CTX_set_signature_md(ctx, md);
383 return ctx->pmeth->ctrl_str(ctx, name, value);
386 /* Utility functions to send a string of hex string to a ctrl */
388 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
395 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
398 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
404 bin = string_to_hex(hex, &binlen);
407 if (binlen <= INT_MAX)
408 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
413 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
415 return ctx->operation;
418 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
420 ctx->keygen_info = dat;
421 ctx->keygen_info_count = datlen;
424 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
429 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
434 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
439 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
444 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
446 ctx->app_data = data;
449 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
451 return ctx->app_data;
454 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
455 int (*init) (EVP_PKEY_CTX *ctx))
460 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
461 int (*copy) (EVP_PKEY_CTX *dst,
467 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
468 void (*cleanup) (EVP_PKEY_CTX *ctx))
470 pmeth->cleanup = cleanup;
473 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
474 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
475 int (*paramgen) (EVP_PKEY_CTX *ctx,
478 pmeth->paramgen_init = paramgen_init;
479 pmeth->paramgen = paramgen;
482 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
483 int (*keygen_init) (EVP_PKEY_CTX *ctx),
484 int (*keygen) (EVP_PKEY_CTX *ctx,
487 pmeth->keygen_init = keygen_init;
488 pmeth->keygen = keygen;
491 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
492 int (*sign_init) (EVP_PKEY_CTX *ctx),
493 int (*sign) (EVP_PKEY_CTX *ctx,
494 unsigned char *sig, size_t *siglen,
495 const unsigned char *tbs,
498 pmeth->sign_init = sign_init;
502 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
503 int (*verify_init) (EVP_PKEY_CTX *ctx),
504 int (*verify) (EVP_PKEY_CTX *ctx,
505 const unsigned char *sig,
507 const unsigned char *tbs,
510 pmeth->verify_init = verify_init;
511 pmeth->verify = verify;
514 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
515 int (*verify_recover_init) (EVP_PKEY_CTX
517 int (*verify_recover) (EVP_PKEY_CTX
526 pmeth->verify_recover_init = verify_recover_init;
527 pmeth->verify_recover = verify_recover;
530 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
531 int (*signctx_init) (EVP_PKEY_CTX *ctx,
533 int (*signctx) (EVP_PKEY_CTX *ctx,
538 pmeth->signctx_init = signctx_init;
539 pmeth->signctx = signctx;
542 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
543 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
545 int (*verifyctx) (EVP_PKEY_CTX *ctx,
546 const unsigned char *sig,
550 pmeth->verifyctx_init = verifyctx_init;
551 pmeth->verifyctx = verifyctx;
554 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
555 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
556 int (*encryptfn) (EVP_PKEY_CTX *ctx,
559 const unsigned char *in,
562 pmeth->encrypt_init = encrypt_init;
563 pmeth->encrypt = encryptfn;
566 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
567 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
568 int (*decrypt) (EVP_PKEY_CTX *ctx,
571 const unsigned char *in,
574 pmeth->decrypt_init = decrypt_init;
575 pmeth->decrypt = decrypt;
578 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
579 int (*derive_init) (EVP_PKEY_CTX *ctx),
580 int (*derive) (EVP_PKEY_CTX *ctx,
584 pmeth->derive_init = derive_init;
585 pmeth->derive = derive;
588 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
589 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
591 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
596 pmeth->ctrl_str = ctrl_str;
599 void EVP_PKEY_meth_get_init(EVP_PKEY_METHOD *pmeth,
600 int (**pinit) (EVP_PKEY_CTX *ctx))
602 *pinit = pmeth->init;
605 void EVP_PKEY_meth_get_copy(EVP_PKEY_METHOD *pmeth,
606 int (**pcopy) (EVP_PKEY_CTX *dst,
609 *pcopy = pmeth->copy;
612 void EVP_PKEY_meth_get_cleanup(EVP_PKEY_METHOD *pmeth,
613 void (**pcleanup) (EVP_PKEY_CTX *ctx))
615 *pcleanup = pmeth->cleanup;
618 void EVP_PKEY_meth_get_paramgen(EVP_PKEY_METHOD *pmeth,
619 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
620 int (**pparamgen) (EVP_PKEY_CTX *ctx,
624 *pparamgen_init = pmeth->paramgen_init;
626 *pparamgen = pmeth->paramgen;
629 void EVP_PKEY_meth_get_keygen(EVP_PKEY_METHOD *pmeth,
630 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
631 int (**pkeygen) (EVP_PKEY_CTX *ctx,
635 *pkeygen_init = pmeth->keygen_init;
637 *pkeygen = pmeth->keygen;
640 void EVP_PKEY_meth_get_sign(EVP_PKEY_METHOD *pmeth,
641 int (**psign_init) (EVP_PKEY_CTX *ctx),
642 int (**psign) (EVP_PKEY_CTX *ctx,
643 unsigned char *sig, size_t *siglen,
644 const unsigned char *tbs,
648 *psign_init = pmeth->sign_init;
650 *psign = pmeth->sign;
653 void EVP_PKEY_meth_get_verify(EVP_PKEY_METHOD *pmeth,
654 int (**pverify_init) (EVP_PKEY_CTX *ctx),
655 int (**pverify) (EVP_PKEY_CTX *ctx,
656 const unsigned char *sig,
658 const unsigned char *tbs,
662 *pverify_init = pmeth->verify_init;
664 *pverify = pmeth->verify;
667 void EVP_PKEY_meth_get_verify_recover(EVP_PKEY_METHOD *pmeth,
668 int (**pverify_recover_init) (EVP_PKEY_CTX
670 int (**pverify_recover) (EVP_PKEY_CTX
679 if (pverify_recover_init)
680 *pverify_recover_init = pmeth->verify_recover_init;
682 *pverify_recover = pmeth->verify_recover;
685 void EVP_PKEY_meth_get_signctx(EVP_PKEY_METHOD *pmeth,
686 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
688 int (**psignctx) (EVP_PKEY_CTX *ctx,
694 *psignctx_init = pmeth->signctx_init;
696 *psignctx = pmeth->signctx;
699 void EVP_PKEY_meth_get_verifyctx(EVP_PKEY_METHOD *pmeth,
700 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
702 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
703 const unsigned char *sig,
708 *pverifyctx_init = pmeth->verifyctx_init;
710 *pverifyctx = pmeth->verifyctx;
713 void EVP_PKEY_meth_get_encrypt(EVP_PKEY_METHOD *pmeth,
714 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
715 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
718 const unsigned char *in,
722 *pencrypt_init = pmeth->encrypt_init;
724 *pencryptfn = pmeth->encrypt;
727 void EVP_PKEY_meth_get_decrypt(EVP_PKEY_METHOD *pmeth,
728 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
729 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
732 const unsigned char *in,
736 *pdecrypt_init = pmeth->decrypt_init;
738 *pdecrypt = pmeth->decrypt;
741 void EVP_PKEY_meth_get_derive(EVP_PKEY_METHOD *pmeth,
742 int (**pderive_init) (EVP_PKEY_CTX *ctx),
743 int (**pderive) (EVP_PKEY_CTX *ctx,
748 *pderive_init = pmeth->derive_init;
750 *pderive = pmeth->derive;
753 void EVP_PKEY_meth_get_ctrl(EVP_PKEY_METHOD *pmeth,
754 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
756 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
761 *pctrl = pmeth->ctrl;
763 *pctrl_str = pmeth->ctrl_str;