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 <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 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)
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 (evp_pkey_ctx_is_legacy(locpctx))
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) {
93 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
96 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
97 ERR_clear_last_mark();
98 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
101 EVP_KEYMGMT_free(locpctx->keymgmt);
102 locpctx->keymgmt = tmp_keymgmt;
104 if (locpctx->keymgmt->query_operation_name != NULL)
106 locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
109 * If we didn't get a supported sig, assume there is one with the
110 * same name as the key type.
112 if (supported_sig == NULL)
113 supported_sig = locpctx->keytype;
116 * Because we cleared out old ops, we shouldn't need to worry about
117 * checking if signature is already there.
119 signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
122 if (signature == NULL
123 || (EVP_KEYMGMT_provider(locpctx->keymgmt)
124 != EVP_SIGNATURE_provider(signature))) {
126 * We don't need to free ctx->keymgmt here, as it's not necessarily
127 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
129 EVP_SIGNATURE_free(signature);
134 * TODO remove this when legacy is gone
135 * If we don't have the full support we need with provided methods,
136 * let's go see if legacy does.
140 /* No more legacy from here down to legacy: */
145 locpctx->op.sig.signature = signature;
146 locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
147 : EVP_PKEY_OP_SIGNCTX;
148 locpctx->op.sig.sigprovctx
149 = signature->newctx(ossl_provider_ctx(signature->prov), props);
150 if (locpctx->op.sig.sigprovctx == NULL) {
151 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
155 ctx->reqdigest = type;
157 mdname = canon_mdname(EVP_MD_name(type));
159 if (mdname == NULL) {
160 if (evp_keymgmt_util_get_deflt_digest_name(tmp_keymgmt, provkey,
162 sizeof(locmdname)) > 0) {
163 mdname = canon_mdname(locmdname);
167 if (mdname != NULL) {
169 * We're about to get a new digest so clear anything associated with
172 evp_md_ctx_clear_digest(ctx, 1);
174 /* legacy code support for engines */
177 * This might be requested by a later call to EVP_MD_CTX_md().
178 * In that case the "explicit fetch" rules apply for that
179 * function (as per man pages), i.e. the ref count is not updated
180 * so the EVP_MD should not be used beyound the lifetime of the
183 ctx->fetched_digest = EVP_MD_fetch(locpctx->libctx, mdname, props);
184 if (ctx->fetched_digest != NULL) {
185 ctx->digest = ctx->reqdigest = ctx->fetched_digest;
187 /* legacy engine support : remove the mark when this is deleted */
188 ctx->reqdigest = ctx->digest = EVP_get_digestbyname(mdname);
189 if (ctx->digest == NULL) {
190 (void)ERR_clear_last_mark();
191 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
195 (void)ERR_pop_to_mark();
200 if (signature->digest_verify_init == NULL) {
201 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
204 ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
207 if (signature->digest_sign_init == NULL) {
208 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
211 ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
218 evp_pkey_ctx_free_old_ops(locpctx);
219 locpctx->operation = EVP_PKEY_OP_UNDEFINED;
224 * TODO remove this when legacy is gone
225 * If we don't have the full support we need with provided methods,
226 * let's go see if legacy does.
230 if (type == NULL && mdname != NULL)
231 type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
233 if (ctx->pctx->pmeth == NULL) {
234 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
238 if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
242 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
243 type = EVP_get_digestbynid(def_nid);
247 ERR_raise(ERR_LIB_EVP, EVP_R_NO_DEFAULT_DIGEST);
253 if (ctx->pctx->pmeth->verifyctx_init) {
254 if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
256 ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
257 } else if (ctx->pctx->pmeth->digestverify != 0) {
258 ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
259 ctx->update = update;
260 } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
264 if (ctx->pctx->pmeth->signctx_init) {
265 if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
267 ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
268 } else if (ctx->pctx->pmeth->digestsign != 0) {
269 ctx->pctx->operation = EVP_PKEY_OP_SIGN;
270 ctx->update = update;
271 } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
275 if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
279 if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
281 if (!EVP_DigestInit_ex(ctx, type, e))
284 * This indicates the current algorithm requires
285 * special treatment before hashing the tbs-message.
287 ctx->pctx->flag_call_digest_custom = 0;
288 if (ctx->pctx->pmeth->digest_custom != NULL)
289 ctx->pctx->flag_call_digest_custom = 1;
296 ret = evp_pkey_ctx_use_cached_data(locpctx);
299 return ret > 0 ? 1 : 0;
302 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
303 const char *mdname, OSSL_LIB_CTX *libctx,
304 const char *props, EVP_PKEY *pkey)
306 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0);
309 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
310 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
312 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0);
315 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
316 const char *mdname, OSSL_LIB_CTX *libctx,
317 const char *props, EVP_PKEY *pkey)
319 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);
327 #endif /* FIPS_MDOE */
329 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
331 EVP_PKEY_CTX *pctx = ctx->pctx;
334 || pctx->operation != EVP_PKEY_OP_SIGNCTX
335 || pctx->op.sig.sigprovctx == NULL
336 || pctx->op.sig.signature == NULL)
339 if (pctx->op.sig.signature->digest_sign_update == NULL) {
340 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
344 return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
349 /* do_sigver_init() checked that |digest_custom| is non-NULL */
350 if (pctx->flag_call_digest_custom
351 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
353 pctx->flag_call_digest_custom = 0;
356 return EVP_DigestUpdate(ctx, data, dsize);
359 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
361 EVP_PKEY_CTX *pctx = ctx->pctx;
364 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
365 || pctx->op.sig.sigprovctx == NULL
366 || pctx->op.sig.signature == NULL)
369 if (pctx->op.sig.signature->digest_verify_update == NULL) {
370 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
374 return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
379 /* do_sigver_init() checked that |digest_custom| is non-NULL */
380 if (pctx->flag_call_digest_custom
381 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
383 pctx->flag_call_digest_custom = 0;
386 return EVP_DigestUpdate(ctx, data, dsize);
390 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
394 EVP_PKEY_CTX *pctx = ctx->pctx;
397 || pctx->operation != EVP_PKEY_OP_SIGNCTX
398 || pctx->op.sig.sigprovctx == NULL
399 || pctx->op.sig.signature == NULL)
402 return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
403 sigret, siglen, SIZE_MAX);
406 if (pctx == NULL || pctx->pmeth == NULL) {
407 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
411 /* do_sigver_init() checked that |digest_custom| is non-NULL */
412 if (pctx->flag_call_digest_custom
413 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
415 pctx->flag_call_digest_custom = 0;
417 if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
419 return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
420 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
421 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
423 EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
427 r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
428 EVP_PKEY_CTX_free(dctx);
432 if (pctx->pmeth->signctx != NULL)
436 if (sigret != NULL) {
437 unsigned char md[EVP_MAX_MD_SIZE];
438 unsigned int mdlen = 0;
440 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
442 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
444 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
446 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
450 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
451 EVP_MD_CTX_free(tmp_ctx);
455 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
456 sigret, siglen, tmp_ctx);
458 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
459 EVP_MD_CTX_free(tmp_ctx);
463 if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
467 if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
470 int s = EVP_MD_size(ctx->digest);
472 if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
479 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
480 const unsigned char *tbs, size_t tbslen)
482 EVP_PKEY_CTX *pctx = ctx->pctx;
485 && pctx->operation == EVP_PKEY_OP_SIGNCTX
486 && pctx->op.sig.sigprovctx != NULL
487 && pctx->op.sig.signature != NULL) {
488 if (pctx->op.sig.signature->digest_sign != NULL)
489 return pctx->op.sig.signature->digest_sign(pctx->op.sig.sigprovctx,
490 sigret, siglen, SIZE_MAX,
494 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
495 return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
498 if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
500 return EVP_DigestSignFinal(ctx, sigret, siglen);
503 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
506 unsigned char md[EVP_MAX_MD_SIZE];
508 unsigned int mdlen = 0;
510 EVP_PKEY_CTX *pctx = ctx->pctx;
513 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
514 || pctx->op.sig.sigprovctx == NULL
515 || pctx->op.sig.signature == NULL)
518 return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
522 if (pctx == NULL || pctx->pmeth == NULL) {
523 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
527 /* do_sigver_init() checked that |digest_custom| is non-NULL */
528 if (pctx->flag_call_digest_custom
529 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
531 pctx->flag_call_digest_custom = 0;
533 if (pctx->pmeth->verifyctx != NULL)
537 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
539 r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
541 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
543 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
546 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
547 EVP_MD_CTX_free(tmp_ctx);
551 r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
552 sig, siglen, tmp_ctx);
554 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
555 EVP_MD_CTX_free(tmp_ctx);
559 return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
562 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
563 size_t siglen, const unsigned char *tbs, size_t tbslen)
565 EVP_PKEY_CTX *pctx = ctx->pctx;
568 && pctx->operation == EVP_PKEY_OP_VERIFYCTX
569 && pctx->op.sig.sigprovctx != NULL
570 && pctx->op.sig.signature != NULL) {
571 if (pctx->op.sig.signature->digest_verify != NULL)
572 return pctx->op.sig.signature->digest_verify(pctx->op.sig.sigprovctx,
577 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
578 return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
581 if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
583 return EVP_DigestVerifyFinal(ctx, sigret, siglen);
585 #endif /* FIPS_MODULE */