2 * Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
11 #include "internal/cryptlib.h"
12 #include <openssl/evp.h>
13 #include <openssl/objects.h>
14 #include <openssl/x509.h>
15 #include "crypto/evp.h"
16 #include "internal/provider.h"
17 #include "evp_local.h"
21 static int update(EVP_MD_CTX *ctx, const void *data, size_t datalen)
23 EVPerr(EVP_F_UPDATE, EVP_R_ONLY_ONESHOT_SUPPORTED);
28 * If we get the "NULL" md then the name comes back as "UNDEF". We want to use
31 static const char *canon_mdname(const char *mdname)
33 if (mdname != NULL && strcmp(mdname, "UNDEF") == 0)
39 static int do_sigver_init(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
40 const EVP_MD *type, const char *mdname,
41 OPENSSL_CTX *libctx, const char *props,
42 ENGINE *e, EVP_PKEY *pkey, int ver)
44 EVP_PKEY_CTX *locpctx = NULL;
45 EVP_SIGNATURE *signature = NULL;
46 EVP_KEYMGMT *tmp_keymgmt = NULL;
47 const char *supported_sig = NULL;
48 char locmdname[80] = ""; /* 80 chars should be enough */
52 if (ctx->provctx != NULL) {
53 if (!ossl_assert(ctx->digest != NULL)) {
54 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
57 if (ctx->digest->freectx != NULL)
58 ctx->digest->freectx(ctx->provctx);
62 if (ctx->pctx == NULL) {
64 ctx->pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, props);
66 ctx->pctx = EVP_PKEY_CTX_new(pkey, e);
68 if (ctx->pctx == NULL)
72 evp_pkey_ctx_free_old_ops(locpctx);
75 props = locpctx->propquery;
78 * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
79 * calls can be removed.
83 if (locpctx->engine != NULL || locpctx->keytype == NULL)
87 * Ensure that the key is provided, either natively, or as a cached export.
89 tmp_keymgmt = locpctx->keymgmt;
90 provkey = evp_pkey_export_to_provider(locpctx->pkey, locpctx->libctx,
91 &tmp_keymgmt, locpctx->propquery);
92 if (provkey == NULL) {
94 * If we couldn't find a keymgmt at all try legacy.
95 * TODO(3.0): Once all legacy algorithms (SM2, HMAC etc) have provider
96 * based implementations this fallback shouldn't be necessary. Either
97 * we have an ENGINE based implementation (in which case we should have
98 * already fallen back in the test above here), or we don't have the
99 * provider based implementation loaded (in which case this is an
100 * application config error)
102 if (locpctx->keymgmt == NULL)
104 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
107 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
108 ERR_clear_last_mark();
109 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
112 EVP_KEYMGMT_free(locpctx->keymgmt);
113 locpctx->keymgmt = tmp_keymgmt;
115 if (locpctx->keymgmt->query_operation_name != NULL)
117 locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
120 * If we didn't get a supported sig, assume there is one with the
121 * same name as the key type.
123 if (supported_sig == NULL)
124 supported_sig = locpctx->keytype;
127 * Because we cleared out old ops, we shouldn't need to worry about
128 * checking if signature is already there.
130 signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
133 if (signature == NULL
134 || (EVP_KEYMGMT_provider(locpctx->keymgmt)
135 != EVP_SIGNATURE_provider(signature))) {
137 * We don't need to free ctx->keymgmt here, as it's not necessarily
138 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
140 EVP_SIGNATURE_free(signature);
145 * TODO remove this when legacy is gone
146 * If we don't have the full support we need with provided methods,
147 * let's go see if legacy does.
151 /* No more legacy from here down to legacy: */
156 locpctx->op.sig.signature = signature;
157 locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
158 : EVP_PKEY_OP_SIGNCTX;
159 locpctx->op.sig.sigprovctx
160 = signature->newctx(ossl_provider_ctx(signature->prov), props);
161 if (locpctx->op.sig.sigprovctx == NULL) {
162 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
166 ctx->reqdigest = type;
168 mdname = canon_mdname(EVP_MD_name(type));
170 if (mdname == NULL) {
171 if (evp_keymgmt_util_get_deflt_digest_name(tmp_keymgmt, provkey,
173 sizeof(locmdname)) > 0) {
174 mdname = canon_mdname(locmdname);
178 if (mdname != NULL) {
180 * This might be requested by a later call to EVP_MD_CTX_md().
181 * In that case the "explicit fetch" rules apply for that
182 * function (as per man pages), i.e. the ref count is not updated
183 * so the EVP_MD should not be used beyound the lifetime of the
186 ctx->digest = ctx->reqdigest = ctx->fetched_digest =
187 EVP_MD_fetch(locpctx->libctx, mdname, props);
192 if (signature->digest_verify_init == NULL) {
193 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
196 ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
199 if (signature->digest_sign_init == NULL) {
200 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
203 ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
210 evp_pkey_ctx_free_old_ops(locpctx);
211 locpctx->operation = EVP_PKEY_OP_UNDEFINED;
216 * TODO remove this when legacy is gone
217 * If we don't have the full support we need with provided methods,
218 * let's go see if legacy does.
222 if (type == NULL && mdname != NULL)
223 type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
225 if (ctx->pctx->pmeth == NULL) {
226 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
230 if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
234 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
235 type = EVP_get_digestbynid(def_nid);
239 EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
245 if (ctx->pctx->pmeth->verifyctx_init) {
246 if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
248 ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
249 } else if (ctx->pctx->pmeth->digestverify != 0) {
250 ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
251 ctx->update = update;
252 } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
256 if (ctx->pctx->pmeth->signctx_init) {
257 if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
259 ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
260 } else if (ctx->pctx->pmeth->digestsign != 0) {
261 ctx->pctx->operation = EVP_PKEY_OP_SIGN;
262 ctx->update = update;
263 } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
267 if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
271 if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
273 if (!EVP_DigestInit_ex(ctx, type, e))
276 * This indicates the current algorithm requires
277 * special treatment before hashing the tbs-message.
279 ctx->pctx->flag_call_digest_custom = 0;
280 if (ctx->pctx->pmeth->digest_custom != NULL)
281 ctx->pctx->flag_call_digest_custom = 1;
288 ret = evp_pkey_ctx_use_cached_data(locpctx);
291 return ret > 0 ? 1 : 0;
294 int EVP_DigestSignInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
296 OPENSSL_CTX *libctx, const char *props,
299 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0);
302 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
303 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
305 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0);
308 int EVP_DigestVerifyInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
310 OPENSSL_CTX *libctx, const char *props,
313 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 1);
316 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
317 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
319 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 1);
321 #endif /* FIPS_MDOE */
323 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
325 EVP_PKEY_CTX *pctx = ctx->pctx;
328 || pctx->operation != EVP_PKEY_OP_SIGNCTX
329 || pctx->op.sig.sigprovctx == NULL
330 || pctx->op.sig.signature == NULL)
333 if (pctx->op.sig.signature->digest_sign_update == NULL) {
334 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
338 return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
343 /* do_sigver_init() checked that |digest_custom| is non-NULL */
344 if (pctx->flag_call_digest_custom
345 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
347 pctx->flag_call_digest_custom = 0;
350 return EVP_DigestUpdate(ctx, data, dsize);
353 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
355 EVP_PKEY_CTX *pctx = ctx->pctx;
358 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
359 || pctx->op.sig.sigprovctx == NULL
360 || pctx->op.sig.signature == NULL)
363 if (pctx->op.sig.signature->digest_verify_update == NULL) {
364 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
368 return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
373 /* do_sigver_init() checked that |digest_custom| is non-NULL */
374 if (pctx->flag_call_digest_custom
375 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
377 pctx->flag_call_digest_custom = 0;
380 return EVP_DigestUpdate(ctx, data, dsize);
384 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
388 EVP_PKEY_CTX *pctx = ctx->pctx;
391 || pctx->operation != EVP_PKEY_OP_SIGNCTX
392 || pctx->op.sig.sigprovctx == NULL
393 || pctx->op.sig.signature == NULL)
396 return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
397 sigret, siglen, SIZE_MAX);
400 if (pctx == NULL || pctx->pmeth == NULL) {
401 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
405 /* do_sigver_init() checked that |digest_custom| is non-NULL */
406 if (pctx->flag_call_digest_custom
407 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
409 pctx->flag_call_digest_custom = 0;
411 if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
413 return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
414 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
415 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
417 EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
421 r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
422 EVP_PKEY_CTX_free(dctx);
426 if (pctx->pmeth->signctx != NULL)
430 if (sigret != NULL) {
431 unsigned char md[EVP_MAX_MD_SIZE];
432 unsigned int mdlen = 0;
434 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
436 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
438 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
440 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
444 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
445 EVP_MD_CTX_free(tmp_ctx);
449 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
450 sigret, siglen, tmp_ctx);
452 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
453 EVP_MD_CTX_free(tmp_ctx);
457 if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
461 if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
464 int s = EVP_MD_size(ctx->digest);
466 if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
473 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
474 const unsigned char *tbs, size_t tbslen)
476 EVP_PKEY_CTX *pctx = ctx->pctx;
479 && pctx->operation == EVP_PKEY_OP_SIGNCTX
480 && pctx->op.sig.sigprovctx != NULL
481 && pctx->op.sig.signature != NULL) {
482 if (pctx->op.sig.signature->digest_sign != NULL)
483 return pctx->op.sig.signature->digest_sign(pctx->op.sig.sigprovctx,
484 sigret, siglen, SIZE_MAX,
488 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
489 return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
492 if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
494 return EVP_DigestSignFinal(ctx, sigret, siglen);
497 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
500 unsigned char md[EVP_MAX_MD_SIZE];
502 unsigned int mdlen = 0;
504 EVP_PKEY_CTX *pctx = ctx->pctx;
507 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
508 || pctx->op.sig.sigprovctx == NULL
509 || pctx->op.sig.signature == NULL)
512 return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
516 if (pctx == NULL || pctx->pmeth == NULL) {
517 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
521 /* do_sigver_init() checked that |digest_custom| is non-NULL */
522 if (pctx->flag_call_digest_custom
523 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
525 pctx->flag_call_digest_custom = 0;
527 if (pctx->pmeth->verifyctx != NULL)
531 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
533 r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
535 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
537 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
540 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
541 EVP_MD_CTX_free(tmp_ctx);
545 r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
546 sig, siglen, tmp_ctx);
548 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
549 EVP_MD_CTX_free(tmp_ctx);
553 return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
556 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
557 size_t siglen, const unsigned char *tbs, size_t tbslen)
559 EVP_PKEY_CTX *pctx = ctx->pctx;
562 && pctx->operation == EVP_PKEY_OP_VERIFYCTX
563 && pctx->op.sig.sigprovctx != NULL
564 && pctx->op.sig.signature != NULL) {
565 if (pctx->op.sig.signature->digest_verify != NULL)
566 return pctx->op.sig.signature->digest_verify(pctx->op.sig.sigprovctx,
571 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
572 return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
575 if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
577 return EVP_DigestVerifyFinal(ctx, sigret, siglen);
579 #endif /* FIPS_MODULE */