2 * Copyright 1995-2018 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
:
173 * Ensure a context left lying around from last time is cleared
176 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
177 OPENSSL_clear_free(ctx
->cipher_data
, ctx
->cipher
->ctx_size
);
178 ctx
->cipher_data
= NULL
;
182 /* TODO(3.0): Start of non-legacy code below */
184 /* Ensure a context left lying around from last time is cleared */
185 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
186 unsigned long flags
= ctx
->flags
;
188 EVP_CIPHER_CTX_reset(ctx
);
189 /* Restore encrypt and flags */
195 ctx
->cipher
= cipher
;
197 cipher
= ctx
->cipher
;
199 if (cipher
->prov
== NULL
) {
201 /* We only do explict fetches inside the FIPS module */
202 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
205 EVP_CIPHER
*provciph
=
206 EVP_CIPHER_fetch(NULL
, OBJ_nid2sn(cipher
->nid
), "");
208 if (provciph
== NULL
) {
209 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
213 EVP_CIPHER_meth_free(ctx
->fetched_cipher
);
214 ctx
->fetched_cipher
= provciph
;
218 ctx
->cipher
= cipher
;
219 if (ctx
->provctx
== NULL
) {
220 ctx
->provctx
= ctx
->cipher
->newctx(ossl_provider_ctx(cipher
->prov
));
221 if (ctx
->provctx
== NULL
) {
222 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
227 if ((ctx
->flags
& EVP_CIPH_NO_PADDING
) != 0) {
229 * If this ctx was already set up for no padding then we need to tell
230 * the new cipher about it.
232 if (!EVP_CIPHER_CTX_set_padding(ctx
, 0))
236 switch (EVP_CIPHER_mode(ctx
->cipher
)) {
237 case EVP_CIPH_CFB_MODE
:
238 case EVP_CIPH_OFB_MODE
:
239 case EVP_CIPH_CBC_MODE
:
240 /* For these modes we remember the original IV for later use */
241 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx
) <= (int)sizeof(ctx
->oiv
))) {
242 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
246 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
250 if (ctx
->cipher
->einit
== NULL
) {
251 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
255 return ctx
->cipher
->einit(ctx
->provctx
,
258 : EVP_CIPHER_CTX_key_length(ctx
),
261 : EVP_CIPHER_CTX_iv_length(ctx
));
264 if (ctx
->cipher
->dinit
== NULL
) {
265 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
269 return ctx
->cipher
->dinit(ctx
->provctx
,
272 : EVP_CIPHER_CTX_key_length(ctx
),
275 : EVP_CIPHER_CTX_iv_length(ctx
));
277 /* TODO(3.0): Remove legacy code below */
280 if (cipher
!= NULL
) {
282 * Ensure a context left lying around from last time is cleared (we
283 * previously attempted to avoid this if the same ENGINE and
284 * EVP_CIPHER could be used).
287 unsigned long flags
= ctx
->flags
;
288 EVP_CIPHER_CTX_reset(ctx
);
289 /* Restore encrypt and flags */
293 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
295 if (!ENGINE_init(impl
)) {
296 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
303 /* There's an ENGINE for this job ... (apparently) */
304 const EVP_CIPHER
*c
= ENGINE_get_cipher(impl
, cipher
->nid
);
308 * One positive side-effect of US's export control history,
309 * is that we should at least be able to avoid using US
310 * misspellings of "initialisation"?
312 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
315 /* We'll use the ENGINE's private cipher definition */
318 * Store the ENGINE functional reference so we know 'cipher' came
319 * from an ENGINE and we need to release it when done.
327 ctx
->cipher
= cipher
;
328 if (ctx
->cipher
->ctx_size
) {
329 ctx
->cipher_data
= OPENSSL_zalloc(ctx
->cipher
->ctx_size
);
330 if (ctx
->cipher_data
== NULL
) {
332 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, ERR_R_MALLOC_FAILURE
);
336 ctx
->cipher_data
= NULL
;
338 ctx
->key_len
= cipher
->key_len
;
339 /* Preserve wrap enable flag, zero everything else */
340 ctx
->flags
&= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
;
341 if (ctx
->cipher
->flags
& EVP_CIPH_CTRL_INIT
) {
342 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_INIT
, 0, NULL
)) {
344 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
349 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
352 if (ctx
->cipher
== NULL
)
355 /* we assume block size is a power of 2 in *cryptUpdate */
356 OPENSSL_assert(ctx
->cipher
->block_size
== 1
357 || ctx
->cipher
->block_size
== 8
358 || ctx
->cipher
->block_size
== 16);
360 if (!(ctx
->flags
& EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
)
361 && EVP_CIPHER_CTX_mode(ctx
) == EVP_CIPH_WRAP_MODE
) {
362 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_WRAP_MODE_NOT_ALLOWED
);
366 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx
)) & EVP_CIPH_CUSTOM_IV
)) {
367 switch (EVP_CIPHER_CTX_mode(ctx
)) {
369 case EVP_CIPH_STREAM_CIPHER
:
370 case EVP_CIPH_ECB_MODE
:
373 case EVP_CIPH_CFB_MODE
:
374 case EVP_CIPH_OFB_MODE
:
379 case EVP_CIPH_CBC_MODE
:
381 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx
) <=
382 (int)sizeof(ctx
->iv
));
384 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
385 memcpy(ctx
->iv
, ctx
->oiv
, EVP_CIPHER_CTX_iv_length(ctx
));
388 case EVP_CIPH_CTR_MODE
:
390 /* Don't reuse IV for CTR mode */
392 memcpy(ctx
->iv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
400 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
401 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
406 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
410 int EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
411 const unsigned char *in
, int inl
)
414 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
416 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
419 int EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
422 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
424 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
427 int EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
430 return EVP_EncryptFinal(ctx
, out
, outl
);
432 return EVP_DecryptFinal(ctx
, out
, outl
);
435 int EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
436 const unsigned char *key
, const unsigned char *iv
)
438 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
441 int EVP_EncryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
442 ENGINE
*impl
, const unsigned char *key
,
443 const unsigned char *iv
)
445 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
448 int EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
449 const unsigned char *key
, const unsigned char *iv
)
451 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
454 int EVP_DecryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
455 ENGINE
*impl
, const unsigned char *key
,
456 const unsigned char *iv
)
458 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
462 * According to the letter of standard difference between pointers
463 * is specified to be valid only within same object. This makes
464 * it formally challenging to determine if input and output buffers
465 * are not partially overlapping with standard pointer arithmetic.
470 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
472 * Then we have VMS that distinguishes itself by adhering to
473 * sizeof(size_t)==4 even in 64-bit builds, which means that
474 * difference between two pointers might be truncated to 32 bits.
475 * In the context one can even wonder how comparison for
476 * equality is implemented. To be on the safe side we adhere to
477 * PTRDIFF_T even for comparison for equality.
479 # define PTRDIFF_T uint64_t
481 # define PTRDIFF_T size_t
484 int is_partially_overlapping(const void *ptr1
, const void *ptr2
, int len
)
486 PTRDIFF_T diff
= (PTRDIFF_T
)ptr1
-(PTRDIFF_T
)ptr2
;
488 * Check for partially overlapping buffers. [Binary logical
489 * operations are used instead of boolean to minimize number
490 * of conditional branches.]
492 int overlapped
= (len
> 0) & (diff
!= 0) & ((diff
< (PTRDIFF_T
)len
) |
493 (diff
> (0 - (PTRDIFF_T
)len
)));
498 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX
*ctx
,
499 unsigned char *out
, int *outl
,
500 const unsigned char *in
, int inl
)
502 int i
, j
, bl
, cmpl
= inl
;
504 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
505 cmpl
= (cmpl
+ 7) / 8;
507 bl
= ctx
->cipher
->block_size
;
509 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
510 /* If block size > 1 then the cipher will have to do this check */
511 if (bl
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
512 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
516 i
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
528 if (is_partially_overlapping(out
+ ctx
->buf_len
, in
, cmpl
)) {
529 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
533 if (ctx
->buf_len
== 0 && (inl
& (ctx
->block_mask
)) == 0) {
534 if (ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
)) {
543 OPENSSL_assert(bl
<= (int)sizeof(ctx
->buf
));
546 memcpy(&(ctx
->buf
[i
]), in
, inl
);
552 memcpy(&(ctx
->buf
[i
]), in
, j
);
555 if (!ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, bl
))
565 if (!ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
))
571 memcpy(ctx
->buf
, &(in
[inl
]), i
);
577 int EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
578 const unsigned char *in
, int inl
)
584 /* Prevent accidental use of decryption context when encrypting */
586 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
590 if (ctx
->cipher
== NULL
) {
591 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
595 if (ctx
->cipher
->prov
== NULL
)
598 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
600 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
601 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
604 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
605 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
609 if (soutl
> INT_MAX
) {
610 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
618 /* TODO(3.0): Remove legacy code below */
621 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
624 int EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
627 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
631 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
634 unsigned int i
, b
, bl
;
638 /* Prevent accidental use of decryption context when encrypting */
640 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
644 if (ctx
->cipher
== NULL
) {
645 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
648 if (ctx
->cipher
->prov
== NULL
)
651 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
653 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
654 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
658 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
659 blocksize
== 1 ? 0 : blocksize
);
662 if (soutl
> INT_MAX
) {
663 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
671 /* TODO(3.0): Remove legacy code below */
674 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
675 ret
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
683 b
= ctx
->cipher
->block_size
;
684 OPENSSL_assert(b
<= sizeof(ctx
->buf
));
690 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
692 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
693 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
701 for (i
= bl
; i
< b
; i
++)
703 ret
= ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, b
);
711 int EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
712 const unsigned char *in
, int inl
)
714 int fix_len
, cmpl
= inl
, ret
;
719 /* Prevent accidental use of encryption context when decrypting */
721 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
725 if (ctx
->cipher
== NULL
) {
726 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_NO_CIPHER_SET
);
729 if (ctx
->cipher
->prov
== NULL
)
732 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
734 if (ctx
->cipher
->cupdate
== NULL
|| blocksize
< 1) {
735 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
738 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
,
739 inl
+ (blocksize
== 1 ? 0 : blocksize
), in
,
743 if (soutl
> INT_MAX
) {
744 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
752 /* TODO(3.0): Remove legacy code below */
755 b
= ctx
->cipher
->block_size
;
757 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
758 cmpl
= (cmpl
+ 7) / 8;
760 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
761 if (b
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
762 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
766 fix_len
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
780 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
781 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
783 OPENSSL_assert(b
<= sizeof(ctx
->final
));
785 if (ctx
->final_used
) {
786 /* see comment about PTRDIFF_T comparison above */
787 if (((PTRDIFF_T
)out
== (PTRDIFF_T
)in
)
788 || is_partially_overlapping(out
, in
, b
)) {
789 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
792 memcpy(out
, ctx
->final
, b
);
798 if (!evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
))
802 * if we have 'decrypted' a multiple of block size, make sure we have a
803 * copy of this last block
805 if (b
> 1 && !ctx
->buf_len
) {
808 memcpy(ctx
->final
, &out
[*outl
], b
);
818 int EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
821 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
825 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
833 /* Prevent accidental use of encryption context when decrypting */
835 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
839 if (ctx
->cipher
== NULL
) {
840 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_NO_CIPHER_SET
);
844 if (ctx
->cipher
->prov
== NULL
)
847 blocksize
= EVP_CIPHER_CTX_block_size(ctx
);
849 if (blocksize
< 1 || ctx
->cipher
->cfinal
== NULL
) {
850 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
854 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
,
855 blocksize
== 1 ? 0 : blocksize
);
858 if (soutl
> INT_MAX
) {
859 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
867 /* TODO(3.0): Remove legacy code below */
871 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
872 i
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
880 b
= ctx
->cipher
->block_size
;
881 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
883 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
884 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
891 if (ctx
->buf_len
|| !ctx
->final_used
) {
892 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
895 OPENSSL_assert(b
<= sizeof(ctx
->final
));
898 * The following assumes that the ciphertext has been authenticated.
899 * Otherwise it provides a padding oracle.
901 n
= ctx
->final
[b
- 1];
902 if (n
== 0 || n
> (int)b
) {
903 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
906 for (i
= 0; i
< n
; i
++) {
907 if (ctx
->final
[--b
] != n
) {
908 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
912 n
= ctx
->cipher
->block_size
- n
;
913 for (i
= 0; i
< n
; i
++)
914 out
[i
] = ctx
->final
[i
];
921 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
923 if (c
->cipher
->flags
& EVP_CIPH_CUSTOM_KEY_LENGTH
)
924 return EVP_CIPHER_CTX_ctrl(c
, EVP_CTRL_SET_KEY_LENGTH
, keylen
, NULL
);
925 if (EVP_CIPHER_CTX_key_length(c
) == keylen
)
927 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
931 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
935 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
938 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
940 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
942 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->prov
!= NULL
) {
943 OSSL_PARAM params
[] = {
944 OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING
, NULL
),
948 params
[0].data
= &pad
;
950 if (ctx
->cipher
->ctx_set_params
== NULL
) {
951 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING
, EVP_R_CTRL_NOT_IMPLEMENTED
);
955 if (!ctx
->cipher
->ctx_set_params(ctx
->provctx
, params
))
962 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
967 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
971 if (!ctx
->cipher
->ctrl
) {
972 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
976 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
978 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
979 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
985 #if !defined(FIPS_MODE)
986 /* TODO(3.0): No support for RAND yet in the FIPS module */
987 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
990 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
991 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
992 kl
= EVP_CIPHER_CTX_key_length(ctx
);
993 if (kl
<= 0 || RAND_priv_bytes(key
, kl
) <= 0)
999 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
1001 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
1002 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
1006 if (in
->cipher
->prov
== NULL
)
1009 if (in
->cipher
->dupctx
== NULL
) {
1010 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1014 EVP_CIPHER_CTX_reset(out
);
1017 out
->provctx
= NULL
;
1019 if (in
->fetched_cipher
!= NULL
&& !EVP_CIPHER_up_ref(in
->fetched_cipher
)) {
1020 out
->fetched_cipher
= NULL
;
1024 out
->provctx
= in
->cipher
->dupctx(in
->provctx
);
1025 if (out
->provctx
== NULL
) {
1026 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
1032 /* TODO(3.0): Remove legacy code below */
1035 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODE)
1036 /* Make sure it's safe to copy a cipher context using an ENGINE */
1037 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
1038 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
1043 EVP_CIPHER_CTX_reset(out
);
1044 memcpy(out
, in
, sizeof(*out
));
1046 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
1047 out
->cipher_data
= OPENSSL_malloc(in
->cipher
->ctx_size
);
1048 if (out
->cipher_data
== NULL
) {
1050 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
1053 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
1056 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
1057 if (!in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
, EVP_CTRL_COPY
, 0, out
)) {
1059 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INITIALIZATION_ERROR
);
1065 static void *evp_cipher_from_dispatch(const OSSL_DISPATCH
*fns
,
1066 OSSL_PROVIDER
*prov
)
1068 EVP_CIPHER
*cipher
= NULL
;
1069 int fnciphcnt
= 0, fnctxcnt
= 0;
1072 * The legacy NID is set by EVP_CIPHER_fetch() if the name exists in
1073 * the object database.
1075 if ((cipher
= EVP_CIPHER_meth_new(0, 0, 0)) == NULL
)
1078 for (; fns
->function_id
!= 0; fns
++) {
1079 switch (fns
->function_id
) {
1080 case OSSL_FUNC_CIPHER_NEWCTX
:
1081 if (cipher
->newctx
!= NULL
)
1083 cipher
->newctx
= OSSL_get_OP_cipher_newctx(fns
);
1086 case OSSL_FUNC_CIPHER_ENCRYPT_INIT
:
1087 if (cipher
->einit
!= NULL
)
1089 cipher
->einit
= OSSL_get_OP_cipher_encrypt_init(fns
);
1092 case OSSL_FUNC_CIPHER_DECRYPT_INIT
:
1093 if (cipher
->dinit
!= NULL
)
1095 cipher
->dinit
= OSSL_get_OP_cipher_decrypt_init(fns
);
1098 case OSSL_FUNC_CIPHER_UPDATE
:
1099 if (cipher
->cupdate
!= NULL
)
1101 cipher
->cupdate
= OSSL_get_OP_cipher_update(fns
);
1104 case OSSL_FUNC_CIPHER_FINAL
:
1105 if (cipher
->cfinal
!= NULL
)
1107 cipher
->cfinal
= OSSL_get_OP_cipher_final(fns
);
1110 case OSSL_FUNC_CIPHER_CIPHER
:
1111 if (cipher
->ccipher
!= NULL
)
1113 cipher
->ccipher
= OSSL_get_OP_cipher_cipher(fns
);
1115 case OSSL_FUNC_CIPHER_FREECTX
:
1116 if (cipher
->freectx
!= NULL
)
1118 cipher
->freectx
= OSSL_get_OP_cipher_freectx(fns
);
1121 case OSSL_FUNC_CIPHER_DUPCTX
:
1122 if (cipher
->dupctx
!= NULL
)
1124 cipher
->dupctx
= OSSL_get_OP_cipher_dupctx(fns
);
1126 case OSSL_FUNC_CIPHER_KEY_LENGTH
:
1127 if (cipher
->key_length
!= NULL
)
1129 cipher
->key_length
= OSSL_get_OP_cipher_key_length(fns
);
1131 case OSSL_FUNC_CIPHER_IV_LENGTH
:
1132 if (cipher
->iv_length
!= NULL
)
1134 cipher
->iv_length
= OSSL_get_OP_cipher_iv_length(fns
);
1136 case OSSL_FUNC_CIPHER_BLOCK_SIZE
:
1137 if (cipher
->blocksize
!= NULL
)
1139 cipher
->blocksize
= OSSL_get_OP_cipher_block_size(fns
);
1141 case OSSL_FUNC_CIPHER_GET_PARAMS
:
1142 if (cipher
->get_params
!= NULL
)
1144 cipher
->get_params
= OSSL_get_OP_cipher_get_params(fns
);
1146 case OSSL_FUNC_CIPHER_CTX_GET_PARAMS
:
1147 if (cipher
->ctx_get_params
!= NULL
)
1149 cipher
->ctx_get_params
= OSSL_get_OP_cipher_ctx_get_params(fns
);
1151 case OSSL_FUNC_CIPHER_CTX_SET_PARAMS
:
1152 if (cipher
->ctx_set_params
!= NULL
)
1154 cipher
->ctx_set_params
= OSSL_get_OP_cipher_ctx_set_params(fns
);
1158 if ((fnciphcnt
!= 0 && fnciphcnt
!= 3 && fnciphcnt
!= 4)
1159 || (fnciphcnt
== 0 && cipher
->ccipher
== NULL
)
1161 || cipher
->blocksize
== NULL
1162 || cipher
->iv_length
== NULL
1163 || cipher
->key_length
== NULL
) {
1165 * In order to be a consistent set of functions we must have at least
1166 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1167 * functions, or a single "cipher" function. In all cases we need a
1168 * complete set of context management functions, as well as the
1169 * blocksize, iv_length and key_length functions.
1171 EVP_CIPHER_meth_free(cipher
);
1172 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH
, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
1175 cipher
->prov
= prov
;
1177 ossl_provider_upref(prov
);
1182 static int evp_cipher_up_ref(void *cipher
)
1184 return EVP_CIPHER_up_ref(cipher
);
1187 static void evp_cipher_free(void *cipher
)
1189 EVP_CIPHER_meth_free(cipher
);
1192 EVP_CIPHER
*EVP_CIPHER_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
1193 const char *properties
)
1195 EVP_CIPHER
*cipher
=
1196 evp_generic_fetch(ctx
, OSSL_OP_CIPHER
, algorithm
, properties
,
1197 evp_cipher_from_dispatch
, evp_cipher_up_ref
,
1201 /* TODO(3.x) get rid of the need for legacy NIDs */
1202 if (cipher
!= NULL
) {
1204 * FIPS module note: since internal fetches will be entirely
1205 * provider based, we know that none of its code depends on legacy
1206 * NIDs or any functionality that use them.
1208 cipher
->nid
= OBJ_sn2nid(algorithm
);