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