crypto/evp/digest.c

   1 /*
   2  * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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
   8  */
   9
  10 #include <stdio.h>
  11 #include <openssl/objects.h>
  12 #include <openssl/evp.h>
  13 #include <openssl/engine.h>
  14 #include <openssl/params.h>
  15 #include <openssl/core_names.h>
  16 #include "internal/cryptlib.h"
  17 #include "crypto/evp.h"
  18 #include "internal/provider.h"
  19 #include "evp_local.h"
  20
  21 /* This call frees resources associated with the context */
  22 int EVP_MD_CTX_reset(EVP_MD_CTX *ctx)
  23 {
  24     if (ctx == NULL)
  25         return 1;
  26
  27 #ifndef FIPS_MODE
  28     /* TODO(3.0): Temporarily no support for EVP_DigestSign* in FIPS module */
  29     /*
  30      * pctx should be freed by the user of EVP_MD_CTX
  31      * if EVP_MD_CTX_FLAG_KEEP_PKEY_CTX is set
  32      */
  33     if (!EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX))
  34         EVP_PKEY_CTX_free(ctx->pctx);
  35 #endif
  36
  37     EVP_MD_free(ctx->fetched_digest);
  38     ctx->fetched_digest = NULL;
  39     ctx->reqdigest = NULL;
  40
  41     if (ctx->provctx != NULL) {
  42         if (ctx->digest->freectx != NULL)
  43             ctx->digest->freectx(ctx->provctx);
  44         ctx->provctx = NULL;
  45         EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);
  46     }
  47
  48     /* TODO(3.0): Remove legacy code below */
  49
  50     /*
  51      * Don't assume ctx->md_data was cleaned in EVP_Digest_Final, because
  52      * sometimes only copies of the context are ever finalised.
  53      */
  54     if (ctx->digest && ctx->digest->cleanup
  55         && !EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_CLEANED))
  56         ctx->digest->cleanup(ctx);
  57     if (ctx->digest && ctx->digest->ctx_size && ctx->md_data
  58         && !EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_REUSE)) {
  59         OPENSSL_clear_free(ctx->md_data, ctx->digest->ctx_size);
  60     }
  61
  62 #if !defined(FIPS_MODE) && !defined(OPENSSL_NO_ENGINE)
  63     ENGINE_finish(ctx->engine);
  64 #endif
  65
  66     /* TODO(3.0): End of legacy code */
  67
  68     OPENSSL_cleanse(ctx, sizeof(*ctx));
  69
  70     return 1;
  71 }
  72
  73 EVP_MD_CTX *EVP_MD_CTX_new(void)
  74 {
  75     return OPENSSL_zalloc(sizeof(EVP_MD_CTX));
  76 }
  77
  78 void EVP_MD_CTX_free(EVP_MD_CTX *ctx)
  79 {
  80     if (ctx == NULL)
  81         return;
  82
  83     EVP_MD_CTX_reset(ctx);
  84
  85     OPENSSL_free(ctx);
  86     return;
  87 }
  88
  89 int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type)
  90 {
  91     EVP_MD_CTX_reset(ctx);
  92     return EVP_DigestInit_ex(ctx, type, NULL);
  93 }
  94
  95 int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl)
  96 {
  97 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
  98     ENGINE *tmpimpl = NULL;
  99 #endif
 100
 101     EVP_MD_CTX_clear_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);
 102
 103     if (ctx->provctx != NULL) {
 104         if (!ossl_assert(ctx->digest != NULL)) {
 105             EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 106             return 0;
 107         }
 108         if (ctx->digest->freectx != NULL)
 109             ctx->digest->freectx(ctx->provctx);
 110         ctx->provctx = NULL;
 111     }
 112
 113     if (type != NULL)
 114         ctx->reqdigest = type;
 115
 116     /* TODO(3.0): Legacy work around code below. Remove this */
 117 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
 118     /*
 119      * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
 120      * this context may already have an ENGINE! Try to avoid releasing the
 121      * previous handle, re-querying for an ENGINE, and having a
 122      * reinitialisation, when it may all be unnecessary.
 123      */
 124     if (ctx->engine && ctx->digest &&
 125         (type == NULL || (type->type == ctx->digest->type)))
 126         goto skip_to_init;
 127
 128     if (type != NULL) {
 129         /*
 130          * Ensure an ENGINE left lying around from last time is cleared (the
 131          * previous check attempted to avoid this if the same ENGINE and
 132          * EVP_MD could be used).
 133          */
 134         ENGINE_finish(ctx->engine);
 135         ctx->engine = NULL;
 136     }
 137
 138     if (type != NULL && impl == NULL)
 139         tmpimpl = ENGINE_get_digest_engine(type->type);
 140 #endif
 141
 142     /*
 143      * If there are engines involved or EVP_MD_CTX_FLAG_NO_INIT is set then we
 144      * should use legacy handling for now.
 145      */
 146     if (ctx->engine != NULL
 147             || impl != NULL
 148 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
 149             || tmpimpl != NULL
 150 #endif
 151             || (ctx->flags & EVP_MD_CTX_FLAG_NO_INIT) != 0) {
 152         if (ctx->digest == ctx->fetched_digest)
 153             ctx->digest = NULL;
 154         EVP_MD_free(ctx->fetched_digest);
 155         ctx->fetched_digest = NULL;
 156         goto legacy;
 157     }
 158
 159     if (ctx->digest != NULL && ctx->digest->ctx_size > 0) {
 160         OPENSSL_clear_free(ctx->md_data, ctx->digest->ctx_size);
 161         ctx->md_data = NULL;
 162     }
 163
 164     /* TODO(3.0): Start of non-legacy code below */
 165
 166     if (type->prov == NULL) {
 167 #ifdef FIPS_MODE
 168         /* We only do explict fetches inside the FIPS module */
 169         EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 170         return 0;
 171 #else
 172         EVP_MD *provmd = EVP_MD_fetch(NULL, OBJ_nid2sn(type->type), "");
 173
 174         if (provmd == NULL) {
 175             EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 176             return 0;
 177         }
 178         type = provmd;
 179         EVP_MD_free(ctx->fetched_digest);
 180         ctx->fetched_digest = provmd;
 181 #endif
 182     }
 183
 184     if (ctx->provctx != NULL && ctx->digest != NULL && ctx->digest != type) {
 185         if (ctx->digest->freectx != NULL)
 186             ctx->digest->freectx(ctx->provctx);
 187         ctx->provctx = NULL;
 188     }
 189     ctx->digest = type;
 190     if (ctx->provctx == NULL) {
 191         ctx->provctx = ctx->digest->newctx(ossl_provider_ctx(type->prov));
 192         if (ctx->provctx == NULL) {
 193             EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 194             return 0;
 195         }
 196     }
 197
 198     if (ctx->digest->dinit == NULL) {
 199         EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 200         return 0;
 201     }
 202
 203     return ctx->digest->dinit(ctx->provctx);
 204
 205     /* TODO(3.0): Remove legacy code below */
 206  legacy:
 207
 208 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
 209     if (type) {
 210         if (impl != NULL) {
 211             if (!ENGINE_init(impl)) {
 212                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 213                 return 0;
 214             }
 215         } else {
 216             /* Ask if an ENGINE is reserved for this job */
 217             impl = tmpimpl;
 218         }
 219         if (impl != NULL) {
 220             /* There's an ENGINE for this job ... (apparently) */
 221             const EVP_MD *d = ENGINE_get_digest(impl, type->type);
 222
 223             if (d == NULL) {
 224                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_INITIALIZATION_ERROR);
 225                 ENGINE_finish(impl);
 226                 return 0;
 227             }
 228             /* We'll use the ENGINE's private digest definition */
 229             type = d;
 230             /*
 231              * Store the ENGINE functional reference so we know 'type' came
 232              * from an ENGINE and we need to release it when done.
 233              */
 234             ctx->engine = impl;
 235         } else
 236             ctx->engine = NULL;
 237     } else {
 238         if (!ctx->digest) {
 239             EVPerr(EVP_F_EVP_DIGESTINIT_EX, EVP_R_NO_DIGEST_SET);
 240             return 0;
 241         }
 242         type = ctx->digest;
 243     }
 244 #endif
 245     if (ctx->digest != type) {
 246         if (ctx->digest && ctx->digest->ctx_size) {
 247             OPENSSL_clear_free(ctx->md_data, ctx->digest->ctx_size);
 248             ctx->md_data = NULL;
 249         }
 250         ctx->digest = type;
 251         if (!(ctx->flags & EVP_MD_CTX_FLAG_NO_INIT) && type->ctx_size) {
 252             ctx->update = type->update;
 253             ctx->md_data = OPENSSL_zalloc(type->ctx_size);
 254             if (ctx->md_data == NULL) {
 255                 EVPerr(EVP_F_EVP_DIGESTINIT_EX, ERR_R_MALLOC_FAILURE);
 256                 return 0;
 257             }
 258         }
 259     }
 260 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
 261  skip_to_init:
 262 #endif
 263 #ifndef FIPS_MODE
 264     /*
 265      * TODO(3.0): Temporarily no support for EVP_DigestSign* inside FIPS module
 266      * or when using providers.
 267      */
 268     if (ctx->pctx != NULL
 269             && (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx->pctx)
 270                  || ctx->pctx->op.sig.signature == NULL)) {
 271         int r;
 272         r = EVP_PKEY_CTX_ctrl(ctx->pctx, -1, EVP_PKEY_OP_TYPE_SIG,
 273                               EVP_PKEY_CTRL_DIGESTINIT, 0, ctx);
 274         if (r <= 0 && (r != -2))
 275             return 0;
 276     }
 277 #endif
 278     if (ctx->flags & EVP_MD_CTX_FLAG_NO_INIT)
 279         return 1;
 280     return ctx->digest->init(ctx);
 281 }
 282
 283 int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *data, size_t count)
 284 {
 285     if (count == 0)
 286         return 1;
 287
 288     if (ctx->digest == NULL || ctx->digest->prov == NULL)
 289         goto legacy;
 290
 291     if (ctx->digest->dupdate == NULL) {
 292         EVPerr(EVP_F_EVP_DIGESTUPDATE, EVP_R_UPDATE_ERROR);
 293         return 0;
 294     }
 295     return ctx->digest->dupdate(ctx->provctx, data, count);
 296
 297     /* TODO(3.0): Remove legacy code below */
 298  legacy:
 299     return ctx->update(ctx, data, count);
 300 }
 301
 302 /* The caller can assume that this removes any secret data from the context */
 303 int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size)
 304 {
 305     int ret;
 306     ret = EVP_DigestFinal_ex(ctx, md, size);
 307     EVP_MD_CTX_reset(ctx);
 308     return ret;
 309 }
 310
 311 /* The caller can assume that this removes any secret data from the context */
 312 int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *isize)
 313 {
 314     int ret;
 315     size_t size = 0;
 316     size_t mdsize = EVP_MD_size(ctx->digest);
 317
 318     if (ctx->digest == NULL || ctx->digest->prov == NULL)
 319         goto legacy;
 320
 321     if (ctx->digest->dfinal == NULL) {
 322         EVPerr(EVP_F_EVP_DIGESTFINAL_EX, EVP_R_FINAL_ERROR);
 323         return 0;
 324     }
 325
 326     ret = ctx->digest->dfinal(ctx->provctx, md, &size, mdsize);
 327
 328     if (isize != NULL) {
 329         if (size <= UINT_MAX) {
 330             *isize = (int)size;
 331         } else {
 332             EVPerr(EVP_F_EVP_DIGESTFINAL_EX, EVP_R_FINAL_ERROR);
 333             ret = 0;
 334         }
 335     }
 336
 337     return ret;
 338
 339     /* TODO(3.0): Remove legacy code below */
 340  legacy:
 341     OPENSSL_assert(mdsize <= EVP_MAX_MD_SIZE);
 342     ret = ctx->digest->final(ctx, md);
 343     if (isize != NULL)
 344         *isize = mdsize;
 345     if (ctx->digest->cleanup) {
 346         ctx->digest->cleanup(ctx);
 347         EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);
 348     }
 349     OPENSSL_cleanse(ctx->md_data, ctx->digest->ctx_size);
 350     return ret;
 351 }
 352
 353 int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md, size_t size)
 354 {
 355     int ret = 0;
 356     OSSL_PARAM params[2];
 357     size_t i = 0;
 358
 359     if (ctx->digest == NULL || ctx->digest->prov == NULL)
 360         goto legacy;
 361
 362     if (ctx->digest->dfinal == NULL) {
 363         EVPerr(EVP_F_EVP_DIGESTFINALXOF, EVP_R_FINAL_ERROR);
 364         return 0;
 365     }
 366
 367     params[i++] = OSSL_PARAM_construct_size_t(OSSL_DIGEST_PARAM_XOFLEN, &size);
 368     params[i++] = OSSL_PARAM_construct_end();
 369
 370     if (EVP_MD_CTX_set_params(ctx, params) > 0)
 371         ret = ctx->digest->dfinal(ctx->provctx, md, &size, size);
 372     EVP_MD_CTX_reset(ctx);
 373     return ret;
 374
 375 legacy:
 376     if (ctx->digest->flags & EVP_MD_FLAG_XOF
 377         && size <= INT_MAX
 378         && ctx->digest->md_ctrl(ctx, EVP_MD_CTRL_XOF_LEN, (int)size, NULL)) {
 379         ret = ctx->digest->final(ctx, md);
 380         if (ctx->digest->cleanup != NULL) {
 381             ctx->digest->cleanup(ctx);
 382             EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);
 383         }
 384         OPENSSL_cleanse(ctx->md_data, ctx->digest->ctx_size);
 385     } else {
 386         EVPerr(EVP_F_EVP_DIGESTFINALXOF, EVP_R_NOT_XOF_OR_INVALID_LENGTH);
 387     }
 388
 389     return ret;
 390 }
 391
 392 int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 393 {
 394     EVP_MD_CTX_reset(out);
 395     return EVP_MD_CTX_copy_ex(out, in);
 396 }
 397
 398 int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in)
 399 {
 400     unsigned char *tmp_buf;
 401
 402     if (in == NULL || in->digest == NULL) {
 403         EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, EVP_R_INPUT_NOT_INITIALIZED);
 404         return 0;
 405     }
 406
 407     if (in->digest->prov == NULL)
 408         goto legacy;
 409
 410     if (in->digest->dupctx == NULL) {
 411         EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, EVP_R_NOT_ABLE_TO_COPY_CTX);
 412         return 0;
 413     }
 414
 415     EVP_MD_CTX_reset(out);
 416     if (out->fetched_digest != NULL)
 417         EVP_MD_free(out->fetched_digest);
 418     *out = *in;
 419     /* NULL out pointers in case of error */
 420     out->pctx = NULL;
 421     out->provctx = NULL;
 422
 423     if (in->fetched_digest != NULL)
 424         EVP_MD_up_ref(in->fetched_digest);
 425
 426     out->provctx = in->digest->dupctx(in->provctx);
 427     if (out->provctx == NULL) {
 428         EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, EVP_R_NOT_ABLE_TO_COPY_CTX);
 429         return 0;
 430     }
 431
 432     /* copied EVP_MD_CTX should free the copied EVP_PKEY_CTX */
 433     EVP_MD_CTX_clear_flags(out, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
 434 #ifndef FIPS_MODE
 435     /* TODO(3.0): Temporarily no support for EVP_DigestSign* in FIPS module */
 436     if (in->pctx != NULL) {
 437         out->pctx = EVP_PKEY_CTX_dup(in->pctx);
 438         if (out->pctx == NULL) {
 439             EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, EVP_R_NOT_ABLE_TO_COPY_CTX);
 440             EVP_MD_CTX_reset(out);
 441             return 0;
 442         }
 443     }
 444 #endif
 445
 446     return 1;
 447
 448     /* TODO(3.0): Remove legacy code below */
 449  legacy:
 450 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
 451     /* Make sure it's safe to copy a digest context using an ENGINE */
 452     if (in->engine && !ENGINE_init(in->engine)) {
 453         EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, ERR_R_ENGINE_LIB);
 454         return 0;
 455     }
 456 #endif
 457
 458     if (out->digest == in->digest) {
 459         tmp_buf = out->md_data;
 460         EVP_MD_CTX_set_flags(out, EVP_MD_CTX_FLAG_REUSE);
 461     } else
 462         tmp_buf = NULL;
 463     EVP_MD_CTX_reset(out);
 464     memcpy(out, in, sizeof(*out));
 465
 466     /* copied EVP_MD_CTX should free the copied EVP_PKEY_CTX */
 467     EVP_MD_CTX_clear_flags(out, EVP_MD_CTX_FLAG_KEEP_PKEY_CTX);
 468
 469     /* Null these variables, since they are getting fixed up
 470      * properly below.  Anything else may cause a memleak and/or
 471      * double free if any of the memory allocations below fail
 472      */
 473     out->md_data = NULL;
 474     out->pctx = NULL;
 475
 476     if (in->md_data && out->digest->ctx_size) {
 477         if (tmp_buf)
 478             out->md_data = tmp_buf;
 479         else {
 480             out->md_data = OPENSSL_malloc(out->digest->ctx_size);
 481             if (out->md_data == NULL) {
 482                 EVPerr(EVP_F_EVP_MD_CTX_COPY_EX, ERR_R_MALLOC_FAILURE);
 483                 return 0;
 484             }
 485         }
 486         memcpy(out->md_data, in->md_data, out->digest->ctx_size);
 487     }
 488
 489     out->update = in->update;
 490
 491 #ifndef FIPS_MODE
 492     /* TODO(3.0): Temporarily no support for EVP_DigestSign* in FIPS module */
 493     if (in->pctx) {
 494         out->pctx = EVP_PKEY_CTX_dup(in->pctx);
 495         if (!out->pctx) {
 496             EVP_MD_CTX_reset(out);
 497             return 0;
 498         }
 499     }
 500 #endif
 501
 502     if (out->digest->copy)
 503         return out->digest->copy(out, in);
 504
 505     return 1;
 506 }
 507
 508 int EVP_Digest(const void *data, size_t count,
 509                unsigned char *md, unsigned int *size, const EVP_MD *type,
 510                ENGINE *impl)
 511 {
 512     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
 513     int ret;
 514
 515     if (ctx == NULL)
 516         return 0;
 517     EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_ONESHOT);
 518     ret = EVP_DigestInit_ex(ctx, type, impl)
 519         && EVP_DigestUpdate(ctx, data, count)
 520         && EVP_DigestFinal_ex(ctx, md, size);
 521     EVP_MD_CTX_free(ctx);
 522
 523     return ret;
 524 }
 525
 526 int EVP_MD_get_params(const EVP_MD *digest, OSSL_PARAM params[])
 527 {
 528     if (digest != NULL && digest->get_params != NULL)
 529         return digest->get_params(params);
 530     return 0;
 531 }
 532
 533 const OSSL_PARAM *EVP_MD_gettable_params(const EVP_MD *digest)
 534 {
 535     if (digest != NULL && digest->gettable_params != NULL)
 536         return digest->gettable_params();
 537     return NULL;
 538 }
 539
 540 int EVP_MD_CTX_set_params(EVP_MD_CTX *ctx, const OSSL_PARAM params[])
 541 {
 542     EVP_PKEY_CTX *pctx = ctx->pctx;
 543
 544     if (ctx->digest != NULL && ctx->digest->set_ctx_params != NULL)
 545         return ctx->digest->set_ctx_params(ctx->provctx, params);
 546
 547     if (pctx != NULL
 548             && (pctx->operation == EVP_PKEY_OP_VERIFYCTX
 549                 || pctx->operation == EVP_PKEY_OP_SIGNCTX)
 550             && pctx->op.sig.sigprovctx != NULL
 551             && pctx->op.sig.signature->set_ctx_md_params != NULL)
 552         return pctx->op.sig.signature->set_ctx_md_params(pctx->op.sig.sigprovctx,
 553                                                          params);
 554     return 0;
 555 }
 556
 557 const OSSL_PARAM *EVP_MD_settable_ctx_params(const EVP_MD *md)
 558 {
 559     if (md != NULL && md->settable_ctx_params != NULL)
 560         return md->settable_ctx_params();
 561     return NULL;
 562 }
 563
 564 const OSSL_PARAM *EVP_MD_CTX_settable_params(EVP_MD_CTX *ctx)
 565 {
 566     EVP_PKEY_CTX *pctx;
 567
 568     if (ctx != NULL
 569             && ctx->digest != NULL
 570             && ctx->digest->settable_ctx_params != NULL)
 571         return ctx->digest->settable_ctx_params();
 572
 573     pctx = ctx->pctx;
 574     if (pctx != NULL
 575             && (pctx->operation == EVP_PKEY_OP_VERIFYCTX
 576                 || pctx->operation == EVP_PKEY_OP_SIGNCTX)
 577             && pctx->op.sig.sigprovctx != NULL
 578             && pctx->op.sig.signature->settable_ctx_md_params != NULL)
 579         return pctx->op.sig.signature->settable_ctx_md_params(
 580                    pctx->op.sig.sigprovctx);
 581
 582     return NULL;
 583 }
 584
 585 int EVP_MD_CTX_get_params(EVP_MD_CTX *ctx, OSSL_PARAM params[])
 586 {
 587     EVP_PKEY_CTX *pctx = ctx->pctx;
 588
 589     if (ctx->digest != NULL && ctx->digest->get_params != NULL)
 590         return ctx->digest->get_ctx_params(ctx->provctx, params);
 591
 592     if (pctx != NULL
 593             && (pctx->operation == EVP_PKEY_OP_VERIFYCTX
 594                 || pctx->operation == EVP_PKEY_OP_SIGNCTX)
 595             && pctx->op.sig.sigprovctx != NULL
 596             && pctx->op.sig.signature->get_ctx_md_params != NULL)
 597         return pctx->op.sig.signature->get_ctx_md_params(pctx->op.sig.sigprovctx,
 598                                                          params);
 599
 600     return 0;
 601 }
 602
 603 const OSSL_PARAM *EVP_MD_gettable_ctx_params(const EVP_MD *md)
 604 {
 605     if (md != NULL && md->gettable_ctx_params != NULL)
 606         return md->gettable_ctx_params();
 607     return NULL;
 608 }
 609
 610 const OSSL_PARAM *EVP_MD_CTX_gettable_params(EVP_MD_CTX *ctx)
 611 {
 612     EVP_PKEY_CTX *pctx;
 613
 614     if (ctx != NULL
 615             && ctx->digest != NULL
 616             && ctx->digest->gettable_ctx_params != NULL)
 617         return ctx->digest->gettable_ctx_params();
 618
 619     pctx = ctx->pctx;
 620     if (pctx != NULL
 621             && (pctx->operation == EVP_PKEY_OP_VERIFYCTX
 622                 || pctx->operation == EVP_PKEY_OP_SIGNCTX)
 623             && pctx->op.sig.sigprovctx != NULL
 624             && pctx->op.sig.signature->gettable_ctx_md_params != NULL)
 625         return pctx->op.sig.signature->gettable_ctx_md_params(
 626                     pctx->op.sig.sigprovctx);
 627
 628     return NULL;
 629 }
 630
 631 /* TODO(3.0): Remove legacy code below - only used by engines & DigestSign */
 632 int EVP_MD_CTX_ctrl(EVP_MD_CTX *ctx, int cmd, int p1, void *p2)
 633 {
 634     int ret = EVP_CTRL_RET_UNSUPPORTED;
 635     int set_params = 1;
 636     size_t sz;
 637     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
 638
 639     if (ctx == NULL || ctx->digest == NULL) {
 640         ERR_raise(ERR_LIB_EVP, EVP_R_MESSAGE_DIGEST_IS_NULL);
 641         return 0;
 642     }
 643
 644     if (ctx->digest->prov == NULL
 645         && (ctx->pctx == NULL
 646             || (ctx->pctx->operation != EVP_PKEY_OP_VERIFYCTX
 647                 && ctx->pctx->operation != EVP_PKEY_OP_SIGNCTX)))
 648         goto legacy;
 649
 650     switch (cmd) {
 651     case EVP_MD_CTRL_XOF_LEN:
 652         sz = (size_t)p1;
 653         params[0] = OSSL_PARAM_construct_size_t(OSSL_DIGEST_PARAM_XOFLEN, &sz);
 654         break;
 655     case EVP_MD_CTRL_MICALG:
 656         set_params = 0;
 657         params[0] = OSSL_PARAM_construct_utf8_string(OSSL_DIGEST_PARAM_MICALG,
 658                                                      p2, p1 ? p1 : 9999);
 659         break;
 660     default:
 661         return EVP_CTRL_RET_UNSUPPORTED;
 662     }
 663
 664     if (set_params)
 665         ret = EVP_MD_CTX_set_params(ctx, params);
 666     else
 667         ret = EVP_MD_CTX_get_params(ctx, params);
 668     goto conclude;
 669
 670
 671 /* TODO(3.0): Remove legacy code below */
 672  legacy:
 673     if (ctx->digest->md_ctrl == NULL) {
 674         ERR_raise(ERR_LIB_EVP, EVP_R_CTRL_NOT_IMPLEMENTED);
 675         return 0;
 676     }
 677
 678     ret = ctx->digest->md_ctrl(ctx, cmd, p1, p2);
 679  conclude:
 680     if (ret <= 0)
 681         return 0;
 682     return ret;
 683 }
 684
 685 EVP_MD *evp_md_new(void)
 686 {
 687     EVP_MD *md = OPENSSL_zalloc(sizeof(*md));
 688
 689     if (md != NULL) {
 690         md->lock = CRYPTO_THREAD_lock_new();
 691         if (md->lock == NULL) {
 692             OPENSSL_free(md);
 693             return NULL;
 694         }
 695         md->refcnt = 1;
 696     }
 697     return md;
 698 }
 699
 700 /*
 701  * FIPS module note: since internal fetches will be entirely
 702  * provider based, we know that none of its code depends on legacy
 703  * NIDs or any functionality that use them.
 704  */
 705 #ifndef FIPS_MODE
 706 /* TODO(3.x) get rid of the need for legacy NIDs */
 707 static void set_legacy_nid(const char *name, void *vlegacy_nid)
 708 {
 709     int nid;
 710     int *legacy_nid = vlegacy_nid;
 711
 712     if (*legacy_nid == -1)       /* We found a clash already */
 713         return;
 714     if ((nid = OBJ_sn2nid(name)) == NID_undef
 715         && (nid = OBJ_ln2nid(name)) == NID_undef)
 716         return;
 717     if (*legacy_nid != NID_undef && *legacy_nid != nid) {
 718         *legacy_nid = -1;
 719         return;
 720     }
 721     *legacy_nid = nid;
 722 }
 723 #endif
 724
 725 static void *evp_md_from_dispatch(int name_id,
 726                                   const OSSL_DISPATCH *fns,
 727                                   OSSL_PROVIDER *prov, void *unused)
 728 {
 729     EVP_MD *md = NULL;
 730     int fncnt = 0;
 731
 732     /* EVP_MD_fetch() will set the legacy NID if available */
 733     if ((md = evp_md_new()) == NULL) {
 734         EVPerr(0, ERR_R_MALLOC_FAILURE);
 735         return NULL;
 736     }
 737
 738 #ifndef FIPS_MODE
 739     /* TODO(3.x) get rid of the need for legacy NIDs */
 740     md->type = NID_undef;
 741     evp_doall_names(prov, name_id, set_legacy_nid, &md->type);
 742     if (md->type == -1) {
 743         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
 744         EVP_MD_free(md);
 745         return NULL;
 746     }
 747 #endif
 748
 749     md->name_id = name_id;
 750
 751     for (; fns->function_id != 0; fns++) {
 752         switch (fns->function_id) {
 753         case OSSL_FUNC_DIGEST_NEWCTX:
 754             if (md->newctx == NULL) {
 755                 md->newctx = OSSL_get_OP_digest_newctx(fns);
 756                 fncnt++;
 757             }
 758             break;
 759         case OSSL_FUNC_DIGEST_INIT:
 760             if (md->dinit == NULL) {
 761                 md->dinit = OSSL_get_OP_digest_init(fns);
 762                 fncnt++;
 763             }
 764             break;
 765         case OSSL_FUNC_DIGEST_UPDATE:
 766             if (md->dupdate == NULL) {
 767                 md->dupdate = OSSL_get_OP_digest_update(fns);
 768                 fncnt++;
 769             }
 770             break;
 771         case OSSL_FUNC_DIGEST_FINAL:
 772             if (md->dfinal == NULL) {
 773                 md->dfinal = OSSL_get_OP_digest_final(fns);
 774                 fncnt++;
 775             }
 776             break;
 777         case OSSL_FUNC_DIGEST_DIGEST:
 778             if (md->digest == NULL)
 779                 md->digest = OSSL_get_OP_digest_digest(fns);
 780             /* We don't increment fnct for this as it is stand alone */
 781             break;
 782         case OSSL_FUNC_DIGEST_FREECTX:
 783             if (md->freectx == NULL) {
 784                 md->freectx = OSSL_get_OP_digest_freectx(fns);
 785                 fncnt++;
 786             }
 787             break;
 788         case OSSL_FUNC_DIGEST_DUPCTX:
 789             if (md->dupctx == NULL)
 790                 md->dupctx = OSSL_get_OP_digest_dupctx(fns);
 791             break;
 792         case OSSL_FUNC_DIGEST_GET_PARAMS:
 793             if (md->get_params == NULL)
 794                 md->get_params = OSSL_get_OP_digest_get_params(fns);
 795             break;
 796         case OSSL_FUNC_DIGEST_SET_CTX_PARAMS:
 797             if (md->set_ctx_params == NULL)
 798                 md->set_ctx_params = OSSL_get_OP_digest_set_ctx_params(fns);
 799             break;
 800         case OSSL_FUNC_DIGEST_GET_CTX_PARAMS:
 801             if (md->get_ctx_params == NULL)
 802                 md->get_ctx_params = OSSL_get_OP_digest_get_ctx_params(fns);
 803             break;
 804         case OSSL_FUNC_DIGEST_GETTABLE_PARAMS:
 805             if (md->gettable_params == NULL)
 806                 md->gettable_params = OSSL_get_OP_digest_gettable_params(fns);
 807             break;
 808         case OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS:
 809             if (md->settable_ctx_params == NULL)
 810                 md->settable_ctx_params =
 811                     OSSL_get_OP_digest_settable_ctx_params(fns);
 812             break;
 813         case OSSL_FUNC_DIGEST_GETTABLE_CTX_PARAMS:
 814             if (md->gettable_ctx_params == NULL)
 815                 md->gettable_ctx_params =
 816                     OSSL_get_OP_digest_gettable_ctx_params(fns);
 817             break;
 818         }
 819     }
 820     if ((fncnt != 0 && fncnt != 5)
 821         || (fncnt == 0 && md->digest == NULL)) {
 822         /*
 823          * In order to be a consistent set of functions we either need the
 824          * whole set of init/update/final etc functions or none of them.
 825          * The "digest" function can standalone. We at least need one way to
 826          * generate digests.
 827          */
 828         EVP_MD_free(md);
 829         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
 830         return NULL;
 831     }
 832     md->prov = prov;
 833     if (prov != NULL)
 834         ossl_provider_up_ref(prov);
 835
 836     return md;
 837 }
 838
 839 static int evp_md_up_ref(void *md)
 840 {
 841     return EVP_MD_up_ref(md);
 842 }
 843
 844 static void evp_md_free(void *md)
 845 {
 846     EVP_MD_free(md);
 847 }
 848
 849 EVP_MD *EVP_MD_fetch(OPENSSL_CTX *ctx, const char *algorithm,
 850                      const char *properties)
 851 {
 852     EVP_MD *md =
 853         evp_generic_fetch(ctx, OSSL_OP_DIGEST, algorithm, properties,
 854                           evp_md_from_dispatch, NULL, evp_md_up_ref,
 855                           evp_md_free);
 856
 857     return md;
 858 }
 859
 860 int EVP_MD_up_ref(EVP_MD *md)
 861 {
 862     int ref = 0;
 863
 864     CRYPTO_UP_REF(&md->refcnt, &ref, md->lock);
 865     return 1;
 866 }
 867
 868 void EVP_MD_free(EVP_MD *md)
 869 {
 870     int i;
 871
 872     if (md == NULL)
 873         return;
 874
 875     CRYPTO_DOWN_REF(&md->refcnt, &i, md->lock);
 876     if (i > 0)
 877         return;
 878     ossl_provider_free(md->prov);
 879     CRYPTO_THREAD_lock_free(md->lock);
 880     OPENSSL_free(md);
 881 }
 882
 883 void EVP_MD_do_all_ex(OPENSSL_CTX *libctx,
 884                           void (*fn)(EVP_MD *mac, void *arg),
 885                           void *arg)
 886 {
 887     evp_generic_do_all(libctx, OSSL_OP_DIGEST,
 888                        (void (*)(void *, void *))fn, arg,
 889                        evp_md_from_dispatch, NULL, evp_md_free);
 890 }