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
:
242 case NID_id_smime_alg_CMS3DESwrap
:
253 case NID_cast5_cfb64
:
254 case NID_cast5_ofb64
:
257 case NID_seed_cfb128
:
258 case NID_seed_ofb128
:
271 * Ensure a context left lying around from last time is cleared
274 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
275 OPENSSL_clear_free(ctx
->cipher_data
, ctx
->cipher
->ctx_size
);
276 ctx
->cipher_data
= NULL
;
280 /* TODO(3.0): Start of non-legacy code below */
282 /* Ensure a context left lying around from last time is cleared */
283 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
284 unsigned long flags
= ctx
->flags
;
286 EVP_CIPHER_CTX_reset(ctx
);
287 /* Restore encrypt and flags */
293 cipher
= ctx
->cipher
;
295 if (cipher
->prov
== NULL
) {
297 /* We only do explict fetches inside the FIPS module */
298 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
301 EVP_CIPHER
*provciph
=
302 EVP_CIPHER_fetch(NULL
, OBJ_nid2sn(cipher
->nid
), "");
304 if (provciph
== NULL
) {
305 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
309 EVP_CIPHER_free(ctx
->fetched_cipher
);
310 ctx
->fetched_cipher
= provciph
;
314 ctx
->cipher
= cipher
;
315 if (ctx
->provctx
== NULL
) {
316 ctx
->provctx
= ctx
->cipher
->newctx(ossl_provider_ctx(cipher
->prov
));
317 if (ctx
->provctx
== NULL
) {
318 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
323 if ((ctx
->flags
& EVP_CIPH_NO_PADDING
) != 0) {
325 * If this ctx was already set up for no padding then we need to tell
326 * the new cipher about it.
328 if (!EVP_CIPHER_CTX_set_padding(ctx
, 0))
332 switch (EVP_CIPHER_mode(ctx
->cipher
)) {
333 case EVP_CIPH_CFB_MODE
:
334 case EVP_CIPH_OFB_MODE
:
335 case EVP_CIPH_CBC_MODE
:
336 /* For these modes we remember the original IV for later use */
337 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx
) <= (int)sizeof(ctx
->oiv
))) {
338 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
342 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
346 if (ctx
->cipher
->einit
== NULL
) {
347 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
351 return ctx
->cipher
->einit(ctx
->provctx
,
354 : EVP_CIPHER_CTX_key_length(ctx
),
357 : EVP_CIPHER_CTX_iv_length(ctx
));
360 if (ctx
->cipher
->dinit
== NULL
) {
361 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
365 return ctx
->cipher
->dinit(ctx
->provctx
,
368 : EVP_CIPHER_CTX_key_length(ctx
),
371 : EVP_CIPHER_CTX_iv_length(ctx
));
373 /* TODO(3.0): Remove legacy code below */
376 if (cipher
!= NULL
) {
378 * Ensure a context left lying around from last time is cleared (we
379 * previously attempted to avoid this if the same ENGINE and
380 * EVP_CIPHER could be used).
383 unsigned long flags
= ctx
->flags
;
384 EVP_CIPHER_CTX_reset(ctx
);
385 /* Restore encrypt and flags */
389 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
391 if (!ENGINE_init(impl
)) {
392 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
399 /* There's an ENGINE for this job ... (apparently) */
400 const EVP_CIPHER
*c
= ENGINE_get_cipher(impl
, cipher
->nid
);
404 * One positive side-effect of US's export control history,
405 * is that we should at least be able to avoid using US
406 * misspellings of "initialisation"?
408 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
411 /* We'll use the ENGINE's private cipher definition */
414 * Store the ENGINE functional reference so we know 'cipher' came
415 * from an ENGINE and we need to release it when done.
423 ctx
->cipher
= cipher
;
424 if (ctx
->cipher
->ctx_size
) {
425 ctx
->cipher_data
= OPENSSL_zalloc(ctx
->cipher
->ctx_size
);
426 if (ctx
->cipher_data
== NULL
) {
428 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, ERR_R_MALLOC_FAILURE
);
432 ctx
->cipher_data
= NULL
;
434 ctx
->key_len
= cipher
->key_len
;
435 /* Preserve wrap enable flag, zero everything else */
436 ctx
->flags
&= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
;
437 if (ctx
->cipher
->flags
& EVP_CIPH_CTRL_INIT
) {
438 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_INIT
, 0, NULL
)) {
440 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
445 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
448 if (ctx
->cipher
== NULL
)
451 /* we assume block size is a power of 2 in *cryptUpdate */
452 OPENSSL_assert(ctx
->cipher
->block_size
== 1
453 || ctx
->cipher
->block_size
== 8
454 || ctx
->cipher
->block_size
== 16);
456 if (!(ctx
->flags
& EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
)
457 && EVP_CIPHER_CTX_mode(ctx
) == EVP_CIPH_WRAP_MODE
) {
458 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_WRAP_MODE_NOT_ALLOWED
);
462 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx
)) & EVP_CIPH_CUSTOM_IV
)) {
463 switch (EVP_CIPHER_CTX_mode(ctx
)) {
465 case EVP_CIPH_STREAM_CIPHER
:
466 case EVP_CIPH_ECB_MODE
:
469 case EVP_CIPH_CFB_MODE
:
470 case EVP_CIPH_OFB_MODE
:
475 case EVP_CIPH_CBC_MODE
:
477 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx
) <=
478 (int)sizeof(ctx
->iv
));
480 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
481 memcpy(ctx
->iv
, ctx
->oiv
, EVP_CIPHER_CTX_iv_length(ctx
));
484 case EVP_CIPH_CTR_MODE
:
486 /* Don't reuse IV for CTR mode */
488 memcpy(ctx
->iv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
496 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
497 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
502 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
506 int EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
507 const unsigned char *in
, int inl
)
510 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
512 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
515 int EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
518 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
520 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
523 int EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
526 return EVP_EncryptFinal(ctx
, out
, outl
);
528 return EVP_DecryptFinal(ctx
, out
, outl
);
531 int EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
532 const unsigned char *key
, const unsigned char *iv
)
534 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
537 int EVP_EncryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
538 ENGINE
*impl
, const unsigned char *key
,
539 const unsigned char *iv
)
541 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
544 int EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
545 const unsigned char *key
, const unsigned char *iv
)
547 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
550 int EVP_DecryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
551 ENGINE
*impl
, const unsigned char *key
,
552 const unsigned char *iv
)
554 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
558 * According to the letter of standard difference between pointers
559 * is specified to be valid only within same object. This makes
560 * it formally challenging to determine if input and output buffers
561 * are not partially overlapping with standard pointer arithmetic.
566 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
568 * Then we have VMS that distinguishes itself by adhering to
569 * sizeof(size_t)==4 even in 64-bit builds, which means that
570 * difference between two pointers might be truncated to 32 bits.
571 * In the context one can even wonder how comparison for
572 * equality is implemented. To be on the safe side we adhere to
573 * PTRDIFF_T even for comparison for equality.
575 # define PTRDIFF_T uint64_t
577 # define PTRDIFF_T size_t
580 int is_partially_overlapping(const void *ptr1
, const void *ptr2
, int len
)
582 PTRDIFF_T diff
= (PTRDIFF_T
)ptr1
-(PTRDIFF_T
)ptr2
;
584 * Check for partially overlapping buffers. [Binary logical
585 * operations are used instead of boolean to minimize number
586 * of conditional branches.]
588 int overlapped
= (len
> 0) & (diff
!= 0) & ((diff
< (PTRDIFF_T
)len
) |
589 (diff
> (0 - (PTRDIFF_T
)len
)));
594 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX
*ctx
,
595 unsigned char *out
, int *outl
,
596 const unsigned char *in
, int inl
)
598 int i
, j
, bl
, cmpl
= inl
;
600 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
601 cmpl
= (cmpl
+ 7) / 8;
603 bl
= ctx
->cipher
->block_size
;
605 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
606 /* If block size > 1 then the cipher will have to do this check */
607 if (bl
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
608 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
612 i
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
624 if (is_partially_overlapping(out
+ ctx
->buf_len
, in
, cmpl
)) {
625 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
629 if (ctx
->buf_len
== 0 && (inl
& (ctx
->block_mask
)) == 0) {
630 if (ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
)) {
639 OPENSSL_assert(bl
<= (int)sizeof(ctx
->buf
));
642 memcpy(&(ctx
->buf
[i
]), in
, inl
);
648 memcpy(&(ctx
->buf
[i
]), in
, j
);
651 if (!ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, bl
))
661 if (!ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
))
667 memcpy(ctx
->buf
, &(in
[inl
]), i
);
673 int EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
674 const unsigned char *in
, int inl
)
680 /* Prevent accidental use of decryption context when encrypting */
682 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
686 if (ctx
->cipher
== NULL
) {
687 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
691 if (ctx
->cipher
->prov
== NULL
)
694 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
696 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
697 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
700 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
701 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
705 if (soutl
> INT_MAX
) {
706 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
714 /* TODO(3.0): Remove legacy code below */
717 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
720 int EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
723 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
727 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
730 unsigned int i
, b
, bl
;
734 /* Prevent accidental use of decryption context when encrypting */
736 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
740 if (ctx
->cipher
== NULL
) {
741 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
744 if (ctx
->cipher
->prov
== NULL
)
747 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
749 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
750 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
754 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
755 blocksize
== 1 ? 0 : blocksize
);
758 if (soutl
> INT_MAX
) {
759 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
767 /* TODO(3.0): Remove legacy code below */
770 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
771 ret
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
779 b
= ctx
->cipher
->block_size
;
780 OPENSSL_assert(b
<= sizeof(ctx
->buf
));
786 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
788 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
789 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
797 for (i
= bl
; i
< b
; i
++)
799 ret
= ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, b
);
807 int EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
808 const unsigned char *in
, int inl
)
810 int fix_len
, cmpl
= inl
, ret
;
815 /* Prevent accidental use of encryption context when decrypting */
817 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
821 if (ctx
->cipher
== NULL
) {
822 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
825 if (ctx
->cipher
->prov
== NULL
)
828 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
830 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
831 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
834 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
835 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
839 if (soutl
> INT_MAX
) {
840 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
848 /* TODO(3.0): Remove legacy code below */
851 b
= ctx
->cipher
->block_size
;
853 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
854 cmpl
= (cmpl
+ 7) / 8;
856 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
857 if (b
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
858 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
862 fix_len
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
876 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
877 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
879 OPENSSL_assert(b
<= sizeof(ctx
->final
));
881 if (ctx
->final_used
) {
882 /* see comment about PTRDIFF_T comparison above */
883 if (((PTRDIFF_T
)out
== (PTRDIFF_T
)in
)
884 || is_partially_overlapping(out
, in
, b
)) {
885 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
888 memcpy(out
, ctx
->final
, b
);
894 if (!evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
))
898 * if we have 'decrypted' a multiple of block size, make sure we have a
899 * copy of this last block
901 if (b
> 1 && !ctx
->buf_len
) {
904 memcpy(ctx
->final
, &out
[*outl
], b
);
914 int EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
917 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
921 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
929 /* Prevent accidental use of encryption context when decrypting */
931 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
935 if (ctx
->cipher
== NULL
) {
936 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
940 if (ctx
->cipher
->prov
== NULL
)
943 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
945 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
946 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
950 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
951 blocksize
== 1 ? 0 : blocksize
);
954 if (soutl
> INT_MAX
) {
955 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
963 /* TODO(3.0): Remove legacy code below */
967 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
968 i
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
976 b
= ctx
->cipher
->block_size
;
977 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
979 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
980 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
987 if (ctx
->buf_len
|| !ctx
->final_used
) {
988 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
991 OPENSSL_assert(b
<= sizeof(ctx
->final
));
994 * The following assumes that the ciphertext has been authenticated.
995 * Otherwise it provides a padding oracle.
997 n
= ctx
->final
[b
- 1];
998 if (n
== 0 || n
> (int)b
) {
999 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
1002 for (i
= 0; i
< n
; i
++) {
1003 if (ctx
->final
[--b
] != n
) {
1004 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
1008 n
= ctx
->cipher
->block_size
- n
;
1009 for (i
= 0; i
< n
; i
++)
1010 out
[i
] = ctx
->final
[i
];
1017 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
1020 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1021 size_t len
= keylen
;
1023 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &len
);
1024 ok
= evp_do_ciph_ctx_setparams(c
->cipher
, c
->provctx
, params
);
1026 if (ok
!= EVP_CTRL_RET_UNSUPPORTED
)
1029 /* TODO(3.0) legacy code follows */
1030 if (c
->cipher
->flags
& EVP_CIPH_CUSTOM_KEY_LENGTH
)
1031 return EVP_CIPHER_CTX_ctrl(c
, EVP_CTRL_SET_KEY_LENGTH
, keylen
, NULL
);
1032 if (EVP_CIPHER_CTX_key_length(c
) == keylen
)
1034 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
1035 c
->key_len
= keylen
;
1038 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
1042 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
1045 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1046 unsigned int pd
= pad
;
1049 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
1051 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
1053 params
[0] = OSSL_PARAM_construct_uint(OSSL_CIPHER_PARAM_PADDING
, &pd
);
1054 ok
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1059 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
1061 int ret
= EVP_CTRL_RET_UNSUPPORTED
;
1064 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1066 if (ctx
== NULL
|| ctx
->cipher
== NULL
) {
1067 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
1071 if (ctx
->cipher
->prov
== NULL
)
1075 case EVP_CTRL_SET_KEY_LENGTH
:
1076 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_KEYLEN
, &sz
);
1078 case EVP_CTRL_RAND_KEY
: /* Used by DES */
1081 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY
,
1085 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS
: /* Used by DASYNC */
1086 case EVP_CTRL_INIT
: /* TODO(3.0) Purely legacy, no provider counterpart */
1088 return EVP_CTRL_RET_UNSUPPORTED
;
1089 case EVP_CTRL_GET_IV
:
1091 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV
,
1094 case EVP_CTRL_AEAD_SET_IVLEN
:
1097 params
[0] = OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_IVLEN
, &sz
);
1099 case EVP_CTRL_GCM_SET_IV_FIXED
:
1101 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED
,
1104 case EVP_CTRL_AEAD_GET_TAG
:
1105 set_params
= 0; /* Fall thru */
1106 case EVP_CTRL_AEAD_SET_TAG
:
1107 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
,
1110 case EVP_CTRL_AEAD_TLS1_AAD
:
1111 /* This one does a set and a get - since it returns a padding size */
1113 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD
,
1115 ret
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1119 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD
, &sz
);
1120 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->provctx
, params
);
1127 ret
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1129 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->provctx
, params
);
1132 /* TODO(3.0): Remove legacy code below */
1134 if (ctx
->cipher
->ctrl
== NULL
) {
1135 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
1139 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
1140 if (ret
== EVP_CTRL_RET_UNSUPPORTED
) {
1141 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
1142 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
1148 int EVP_CIPHER_get_params(EVP_CIPHER
*cipher
, OSSL_PARAM params
[])
1150 if (cipher
!= NULL
&& cipher
->get_params
!= NULL
)
1151 return cipher
->get_params(params
);
1155 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX
*ctx
, const OSSL_PARAM params
[])
1157 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->set_ctx_params
!= NULL
)
1158 return ctx
->cipher
->set_ctx_params(ctx
->provctx
, params
);
1162 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX
*ctx
, OSSL_PARAM params
[])
1164 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->get_ctx_params
!= NULL
)
1165 return ctx
->cipher
->get_ctx_params(ctx
->provctx
, params
);
1169 const OSSL_PARAM
*EVP_CIPHER_gettable_params(const EVP_CIPHER
*cipher
)
1171 if (cipher
!= NULL
&& cipher
->gettable_params
!= NULL
)
1172 return cipher
->gettable_params();
1176 const OSSL_PARAM
*EVP_CIPHER_CTX_settable_params(const EVP_CIPHER
*cipher
)
1178 if (cipher
!= NULL
&& cipher
->settable_ctx_params
!= NULL
)
1179 return cipher
->settable_ctx_params();
1183 const OSSL_PARAM
*EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER
*cipher
)
1185 if (cipher
!= NULL
&& cipher
->gettable_ctx_params
!= NULL
)
1186 return cipher
->gettable_ctx_params();
1190 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
1192 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
1193 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
1201 kl
= EVP_CIPHER_CTX_key_length(ctx
);
1202 if (kl
<= 0 || RAND_priv_bytes(key
, kl
) <= 0)
1206 #endif /* FIPS_MODE */
1209 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
1211 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
1212 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
1216 if (in
->cipher
->prov
== NULL
)
1219 if (in
->cipher
->dupctx
== NULL
) {
1220 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1224 EVP_CIPHER_CTX_reset(out
);
1227 out
->provctx
= NULL
;
1229 if (in
->fetched_cipher
!= NULL
&& !EVP_CIPHER_up_ref(in
->fetched_cipher
)) {
1230 out
->fetched_cipher
= NULL
;
1234 out
->provctx
= in
->cipher
->dupctx(in
->provctx
);
1235 if (out
->provctx
== NULL
) {
1236 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1242 /* TODO(3.0): Remove legacy code below */
1245 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1246 /* Make sure it's safe to copy a cipher context using an ENGINE */
1247 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
1248 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
1253 EVP_CIPHER_CTX_reset(out
);
1254 memcpy(out
, in
, sizeof(*out
));
1256 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
1257 out
->cipher_data
= OPENSSL_malloc(in
->cipher
->ctx_size
);
1258 if (out
->cipher_data
== NULL
) {
1260 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
1263 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
1266 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
1267 if (!in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
, EVP_CTRL_COPY
, 0, out
)) {
1269 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INITIALIZATION_ERROR
);
1275 EVP_CIPHER
*evp_cipher_new(void)
1277 EVP_CIPHER
*cipher
= OPENSSL_zalloc(sizeof(EVP_CIPHER
));
1279 if (cipher
!= NULL
) {
1280 cipher
->lock
= CRYPTO_THREAD_lock_new();
1281 if (cipher
->lock
== NULL
) {
1282 OPENSSL_free(cipher
);
1290 static void *evp_cipher_from_dispatch(const int name_id
,
1291 const OSSL_DISPATCH
*fns
,
1292 OSSL_PROVIDER
*prov
,
1295 EVP_CIPHER
*cipher
= NULL
;
1296 int fnciphcnt
= 0, fnctxcnt
= 0;
1298 if ((cipher
= evp_cipher_new()) == NULL
) {
1299 EVPerr(0, ERR_R_MALLOC_FAILURE
);
1302 cipher
->name_id
= name_id
;
1307 * FIPS module note: since internal fetches will be entirely
1308 * provider based, we know that none of its code depends on legacy
1309 * NIDs or any functionality that use them.
1311 * TODO(3.x) get rid of the need for legacy NIDs
1313 cipher
->nid
= OBJ_sn2nid(evp_first_name(prov
, name_id
));
1317 for (; fns
->function_id
!= 0; fns
++) {
1318 switch (fns
->function_id
) {
1319 case OSSL_FUNC_CIPHER_NEWCTX
:
1320 if (cipher
->newctx
!= NULL
)
1322 cipher
->newctx
= OSSL_get_OP_cipher_newctx(fns
);
1325 case OSSL_FUNC_CIPHER_ENCRYPT_INIT
:
1326 if (cipher
->einit
!= NULL
)
1328 cipher
->einit
= OSSL_get_OP_cipher_encrypt_init(fns
);
1331 case OSSL_FUNC_CIPHER_DECRYPT_INIT
:
1332 if (cipher
->dinit
!= NULL
)
1334 cipher
->dinit
= OSSL_get_OP_cipher_decrypt_init(fns
);
1337 case OSSL_FUNC_CIPHER_UPDATE
:
1338 if (cipher
->cupdate
!= NULL
)
1340 cipher
->cupdate
= OSSL_get_OP_cipher_update(fns
);
1343 case OSSL_FUNC_CIPHER_FINAL
:
1344 if (cipher
->cfinal
!= NULL
)
1346 cipher
->cfinal
= OSSL_get_OP_cipher_final(fns
);
1349 case OSSL_FUNC_CIPHER_CIPHER
:
1350 if (cipher
->ccipher
!= NULL
)
1352 cipher
->ccipher
= OSSL_get_OP_cipher_cipher(fns
);
1354 case OSSL_FUNC_CIPHER_FREECTX
:
1355 if (cipher
->freectx
!= NULL
)
1357 cipher
->freectx
= OSSL_get_OP_cipher_freectx(fns
);
1360 case OSSL_FUNC_CIPHER_DUPCTX
:
1361 if (cipher
->dupctx
!= NULL
)
1363 cipher
->dupctx
= OSSL_get_OP_cipher_dupctx(fns
);
1365 case OSSL_FUNC_CIPHER_GET_PARAMS
:
1366 if (cipher
->get_params
!= NULL
)
1368 cipher
->get_params
= OSSL_get_OP_cipher_get_params(fns
);
1370 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS
:
1371 if (cipher
->get_ctx_params
!= NULL
)
1373 cipher
->get_ctx_params
= OSSL_get_OP_cipher_get_ctx_params(fns
);
1375 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS
:
1376 if (cipher
->set_ctx_params
!= NULL
)
1378 cipher
->set_ctx_params
= OSSL_get_OP_cipher_set_ctx_params(fns
);
1380 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS
:
1381 if (cipher
->gettable_params
!= NULL
)
1383 cipher
->gettable_params
= OSSL_get_OP_cipher_gettable_params(fns
);
1385 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS
:
1386 if (cipher
->gettable_ctx_params
!= NULL
)
1388 cipher
->gettable_ctx_params
=
1389 OSSL_get_OP_cipher_gettable_ctx_params(fns
);
1391 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS
:
1392 if (cipher
->settable_ctx_params
!= NULL
)
1394 cipher
->settable_ctx_params
=
1395 OSSL_get_OP_cipher_settable_ctx_params(fns
);
1399 if ((fnciphcnt
!= 0 && fnciphcnt
!= 3 && fnciphcnt
!= 4)
1400 || (fnciphcnt
== 0 && cipher
->ccipher
== NULL
)
1403 * In order to be a consistent set of functions we must have at least
1404 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1405 * functions, or a single "cipher" function. In all cases we need both
1406 * the "newctx" and "freectx" functions.
1408 EVP_CIPHER_free(cipher
);
1409 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH
, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
1412 cipher
->prov
= prov
;
1414 ossl_provider_up_ref(prov
);
1419 static int evp_cipher_up_ref(void *cipher
)
1421 return EVP_CIPHER_up_ref(cipher
);
1424 static void evp_cipher_free(void *cipher
)
1426 EVP_CIPHER_free(cipher
);
1429 EVP_CIPHER
*EVP_CIPHER_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
1430 const char *properties
)
1432 EVP_CIPHER
*cipher
=
1433 evp_generic_fetch(ctx
, OSSL_OP_CIPHER
, algorithm
, properties
,
1434 evp_cipher_from_dispatch
, NULL
, evp_cipher_up_ref
,
1440 int EVP_CIPHER_up_ref(EVP_CIPHER
*cipher
)
1444 CRYPTO_UP_REF(&cipher
->refcnt
, &ref
, cipher
->lock
);
1448 void EVP_CIPHER_free(EVP_CIPHER
*cipher
)
1455 CRYPTO_DOWN_REF(&cipher
->refcnt
, &i
, cipher
->lock
);
1458 ossl_provider_free(cipher
->prov
);
1459 CRYPTO_THREAD_lock_free(cipher
->lock
);
1460 OPENSSL_free(cipher
);
1463 void EVP_CIPHER_do_all_ex(OPENSSL_CTX
*libctx
,
1464 void (*fn
)(EVP_CIPHER
*mac
, void *arg
),
1467 evp_generic_do_all(libctx
, OSSL_OP_CIPHER
,
1468 (void (*)(void *, void *))fn
, arg
,
1469 evp_cipher_from_dispatch
, NULL
, evp_cipher_free
);