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