crypto/evp/evp_enc.c

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