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 #ifndef OPENSSL_NO_ENGINE
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 EVP_CIPHER
*provciph
= NULL
;
85 ENGINE
*tmpimpl
= NULL
;
86 const EVP_CIPHER
*tmpcipher
;
89 * enc == 1 means we are encrypting.
90 * enc == 0 means we are decrypting.
91 * enc == -1 means, use the previously initialised value for encrypt/decrypt
101 if (cipher
== NULL
&& ctx
->cipher
== NULL
) {
102 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_NO_CIPHER_SET
);
106 /* TODO(3.0): Legacy work around code below. Remove this */
108 #ifndef OPENSSL_NO_ENGINE
110 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
111 * this context may already have an ENGINE! Try to avoid releasing the
112 * previous handle, re-querying for an ENGINE, and having a
113 * reinitialisation, when it may all be unnecessary.
115 if (ctx
->engine
&& ctx
->cipher
116 && (cipher
== NULL
|| cipher
->nid
== ctx
->cipher
->nid
))
119 if (cipher
!= NULL
&& impl
== NULL
) {
120 /* Ask if an ENGINE is reserved for this job */
121 tmpimpl
= ENGINE_get_cipher_engine(cipher
->nid
);
126 * If there are engines involved then we should use legacy handling for now.
128 if (ctx
->engine
!= NULL
130 || tmpimpl
!= NULL
) {
131 if (ctx
->cipher
== ctx
->fetched_cipher
)
133 EVP_CIPHER_meth_free(ctx
->fetched_cipher
);
134 ctx
->fetched_cipher
= NULL
;
138 tmpcipher
= (cipher
== NULL
) ? ctx
->cipher
: cipher
;
140 if (tmpcipher
->prov
== NULL
) {
141 switch(tmpcipher
->nid
) {
142 case NID_aes_256_ecb
:
143 case NID_aes_192_ecb
:
144 case NID_aes_128_ecb
:
145 case NID_aes_256_cbc
:
146 case NID_aes_192_cbc
:
147 case NID_aes_128_cbc
:
148 case NID_aes_256_ofb128
:
149 case NID_aes_192_ofb128
:
150 case NID_aes_128_ofb128
:
151 case NID_aes_256_cfb128
:
152 case NID_aes_192_cfb128
:
153 case NID_aes_128_cfb128
:
154 case NID_aes_256_cfb1
:
155 case NID_aes_192_cfb1
:
156 case NID_aes_128_cfb1
:
157 case NID_aes_256_cfb8
:
158 case NID_aes_192_cfb8
:
159 case NID_aes_128_cfb8
:
160 case NID_aes_256_ctr
:
161 case NID_aes_192_ctr
:
162 case NID_aes_128_ctr
:
170 * Ensure a context left lying around from last time is cleared
173 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
174 OPENSSL_clear_free(ctx
->cipher_data
, ctx
->cipher
->ctx_size
);
175 ctx
->cipher_data
= NULL
;
179 /* TODO(3.0): Start of non-legacy code below */
181 /* Ensure a context left lying around from last time is cleared */
182 if (cipher
!= NULL
&& ctx
->cipher
!= NULL
) {
183 unsigned long flags
= ctx
->flags
;
185 EVP_CIPHER_CTX_reset(ctx
);
186 /* Restore encrypt and flags */
192 ctx
->cipher
= cipher
;
194 cipher
= ctx
->cipher
;
196 if (cipher
->prov
== NULL
) {
197 provciph
= EVP_CIPHER_fetch(NULL
, OBJ_nid2sn(cipher
->nid
), "");
198 if (provciph
== NULL
) {
199 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
203 EVP_CIPHER_meth_free(ctx
->fetched_cipher
);
204 ctx
->fetched_cipher
= provciph
;
207 ctx
->cipher
= cipher
;
208 if (ctx
->provctx
== NULL
) {
209 ctx
->provctx
= ctx
->cipher
->newctx();
210 if (ctx
->provctx
== NULL
) {
211 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
216 if ((ctx
->flags
& EVP_CIPH_NO_PADDING
) != 0) {
218 * If this ctx was already set up for no padding then we need to tell
219 * the new cipher about it.
221 if (!EVP_CIPHER_CTX_set_padding(ctx
, 0))
225 switch (EVP_CIPHER_mode(ctx
->cipher
)) {
226 case EVP_CIPH_CFB_MODE
:
227 case EVP_CIPH_OFB_MODE
:
228 case EVP_CIPH_CBC_MODE
:
229 /* For these modes we remember the original IV for later use */
230 if (!ossl_assert(EVP_CIPHER_CTX_iv_length(ctx
) <= (int)sizeof(ctx
->oiv
))) {
231 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
235 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
239 if (ctx
->cipher
->einit
== NULL
) {
240 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
244 return ctx
->cipher
->einit(ctx
->provctx
, key
, iv
);
247 if (ctx
->cipher
->dinit
== NULL
) {
248 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
252 return ctx
->cipher
->dinit(ctx
->provctx
, key
, iv
);
254 /* TODO(3.0): Remove legacy code below */
257 if (cipher
!= NULL
) {
259 * Ensure a context left lying around from last time is cleared (we
260 * previously attempted to avoid this if the same ENGINE and
261 * EVP_CIPHER could be used).
264 unsigned long flags
= ctx
->flags
;
265 EVP_CIPHER_CTX_reset(ctx
);
266 /* Restore encrypt and flags */
270 #ifndef OPENSSL_NO_ENGINE
272 if (!ENGINE_init(impl
)) {
273 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
280 /* There's an ENGINE for this job ... (apparently) */
281 const EVP_CIPHER
*c
= ENGINE_get_cipher(impl
, cipher
->nid
);
285 * One positive side-effect of US's export control history,
286 * is that we should at least be able to avoid using US
287 * misspellings of "initialisation"?
289 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
292 /* We'll use the ENGINE's private cipher definition */
295 * Store the ENGINE functional reference so we know 'cipher' came
296 * from an ENGINE and we need to release it when done.
304 ctx
->cipher
= cipher
;
305 if (ctx
->cipher
->ctx_size
) {
306 ctx
->cipher_data
= OPENSSL_zalloc(ctx
->cipher
->ctx_size
);
307 if (ctx
->cipher_data
== NULL
) {
309 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, ERR_R_MALLOC_FAILURE
);
313 ctx
->cipher_data
= NULL
;
315 ctx
->key_len
= cipher
->key_len
;
316 /* Preserve wrap enable flag, zero everything else */
317 ctx
->flags
&= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
;
318 if (ctx
->cipher
->flags
& EVP_CIPH_CTRL_INIT
) {
319 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_INIT
, 0, NULL
)) {
321 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
326 #ifndef OPENSSL_NO_ENGINE
329 /* we assume block size is a power of 2 in *cryptUpdate */
330 OPENSSL_assert(ctx
->cipher
->block_size
== 1
331 || ctx
->cipher
->block_size
== 8
332 || ctx
->cipher
->block_size
== 16);
334 if (!(ctx
->flags
& EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
)
335 && EVP_CIPHER_CTX_mode(ctx
) == EVP_CIPH_WRAP_MODE
) {
336 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_WRAP_MODE_NOT_ALLOWED
);
340 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx
)) & EVP_CIPH_CUSTOM_IV
)) {
341 switch (EVP_CIPHER_CTX_mode(ctx
)) {
343 case EVP_CIPH_STREAM_CIPHER
:
344 case EVP_CIPH_ECB_MODE
:
347 case EVP_CIPH_CFB_MODE
:
348 case EVP_CIPH_OFB_MODE
:
353 case EVP_CIPH_CBC_MODE
:
355 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx
) <=
356 (int)sizeof(ctx
->iv
));
358 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
359 memcpy(ctx
->iv
, ctx
->oiv
, EVP_CIPHER_CTX_iv_length(ctx
));
362 case EVP_CIPH_CTR_MODE
:
364 /* Don't reuse IV for CTR mode */
366 memcpy(ctx
->iv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
374 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
375 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
380 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
384 int EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
385 const unsigned char *in
, int inl
)
388 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
390 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
393 int EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
396 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
398 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
401 int EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
404 return EVP_EncryptFinal(ctx
, out
, outl
);
406 return EVP_DecryptFinal(ctx
, out
, outl
);
409 int EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
410 const unsigned char *key
, const unsigned char *iv
)
412 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
415 int EVP_EncryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
416 ENGINE
*impl
, const unsigned char *key
,
417 const unsigned char *iv
)
419 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
422 int EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
423 const unsigned char *key
, const unsigned char *iv
)
425 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
428 int EVP_DecryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
429 ENGINE
*impl
, const unsigned char *key
,
430 const unsigned char *iv
)
432 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
436 * According to the letter of standard difference between pointers
437 * is specified to be valid only within same object. This makes
438 * it formally challenging to determine if input and output buffers
439 * are not partially overlapping with standard pointer arithmetic.
444 #if defined(OPENSSL_SYS_VMS) && __INITIAL_POINTER_SIZE==64
446 * Then we have VMS that distinguishes itself by adhering to
447 * sizeof(size_t)==4 even in 64-bit builds, which means that
448 * difference between two pointers might be truncated to 32 bits.
449 * In the context one can even wonder how comparison for
450 * equality is implemented. To be on the safe side we adhere to
451 * PTRDIFF_T even for comparison for equality.
453 # define PTRDIFF_T uint64_t
455 # define PTRDIFF_T size_t
458 int is_partially_overlapping(const void *ptr1
, const void *ptr2
, int len
)
460 PTRDIFF_T diff
= (PTRDIFF_T
)ptr1
-(PTRDIFF_T
)ptr2
;
462 * Check for partially overlapping buffers. [Binary logical
463 * operations are used instead of boolean to minimize number
464 * of conditional branches.]
466 int overlapped
= (len
> 0) & (diff
!= 0) & ((diff
< (PTRDIFF_T
)len
) |
467 (diff
> (0 - (PTRDIFF_T
)len
)));
472 static int evp_EncryptDecryptUpdate(EVP_CIPHER_CTX
*ctx
,
473 unsigned char *out
, int *outl
,
474 const unsigned char *in
, int inl
)
476 int i
, j
, bl
, cmpl
= inl
;
478 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
479 cmpl
= (cmpl
+ 7) / 8;
481 bl
= ctx
->cipher
->block_size
;
488 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
489 /* If block size > 1 then the cipher will have to do this check */
490 if (bl
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
491 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
495 i
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
503 if (is_partially_overlapping(out
+ ctx
->buf_len
, in
, cmpl
)) {
504 EVPerr(EVP_F_EVP_ENCRYPTDECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
508 if (ctx
->buf_len
== 0 && (inl
& (ctx
->block_mask
)) == 0) {
509 if (ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
)) {
518 OPENSSL_assert(bl
<= (int)sizeof(ctx
->buf
));
521 memcpy(&(ctx
->buf
[i
]), in
, inl
);
527 memcpy(&(ctx
->buf
[i
]), in
, j
);
530 if (!ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, bl
))
540 if (!ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
))
546 memcpy(ctx
->buf
, &(in
[inl
]), i
);
552 int EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
553 const unsigned char *in
, int inl
)
558 /* Prevent accidental use of decryption context when encrypting */
560 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
564 if (ctx
->cipher
== NULL
|| ctx
->cipher
->prov
== NULL
)
567 if (ctx
->cipher
->cupdate
== NULL
) {
568 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
571 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
, in
, (size_t)inl
);
573 if (soutl
> INT_MAX
) {
574 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
580 /* TODO(3.0): Remove legacy code below */
583 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
586 int EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
589 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
593 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
596 unsigned int i
, b
, bl
;
599 /* Prevent accidental use of decryption context when encrypting */
601 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
605 if (ctx
->cipher
== NULL
|| ctx
->cipher
->prov
== NULL
)
608 if (ctx
->cipher
->cfinal
== NULL
) {
609 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
613 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
);
615 if (soutl
> INT_MAX
) {
616 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
623 /* TODO(3.0): Remove legacy code below */
626 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
627 ret
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
635 b
= ctx
->cipher
->block_size
;
636 OPENSSL_assert(b
<= sizeof(ctx
->buf
));
642 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
644 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
645 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
653 for (i
= bl
; i
< b
; i
++)
655 ret
= ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, b
);
663 int EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
664 const unsigned char *in
, int inl
)
666 int fix_len
, cmpl
= inl
, ret
;
670 /* Prevent accidental use of encryption context when decrypting */
672 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_INVALID_OPERATION
);
676 if (ctx
->cipher
== NULL
|| ctx
->cipher
->prov
== NULL
)
679 if (ctx
->cipher
->cupdate
== NULL
) {
680 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
683 ret
= ctx
->cipher
->cupdate(ctx
->provctx
, out
, &soutl
, in
, (size_t)inl
);
686 if (soutl
> INT_MAX
) {
687 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_UPDATE_ERROR
);
695 /* TODO(3.0): Remove legacy code below */
698 b
= ctx
->cipher
->block_size
;
700 if (EVP_CIPHER_CTX_test_flags(ctx
, EVP_CIPH_FLAG_LENGTH_BITS
))
701 cmpl
= (cmpl
+ 7) / 8;
708 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
709 if (b
== 1 && is_partially_overlapping(out
, in
, cmpl
)) {
710 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
714 fix_len
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
723 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
724 return evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
);
726 OPENSSL_assert(b
<= sizeof(ctx
->final
));
728 if (ctx
->final_used
) {
729 /* see comment about PTRDIFF_T comparison above */
730 if (((PTRDIFF_T
)out
== (PTRDIFF_T
)in
)
731 || is_partially_overlapping(out
, in
, b
)) {
732 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_PARTIALLY_OVERLAPPING
);
735 memcpy(out
, ctx
->final
, b
);
741 if (!evp_EncryptDecryptUpdate(ctx
, out
, outl
, in
, inl
))
745 * if we have 'decrypted' a multiple of block size, make sure we have a
746 * copy of this last block
748 if (b
> 1 && !ctx
->buf_len
) {
751 memcpy(ctx
->final
, &out
[*outl
], b
);
761 int EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
764 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
768 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
775 /* Prevent accidental use of encryption context when decrypting */
777 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_INVALID_OPERATION
);
781 if (ctx
->cipher
== NULL
|| ctx
->cipher
->prov
== NULL
)
784 if (ctx
->cipher
->cfinal
== NULL
) {
785 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
789 ret
= ctx
->cipher
->cfinal(ctx
->provctx
, out
, &soutl
);
792 if (soutl
> INT_MAX
) {
793 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_FINAL_ERROR
);
801 /* TODO(3.0): Remove legacy code below */
806 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
807 i
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
815 b
= ctx
->cipher
->block_size
;
816 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
818 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
819 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
826 if (ctx
->buf_len
|| !ctx
->final_used
) {
827 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
830 OPENSSL_assert(b
<= sizeof(ctx
->final
));
833 * The following assumes that the ciphertext has been authenticated.
834 * Otherwise it provides a padding oracle.
836 n
= ctx
->final
[b
- 1];
837 if (n
== 0 || n
> (int)b
) {
838 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
841 for (i
= 0; i
< n
; i
++) {
842 if (ctx
->final
[--b
] != n
) {
843 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
847 n
= ctx
->cipher
->block_size
- n
;
848 for (i
= 0; i
< n
; i
++)
849 out
[i
] = ctx
->final
[i
];
856 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
858 if (c
->cipher
->flags
& EVP_CIPH_CUSTOM_KEY_LENGTH
)
859 return EVP_CIPHER_CTX_ctrl(c
, EVP_CTRL_SET_KEY_LENGTH
, keylen
, NULL
);
860 if (EVP_CIPHER_CTX_key_length(c
) == keylen
)
862 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
866 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
870 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
873 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
875 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
877 if (ctx
->cipher
!= NULL
&& ctx
->cipher
->prov
!= NULL
) {
878 OSSL_PARAM params
[] = {
879 OSSL_PARAM_int(OSSL_CIPHER_PARAM_PADDING
, NULL
),
883 params
[0].data
= &pad
;
885 if (ctx
->cipher
->ctx_set_params
== NULL
) {
886 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_PADDING
, EVP_R_CTRL_NOT_IMPLEMENTED
);
890 if (!ctx
->cipher
->ctx_set_params(ctx
->provctx
, params
))
897 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
902 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
906 if (!ctx
->cipher
->ctrl
) {
907 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
911 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
913 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
914 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
920 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
922 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
923 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
924 if (RAND_priv_bytes(key
, ctx
->key_len
) <= 0)
929 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
931 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
932 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
936 if (in
->cipher
->prov
== NULL
)
939 if (in
->cipher
->dupctx
== NULL
) {
940 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
944 EVP_CIPHER_CTX_reset(out
);
949 if (in
->fetched_cipher
!= NULL
&& !EVP_CIPHER_upref(in
->fetched_cipher
)) {
950 out
->fetched_cipher
= NULL
;
954 out
->provctx
= in
->cipher
->dupctx(in
->provctx
);
955 if (out
->provctx
== NULL
) {
956 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_NOT_ABLE_TO_COPY_CTX
);
962 /* TODO(3.0): Remove legacy code below */
965 #ifndef OPENSSL_NO_ENGINE
966 /* Make sure it's safe to copy a cipher context using an ENGINE */
967 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
968 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
973 EVP_CIPHER_CTX_reset(out
);
974 memcpy(out
, in
, sizeof(*out
));
976 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
977 out
->cipher_data
= OPENSSL_malloc(in
->cipher
->ctx_size
);
978 if (out
->cipher_data
== NULL
) {
980 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
983 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
986 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
987 if (!in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
, EVP_CTRL_COPY
, 0, out
)) {
989 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INITIALIZATION_ERROR
);
995 static void *evp_cipher_from_dispatch(int nid
, const OSSL_DISPATCH
*fns
,
998 EVP_CIPHER
*cipher
= NULL
;
999 int fnciphcnt
= 0, fnctxcnt
= 0;
1001 if ((cipher
= EVP_CIPHER_meth_new(nid
, 0, 0)) == NULL
)
1004 for (; fns
->function_id
!= 0; fns
++) {
1005 switch (fns
->function_id
) {
1006 case OSSL_FUNC_CIPHER_NEWCTX
:
1007 if (cipher
->newctx
!= NULL
)
1009 cipher
->newctx
= OSSL_get_OP_cipher_newctx(fns
);
1012 case OSSL_FUNC_CIPHER_ENCRYPT_INIT
:
1013 if (cipher
->einit
!= NULL
)
1015 cipher
->einit
= OSSL_get_OP_cipher_encrypt_init(fns
);
1018 case OSSL_FUNC_CIPHER_DECRYPT_INIT
:
1019 if (cipher
->dinit
!= NULL
)
1021 cipher
->dinit
= OSSL_get_OP_cipher_decrypt_init(fns
);
1024 case OSSL_FUNC_CIPHER_UPDATE
:
1025 if (cipher
->cupdate
!= NULL
)
1027 cipher
->cupdate
= OSSL_get_OP_cipher_update(fns
);
1030 case OSSL_FUNC_CIPHER_FINAL
:
1031 if (cipher
->cfinal
!= NULL
)
1033 cipher
->cfinal
= OSSL_get_OP_cipher_final(fns
);
1036 case OSSL_FUNC_CIPHER_CIPHER
:
1037 if (cipher
->ccipher
!= NULL
)
1039 cipher
->ccipher
= OSSL_get_OP_cipher_cipher(fns
);
1041 case OSSL_FUNC_CIPHER_FREECTX
:
1042 if (cipher
->freectx
!= NULL
)
1044 cipher
->freectx
= OSSL_get_OP_cipher_freectx(fns
);
1047 case OSSL_FUNC_CIPHER_DUPCTX
:
1048 if (cipher
->dupctx
!= NULL
)
1050 cipher
->dupctx
= OSSL_get_OP_cipher_dupctx(fns
);
1052 case OSSL_FUNC_CIPHER_KEY_LENGTH
:
1053 if (cipher
->key_length
!= NULL
)
1055 cipher
->key_length
= OSSL_get_OP_cipher_key_length(fns
);
1057 case OSSL_FUNC_CIPHER_IV_LENGTH
:
1058 if (cipher
->iv_length
!= NULL
)
1060 cipher
->iv_length
= OSSL_get_OP_cipher_iv_length(fns
);
1062 case OSSL_FUNC_CIPHER_BLOCK_SIZE
:
1063 if (cipher
->blocksize
!= NULL
)
1065 cipher
->blocksize
= OSSL_get_OP_cipher_block_size(fns
);
1067 case OSSL_FUNC_CIPHER_GET_PARAMS
:
1068 if (cipher
->get_params
!= NULL
)
1070 cipher
->get_params
= OSSL_get_OP_cipher_get_params(fns
);
1072 case OSSL_FUNC_CIPHER_CTX_GET_PARAMS
:
1073 if (cipher
->ctx_get_params
!= NULL
)
1075 cipher
->ctx_get_params
= OSSL_get_OP_cipher_ctx_get_params(fns
);
1077 case OSSL_FUNC_CIPHER_CTX_SET_PARAMS
:
1078 if (cipher
->ctx_set_params
!= NULL
)
1080 cipher
->ctx_set_params
= OSSL_get_OP_cipher_ctx_set_params(fns
);
1084 if ((fnciphcnt
!= 0 && fnciphcnt
!= 3 && fnciphcnt
!= 4)
1085 || (fnciphcnt
== 0 && cipher
->ccipher
== NULL
)
1088 * In order to be a consistent set of functions we must have at least
1089 * a complete set of "encrypt" functions, or a complete set of "decrypt"
1090 * functions, or a single "cipher" function. In all cases we need a
1091 * complete set of context management functions
1093 EVP_CIPHER_meth_free(cipher
);
1094 EVPerr(EVP_F_EVP_CIPHER_FROM_DISPATCH
, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
1097 cipher
->prov
= prov
;
1099 ossl_provider_upref(prov
);
1104 static int evp_cipher_upref(void *cipher
)
1106 return EVP_CIPHER_upref(cipher
);
1109 static void evp_cipher_free(void *cipher
)
1111 EVP_CIPHER_meth_free(cipher
);
1114 static int evp_cipher_nid(void *vcipher
)
1116 EVP_CIPHER
*cipher
= vcipher
;
1121 EVP_CIPHER
*EVP_CIPHER_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
1122 const char *properties
)
1124 return evp_generic_fetch(ctx
, OSSL_OP_CIPHER
, algorithm
, properties
,
1125 evp_cipher_from_dispatch
, evp_cipher_upref
,
1126 evp_cipher_free
, evp_cipher_nid
);