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_meth_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_meth_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_256_gcm
:
167 case NID_aes_192_gcm
:
168 case NID_aes_128_gcm
:
169 case NID_aria_256_gcm
:
170 case NID_aria_192_gcm
:
171 case NID_aria_128_gcm
:
172 case NID_aes_256_ccm
:
173 case NID_aes_192_ccm
:
174 case NID_aes_128_ccm
:
175 case NID_aria_256_ccm
:
176 case NID_aria_192_ccm
:
177 case NID_aria_128_ccm
:
178 case NID_aria_256_ecb
:
179 case NID_aria_192_ecb
:
180 case NID_aria_128_ecb
:
181 case NID_aria_256_cbc
:
182 case NID_aria_192_cbc
:
183 case NID_aria_128_cbc
:
184 case NID_aria_256_ofb128
:
185 case NID_aria_192_ofb128
:
186 case NID_aria_128_ofb128
:
187 case NID_aria_256_cfb128
:
188 case NID_aria_192_cfb128
:
189 case NID_aria_128_cfb128
:
190 case NID_aria_256_cfb1
:
191 case NID_aria_192_cfb1
:
192 case NID_aria_128_cfb1
:
193 case NID_aria_256_cfb8
:
194 case NID_aria_192_cfb8
:
195 case NID_aria_128_cfb8
:
196 case NID_aria_256_ctr
:
197 case NID_aria_192_ctr
:
198 case NID_aria_128_ctr
:
199 case NID_camellia_256_ecb
:
200 case NID_camellia_192_ecb
:
201 case NID_camellia_128_ecb
:
202 case NID_camellia_256_cbc
:
203 case NID_camellia_192_cbc
:
204 case NID_camellia_128_cbc
:
205 case NID_camellia_256_ofb128
:
206 case NID_camellia_192_ofb128
:
207 case NID_camellia_128_ofb128
:
208 case NID_camellia_256_cfb128
:
209 case NID_camellia_192_cfb128
:
210 case NID_camellia_128_cfb128
:
211 case NID_camellia_256_cfb1
:
212 case NID_camellia_192_cfb1
:
213 case NID_camellia_128_cfb1
:
214 case NID_camellia_256_cfb8
:
215 case NID_camellia_192_cfb8
:
216 case NID_camellia_128_cfb8
:
217 case NID_camellia_256_ctr
:
218 case NID_camellia_192_ctr
:
219 case NID_camellia_128_ctr
:
227 * Ensure a context left lying around from last time is cleared
230 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
231 OPENSSL_clear_free(ctx
->cipher_data
, ctx
->cipher
->ctx_size
);
232 ctx
->cipher_data
= NULL
;
236 /* TODO(3.0): Start of non-legacy code below */
238 /* Ensure a context left lying around from last time is cleared */
239 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
240 unsigned long flags
= ctx
->flags
;
242 EVP_CIPHER_CTX_reset(ctx
);
243 /* Restore encrypt and flags */
249 cipher
= ctx
->cipher
;
251 if (cipher
->prov
== NULL
) {
253 /* We only do explict fetches inside the FIPS module */
254 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
257 EVP_CIPHER
*provciph
=
258 EVP_CIPHER_fetch(NULL
, OBJ_nid2sn(cipher
->nid
), "");
260 if (provciph
== NULL
) {
261 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
265 EVP_CIPHER_meth_free(ctx
->fetched_cipher
);
266 ctx
->fetched_cipher
= provciph
;
270 ctx
->cipher
= cipher
;
271 if (ctx
->provctx
== NULL
) {
272 ctx
->provctx
= ctx
->cipher
->newctx(ossl_provider_ctx(cipher
->prov
));
273 if (ctx
->provctx
== NULL
) {
274 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
279 if ((ctx
->flags
& EVP_CIPH_NO_PADDING
) != 0) {
281 * If this ctx was already set up for no padding then we need to tell
282 * the new cipher about it.
284 if (!EVP_CIPHER_CTX_set_padding(ctx
, 0))
288 switch (EVP_CIPHER_mode(ctx
->cipher
)) {
289 case EVP_CIPH_CFB_MODE
:
290 case EVP_CIPH_OFB_MODE
:
291 case EVP_CIPH_CBC_MODE
:
292 /* For these modes we remember the original IV for later use */
293 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx
) <= (int)sizeof(ctx
->oiv
))) {
294 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
298 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
302 if (ctx
->cipher
->einit
== NULL
) {
303 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
307 return ctx
->cipher
->einit(ctx
->provctx
,
310 : EVP_CIPHER_CTX_key_length(ctx
),
313 : EVP_CIPHER_CTX_iv_length(ctx
));
316 if (ctx
->cipher
->dinit
== NULL
) {
317 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
321 return ctx
->cipher
->dinit(ctx
->provctx
,
324 : EVP_CIPHER_CTX_key_length(ctx
),
327 : EVP_CIPHER_CTX_iv_length(ctx
));
329 /* TODO(3.0): Remove legacy code below */
332 if (cipher
!= NULL
) {
334 * Ensure a context left lying around from last time is cleared (we
335 * previously attempted to avoid this if the same ENGINE and
336 * EVP_CIPHER could be used).
339 unsigned long flags
= ctx
->flags
;
340 EVP_CIPHER_CTX_reset(ctx
);
341 /* Restore encrypt and flags */
345 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
347 if (!ENGINE_init(impl
)) {
348 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
355 /* There's an ENGINE for this job ... (apparently) */
356 const EVP_CIPHER
*c
= ENGINE_get_cipher(impl
, cipher
->nid
);
360 * One positive side-effect of US's export control history,
361 * is that we should at least be able to avoid using US
362 * misspellings of "initialisation"?
364 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
367 /* We'll use the ENGINE's private cipher definition */
370 * Store the ENGINE functional reference so we know 'cipher' came
371 * from an ENGINE and we need to release it when done.
379 ctx
->cipher
= cipher
;
380 if (ctx
->cipher
->ctx_size
) {
381 ctx
->cipher_data
= OPENSSL_zalloc(ctx
->cipher
->ctx_size
);
382 if (ctx
->cipher_data
== NULL
) {
384 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, ERR_R_MALLOC_FAILURE
);
388 ctx
->cipher_data
= NULL
;
390 ctx
->key_len
= cipher
->key_len
;
391 /* Preserve wrap enable flag, zero everything else */
392 ctx
->flags
&= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
;
393 if (ctx
->cipher
->flags
& EVP_CIPH_CTRL_INIT
) {
394 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_INIT
, 0, NULL
)) {
396 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
401 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
404 if (ctx
->cipher
== NULL
)
407 /* we assume block size is a power of 2 in *cryptUpdate */
408 OPENSSL_assert(ctx
->cipher
->block_size
== 1
409 || ctx
->cipher
->block_size
== 8
410 || ctx
->cipher
->block_size
== 16);
412 if (!(ctx
->flags
& EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
)
413 && EVP_CIPHER_CTX_mode(ctx
) == EVP_CIPH_WRAP_MODE
) {
414 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_WRAP_MODE_NOT_ALLOWED
);
418 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx
)) & EVP_CIPH_CUSTOM_IV
)) {
419 switch (EVP_CIPHER_CTX_mode(ctx
)) {
421 case EVP_CIPH_STREAM_CIPHER
:
422 case EVP_CIPH_ECB_MODE
:
425 case EVP_CIPH_CFB_MODE
:
426 case EVP_CIPH_OFB_MODE
:
431 case EVP_CIPH_CBC_MODE
:
433 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx
) <=
434 (int)sizeof(ctx
->iv
));
436 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
437 memcpy(ctx
->iv
, ctx
->oiv
, EVP_CIPHER_CTX_iv_length(ctx
));
440 case EVP_CIPH_CTR_MODE
:
442 /* Don't reuse IV for CTR mode */
444 memcpy(ctx
->iv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
452 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
453 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
458 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
462 int EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
463 const unsigned char *in
, int inl
)
466 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
468 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
471 int EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
474 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
476 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
479 int EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
482 return EVP_EncryptFinal(ctx
, out
, outl
);
484 return EVP_DecryptFinal(ctx
, out
, outl
);
487 int EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
488 const unsigned char *key
, const unsigned char *iv
)
490 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
493 int EVP_EncryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
494 ENGINE
*impl
, const unsigned char *key
,
495 const unsigned char *iv
)
497 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
500 int EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
501 const unsigned char *key
, const unsigned char *iv
)
503 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
506 int EVP_DecryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
507 ENGINE
*impl
, const unsigned char *key
,
508 const unsigned char *iv
)
510 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
514 * According to the letter of standard difference between pointers
515 * is specified to be valid only within same object. This makes
516 * it formally challenging to determine if input and output buffers
517 * are not partially overlapping with standard pointer arithmetic.
522 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
524 * Then we have VMS that distinguishes itself by adhering to
525 * sizeof(size_t)==4 even in 64-bit builds, which means that
526 * difference between two pointers might be truncated to 32 bits.
527 * In the context one can even wonder how comparison for
528 * equality is implemented. To be on the safe side we adhere to
529 * PTRDIFF_T even for comparison for equality.
531 # define PTRDIFF_T uint64_t
533 # define PTRDIFF_T size_t
536 int is_partially_overlapping(const void *ptr1
, const void *ptr2
, int len
)
538 PTRDIFF_T diff
= (PTRDIFF_T
)ptr1
-(PTRDIFF_T
)ptr2
;
540 * Check for partially overlapping buffers. [Binary logical
541 * operations are used instead of boolean to minimize number
542 * of conditional branches.]
544 int overlapped
= (len
> 0) & (diff
!= 0) & ((diff
< (PTRDIFF_T
)len
) |
545 (diff
> (0 - (PTRDIFF_T
)len
)));
550 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX
*ctx
,
551 unsigned char *out
, int *outl
,
552 const unsigned char *in
, int inl
)
554 int i
, j
, bl
, cmpl
= inl
;
556 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
557 cmpl
= (cmpl
+ 7) / 8;
559 bl
= ctx
->cipher
->block_size
;
561 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
562 /* If block size > 1 then the cipher will have to do this check */
563 if (bl
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
564 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
568 i
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
580 if (is_partially_overlapping(out
+ ctx
->buf_len
, in
, cmpl
)) {
581 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
585 if (ctx
->buf_len
== 0 && (inl
& (ctx
->block_mask
)) == 0) {
586 if (ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
)) {
595 OPENSSL_assert(bl
<= (int)sizeof(ctx
->buf
));
598 memcpy(&(ctx
->buf
[i
]), in
, inl
);
604 memcpy(&(ctx
->buf
[i
]), in
, j
);
607 if (!ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, bl
))
617 if (!ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
))
623 memcpy(ctx
->buf
, &(in
[inl
]), i
);
629 int EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
630 const unsigned char *in
, int inl
)
636 /* Prevent accidental use of decryption context when encrypting */
638 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
642 if (ctx
->cipher
== NULL
) {
643 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
647 if (ctx
->cipher
->prov
== NULL
)
650 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
652 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
653 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
656 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
657 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
661 if (soutl
> INT_MAX
) {
662 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
670 /* TODO(3.0): Remove legacy code below */
673 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
676 int EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
679 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
683 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
686 unsigned int i
, b
, bl
;
690 /* Prevent accidental use of decryption context when encrypting */
692 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
696 if (ctx
->cipher
== NULL
) {
697 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
700 if (ctx
->cipher
->prov
== NULL
)
703 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
705 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
706 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
710 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
711 blocksize
== 1 ? 0 : blocksize
);
714 if (soutl
> INT_MAX
) {
715 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
723 /* TODO(3.0): Remove legacy code below */
726 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
727 ret
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
735 b
= ctx
->cipher
->block_size
;
736 OPENSSL_assert(b
<= sizeof(ctx
->buf
));
742 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
744 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
745 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
753 for (i
= bl
; i
< b
; i
++)
755 ret
= ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, b
);
763 int EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
764 const unsigned char *in
, int inl
)
766 int fix_len
, cmpl
= inl
, ret
;
771 /* Prevent accidental use of encryption context when decrypting */
773 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
777 if (ctx
->cipher
== NULL
) {
778 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
781 if (ctx
->cipher
->prov
== NULL
)
784 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
786 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
787 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
790 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
791 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
795 if (soutl
> INT_MAX
) {
796 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
804 /* TODO(3.0): Remove legacy code below */
807 b
= ctx
->cipher
->block_size
;
809 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
810 cmpl
= (cmpl
+ 7) / 8;
812 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
813 if (b
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
814 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
818 fix_len
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
832 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
833 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
835 OPENSSL_assert(b
<= sizeof(ctx
->final
));
837 if (ctx
->final_used
) {
838 /* see comment about PTRDIFF_T comparison above */
839 if (((PTRDIFF_T
)out
== (PTRDIFF_T
)in
)
840 || is_partially_overlapping(out
, in
, b
)) {
841 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
844 memcpy(out
, ctx
->final
, b
);
850 if (!evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
))
854 * if we have 'decrypted' a multiple of block size, make sure we have a
855 * copy of this last block
857 if (b
> 1 && !ctx
->buf_len
) {
860 memcpy(ctx
->final
, &out
[*outl
], b
);
870 int EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
873 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
877 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
885 /* Prevent accidental use of encryption context when decrypting */
887 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
891 if (ctx
->cipher
== NULL
) {
892 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
896 if (ctx
->cipher
->prov
== NULL
)
899 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
901 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
902 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
906 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
907 blocksize
== 1 ? 0 : blocksize
);
910 if (soutl
> INT_MAX
) {
911 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
919 /* TODO(3.0): Remove legacy code below */
923 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
924 i
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
932 b
= ctx
->cipher
->block_size
;
933 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
935 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
936 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
943 if (ctx
->buf_len
|| !ctx
->final_used
) {
944 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
947 OPENSSL_assert(b
<= sizeof(ctx
->final
));
950 * The following assumes that the ciphertext has been authenticated.
951 * Otherwise it provides a padding oracle.
953 n
= ctx
->final
[b
- 1];
954 if (n
== 0 || n
> (int)b
) {
955 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
958 for (i
= 0; i
< n
; i
++) {
959 if (ctx
->final
[--b
] != n
) {
960 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
964 n
= ctx
->cipher
->block_size
- n
;
965 for (i
= 0; i
< n
; i
++)
966 out
[i
] = ctx
->final
[i
];
973 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
976 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
978 params
[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN
, &keylen
);
979 ok
= evp_do_ciph_ctx_setparams(c
->cipher
, c
->provctx
, params
);
981 if (ok
!= EVP_CTRL_RET_UNSUPPORTED
)
984 /* TODO(3.0) legacy code follows */
985 if (c
->cipher
->flags
& EVP_CIPH_CUSTOM_KEY_LENGTH
)
986 return EVP_CIPHER_CTX_ctrl(c
, EVP_CTRL_SET_KEY_LENGTH
, keylen
, NULL
);
987 if (EVP_CIPHER_CTX_key_length(c
) == keylen
)
989 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
993 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
997 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
1000 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1003 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
1005 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
1007 params
[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_PADDING
, &pad
);
1008 ok
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1013 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
1015 int ret
= EVP_CTRL_RET_UNSUPPORTED
;
1018 OSSL_PARAM params
[2] = { OSSL_PARAM_END
, OSSL_PARAM_END
};
1020 if (ctx
== NULL
|| ctx
->cipher
== NULL
) {
1021 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
1025 if (ctx
->cipher
->prov
== NULL
)
1029 case EVP_CTRL_SET_KEY_LENGTH
:
1030 params
[0] = OSSL_PARAM_construct_int(OSSL_CIPHER_PARAM_KEYLEN
, &arg
);
1032 case EVP_CTRL_RAND_KEY
: /* Used by DES */
1033 case EVP_CTRL_SET_PIPELINE_OUTPUT_BUFS
: /* Used by DASYNC */
1034 case EVP_CTRL_INIT
: /* TODO(3.0) Purely legacy, no provider counterpart */
1036 return EVP_CTRL_RET_UNSUPPORTED
;
1037 case EVP_CTRL_GET_IV
:
1039 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_IV
,
1042 case EVP_CTRL_AEAD_SET_IVLEN
:
1047 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN
, &sz
);
1049 case EVP_CTRL_GCM_SET_IV_FIXED
:
1051 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED
,
1054 case EVP_CTRL_AEAD_SET_TAG
:
1056 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
,
1059 case EVP_CTRL_AEAD_GET_TAG
:
1061 params
[0] = OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG
,
1064 case EVP_CTRL_AEAD_TLS1_AAD
:
1065 /* This one does a set and a get - since it returns a padding size */
1067 OSSL_PARAM_construct_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD
,
1069 ret
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1073 OSSL_PARAM_construct_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD
, &sz
);
1074 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->provctx
, params
);
1081 ret
= evp_do_ciph_ctx_setparams(ctx
->cipher
, ctx
->provctx
, params
);
1083 ret
= evp_do_ciph_ctx_getparams(ctx
->cipher
, ctx
->provctx
, params
);
1086 /* TODO(3.0): Remove legacy code below */
1088 if (ctx
->cipher
->ctrl
== NULL
) {
1089 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
1093 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
1094 if (ret
== EVP_CTRL_RET_UNSUPPORTED
) {
1095 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
1096 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
1102 int EVP_CIPHER_get_params(EVP_CIPHER
*cipher
, OSSL_PARAM params
[])
1104 if (cipher
!= NULL
&& cipher
->get_params
!= NULL
)
1105 return cipher
->get_params(params
);
1109 int EVP_CIPHER_CTX_set_params(EVP_CIPHER_CTX
*ctx
, const OSSL_PARAM params
[])
1111 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->set_ctx_params
!= NULL
)
1112 return ctx
->cipher
->set_ctx_params(ctx
->provctx
, params
);
1116 int EVP_CIPHER_CTX_get_params(EVP_CIPHER_CTX
*ctx
, OSSL_PARAM params
[])
1118 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->get_ctx_params
!= NULL
)
1119 return ctx
->cipher
->get_ctx_params(ctx
->provctx
, params
);
1123 const OSSL_PARAM
*EVP_CIPHER_gettable_params(const EVP_CIPHER
*cipher
)
1125 if (cipher
!= NULL
&& cipher
->gettable_params
!= NULL
)
1126 return cipher
->gettable_params();
1130 const OSSL_PARAM
*EVP_CIPHER_CTX_settable_params(const EVP_CIPHER
*cipher
)
1132 if (cipher
!= NULL
&& cipher
->settable_ctx_params
!= NULL
)
1133 return cipher
->settable_ctx_params();
1137 const OSSL_PARAM
*EVP_CIPHER_CTX_gettable_params(const EVP_CIPHER
*cipher
)
1139 if (cipher
!= NULL
&& cipher
->gettable_ctx_params
!= NULL
)
1140 return cipher
->gettable_ctx_params();
1144 #if !defined(FIPS_MODE)
1145 /* TODO(3.0): No support for RAND yet in the FIPS module */
1146 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
1149 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
1150 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
1151 kl
= EVP_CIPHER_CTX_key_length(ctx
);
1152 if (kl
<= 0 || RAND_priv_bytes(key
, kl
) <= 0)
1158 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
1160 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
1161 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
1165 if (in
->cipher
->prov
== NULL
)
1168 if (in
->cipher
->dupctx
== NULL
) {
1169 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1173 EVP_CIPHER_CTX_reset(out
);
1176 out
->provctx
= NULL
;
1178 if (in
->fetched_cipher
!= NULL
&& !EVP_CIPHER_up_ref(in
->fetched_cipher
)) {
1179 out
->fetched_cipher
= NULL
;
1183 out
->provctx
= in
->cipher
->dupctx(in
->provctx
);
1184 if (out
->provctx
== NULL
) {
1185 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1191 /* TODO(3.0): Remove legacy code below */
1194 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1195 /* Make sure it's safe to copy a cipher context using an ENGINE */
1196 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
1197 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
1202 EVP_CIPHER_CTX_reset(out
);
1203 memcpy(out
, in
, sizeof(*out
));
1205 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
1206 out
->cipher_data
= OPENSSL_malloc(in
->cipher
->ctx_size
);
1207 if (out
->cipher_data
== NULL
) {
1209 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
1212 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
1215 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
1216 if (!in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
, EVP_CTRL_COPY
, 0, out
)) {
1218 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INITIALIZATION_ERROR
);
1224 static void *evp_cipher_from_dispatch(const char *name
,
1225 const OSSL_DISPATCH
*fns
,
1226 OSSL_PROVIDER
*prov
)
1228 EVP_CIPHER
*cipher
= NULL
;
1229 int fnciphcnt
= 0, fnctxcnt
= 0;
1232 * The legacy NID is set by EVP_CIPHER_fetch() if the name exists in
1233 * the object database.
1235 if ((cipher
= EVP_CIPHER_meth_new(0, 0, 0)) == NULL
1236 || (cipher
->name
= OPENSSL_strdup(name
)) == NULL
) {
1237 EVP_CIPHER_meth_free(cipher
);
1238 EVPerr(0, ERR_R_MALLOC_FAILURE
);
1242 for (; fns
->function_id
!= 0; fns
++) {
1243 switch (fns
->function_id
) {
1244 case OSSL_FUNC_CIPHER_NEWCTX
:
1245 if (cipher
->newctx
!= NULL
)
1247 cipher
->newctx
= OSSL_get_OP_cipher_newctx(fns
);
1250 case OSSL_FUNC_CIPHER_ENCRYPT_INIT
:
1251 if (cipher
->einit
!= NULL
)
1253 cipher
->einit
= OSSL_get_OP_cipher_encrypt_init(fns
);
1256 case OSSL_FUNC_CIPHER_DECRYPT_INIT
:
1257 if (cipher
->dinit
!= NULL
)
1259 cipher
->dinit
= OSSL_get_OP_cipher_decrypt_init(fns
);
1262 case OSSL_FUNC_CIPHER_UPDATE
:
1263 if (cipher
->cupdate
!= NULL
)
1265 cipher
->cupdate
= OSSL_get_OP_cipher_update(fns
);
1268 case OSSL_FUNC_CIPHER_FINAL
:
1269 if (cipher
->cfinal
!= NULL
)
1271 cipher
->cfinal
= OSSL_get_OP_cipher_final(fns
);
1274 case OSSL_FUNC_CIPHER_CIPHER
:
1275 if (cipher
->ccipher
!= NULL
)
1277 cipher
->ccipher
= OSSL_get_OP_cipher_cipher(fns
);
1279 case OSSL_FUNC_CIPHER_FREECTX
:
1280 if (cipher
->freectx
!= NULL
)
1282 cipher
->freectx
= OSSL_get_OP_cipher_freectx(fns
);
1285 case OSSL_FUNC_CIPHER_DUPCTX
:
1286 if (cipher
->dupctx
!= NULL
)
1288 cipher
->dupctx
= OSSL_get_OP_cipher_dupctx(fns
);
1290 case OSSL_FUNC_CIPHER_GET_PARAMS
:
1291 if (cipher
->get_params
!= NULL
)
1293 cipher
->get_params
= OSSL_get_OP_cipher_get_params(fns
);
1295 case OSSL_FUNC_CIPHER_GET_CTX_PARAMS
:
1296 if (cipher
->get_ctx_params
!= NULL
)
1298 cipher
->get_ctx_params
= OSSL_get_OP_cipher_get_ctx_params(fns
);
1300 case OSSL_FUNC_CIPHER_SET_CTX_PARAMS
:
1301 if (cipher
->set_ctx_params
!= NULL
)
1303 cipher
->set_ctx_params
= OSSL_get_OP_cipher_set_ctx_params(fns
);
1305 case OSSL_FUNC_CIPHER_GETTABLE_PARAMS
:
1306 if (cipher
->gettable_params
!= NULL
)
1308 cipher
->gettable_params
= OSSL_get_OP_cipher_gettable_params(fns
);
1310 case OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS
:
1311 if (cipher
->gettable_ctx_params
!= NULL
)
1313 cipher
->gettable_ctx_params
=
1314 OSSL_get_OP_cipher_gettable_ctx_params(fns
);
1316 case OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS
:
1317 if (cipher
->settable_ctx_params
!= NULL
)
1319 cipher
->settable_ctx_params
=
1320 OSSL_get_OP_cipher_settable_ctx_params(fns
);
1324 if ((fnciphcnt
!= 0 && fnciphcnt
!= 3 && fnciphcnt
!= 4)
1325 || (fnciphcnt
== 0 && cipher
->ccipher
== NULL
)
1328 * In order to be a consistent set of functions we must have at least
1329 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1330 * functions, or a single "cipher" function. In all cases we need both
1331 * the "newctx" and "freectx" functions.
1333 EVP_CIPHER_meth_free(cipher
);
1334 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH
, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
1337 cipher
->prov
= prov
;
1339 ossl_provider_up_ref(prov
);
1344 static int evp_cipher_up_ref(void *cipher
)
1346 return EVP_CIPHER_up_ref(cipher
);
1349 static void evp_cipher_free(void *cipher
)
1351 EVP_CIPHER_meth_free(cipher
);
1354 EVP_CIPHER
*EVP_CIPHER_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
1355 const char *properties
)
1357 EVP_CIPHER
*cipher
=
1358 evp_generic_fetch(ctx
, OSSL_OP_CIPHER
, algorithm
, properties
,
1359 evp_cipher_from_dispatch
, evp_cipher_up_ref
,
1363 /* TODO(3.x) get rid of the need for legacy NIDs */
1364 if (cipher
!= NULL
) {
1366 * FIPS module note: since internal fetches will be entirely
1367 * provider based, we know that none of its code depends on legacy
1368 * NIDs or any functionality that use them.
1370 cipher
->nid
= OBJ_sn2nid(algorithm
);
1377 void EVP_CIPHER_do_all_ex(OPENSSL_CTX
*libctx
,
1378 void (*fn
)(EVP_CIPHER
*mac
, void *arg
),
1381 evp_generic_do_all(libctx
, OSSL_OP_CIPHER
,
1382 (void (*)(void *, void *))fn
, arg
,
1383 evp_cipher_from_dispatch
, evp_cipher_free
);