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