crypto/evp/evp_enc.c

   1 /*
   2  * Copyright 1995-2021 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 /* We need to use some engine deprecated APIs */
  11 #define OPENSSL_SUPPRESS_DEPRECATED
  12
  13 #include <stdio.h>
  14 #include <limits.h>
  15 #include <assert.h>
  16 #include <openssl/evp.h>
  17 #include <openssl/err.h>
  18 #include <openssl/rand.h>
  19 #include <openssl/engine.h>
  20 #include <openssl/params.h>
  21 #include <openssl/core_names.h>
  22 #include "internal/cryptlib.h"
  23 #include "internal/provider.h"
  24 #include "internal/core.h"
  25 #include "crypto/evp.h"
  26 #include "evp_local.h"
  27
  28 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx)
  29 {
  30     if (ctx == NULL)
  31         return 1;
  32
  33     if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
  34         goto legacy;
  35
  36     if (ctx->algctx != NULL) {
  37         if (ctx->cipher->freectx != NULL)
  38             ctx->cipher->freectx(ctx->algctx);
  39         ctx->algctx = NULL;
  40     }
  41     if (ctx->fetched_cipher != NULL)
  42         EVP_CIPHER_free(ctx->fetched_cipher);
  43     memset(ctx, 0, sizeof(*ctx));
  44
  45     return 1;
  46
  47     /* Remove legacy code below when legacy support is removed. */
  48  legacy:
  49
  50     if (ctx->cipher != NULL) {
  51         if (ctx->cipher->cleanup && !ctx->cipher->cleanup(ctx))
  52             return 0;
  53         /* Cleanse cipher context data */
  54         if (ctx->cipher_data && ctx->cipher->ctx_size)
  55             OPENSSL_cleanse(ctx->cipher_data, ctx->cipher->ctx_size);
  56     }
  57     OPENSSL_free(ctx->cipher_data);
  58 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
  59     ENGINE_finish(ctx->engine);
  60 #endif
  61     memset(ctx, 0, sizeof(*ctx));
  62     return 1;
  63 }
  64
  65 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
  66 {
  67     return OPENSSL_zalloc(sizeof(EVP_CIPHER_CTX));
  68 }
  69
  70 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
  71 {
  72     if (ctx == NULL)
  73         return;
  74     EVP_CIPHER_CTX_reset(ctx);
  75     OPENSSL_free(ctx);
  76 }
  77
  78 static int evp_cipher_init_internal(EVP_CIPHER_CTX *ctx,
  79                                     const EVP_CIPHER *cipher,
  80                                     ENGINE *impl, const unsigned char *key,
  81                                     const unsigned char *iv, int enc,
  82                                     const OSSL_PARAM params[])
  83 {
  84     int n;
  85 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
  86     ENGINE *tmpimpl = NULL;
  87 #endif
  88     /*
  89      * enc == 1 means we are encrypting.
  90      * enc == 0 means we are decrypting.
  91      * enc == -1 means, use the previously initialised value for encrypt/decrypt
  92      */
  93     if (enc == -1) {
  94         enc = ctx->encrypt;
  95     } else {
  96         if (enc)
  97             enc = 1;
  98         ctx->encrypt = enc;
  99     }
 100
 101     if (cipher == NULL && ctx->cipher == NULL) {
 102         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
 103         return 0;
 104     }
 105
 106     /* Code below to be removed when legacy support is dropped. */
 107
 108 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
 109     /*
 110      * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
 111      * this context may already have an ENGINE! Try to avoid releasing the
 112      * previous handle, re-querying for an ENGINE, and having a
 113      * reinitialisation, when it may all be unnecessary.
 114      */
 115     if (ctx->engine && ctx->cipher
 116         && (cipher == NULL || cipher->nid == ctx->cipher->nid))
 117         goto skip_to_init;
 118
 119     if (cipher != NULL && impl == NULL) {
 120          /* Ask if an ENGINE is reserved for this job */
 121         tmpimpl = ENGINE_get_cipher_engine(cipher->nid);
 122     }
 123 #endif
 124
 125     /*
 126      * If there are engines involved then we should use legacy handling for now.
 127      */
 128     if (ctx->engine != NULL
 129 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
 130             || tmpimpl != NULL
 131 #endif
 132             || impl != NULL) {
 133         if (ctx->cipher == ctx->fetched_cipher)
 134             ctx->cipher = NULL;
 135         EVP_CIPHER_free(ctx->fetched_cipher);
 136         ctx->fetched_cipher = NULL;
 137         goto legacy;
 138     }
 139     /*
 140      * Ensure a context left lying around from last time is cleared
 141      * (legacy code)
 142      */
 143     if (cipher != NULL && ctx->cipher != NULL) {
 144         OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
 145         ctx->cipher_data = NULL;
 146     }
 147
 148
 149     /* Start of non-legacy code below */
 150
 151     /* Ensure a context left lying around from last time is cleared */
 152     if (cipher != NULL && ctx->cipher != NULL) {
 153         unsigned long flags = ctx->flags;
 154
 155         EVP_CIPHER_CTX_reset(ctx);
 156         /* Restore encrypt and flags */
 157         ctx->encrypt = enc;
 158         ctx->flags = flags;
 159     }
 160
 161     if (cipher == NULL)
 162         cipher = ctx->cipher;
 163
 164     if (cipher->prov == NULL) {
 165 #ifdef FIPS_MODULE
 166         /* We only do explicit fetches inside the FIPS module */
 167         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 168         return 0;
 169 #else
 170         EVP_CIPHER *provciph =
 171             EVP_CIPHER_fetch(NULL,
 172                              cipher->nid == NID_undef ? "NULL"
 173                                                       : OBJ_nid2sn(cipher->nid),
 174                              "");
 175
 176         if (provciph == NULL)
 177             return 0;
 178         cipher = provciph;
 179         EVP_CIPHER_free(ctx->fetched_cipher);
 180         ctx->fetched_cipher = provciph;
 181 #endif
 182     }
 183
 184     if (cipher->prov != NULL) {
 185         if (!EVP_CIPHER_up_ref((EVP_CIPHER *)cipher)) {
 186             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 187             return 0;
 188         }
 189         EVP_CIPHER_free(ctx->fetched_cipher);
 190         ctx->fetched_cipher = (EVP_CIPHER *)cipher;
 191     }
 192     ctx->cipher = cipher;
 193     if (ctx->algctx == NULL) {
 194         ctx->algctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
 195         if (ctx->algctx == NULL) {
 196             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 197             return 0;
 198         }
 199     }
 200
 201     if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
 202         /*
 203          * If this ctx was already set up for no padding then we need to tell
 204          * the new cipher about it.
 205          */
 206         if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
 207             return 0;
 208     }
 209
 210     if (enc) {
 211         if (ctx->cipher->einit == NULL) {
 212             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 213             return 0;
 214         }
 215
 216         return ctx->cipher->einit(ctx->algctx,
 217                                   key,
 218                                   key == NULL ? 0
 219                                               : EVP_CIPHER_CTX_get_key_length(ctx),
 220                                   iv,
 221                                   iv == NULL ? 0
 222                                              : EVP_CIPHER_CTX_get_iv_length(ctx),
 223                                   params);
 224     }
 225
 226     if (ctx->cipher->dinit == NULL) {
 227         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 228         return 0;
 229     }
 230
 231     return ctx->cipher->dinit(ctx->algctx,
 232                               key,
 233                               key == NULL ? 0
 234                                           : EVP_CIPHER_CTX_get_key_length(ctx),
 235                               iv,
 236                               iv == NULL ? 0
 237                                          : EVP_CIPHER_CTX_get_iv_length(ctx),
 238                                   params);
 239
 240     /* Code below to be removed when legacy support is dropped. */
 241  legacy:
 242
 243     if (cipher != NULL) {
 244         /*
 245          * Ensure a context left lying around from last time is cleared (we
 246          * previously attempted to avoid this if the same ENGINE and
 247          * EVP_CIPHER could be used).
 248          */
 249         if (ctx->cipher) {
 250             unsigned long flags = ctx->flags;
 251             EVP_CIPHER_CTX_reset(ctx);
 252             /* Restore encrypt and flags */
 253             ctx->encrypt = enc;
 254             ctx->flags = flags;
 255         }
 256 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
 257         if (impl != NULL) {
 258             if (!ENGINE_init(impl)) {
 259                 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 260                 return 0;
 261             }
 262         } else {
 263             impl = tmpimpl;
 264         }
 265         if (impl != NULL) {
 266             /* There's an ENGINE for this job ... (apparently) */
 267             const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
 268
 269             if (c == NULL) {
 270                 /*
 271                  * One positive side-effect of US's export control history,
 272                  * is that we should at least be able to avoid using US
 273                  * misspellings of "initialisation"?
 274                  */
 275                 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 276                 return 0;
 277             }
 278             /* We'll use the ENGINE's private cipher definition */
 279             cipher = c;
 280             /*
 281              * Store the ENGINE functional reference so we know 'cipher' came
 282              * from an ENGINE and we need to release it when done.
 283              */
 284             ctx->engine = impl;
 285         } else {
 286             ctx->engine = NULL;
 287         }
 288 #endif
 289
 290         ctx->cipher = cipher;
 291         if (ctx->cipher->ctx_size) {
 292             ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
 293             if (ctx->cipher_data == NULL) {
 294                 ctx->cipher = NULL;
 295                 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
 296                 return 0;
 297             }
 298         } else {
 299             ctx->cipher_data = NULL;
 300         }
 301         ctx->key_len = cipher->key_len;
 302         /* Preserve wrap enable flag, zero everything else */
 303         ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
 304         if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
 305             if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
 306                 ctx->cipher = NULL;
 307                 ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 308                 return 0;
 309             }
 310         }
 311     }
 312 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
 313  skip_to_init:
 314 #endif
 315     if (ctx->cipher == NULL)
 316         return 0;
 317
 318     /* we assume block size is a power of 2 in *cryptUpdate */
 319     OPENSSL_assert(ctx->cipher->block_size == 1
 320                    || ctx->cipher->block_size == 8
 321                    || ctx->cipher->block_size == 16);
 322
 323     if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
 324         && EVP_CIPHER_CTX_get_mode(ctx) == EVP_CIPH_WRAP_MODE) {
 325         ERR_raise(ERR_LIB_EVP, EVP_R_WRAP_MODE_NOT_ALLOWED);
 326         return 0;
 327     }
 328
 329     if ((EVP_CIPHER_get_flags(EVP_CIPHER_CTX_get0_cipher(ctx))
 330                 & EVP_CIPH_CUSTOM_IV) == 0) {
 331         switch (EVP_CIPHER_CTX_get_mode(ctx)) {
 332
 333         case EVP_CIPH_STREAM_CIPHER:
 334         case EVP_CIPH_ECB_MODE:
 335             break;
 336
 337         case EVP_CIPH_CFB_MODE:
 338         case EVP_CIPH_OFB_MODE:
 339
 340             ctx->num = 0;
 341             /* fall-through */
 342
 343         case EVP_CIPH_CBC_MODE:
 344             n = EVP_CIPHER_CTX_get_iv_length(ctx);
 345             if (!ossl_assert(n >= 0 && n <= (int)sizeof(ctx->iv)))
 346                     return 0;
 347             if (iv)
 348                 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_get_iv_length(ctx));
 349             memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_get_iv_length(ctx));
 350             break;
 351
 352         case EVP_CIPH_CTR_MODE:
 353             ctx->num = 0;
 354             /* Don't reuse IV for CTR mode */
 355             if (iv)
 356                 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_get_iv_length(ctx));
 357             break;
 358
 359         default:
 360             return 0;
 361         }
 362     }
 363
 364     if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
 365         if (!ctx->cipher->init(ctx, key, iv, enc))
 366             return 0;
 367     }
 368     ctx->buf_len = 0;
 369     ctx->final_used = 0;
 370     ctx->block_mask = ctx->cipher->block_size - 1;
 371     return 1;
 372 }
 373
 374 int EVP_CipherInit_ex2(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 375                        const unsigned char *key, const unsigned char *iv,
 376                        int enc, const OSSL_PARAM params[])
 377 {
 378     return evp_cipher_init_internal(ctx, cipher, NULL, key, iv, enc, params);
 379 }
 380
 381 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 382                    const unsigned char *key, const unsigned char *iv, int enc)
 383 {
 384     if (cipher != NULL)
 385         EVP_CIPHER_CTX_reset(ctx);
 386     return evp_cipher_init_internal(ctx, cipher, NULL, key, iv, enc, NULL);
 387 }
 388
 389 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 390                       ENGINE *impl, const unsigned char *key,
 391                       const unsigned char *iv, int enc)
 392 {
 393     return evp_cipher_init_internal(ctx, cipher, impl, key, iv, enc, NULL);
 394 }
 395
 396 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
 397                      const unsigned char *in, int inl)
 398 {
 399     if (ctx->encrypt)
 400         return EVP_EncryptUpdate(ctx, out, outl, in, inl);
 401     else
 402         return EVP_DecryptUpdate(ctx, out, outl, in, inl);
 403 }
 404
 405 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 406 {
 407     if (ctx->encrypt)
 408         return EVP_EncryptFinal_ex(ctx, out, outl);
 409     else
 410         return EVP_DecryptFinal_ex(ctx, out, outl);
 411 }
 412
 413 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 414 {
 415     if (ctx->encrypt)
 416         return EVP_EncryptFinal(ctx, out, outl);
 417     else
 418         return EVP_DecryptFinal(ctx, out, outl);
 419 }
 420
 421 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 422                     const unsigned char *key, const unsigned char *iv)
 423 {
 424     return EVP_CipherInit(ctx, cipher, key, iv, 1);
 425 }
 426
 427 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 428                        ENGINE *impl, const unsigned char *key,
 429                        const unsigned char *iv)
 430 {
 431     return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
 432 }
 433
 434 int EVP_EncryptInit_ex2(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 435                         const unsigned char *key, const unsigned char *iv,
 436                         const OSSL_PARAM params[])
 437 {
 438     return EVP_CipherInit_ex2(ctx, cipher, key, iv, 1, params);
 439 }
 440
 441 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 442                     const unsigned char *key, const unsigned char *iv)
 443 {
 444     return EVP_CipherInit(ctx, cipher, key, iv, 0);
 445 }
 446
 447 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 448                        ENGINE *impl, const unsigned char *key,
 449                        const unsigned char *iv)
 450 {
 451     return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
 452 }
 453
 454 int EVP_DecryptInit_ex2(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 455                         const unsigned char *key, const unsigned char *iv,
 456                         const OSSL_PARAM params[])
 457 {
 458     return EVP_CipherInit_ex2(ctx, cipher, key, iv, 0, params);
 459 }
 460
 461 /*
 462  * According to the letter of standard difference between pointers
 463  * is specified to be valid only within same object. This makes
 464  * it formally challenging to determine if input and output buffers
 465  * are not partially overlapping with standard pointer arithmetic.
 466  */
 467 #ifdef PTRDIFF_T
 468 # undef PTRDIFF_T
 469 #endif
 470 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
 471 /*
 472  * Then we have VMS that distinguishes itself by adhering to
 473  * sizeof(size_t)==4 even in 64-bit builds, which means that
 474  * difference between two pointers might be truncated to 32 bits.
 475  * In the context one can even wonder how comparison for
 476  * equality is implemented. To be on the safe side we adhere to
 477  * PTRDIFF_T even for comparison for equality.
 478  */
 479 # define PTRDIFF_T uint64_t
 480 #else
 481 # define PTRDIFF_T size_t
 482 #endif
 483
 484 int ossl_is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
 485 {
 486     PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
 487     /*
 488      * Check for partially overlapping buffers. [Binary logical
 489      * operations are used instead of boolean to minimize number
 490      * of conditional branches.]
 491      */
 492     int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
 493                                                 (diff > (0 - (PTRDIFF_T)len)));
 494
 495     return overlapped;
 496 }
 497
 498 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
 499                                     unsigned char *out, int *outl,
 500                                     const unsigned char *in, int inl)
 501 {
 502     int i, j, bl, cmpl = inl;
 503
 504     if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
 505         cmpl = (cmpl + 7) / 8;
 506
 507     bl = ctx->cipher->block_size;
 508
 509     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 510         /* If block size > 1 then the cipher will have to do this check */
 511         if (bl == 1 && ossl_is_partially_overlapping(out, in, cmpl)) {
 512             ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
 513             return 0;
 514         }
 515
 516         i = ctx->cipher->do_cipher(ctx, out, in, inl);
 517         if (i < 0)
 518             return 0;
 519         else
 520             *outl = i;
 521         return 1;
 522     }
 523
 524     if (inl <= 0) {
 525         *outl = 0;
 526         return inl == 0;
 527     }
 528     if (ossl_is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
 529         ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
 530         return 0;
 531     }
 532
 533     if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
 534         if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
 535             *outl = inl;
 536             return 1;
 537         } else {
 538             *outl = 0;
 539             return 0;
 540         }
 541     }
 542     i = ctx->buf_len;
 543     OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
 544     if (i != 0) {
 545         if (bl - i > inl) {
 546             memcpy(&(ctx->buf[i]), in, inl);
 547             ctx->buf_len += inl;
 548             *outl = 0;
 549             return 1;
 550         } else {
 551             j = bl - i;
 552
 553             /*
 554              * Once we've processed the first j bytes from in, the amount of
 555              * data left that is a multiple of the block length is:
 556              * (inl - j) & ~(bl - 1)
 557              * We must ensure that this amount of data, plus the one block that
 558              * we process from ctx->buf does not exceed INT_MAX
 559              */
 560             if (((inl - j) & ~(bl - 1)) > INT_MAX - bl) {
 561                 ERR_raise(ERR_LIB_EVP, EVP_R_OUTPUT_WOULD_OVERFLOW);
 562                 return 0;
 563             }
 564             memcpy(&(ctx->buf[i]), in, j);
 565             inl -= j;
 566             in += j;
 567             if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
 568                 return 0;
 569             out += bl;
 570             *outl = bl;
 571         }
 572     } else
 573         *outl = 0;
 574     i = inl & (bl - 1);
 575     inl -= i;
 576     if (inl > 0) {
 577         if (!ctx->cipher->do_cipher(ctx, out, in, inl))
 578             return 0;
 579         *outl += inl;
 580     }
 581
 582     if (i != 0)
 583         memcpy(ctx->buf, &(in[inl]), i);
 584     ctx->buf_len = i;
 585     return 1;
 586 }
 587
 588
 589 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
 590                       const unsigned char *in, int inl)
 591 {
 592     int ret;
 593     size_t soutl;
 594     int blocksize;
 595
 596     if (outl != NULL) {
 597         *outl = 0;
 598     } else {
 599         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 600         return 0;
 601     }
 602
 603     /* Prevent accidental use of decryption context when encrypting */
 604     if (!ctx->encrypt) {
 605         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
 606         return 0;
 607     }
 608
 609     if (ctx->cipher == NULL) {
 610         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
 611         return 0;
 612     }
 613
 614     if (ctx->cipher->prov == NULL)
 615         goto legacy;
 616
 617     blocksize = ctx->cipher->block_size;
 618
 619     if (ctx->cipher->cupdate == NULL  || blocksize < 1) {
 620         ERR_raise(ERR_LIB_EVP, EVP_R_UPDATE_ERROR);
 621         return 0;
 622     }
 623     ret = ctx->cipher->cupdate(ctx->algctx, out, &soutl,
 624                                inl + (blocksize == 1 ? 0 : blocksize), in,
 625                                (size_t)inl);
 626
 627     if (ret) {
 628         if (soutl > INT_MAX) {
 629             ERR_raise(ERR_LIB_EVP, EVP_R_UPDATE_ERROR);
 630             return 0;
 631         }
 632         *outl = soutl;
 633     }
 634
 635     return ret;
 636
 637     /* Code below to be removed when legacy support is dropped. */
 638  legacy:
 639
 640     return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
 641 }
 642
 643 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 644 {
 645     int ret;
 646     ret = EVP_EncryptFinal_ex(ctx, out, outl);
 647     return ret;
 648 }
 649
 650 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 651 {
 652     int n, ret;
 653     unsigned int i, b, bl;
 654     size_t soutl;
 655     int blocksize;
 656
 657     if (outl != NULL) {
 658         *outl = 0;
 659     } else {
 660         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 661         return 0;
 662     }
 663
 664     /* Prevent accidental use of decryption context when encrypting */
 665     if (!ctx->encrypt) {
 666         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
 667         return 0;
 668     }
 669
 670     if (ctx->cipher == NULL) {
 671         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
 672         return 0;
 673     }
 674     if (ctx->cipher->prov == NULL)
 675         goto legacy;
 676
 677     blocksize = EVP_CIPHER_CTX_get_block_size(ctx);
 678
 679     if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
 680         ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
 681         return 0;
 682     }
 683
 684     ret = ctx->cipher->cfinal(ctx->algctx, out, &soutl,
 685                               blocksize == 1 ? 0 : blocksize);
 686
 687     if (ret) {
 688         if (soutl > INT_MAX) {
 689             ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
 690             return 0;
 691         }
 692         *outl = soutl;
 693     }
 694
 695     return ret;
 696
 697     /* Code below to be removed when legacy support is dropped. */
 698  legacy:
 699
 700     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 701         ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
 702         if (ret < 0)
 703             return 0;
 704         else
 705             *outl = ret;
 706         return 1;
 707     }
 708
 709     b = ctx->cipher->block_size;
 710     OPENSSL_assert(b <= sizeof(ctx->buf));
 711     if (b == 1) {
 712         *outl = 0;
 713         return 1;
 714     }
 715     bl = ctx->buf_len;
 716     if (ctx->flags & EVP_CIPH_NO_PADDING) {
 717         if (bl) {
 718             ERR_raise(ERR_LIB_EVP, EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
 719             return 0;
 720         }
 721         *outl = 0;
 722         return 1;
 723     }
 724
 725     n = b - bl;
 726     for (i = bl; i < b; i++)
 727         ctx->buf[i] = n;
 728     ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
 729
 730     if (ret)
 731         *outl = b;
 732
 733     return ret;
 734 }
 735
 736 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
 737                       const unsigned char *in, int inl)
 738 {
 739     int fix_len, cmpl = inl, ret;
 740     unsigned int b;
 741     size_t soutl;
 742     int blocksize;
 743
 744     if (outl != NULL) {
 745         *outl = 0;
 746     } else {
 747         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 748         return 0;
 749     }
 750
 751     /* Prevent accidental use of encryption context when decrypting */
 752     if (ctx->encrypt) {
 753         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
 754         return 0;
 755     }
 756
 757     if (ctx->cipher == NULL) {
 758         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
 759         return 0;
 760     }
 761     if (ctx->cipher->prov == NULL)
 762         goto legacy;
 763
 764     blocksize = EVP_CIPHER_CTX_get_block_size(ctx);
 765
 766     if (ctx->cipher->cupdate == NULL || blocksize < 1) {
 767         ERR_raise(ERR_LIB_EVP, EVP_R_UPDATE_ERROR);
 768         return 0;
 769     }
 770     ret = ctx->cipher->cupdate(ctx->algctx, out, &soutl,
 771                                inl + (blocksize == 1 ? 0 : blocksize), in,
 772                                (size_t)inl);
 773
 774     if (ret) {
 775         if (soutl > INT_MAX) {
 776             ERR_raise(ERR_LIB_EVP, EVP_R_UPDATE_ERROR);
 777             return 0;
 778         }
 779         *outl = soutl;
 780     }
 781
 782     return ret;
 783
 784     /* Code below to be removed when legacy support is dropped. */
 785  legacy:
 786
 787     b = ctx->cipher->block_size;
 788
 789     if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
 790         cmpl = (cmpl + 7) / 8;
 791
 792     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 793         if (b == 1 && ossl_is_partially_overlapping(out, in, cmpl)) {
 794             ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
 795             return 0;
 796         }
 797
 798         fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
 799         if (fix_len < 0) {
 800             *outl = 0;
 801             return 0;
 802         } else
 803             *outl = fix_len;
 804         return 1;
 805     }
 806
 807     if (inl <= 0) {
 808         *outl = 0;
 809         return inl == 0;
 810     }
 811
 812     if (ctx->flags & EVP_CIPH_NO_PADDING)
 813         return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
 814
 815     OPENSSL_assert(b <= sizeof(ctx->final));
 816
 817     if (ctx->final_used) {
 818         /* see comment about PTRDIFF_T comparison above */
 819         if (((PTRDIFF_T)out == (PTRDIFF_T)in)
 820             || ossl_is_partially_overlapping(out, in, b)) {
 821             ERR_raise(ERR_LIB_EVP, EVP_R_PARTIALLY_OVERLAPPING);
 822             return 0;
 823         }
 824         /*
 825          * final_used is only ever set if buf_len is 0. Therefore the maximum
 826          * length output we will ever see from evp_EncryptDecryptUpdate is
 827          * the maximum multiple of the block length that is <= inl, or just:
 828          * inl & ~(b - 1)
 829          * Since final_used has been set then the final output length is:
 830          * (inl & ~(b - 1)) + b
 831          * This must never exceed INT_MAX
 832          */
 833         if ((inl & ~(b - 1)) > INT_MAX - b) {
 834             ERR_raise(ERR_LIB_EVP, EVP_R_OUTPUT_WOULD_OVERFLOW);
 835             return 0;
 836         }
 837         memcpy(out, ctx->final, b);
 838         out += b;
 839         fix_len = 1;
 840     } else
 841         fix_len = 0;
 842
 843     if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
 844         return 0;
 845
 846     /*
 847      * if we have 'decrypted' a multiple of block size, make sure we have a
 848      * copy of this last block
 849      */
 850     if (b > 1 && !ctx->buf_len) {
 851         *outl -= b;
 852         ctx->final_used = 1;
 853         memcpy(ctx->final, &out[*outl], b);
 854     } else
 855         ctx->final_used = 0;
 856
 857     if (fix_len)
 858         *outl += b;
 859
 860     return 1;
 861 }
 862
 863 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 864 {
 865     int ret;
 866     ret = EVP_DecryptFinal_ex(ctx, out, outl);
 867     return ret;
 868 }
 869
 870 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 871 {
 872     int i, n;
 873     unsigned int b;
 874     size_t soutl;
 875     int ret;
 876     int blocksize;
 877
 878     if (outl != NULL) {
 879         *outl = 0;
 880     } else {
 881         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 882         return 0;
 883     }
 884
 885     /* Prevent accidental use of encryption context when decrypting */
 886     if (ctx->encrypt) {
 887         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
 888         return 0;
 889     }
 890
 891     if (ctx->cipher == NULL) {
 892         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
 893         return 0;
 894     }
 895
 896     if (ctx->cipher->prov == NULL)
 897         goto legacy;
 898
 899     blocksize = EVP_CIPHER_CTX_get_block_size(ctx);
 900
 901     if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
 902         ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
 903         return 0;
 904     }
 905
 906     ret = ctx->cipher->cfinal(ctx->algctx, out, &soutl,
 907                               blocksize == 1 ? 0 : blocksize);
 908
 909     if (ret) {
 910         if (soutl > INT_MAX) {
 911             ERR_raise(ERR_LIB_EVP, EVP_R_FINAL_ERROR);
 912             return 0;
 913         }
 914         *outl = soutl;
 915     }
 916
 917     return ret;
 918
 919     /* Code below to be removed when legacy support is dropped. */
 920  legacy:
 921
 922     *outl = 0;
 923     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 924         i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
 925         if (i < 0)
 926             return 0;
 927         else
 928             *outl = i;
 929         return 1;
 930     }
 931
 932     b = ctx->cipher->block_size;
 933     if (ctx->flags & EVP_CIPH_NO_PADDING) {
 934         if (ctx->buf_len) {
 935             ERR_raise(ERR_LIB_EVP, EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
 936             return 0;
 937         }
 938         *outl = 0;
 939         return 1;
 940     }
 941     if (b > 1) {
 942         if (ctx->buf_len || !ctx->final_used) {
 943             ERR_raise(ERR_LIB_EVP, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
 944             return 0;
 945         }
 946         OPENSSL_assert(b <= sizeof(ctx->final));
 947
 948         /*
 949          * The following assumes that the ciphertext has been authenticated.
 950          * Otherwise it provides a padding oracle.
 951          */
 952         n = ctx->final[b - 1];
 953         if (n == 0 || n > (int)b) {
 954             ERR_raise(ERR_LIB_EVP, EVP_R_BAD_DECRYPT);
 955             return 0;
 956         }
 957         for (i = 0; i < n; i++) {
 958             if (ctx->final[--b] != n) {
 959                 ERR_raise(ERR_LIB_EVP, EVP_R_BAD_DECRYPT);
 960                 return 0;
 961             }
 962         }
 963         n = ctx->cipher->block_size - n;
 964         for (i = 0; i < n; i++)
 965             out[i] = ctx->final[i];
 966         *outl = n;
 967     } else
 968         *outl = 0;
 969     return 1;
 970 }
 971
 972 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
 973 {
 974     if (c->cipher->prov != NULL) {
 975         int ok;
 976         OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
 977         size_t len = keylen;
 978
 979         if (EVP_CIPHER_CTX_get_key_length(c) == keylen)
 980             return 1;
 981
 982         /* Check the cipher actually understands this parameter */
 983         if (OSSL_PARAM_locate_const(EVP_CIPHER_settable_ctx_params(c->cipher),
 984                                     OSSL_CIPHER_PARAM_KEYLEN) == NULL)
 985             return 0;
 986
 987         params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &len);
 988         ok = evp_do_ciph_ctx_setparams(c->cipher, c->algctx, params);
 989
 990         return ok > 0 ? 1 : 0;
 991     }
 992
 993     /* Code below to be removed when legacy support is dropped. */
 994
 995     /*
 996      * Note there have never been any built-in ciphers that define this flag
 997      * since it was first introduced.
 998      */
 999     if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
1000         return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
1001     if (EVP_CIPHER_CTX_get_key_length(c) == keylen)
1002         return 1;
1003     if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
1004         c->key_len = keylen;
1005         return 1;
1006     }
1007     ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH);
1008     return 0;
1009 }
1010
1011 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
1012 {
1013     int ok;
1014     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1015     unsigned int pd = pad;
1016
1017     if (pad)
1018         ctx->flags &= ~EVP_CIPH_NO_PADDING;
1019     else
1020         ctx->flags |= EVP_CIPH_NO_PADDING;
1021
1022     if (ctx->cipher != NULL && ctx->cipher->prov == NULL)
1023         return 1;
1024     params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING, &pd);
1025     ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->algctx, params);
1026
1027     return ok != 0;
1028 }
1029
1030 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
1031 {
1032     int ret = EVP_CTRL_RET_UNSUPPORTED;
1033     int set_params = 1;
1034     size_t sz = arg;
1035     unsigned int i;
1036     OSSL_PARAM params[4] = {
1037         OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END
1038     };
1039
1040     if (ctx == NULL || ctx->cipher == NULL) {
1041         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
1042         return 0;
1043     }
1044
1045     if (ctx->cipher->prov == NULL)
1046         goto legacy;
1047
1048     switch (type) {
1049     case EVP_CTRL_SET_KEY_LENGTH:
1050         params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &sz);
1051         break;
1052     case EVP_CTRL_RAND_KEY:      /* Used by DES */
1053         set_params = 0;
1054         params[0] =
1055             OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
1056                                               ptr, sz);
1057         break;
1058
1059     case EVP_CTRL_INIT:
1060         /*
1061          * EVP_CTRL_INIT is purely legacy, no provider counterpart.
1062          * As a matter of fact, this should be dead code, but some caller
1063          * might still do a direct control call with this command, so...
1064          * Legacy methods return 1 except for exceptional circumstances, so
1065          * we do the same here to not be disruptive.
1066          */
1067         return 1;
1068     case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
1069     default:
1070         goto end;
1071     case EVP_CTRL_AEAD_SET_IVLEN:
1072         if (arg < 0)
1073             return 0;
1074         params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
1075         break;
1076     case EVP_CTRL_CCM_SET_L:
1077         if (arg < 2 || arg > 8)
1078             return 0;
1079         sz = 15 - arg;
1080         params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
1081         break;
1082     case EVP_CTRL_AEAD_SET_IV_FIXED:
1083         params[0] = OSSL_PARAM_construct_octet_string(
1084                         OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, ptr, sz);
1085         break;
1086     case EVP_CTRL_GCM_IV_GEN:
1087         set_params = 0;
1088         if (arg < 0)
1089             sz = 0; /* special case that uses the iv length */
1090         params[0] = OSSL_PARAM_construct_octet_string(
1091                         OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN, ptr, sz);
1092         break;
1093     case EVP_CTRL_GCM_SET_IV_INV:
1094         if (arg < 0)
1095             return 0;
1096         params[0] = OSSL_PARAM_construct_octet_string(
1097                         OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV, ptr, sz);
1098         break;
1099     case EVP_CTRL_GET_RC5_ROUNDS:
1100         set_params = 0; /* Fall thru */
1101     case EVP_CTRL_SET_RC5_ROUNDS:
1102         if (arg < 0)
1103             return 0;
1104         i = (unsigned int)arg;
1105         params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_ROUNDS, &i);
1106         break;
1107     case EVP_CTRL_SET_SPEED:
1108         if (arg < 0)
1109             return 0;
1110         i = (unsigned int)arg;
1111         params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_SPEED, &i);
1112         break;
1113     case EVP_CTRL_AEAD_GET_TAG:
1114         set_params = 0; /* Fall thru */
1115     case EVP_CTRL_AEAD_SET_TAG:
1116         params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1117                                                       ptr, sz);
1118         break;
1119     case EVP_CTRL_AEAD_TLS1_AAD:
1120         /* This one does a set and a get - since it returns a size */
1121         params[0] =
1122             OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1123                                               ptr, sz);
1124         ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->algctx, params);
1125         if (ret <= 0)
1126             goto end;
1127         params[0] =
1128             OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1129         ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->algctx, params);
1130         if (ret <= 0)
1131             goto end;
1132         return sz;
1133 #ifndef OPENSSL_NO_RC2
1134     case EVP_CTRL_GET_RC2_KEY_BITS:
1135         set_params = 0; /* Fall thru */
1136     case EVP_CTRL_SET_RC2_KEY_BITS:
1137         params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, &sz);
1138         break;
1139 #endif /* OPENSSL_NO_RC2 */
1140 #if !defined(OPENSSL_NO_MULTIBLOCK)
1141     case EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE:
1142         params[0] = OSSL_PARAM_construct_size_t(
1143                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT, &sz);
1144         ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->algctx, params);
1145         if (ret <= 0)
1146             return 0;
1147
1148         params[0] = OSSL_PARAM_construct_size_t(
1149                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE, &sz);
1150         params[1] = OSSL_PARAM_construct_end();
1151         ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->algctx, params);
1152         if (ret <= 0)
1153             return 0;
1154         return sz;
1155     case EVP_CTRL_TLS1_1_MULTIBLOCK_AAD: {
1156         EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *p =
1157             (EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *)ptr;
1158
1159         if (arg < (int)sizeof(EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM))
1160             return 0;
1161
1162         params[0] = OSSL_PARAM_construct_octet_string(
1163                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD, (void*)p->inp, p->len);
1164         params[1] = OSSL_PARAM_construct_uint(
1165                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1166         ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->algctx, params);
1167         if (ret <= 0)
1168             return ret;
1169         /* Retrieve the return values changed by the set */
1170         params[0] = OSSL_PARAM_construct_size_t(
1171                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN, &sz);
1172         params[1] = OSSL_PARAM_construct_uint(
1173                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1174         params[2] = OSSL_PARAM_construct_end();
1175         ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->algctx, params);
1176         if (ret <= 0)
1177             return 0;
1178         return sz;
1179     }
1180     case EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT: {
1181         EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *p =
1182             (EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM *)ptr;
1183
1184         params[0] = OSSL_PARAM_construct_octet_string(
1185                         OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC, p->out, p->len);
1186
1187         params[1] = OSSL_PARAM_construct_octet_string(
1188                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN, (void*)p->inp,
1189                 p->len);
1190         params[2] = OSSL_PARAM_construct_uint(
1191                 OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE, &p->interleave);
1192         ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->algctx, params);
1193         if (ret <= 0)
1194             return ret;
1195         params[0] = OSSL_PARAM_construct_size_t(
1196                         OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN, &sz);
1197         params[1] = OSSL_PARAM_construct_end();
1198         ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->algctx, params);
1199         if (ret <= 0)
1200             return 0;
1201         return sz;
1202     }
1203 #endif /* OPENSSL_NO_MULTIBLOCK */
1204     case EVP_CTRL_AEAD_SET_MAC_KEY:
1205         if (arg < 0)
1206             return -1;
1207         params[0] = OSSL_PARAM_construct_octet_string(
1208                 OSSL_CIPHER_PARAM_AEAD_MAC_KEY, ptr, sz);
1209         break;
1210     }
1211
1212     if (set_params)
1213         ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->algctx, params);
1214     else
1215         ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->algctx, params);
1216     goto end;
1217
1218     /* Code below to be removed when legacy support is dropped. */
1219 legacy:
1220     if (ctx->cipher->ctrl == NULL) {
1221         ERR_raise(ERR_LIB_EVP, EVP_R_CTRL_NOT_IMPLEMENTED);
1222         return 0;
1223     }
1224
1225     ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1226
1227  end:
1228     if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1229         ERR_raise(ERR_LIB_EVP, EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1230         return 0;
1231     }
1232     return ret;
1233 }
1234
1235 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1236 {
1237     if (cipher != NULL && cipher->get_params != NULL)
1238         return cipher->get_params(params);
1239     return 0;
1240 }
1241
1242 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1243 {
1244     if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1245         return ctx->cipher->set_ctx_params(ctx->algctx, params);
1246     return 0;
1247 }
1248
1249 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1250 {
1251     if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1252         return ctx->cipher->get_ctx_params(ctx->algctx, params);
1253     return 0;
1254 }
1255
1256 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1257 {
1258     if (cipher != NULL && cipher->gettable_params != NULL)
1259         return cipher->gettable_params(
1260                    ossl_provider_ctx(EVP_CIPHER_get0_provider(cipher)));
1261     return NULL;
1262 }
1263
1264 const OSSL_PARAM *EVP_CIPHER_settable_ctx_params(const EVP_CIPHER *cipher)
1265 {
1266     void *provctx;
1267
1268     if (cipher != NULL && cipher->settable_ctx_params != NULL) {
1269         provctx = ossl_provider_ctx(EVP_CIPHER_get0_provider(cipher));
1270         return cipher->settable_ctx_params(NULL, provctx);
1271     }
1272     return NULL;
1273 }
1274
1275 const OSSL_PARAM *EVP_CIPHER_gettable_ctx_params(const EVP_CIPHER *cipher)
1276 {
1277     void *provctx;
1278
1279     if (cipher != NULL && cipher->gettable_ctx_params != NULL) {
1280         provctx = ossl_provider_ctx(EVP_CIPHER_get0_provider(cipher));
1281         return cipher->gettable_ctx_params(NULL, provctx);
1282     }
1283     return NULL;
1284 }
1285
1286 const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(EVP_CIPHER_CTX *cctx)
1287 {
1288     void *alg;
1289
1290     if (cctx != NULL && cctx->cipher->settable_ctx_params != NULL) {
1291         alg = ossl_provider_ctx(EVP_CIPHER_get0_provider(cctx->cipher));
1292         return cctx->cipher->settable_ctx_params(cctx->algctx, alg);
1293     }
1294     return NULL;
1295 }
1296
1297 const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(EVP_CIPHER_CTX *cctx)
1298 {
1299     void *provctx;
1300
1301     if (cctx != NULL && cctx->cipher->gettable_ctx_params != NULL) {
1302         provctx = ossl_provider_ctx(EVP_CIPHER_get0_provider(cctx->cipher));
1303         return cctx->cipher->gettable_ctx_params(cctx->algctx, provctx);
1304     }
1305     return NULL;
1306 }
1307
1308 #ifndef FIPS_MODULE
1309 static OSSL_LIB_CTX *EVP_CIPHER_CTX_get_libctx(EVP_CIPHER_CTX *ctx)
1310 {
1311     const EVP_CIPHER *cipher = ctx->cipher;
1312     const OSSL_PROVIDER *prov;
1313
1314     if (cipher == NULL)
1315         return NULL;
1316
1317     prov = EVP_CIPHER_get0_provider(cipher);
1318     return ossl_provider_libctx(prov);
1319 }
1320 #endif
1321
1322 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1323 {
1324     if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1325         return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1326
1327 #ifdef FIPS_MODULE
1328     return 0;
1329 #else
1330     {
1331         int kl;
1332         OSSL_LIB_CTX *libctx = EVP_CIPHER_CTX_get_libctx(ctx);
1333
1334         kl = EVP_CIPHER_CTX_get_key_length(ctx);
1335         if (kl <= 0 || RAND_priv_bytes_ex(libctx, key, kl, 0) <= 0)
1336             return 0;
1337         return 1;
1338     }
1339 #endif /* FIPS_MODULE */
1340 }
1341
1342 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1343 {
1344     if ((in == NULL) || (in->cipher == NULL)) {
1345         ERR_raise(ERR_LIB_EVP, EVP_R_INPUT_NOT_INITIALIZED);
1346         return 0;
1347     }
1348
1349     if (in->cipher->prov == NULL)
1350         goto legacy;
1351
1352     if (in->cipher->dupctx == NULL) {
1353         ERR_raise(ERR_LIB_EVP, EVP_R_NOT_ABLE_TO_COPY_CTX);
1354         return 0;
1355     }
1356
1357     EVP_CIPHER_CTX_reset(out);
1358
1359     *out = *in;
1360     out->algctx = NULL;
1361
1362     if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1363         out->fetched_cipher = NULL;
1364         return 0;
1365     }
1366
1367     out->algctx = in->cipher->dupctx(in->algctx);
1368     if (out->algctx == NULL) {
1369         ERR_raise(ERR_LIB_EVP, EVP_R_NOT_ABLE_TO_COPY_CTX);
1370         return 0;
1371     }
1372
1373     return 1;
1374
1375     /* Code below to be removed when legacy support is dropped. */
1376  legacy:
1377
1378 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
1379     /* Make sure it's safe to copy a cipher context using an ENGINE */
1380     if (in->engine && !ENGINE_init(in->engine)) {
1381         ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
1382         return 0;
1383     }
1384 #endif
1385
1386     EVP_CIPHER_CTX_reset(out);
1387     memcpy(out, in, sizeof(*out));
1388
1389     if (in->cipher_data && in->cipher->ctx_size) {
1390         out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1391         if (out->cipher_data == NULL) {
1392             out->cipher = NULL;
1393             ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1394             return 0;
1395         }
1396         memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1397     }
1398
1399     if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1400         if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1401             out->cipher = NULL;
1402             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
1403             return 0;
1404         }
1405     return 1;
1406 }
1407
1408 EVP_CIPHER *evp_cipher_new(void)
1409 {
1410     EVP_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_CIPHER));
1411
1412     if (cipher != NULL) {
1413         cipher->lock = CRYPTO_THREAD_lock_new();
1414         if (cipher->lock == NULL) {
1415             OPENSSL_free(cipher);
1416             return NULL;
1417         }
1418         cipher->refcnt = 1;
1419     }
1420     return cipher;
1421 }
1422
1423 /*
1424  * FIPS module note: since internal fetches will be entirely
1425  * provider based, we know that none of its code depends on legacy
1426  * NIDs or any functionality that use them.
1427  */
1428 #ifndef FIPS_MODULE
1429 /* After removal of legacy support get rid of the need for legacy NIDs */
1430 static void set_legacy_nid(const char *name, void *vlegacy_nid)
1431 {
1432     int nid;
1433     int *legacy_nid = vlegacy_nid;
1434     /*
1435      * We use lowest level function to get the associated method, because
1436      * higher level functions such as EVP_get_cipherbyname() have changed
1437      * to look at providers too.
1438      */
1439     const void *legacy_method = OBJ_NAME_get(name, OBJ_NAME_TYPE_CIPHER_METH);
1440
1441     if (*legacy_nid == -1)       /* We found a clash already */
1442         return;
1443     if (legacy_method == NULL)
1444         return;
1445     nid = EVP_CIPHER_get_nid(legacy_method);
1446     if (*legacy_nid != NID_undef && *legacy_nid != nid) {
1447         *legacy_nid = -1;
1448         return;
1449     }
1450     *legacy_nid = nid;
1451 }
1452 #endif
1453
1454 static void *evp_cipher_from_algorithm(const int name_id,
1455                                        const OSSL_ALGORITHM *algodef,
1456                                        OSSL_PROVIDER *prov)
1457 {
1458     const OSSL_DISPATCH *fns = algodef->implementation;
1459     EVP_CIPHER *cipher = NULL;
1460     int fnciphcnt = 0, fnctxcnt = 0;
1461
1462     if ((cipher = evp_cipher_new()) == NULL) {
1463         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1464         return NULL;
1465     }
1466
1467 #ifndef FIPS_MODULE
1468     cipher->nid = NID_undef;
1469     if (!evp_names_do_all(prov, name_id, set_legacy_nid, &cipher->nid)
1470             || cipher->nid == -1) {
1471         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1472         EVP_CIPHER_free(cipher);
1473         return NULL;
1474     }
1475 #endif
1476
1477     cipher->name_id = name_id;
1478     if ((cipher->type_name = ossl_algorithm_get1_first_name(algodef)) == NULL) {
1479         EVP_CIPHER_free(cipher);
1480         return NULL;
1481     }
1482     cipher->description = algodef->algorithm_description;
1483
1484     for (; fns->function_id != 0; fns++) {
1485         switch (fns->function_id) {
1486         case OSSL_FUNC_CIPHER_NEWCTX:
1487             if (cipher->newctx != NULL)
1488                 break;
1489             cipher->newctx = OSSL_FUNC_cipher_newctx(fns);
1490             fnctxcnt++;
1491             break;
1492         case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1493             if (cipher->einit != NULL)
1494                 break;
1495             cipher->einit = OSSL_FUNC_cipher_encrypt_init(fns);
1496             fnciphcnt++;
1497             break;
1498         case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1499             if (cipher->dinit != NULL)
1500                 break;
1501             cipher->dinit = OSSL_FUNC_cipher_decrypt_init(fns);
1502             fnciphcnt++;
1503             break;
1504         case OSSL_FUNC_CIPHER_UPDATE:
1505             if (cipher->cupdate != NULL)
1506                 break;
1507             cipher->cupdate = OSSL_FUNC_cipher_update(fns);
1508             fnciphcnt++;
1509             break;
1510         case OSSL_FUNC_CIPHER_FINAL:
1511             if (cipher->cfinal != NULL)
1512                 break;
1513             cipher->cfinal = OSSL_FUNC_cipher_final(fns);
1514             fnciphcnt++;
1515             break;
1516         case OSSL_FUNC_CIPHER_CIPHER:
1517             if (cipher->ccipher != NULL)
1518                 break;
1519             cipher->ccipher = OSSL_FUNC_cipher_cipher(fns);
1520             break;
1521         case OSSL_FUNC_CIPHER_FREECTX:
1522             if (cipher->freectx != NULL)
1523                 break;
1524             cipher->freectx = OSSL_FUNC_cipher_freectx(fns);
1525             fnctxcnt++;
1526             break;
1527         case OSSL_FUNC_CIPHER_DUPCTX:
1528             if (cipher->dupctx != NULL)
1529                 break;
1530             cipher->dupctx = OSSL_FUNC_cipher_dupctx(fns);
1531             break;
1532         case OSSL_FUNC_CIPHER_GET_PARAMS:
1533             if (cipher->get_params != NULL)
1534                 break;
1535             cipher->get_params = OSSL_FUNC_cipher_get_params(fns);
1536             break;
1537         case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1538             if (cipher->get_ctx_params != NULL)
1539                 break;
1540             cipher->get_ctx_params = OSSL_FUNC_cipher_get_ctx_params(fns);
1541             break;
1542         case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1543             if (cipher->set_ctx_params != NULL)
1544                 break;
1545             cipher->set_ctx_params = OSSL_FUNC_cipher_set_ctx_params(fns);
1546             break;
1547         case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1548             if (cipher->gettable_params != NULL)
1549                 break;
1550             cipher->gettable_params = OSSL_FUNC_cipher_gettable_params(fns);
1551             break;
1552         case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1553             if (cipher->gettable_ctx_params != NULL)
1554                 break;
1555             cipher->gettable_ctx_params =
1556                 OSSL_FUNC_cipher_gettable_ctx_params(fns);
1557             break;
1558         case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1559             if (cipher->settable_ctx_params != NULL)
1560                 break;
1561             cipher->settable_ctx_params =
1562                 OSSL_FUNC_cipher_settable_ctx_params(fns);
1563             break;
1564         }
1565     }
1566     if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1567             || (fnciphcnt == 0 && cipher->ccipher == NULL)
1568             || fnctxcnt != 2) {
1569         /*
1570          * In order to be a consistent set of functions we must have at least
1571          * a complete set of "encrypt" functions, or a complete set of "decrypt"
1572          * functions, or a single "cipher" function. In all cases we need both
1573          * the "newctx" and "freectx" functions.
1574          */
1575         EVP_CIPHER_free(cipher);
1576         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1577         return NULL;
1578     }
1579     cipher->prov = prov;
1580     if (prov != NULL)
1581         ossl_provider_up_ref(prov);
1582
1583     if (!evp_cipher_cache_constants(cipher)) {
1584         EVP_CIPHER_free(cipher);
1585         ERR_raise(ERR_LIB_EVP, EVP_R_CACHE_CONSTANTS_FAILED);
1586         cipher = NULL;
1587     }
1588
1589     return cipher;
1590 }
1591
1592 static int evp_cipher_up_ref(void *cipher)
1593 {
1594     return EVP_CIPHER_up_ref(cipher);
1595 }
1596
1597 static void evp_cipher_free(void *cipher)
1598 {
1599     EVP_CIPHER_free(cipher);
1600 }
1601
1602 EVP_CIPHER *EVP_CIPHER_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
1603                              const char *properties)
1604 {
1605     EVP_CIPHER *cipher =
1606         evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1607                           evp_cipher_from_algorithm, evp_cipher_up_ref,
1608                           evp_cipher_free);
1609
1610     return cipher;
1611 }
1612
1613 int EVP_CIPHER_up_ref(EVP_CIPHER *cipher)
1614 {
1615     int ref = 0;
1616
1617     if (cipher->origin == EVP_ORIG_DYNAMIC)
1618         CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
1619     return 1;
1620 }
1621
1622 void evp_cipher_free_int(EVP_CIPHER *cipher)
1623 {
1624     OPENSSL_free(cipher->type_name);
1625     ossl_provider_free(cipher->prov);
1626     CRYPTO_THREAD_lock_free(cipher->lock);
1627     OPENSSL_free(cipher);
1628 }
1629
1630 void EVP_CIPHER_free(EVP_CIPHER *cipher)
1631 {
1632     int i;
1633
1634     if (cipher == NULL || cipher->origin != EVP_ORIG_DYNAMIC)
1635         return;
1636
1637     CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
1638     if (i > 0)
1639         return;
1640     evp_cipher_free_int(cipher);
1641 }
1642
1643 void EVP_CIPHER_do_all_provided(OSSL_LIB_CTX *libctx,
1644                                 void (*fn)(EVP_CIPHER *mac, void *arg),
1645                                 void *arg)
1646 {
1647     evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1648                        (void (*)(void *, void *))fn, arg,
1649                        evp_cipher_from_algorithm, evp_cipher_free);
1650 }