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 const char *props, ENGINE *e, EVP_PKEY *pkey,
42 OPENSSL_CTX *libctx, 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 * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
76 * calls can be removed.
80 if (locpctx->engine != NULL || locpctx->keytype == NULL)
84 * Ensure that the key is provided, either natively, or as a cached export.
87 tmp_keymgmt = locpctx->keymgmt;
88 provkey = evp_pkey_export_to_provider(locpctx->pkey, locpctx->libctx,
89 &tmp_keymgmt, locpctx->propquery);
92 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
93 ERR_clear_last_mark();
94 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
97 EVP_KEYMGMT_free(locpctx->keymgmt);
98 locpctx->keymgmt = tmp_keymgmt;
100 if (locpctx->keymgmt->query_operation_name != NULL)
102 locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
105 * If we didn't get a supported sig, assume there is one with the
106 * same name as the key type.
108 if (supported_sig == NULL)
109 supported_sig = locpctx->keytype;
112 * Because we cleared out old ops, we shouldn't need to worry about
113 * checking if signature is already there.
115 signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
118 if (signature == NULL
119 || (EVP_KEYMGMT_provider(locpctx->keymgmt)
120 != EVP_SIGNATURE_provider(signature))) {
122 * We don't need to free ctx->keymgmt here, as it's not necessarily
123 * tied to this operation. It will be freed by EVP_PKEY_CTX_free().
125 EVP_SIGNATURE_free(signature);
130 * TODO remove this when legacy is gone
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.sigprovctx
145 = signature->newctx(ossl_provider_ctx(signature->prov));
146 if (locpctx->op.sig.sigprovctx == NULL) {
147 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
151 ctx->reqdigest = type;
153 mdname = canon_mdname(EVP_MD_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);
161 EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
166 if (mdname != NULL) {
168 * This might be requested by a later call to EVP_MD_CTX_md().
169 * In that case the "explicit fetch" rules apply for that
170 * function (as per man pages), i.e. the ref count is not updated
171 * so the EVP_MD should not be used beyound the lifetime of the
174 ctx->reqdigest = ctx->fetched_digest =
175 EVP_MD_fetch(locpctx->libctx, mdname, props);
180 if (signature->digest_verify_init == NULL) {
181 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
184 ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
185 mdname, props, provkey);
187 if (signature->digest_sign_init == NULL) {
188 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
191 ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
192 mdname, props, provkey);
197 evp_pkey_ctx_free_old_ops(locpctx);
198 locpctx->operation = EVP_PKEY_OP_UNDEFINED;
203 * TODO remove this when legacy is gone
204 * If we don't have the full support we need with provided methods,
205 * let's go see if legacy does.
209 if (type == NULL && mdname != NULL)
210 type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
212 if (ctx->pctx->pmeth == NULL) {
213 EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
217 if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
221 if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
222 type = EVP_get_digestbynid(def_nid);
226 EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
232 if (ctx->pctx->pmeth->verifyctx_init) {
233 if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
235 ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
236 } else if (ctx->pctx->pmeth->digestverify != 0) {
237 ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
238 ctx->update = update;
239 } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
243 if (ctx->pctx->pmeth->signctx_init) {
244 if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
246 ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
247 } else if (ctx->pctx->pmeth->digestsign != 0) {
248 ctx->pctx->operation = EVP_PKEY_OP_SIGN;
249 ctx->update = update;
250 } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
254 if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
258 if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
260 if (!EVP_DigestInit_ex(ctx, type, e))
263 * This indicates the current algorithm requires
264 * special treatment before hashing the tbs-message.
266 ctx->pctx->flag_call_digest_custom = 0;
267 if (ctx->pctx->pmeth->digest_custom != NULL)
268 ctx->pctx->flag_call_digest_custom = 1;
273 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
274 const char *mdname, const char *props, EVP_PKEY *pkey,
277 return do_sigver_init(ctx, pctx, NULL, mdname, props, NULL, pkey, libctx,
281 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
282 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
284 return do_sigver_init(ctx, pctx, type, NULL, NULL, e, pkey, NULL, 0);
287 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
288 const char *mdname, const char *props,
289 EVP_PKEY *pkey, OPENSSL_CTX *libctx)
291 return do_sigver_init(ctx, pctx, NULL, mdname, props, NULL, pkey, libctx, 1);
294 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
295 const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
297 return do_sigver_init(ctx, pctx, type, NULL, NULL, e, pkey, NULL, 1);
299 #endif /* FIPS_MDOE */
301 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
303 EVP_PKEY_CTX *pctx = ctx->pctx;
306 || pctx->operation != EVP_PKEY_OP_SIGNCTX
307 || pctx->op.sig.sigprovctx == NULL
308 || pctx->op.sig.signature == NULL)
311 if (pctx->op.sig.signature->digest_sign_update == NULL) {
312 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
316 return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
321 /* do_sigver_init() checked that |digest_custom| is non-NULL */
322 if (pctx->flag_call_digest_custom
323 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
325 pctx->flag_call_digest_custom = 0;
328 return EVP_DigestUpdate(ctx, data, dsize);
331 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
333 EVP_PKEY_CTX *pctx = ctx->pctx;
336 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
337 || pctx->op.sig.sigprovctx == NULL
338 || pctx->op.sig.signature == NULL)
341 if (pctx->op.sig.signature->digest_verify_update == NULL) {
342 ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
346 return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
351 /* do_sigver_init() checked that |digest_custom| is non-NULL */
352 if (pctx->flag_call_digest_custom
353 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
355 pctx->flag_call_digest_custom = 0;
358 return EVP_DigestUpdate(ctx, data, dsize);
362 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
366 EVP_PKEY_CTX *pctx = ctx->pctx;
369 || pctx->operation != EVP_PKEY_OP_SIGNCTX
370 || pctx->op.sig.sigprovctx == NULL
371 || pctx->op.sig.signature == NULL)
374 return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
375 sigret, siglen, SIZE_MAX);
378 if (pctx == NULL || pctx->pmeth == NULL) {
379 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
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;
389 if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
391 return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
392 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
393 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
395 EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
399 r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
400 EVP_PKEY_CTX_free(dctx);
404 if (pctx->pmeth->signctx != NULL)
408 if (sigret != NULL) {
409 unsigned char md[EVP_MAX_MD_SIZE];
410 unsigned int mdlen = 0;
412 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
414 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
416 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
418 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
422 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
423 EVP_MD_CTX_free(tmp_ctx);
427 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
428 sigret, siglen, tmp_ctx);
430 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
431 EVP_MD_CTX_free(tmp_ctx);
435 if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
439 if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
442 int s = EVP_MD_size(ctx->digest);
444 if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
451 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
452 const unsigned char *tbs, size_t tbslen)
454 EVP_PKEY_CTX *pctx = ctx->pctx;
457 && pctx->operation == EVP_PKEY_OP_SIGNCTX
458 && pctx->op.sig.sigprovctx != NULL
459 && pctx->op.sig.signature != NULL) {
460 if (pctx->op.sig.signature->digest_sign != NULL)
461 return pctx->op.sig.signature->digest_sign(pctx->op.sig.sigprovctx,
462 sigret, siglen, SIZE_MAX,
466 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
467 return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
470 if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
472 return EVP_DigestSignFinal(ctx, sigret, siglen);
475 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
478 unsigned char md[EVP_MAX_MD_SIZE];
480 unsigned int mdlen = 0;
482 EVP_PKEY_CTX *pctx = ctx->pctx;
485 || pctx->operation != EVP_PKEY_OP_VERIFYCTX
486 || pctx->op.sig.sigprovctx == NULL
487 || pctx->op.sig.signature == NULL)
490 return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
494 if (pctx == NULL || pctx->pmeth == NULL) {
495 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
499 /* do_sigver_init() checked that |digest_custom| is non-NULL */
500 if (pctx->flag_call_digest_custom
501 && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
503 pctx->flag_call_digest_custom = 0;
505 if (pctx->pmeth->verifyctx != NULL)
509 if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
511 r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
513 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
515 EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
518 if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
519 EVP_MD_CTX_free(tmp_ctx);
523 r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
524 sig, siglen, tmp_ctx);
526 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
527 EVP_MD_CTX_free(tmp_ctx);
531 return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
534 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
535 size_t siglen, const unsigned char *tbs, size_t tbslen)
537 EVP_PKEY_CTX *pctx = ctx->pctx;
540 && pctx->operation == EVP_PKEY_OP_VERIFYCTX
541 && pctx->op.sig.sigprovctx != NULL
542 && pctx->op.sig.signature != NULL) {
543 if (pctx->op.sig.signature->digest_verify != NULL)
544 return pctx->op.sig.signature->digest_verify(pctx->op.sig.sigprovctx,
549 if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
550 return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
553 if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
555 return EVP_DigestVerifyFinal(ctx, sigret, siglen);
557 #endif /* FIPS_MODULE */