crypto/evp/evp_enc.c

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