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 * We're about to get a new digest so clear anything associated with
183 evp_md_ctx_clear_digest(ctx, 1);
186 * This might be requested by a later call to EVP_MD_CTX_md().
187 * In that case the "explicit fetch" rules apply for that
188 * function (as per man pages), i.e. the ref count is not updated
189 * so the EVP_MD should not be used beyound the lifetime of the
192 ctx->digest = ctx->reqdigest = ctx->fetched_digest =
193 EVP_MD_fetch(locpctx->libctx, mdname, props);
194 if (ctx->digest == NULL) {
195 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
202 if (signature->digest_verify_init == NULL) {
203 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
206 ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
209 if (signature->digest_sign_init == NULL) {
210 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
213 ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
220 evp_pkey_ctx_free_old_ops(locpctx);
221 locpctx->operation = EVP_PKEY_OP_UNDEFINED;
226 * TODO remove this when legacy is gone
227 * If we don't have the full support we need with provided methods,
228 * let's go see if legacy does.
232 if (type == NULL && mdname != NULL)
233 type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
235 if (ctx->pctx->pmeth == NULL) {
236 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
240 if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
244 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
245 type = EVP_get_digestbynid(def_nid);
249 EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
255 if (ctx->pctx->pmeth->verifyctx_init) {
256 if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
258 ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
259 } else if (ctx->pctx->pmeth->digestverify != 0) {
260 ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
261 ctx->update = update;
262 } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
266 if (ctx->pctx->pmeth->signctx_init) {
267 if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
269 ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
270 } else if (ctx->pctx->pmeth->digestsign != 0) {
271 ctx->pctx->operation = EVP_PKEY_OP_SIGN;
272 ctx->update = update;
273 } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
277 if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
281 if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
283 if (!EVP_DigestInit_ex(ctx, type, e))
286 * This indicates the current algorithm requires
287 * special treatment before hashing the tbs-message.
289 ctx->pctx->flag_call_digest_custom = 0;
290 if (ctx->pctx->pmeth->digest_custom != NULL)
291 ctx->pctx->flag_call_digest_custom = 1;
298 ret = evp_pkey_ctx_use_cached_data(locpctx);
301 return ret > 0 ? 1 : 0;
304 int EVP_DigestSignInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
306 OPENSSL_CTX *libctx, const char *props,
309 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0);
312 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
313 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
315 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0);
318 int EVP_DigestVerifyInit_with_libctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
320 OPENSSL_CTX *libctx, const char *props,
323 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 1);
326 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
327 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
329 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 1);
331 #endif /* FIPS_MDOE */
333 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
335 EVP_PKEY_CTX *pctx = ctx->pctx;
338 || pctx->operation != EVP_PKEY_OP_SIGNCTX
339 || pctx->op.sig.sigprovctx == NULL
340 || pctx->op.sig.signature == NULL)
343 if (pctx->op.sig.signature->digest_sign_update == NULL) {
344 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
348 return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
353 /* do_sigver_init() checked that |digest_custom| is non-NULL */
354 if (pctx->flag_call_digest_custom
355 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
357 pctx->flag_call_digest_custom = 0;
360 return EVP_DigestUpdate(ctx, data, dsize);
363 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
365 EVP_PKEY_CTX *pctx = ctx->pctx;
368 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
369 || pctx->op.sig.sigprovctx == NULL
370 || pctx->op.sig.signature == NULL)
373 if (pctx->op.sig.signature->digest_verify_update == NULL) {
374 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
378 return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
383 /* do_sigver_init() checked that |digest_custom| is non-NULL */
384 if (pctx->flag_call_digest_custom
385 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
387 pctx->flag_call_digest_custom = 0;
390 return EVP_DigestUpdate(ctx, data, dsize);
394 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
398 EVP_PKEY_CTX *pctx = ctx->pctx;
401 || pctx->operation != EVP_PKEY_OP_SIGNCTX
402 || pctx->op.sig.sigprovctx == NULL
403 || pctx->op.sig.signature == NULL)
406 return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
407 sigret, siglen, SIZE_MAX);
410 if (pctx == NULL || pctx->pmeth == NULL) {
411 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
415 /* do_sigver_init() checked that |digest_custom| is non-NULL */
416 if (pctx->flag_call_digest_custom
417 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
419 pctx->flag_call_digest_custom = 0;
421 if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
423 return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
424 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
425 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
427 EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
431 r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
432 EVP_PKEY_CTX_free(dctx);
436 if (pctx->pmeth->signctx != NULL)
440 if (sigret != NULL) {
441 unsigned char md[EVP_MAX_MD_SIZE];
442 unsigned int mdlen = 0;
444 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
446 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
448 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
450 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
454 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
455 EVP_MD_CTX_free(tmp_ctx);
459 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
460 sigret, siglen, tmp_ctx);
462 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
463 EVP_MD_CTX_free(tmp_ctx);
467 if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
471 if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
474 int s = EVP_MD_size(ctx->digest);
476 if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
483 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
484 const unsigned char *tbs, size_t tbslen)
486 EVP_PKEY_CTX *pctx = ctx->pctx;
489 && pctx->operation == EVP_PKEY_OP_SIGNCTX
490 && pctx->op.sig.sigprovctx != NULL
491 && pctx->op.sig.signature != NULL) {
492 if (pctx->op.sig.signature->digest_sign != NULL)
493 return pctx->op.sig.signature->digest_sign(pctx->op.sig.sigprovctx,
494 sigret, siglen, SIZE_MAX,
498 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
499 return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
502 if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
504 return EVP_DigestSignFinal(ctx, sigret, siglen);
507 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
510 unsigned char md[EVP_MAX_MD_SIZE];
512 unsigned int mdlen = 0;
514 EVP_PKEY_CTX *pctx = ctx->pctx;
517 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
518 || pctx->op.sig.sigprovctx == NULL
519 || pctx->op.sig.signature == NULL)
522 return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
526 if (pctx == NULL || pctx->pmeth == NULL) {
527 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
531 /* do_sigver_init() checked that |digest_custom| is non-NULL */
532 if (pctx->flag_call_digest_custom
533 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
535 pctx->flag_call_digest_custom = 0;
537 if (pctx->pmeth->verifyctx != NULL)
541 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
543 r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
545 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
547 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
550 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
551 EVP_MD_CTX_free(tmp_ctx);
555 r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
556 sig, siglen, tmp_ctx);
558 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
559 EVP_MD_CTX_free(tmp_ctx);
563 return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
566 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
567 size_t siglen, const unsigned char *tbs, size_t tbslen)
569 EVP_PKEY_CTX *pctx = ctx->pctx;
572 && pctx->operation == EVP_PKEY_OP_VERIFYCTX
573 && pctx->op.sig.sigprovctx != NULL
574 && pctx->op.sig.signature != NULL) {
575 if (pctx->op.sig.signature->digest_verify != NULL)
576 return pctx->op.sig.signature->digest_verify(pctx->op.sig.sigprovctx,
581 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
582 return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
585 if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
587 return EVP_DigestVerifyFinal(ctx, sigret, siglen);
589 #endif /* FIPS_MODULE */