1 /* $OpenBSD: pmeth_lib.c,v 1.10 2014/11/09 19:17:13 miod Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
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).
63 #include <openssl/opensslconf.h>
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
67 #include <openssl/objects.h>
69 #ifndef OPENSSL_NO_ENGINE
70 #include <openssl/engine.h>
73 #include "asn1_locl.h"
76 typedef int sk_cmp_fn_type(const char * const *a, const char * const *b);
78 DECLARE_STACK_OF(EVP_PKEY_METHOD)
79 STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
81 extern const EVP_PKEY_METHOD rsa_pkey_meth, dh_pkey_meth, dsa_pkey_meth;
82 extern const EVP_PKEY_METHOD ec_pkey_meth, hmac_pkey_meth, cmac_pkey_meth;
83 extern const EVP_PKEY_METHOD gostimit_pkey_meth, gostr01_pkey_meth;
85 static const EVP_PKEY_METHOD *standard_methods[] = {
86 #ifndef OPENSSL_NO_RSA
92 #ifndef OPENSSL_NO_DSA
98 #ifndef OPENSSL_NO_GOST
106 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
110 pmeth_cmp(const EVP_PKEY_METHOD * const *a, const EVP_PKEY_METHOD * const *b)
112 return ((*a)->pkey_id - (*b)->pkey_id);
115 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
118 const EVP_PKEY_METHOD *
119 EVP_PKEY_meth_find(int type)
122 const EVP_PKEY_METHOD *t = &tmp, **ret;
125 if (app_pkey_methods) {
127 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
129 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
131 ret = OBJ_bsearch_pmeth(&t, standard_methods,
132 sizeof(standard_methods)/sizeof(EVP_PKEY_METHOD *));
138 static EVP_PKEY_CTX *
139 int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
142 const EVP_PKEY_METHOD *pmeth;
145 if (!pkey || !pkey->ameth)
147 id = pkey->ameth->pkey_id;
149 #ifndef OPENSSL_NO_ENGINE
150 if (pkey && pkey->engine)
152 /* Try to find an ENGINE which implements this method */
154 if (!ENGINE_init(e)) {
155 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
159 e = ENGINE_get_pkey_meth_engine(id);
161 /* If an ENGINE handled this method look it up. Othewise
162 * use internal tables.
166 pmeth = ENGINE_get_pkey_meth(e, id);
169 pmeth = EVP_PKEY_meth_find(id);
172 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
176 ret = malloc(sizeof(EVP_PKEY_CTX));
178 #ifndef OPENSSL_NO_ENGINE
182 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
187 ret->operation = EVP_PKEY_OP_UNDEFINED;
192 CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
196 if (pmeth->init(ret) <= 0) {
197 EVP_PKEY_CTX_free(ret);
206 EVP_PKEY_meth_new(int id, int flags)
208 EVP_PKEY_METHOD *pmeth;
210 pmeth = calloc(1, sizeof(EVP_PKEY_METHOD));
215 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
220 pmeth->paramgen_init = 0;
222 pmeth->keygen_init = 0;
224 pmeth->sign_init = 0;
226 pmeth->verify_init = 0;
228 pmeth->verify_recover_init = 0;
229 pmeth->verify_recover = 0;
230 pmeth->signctx_init = 0;
232 pmeth->verifyctx_init = 0;
233 pmeth->verifyctx = 0;
234 pmeth->encrypt_init = 0;
236 pmeth->decrypt_init = 0;
238 pmeth->derive_init = 0;
247 EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags, const EVP_PKEY_METHOD *meth)
250 *ppkey_id = meth->pkey_id;
252 *pflags = meth->flags;
256 EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
258 dst->init = src->init;
259 dst->copy = src->copy;
260 dst->cleanup = src->cleanup;
262 dst->paramgen_init = src->paramgen_init;
263 dst->paramgen = src->paramgen;
265 dst->keygen_init = src->keygen_init;
266 dst->keygen = src->keygen;
268 dst->sign_init = src->sign_init;
269 dst->sign = src->sign;
271 dst->verify_init = src->verify_init;
272 dst->verify = src->verify;
274 dst->verify_recover_init = src->verify_recover_init;
275 dst->verify_recover = src->verify_recover;
277 dst->signctx_init = src->signctx_init;
278 dst->signctx = src->signctx;
280 dst->verifyctx_init = src->verifyctx_init;
281 dst->verifyctx = src->verifyctx;
283 dst->encrypt_init = src->encrypt_init;
284 dst->encrypt = src->encrypt;
286 dst->decrypt_init = src->decrypt_init;
287 dst->decrypt = src->decrypt;
289 dst->derive_init = src->derive_init;
290 dst->derive = src->derive;
292 dst->ctrl = src->ctrl;
293 dst->ctrl_str = src->ctrl_str;
297 EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
299 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
304 EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
306 return int_ctx_new(pkey, e, -1);
310 EVP_PKEY_CTX_new_id(int id, ENGINE *e)
312 return int_ctx_new(NULL, e, id);
316 EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
320 if (!pctx->pmeth || !pctx->pmeth->copy)
322 #ifndef OPENSSL_NO_ENGINE
323 /* Make sure it's safe to copy a pkey context using an ENGINE */
324 if (pctx->engine && !ENGINE_init(pctx->engine)) {
325 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
329 rctx = malloc(sizeof(EVP_PKEY_CTX));
333 rctx->pmeth = pctx->pmeth;
334 #ifndef OPENSSL_NO_ENGINE
335 rctx->engine = pctx->engine;
339 CRYPTO_add(&pctx->pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
341 rctx->pkey = pctx->pkey;
344 CRYPTO_add(&pctx->peerkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
346 rctx->peerkey = pctx->peerkey;
349 rctx->app_data = NULL;
350 rctx->operation = pctx->operation;
352 if (pctx->pmeth->copy(rctx, pctx) > 0)
355 EVP_PKEY_CTX_free(rctx);
360 EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
362 if (app_pkey_methods == NULL) {
363 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
364 if (!app_pkey_methods)
367 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
369 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
374 EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
378 if (ctx->pmeth && ctx->pmeth->cleanup)
379 ctx->pmeth->cleanup(ctx);
380 EVP_PKEY_free(ctx->pkey);
381 EVP_PKEY_free(ctx->peerkey);
382 #ifndef OPENSSL_NO_ENGINE
384 /* The EVP_PKEY_CTX we used belongs to an ENGINE, release the
385 * functional reference we held for this reason. */
386 ENGINE_finish(ctx->engine);
392 EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype, int cmd,
397 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
398 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
401 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
404 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
405 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
409 if ((optype != -1) && !(ctx->operation & optype)) {
410 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
414 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
417 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
424 EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *name, const char *value)
426 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
427 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR,
428 EVP_R_COMMAND_NOT_SUPPORTED);
431 if (!strcmp(name, "digest")) {
433 if (!value || !(md = EVP_get_digestbyname(value))) {
434 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR,
435 EVP_R_INVALID_DIGEST);
438 return EVP_PKEY_CTX_set_signature_md(ctx, md);
440 return ctx->pmeth->ctrl_str(ctx, name, value);
444 EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
446 return ctx->operation;
450 EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
452 ctx->keygen_info = dat;
453 ctx->keygen_info_count = datlen;
457 EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
463 EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
469 EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
475 EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
481 EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
483 ctx->app_data = data;
487 EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
489 return ctx->app_data;
493 EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
494 int (*init)(EVP_PKEY_CTX *ctx))
500 EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
501 int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src))
507 EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
508 void (*cleanup)(EVP_PKEY_CTX *ctx))
510 pmeth->cleanup = cleanup;
514 EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
515 int (*paramgen_init)(EVP_PKEY_CTX *ctx),
516 int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
518 pmeth->paramgen_init = paramgen_init;
519 pmeth->paramgen = paramgen;
523 EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
524 int (*keygen_init)(EVP_PKEY_CTX *ctx),
525 int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
527 pmeth->keygen_init = keygen_init;
528 pmeth->keygen = keygen;
532 EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
533 int (*sign_init)(EVP_PKEY_CTX *ctx),
534 int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
535 const unsigned char *tbs, size_t tbslen))
537 pmeth->sign_init = sign_init;
542 EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
543 int (*verify_init)(EVP_PKEY_CTX *ctx),
544 int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen,
545 const unsigned char *tbs, size_t tbslen))
547 pmeth->verify_init = verify_init;
548 pmeth->verify = verify;
552 EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
553 int (*verify_recover_init)(EVP_PKEY_CTX *ctx),
554 int (*verify_recover)(EVP_PKEY_CTX *ctx,
555 unsigned char *sig, size_t *siglen,
556 const unsigned char *tbs, size_t tbslen))
558 pmeth->verify_recover_init = verify_recover_init;
559 pmeth->verify_recover = verify_recover;
563 EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
564 int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
565 int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
568 pmeth->signctx_init = signctx_init;
569 pmeth->signctx = signctx;
573 EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
574 int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
575 int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
578 pmeth->verifyctx_init = verifyctx_init;
579 pmeth->verifyctx = verifyctx;
583 EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
584 int (*encrypt_init)(EVP_PKEY_CTX *ctx),
585 int (*encryptfn)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
586 const unsigned char *in, size_t inlen))
588 pmeth->encrypt_init = encrypt_init;
589 pmeth->encrypt = encryptfn;
593 EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
594 int (*decrypt_init)(EVP_PKEY_CTX *ctx),
595 int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
596 const unsigned char *in, size_t inlen))
598 pmeth->decrypt_init = decrypt_init;
599 pmeth->decrypt = decrypt;
603 EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
604 int (*derive_init)(EVP_PKEY_CTX *ctx),
605 int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen))
607 pmeth->derive_init = derive_init;
608 pmeth->derive = derive;
612 EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
613 int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2),
614 int (*ctrl_str)(EVP_PKEY_CTX *ctx, const char *type, const char *value))
617 pmeth->ctrl_str = ctrl_str;