crypto/evp/m_sigver.c

   1 /*
   2  * Copyright 2006-2020 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 "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"
  18
  19 #ifndef FIPS_MODULE
  20
  21 static int update(EVP_MD_CTX *ctx, const void *data, size_t datalen)
  22 {
  23     EVPerr(EVP_F_UPDATE, EVP_R_ONLY_ONESHOT_SUPPORTED);
  24     return 0;
  25 }
  26
  27 /*
  28  * If we get the "NULL" md then the name comes back as "UNDEF". We want to use
  29  * NULL for this.
  30  */
  31 static const char *canon_mdname(const char *mdname)
  32 {
  33     if (mdname != NULL && strcmp(mdname, "UNDEF") == 0)
  34         return NULL;
  35
  36     return mdname;
  37 }
  38
  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)
  43 {
  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 */
  49     void *provkey = NULL;
  50     int ret;
  51
  52     if (ctx->provctx != NULL) {
  53         if (!ossl_assert(ctx->digest != NULL)) {
  54             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
  55             return 0;
  56         }
  57         if (ctx->digest->freectx != NULL)
  58             ctx->digest->freectx(ctx->provctx);
  59         ctx->provctx = NULL;
  60     }
  61
  62     if (ctx->pctx == NULL) {
  63         if (libctx != NULL)
  64             ctx->pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, props);
  65         else
  66             ctx->pctx = EVP_PKEY_CTX_new(pkey, e);
  67     }
  68     if (ctx->pctx == NULL)
  69         return 0;
  70
  71     locpctx = ctx->pctx;
  72     evp_pkey_ctx_free_old_ops(locpctx);
  73
  74     if (props == NULL)
  75         props = locpctx->propquery;
  76
  77     /*
  78      * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
  79      * calls can be removed.
  80      */
  81     ERR_set_mark();
  82
  83     if (locpctx->engine != NULL || locpctx->keytype == NULL)
  84         goto legacy;
  85
  86     /*
  87      * Ensure that the key is provided, either natively, or as a cached export.
  88      *  If not, go legacy
  89      */
  90     tmp_keymgmt = locpctx->keymgmt;
  91     provkey = evp_pkey_export_to_provider(locpctx->pkey, locpctx->libctx,
  92                                           &tmp_keymgmt, locpctx->propquery);
  93     if (provkey == NULL)
  94         goto legacy;
  95     if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
  96         ERR_clear_last_mark();
  97         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
  98         goto err;
  99     }
 100     EVP_KEYMGMT_free(locpctx->keymgmt);
 101     locpctx->keymgmt = tmp_keymgmt;
 102
 103     if (locpctx->keymgmt->query_operation_name != NULL)
 104         supported_sig =
 105             locpctx->keymgmt->query_operation_name(OSSL_OP_SIGNATURE);
 106
 107     /*
 108      * If we didn't get a supported sig, assume there is one with the
 109      * same name as the key type.
 110      */
 111     if (supported_sig == NULL)
 112         supported_sig = locpctx->keytype;
 113
 114     /*
 115      * Because we cleared out old ops, we shouldn't need to worry about
 116      * checking if signature is already there.
 117      */
 118     signature = EVP_SIGNATURE_fetch(locpctx->libctx, supported_sig,
 119                                     locpctx->propquery);
 120
 121     if (signature == NULL
 122         || (EVP_KEYMGMT_provider(locpctx->keymgmt)
 123             != EVP_SIGNATURE_provider(signature))) {
 124         /*
 125          * We don't need to free ctx->keymgmt here, as it's not necessarily
 126          * tied to this operation.  It will be freed by EVP_PKEY_CTX_free().
 127          */
 128         EVP_SIGNATURE_free(signature);
 129         goto legacy;
 130     }
 131
 132     /*
 133      * TODO remove this when legacy is gone
 134      * If we don't have the full support we need with provided methods,
 135      * let's go see if legacy does.
 136      */
 137     ERR_pop_to_mark();
 138
 139     /* No more legacy from here down to legacy: */
 140
 141     if (pctx != NULL)
 142         *pctx = locpctx;
 143
 144     locpctx->op.sig.signature = signature;
 145     locpctx->operation = ver ? EVP_PKEY_OP_VERIFYCTX
 146                              : EVP_PKEY_OP_SIGNCTX;
 147     locpctx->op.sig.sigprovctx
 148         = signature->newctx(ossl_provider_ctx(signature->prov), props);
 149     if (locpctx->op.sig.sigprovctx == NULL) {
 150         ERR_raise(ERR_LIB_EVP,  EVP_R_INITIALIZATION_ERROR);
 151         goto err;
 152     }
 153     if (type != NULL) {
 154         ctx->reqdigest = type;
 155         if (mdname == NULL)
 156             mdname = canon_mdname(EVP_MD_name(type));
 157     } else {
 158         if (mdname == NULL) {
 159             if (evp_keymgmt_util_get_deflt_digest_name(tmp_keymgmt, provkey,
 160                                                        locmdname,
 161                                                        sizeof(locmdname)) > 0) {
 162                 mdname = canon_mdname(locmdname);
 163             } else {
 164                 EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
 165                 return 0;
 166             }
 167         }
 168
 169         if (mdname != NULL) {
 170             /*
 171              * This might be requested by a later call to EVP_MD_CTX_md().
 172              * In that case the "explicit fetch" rules apply for that
 173              * function (as per man pages), i.e. the ref count is not updated
 174              * so the EVP_MD should not be used beyound the lifetime of the
 175              * EVP_MD_CTX.
 176              */
 177             ctx->reqdigest = ctx->fetched_digest =
 178                 EVP_MD_fetch(locpctx->libctx, mdname, props);
 179         }
 180     }
 181
 182     if (ver) {
 183         if (signature->digest_verify_init == NULL) {
 184             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 185             goto err;
 186         }
 187         ret = signature->digest_verify_init(locpctx->op.sig.sigprovctx,
 188                                             mdname, provkey);
 189     } else {
 190         if (signature->digest_sign_init == NULL) {
 191             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 192             goto err;
 193         }
 194         ret = signature->digest_sign_init(locpctx->op.sig.sigprovctx,
 195                                           mdname, provkey);
 196     }
 197
 198     return ret ? 1 : 0;
 199  err:
 200     evp_pkey_ctx_free_old_ops(locpctx);
 201     locpctx->operation = EVP_PKEY_OP_UNDEFINED;
 202     return 0;
 203
 204  legacy:
 205     /*
 206      * TODO remove this when legacy is gone
 207      * If we don't have the full support we need with provided methods,
 208      * let's go see if legacy does.
 209      */
 210     ERR_pop_to_mark();
 211
 212     if (type == NULL && mdname != NULL)
 213         type = evp_get_digestbyname_ex(locpctx->libctx, mdname);
 214
 215     if (ctx->pctx->pmeth == NULL) {
 216         EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 217         return 0;
 218     }
 219
 220     if (!(ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)) {
 221
 222         if (type == NULL) {
 223             int def_nid;
 224             if (EVP_PKEY_get_default_digest_nid(pkey, &def_nid) > 0)
 225                 type = EVP_get_digestbynid(def_nid);
 226         }
 227
 228         if (type == NULL) {
 229             EVPerr(EVP_F_DO_SIGVER_INIT, EVP_R_NO_DEFAULT_DIGEST);
 230             return 0;
 231         }
 232     }
 233
 234     if (ver) {
 235         if (ctx->pctx->pmeth->verifyctx_init) {
 236             if (ctx->pctx->pmeth->verifyctx_init(ctx->pctx, ctx) <= 0)
 237                 return 0;
 238             ctx->pctx->operation = EVP_PKEY_OP_VERIFYCTX;
 239         } else if (ctx->pctx->pmeth->digestverify != 0) {
 240             ctx->pctx->operation = EVP_PKEY_OP_VERIFY;
 241             ctx->update = update;
 242         } else if (EVP_PKEY_verify_init(ctx->pctx) <= 0) {
 243             return 0;
 244         }
 245     } else {
 246         if (ctx->pctx->pmeth->signctx_init) {
 247             if (ctx->pctx->pmeth->signctx_init(ctx->pctx, ctx) <= 0)
 248                 return 0;
 249             ctx->pctx->operation = EVP_PKEY_OP_SIGNCTX;
 250         } else if (ctx->pctx->pmeth->digestsign != 0) {
 251             ctx->pctx->operation = EVP_PKEY_OP_SIGN;
 252             ctx->update = update;
 253         } else if (EVP_PKEY_sign_init(ctx->pctx) <= 0) {
 254             return 0;
 255         }
 256     }
 257     if (EVP_PKEY_CTX_set_signature_md(ctx->pctx, type) <= 0)
 258         return 0;
 259     if (pctx)
 260         *pctx = ctx->pctx;
 261     if (ctx->pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM)
 262         return 1;
 263     if (!EVP_DigestInit_ex(ctx, type, e))
 264         return 0;
 265     /*
 266      * This indicates the current algorithm requires
 267      * special treatment before hashing the tbs-message.
 268      */
 269     ctx->pctx->flag_call_digest_custom = 0;
 270     if (ctx->pctx->pmeth->digest_custom != NULL)
 271         ctx->pctx->flag_call_digest_custom = 1;
 272
 273     return 1;
 274 }
 275
 276 int EVP_DigestSignInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
 277                           const char *mdname, const char *props, EVP_PKEY *pkey,
 278                           OPENSSL_CTX *libctx)
 279 {
 280     return do_sigver_init(ctx, pctx, NULL, mdname, props, NULL, pkey, libctx,
 281                           0);
 282 }
 283
 284 int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
 285                        const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
 286 {
 287     return do_sigver_init(ctx, pctx, type, NULL, NULL, e, pkey, NULL, 0);
 288 }
 289
 290 int EVP_DigestVerifyInit_ex(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
 291                             const char *mdname, const char *props,
 292                             EVP_PKEY *pkey, OPENSSL_CTX *libctx)
 293 {
 294     return do_sigver_init(ctx, pctx, NULL, mdname, props, NULL, pkey, libctx, 1);
 295 }
 296
 297 int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx,
 298                          const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey)
 299 {
 300     return do_sigver_init(ctx, pctx, type, NULL, NULL, e, pkey, NULL, 1);
 301 }
 302 #endif /* FIPS_MDOE */
 303
 304 int EVP_DigestSignUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
 305 {
 306     EVP_PKEY_CTX *pctx = ctx->pctx;
 307
 308     if (pctx == NULL
 309             || pctx->operation != EVP_PKEY_OP_SIGNCTX
 310             || pctx->op.sig.sigprovctx == NULL
 311             || pctx->op.sig.signature == NULL)
 312         goto legacy;
 313
 314     if (pctx->op.sig.signature->digest_sign_update == NULL) {
 315         ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 316         return 0;
 317     }
 318
 319     return pctx->op.sig.signature->digest_sign_update(pctx->op.sig.sigprovctx,
 320                                                       data, dsize);
 321
 322  legacy:
 323     if (pctx != NULL) {
 324         /* do_sigver_init() checked that |digest_custom| is non-NULL */
 325         if (pctx->flag_call_digest_custom
 326             && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
 327             return 0;
 328         pctx->flag_call_digest_custom = 0;
 329     }
 330
 331     return EVP_DigestUpdate(ctx, data, dsize);
 332 }
 333
 334 int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, size_t dsize)
 335 {
 336     EVP_PKEY_CTX *pctx = ctx->pctx;
 337
 338     if (pctx == NULL
 339             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
 340             || pctx->op.sig.sigprovctx == NULL
 341             || pctx->op.sig.signature == NULL)
 342         goto legacy;
 343
 344     if (pctx->op.sig.signature->digest_verify_update == NULL) {
 345         ERR_raise(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
 346         return 0;
 347     }
 348
 349     return pctx->op.sig.signature->digest_verify_update(pctx->op.sig.sigprovctx,
 350                                                         data, dsize);
 351
 352  legacy:
 353     if (pctx != NULL) {
 354         /* do_sigver_init() checked that |digest_custom| is non-NULL */
 355         if (pctx->flag_call_digest_custom
 356             && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
 357             return 0;
 358         pctx->flag_call_digest_custom = 0;
 359     }
 360
 361     return EVP_DigestUpdate(ctx, data, dsize);
 362 }
 363
 364 #ifndef FIPS_MODULE
 365 int EVP_DigestSignFinal(EVP_MD_CTX *ctx, unsigned char *sigret,
 366                         size_t *siglen)
 367 {
 368     int sctx = 0, r = 0;
 369     EVP_PKEY_CTX *pctx = ctx->pctx;
 370
 371     if (pctx == NULL
 372             || pctx->operation != EVP_PKEY_OP_SIGNCTX
 373             || pctx->op.sig.sigprovctx == NULL
 374             || pctx->op.sig.signature == NULL)
 375         goto legacy;
 376
 377     return pctx->op.sig.signature->digest_sign_final(pctx->op.sig.sigprovctx,
 378                                                      sigret, siglen, SIZE_MAX);
 379
 380  legacy:
 381     if (pctx == NULL || pctx->pmeth == NULL) {
 382         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 383         return 0;
 384     }
 385
 386     /* do_sigver_init() checked that |digest_custom| is non-NULL */
 387     if (pctx->flag_call_digest_custom
 388         && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
 389         return 0;
 390     pctx->flag_call_digest_custom = 0;
 391
 392     if (pctx->pmeth->flags & EVP_PKEY_FLAG_SIGCTX_CUSTOM) {
 393         if (sigret == NULL)
 394             return pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
 395         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE)
 396             r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
 397         else {
 398             EVP_PKEY_CTX *dctx = EVP_PKEY_CTX_dup(pctx);
 399
 400             if (dctx == NULL)
 401                 return 0;
 402             r = dctx->pmeth->signctx(dctx, sigret, siglen, ctx);
 403             EVP_PKEY_CTX_free(dctx);
 404         }
 405         return r;
 406     }
 407     if (pctx->pmeth->signctx != NULL)
 408         sctx = 1;
 409     else
 410         sctx = 0;
 411     if (sigret != NULL) {
 412         unsigned char md[EVP_MAX_MD_SIZE];
 413         unsigned int mdlen = 0;
 414
 415         if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
 416             if (sctx)
 417                 r = pctx->pmeth->signctx(pctx, sigret, siglen, ctx);
 418             else
 419                 r = EVP_DigestFinal_ex(ctx, md, &mdlen);
 420         } else {
 421             EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
 422
 423             if (tmp_ctx == NULL)
 424                 return 0;
 425             if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
 426                 EVP_MD_CTX_free(tmp_ctx);
 427                 return 0;
 428             }
 429             if (sctx)
 430                 r = tmp_ctx->pctx->pmeth->signctx(tmp_ctx->pctx,
 431                                                   sigret, siglen, tmp_ctx);
 432             else
 433                 r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
 434             EVP_MD_CTX_free(tmp_ctx);
 435         }
 436         if (sctx || !r)
 437             return r;
 438         if (EVP_PKEY_sign(pctx, sigret, siglen, md, mdlen) <= 0)
 439             return 0;
 440     } else {
 441         if (sctx) {
 442             if (pctx->pmeth->signctx(pctx, sigret, siglen, ctx) <= 0)
 443                 return 0;
 444         } else {
 445             int s = EVP_MD_size(ctx->digest);
 446
 447             if (s < 0 || EVP_PKEY_sign(pctx, sigret, siglen, NULL, s) <= 0)
 448                 return 0;
 449         }
 450     }
 451     return 1;
 452 }
 453
 454 int EVP_DigestSign(EVP_MD_CTX *ctx, unsigned char *sigret, size_t *siglen,
 455                    const unsigned char *tbs, size_t tbslen)
 456 {
 457     EVP_PKEY_CTX *pctx = ctx->pctx;
 458
 459     if (pctx != NULL
 460             && pctx->operation == EVP_PKEY_OP_SIGNCTX
 461             && pctx->op.sig.sigprovctx != NULL
 462             && pctx->op.sig.signature != NULL) {
 463         if (pctx->op.sig.signature->digest_sign != NULL)
 464             return pctx->op.sig.signature->digest_sign(pctx->op.sig.sigprovctx,
 465                                                        sigret, siglen, SIZE_MAX,
 466                                                        tbs, tbslen);
 467     } else {
 468         /* legacy */
 469         if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestsign != NULL)
 470             return ctx->pctx->pmeth->digestsign(ctx, sigret, siglen, tbs, tbslen);
 471     }
 472
 473     if (sigret != NULL && EVP_DigestSignUpdate(ctx, tbs, tbslen) <= 0)
 474         return 0;
 475     return EVP_DigestSignFinal(ctx, sigret, siglen);
 476 }
 477
 478 int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, const unsigned char *sig,
 479                           size_t siglen)
 480 {
 481     unsigned char md[EVP_MAX_MD_SIZE];
 482     int r = 0;
 483     unsigned int mdlen = 0;
 484     int vctx = 0;
 485     EVP_PKEY_CTX *pctx = ctx->pctx;
 486
 487     if (pctx == NULL
 488             || pctx->operation != EVP_PKEY_OP_VERIFYCTX
 489             || pctx->op.sig.sigprovctx == NULL
 490             || pctx->op.sig.signature == NULL)
 491         goto legacy;
 492
 493     return pctx->op.sig.signature->digest_verify_final(pctx->op.sig.sigprovctx,
 494                                                        sig, siglen);
 495
 496  legacy:
 497     if (pctx == NULL || pctx->pmeth == NULL) {
 498         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 499         return 0;
 500     }
 501
 502     /* do_sigver_init() checked that |digest_custom| is non-NULL */
 503     if (pctx->flag_call_digest_custom
 504         && !ctx->pctx->pmeth->digest_custom(ctx->pctx, ctx))
 505         return 0;
 506     pctx->flag_call_digest_custom = 0;
 507
 508     if (pctx->pmeth->verifyctx != NULL)
 509         vctx = 1;
 510     else
 511         vctx = 0;
 512     if (ctx->flags & EVP_MD_CTX_FLAG_FINALISE) {
 513         if (vctx)
 514             r = pctx->pmeth->verifyctx(pctx, sig, siglen, ctx);
 515         else
 516             r = EVP_DigestFinal_ex(ctx, md, &mdlen);
 517     } else {
 518         EVP_MD_CTX *tmp_ctx = EVP_MD_CTX_new();
 519         if (tmp_ctx == NULL)
 520             return -1;
 521         if (!EVP_MD_CTX_copy_ex(tmp_ctx, ctx)) {
 522             EVP_MD_CTX_free(tmp_ctx);
 523             return -1;
 524         }
 525         if (vctx)
 526             r = tmp_ctx->pctx->pmeth->verifyctx(tmp_ctx->pctx,
 527                                                 sig, siglen, tmp_ctx);
 528         else
 529             r = EVP_DigestFinal_ex(tmp_ctx, md, &mdlen);
 530         EVP_MD_CTX_free(tmp_ctx);
 531     }
 532     if (vctx || !r)
 533         return r;
 534     return EVP_PKEY_verify(pctx, sig, siglen, md, mdlen);
 535 }
 536
 537 int EVP_DigestVerify(EVP_MD_CTX *ctx, const unsigned char *sigret,
 538                      size_t siglen, const unsigned char *tbs, size_t tbslen)
 539 {
 540     EVP_PKEY_CTX *pctx = ctx->pctx;
 541
 542     if (pctx != NULL
 543             && pctx->operation == EVP_PKEY_OP_VERIFYCTX
 544             && pctx->op.sig.sigprovctx != NULL
 545             && pctx->op.sig.signature != NULL) {
 546         if (pctx->op.sig.signature->digest_verify != NULL)
 547             return pctx->op.sig.signature->digest_verify(pctx->op.sig.sigprovctx,
 548                                                          sigret, siglen,
 549                                                          tbs, tbslen);
 550     } else {
 551         /* legacy */
 552         if (ctx->pctx->pmeth != NULL && ctx->pctx->pmeth->digestverify != NULL)
 553             return ctx->pctx->pmeth->digestverify(ctx, sigret, siglen, tbs, tbslen);
 554     }
 555
 556     if (EVP_DigestVerifyUpdate(ctx, tbs, tbslen) <= 0)
 557         return -1;
 558     return EVP_DigestVerifyFinal(ctx, sigret, siglen);
 559 }
 560 #endif /* FIPS_MODULE */