crypto/evp/m_sigver.c

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