2 * Copyright 2006-2021 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 "crypto/evp.h"
15 #include "internal/provider.h"
16 #include "internal/numbers.h" /* includes SIZE_MAX */
17 #include "evp_local.h"
21 static int update(EVP_MD_CTX *ctx, const void *data, size_t datalen)
23 ERR_raise(ERR_LIB_EVP, 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 OSSL_LIB_CTX *libctx, const char *props,
42 ENGINE *e, EVP_PKEY *pkey, int ver,
45 EVP_PKEY_CTX *locpctx = NULL;
46 EVP_SIGNATURE *signature = NULL;
47 EVP_KEYMGMT *tmp_keymgmt = NULL;
48 const char *supported_sig = NULL;
49 char locmdname[80] = ""; /* 80 chars should be enough */
53 if (ctx->algctx != NULL) {
54 if (!ossl_assert(ctx->digest != NULL)) {
55 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
58 if (ctx->digest->freectx != NULL)
59 ctx->digest->freectx(ctx->algctx);
63 if (ctx->pctx == NULL) {
65 ctx->pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, props);
67 ctx->pctx = EVP_PKEY_CTX_new(pkey, e);
69 if (ctx->pctx == NULL)
73 evp_pkey_ctx_free_old_ops(locpctx);
76 props = locpctx->propquery;
80 if (evp_pkey_ctx_is_legacy(locpctx))
84 * Ensure that the key is provided, either natively, or as a cached export.
86 tmp_keymgmt = locpctx->keymgmt;
87 provkey = evp_pkey_export_to_provider(locpctx->pkey, locpctx->libctx,
88 &tmp_keymgmt, locpctx->propquery);
89 if (provkey == NULL) {
90 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
93 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
94 ERR_clear_last_mark();
95 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
98 EVP_KEYMGMT_free(locpctx->keymgmt);
99 locpctx->keymgmt = tmp_keymgmt;
101 if (locpctx->keymgmt->query_operation_name != NULL)
103 locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
106 * If we didn't get a supported sig, assume there is one with the
107 * same name as the key type.
109 if (supported_sig == NULL)
110 supported_sig = locpctx->keytype;
113 * Because we cleared out old ops, we shouldn't need to worry about
114 * checking if signature is already there.
116 signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
119 if (signature == NULL
120 || (EVP_KEYMGMT_get0_provider(locpctx->keymgmt)
121 != EVP_SIGNATURE_get0_provider(signature))) {
123 * We don't need to free ctx->keymgmt here, as it's not necessarily
124 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
126 EVP_SIGNATURE_free(signature);
131 * If we don't have the full support we need with provided methods,
132 * let's go see if legacy does.
136 /* No more legacy from here down to legacy: */
141 locpctx->op.sig.signature = signature;
142 locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
143 : EVP_PKEY_OP_SIGNCTX;
144 locpctx->op.sig.algctx
145 = signature->newctx(ossl_provider_ctx(signature->prov), props);
146 if (locpctx->op.sig.algctx == NULL) {
147 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
151 ctx->reqdigest = type;
153 mdname = canon_mdname(EVP_MD_get0_name(type));
155 if (mdname == NULL) {
156 if (evp_keymgmt_util_get_deflt_digest_name(tmp_keymgmt, provkey,
158 sizeof(locmdname)) > 0) {
159 mdname = canon_mdname(locmdname);
163 if (mdname != NULL) {
165 * We're about to get a new digest so clear anything associated with
168 evp_md_ctx_clear_digest(ctx, 1);
170 /* legacy code support for engines */
173 * This might be requested by a later call to EVP_MD_CTX_get0_md().
174 * In that case the "explicit fetch" rules apply for that
175 * function (as per man pages), i.e. the ref count is not updated
176 * so the EVP_MD should not be used beyound the lifetime of the
179 ctx->fetched_digest = EVP_MD_fetch(locpctx->libctx, mdname, props);
180 if (ctx->fetched_digest != NULL) {
181 ctx->digest = ctx->reqdigest = ctx->fetched_digest;
183 /* legacy engine support : remove the mark when this is deleted */
184 ctx->reqdigest = ctx->digest = EVP_get_digestbyname(mdname);
185 if (ctx->digest == NULL) {
186 (void)ERR_clear_last_mark();
187 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
191 (void)ERR_pop_to_mark();
196 if (signature->digest_verify_init == NULL) {
197 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
200 ret = signature->digest_verify_init(locpctx->op.sig.algctx,
201 mdname, provkey, params);
203 if (signature->digest_sign_init == NULL) {
204 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
207 ret = signature->digest_sign_init(locpctx->op.sig.algctx,
208 mdname, provkey, params);
214 evp_pkey_ctx_free_old_ops(locpctx);
215 locpctx->operation = EVP_PKEY_OP_UNDEFINED;
220 * If we don't have the full support we need with provided methods,
221 * let's go see if legacy does.
225 if (type == NULL && mdname != NULL)
226 type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
228 if (ctx->pctx->pmeth == NULL) {
229 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
233 if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
237 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
238 type = EVP_get_digestbynid(def_nid);
242 ERR_raise(ERR_LIB_EVP, EVP_R_NO_DEFAULT_DIGEST);
248 if (ctx->pctx->pmeth->verifyctx_init) {
249 if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
251 ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
252 } else if (ctx->pctx->pmeth->digestverify != 0) {
253 ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
254 ctx->update = update;
255 } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
259 if (ctx->pctx->pmeth->signctx_init) {
260 if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
262 ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
263 } else if (ctx->pctx->pmeth->digestsign != 0) {
264 ctx->pctx->operation = EVP_PKEY_OP_SIGN;
265 ctx->update = update;
266 } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
270 if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
274 if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
276 if (!EVP_DigestInit_ex(ctx, type, e))
279 * This indicates the current algorithm requires
280 * special treatment before hashing the tbs-message.
282 ctx->pctx->flag_call_digest_custom = 0;
283 if (ctx->pctx->pmeth->digest_custom != NULL)
284 ctx->pctx->flag_call_digest_custom = 1;
291 ret = evp_pkey_ctx_use_cached_data(locpctx);
294 return ret > 0 ? 1 : 0;
297 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
298 const char *mdname, OSSL_LIB_CTX *libctx,
299 const char *props, EVP_PKEY *pkey,
302 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0,
306 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
307 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
309 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0,
313 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
314 const char *mdname, OSSL_LIB_CTX *libctx,
315 const char *props, EVP_PKEY *pkey,
318 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 1,
322 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
323 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
325 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 1,
328 #endif /* FIPS_MDOE */
330 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
332 EVP_PKEY_CTX *pctx = ctx->pctx;
335 || pctx->operation != EVP_PKEY_OP_SIGNCTX
336 || pctx->op.sig.algctx == NULL
337 || pctx->op.sig.signature == NULL)
340 if (pctx->op.sig.signature->digest_sign_update == NULL) {
341 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
345 return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.algctx,
350 /* do_sigver_init() checked that |digest_custom| is non-NULL */
351 if (pctx->flag_call_digest_custom
352 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
354 pctx->flag_call_digest_custom = 0;
357 return EVP_DigestUpdate(ctx, data, dsize);
360 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
362 EVP_PKEY_CTX *pctx = ctx->pctx;
365 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
366 || pctx->op.sig.algctx == NULL
367 || pctx->op.sig.signature == NULL)
370 if (pctx->op.sig.signature->digest_verify_update == NULL) {
371 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
375 return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.algctx,
380 /* do_sigver_init() checked that |digest_custom| is non-NULL */
381 if (pctx->flag_call_digest_custom
382 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
384 pctx->flag_call_digest_custom = 0;
387 return EVP_DigestUpdate(ctx, data, dsize);
391 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
395 EVP_PKEY_CTX *pctx = ctx->pctx;
398 || pctx->operation != EVP_PKEY_OP_SIGNCTX
399 || pctx->op.sig.algctx == NULL
400 || pctx->op.sig.signature == NULL)
403 return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.algctx,
404 sigret, siglen, SIZE_MAX);
407 if (pctx == NULL || pctx->pmeth == NULL) {
408 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
412 /* do_sigver_init() checked that |digest_custom| is non-NULL */
413 if (pctx->flag_call_digest_custom
414 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
416 pctx->flag_call_digest_custom = 0;
418 if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
420 return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
421 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
422 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
424 EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
428 r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
429 EVP_PKEY_CTX_free(dctx);
433 if (pctx->pmeth->signctx != NULL)
437 if (sigret != NULL) {
438 unsigned char md[EVP_MAX_MD_SIZE];
439 unsigned int mdlen = 0;
441 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
443 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
445 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
447 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
451 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
452 EVP_MD_CTX_free(tmp_ctx);
456 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
457 sigret, siglen, tmp_ctx);
459 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
460 EVP_MD_CTX_free(tmp_ctx);
464 if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
468 if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
471 int s = EVP_MD_get_size(ctx->digest);
473 if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
480 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
481 const unsigned char *tbs, size_t tbslen)
483 EVP_PKEY_CTX *pctx = ctx->pctx;
486 && pctx->operation == EVP_PKEY_OP_SIGNCTX
487 && pctx->op.sig.algctx != NULL
488 && pctx->op.sig.signature != NULL) {
489 if (pctx->op.sig.signature->digest_sign != NULL)
490 return pctx->op.sig.signature->digest_sign(pctx->op.sig.algctx,
491 sigret, siglen, SIZE_MAX,
495 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
496 return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
499 if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
501 return EVP_DigestSignFinal(ctx, sigret, siglen);
504 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
507 unsigned char md[EVP_MAX_MD_SIZE];
509 unsigned int mdlen = 0;
511 EVP_PKEY_CTX *pctx = ctx->pctx;
514 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
515 || pctx->op.sig.algctx == NULL
516 || pctx->op.sig.signature == NULL)
519 return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.algctx,
523 if (pctx == NULL || pctx->pmeth == NULL) {
524 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
528 /* do_sigver_init() checked that |digest_custom| is non-NULL */
529 if (pctx->flag_call_digest_custom
530 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
532 pctx->flag_call_digest_custom = 0;
534 if (pctx->pmeth->verifyctx != NULL)
538 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
540 r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
542 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
544 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
547 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
548 EVP_MD_CTX_free(tmp_ctx);
552 r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
553 sig, siglen, tmp_ctx);
555 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
556 EVP_MD_CTX_free(tmp_ctx);
560 return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
563 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
564 size_t siglen, const unsigned char *tbs, size_t tbslen)
566 EVP_PKEY_CTX *pctx = ctx->pctx;
569 && pctx->operation == EVP_PKEY_OP_VERIFYCTX
570 && pctx->op.sig.algctx != NULL
571 && pctx->op.sig.signature != NULL) {
572 if (pctx->op.sig.signature->digest_verify != NULL)
573 return pctx->op.sig.signature->digest_verify(pctx->op.sig.algctx,
578 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
579 return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
582 if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
584 return EVP_DigestVerifyFinal(ctx, sigret, siglen);
586 #endif /* FIPS_MODULE */