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,
43 const OSSL_PARAM params[])
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_clear_last_mark();
91 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
94 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
95 ERR_clear_last_mark();
96 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
99 EVP_KEYMGMT_free(locpctx->keymgmt);
100 locpctx->keymgmt = tmp_keymgmt;
102 if (locpctx->keymgmt->query_operation_name != NULL)
104 locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
107 * If we didn't get a supported sig, assume there is one with the
108 * same name as the key type.
110 if (supported_sig == NULL)
111 supported_sig = locpctx->keytype;
114 * Because we cleared out old ops, we shouldn't need to worry about
115 * checking if signature is already there.
117 signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
120 if (signature == NULL
121 || (EVP_KEYMGMT_get0_provider(locpctx->keymgmt)
122 != EVP_SIGNATURE_get0_provider(signature))) {
124 * We don't need to free ctx->keymgmt here, as it's not necessarily
125 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
127 EVP_SIGNATURE_free(signature);
132 * If we don't have the full support we need with provided methods,
133 * let's go see if legacy does.
137 /* No more legacy from here down to legacy: */
142 locpctx->op.sig.signature = signature;
143 locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
144 : EVP_PKEY_OP_SIGNCTX;
145 locpctx->op.sig.algctx
146 = signature->newctx(ossl_provider_ctx(signature->prov), props);
147 if (locpctx->op.sig.algctx == NULL) {
148 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
152 ctx->reqdigest = type;
154 mdname = canon_mdname(EVP_MD_get0_name(type));
156 if (mdname == NULL) {
157 if (evp_keymgmt_util_get_deflt_digest_name(tmp_keymgmt, provkey,
159 sizeof(locmdname)) > 0) {
160 mdname = canon_mdname(locmdname);
164 if (mdname != NULL) {
166 * We're about to get a new digest so clear anything associated with
169 evp_md_ctx_clear_digest(ctx, 1);
171 /* legacy code support for engines */
174 * This might be requested by a later call to EVP_MD_CTX_get0_md().
175 * In that case the "explicit fetch" rules apply for that
176 * function (as per man pages), i.e. the ref count is not updated
177 * so the EVP_MD should not be used beyound the lifetime of the
180 ctx->fetched_digest = EVP_MD_fetch(locpctx->libctx, mdname, props);
181 if (ctx->fetched_digest != NULL) {
182 ctx->digest = ctx->reqdigest = ctx->fetched_digest;
184 /* legacy engine support : remove the mark when this is deleted */
185 ctx->reqdigest = ctx->digest = EVP_get_digestbyname(mdname);
186 if (ctx->digest == NULL) {
187 (void)ERR_clear_last_mark();
188 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
192 (void)ERR_pop_to_mark();
197 if (signature->digest_verify_init == NULL) {
198 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
201 ret = signature->digest_verify_init(locpctx->op.sig.algctx,
202 mdname, provkey, params);
204 if (signature->digest_sign_init == NULL) {
205 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
208 ret = signature->digest_sign_init(locpctx->op.sig.algctx,
209 mdname, provkey, params);
213 * If the operation was not a success and no digest was found, an error
214 * needs to be raised.
216 if (ret > 0 || mdname != NULL)
218 if (type == NULL) /* This check is redundant but clarifies matters */
219 ERR_raise(ERR_LIB_EVP, EVP_R_NO_DEFAULT_DIGEST);
222 evp_pkey_ctx_free_old_ops(locpctx);
223 locpctx->operation = EVP_PKEY_OP_UNDEFINED;
228 * If we don't have the full support we need with provided methods,
229 * let's go see if legacy does.
233 if (type == NULL && mdname != NULL)
234 type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
236 if (ctx->pctx->pmeth == NULL) {
237 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
241 if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
245 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
246 type = EVP_get_digestbynid(def_nid);
250 ERR_raise(ERR_LIB_EVP, EVP_R_NO_DEFAULT_DIGEST);
256 if (ctx->pctx->pmeth->verifyctx_init) {
257 if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
259 ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
260 } else if (ctx->pctx->pmeth->digestverify != 0) {
261 ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
262 ctx->update = update;
263 } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
267 if (ctx->pctx->pmeth->signctx_init) {
268 if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
270 ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
271 } else if (ctx->pctx->pmeth->digestsign != 0) {
272 ctx->pctx->operation = EVP_PKEY_OP_SIGN;
273 ctx->update = update;
274 } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
278 if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
282 if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
284 if (!EVP_DigestInit_ex(ctx, type, e))
287 * This indicates the current algorithm requires
288 * special treatment before hashing the tbs-message.
290 ctx->pctx->flag_call_digest_custom = 0;
291 if (ctx->pctx->pmeth->digest_custom != NULL)
292 ctx->pctx->flag_call_digest_custom = 1;
299 ret = evp_pkey_ctx_use_cached_data(locpctx);
302 return ret > 0 ? 1 : 0;
305 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
306 const char *mdname, OSSL_LIB_CTX *libctx,
307 const char *props, EVP_PKEY *pkey,
308 const OSSL_PARAM params[])
310 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 0,
314 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
315 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
317 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 0,
321 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
322 const char *mdname, OSSL_LIB_CTX *libctx,
323 const char *props, EVP_PKEY *pkey,
324 const OSSL_PARAM params[])
326 return do_sigver_init(ctx, pctx, NULL, mdname, libctx, props, NULL, pkey, 1,
330 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
331 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
333 return do_sigver_init(ctx, pctx, type, NULL, NULL, NULL, e, pkey, 1,
336 #endif /* FIPS_MDOE */
338 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
340 EVP_PKEY_CTX *pctx = ctx->pctx;
343 || pctx->operation != EVP_PKEY_OP_SIGNCTX
344 || pctx->op.sig.algctx == NULL
345 || pctx->op.sig.signature == NULL)
348 if (pctx->op.sig.signature->digest_sign_update == NULL) {
349 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
353 return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.algctx,
358 /* do_sigver_init() checked that |digest_custom| is non-NULL */
359 if (pctx->flag_call_digest_custom
360 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
362 pctx->flag_call_digest_custom = 0;
365 return EVP_DigestUpdate(ctx, data, dsize);
368 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
370 EVP_PKEY_CTX *pctx = ctx->pctx;
373 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
374 || pctx->op.sig.algctx == NULL
375 || pctx->op.sig.signature == NULL)
378 if (pctx->op.sig.signature->digest_verify_update == NULL) {
379 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
383 return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.algctx,
388 /* do_sigver_init() checked that |digest_custom| is non-NULL */
389 if (pctx->flag_call_digest_custom
390 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
392 pctx->flag_call_digest_custom = 0;
395 return EVP_DigestUpdate(ctx, data, dsize);
399 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
403 EVP_PKEY_CTX *pctx = ctx->pctx;
406 || pctx->operation != EVP_PKEY_OP_SIGNCTX
407 || pctx->op.sig.algctx == NULL
408 || pctx->op.sig.signature == NULL)
411 return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.algctx,
412 sigret, siglen, SIZE_MAX);
415 if (pctx == NULL || pctx->pmeth == NULL) {
416 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
420 /* do_sigver_init() checked that |digest_custom| is non-NULL */
421 if (pctx->flag_call_digest_custom
422 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
424 pctx->flag_call_digest_custom = 0;
426 if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
428 return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
429 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
430 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
432 EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
436 r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
437 EVP_PKEY_CTX_free(dctx);
441 if (pctx->pmeth->signctx != NULL)
445 if (sigret != NULL) {
446 unsigned char md[EVP_MAX_MD_SIZE];
447 unsigned int mdlen = 0;
449 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
451 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
453 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
455 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
459 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
460 EVP_MD_CTX_free(tmp_ctx);
464 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
465 sigret, siglen, tmp_ctx);
467 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
468 EVP_MD_CTX_free(tmp_ctx);
472 if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
476 if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
479 int s = EVP_MD_get_size(ctx->digest);
481 if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
488 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
489 const unsigned char *tbs, size_t tbslen)
491 EVP_PKEY_CTX *pctx = ctx->pctx;
494 && pctx->operation == EVP_PKEY_OP_SIGNCTX
495 && pctx->op.sig.algctx != NULL
496 && pctx->op.sig.signature != NULL) {
497 if (pctx->op.sig.signature->digest_sign != NULL)
498 return pctx->op.sig.signature->digest_sign(pctx->op.sig.algctx,
499 sigret, siglen, SIZE_MAX,
503 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
504 return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
507 if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
509 return EVP_DigestSignFinal(ctx, sigret, siglen);
512 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
515 unsigned char md[EVP_MAX_MD_SIZE];
517 unsigned int mdlen = 0;
519 EVP_PKEY_CTX *pctx = ctx->pctx;
522 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
523 || pctx->op.sig.algctx == NULL
524 || pctx->op.sig.signature == NULL)
527 return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.algctx,
531 if (pctx == NULL || pctx->pmeth == NULL) {
532 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
536 /* do_sigver_init() checked that |digest_custom| is non-NULL */
537 if (pctx->flag_call_digest_custom
538 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
540 pctx->flag_call_digest_custom = 0;
542 if (pctx->pmeth->verifyctx != NULL)
546 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
548 r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
550 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
552 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
555 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
556 EVP_MD_CTX_free(tmp_ctx);
560 r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
561 sig, siglen, tmp_ctx);
563 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
564 EVP_MD_CTX_free(tmp_ctx);
568 return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
571 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
572 size_t siglen, const unsigned char *tbs, size_t tbslen)
574 EVP_PKEY_CTX *pctx = ctx->pctx;
577 && pctx->operation == EVP_PKEY_OP_VERIFYCTX
578 && pctx->op.sig.algctx != NULL
579 && pctx->op.sig.signature != NULL) {
580 if (pctx->op.sig.signature->digest_verify != NULL)
581 return pctx->op.sig.signature->digest_verify(pctx->op.sig.algctx,
586 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
587 return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
590 if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
592 return EVP_DigestVerifyFinal(ctx, sigret, siglen);
594 #endif /* FIPS_MODULE */