2 * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
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
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"
24 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx)
29 if (ctx->cipher == NULL || ctx->cipher->prov == NULL)
32 if (ctx->provctx != NULL) {
33 if (ctx->cipher->freectx != NULL)
34 ctx->cipher->freectx(ctx->provctx);
37 if (ctx->fetched_cipher != NULL)
38 EVP_CIPHER_free(ctx->fetched_cipher);
39 memset(ctx, 0, sizeof(*ctx));
43 /* TODO(3.0): Remove legacy code below */
46 if (ctx->cipher != NULL) {
47 if (ctx->cipher->cleanup && !ctx->cipher->cleanup(ctx))
49 /* Cleanse cipher context data */
50 if (ctx->cipher_data && ctx->cipher->ctx_size)
51 OPENSSL_cleanse(ctx->cipher_data, ctx->cipher->ctx_size);
53 OPENSSL_free(ctx->cipher_data);
54 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
55 ENGINE_finish(ctx->engine);
57 memset(ctx, 0, sizeof(*ctx));
61 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
63 return OPENSSL_zalloc(sizeof(EVP_CIPHER_CTX));
66 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
68 EVP_CIPHER_CTX_reset(ctx);
72 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
73 const unsigned char *key, const unsigned char *iv, int enc)
76 EVP_CIPHER_CTX_reset(ctx);
77 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
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)
84 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
85 ENGINE *tmpimpl = NULL;
87 const EVP_CIPHER *tmpcipher;
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
102 if (cipher == NULL && ctx->cipher == NULL) {
103 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
107 /* TODO(3.0): Legacy work around code below. Remove this */
109 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
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.
116 if (ctx->engine && ctx->cipher
117 && (cipher == NULL || cipher->nid == ctx->cipher->nid))
120 if (cipher != NULL && impl == NULL) {
121 /* Ask if an ENGINE is reserved for this job */
122 tmpimpl = ENGINE_get_cipher_engine(cipher->nid);
127 * If there are engines involved then we should use legacy handling for now.
129 if (ctx->engine != NULL
130 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
134 if (ctx->cipher == ctx->fetched_cipher)
136 EVP_CIPHER_free(ctx->fetched_cipher);
137 ctx->fetched_cipher = NULL;
141 tmpcipher = (cipher == NULL) ? ctx->cipher : cipher;
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:
248 case NID_id_smime_alg_CMS3DESwrap:
259 case NID_cast5_cfb64:
260 case NID_cast5_ofb64:
263 case NID_seed_cfb128:
264 case NID_seed_ofb128:
279 * Ensure a context left lying around from last time is cleared
282 if (cipher != NULL && ctx->cipher != NULL) {
283 OPENSSL_clear_free(ctx->cipher_data, ctx->cipher->ctx_size);
284 ctx->cipher_data = NULL;
288 /* TODO(3.0): Start of non-legacy code below */
290 /* Ensure a context left lying around from last time is cleared */
291 if (cipher != NULL && ctx->cipher != NULL) {
292 unsigned long flags = ctx->flags;
294 EVP_CIPHER_CTX_reset(ctx);
295 /* Restore encrypt and flags */
301 cipher = ctx->cipher;
303 if (cipher->prov == NULL) {
305 /* We only do explict fetches inside the FIPS module */
306 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
309 EVP_CIPHER *provciph =
310 EVP_CIPHER_fetch(NULL, OBJ_nid2sn(cipher->nid), "");
312 if (provciph == NULL) {
313 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
317 EVP_CIPHER_free(ctx->fetched_cipher);
318 ctx->fetched_cipher = provciph;
322 ctx->cipher = cipher;
323 if (ctx->provctx == NULL) {
324 ctx->provctx = ctx->cipher->newctx(ossl_provider_ctx(cipher->prov));
325 if (ctx->provctx == NULL) {
326 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
331 if ((ctx->flags & EVP_CIPH_NO_PADDING) != 0) {
333 * If this ctx was already set up for no padding then we need to tell
334 * the new cipher about it.
336 if (!EVP_CIPHER_CTX_set_padding(ctx, 0))
340 switch (EVP_CIPHER_mode(ctx->cipher)) {
341 case EVP_CIPH_CFB_MODE:
342 case EVP_CIPH_OFB_MODE:
343 case EVP_CIPH_CBC_MODE:
344 /* For these modes we remember the original IV for later use */
345 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx) <= (int)sizeof(ctx->oiv))) {
346 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
350 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
354 if (ctx->cipher->einit == NULL) {
355 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
359 return ctx->cipher->einit(ctx->provctx,
362 : EVP_CIPHER_CTX_key_length(ctx),
365 : EVP_CIPHER_CTX_iv_length(ctx));
368 if (ctx->cipher->dinit == NULL) {
369 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
373 return ctx->cipher->dinit(ctx->provctx,
376 : EVP_CIPHER_CTX_key_length(ctx),
379 : EVP_CIPHER_CTX_iv_length(ctx));
381 /* TODO(3.0): Remove legacy code below */
384 if (cipher != NULL) {
386 * Ensure a context left lying around from last time is cleared (we
387 * previously attempted to avoid this if the same ENGINE and
388 * EVP_CIPHER could be used).
391 unsigned long flags = ctx->flags;
392 EVP_CIPHER_CTX_reset(ctx);
393 /* Restore encrypt and flags */
397 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
399 if (!ENGINE_init(impl)) {
400 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
407 /* There's an ENGINE for this job ... (apparently) */
408 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
412 * One positive side-effect of US's export control history,
413 * is that we should at least be able to avoid using US
414 * misspellings of "initialisation"?
416 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
419 /* We'll use the ENGINE's private cipher definition */
422 * Store the ENGINE functional reference so we know 'cipher' came
423 * from an ENGINE and we need to release it when done.
431 ctx->cipher = cipher;
432 if (ctx->cipher->ctx_size) {
433 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
434 if (ctx->cipher_data == NULL) {
436 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
440 ctx->cipher_data = NULL;
442 ctx->key_len = cipher->key_len;
443 /* Preserve wrap enable flag, zero everything else */
444 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
445 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
446 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
448 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
453 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
456 if (ctx->cipher == NULL)
459 /* we assume block size is a power of 2 in *cryptUpdate */
460 OPENSSL_assert(ctx->cipher->block_size == 1
461 || ctx->cipher->block_size == 8
462 || ctx->cipher->block_size == 16);
464 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
465 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
466 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
470 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
471 switch (EVP_CIPHER_CTX_mode(ctx)) {
473 case EVP_CIPH_STREAM_CIPHER:
474 case EVP_CIPH_ECB_MODE:
477 case EVP_CIPH_CFB_MODE:
478 case EVP_CIPH_OFB_MODE:
483 case EVP_CIPH_CBC_MODE:
485 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
486 (int)sizeof(ctx->iv));
488 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
489 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
492 case EVP_CIPH_CTR_MODE:
494 /* Don't reuse IV for CTR mode */
496 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
504 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
505 if (!ctx->cipher->init(ctx, key, iv, enc))
510 ctx->block_mask = ctx->cipher->block_size - 1;
514 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
515 const unsigned char *in, int inl)
518 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
520 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
523 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
526 return EVP_EncryptFinal_ex(ctx, out, outl);
528 return EVP_DecryptFinal_ex(ctx, out, outl);
531 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
534 return EVP_EncryptFinal(ctx, out, outl);
536 return EVP_DecryptFinal(ctx, out, outl);
539 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
540 const unsigned char *key, const unsigned char *iv)
542 return EVP_CipherInit(ctx, cipher, key, iv, 1);
545 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
546 ENGINE *impl, const unsigned char *key,
547 const unsigned char *iv)
549 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
552 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
553 const unsigned char *key, const unsigned char *iv)
555 return EVP_CipherInit(ctx, cipher, key, iv, 0);
558 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
559 ENGINE *impl, const unsigned char *key,
560 const unsigned char *iv)
562 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
566 * According to the letter of standard difference between pointers
567 * is specified to be valid only within same object. This makes
568 * it formally challenging to determine if input and output buffers
569 * are not partially overlapping with standard pointer arithmetic.
574 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
576 * Then we have VMS that distinguishes itself by adhering to
577 * sizeof(size_t)==4 even in 64-bit builds, which means that
578 * difference between two pointers might be truncated to 32 bits.
579 * In the context one can even wonder how comparison for
580 * equality is implemented. To be on the safe side we adhere to
581 * PTRDIFF_T even for comparison for equality.
583 # define PTRDIFF_T uint64_t
585 # define PTRDIFF_T size_t
588 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len)
590 PTRDIFF_T diff = (PTRDIFF_T)ptr1-(PTRDIFF_T)ptr2;
592 * Check for partially overlapping buffers. [Binary logical
593 * operations are used instead of boolean to minimize number
594 * of conditional branches.]
596 int overlapped = (len > 0) & (diff != 0) & ((diff < (PTRDIFF_T)len) |
597 (diff > (0 - (PTRDIFF_T)len)));
602 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX *ctx,
603 unsigned char *out, int *outl,
604 const unsigned char *in, int inl)
606 int i, j, bl, cmpl = inl;
608 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
609 cmpl = (cmpl + 7) / 8;
611 bl = ctx->cipher->block_size;
613 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
614 /* If block size > 1 then the cipher will have to do this check */
615 if (bl == 1 && is_partially_overlapping(out, in, cmpl)) {
616 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
620 i = ctx->cipher->do_cipher(ctx, out, in, inl);
632 if (is_partially_overlapping(out + ctx->buf_len, in, cmpl)) {
633 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
637 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
638 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
647 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
650 memcpy(&(ctx->buf[i]), in, inl);
656 memcpy(&(ctx->buf[i]), in, j);
659 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
669 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
675 memcpy(ctx->buf, &(in[inl]), i);
681 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
682 const unsigned char *in, int inl)
688 /* Prevent accidental use of decryption context when encrypting */
690 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_INVALID_OPERATION);
694 if (ctx->cipher == NULL) {
695 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_NO_CIPHER_SET);
699 if (ctx->cipher->prov == NULL)
702 blocksize = EVP_CIPHER_CTX_block_size(ctx);
704 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
705 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
708 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
709 inl + (blocksize == 1 ? 0 : blocksize), in,
713 if (soutl > INT_MAX) {
714 EVPerr(EVP_F_EVP_ENCRYPTUPDATE, EVP_R_UPDATE_ERROR);
722 /* TODO(3.0): Remove legacy code below */
725 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
728 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
731 ret = EVP_EncryptFinal_ex(ctx, out, outl);
735 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
738 unsigned int i, b, bl;
742 /* Prevent accidental use of decryption context when encrypting */
744 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
748 if (ctx->cipher == NULL) {
749 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
752 if (ctx->cipher->prov == NULL)
755 blocksize = EVP_CIPHER_CTX_block_size(ctx);
757 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
758 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
762 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
763 blocksize == 1 ? 0 : blocksize);
766 if (soutl > INT_MAX) {
767 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX, EVP_R_FINAL_ERROR);
775 /* TODO(3.0): Remove legacy code below */
778 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
779 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
787 b = ctx->cipher->block_size;
788 OPENSSL_assert(b <= sizeof(ctx->buf));
794 if (ctx->flags & EVP_CIPH_NO_PADDING) {
796 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
797 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
805 for (i = bl; i < b; i++)
807 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
815 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
816 const unsigned char *in, int inl)
818 int fix_len, cmpl = inl, ret;
823 /* Prevent accidental use of encryption context when decrypting */
825 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_INVALID_OPERATION);
829 if (ctx->cipher == NULL) {
830 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_NO_CIPHER_SET);
833 if (ctx->cipher->prov == NULL)
836 blocksize = EVP_CIPHER_CTX_block_size(ctx);
838 if (ctx->cipher->cupdate == NULL || blocksize < 1) {
839 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
842 ret = ctx->cipher->cupdate(ctx->provctx, out, &soutl,
843 inl + (blocksize == 1 ? 0 : blocksize), in,
847 if (soutl > INT_MAX) {
848 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_UPDATE_ERROR);
856 /* TODO(3.0): Remove legacy code below */
859 b = ctx->cipher->block_size;
861 if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS))
862 cmpl = (cmpl + 7) / 8;
864 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
865 if (b == 1 && is_partially_overlapping(out, in, cmpl)) {
866 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
870 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
884 if (ctx->flags & EVP_CIPH_NO_PADDING)
885 return evp_EncryptDecryptUpdate(ctx, out, outl, in, inl);
887 OPENSSL_assert(b <= sizeof(ctx->final));
889 if (ctx->final_used) {
890 /* see comment about PTRDIFF_T comparison above */
891 if (((PTRDIFF_T)out == (PTRDIFF_T)in)
892 || is_partially_overlapping(out, in, b)) {
893 EVPerr(EVP_F_EVP_DECRYPTUPDATE, EVP_R_PARTIALLY_OVERLAPPING);
896 memcpy(out, ctx->final, b);
902 if (!evp_EncryptDecryptUpdate(ctx, out, outl, in, inl))
906 * if we have 'decrypted' a multiple of block size, make sure we have a
907 * copy of this last block
909 if (b > 1 && !ctx->buf_len) {
912 memcpy(ctx->final, &out[*outl], b);
922 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
925 ret = EVP_DecryptFinal_ex(ctx, out, outl);
929 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
937 /* Prevent accidental use of encryption context when decrypting */
939 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_INVALID_OPERATION);
943 if (ctx->cipher == NULL) {
944 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_NO_CIPHER_SET);
948 if (ctx->cipher->prov == NULL)
951 blocksize = EVP_CIPHER_CTX_block_size(ctx);
953 if (blocksize < 1 || ctx->cipher->cfinal == NULL) {
954 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
958 ret = ctx->cipher->cfinal(ctx->provctx, out, &soutl,
959 blocksize == 1 ? 0 : blocksize);
962 if (soutl > INT_MAX) {
963 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_FINAL_ERROR);
971 /* TODO(3.0): Remove legacy code below */
975 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
976 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
984 b = ctx->cipher->block_size;
985 if (ctx->flags & EVP_CIPH_NO_PADDING) {
987 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
988 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
995 if (ctx->buf_len || !ctx->final_used) {
996 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
999 OPENSSL_assert(b <= sizeof(ctx->final));
1002 * The following assumes that the ciphertext has been authenticated.
1003 * Otherwise it provides a padding oracle.
1005 n = ctx->final[b - 1];
1006 if (n == 0 || n > (int)b) {
1007 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
1010 for (i = 0; i < n; i++) {
1011 if (ctx->final[--b] != n) {
1012 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
1016 n = ctx->cipher->block_size - n;
1017 for (i = 0; i < n; i++)
1018 out[i] = ctx->final[i];
1025 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
1028 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1029 size_t len = keylen;
1031 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &len);
1032 ok = evp_do_ciph_ctx_setparams(c->cipher, c->provctx, params);
1034 if (ok != EVP_CTRL_RET_UNSUPPORTED)
1037 /* TODO(3.0) legacy code follows */
1038 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
1039 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
1040 if (EVP_CIPHER_CTX_key_length(c) == keylen)
1042 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
1043 c->key_len = keylen;
1046 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
1050 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
1053 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1054 unsigned int pd = pad;
1057 ctx->flags &= ~EVP_CIPH_NO_PADDING;
1059 ctx->flags |= EVP_CIPH_NO_PADDING;
1061 params[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING, &pd);
1062 ok = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1067 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
1069 int ret = EVP_CTRL_RET_UNSUPPORTED;
1072 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1074 if (ctx == NULL || ctx->cipher == NULL) {
1075 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
1079 if (ctx->cipher->prov == NULL)
1083 case EVP_CTRL_SET_KEY_LENGTH:
1084 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN, &sz);
1086 case EVP_CTRL_RAND_KEY: /* Used by DES */
1089 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY,
1093 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS: /* Used by DASYNC */
1094 case EVP_CTRL_INIT: /* TODO(3.0) Purely legacy, no provider counterpart */
1096 return EVP_CTRL_RET_UNSUPPORTED;
1097 case EVP_CTRL_GET_IV:
1099 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV,
1102 case EVP_CTRL_AEAD_SET_IVLEN:
1105 params[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN, &sz);
1107 case EVP_CTRL_GCM_SET_IV_FIXED:
1109 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED,
1112 case EVP_CTRL_AEAD_GET_TAG:
1113 set_params = 0; /* Fall thru */
1114 case EVP_CTRL_AEAD_SET_TAG:
1115 params[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG,
1118 case EVP_CTRL_AEAD_TLS1_AAD:
1119 /* This one does a set and a get - since it returns a padding size */
1121 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD,
1123 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1127 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, &sz);
1128 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1135 ret = evp_do_ciph_ctx_setparams(ctx->cipher, ctx->provctx, params);
1137 ret = evp_do_ciph_ctx_getparams(ctx->cipher, ctx->provctx, params);
1140 /* TODO(3.0): Remove legacy code below */
1142 if (ctx->cipher->ctrl == NULL) {
1143 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
1147 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
1148 if (ret == EVP_CTRL_RET_UNSUPPORTED) {
1149 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
1150 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
1156 int EVP_CIPHER_get_params(EVP_CIPHER *cipher, OSSL_PARAM params[])
1158 if (cipher != NULL && cipher->get_params != NULL)
1159 return cipher->get_params(params);
1163 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX *ctx, const OSSL_PARAM params[])
1165 if (ctx->cipher != NULL && ctx->cipher->set_ctx_params != NULL)
1166 return ctx->cipher->set_ctx_params(ctx->provctx, params);
1170 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX *ctx, OSSL_PARAM params[])
1172 if (ctx->cipher != NULL && ctx->cipher->get_ctx_params != NULL)
1173 return ctx->cipher->get_ctx_params(ctx->provctx, params);
1177 const OSSL_PARAM *EVP_CIPHER_gettable_params(const EVP_CIPHER *cipher)
1179 if (cipher != NULL && cipher->gettable_params != NULL)
1180 return cipher->gettable_params();
1184 const OSSL_PARAM *EVP_CIPHER_CTX_settable_params(const EVP_CIPHER *cipher)
1186 if (cipher != NULL && cipher->settable_ctx_params != NULL)
1187 return cipher->settable_ctx_params();
1191 const OSSL_PARAM *EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER *cipher)
1193 if (cipher != NULL && cipher->gettable_ctx_params != NULL)
1194 return cipher->gettable_ctx_params();
1198 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
1200 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
1201 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
1209 kl = EVP_CIPHER_CTX_key_length(ctx);
1210 if (kl <= 0 || RAND_priv_bytes(key, kl) <= 0)
1214 #endif /* FIPS_MODE */
1217 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
1219 if ((in == NULL) || (in->cipher == NULL)) {
1220 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
1224 if (in->cipher->prov == NULL)
1227 if (in->cipher->dupctx == NULL) {
1228 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1232 EVP_CIPHER_CTX_reset(out);
1235 out->provctx = NULL;
1237 if (in->fetched_cipher != NULL && !EVP_CIPHER_up_ref(in->fetched_cipher)) {
1238 out->fetched_cipher = NULL;
1242 out->provctx = in->cipher->dupctx(in->provctx);
1243 if (out->provctx == NULL) {
1244 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_NOT_ABLE_TO_COPY_CTX);
1250 /* TODO(3.0): Remove legacy code below */
1253 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1254 /* Make sure it's safe to copy a cipher context using an ENGINE */
1255 if (in->engine && !ENGINE_init(in->engine)) {
1256 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
1261 EVP_CIPHER_CTX_reset(out);
1262 memcpy(out, in, sizeof(*out));
1264 if (in->cipher_data && in->cipher->ctx_size) {
1265 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
1266 if (out->cipher_data == NULL) {
1268 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
1271 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
1274 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
1275 if (!in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out)) {
1277 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INITIALIZATION_ERROR);
1283 EVP_CIPHER *evp_cipher_new(void)
1285 EVP_CIPHER *cipher = OPENSSL_zalloc(sizeof(EVP_CIPHER));
1287 if (cipher != NULL) {
1288 cipher->lock = CRYPTO_THREAD_lock_new();
1289 if (cipher->lock == NULL) {
1290 OPENSSL_free(cipher);
1299 * FIPS module note: since internal fetches will be entirely
1300 * provider based, we know that none of its code depends on legacy
1301 * NIDs or any functionality that use them.
1304 /* TODO(3.x) get rid of the need for legacy NIDs */
1305 static void set_legacy_nid(const char *name, void *vlegacy_nid)
1308 int *legacy_nid = vlegacy_nid;
1310 if (*legacy_nid == -1) /* We found a clash already */
1312 if ((nid = OBJ_sn2nid(name)) == NID_undef
1313 && (nid = OBJ_ln2nid(name)) == NID_undef)
1315 if (*legacy_nid != NID_undef && *legacy_nid != nid) {
1323 static void *evp_cipher_from_dispatch(const int name_id,
1324 const OSSL_DISPATCH *fns,
1325 OSSL_PROVIDER *prov,
1328 EVP_CIPHER *cipher = NULL;
1329 int fnciphcnt = 0, fnctxcnt = 0;
1331 if ((cipher = evp_cipher_new()) == NULL) {
1332 EVPerr(0, ERR_R_MALLOC_FAILURE);
1337 /* TODO(3.x) get rid of the need for legacy NIDs */
1338 cipher->nid = NID_undef;
1339 evp_doall_names(prov, name_id, set_legacy_nid, &cipher->nid);
1340 if (cipher->nid == -1) {
1341 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1342 EVP_CIPHER_free(cipher);
1347 cipher->name_id = name_id;
1349 for (; fns->function_id != 0; fns++) {
1350 switch (fns->function_id) {
1351 case OSSL_FUNC_CIPHER_NEWCTX:
1352 if (cipher->newctx != NULL)
1354 cipher->newctx = OSSL_get_OP_cipher_newctx(fns);
1357 case OSSL_FUNC_CIPHER_ENCRYPT_INIT:
1358 if (cipher->einit != NULL)
1360 cipher->einit = OSSL_get_OP_cipher_encrypt_init(fns);
1363 case OSSL_FUNC_CIPHER_DECRYPT_INIT:
1364 if (cipher->dinit != NULL)
1366 cipher->dinit = OSSL_get_OP_cipher_decrypt_init(fns);
1369 case OSSL_FUNC_CIPHER_UPDATE:
1370 if (cipher->cupdate != NULL)
1372 cipher->cupdate = OSSL_get_OP_cipher_update(fns);
1375 case OSSL_FUNC_CIPHER_FINAL:
1376 if (cipher->cfinal != NULL)
1378 cipher->cfinal = OSSL_get_OP_cipher_final(fns);
1381 case OSSL_FUNC_CIPHER_CIPHER:
1382 if (cipher->ccipher != NULL)
1384 cipher->ccipher = OSSL_get_OP_cipher_cipher(fns);
1386 case OSSL_FUNC_CIPHER_FREECTX:
1387 if (cipher->freectx != NULL)
1389 cipher->freectx = OSSL_get_OP_cipher_freectx(fns);
1392 case OSSL_FUNC_CIPHER_DUPCTX:
1393 if (cipher->dupctx != NULL)
1395 cipher->dupctx = OSSL_get_OP_cipher_dupctx(fns);
1397 case OSSL_FUNC_CIPHER_GET_PARAMS:
1398 if (cipher->get_params != NULL)
1400 cipher->get_params = OSSL_get_OP_cipher_get_params(fns);
1402 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS:
1403 if (cipher->get_ctx_params != NULL)
1405 cipher->get_ctx_params = OSSL_get_OP_cipher_get_ctx_params(fns);
1407 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS:
1408 if (cipher->set_ctx_params != NULL)
1410 cipher->set_ctx_params = OSSL_get_OP_cipher_set_ctx_params(fns);
1412 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS:
1413 if (cipher->gettable_params != NULL)
1415 cipher->gettable_params = OSSL_get_OP_cipher_gettable_params(fns);
1417 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS:
1418 if (cipher->gettable_ctx_params != NULL)
1420 cipher->gettable_ctx_params =
1421 OSSL_get_OP_cipher_gettable_ctx_params(fns);
1423 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS:
1424 if (cipher->settable_ctx_params != NULL)
1426 cipher->settable_ctx_params =
1427 OSSL_get_OP_cipher_settable_ctx_params(fns);
1431 if ((fnciphcnt != 0 && fnciphcnt != 3 && fnciphcnt != 4)
1432 || (fnciphcnt == 0 && cipher->ccipher == NULL)
1435 * In order to be a consistent set of functions we must have at least
1436 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1437 * functions, or a single "cipher" function. In all cases we need both
1438 * the "newctx" and "freectx" functions.
1440 EVP_CIPHER_free(cipher);
1441 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH, EVP_R_INVALID_PROVIDER_FUNCTIONS);
1444 cipher->prov = prov;
1446 ossl_provider_up_ref(prov);
1451 static int evp_cipher_up_ref(void *cipher)
1453 return EVP_CIPHER_up_ref(cipher);
1456 static void evp_cipher_free(void *cipher)
1458 EVP_CIPHER_free(cipher);
1461 EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
1462 const char *properties)
1464 EVP_CIPHER *cipher =
1465 evp_generic_fetch(ctx, OSSL_OP_CIPHER, algorithm, properties,
1466 evp_cipher_from_dispatch, NULL, evp_cipher_up_ref,
1472 int EVP_CIPHER_up_ref(EVP_CIPHER *cipher)
1476 CRYPTO_UP_REF(&cipher->refcnt, &ref, cipher->lock);
1480 void EVP_CIPHER_free(EVP_CIPHER *cipher)
1487 CRYPTO_DOWN_REF(&cipher->refcnt, &i, cipher->lock);
1490 ossl_provider_free(cipher->prov);
1491 CRYPTO_THREAD_lock_free(cipher->lock);
1492 OPENSSL_free(cipher);
1495 void EVP_CIPHER_do_all_ex(OPENSSL_CTX *libctx,
1496 void (*fn)(EVP_CIPHER *mac, void *arg),
1499 evp_generic_do_all(libctx, OSSL_OP_CIPHER,
1500 (void (*)(void *, void *))fn, arg,
1501 evp_cipher_from_dispatch, NULL, evp_cipher_free);