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