crypto/evp/evp_enc.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include <assert.h>
  12 #include "internal/cryptlib.h"
  13 #include <openssl/evp.h>
  14 #include <openssl/err.h>
  15 #include <openssl/rand.h>
  16 #include <openssl/rand_drbg.h>
  17 #include <openssl/engine.h>
  18 #include <openssl/params.h>
  19 #include <openssl/core_names.h>
  20 #include "internal/evp_int.h"
  21 #include "internal/provider.h"
  22 #include "evp_locl.h"
  23
  24 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx)
  25 {
  26     if (ctx == NULL)
  27         return 1;
  28
  29     if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
  30         goto legacy;
  31
  32     if (ctx->provctx != NULL) {
  33         if (ctx->cipher->freectx != NULL)
  34             ctx->cipher->freectx(ctx->provctx);
  35         ctx->provctx = NULL;
  36     }
  37     if (ctx->fetched_cipher != NULL)
  38         EVP_CIPHER_meth_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 #ifndef OPENSSL_NO_ENGINE
  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     EVP_CIPHER *provciph = NULL;
  85     ENGINE *tmpimpl = NULL;
  86     const EVP_CIPHER *tmpcipher;
  87
  88     /*
  89      * enc == 1 means we are encrypting.
  90      * enc == 0 means we are decrypting.
  91      * enc == -1 means, use the previously initialised value for encrypt/decrypt
  92      */
  93     if (enc == -1) {
  94         enc = ctx->encrypt;
  95     } else {
  96         if (enc)
  97             enc = 1;
  98         ctx->encrypt = enc;
  99     }
 100
 101     if (cipher == NULL && ctx->cipher == NULL) {
 102         EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
 103         return 0;
 104     }
 105
 106     /* TODO(3.0): Legacy work around code below. Remove this */
 107
 108 #ifndef OPENSSL_NO_ENGINE
 109     /*
 110      * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
 111      * this context may already have an ENGINE! Try to avoid releasing the
 112      * previous handle, re-querying for an ENGINE, and having a
 113      * reinitialisation, when it may all be unnecessary.
 114      */
 115     if (ctx->engine && ctx->cipher
 116         && (cipher == NULL || cipher->nid == ctx->cipher->nid))
 117         goto skip_to_init;
 118
 119     if (cipher != NULL && impl == NULL) {
 120          /* Ask if an ENGINE is reserved for this job */
 121         tmpimpl = ENGINE_get_cipher_engine(cipher->nid);
 122     }
 123 #endif
 124
 125     /*
 126      * If there are engines involved then we should use legacy handling for now.
 127      */
 128     if (ctx->engine != NULL
 129             || impl != NULL
 130             || tmpimpl != NULL) {
 131         if (ctx->cipher == ctx->fetched_cipher)
 132             ctx->cipher = NULL;
 133         EVP_CIPHER_meth_free(ctx->fetched_cipher);
 134         ctx->fetched_cipher = NULL;
 135         goto legacy;
 136     }
 137
 138     tmpcipher = (cipher == NULL) ? ctx->cipher : cipher;
 139
 140     if (tmpcipher->prov == NULL) {
 141         switch(tmpcipher->nid) {
 142         default:
 143             goto legacy;
 144         }
 145     }
 146
 147     /*
 148      * Ensure a context left lying around from last time is cleared
 149      * (legacy code)
 150      */
 151     if (cipher != NULL && ctx->cipher != NULL) {
 152         OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
 153         ctx->cipher_data = NULL;
 154     }
 155
 156
 157     /* TODO(3.0): Start of non-legacy code below */
 158
 159     /* Ensure a context left lying around from last time is cleared */
 160     if (cipher != NULL && ctx->cipher != NULL) {
 161         unsigned long flags = ctx->flags;
 162
 163         EVP_CIPHER_CTX_reset(ctx);
 164         /* Restore encrypt and flags */
 165         ctx->encrypt = enc;
 166         ctx->flags = flags;
 167     }
 168
 169     if (cipher != NULL)
 170         ctx->cipher = cipher;
 171     else
 172         cipher = ctx->cipher;
 173
 174     if (cipher->prov == NULL) {
 175         provciph = EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
 176         if (provciph == NULL) {
 177             EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 178             return 0;
 179         }
 180         cipher = provciph;
 181         EVP_CIPHER_meth_free(ctx->fetched_cipher);
 182         ctx->fetched_cipher = provciph;
 183     }
 184
 185     ctx->cipher = cipher;
 186     if (ctx->provctx == NULL) {
 187         ctx->provctx = ctx->cipher->newctx();
 188         if (ctx->provctx == NULL) {
 189             EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 190             return 0;
 191         }
 192     }
 193
 194     if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
 195         /*
 196          * If this ctx was already set up for no padding then we need to tell
 197          * the new cipher about it.
 198          */
 199         if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
 200             return 0;
 201     }
 202
 203     if (enc) {
 204         if (ctx->cipher->einit == NULL) {
 205             EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 206             return 0;
 207         }
 208
 209         return ctx->cipher->einit(ctx->provctx, key, iv);
 210     }
 211
 212     if (ctx->cipher->dinit == NULL) {
 213         EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 214         return 0;
 215     }
 216
 217     return ctx->cipher->dinit(ctx->provctx, key, iv);
 218
 219     /* TODO(3.0): Remove legacy code below */
 220  legacy:
 221
 222     if (cipher != NULL) {
 223         /*
 224          * Ensure a context left lying around from last time is cleared (we
 225          * previously attempted to avoid this if the same ENGINE and
 226          * EVP_CIPHER could be used).
 227          */
 228         if (ctx->cipher) {
 229             unsigned long flags = ctx->flags;
 230             EVP_CIPHER_CTX_reset(ctx);
 231             /* Restore encrypt and flags */
 232             ctx->encrypt = enc;
 233             ctx->flags = flags;
 234         }
 235 #ifndef OPENSSL_NO_ENGINE
 236         if (impl != NULL) {
 237             if (!ENGINE_init(impl)) {
 238                 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 239                 return 0;
 240             }
 241         } else {
 242             impl = tmpimpl;
 243         }
 244         if (impl != NULL) {
 245             /* There's an ENGINE for this job ... (apparently) */
 246             const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
 247
 248             if (c == NULL) {
 249                 /*
 250                  * One positive side-effect of US's export control history,
 251                  * is that we should at least be able to avoid using US
 252                  * misspellings of "initialisation"?
 253                  */
 254                 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 255                 return 0;
 256             }
 257             /* We'll use the ENGINE's private cipher definition */
 258             cipher = c;
 259             /*
 260              * Store the ENGINE functional reference so we know 'cipher' came
 261              * from an ENGINE and we need to release it when done.
 262              */
 263             ctx->engine = impl;
 264         } else {
 265             ctx->engine = NULL;
 266         }
 267 #endif
 268
 269         ctx->cipher = cipher;
 270         if (ctx->cipher->ctx_size) {
 271             ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
 272             if (ctx->cipher_data == NULL) {
 273                 ctx->cipher = NULL;
 274                 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
 275                 return 0;
 276             }
 277         } else {
 278             ctx->cipher_data = NULL;
 279         }
 280         ctx->key_len = cipher->key_len;
 281         /* Preserve wrap enable flag, zero everything else */
 282         ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
 283         if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
 284             if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
 285                 ctx->cipher = NULL;
 286                 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
 287                 return 0;
 288             }
 289         }
 290     }
 291 #ifndef OPENSSL_NO_ENGINE
 292  skip_to_init:
 293 #endif
 294     /* we assume block size is a power of 2 in *cryptUpdate */
 295     OPENSSL_assert(ctx->cipher->block_size == 1
 296                    || ctx->cipher->block_size == 8
 297                    || ctx->cipher->block_size == 16);
 298
 299     if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
 300         && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
 301         EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
 302         return 0;
 303     }
 304
 305     if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
 306         switch (EVP_CIPHER_CTX_mode(ctx)) {
 307
 308         case EVP_CIPH_STREAM_CIPHER:
 309         case EVP_CIPH_ECB_MODE:
 310             break;
 311
 312         case EVP_CIPH_CFB_MODE:
 313         case EVP_CIPH_OFB_MODE:
 314
 315             ctx->num = 0;
 316             /* fall-through */
 317
 318         case EVP_CIPH_CBC_MODE:
 319
 320             OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
 321                            (int)sizeof(ctx->iv));
 322             if (iv)
 323                 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
 324             memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
 325             break;
 326
 327         case EVP_CIPH_CTR_MODE:
 328             ctx->num = 0;
 329             /* Don't reuse IV for CTR mode */
 330             if (iv)
 331                 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
 332             break;
 333
 334         default:
 335             return 0;
 336         }
 337     }
 338
 339     if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
 340         if (!ctx->cipher->init(ctx, key, iv, enc))
 341             return 0;
 342     }
 343     ctx->buf_len = 0;
 344     ctx->final_used = 0;
 345     ctx->block_mask = ctx->cipher->block_size - 1;
 346     return 1;
 347 }
 348
 349 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
 350                      const unsigned char *in, int inl)
 351 {
 352     if (ctx->encrypt)
 353         return EVP_EncryptUpdate(ctx, out, outl, in, inl);
 354     else
 355         return EVP_DecryptUpdate(ctx, out, outl, in, inl);
 356 }
 357
 358 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 359 {
 360     if (ctx->encrypt)
 361         return EVP_EncryptFinal_ex(ctx, out, outl);
 362     else
 363         return EVP_DecryptFinal_ex(ctx, out, outl);
 364 }
 365
 366 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 367 {
 368     if (ctx->encrypt)
 369         return EVP_EncryptFinal(ctx, out, outl);
 370     else
 371         return EVP_DecryptFinal(ctx, out, outl);
 372 }
 373
 374 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 375                     const unsigned char *key, const unsigned char *iv)
 376 {
 377     return EVP_CipherInit(ctx, cipher, key, iv, 1);
 378 }
 379
 380 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 381                        ENGINE *impl, const unsigned char *key,
 382                        const unsigned char *iv)
 383 {
 384     return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
 385 }
 386
 387 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 388                     const unsigned char *key, const unsigned char *iv)
 389 {
 390     return EVP_CipherInit(ctx, cipher, key, iv, 0);
 391 }
 392
 393 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
 394                        ENGINE *impl, const unsigned char *key,
 395                        const unsigned char *iv)
 396 {
 397     return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
 398 }
 399
 400 /*
 401  * According to the letter of standard difference between pointers
 402  * is specified to be valid only within same object. This makes
 403  * it formally challenging to determine if input and output buffers
 404  * are not partially overlapping with standard pointer arithmetic.
 405  */
 406 #ifdef PTRDIFF_T
 407 # undef PTRDIFF_T
 408 #endif
 409 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
 410 /*
 411  * Then we have VMS that distinguishes itself by adhering to
 412  * sizeof(size_t)==4 even in 64-bit builds, which means that
 413  * difference between two pointers might be truncated to 32 bits.
 414  * In the context one can even wonder how comparison for
 415  * equality is implemented. To be on the safe side we adhere to
 416  * PTRDIFF_T even for comparison for equality.
 417  */
 418 # define PTRDIFF_T uint64_t
 419 #else
 420 # define PTRDIFF_T size_t
 421 #endif
 422
 423 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
 424 {
 425     PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
 426     /*
 427      * Check for partially overlapping buffers. [Binary logical
 428      * operations are used instead of boolean to minimize number
 429      * of conditional branches.]
 430      */
 431     int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
 432                                                 (diff > (0 - (PTRDIFF_T)len)));
 433
 434     return overlapped;
 435 }
 436
 437 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
 438                                     unsigned char *out, int *outl,
 439                                     const unsigned char *in, int inl)
 440 {
 441     int i, j, bl, cmpl = inl;
 442
 443     if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
 444         cmpl = (cmpl + 7) / 8;
 445
 446     bl = ctx->cipher->block_size;
 447
 448     if (inl <= 0) {
 449         *outl = 0;
 450         return inl == 0;
 451     }
 452
 453     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 454         /* If block size > 1 then the cipher will have to do this check */
 455         if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
 456             EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
 457             return 0;
 458         }
 459
 460         i = ctx->cipher->do_cipher(ctx, out, in, inl);
 461         if (i < 0)
 462             return 0;
 463         else
 464             *outl = i;
 465         return 1;
 466     }
 467
 468     if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
 469         EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
 470         return 0;
 471     }
 472
 473     if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
 474         if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
 475             *outl = inl;
 476             return 1;
 477         } else {
 478             *outl = 0;
 479             return 0;
 480         }
 481     }
 482     i = ctx->buf_len;
 483     OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
 484     if (i != 0) {
 485         if (bl - i > inl) {
 486             memcpy(&(ctx->buf[i]), in, inl);
 487             ctx->buf_len += inl;
 488             *outl = 0;
 489             return 1;
 490         } else {
 491             j = bl - i;
 492             memcpy(&(ctx->buf[i]), in, j);
 493             inl -= j;
 494             in += j;
 495             if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
 496                 return 0;
 497             out += bl;
 498             *outl = bl;
 499         }
 500     } else
 501         *outl = 0;
 502     i = inl & (bl - 1);
 503     inl -= i;
 504     if (inl > 0) {
 505         if (!ctx->cipher->do_cipher(ctx, out, in, inl))
 506             return 0;
 507         *outl += inl;
 508     }
 509
 510     if (i != 0)
 511         memcpy(ctx->buf, &(in[inl]), i);
 512     ctx->buf_len = i;
 513     return 1;
 514 }
 515
 516
 517 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
 518                       const unsigned char *in, int inl)
 519 {
 520     int ret;
 521     size_t soutl;
 522
 523     /* Prevent accidental use of decryption context when encrypting */
 524     if (!ctx->encrypt) {
 525         EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
 526         return 0;
 527     }
 528
 529     if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
 530         goto legacy;
 531
 532     if (ctx->cipher->cupdate == NULL) {
 533         EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
 534         return 0;
 535     }
 536     ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
 537
 538     if (soutl > INT_MAX) {
 539         EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
 540         return 0;
 541     }
 542     *outl = soutl;
 543     return ret;
 544
 545     /* TODO(3.0): Remove legacy code below */
 546  legacy:
 547
 548     return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
 549 }
 550
 551 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 552 {
 553     int ret;
 554     ret = EVP_EncryptFinal_ex(ctx, out, outl);
 555     return ret;
 556 }
 557
 558 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 559 {
 560     int n, ret;
 561     unsigned int i, b, bl;
 562     size_t soutl;
 563
 564     /* Prevent accidental use of decryption context when encrypting */
 565     if (!ctx->encrypt) {
 566         EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
 567         return 0;
 568     }
 569
 570     if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
 571         goto legacy;
 572
 573     if (ctx->cipher->cfinal == NULL) {
 574         EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
 575         return 0;
 576     }
 577
 578     ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
 579
 580     if (soutl > INT_MAX) {
 581         EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
 582         return 0;
 583     }
 584     *outl = soutl;
 585
 586     return ret;
 587
 588     /* TODO(3.0): Remove legacy code below */
 589  legacy:
 590
 591     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 592         ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
 593         if (ret < 0)
 594             return 0;
 595         else
 596             *outl = ret;
 597         return 1;
 598     }
 599
 600     b = ctx->cipher->block_size;
 601     OPENSSL_assert(b <= sizeof(ctx->buf));
 602     if (b == 1) {
 603         *outl = 0;
 604         return 1;
 605     }
 606     bl = ctx->buf_len;
 607     if (ctx->flags & EVP_CIPH_NO_PADDING) {
 608         if (bl) {
 609             EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
 610                    EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
 611             return 0;
 612         }
 613         *outl = 0;
 614         return 1;
 615     }
 616
 617     n = b - bl;
 618     for (i = bl; i < b; i++)
 619         ctx->buf[i] = n;
 620     ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
 621
 622     if (ret)
 623         *outl = b;
 624
 625     return ret;
 626 }
 627
 628 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
 629                       const unsigned char *in, int inl)
 630 {
 631     int fix_len, cmpl = inl, ret;
 632     unsigned int b;
 633     size_t soutl;
 634
 635     /* Prevent accidental use of encryption context when decrypting */
 636     if (ctx->encrypt) {
 637         EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
 638         return 0;
 639     }
 640
 641     if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
 642         goto legacy;
 643
 644     if (ctx->cipher->cupdate == NULL) {
 645         EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
 646         return 0;
 647     }
 648     ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl, in, (size_t)inl);
 649
 650     if (ret) {
 651         if (soutl > INT_MAX) {
 652             EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
 653             return 0;
 654         }
 655         *outl = soutl;
 656     }
 657
 658     return ret;
 659
 660     /* TODO(3.0): Remove legacy code below */
 661  legacy:
 662
 663     b = ctx->cipher->block_size;
 664
 665     if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
 666         cmpl = (cmpl + 7) / 8;
 667
 668     if (inl <= 0) {
 669         *outl = 0;
 670         return inl == 0;
 671     }
 672
 673     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 674         if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
 675             EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
 676             return 0;
 677         }
 678
 679         fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
 680         if (fix_len < 0) {
 681             *outl = 0;
 682             return 0;
 683         } else
 684             *outl = fix_len;
 685         return 1;
 686     }
 687
 688     if (ctx->flags & EVP_CIPH_NO_PADDING)
 689         return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
 690
 691     OPENSSL_assert(b <= sizeof(ctx->final));
 692
 693     if (ctx->final_used) {
 694         /* see comment about PTRDIFF_T comparison above */
 695         if (((PTRDIFF_T)out == (PTRDIFF_T)in)
 696             || is_partially_overlapping(out, in, b)) {
 697             EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
 698             return 0;
 699         }
 700         memcpy(out, ctx->final, b);
 701         out += b;
 702         fix_len = 1;
 703     } else
 704         fix_len = 0;
 705
 706     if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
 707         return 0;
 708
 709     /*
 710      * if we have 'decrypted' a multiple of block size, make sure we have a
 711      * copy of this last block
 712      */
 713     if (b > 1 && !ctx->buf_len) {
 714         *outl -= b;
 715         ctx->final_used = 1;
 716         memcpy(ctx->final, &out[*outl], b);
 717     } else
 718         ctx->final_used = 0;
 719
 720     if (fix_len)
 721         *outl += b;
 722
 723     return 1;
 724 }
 725
 726 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 727 {
 728     int ret;
 729     ret = EVP_DecryptFinal_ex(ctx, out, outl);
 730     return ret;
 731 }
 732
 733 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
 734 {
 735     int i, n;
 736     unsigned int b;
 737     size_t soutl;
 738     int ret;
 739
 740     /* Prevent accidental use of encryption context when decrypting */
 741     if (ctx->encrypt) {
 742         EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
 743         return 0;
 744     }
 745
 746     if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
 747         goto legacy;
 748
 749     if (ctx->cipher->cfinal == NULL) {
 750         EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
 751         return 0;
 752     }
 753
 754     ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl);
 755
 756     if (ret) {
 757         if (soutl > INT_MAX) {
 758             EVPerr(EVP_F_EVP_DECRYPTFINAL_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     *outl = 0;
 770
 771     if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
 772         i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
 773         if (i < 0)
 774             return 0;
 775         else
 776             *outl = i;
 777         return 1;
 778     }
 779
 780     b = ctx->cipher->block_size;
 781     if (ctx->flags & EVP_CIPH_NO_PADDING) {
 782         if (ctx->buf_len) {
 783             EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
 784                    EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
 785             return 0;
 786         }
 787         *outl = 0;
 788         return 1;
 789     }
 790     if (b > 1) {
 791         if (ctx->buf_len || !ctx->final_used) {
 792             EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
 793             return 0;
 794         }
 795         OPENSSL_assert(b <= sizeof(ctx->final));
 796
 797         /*
 798          * The following assumes that the ciphertext has been authenticated.
 799          * Otherwise it provides a padding oracle.
 800          */
 801         n = ctx->final[b - 1];
 802         if (n == 0 || n > (int)b) {
 803             EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
 804             return 0;
 805         }
 806         for (i = 0; i < n; i++) {
 807             if (ctx->final[--b] != n) {
 808                 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
 809                 return 0;
 810             }
 811         }
 812         n = ctx->cipher->block_size - n;
 813         for (i = 0; i < n; i++)
 814             out[i] = ctx->final[i];
 815         *outl = n;
 816     } else
 817         *outl = 0;
 818     return 1;
 819 }
 820
 821 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
 822 {
 823     if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
 824         return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
 825     if (EVP_CIPHER_CTX_key_length(c) == keylen)
 826         return 1;
 827     if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
 828         c->key_len = keylen;
 829         return 1;
 830     }
 831     EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
 832     return 0;
 833 }
 834
 835 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
 836 {
 837     if (pad)
 838         ctx->flags &= ~EVP_CIPH_NO_PADDING;
 839     else
 840         ctx->flags |= EVP_CIPH_NO_PADDING;
 841
 842     if (ctx->cipher != NULL && ctx->cipher->prov != NULL) {
 843         OSSL_PARAM params[] = {
 844             OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING, NULL),
 845             OSSL_PARAM_END
 846         };
 847
 848         params[0].data = &pad;
 849
 850         if (ctx->cipher->set_params == NULL) {
 851             EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING, EVP_R_CTRL_NOT_IMPLEMENTED);
 852             return 0;
 853         }
 854
 855         if (!ctx->cipher->set_params(ctx->provctx, params))
 856             return 0;
 857     }
 858
 859     return 1;
 860 }
 861
 862 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
 863 {
 864     int ret;
 865
 866     if (!ctx->cipher) {
 867         EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
 868         return 0;
 869     }
 870
 871     if (!ctx->cipher->ctrl) {
 872         EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
 873         return 0;
 874     }
 875
 876     ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
 877     if (ret == -1) {
 878         EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
 879                EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
 880         return 0;
 881     }
 882     return ret;
 883 }
 884
 885 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
 886 {
 887     if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
 888         return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
 889     if (RAND_priv_bytes(key, ctx->key_len) <= 0)
 890         return 0;
 891     return 1;
 892 }
 893
 894 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
 895 {
 896     if ((in == NULL) || (in->cipher == NULL)) {
 897         EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
 898         return 0;
 899     }
 900
 901     if (in->cipher->prov == NULL)
 902         goto legacy;
 903
 904     if (in->cipher->dupctx == NULL) {
 905         EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
 906         return 0;
 907     }
 908
 909     EVP_CIPHER_CTX_reset(out);
 910
 911     *out = *in;
 912     out->provctx = NULL;
 913
 914     if (in->fetched_cipher != NULL || !EVP_CIPHER_upref(in->fetched_cipher)) {
 915         out->fetched_cipher = NULL;
 916         return 0;
 917     }
 918
 919     out->provctx = in->cipher->dupctx(in->provctx);
 920     if (out->provctx == NULL) {
 921         EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
 922         return 0;
 923     }
 924
 925     return 1;
 926
 927     /* TODO(3.0): Remove legacy code below */
 928  legacy:
 929
 930 #ifndef OPENSSL_NO_ENGINE
 931     /* Make sure it's safe to copy a cipher context using an ENGINE */
 932     if (in->engine && !ENGINE_init(in->engine)) {
 933         EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
 934         return 0;
 935     }
 936 #endif
 937
 938     EVP_CIPHER_CTX_reset(out);
 939     memcpy(out, in, sizeof(*out));
 940
 941     if (in->cipher_data && in->cipher->ctx_size) {
 942         out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
 943         if (out->cipher_data == NULL) {
 944             out->cipher = NULL;
 945             EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
 946             return 0;
 947         }
 948         memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
 949     }
 950
 951     if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
 952         if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
 953             out->cipher = NULL;
 954             EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
 955             return 0;
 956         }
 957     return 1;
 958 }
 959
 960 static void *evp_cipher_from_dispatch(int nid, const OSSL_DISPATCH *fns,
 961                                       OSSL_PROVIDER *prov)
 962 {
 963     EVP_CIPHER *cipher = NULL;
 964     int fnciphcnt = 0, fnctxcnt = 0;
 965
 966     if ((cipher = EVP_CIPHER_meth_new(nid, 0, 0)) == NULL)
 967         return NULL;
 968
 969     for (; fns->function_id != 0; fns++) {
 970         switch (fns->function_id) {
 971         case OSSL_FUNC_CIPHER_NEWCTX:
 972             if (cipher->newctx != NULL)
 973                 break;
 974             cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
 975             fnctxcnt++;
 976             break;
 977         case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
 978             if (cipher->einit != NULL)
 979                 break;
 980             cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
 981             fnciphcnt++;
 982             break;
 983         case OSSL_FUNC_CIPHER_DECRYPT_INIT:
 984             if (cipher->dinit != NULL)
 985                 break;
 986             cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
 987             fnciphcnt++;
 988             break;
 989         case OSSL_FUNC_CIPHER_UPDATE:
 990             if (cipher->cupdate != NULL)
 991                 break;
 992             cipher->cupdate = OSSL_get_OP_cipher_update(fns);
 993             fnciphcnt++;
 994             break;
 995         case OSSL_FUNC_CIPHER_FINAL:
 996             if (cipher->cfinal != NULL)
 997                 break;
 998             cipher->cfinal = OSSL_get_OP_cipher_final(fns);
 999             fnciphcnt++;
1000             break;
1001         case OSSL_FUNC_CIPHER_FREECTX:
1002             if (cipher->freectx != NULL)
1003                 break;
1004             cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1005             fnctxcnt++;
1006             break;
1007         case OSSL_FUNC_CIPHER_DUPCTX:
1008             if (cipher->dupctx != NULL)
1009                 break;
1010             cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1011             break;
1012         case OSSL_FUNC_CIPHER_KEY_LENGTH:
1013             if (cipher->key_length != NULL)
1014                 break;
1015             cipher->key_length = OSSL_get_OP_cipher_key_length(fns);
1016             break;
1017         case OSSL_FUNC_CIPHER_GET_PARAMS:
1018             if (cipher->get_params != NULL)
1019                 break;
1020             cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1021             break;
1022         case OSSL_FUNC_CIPHER_SET_PARAMS:
1023             if (cipher->set_params != NULL)
1024                 break;
1025             cipher->set_params = OSSL_get_OP_cipher_set_params(fns);
1026             break;
1027         }
1028     }
1029     if ((fnciphcnt != 3 && fnciphcnt != 4)
1030             || fnctxcnt != 2) {
1031         /*
1032          * In order to be a consistent set of functions we must have at least
1033          * a complete set of "encrypt" functions, or a complete set of "decrypt"
1034          * functions. In both cases we need a complete set of context management
1035          * functions
1036          */
1037         EVP_CIPHER_meth_free(cipher);
1038         EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1039         return NULL;
1040     }
1041     cipher->prov = prov;
1042     if (prov != NULL)
1043         ossl_provider_upref(prov);
1044
1045     return cipher;
1046 }
1047
1048 static int evp_cipher_upref(void *cipher)
1049 {
1050     return EVP_CIPHER_upref(cipher);
1051 }
1052
1053 static void evp_cipher_free(void *cipher)
1054 {
1055     EVP_CIPHER_meth_free(cipher);
1056 }
1057
1058 static int evp_cipher_nid(void *vcipher)
1059 {
1060     EVP_CIPHER *cipher = vcipher;
1061
1062     return cipher->nid;
1063 }
1064
1065 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1066                              const char *properties)
1067 {
1068     return evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1069                              evp_cipher_from_dispatch, evp_cipher_upref,
1070                              evp_cipher_free, evp_cipher_nid);
1071 }