1 /* $OpenBSD: pmeth_lib.c,v 1.22 2022/05/05 08:51:21 tb 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).
64 #include <openssl/opensslconf.h>
66 #include <openssl/err.h>
67 #include <openssl/evp.h>
68 #include <openssl/objects.h>
69 #include <openssl/x509v3.h>
71 #ifndef OPENSSL_NO_ENGINE
72 #include <openssl/engine.h>
75 #include "asn1_locl.h"
78 typedef int sk_cmp_fn_type(const char * const *a, const char * const *b);
80 DECLARE_STACK_OF(EVP_PKEY_METHOD)
81 STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
83 extern const EVP_PKEY_METHOD rsa_pkey_meth, rsa_pss_pkey_meth;
84 extern const EVP_PKEY_METHOD dh_pkey_meth, dsa_pkey_meth;
85 extern const EVP_PKEY_METHOD ec_pkey_meth, hmac_pkey_meth, cmac_pkey_meth;
86 extern const EVP_PKEY_METHOD gostimit_pkey_meth, gostr01_pkey_meth;
87 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
89 static const EVP_PKEY_METHOD *standard_methods[] = {
90 #ifndef OPENSSL_NO_RSA
96 #ifndef OPENSSL_NO_DSA
102 #ifndef OPENSSL_NO_GOST
108 #ifndef OPENSSL_NO_RSA
114 static int pmeth_cmp_BSEARCH_CMP_FN(const void *, const void *);
115 static int pmeth_cmp(const EVP_PKEY_METHOD * const *, const EVP_PKEY_METHOD * const *);
116 static const EVP_PKEY_METHOD * *OBJ_bsearch_pmeth(const EVP_PKEY_METHOD * *key, const EVP_PKEY_METHOD * const *base, int num);
119 pmeth_cmp(const EVP_PKEY_METHOD * const *a, const EVP_PKEY_METHOD * const *b)
121 return ((*a)->pkey_id - (*b)->pkey_id);
126 pmeth_cmp_BSEARCH_CMP_FN(const void *a_, const void *b_)
128 const EVP_PKEY_METHOD * const *a = a_;
129 const EVP_PKEY_METHOD * const *b = b_;
130 return pmeth_cmp(a, b);
133 static const EVP_PKEY_METHOD * *
134 OBJ_bsearch_pmeth(const EVP_PKEY_METHOD * *key, const EVP_PKEY_METHOD * const *base, int num)
136 return (const EVP_PKEY_METHOD * *)OBJ_bsearch_(key, base, num, sizeof(const EVP_PKEY_METHOD *),
137 pmeth_cmp_BSEARCH_CMP_FN);
140 const EVP_PKEY_METHOD *
141 EVP_PKEY_meth_find(int type)
144 const EVP_PKEY_METHOD *t = &tmp, **ret;
147 if (app_pkey_methods) {
149 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
151 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
153 ret = OBJ_bsearch_pmeth(&t, standard_methods,
154 sizeof(standard_methods)/sizeof(EVP_PKEY_METHOD *));
160 static EVP_PKEY_CTX *
161 int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
164 const EVP_PKEY_METHOD *pmeth;
167 if (!pkey || !pkey->ameth)
169 id = pkey->ameth->pkey_id;
171 #ifndef OPENSSL_NO_ENGINE
172 if (pkey && pkey->engine)
174 /* Try to find an ENGINE which implements this method */
176 if (!ENGINE_init(e)) {
177 EVPerror(ERR_R_ENGINE_LIB);
181 e = ENGINE_get_pkey_meth_engine(id);
183 /* If an ENGINE handled this method look it up. Othewise
184 * use internal tables.
188 pmeth = ENGINE_get_pkey_meth(e, id);
191 pmeth = EVP_PKEY_meth_find(id);
194 EVPerror(EVP_R_UNSUPPORTED_ALGORITHM);
198 ret = malloc(sizeof(EVP_PKEY_CTX));
200 #ifndef OPENSSL_NO_ENGINE
203 EVPerror(ERR_R_MALLOC_FAILURE);
208 ret->operation = EVP_PKEY_OP_UNDEFINED;
213 CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
217 if (pmeth->init(ret) <= 0) {
218 EVP_PKEY_CTX_free(ret);
227 EVP_PKEY_meth_new(int id, int flags)
229 EVP_PKEY_METHOD *pmeth;
231 if ((pmeth = calloc(1, sizeof(EVP_PKEY_METHOD))) == NULL)
235 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
241 EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags, const EVP_PKEY_METHOD *meth)
244 *ppkey_id = meth->pkey_id;
246 *pflags = meth->flags;
250 EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
252 EVP_PKEY_METHOD preserve;
254 preserve.pkey_id = dst->pkey_id;
255 preserve.flags = dst->flags;
259 dst->pkey_id = preserve.pkey_id;
260 dst->flags = preserve.flags;
264 EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
266 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
271 EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
273 return int_ctx_new(pkey, e, -1);
277 EVP_PKEY_CTX_new_id(int id, ENGINE *e)
279 return int_ctx_new(NULL, e, id);
283 EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
287 if (!pctx->pmeth || !pctx->pmeth->copy)
289 #ifndef OPENSSL_NO_ENGINE
290 /* Make sure it's safe to copy a pkey context using an ENGINE */
291 if (pctx->engine && !ENGINE_init(pctx->engine)) {
292 EVPerror(ERR_R_ENGINE_LIB);
296 rctx = malloc(sizeof(EVP_PKEY_CTX));
300 rctx->pmeth = pctx->pmeth;
301 #ifndef OPENSSL_NO_ENGINE
302 rctx->engine = pctx->engine;
306 CRYPTO_add(&pctx->pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
308 rctx->pkey = pctx->pkey;
311 CRYPTO_add(&pctx->peerkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
313 rctx->peerkey = pctx->peerkey;
316 rctx->app_data = NULL;
317 rctx->operation = pctx->operation;
319 if (pctx->pmeth->copy(rctx, pctx) > 0)
322 EVP_PKEY_CTX_free(rctx);
327 EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
329 if (app_pkey_methods == NULL) {
330 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
331 if (!app_pkey_methods)
334 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
336 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
341 EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
345 if (ctx->pmeth && ctx->pmeth->cleanup)
346 ctx->pmeth->cleanup(ctx);
347 EVP_PKEY_free(ctx->pkey);
348 EVP_PKEY_free(ctx->peerkey);
349 #ifndef OPENSSL_NO_ENGINE
350 ENGINE_finish(ctx->engine);
356 EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype, int cmd,
361 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
362 EVPerror(EVP_R_COMMAND_NOT_SUPPORTED);
365 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
368 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
369 EVPerror(EVP_R_NO_OPERATION_SET);
373 if ((optype != -1) && !(ctx->operation & optype)) {
374 EVPerror(EVP_R_INVALID_OPERATION);
378 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
381 EVPerror(EVP_R_COMMAND_NOT_SUPPORTED);
388 EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *name, const char *value)
390 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
391 EVPerror(EVP_R_COMMAND_NOT_SUPPORTED);
394 if (!strcmp(name, "digest")) {
395 return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_TYPE_SIG,
396 EVP_PKEY_CTRL_MD, value);
398 return ctx->pmeth->ctrl_str(ctx, name, value);
402 EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
406 if ((len = strlen(str)) > INT_MAX)
409 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
413 EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hexstr)
415 unsigned char *hex = NULL;
419 if ((hex = string_to_hex(hexstr, &length)) == NULL)
421 if (length < 0 || length > INT_MAX) {
426 ret = ctx->pmeth->ctrl(ctx, cmd, length, hex);
434 EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md_name)
438 if ((md = EVP_get_digestbyname(md_name)) == NULL) {
439 EVPerror(EVP_R_INVALID_DIGEST);
442 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)md);
446 EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
448 return ctx->operation;
452 EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
454 ctx->keygen_info = dat;
455 ctx->keygen_info_count = datlen;
459 EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
465 EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
471 EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
477 EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
483 EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
485 ctx->app_data = data;
489 EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
491 return ctx->app_data;
495 EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
496 int (*init)(EVP_PKEY_CTX *ctx))
502 EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
503 int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src))
509 EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
510 void (*cleanup)(EVP_PKEY_CTX *ctx))
512 pmeth->cleanup = cleanup;
516 EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
517 int (*paramgen_init)(EVP_PKEY_CTX *ctx),
518 int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
520 pmeth->paramgen_init = paramgen_init;
521 pmeth->paramgen = paramgen;
525 EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
526 int (*keygen_init)(EVP_PKEY_CTX *ctx),
527 int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
529 pmeth->keygen_init = keygen_init;
530 pmeth->keygen = keygen;
534 EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
535 int (*sign_init)(EVP_PKEY_CTX *ctx),
536 int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
537 const unsigned char *tbs, size_t tbslen))
539 pmeth->sign_init = sign_init;
544 EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
545 int (*verify_init)(EVP_PKEY_CTX *ctx),
546 int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen,
547 const unsigned char *tbs, size_t tbslen))
549 pmeth->verify_init = verify_init;
550 pmeth->verify = verify;
554 EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
555 int (*verify_recover_init)(EVP_PKEY_CTX *ctx),
556 int (*verify_recover)(EVP_PKEY_CTX *ctx,
557 unsigned char *sig, size_t *siglen,
558 const unsigned char *tbs, size_t tbslen))
560 pmeth->verify_recover_init = verify_recover_init;
561 pmeth->verify_recover = verify_recover;
565 EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
566 int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
567 int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
570 pmeth->signctx_init = signctx_init;
571 pmeth->signctx = signctx;
575 EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
576 int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
577 int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
580 pmeth->verifyctx_init = verifyctx_init;
581 pmeth->verifyctx = verifyctx;
585 EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
586 int (*encrypt_init)(EVP_PKEY_CTX *ctx),
587 int (*encryptfn)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
588 const unsigned char *in, size_t inlen))
590 pmeth->encrypt_init = encrypt_init;
591 pmeth->encrypt = encryptfn;
595 EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
596 int (*decrypt_init)(EVP_PKEY_CTX *ctx),
597 int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
598 const unsigned char *in, size_t inlen))
600 pmeth->decrypt_init = decrypt_init;
601 pmeth->decrypt = decrypt;
605 EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
606 int (*derive_init)(EVP_PKEY_CTX *ctx),
607 int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen))
609 pmeth->derive_init = derive_init;
610 pmeth->derive = derive;
614 EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
615 int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2),
616 int (*ctrl_str)(EVP_PKEY_CTX *ctx, const char *type, const char *value))
619 pmeth->ctrl_str = ctrl_str;
623 EVP_PKEY_meth_set_check(EVP_PKEY_METHOD *pmeth, int (*check)(EVP_PKEY *pkey))
625 pmeth->check = check;
629 EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD *pmeth,
630 int (*public_check)(EVP_PKEY *pkey))
632 pmeth->public_check = public_check;
636 EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD *pmeth,
637 int (*param_check)(EVP_PKEY *pkey))
639 pmeth->param_check = param_check;