1 /* crypto/evp/evp_enc.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 #include "internal/cryptlib.h"
61 #include <openssl/evp.h>
62 #include <openssl/err.h>
63 #include <openssl/rand.h>
64 #ifndef OPENSSL_NO_ENGINE
65 # include <openssl/engine.h>
69 void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX
*ctx
)
71 memset(ctx
, 0, sizeof(*ctx
));
74 EVP_CIPHER_CTX
*EVP_CIPHER_CTX_new(void)
76 EVP_CIPHER_CTX
*ctx
= OPENSSL_malloc(sizeof(*ctx
));
78 EVP_CIPHER_CTX_init(ctx
);
82 int EVP_CipherInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
83 const unsigned char *key
, const unsigned char *iv
, int enc
)
86 EVP_CIPHER_CTX_init(ctx
);
87 return EVP_CipherInit_ex(ctx
, cipher
, NULL
, key
, iv
, enc
);
90 int EVP_CipherInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
91 ENGINE
*impl
, const unsigned char *key
,
92 const unsigned char *iv
, int enc
)
101 #ifndef OPENSSL_NO_ENGINE
103 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
104 * this context may already have an ENGINE! Try to avoid releasing the
105 * previous handle, re-querying for an ENGINE, and having a
106 * reinitialisation, when it may all be unecessary.
108 if (ctx
->engine
&& ctx
->cipher
&& (!cipher
||
116 * Ensure a context left lying around from last time is cleared (the
117 * previous check attempted to avoid this if the same ENGINE and
118 * EVP_CIPHER could be used).
121 unsigned long flags
= ctx
->flags
;
122 EVP_CIPHER_CTX_cleanup(ctx
);
123 /* Restore encrypt and flags */
127 #ifndef OPENSSL_NO_ENGINE
129 if (!ENGINE_init(impl
)) {
130 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
134 /* Ask if an ENGINE is reserved for this job */
135 impl
= ENGINE_get_cipher_engine(cipher
->nid
);
137 /* There's an ENGINE for this job ... (apparently) */
138 const EVP_CIPHER
*c
= ENGINE_get_cipher(impl
, cipher
->nid
);
141 * One positive side-effect of US's export control history,
142 * is that we should at least be able to avoid using US
143 * mispellings of "initialisation"?
145 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
148 /* We'll use the ENGINE's private cipher definition */
151 * Store the ENGINE functional reference so we know 'cipher' came
152 * from an ENGINE and we need to release it when done.
159 ctx
->cipher
= cipher
;
160 if (ctx
->cipher
->ctx_size
) {
161 ctx
->cipher_data
= OPENSSL_zalloc(ctx
->cipher
->ctx_size
);
162 if (!ctx
->cipher_data
) {
163 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, ERR_R_MALLOC_FAILURE
);
167 ctx
->cipher_data
= NULL
;
169 ctx
->key_len
= cipher
->key_len
;
170 /* Preserve wrap enable flag, zero everything else */
171 ctx
->flags
&= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
;
172 if (ctx
->cipher
->flags
& EVP_CIPH_CTRL_INIT
) {
173 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_INIT
, 0, NULL
)) {
174 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_INITIALIZATION_ERROR
);
178 } else if (!ctx
->cipher
) {
179 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_NO_CIPHER_SET
);
182 #ifndef OPENSSL_NO_ENGINE
185 /* we assume block size is a power of 2 in *cryptUpdate */
186 OPENSSL_assert(ctx
->cipher
->block_size
== 1
187 || ctx
->cipher
->block_size
== 8
188 || ctx
->cipher
->block_size
== 16);
190 if (!(ctx
->flags
& EVP_CIPHER_CTX_FLAG_WRAP_ALLOW
)
191 && EVP_CIPHER_CTX_mode(ctx
) == EVP_CIPH_WRAP_MODE
) {
192 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_WRAP_MODE_NOT_ALLOWED
);
196 if (!(EVP_CIPHER_CTX_flags(ctx
) & EVP_CIPH_CUSTOM_IV
)) {
197 switch (EVP_CIPHER_CTX_mode(ctx
)) {
199 case EVP_CIPH_STREAM_CIPHER
:
200 case EVP_CIPH_ECB_MODE
:
203 case EVP_CIPH_CFB_MODE
:
204 case EVP_CIPH_OFB_MODE
:
209 case EVP_CIPH_CBC_MODE
:
211 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx
) <=
212 (int)sizeof(ctx
->iv
));
214 memcpy(ctx
->oiv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
215 memcpy(ctx
->iv
, ctx
->oiv
, EVP_CIPHER_CTX_iv_length(ctx
));
218 case EVP_CIPH_CTR_MODE
:
220 /* Don't reuse IV for CTR mode */
222 memcpy(ctx
->iv
, iv
, EVP_CIPHER_CTX_iv_length(ctx
));
230 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
231 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
236 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
240 int EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
241 const unsigned char *in
, int inl
)
244 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
246 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
249 int EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
252 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
254 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
257 int EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
260 return EVP_EncryptFinal(ctx
, out
, outl
);
262 return EVP_DecryptFinal(ctx
, out
, outl
);
265 int EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
266 const unsigned char *key
, const unsigned char *iv
)
268 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
271 int EVP_EncryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
272 ENGINE
*impl
, const unsigned char *key
,
273 const unsigned char *iv
)
275 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
278 int EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
279 const unsigned char *key
, const unsigned char *iv
)
281 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
284 int EVP_DecryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
285 ENGINE
*impl
, const unsigned char *key
,
286 const unsigned char *iv
)
288 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
291 int EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
292 const unsigned char *in
, int inl
)
296 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
297 i
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
310 if (ctx
->buf_len
== 0 && (inl
& (ctx
->block_mask
)) == 0) {
311 if (ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
)) {
320 bl
= ctx
->cipher
->block_size
;
321 OPENSSL_assert(bl
<= (int)sizeof(ctx
->buf
));
324 memcpy(&(ctx
->buf
[i
]), in
, inl
);
330 memcpy(&(ctx
->buf
[i
]), in
, j
);
331 if (!ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, bl
))
343 if (!ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
))
349 memcpy(ctx
->buf
, &(in
[inl
]), i
);
354 int EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
357 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
361 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
364 unsigned int i
, b
, bl
;
366 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
367 ret
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
375 b
= ctx
->cipher
->block_size
;
376 OPENSSL_assert(b
<= sizeof ctx
->buf
);
382 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
384 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
385 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
393 for (i
= bl
; i
< b
; i
++)
395 ret
= ctx
->cipher
->do_cipher(ctx
, out
, ctx
->buf
, b
);
403 int EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
404 const unsigned char *in
, int inl
)
409 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
410 fix_len
= ctx
->cipher
->do_cipher(ctx
, out
, in
, inl
);
424 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
425 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
427 b
= ctx
->cipher
->block_size
;
428 OPENSSL_assert(b
<= sizeof ctx
->final
);
430 if (ctx
->final_used
) {
431 memcpy(out
, ctx
->final
, b
);
437 if (!EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
))
441 * if we have 'decrypted' a multiple of block size, make sure we have a
442 * copy of this last block
444 if (b
> 1 && !ctx
->buf_len
) {
447 memcpy(ctx
->final
, &out
[*outl
], b
);
457 int EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
460 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
464 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
470 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
471 i
= ctx
->cipher
->do_cipher(ctx
, out
, NULL
, 0);
479 b
= ctx
->cipher
->block_size
;
480 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
482 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
483 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
490 if (ctx
->buf_len
|| !ctx
->final_used
) {
491 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
494 OPENSSL_assert(b
<= sizeof ctx
->final
);
497 * The following assumes that the ciphertext has been authenticated.
498 * Otherwise it provides a padding oracle.
500 n
= ctx
->final
[b
- 1];
501 if (n
== 0 || n
> (int)b
) {
502 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
505 for (i
= 0; i
< n
; i
++) {
506 if (ctx
->final
[--b
] != n
) {
507 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
511 n
= ctx
->cipher
->block_size
- n
;
512 for (i
= 0; i
< n
; i
++)
513 out
[i
] = ctx
->final
[i
];
520 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX
*ctx
)
522 EVP_CIPHER_CTX_cleanup(ctx
);
526 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX
*c
)
530 if (c
->cipher
!= NULL
) {
531 if (c
->cipher
->cleanup
&& !c
->cipher
->cleanup(c
))
533 /* Cleanse cipher context data */
535 OPENSSL_cleanse(c
->cipher_data
, c
->cipher
->ctx_size
);
537 OPENSSL_free(c
->cipher_data
);
538 #ifndef OPENSSL_NO_ENGINE
541 * The EVP_CIPHER we used belongs to an ENGINE, release the
542 * functional reference we held for this reason.
544 ENGINE_finish(c
->engine
);
546 memset(c
, 0, sizeof(*c
));
550 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
552 if (c
->cipher
->flags
& EVP_CIPH_CUSTOM_KEY_LENGTH
)
553 return EVP_CIPHER_CTX_ctrl(c
, EVP_CTRL_SET_KEY_LENGTH
, keylen
, NULL
);
554 if (c
->key_len
== keylen
)
556 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
560 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
564 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
567 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
569 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
573 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
577 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
581 if (!ctx
->cipher
->ctrl
) {
582 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
586 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
588 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
589 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
595 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
597 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
598 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
599 if (RAND_bytes(key
, ctx
->key_len
) <= 0)
604 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
606 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
607 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
610 #ifndef OPENSSL_NO_ENGINE
611 /* Make sure it's safe to copy a cipher context using an ENGINE */
612 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
613 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
618 EVP_CIPHER_CTX_cleanup(out
);
619 memcpy(out
, in
, sizeof(*out
));
621 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
622 out
->cipher_data
= OPENSSL_malloc(in
->cipher
->ctx_size
);
623 if (!out
->cipher_data
) {
624 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
627 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
630 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
631 return in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
, EVP_CTRL_COPY
, 0, out
);