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 "internal/evp_int.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
:
277 * Ensure a context left lying around from last time is cleared
280 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
281 OPENSSL_clear_free(ctx
->cipher_data
, ctx
->cipher
->ctx_size
);
282 ctx
->cipher_data
= NULL
;
286 /* TODO(3.0): Start of non-legacy code below */
288 /* Ensure a context left lying around from last time is cleared */
289 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
290 unsigned long flags
= ctx
->flags
;
292 EVP_CIPHER_CTX_reset(ctx
);
293 /* Restore encrypt and flags */
299 cipher
= ctx
->cipher
;
301 if (cipher
->prov
== NULL
) {
303 /* We only do explict fetches inside the FIPS module */
304 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
307 EVP_CIPHER
*provciph
=
308 EVP_CIPHER_fetch(NULL
, OBJ_nid2sn(cipher
->nid
), "");
310 if (provciph
== NULL
) {
311 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
315 EVP_CIPHER_free(ctx
->fetched_cipher
);
316 ctx
->fetched_cipher
= provciph
;
320 ctx
->cipher
= cipher
;
321 if (ctx
->provctx
== NULL
) {
322 ctx
->provctx
= ctx
->cipher
->newctx(ossl_provider_ctx(cipher
->prov
));
323 if (ctx
->provctx
== NULL
) {
324 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
329 if ((ctx
->flags
& EVP_CIPH_NO_PADDING
) != 0) {
331 * If this ctx was already set up for no padding then we need to tell
332 * the new cipher about it.
334 if (!EVP_CIPHER_CTX_set_padding(ctx
, 0))
338 switch (EVP_CIPHER_mode(ctx
->cipher
)) {
339 case EVP_CIPH_CFB_MODE
:
340 case EVP_CIPH_OFB_MODE
:
341 case EVP_CIPH_CBC_MODE
:
342 /* For these modes we remember the original IV for later use */
343 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx
) <= (int)sizeof(ctx
->oiv
))) {
344 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
348 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
352 if (ctx
->cipher
->einit
== NULL
) {
353 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
357 return ctx
->cipher
->einit(ctx
->provctx
,
360 : EVP_CIPHER_CTX_key_length(ctx
),
363 : EVP_CIPHER_CTX_iv_length(ctx
));
366 if (ctx
->cipher
->dinit
== NULL
) {
367 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
371 return ctx
->cipher
->dinit(ctx
->provctx
,
374 : EVP_CIPHER_CTX_key_length(ctx
),
377 : EVP_CIPHER_CTX_iv_length(ctx
));
379 /* TODO(3.0): Remove legacy code below */
382 if (cipher
!= NULL
) {
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).
389 unsigned long flags
= ctx
->flags
;
390 EVP_CIPHER_CTX_reset(ctx
);
391 /* Restore encrypt and flags */
395 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
397 if (!ENGINE_init(impl
)) {
398 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
405 /* There's an ENGINE for this job ... (apparently) */
406 const EVP_CIPHER
*c
= ENGINE_get_cipher(impl
, cipher
->nid
);
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"?
414 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
417 /* We'll use the ENGINE's private cipher definition */
420 * Store the ENGINE functional reference so we know 'cipher' came
421 * from an ENGINE and we need to release it when done.
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
) {
434 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, ERR_R_MALLOC_FAILURE
);
438 ctx
->cipher_data
= NULL
;
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
)) {
446 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
451 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
454 if (ctx
->cipher
== NULL
)
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);
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
);
468 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx
)) & EVP_CIPH_CUSTOM_IV
)) {
469 switch (EVP_CIPHER_CTX_mode(ctx
)) {
471 case EVP_CIPH_STREAM_CIPHER
:
472 case EVP_CIPH_ECB_MODE
:
475 case EVP_CIPH_CFB_MODE
:
476 case EVP_CIPH_OFB_MODE
:
481 case EVP_CIPH_CBC_MODE
:
483 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx
) <=
484 (int)sizeof(ctx
->iv
));
486 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
487 memcpy(ctx
->iv
, ctx
->oiv
, EVP_CIPHER_CTX_iv_length(ctx
));
490 case EVP_CIPH_CTR_MODE
:
492 /* Don't reuse IV for CTR mode */
494 memcpy(ctx
->iv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
502 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
503 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
508 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
512 int EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
513 const unsigned char *in
, int inl
)
516 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
518 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
521 int EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
524 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
526 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
529 int EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
532 return EVP_EncryptFinal(ctx
, out
, outl
);
534 return EVP_DecryptFinal(ctx
, out
, outl
);
537 int EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
538 const unsigned char *key
, const unsigned char *iv
)
540 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
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
)
547 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
550 int EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
551 const unsigned char *key
, const unsigned char *iv
)
553 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
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
)
560 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
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.
572 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
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.
581 # define PTRDIFF_T uint64_t
583 # define PTRDIFF_T size_t
586 int is_partially_overlapping(const void *ptr1
, const void *ptr2
, int len
)
588 PTRDIFF_T diff
= (PTRDIFF_T
)ptr1
-(PTRDIFF_T
)ptr2
;
590 * Check for partially overlapping buffers. [Binary logical
591 * operations are used instead of boolean to minimize number
592 * of conditional branches.]
594 int overlapped
= (len
> 0) & (diff
!= 0) & ((diff
< (PTRDIFF_T
)len
) |
595 (diff
> (0 - (PTRDIFF_T
)len
)));
600 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX
*ctx
,
601 unsigned char *out
, int *outl
,
602 const unsigned char *in
, int inl
)
604 int i
, j
, bl
, cmpl
= inl
;
606 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
607 cmpl
= (cmpl
+ 7) / 8;
609 bl
= ctx
->cipher
->block_size
;
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
);
618 i
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
630 if (is_partially_overlapping(out
+ ctx
->buf_len
, in
, cmpl
)) {
631 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
635 if (ctx
->buf_len
== 0 && (inl
& (ctx
->block_mask
)) == 0) {
636 if (ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
)) {
645 OPENSSL_assert(bl
<= (int)sizeof(ctx
->buf
));
648 memcpy(&(ctx
->buf
[i
]), in
, inl
);
654 memcpy(&(ctx
->buf
[i
]), in
, j
);
657 if (!ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, bl
))
667 if (!ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
))
673 memcpy(ctx
->buf
, &(in
[inl
]), i
);
679 int EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
680 const unsigned char *in
, int inl
)
686 /* Prevent accidental use of decryption context when encrypting */
688 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
692 if (ctx
->cipher
== NULL
) {
693 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
697 if (ctx
->cipher
->prov
== NULL
)
700 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
702 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
703 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
706 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
707 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
711 if (soutl
> INT_MAX
) {
712 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
720 /* TODO(3.0): Remove legacy code below */
723 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
726 int EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
729 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
733 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
736 unsigned int i
, b
, bl
;
740 /* Prevent accidental use of decryption context when encrypting */
742 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
746 if (ctx
->cipher
== NULL
) {
747 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
750 if (ctx
->cipher
->prov
== NULL
)
753 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
755 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
756 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
760 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
761 blocksize
== 1 ? 0 : blocksize
);
764 if (soutl
> INT_MAX
) {
765 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
773 /* TODO(3.0): Remove legacy code below */
776 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
777 ret
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
785 b
= ctx
->cipher
->block_size
;
786 OPENSSL_assert(b
<= sizeof(ctx
->buf
));
792 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
794 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
795 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
803 for (i
= bl
; i
< b
; i
++)
805 ret
= ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, b
);
813 int EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
814 const unsigned char *in
, int inl
)
816 int fix_len
, cmpl
= inl
, ret
;
821 /* Prevent accidental use of encryption context when decrypting */
823 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
827 if (ctx
->cipher
== NULL
) {
828 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
831 if (ctx
->cipher
->prov
== NULL
)
834 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
836 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
837 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
840 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
841 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
845 if (soutl
> INT_MAX
) {
846 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
854 /* TODO(3.0): Remove legacy code below */
857 b
= ctx
->cipher
->block_size
;
859 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
860 cmpl
= (cmpl
+ 7) / 8;
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
);
868 fix_len
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
882 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
883 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
885 OPENSSL_assert(b
<= sizeof(ctx
->final
));
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
);
894 memcpy(out
, ctx
->final
, b
);
900 if (!evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
))
904 * if we have 'decrypted' a multiple of block size, make sure we have a
905 * copy of this last block
907 if (b
> 1 && !ctx
->buf_len
) {
910 memcpy(ctx
->final
, &out
[*outl
], b
);
920 int EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
923 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
927 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
935 /* Prevent accidental use of encryption context when decrypting */
937 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
941 if (ctx
->cipher
== NULL
) {
942 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
946 if (ctx
->cipher
->prov
== NULL
)
949 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
951 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
952 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
956 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
957 blocksize
== 1 ? 0 : blocksize
);
960 if (soutl
> INT_MAX
) {
961 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
969 /* TODO(3.0): Remove legacy code below */
973 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
974 i
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
982 b
= ctx
->cipher
->block_size
;
983 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
985 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
986 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
993 if (ctx
->buf_len
|| !ctx
->final_used
) {
994 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
997 OPENSSL_assert(b
<= sizeof(ctx
->final
));
1000 * The following assumes that the ciphertext has been authenticated.
1001 * Otherwise it provides a padding oracle.
1003 n
= ctx
->final
[b
- 1];
1004 if (n
== 0 || n
> (int)b
) {
1005 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
1008 for (i
= 0; i
< n
; i
++) {
1009 if (ctx
->final
[--b
] != n
) {
1010 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
1014 n
= ctx
->cipher
->block_size
- n
;
1015 for (i
= 0; i
< n
; i
++)
1016 out
[i
] = ctx
->final
[i
];
1023 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
1026 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1027 size_t len
= keylen
;
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
);
1032 if (ok
!= EVP_CTRL_RET_UNSUPPORTED
)
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
)
1040 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
1041 c
->key_len
= keylen
;
1044 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
1048 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
1051 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1052 unsigned int pd
= pad
;
1055 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
1057 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
1059 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING
, &pd
);
1060 ok
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1065 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
1067 int ret
= EVP_CTRL_RET_UNSUPPORTED
;
1070 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1072 if (ctx
== NULL
|| ctx
->cipher
== NULL
) {
1073 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
1077 if (ctx
->cipher
->prov
== NULL
)
1081 case EVP_CTRL_SET_KEY_LENGTH
:
1082 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &sz
);
1084 case EVP_CTRL_RAND_KEY
: /* Used by DES */
1087 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY
,
1091 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS
: /* Used by DASYNC */
1092 case EVP_CTRL_INIT
: /* TODO(3.0) Purely legacy, no provider counterpart */
1094 return EVP_CTRL_RET_UNSUPPORTED
;
1095 case EVP_CTRL_GET_IV
:
1097 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV
,
1100 case EVP_CTRL_AEAD_SET_IVLEN
:
1103 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN
, &sz
);
1105 case EVP_CTRL_GCM_SET_IV_FIXED
:
1107 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED
,
1110 case EVP_CTRL_AEAD_GET_TAG
:
1111 set_params
= 0; /* Fall thru */
1112 case EVP_CTRL_AEAD_SET_TAG
:
1113 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
,
1116 case EVP_CTRL_AEAD_TLS1_AAD
:
1117 /* This one does a set and a get - since it returns a padding size */
1119 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD
,
1121 ret
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1125 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD
, &sz
);
1126 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->provctx
, params
);
1133 ret
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1135 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->provctx
, params
);
1138 /* TODO(3.0): Remove legacy code below */
1140 if (ctx
->cipher
->ctrl
== NULL
) {
1141 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
1145 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
1146 if (ret
== EVP_CTRL_RET_UNSUPPORTED
) {
1147 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
1148 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
1154 int EVP_CIPHER_get_params(EVP_CIPHER
*cipher
, OSSL_PARAM params
[])
1156 if (cipher
!= NULL
&& cipher
->get_params
!= NULL
)
1157 return cipher
->get_params(params
);
1161 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX
*ctx
, const OSSL_PARAM params
[])
1163 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->set_ctx_params
!= NULL
)
1164 return ctx
->cipher
->set_ctx_params(ctx
->provctx
, params
);
1168 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX
*ctx
, OSSL_PARAM params
[])
1170 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->get_ctx_params
!= NULL
)
1171 return ctx
->cipher
->get_ctx_params(ctx
->provctx
, params
);
1175 const OSSL_PARAM
*EVP_CIPHER_gettable_params(const EVP_CIPHER
*cipher
)
1177 if (cipher
!= NULL
&& cipher
->gettable_params
!= NULL
)
1178 return cipher
->gettable_params();
1182 const OSSL_PARAM
*EVP_CIPHER_CTX_settable_params(const EVP_CIPHER
*cipher
)
1184 if (cipher
!= NULL
&& cipher
->settable_ctx_params
!= NULL
)
1185 return cipher
->settable_ctx_params();
1189 const OSSL_PARAM
*EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER
*cipher
)
1191 if (cipher
!= NULL
&& cipher
->gettable_ctx_params
!= NULL
)
1192 return cipher
->gettable_ctx_params();
1196 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
1198 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
1199 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
1207 kl
= EVP_CIPHER_CTX_key_length(ctx
);
1208 if (kl
<= 0 || RAND_priv_bytes(key
, kl
) <= 0)
1212 #endif /* FIPS_MODE */
1215 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
1217 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
1218 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
1222 if (in
->cipher
->prov
== NULL
)
1225 if (in
->cipher
->dupctx
== NULL
) {
1226 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1230 EVP_CIPHER_CTX_reset(out
);
1233 out
->provctx
= NULL
;
1235 if (in
->fetched_cipher
!= NULL
&& !EVP_CIPHER_up_ref(in
->fetched_cipher
)) {
1236 out
->fetched_cipher
= NULL
;
1240 out
->provctx
= in
->cipher
->dupctx(in
->provctx
);
1241 if (out
->provctx
== NULL
) {
1242 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1248 /* TODO(3.0): Remove legacy code below */
1251 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1252 /* Make sure it's safe to copy a cipher context using an ENGINE */
1253 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
1254 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
1259 EVP_CIPHER_CTX_reset(out
);
1260 memcpy(out
, in
, sizeof(*out
));
1262 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
1263 out
->cipher_data
= OPENSSL_malloc(in
->cipher
->ctx_size
);
1264 if (out
->cipher_data
== NULL
) {
1266 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
1269 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
1272 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
1273 if (!in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
, EVP_CTRL_COPY
, 0, out
)) {
1275 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INITIALIZATION_ERROR
);
1281 EVP_CIPHER
*evp_cipher_new(void)
1283 EVP_CIPHER
*cipher
= OPENSSL_zalloc(sizeof(EVP_CIPHER
));
1285 if (cipher
!= NULL
) {
1286 cipher
->lock
= CRYPTO_THREAD_lock_new();
1287 if (cipher
->lock
== NULL
) {
1288 OPENSSL_free(cipher
);
1296 static void *evp_cipher_from_dispatch(const int name_id
,
1297 const OSSL_DISPATCH
*fns
,
1298 OSSL_PROVIDER
*prov
,
1301 EVP_CIPHER
*cipher
= NULL
;
1302 int fnciphcnt
= 0, fnctxcnt
= 0;
1304 if ((cipher
= evp_cipher_new()) == NULL
) {
1305 EVPerr(0, ERR_R_MALLOC_FAILURE
);
1308 cipher
->name_id
= name_id
;
1313 * FIPS module note: since internal fetches will be entirely
1314 * provider based, we know that none of its code depends on legacy
1315 * NIDs or any functionality that use them.
1317 * TODO(3.x) get rid of the need for legacy NIDs
1319 cipher
->nid
= OBJ_sn2nid(evp_first_name(prov
, name_id
));
1323 for (; fns
->function_id
!= 0; fns
++) {
1324 switch (fns
->function_id
) {
1325 case OSSL_FUNC_CIPHER_NEWCTX
:
1326 if (cipher
->newctx
!= NULL
)
1328 cipher
->newctx
= OSSL_get_OP_cipher_newctx(fns
);
1331 case OSSL_FUNC_CIPHER_ENCRYPT_INIT
:
1332 if (cipher
->einit
!= NULL
)
1334 cipher
->einit
= OSSL_get_OP_cipher_encrypt_init(fns
);
1337 case OSSL_FUNC_CIPHER_DECRYPT_INIT
:
1338 if (cipher
->dinit
!= NULL
)
1340 cipher
->dinit
= OSSL_get_OP_cipher_decrypt_init(fns
);
1343 case OSSL_FUNC_CIPHER_UPDATE
:
1344 if (cipher
->cupdate
!= NULL
)
1346 cipher
->cupdate
= OSSL_get_OP_cipher_update(fns
);
1349 case OSSL_FUNC_CIPHER_FINAL
:
1350 if (cipher
->cfinal
!= NULL
)
1352 cipher
->cfinal
= OSSL_get_OP_cipher_final(fns
);
1355 case OSSL_FUNC_CIPHER_CIPHER
:
1356 if (cipher
->ccipher
!= NULL
)
1358 cipher
->ccipher
= OSSL_get_OP_cipher_cipher(fns
);
1360 case OSSL_FUNC_CIPHER_FREECTX
:
1361 if (cipher
->freectx
!= NULL
)
1363 cipher
->freectx
= OSSL_get_OP_cipher_freectx(fns
);
1366 case OSSL_FUNC_CIPHER_DUPCTX
:
1367 if (cipher
->dupctx
!= NULL
)
1369 cipher
->dupctx
= OSSL_get_OP_cipher_dupctx(fns
);
1371 case OSSL_FUNC_CIPHER_GET_PARAMS
:
1372 if (cipher
->get_params
!= NULL
)
1374 cipher
->get_params
= OSSL_get_OP_cipher_get_params(fns
);
1376 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS
:
1377 if (cipher
->get_ctx_params
!= NULL
)
1379 cipher
->get_ctx_params
= OSSL_get_OP_cipher_get_ctx_params(fns
);
1381 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS
:
1382 if (cipher
->set_ctx_params
!= NULL
)
1384 cipher
->set_ctx_params
= OSSL_get_OP_cipher_set_ctx_params(fns
);
1386 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS
:
1387 if (cipher
->gettable_params
!= NULL
)
1389 cipher
->gettable_params
= OSSL_get_OP_cipher_gettable_params(fns
);
1391 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS
:
1392 if (cipher
->gettable_ctx_params
!= NULL
)
1394 cipher
->gettable_ctx_params
=
1395 OSSL_get_OP_cipher_gettable_ctx_params(fns
);
1397 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS
:
1398 if (cipher
->settable_ctx_params
!= NULL
)
1400 cipher
->settable_ctx_params
=
1401 OSSL_get_OP_cipher_settable_ctx_params(fns
);
1405 if ((fnciphcnt
!= 0 && fnciphcnt
!= 3 && fnciphcnt
!= 4)
1406 || (fnciphcnt
== 0 && cipher
->ccipher
== NULL
)
1409 * In order to be a consistent set of functions we must have at least
1410 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1411 * functions, or a single "cipher" function. In all cases we need both
1412 * the "newctx" and "freectx" functions.
1414 EVP_CIPHER_free(cipher
);
1415 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH
, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
1418 cipher
->prov
= prov
;
1420 ossl_provider_up_ref(prov
);
1425 static int evp_cipher_up_ref(void *cipher
)
1427 return EVP_CIPHER_up_ref(cipher
);
1430 static void evp_cipher_free(void *cipher
)
1432 EVP_CIPHER_free(cipher
);
1435 EVP_CIPHER
*EVP_CIPHER_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
1436 const char *properties
)
1438 EVP_CIPHER
*cipher
=
1439 evp_generic_fetch(ctx
, OSSL_OP_CIPHER
, algorithm
, properties
,
1440 evp_cipher_from_dispatch
, NULL
, evp_cipher_up_ref
,
1446 int EVP_CIPHER_up_ref(EVP_CIPHER
*cipher
)
1450 CRYPTO_UP_REF(&cipher
->refcnt
, &ref
, cipher
->lock
);
1454 void EVP_CIPHER_free(EVP_CIPHER
*cipher
)
1461 CRYPTO_DOWN_REF(&cipher
->refcnt
, &i
, cipher
->lock
);
1464 ossl_provider_free(cipher
->prov
);
1465 CRYPTO_THREAD_lock_free(cipher
->lock
);
1466 OPENSSL_free(cipher
);
1469 void EVP_CIPHER_do_all_ex(OPENSSL_CTX
*libctx
,
1470 void (*fn
)(EVP_CIPHER
*mac
, void *arg
),
1473 evp_generic_do_all(libctx
, OSSL_OP_CIPHER
,
1474 (void (*)(void *, void *))fn
, arg
,
1475 evp_cipher_from_dispatch
, NULL
, evp_cipher_free
);