3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
62 #include "internal/cryptlib.h"
63 #include <openssl/objects.h>
64 #include <openssl/evp.h>
65 #ifndef OPENSSL_NO_ENGINE
66 # include <openssl/engine.h>
68 #include "internal/asn1_int.h"
69 #include "internal/evp_int.h"
71 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
73 DECLARE_STACK_OF(EVP_PKEY_METHOD)
74 STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
76 extern const EVP_PKEY_METHOD rsa_pkey_meth, dh_pkey_meth, dsa_pkey_meth;
77 extern const EVP_PKEY_METHOD ec_pkey_meth, hmac_pkey_meth, cmac_pkey_meth;
78 extern const EVP_PKEY_METHOD dhx_pkey_meth;
80 static const EVP_PKEY_METHOD *standard_methods[] = {
81 #ifndef OPENSSL_NO_RSA
87 #ifndef OPENSSL_NO_DSA
100 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
103 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
104 const EVP_PKEY_METHOD *const *b)
106 return ((*a)->pkey_id - (*b)->pkey_id);
109 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
112 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
115 const EVP_PKEY_METHOD *t = &tmp, **ret;
117 if (app_pkey_methods) {
119 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
121 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
123 ret = OBJ_bsearch_pmeth(&t, standard_methods,
124 sizeof(standard_methods) /
125 sizeof(EVP_PKEY_METHOD *));
131 static EVP_PKEY_CTX *int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
134 const EVP_PKEY_METHOD *pmeth;
136 if (!pkey || !pkey->ameth)
138 id = pkey->ameth->pkey_id;
140 #ifndef OPENSSL_NO_ENGINE
141 if (pkey && pkey->engine)
143 /* Try to find an ENGINE which implements this method */
145 if (!ENGINE_init(e)) {
146 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
150 e = ENGINE_get_pkey_meth_engine(id);
153 * If an ENGINE handled this method look it up. Othewise use internal
158 pmeth = ENGINE_get_pkey_meth(e, id);
161 pmeth = EVP_PKEY_meth_find(id);
164 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
168 ret = OPENSSL_malloc(sizeof(*ret));
170 #ifndef OPENSSL_NO_ENGINE
174 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
179 ret->operation = EVP_PKEY_OP_UNDEFINED;
184 CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
188 if (pmeth->init(ret) <= 0) {
189 EVP_PKEY_CTX_free(ret);
197 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
199 EVP_PKEY_METHOD *pmeth;
201 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
206 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
210 pmeth->paramgen_init = 0;
212 pmeth->keygen_init = 0;
214 pmeth->sign_init = 0;
216 pmeth->verify_init = 0;
218 pmeth->verify_recover_init = 0;
219 pmeth->verify_recover = 0;
220 pmeth->signctx_init = 0;
222 pmeth->verifyctx_init = 0;
223 pmeth->verifyctx = 0;
224 pmeth->encrypt_init = 0;
226 pmeth->decrypt_init = 0;
228 pmeth->derive_init = 0;
236 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
237 const EVP_PKEY_METHOD *meth)
240 *ppkey_id = meth->pkey_id;
242 *pflags = meth->flags;
245 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
248 dst->init = src->init;
249 dst->copy = src->copy;
250 dst->cleanup = src->cleanup;
252 dst->paramgen_init = src->paramgen_init;
253 dst->paramgen = src->paramgen;
255 dst->keygen_init = src->keygen_init;
256 dst->keygen = src->keygen;
258 dst->sign_init = src->sign_init;
259 dst->sign = src->sign;
261 dst->verify_init = src->verify_init;
262 dst->verify = src->verify;
264 dst->verify_recover_init = src->verify_recover_init;
265 dst->verify_recover = src->verify_recover;
267 dst->signctx_init = src->signctx_init;
268 dst->signctx = src->signctx;
270 dst->verifyctx_init = src->verifyctx_init;
271 dst->verifyctx = src->verifyctx;
273 dst->encrypt_init = src->encrypt_init;
274 dst->encrypt = src->encrypt;
276 dst->decrypt_init = src->decrypt_init;
277 dst->decrypt = src->decrypt;
279 dst->derive_init = src->derive_init;
280 dst->derive = src->derive;
282 dst->ctrl = src->ctrl;
283 dst->ctrl_str = src->ctrl_str;
286 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
288 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
292 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
294 return int_ctx_new(pkey, e, -1);
297 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
299 return int_ctx_new(NULL, e, id);
302 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
305 if (!pctx->pmeth || !pctx->pmeth->copy)
307 #ifndef OPENSSL_NO_ENGINE
308 /* Make sure it's safe to copy a pkey context using an ENGINE */
309 if (pctx->engine && !ENGINE_init(pctx->engine)) {
310 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
314 rctx = OPENSSL_malloc(sizeof(*rctx));
318 rctx->pmeth = pctx->pmeth;
319 #ifndef OPENSSL_NO_ENGINE
320 rctx->engine = pctx->engine;
324 CRYPTO_add(&pctx->pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
326 rctx->pkey = pctx->pkey;
329 CRYPTO_add(&pctx->peerkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
331 rctx->peerkey = pctx->peerkey;
334 rctx->app_data = NULL;
335 rctx->operation = pctx->operation;
337 if (pctx->pmeth->copy(rctx, pctx) > 0)
340 EVP_PKEY_CTX_free(rctx);
345 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
347 if (app_pkey_methods == NULL) {
348 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
349 if (!app_pkey_methods)
352 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
354 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
358 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
362 if (ctx->pmeth && ctx->pmeth->cleanup)
363 ctx->pmeth->cleanup(ctx);
364 EVP_PKEY_free(ctx->pkey);
365 EVP_PKEY_free(ctx->peerkey);
366 #ifndef OPENSSL_NO_ENGINE
369 * The EVP_PKEY_CTX we used belongs to an ENGINE, release the
370 * functional reference we held for this reason.
372 ENGINE_finish(ctx->engine);
377 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
378 int cmd, int p1, void *p2)
381 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
382 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
385 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
388 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
389 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
393 if ((optype != -1) && !(ctx->operation & optype)) {
394 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
398 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
401 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
407 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
408 const char *name, const char *value)
410 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
411 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
414 if (strcmp(name, "digest") == 0) {
416 if (value == NULL || (md = EVP_get_digestbyname(value)) == NULL) {
417 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_INVALID_DIGEST);
420 return EVP_PKEY_CTX_set_signature_md(ctx, md);
422 return ctx->pmeth->ctrl_str(ctx, name, value);
425 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
427 return ctx->operation;
430 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
432 ctx->keygen_info = dat;
433 ctx->keygen_info_count = datlen;
436 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
441 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
446 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
451 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
456 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
458 ctx->app_data = data;
461 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
463 return ctx->app_data;
466 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
467 int (*init) (EVP_PKEY_CTX *ctx))
472 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
473 int (*copy) (EVP_PKEY_CTX *dst,
479 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
480 void (*cleanup) (EVP_PKEY_CTX *ctx))
482 pmeth->cleanup = cleanup;
485 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
486 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
487 int (*paramgen) (EVP_PKEY_CTX *ctx,
490 pmeth->paramgen_init = paramgen_init;
491 pmeth->paramgen = paramgen;
494 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
495 int (*keygen_init) (EVP_PKEY_CTX *ctx),
496 int (*keygen) (EVP_PKEY_CTX *ctx,
499 pmeth->keygen_init = keygen_init;
500 pmeth->keygen = keygen;
503 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
504 int (*sign_init) (EVP_PKEY_CTX *ctx),
505 int (*sign) (EVP_PKEY_CTX *ctx,
506 unsigned char *sig, size_t *siglen,
507 const unsigned char *tbs,
510 pmeth->sign_init = sign_init;
514 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
515 int (*verify_init) (EVP_PKEY_CTX *ctx),
516 int (*verify) (EVP_PKEY_CTX *ctx,
517 const unsigned char *sig,
519 const unsigned char *tbs,
522 pmeth->verify_init = verify_init;
523 pmeth->verify = verify;
526 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
527 int (*verify_recover_init) (EVP_PKEY_CTX
529 int (*verify_recover) (EVP_PKEY_CTX
538 pmeth->verify_recover_init = verify_recover_init;
539 pmeth->verify_recover = verify_recover;
542 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
543 int (*signctx_init) (EVP_PKEY_CTX *ctx,
545 int (*signctx) (EVP_PKEY_CTX *ctx,
550 pmeth->signctx_init = signctx_init;
551 pmeth->signctx = signctx;
554 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
555 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
557 int (*verifyctx) (EVP_PKEY_CTX *ctx,
558 const unsigned char *sig,
562 pmeth->verifyctx_init = verifyctx_init;
563 pmeth->verifyctx = verifyctx;
566 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
567 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
568 int (*encryptfn) (EVP_PKEY_CTX *ctx,
571 const unsigned char *in,
574 pmeth->encrypt_init = encrypt_init;
575 pmeth->encrypt = encryptfn;
578 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
579 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
580 int (*decrypt) (EVP_PKEY_CTX *ctx,
583 const unsigned char *in,
586 pmeth->decrypt_init = decrypt_init;
587 pmeth->decrypt = decrypt;
590 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
591 int (*derive_init) (EVP_PKEY_CTX *ctx),
592 int (*derive) (EVP_PKEY_CTX *ctx,
596 pmeth->derive_init = derive_init;
597 pmeth->derive = derive;
600 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
601 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
603 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
608 pmeth->ctrl_str = ctrl_str;