2 * Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include "internal/cryptlib.h"
13 #include <openssl/engine.h>
14 #include <openssl/evp.h>
15 #include <openssl/x509v3.h>
16 #include "internal/asn1_int.h"
17 #include "internal/evp_int.h"
18 #include "internal/numbers.h"
20 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
22 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
24 static const EVP_PKEY_METHOD *standard_methods[] = {
25 #ifndef OPENSSL_NO_RSA
31 #ifndef OPENSSL_NO_DSA
38 #ifndef OPENSSL_NO_CMAC
41 #ifndef OPENSSL_NO_RSA
52 #ifndef OPENSSL_NO_POLY1305
55 #ifndef OPENSSL_NO_SIPHASH
60 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
63 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
64 const EVP_PKEY_METHOD *const *b)
66 return ((*a)->pkey_id - (*b)->pkey_id);
69 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
72 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
75 const EVP_PKEY_METHOD *t = &tmp, **ret;
77 if (app_pkey_methods) {
79 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
81 return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
83 ret = OBJ_bsearch_pmeth(&t, standard_methods,
84 sizeof(standard_methods) /
85 sizeof(EVP_PKEY_METHOD *));
91 static EVP_PKEY_CTX *int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
94 const EVP_PKEY_METHOD *pmeth;
96 if (!pkey || !pkey->ameth)
98 id = pkey->ameth->pkey_id;
100 #ifndef OPENSSL_NO_ENGINE
101 if (pkey && pkey->engine)
103 /* Try to find an ENGINE which implements this method */
105 if (!ENGINE_init(e)) {
106 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
110 e = ENGINE_get_pkey_meth_engine(id);
113 * If an ENGINE handled this method look it up. Otherwise use internal
118 pmeth = ENGINE_get_pkey_meth(e, id);
121 pmeth = EVP_PKEY_meth_find(id);
124 EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
128 ret = OPENSSL_zalloc(sizeof(*ret));
130 #ifndef OPENSSL_NO_ENGINE
133 EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
138 ret->operation = EVP_PKEY_OP_UNDEFINED;
141 EVP_PKEY_up_ref(pkey);
144 if (pmeth->init(ret) <= 0) {
145 EVP_PKEY_CTX_free(ret);
153 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
155 EVP_PKEY_METHOD *pmeth;
157 pmeth = OPENSSL_zalloc(sizeof(*pmeth));
162 pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
166 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
167 const EVP_PKEY_METHOD *meth)
170 *ppkey_id = meth->pkey_id;
172 *pflags = meth->flags;
175 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
178 dst->init = src->init;
179 dst->copy = src->copy;
180 dst->cleanup = src->cleanup;
182 dst->paramgen_init = src->paramgen_init;
183 dst->paramgen = src->paramgen;
185 dst->keygen_init = src->keygen_init;
186 dst->keygen = src->keygen;
188 dst->sign_init = src->sign_init;
189 dst->sign = src->sign;
191 dst->verify_init = src->verify_init;
192 dst->verify = src->verify;
194 dst->verify_recover_init = src->verify_recover_init;
195 dst->verify_recover = src->verify_recover;
197 dst->signctx_init = src->signctx_init;
198 dst->signctx = src->signctx;
200 dst->verifyctx_init = src->verifyctx_init;
201 dst->verifyctx = src->verifyctx;
203 dst->encrypt_init = src->encrypt_init;
204 dst->encrypt = src->encrypt;
206 dst->decrypt_init = src->decrypt_init;
207 dst->decrypt = src->decrypt;
209 dst->derive_init = src->derive_init;
210 dst->derive = src->derive;
212 dst->ctrl = src->ctrl;
213 dst->ctrl_str = src->ctrl_str;
216 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
218 if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
222 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
224 return int_ctx_new(pkey, e, -1);
227 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
229 return int_ctx_new(NULL, e, id);
232 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
235 if (!pctx->pmeth || !pctx->pmeth->copy)
237 #ifndef OPENSSL_NO_ENGINE
238 /* Make sure it's safe to copy a pkey context using an ENGINE */
239 if (pctx->engine && !ENGINE_init(pctx->engine)) {
240 EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
244 rctx = OPENSSL_malloc(sizeof(*rctx));
248 rctx->pmeth = pctx->pmeth;
249 #ifndef OPENSSL_NO_ENGINE
250 rctx->engine = pctx->engine;
254 EVP_PKEY_up_ref(pctx->pkey);
256 rctx->pkey = pctx->pkey;
259 EVP_PKEY_up_ref(pctx->peerkey);
261 rctx->peerkey = pctx->peerkey;
264 rctx->app_data = NULL;
265 rctx->operation = pctx->operation;
267 if (pctx->pmeth->copy(rctx, pctx) > 0)
270 EVP_PKEY_CTX_free(rctx);
275 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
277 if (app_pkey_methods == NULL) {
278 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
279 if (app_pkey_methods == NULL)
282 if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
284 sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
288 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
292 if (ctx->pmeth && ctx->pmeth->cleanup)
293 ctx->pmeth->cleanup(ctx);
294 EVP_PKEY_free(ctx->pkey);
295 EVP_PKEY_free(ctx->peerkey);
296 #ifndef OPENSSL_NO_ENGINE
297 ENGINE_finish(ctx->engine);
302 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
303 int cmd, int p1, void *p2)
306 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl) {
307 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
310 if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
313 if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
314 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
318 if ((optype != -1) && !(ctx->operation & optype)) {
319 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
323 ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
326 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
332 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
333 const char *name, const char *value)
335 if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
336 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
339 if (strcmp(name, "digest") == 0)
340 return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD,
342 return ctx->pmeth->ctrl_str(ctx, name, value);
345 /* Utility functions to send a string of hex string to a ctrl */
347 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
354 return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
357 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
363 bin = OPENSSL_hexstr2buf(hex, &binlen);
366 if (binlen <= INT_MAX)
367 rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
372 /* Pass a message digest to a ctrl */
373 int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md)
377 if (md == NULL || (m = EVP_get_digestbyname(md)) == NULL) {
378 EVPerr(EVP_F_EVP_PKEY_CTX_MD, EVP_R_INVALID_DIGEST);
381 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)m);
384 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
386 return ctx->operation;
389 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
391 ctx->keygen_info = dat;
392 ctx->keygen_info_count = datlen;
395 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
400 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
405 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
410 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
415 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
417 ctx->app_data = data;
420 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
422 return ctx->app_data;
425 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
426 int (*init) (EVP_PKEY_CTX *ctx))
431 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
432 int (*copy) (EVP_PKEY_CTX *dst,
438 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
439 void (*cleanup) (EVP_PKEY_CTX *ctx))
441 pmeth->cleanup = cleanup;
444 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
445 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
446 int (*paramgen) (EVP_PKEY_CTX *ctx,
449 pmeth->paramgen_init = paramgen_init;
450 pmeth->paramgen = paramgen;
453 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
454 int (*keygen_init) (EVP_PKEY_CTX *ctx),
455 int (*keygen) (EVP_PKEY_CTX *ctx,
458 pmeth->keygen_init = keygen_init;
459 pmeth->keygen = keygen;
462 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
463 int (*sign_init) (EVP_PKEY_CTX *ctx),
464 int (*sign) (EVP_PKEY_CTX *ctx,
465 unsigned char *sig, size_t *siglen,
466 const unsigned char *tbs,
469 pmeth->sign_init = sign_init;
473 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
474 int (*verify_init) (EVP_PKEY_CTX *ctx),
475 int (*verify) (EVP_PKEY_CTX *ctx,
476 const unsigned char *sig,
478 const unsigned char *tbs,
481 pmeth->verify_init = verify_init;
482 pmeth->verify = verify;
485 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
486 int (*verify_recover_init) (EVP_PKEY_CTX
488 int (*verify_recover) (EVP_PKEY_CTX
497 pmeth->verify_recover_init = verify_recover_init;
498 pmeth->verify_recover = verify_recover;
501 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
502 int (*signctx_init) (EVP_PKEY_CTX *ctx,
504 int (*signctx) (EVP_PKEY_CTX *ctx,
509 pmeth->signctx_init = signctx_init;
510 pmeth->signctx = signctx;
513 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
514 int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
516 int (*verifyctx) (EVP_PKEY_CTX *ctx,
517 const unsigned char *sig,
521 pmeth->verifyctx_init = verifyctx_init;
522 pmeth->verifyctx = verifyctx;
525 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
526 int (*encrypt_init) (EVP_PKEY_CTX *ctx),
527 int (*encryptfn) (EVP_PKEY_CTX *ctx,
530 const unsigned char *in,
533 pmeth->encrypt_init = encrypt_init;
534 pmeth->encrypt = encryptfn;
537 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
538 int (*decrypt_init) (EVP_PKEY_CTX *ctx),
539 int (*decrypt) (EVP_PKEY_CTX *ctx,
542 const unsigned char *in,
545 pmeth->decrypt_init = decrypt_init;
546 pmeth->decrypt = decrypt;
549 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
550 int (*derive_init) (EVP_PKEY_CTX *ctx),
551 int (*derive) (EVP_PKEY_CTX *ctx,
555 pmeth->derive_init = derive_init;
556 pmeth->derive = derive;
559 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
560 int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
562 int (*ctrl_str) (EVP_PKEY_CTX *ctx,
567 pmeth->ctrl_str = ctrl_str;
570 void EVP_PKEY_meth_get_init(EVP_PKEY_METHOD *pmeth,
571 int (**pinit) (EVP_PKEY_CTX *ctx))
573 *pinit = pmeth->init;
576 void EVP_PKEY_meth_get_copy(EVP_PKEY_METHOD *pmeth,
577 int (**pcopy) (EVP_PKEY_CTX *dst,
580 *pcopy = pmeth->copy;
583 void EVP_PKEY_meth_get_cleanup(EVP_PKEY_METHOD *pmeth,
584 void (**pcleanup) (EVP_PKEY_CTX *ctx))
586 *pcleanup = pmeth->cleanup;
589 void EVP_PKEY_meth_get_paramgen(EVP_PKEY_METHOD *pmeth,
590 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
591 int (**pparamgen) (EVP_PKEY_CTX *ctx,
595 *pparamgen_init = pmeth->paramgen_init;
597 *pparamgen = pmeth->paramgen;
600 void EVP_PKEY_meth_get_keygen(EVP_PKEY_METHOD *pmeth,
601 int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
602 int (**pkeygen) (EVP_PKEY_CTX *ctx,
606 *pkeygen_init = pmeth->keygen_init;
608 *pkeygen = pmeth->keygen;
611 void EVP_PKEY_meth_get_sign(EVP_PKEY_METHOD *pmeth,
612 int (**psign_init) (EVP_PKEY_CTX *ctx),
613 int (**psign) (EVP_PKEY_CTX *ctx,
614 unsigned char *sig, size_t *siglen,
615 const unsigned char *tbs,
619 *psign_init = pmeth->sign_init;
621 *psign = pmeth->sign;
624 void EVP_PKEY_meth_get_verify(EVP_PKEY_METHOD *pmeth,
625 int (**pverify_init) (EVP_PKEY_CTX *ctx),
626 int (**pverify) (EVP_PKEY_CTX *ctx,
627 const unsigned char *sig,
629 const unsigned char *tbs,
633 *pverify_init = pmeth->verify_init;
635 *pverify = pmeth->verify;
638 void EVP_PKEY_meth_get_verify_recover(EVP_PKEY_METHOD *pmeth,
639 int (**pverify_recover_init) (EVP_PKEY_CTX
641 int (**pverify_recover) (EVP_PKEY_CTX
650 if (pverify_recover_init)
651 *pverify_recover_init = pmeth->verify_recover_init;
653 *pverify_recover = pmeth->verify_recover;
656 void EVP_PKEY_meth_get_signctx(EVP_PKEY_METHOD *pmeth,
657 int (**psignctx_init) (EVP_PKEY_CTX *ctx,
659 int (**psignctx) (EVP_PKEY_CTX *ctx,
665 *psignctx_init = pmeth->signctx_init;
667 *psignctx = pmeth->signctx;
670 void EVP_PKEY_meth_get_verifyctx(EVP_PKEY_METHOD *pmeth,
671 int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
673 int (**pverifyctx) (EVP_PKEY_CTX *ctx,
674 const unsigned char *sig,
679 *pverifyctx_init = pmeth->verifyctx_init;
681 *pverifyctx = pmeth->verifyctx;
684 void EVP_PKEY_meth_get_encrypt(EVP_PKEY_METHOD *pmeth,
685 int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
686 int (**pencryptfn) (EVP_PKEY_CTX *ctx,
689 const unsigned char *in,
693 *pencrypt_init = pmeth->encrypt_init;
695 *pencryptfn = pmeth->encrypt;
698 void EVP_PKEY_meth_get_decrypt(EVP_PKEY_METHOD *pmeth,
699 int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
700 int (**pdecrypt) (EVP_PKEY_CTX *ctx,
703 const unsigned char *in,
707 *pdecrypt_init = pmeth->decrypt_init;
709 *pdecrypt = pmeth->decrypt;
712 void EVP_PKEY_meth_get_derive(EVP_PKEY_METHOD *pmeth,
713 int (**pderive_init) (EVP_PKEY_CTX *ctx),
714 int (**pderive) (EVP_PKEY_CTX *ctx,
719 *pderive_init = pmeth->derive_init;
721 *pderive = pmeth->derive;
724 void EVP_PKEY_meth_get_ctrl(EVP_PKEY_METHOD *pmeth,
725 int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
727 int (**pctrl_str) (EVP_PKEY_CTX *ctx,
732 *pctrl = pmeth->ctrl;
734 *pctrl_str = pmeth->ctrl_str;