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