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