1 /* $OpenBSD: evp_enc.c,v 1.30 2016/05/04 15:05:13 tedu Exp $ */
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.]
63 #include <openssl/opensslconf.h>
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
68 #ifndef OPENSSL_NO_ENGINE
69 #include <openssl/engine.h>
74 #define M_do_cipher(ctx, out, in, inl) ctx->cipher->do_cipher(ctx, out, in, inl)
77 EVP_CIPHER_CTX_init(EVP_CIPHER_CTX
*ctx
)
79 memset(ctx
, 0, sizeof(EVP_CIPHER_CTX
));
83 EVP_CIPHER_CTX_new(void)
85 return calloc(1, sizeof(EVP_CIPHER_CTX
));
89 EVP_CipherInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
90 const unsigned char *key
, const unsigned char *iv
, int enc
)
93 EVP_CIPHER_CTX_init(ctx
);
94 return EVP_CipherInit_ex(ctx
, cipher
, NULL
, key
, iv
, enc
);
98 EVP_CipherInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
, ENGINE
*impl
,
99 const unsigned char *key
, const unsigned char *iv
, int enc
)
108 #ifndef OPENSSL_NO_ENGINE
109 /* Whether it's nice or not, "Inits" can be used on "Final"'d contexts
110 * so this context may already have an ENGINE! Try to avoid releasing
111 * the previous handle, re-querying for an ENGINE, and having a
112 * reinitialisation, when it may all be unecessary. */
113 if (ctx
->engine
&& ctx
->cipher
&&
114 (!cipher
|| (cipher
&& (cipher
->nid
== ctx
->cipher
->nid
))))
118 /* Ensure a context left lying around from last time is cleared
119 * (the previous check attempted to avoid this if the same
120 * ENGINE and EVP_CIPHER could be used). */
122 unsigned long flags
= ctx
->flags
;
123 EVP_CIPHER_CTX_cleanup(ctx
);
124 /* Restore encrypt and flags */
128 #ifndef OPENSSL_NO_ENGINE
130 if (!ENGINE_init(impl
)) {
131 EVPerr(EVP_F_EVP_CIPHERINIT_EX
,
132 EVP_R_INITIALIZATION_ERROR
);
136 /* Ask if an ENGINE is reserved for this job */
137 impl
= ENGINE_get_cipher_engine(cipher
->nid
);
139 /* There's an ENGINE for this job ... (apparently) */
140 const EVP_CIPHER
*c
=
141 ENGINE_get_cipher(impl
, cipher
->nid
);
143 EVPerr(EVP_F_EVP_CIPHERINIT_EX
,
144 EVP_R_INITIALIZATION_ERROR
);
147 /* We'll use the ENGINE's private cipher definition */
149 /* Store the ENGINE functional reference so we know
150 * 'cipher' came from an ENGINE and we need to release
157 ctx
->cipher
= cipher
;
158 if (ctx
->cipher
->ctx_size
) {
159 ctx
->cipher_data
= malloc(ctx
->cipher
->ctx_size
);
160 if (!ctx
->cipher_data
) {
161 EVPerr(EVP_F_EVP_CIPHERINIT_EX
,
162 ERR_R_MALLOC_FAILURE
);
166 ctx
->cipher_data
= NULL
;
168 ctx
->key_len
= cipher
->key_len
;
170 if (ctx
->cipher
->flags
& EVP_CIPH_CTRL_INIT
) {
171 if (!EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_INIT
, 0, NULL
)) {
172 EVPerr(EVP_F_EVP_CIPHERINIT_EX
,
173 EVP_R_INITIALIZATION_ERROR
);
177 } else if (!ctx
->cipher
) {
178 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_NO_CIPHER_SET
);
181 #ifndef OPENSSL_NO_ENGINE
184 /* we assume block size is a power of 2 in *cryptUpdate */
185 if (ctx
->cipher
->block_size
!= 1 &&
186 ctx
->cipher
->block_size
!= 8 &&
187 ctx
->cipher
->block_size
!= 16) {
188 EVPerr(EVP_F_EVP_CIPHERINIT_EX
, EVP_R_BAD_BLOCK_LENGTH
);
192 if (!(EVP_CIPHER_CTX_flags(ctx
) & EVP_CIPH_CUSTOM_IV
)) {
193 switch (EVP_CIPHER_CTX_mode(ctx
)) {
195 case EVP_CIPH_STREAM_CIPHER
:
196 case EVP_CIPH_ECB_MODE
:
199 case EVP_CIPH_CFB_MODE
:
200 case EVP_CIPH_OFB_MODE
:
205 case EVP_CIPH_CBC_MODE
:
207 if ((size_t)EVP_CIPHER_CTX_iv_length(ctx
) >
209 EVPerr(EVP_F_EVP_CIPHERINIT_EX
,
215 EVP_CIPHER_CTX_iv_length(ctx
));
216 memcpy(ctx
->iv
, ctx
->oiv
,
217 EVP_CIPHER_CTX_iv_length(ctx
));
220 case EVP_CIPH_CTR_MODE
:
222 /* Don't reuse IV for CTR mode */
225 EVP_CIPHER_CTX_iv_length(ctx
));
234 if (key
|| (ctx
->cipher
->flags
& EVP_CIPH_ALWAYS_CALL_INIT
)) {
235 if (!ctx
->cipher
->init(ctx
, key
, iv
, enc
))
240 ctx
->block_mask
= ctx
->cipher
->block_size
- 1;
245 EVP_CipherUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
246 const unsigned char *in
, int inl
)
249 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
251 return EVP_DecryptUpdate(ctx
, out
, outl
, in
, inl
);
255 EVP_CipherFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
258 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
260 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
264 EVP_CipherFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
267 return EVP_EncryptFinal_ex(ctx
, out
, outl
);
269 return EVP_DecryptFinal_ex(ctx
, out
, outl
);
273 EVP_EncryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
274 const unsigned char *key
, const unsigned char *iv
)
276 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 1);
280 EVP_EncryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
, ENGINE
*impl
,
281 const unsigned char *key
, const unsigned char *iv
)
283 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 1);
287 EVP_DecryptInit(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
288 const unsigned char *key
, const unsigned char *iv
)
290 return EVP_CipherInit(ctx
, cipher
, key
, iv
, 0);
294 EVP_DecryptInit_ex(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
, ENGINE
*impl
,
295 const unsigned char *key
, const unsigned char *iv
)
297 return EVP_CipherInit_ex(ctx
, cipher
, impl
, key
, iv
, 0);
301 EVP_EncryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
302 const unsigned char *in
, int inl
)
306 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
307 i
= M_do_cipher(ctx
, out
, in
, inl
);
320 if (ctx
->buf_len
== 0 && (inl
&(ctx
->block_mask
)) == 0) {
321 if (M_do_cipher(ctx
, out
, in
, inl
)) {
330 bl
= ctx
->cipher
->block_size
;
331 if ((size_t)bl
> sizeof(ctx
->buf
)) {
332 EVPerr(EVP_F_EVP_ENCRYPTUPDATE
, EVP_R_BAD_BLOCK_LENGTH
);
338 memcpy(&(ctx
->buf
[i
]), in
, inl
);
344 memcpy(&(ctx
->buf
[i
]), in
, j
);
345 if (!M_do_cipher(ctx
, out
, ctx
->buf
, bl
))
357 if (!M_do_cipher(ctx
, out
, in
, inl
))
363 memcpy(ctx
->buf
, &(in
[inl
]), i
);
369 EVP_EncryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
373 ret
= EVP_EncryptFinal_ex(ctx
, out
, outl
);
374 (void) EVP_CIPHER_CTX_cleanup(ctx
);
379 EVP_EncryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
382 unsigned int i
, b
, bl
;
384 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
385 ret
= M_do_cipher(ctx
, out
, NULL
, 0);
393 b
= ctx
->cipher
->block_size
;
394 if (b
> sizeof ctx
->buf
) {
395 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
, EVP_R_BAD_BLOCK_LENGTH
);
403 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
405 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX
,
406 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
414 for (i
= bl
; i
< b
; i
++)
416 ret
= M_do_cipher(ctx
, out
, ctx
->buf
, b
);
426 EVP_DecryptUpdate(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
,
427 const unsigned char *in
, int inl
)
432 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
433 fix_len
= M_do_cipher(ctx
, out
, in
, inl
);
447 if (ctx
->flags
& EVP_CIPH_NO_PADDING
)
448 return EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
);
450 b
= ctx
->cipher
->block_size
;
451 if (b
> sizeof ctx
->final
) {
452 EVPerr(EVP_F_EVP_DECRYPTUPDATE
, EVP_R_BAD_BLOCK_LENGTH
);
456 if (ctx
->final_used
) {
457 memcpy(out
, ctx
->final
, b
);
464 if (!EVP_EncryptUpdate(ctx
, out
, outl
, in
, inl
))
467 /* if we have 'decrypted' a multiple of block size, make sure
468 * we have a copy of this last block */
469 if (b
> 1 && !ctx
->buf_len
) {
472 memcpy(ctx
->final
, &out
[*outl
], b
);
483 EVP_DecryptFinal(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
487 ret
= EVP_DecryptFinal_ex(ctx
, out
, outl
);
488 (void) EVP_CIPHER_CTX_cleanup(ctx
);
493 EVP_DecryptFinal_ex(EVP_CIPHER_CTX
*ctx
, unsigned char *out
, int *outl
)
499 if (ctx
->cipher
->flags
& EVP_CIPH_FLAG_CUSTOM_CIPHER
) {
500 i
= M_do_cipher(ctx
, out
, NULL
, 0);
508 b
= ctx
->cipher
->block_size
;
509 if (ctx
->flags
& EVP_CIPH_NO_PADDING
) {
511 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
512 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH
);
519 if (ctx
->buf_len
|| !ctx
->final_used
) {
520 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
521 EVP_R_WRONG_FINAL_BLOCK_LENGTH
);
524 if (b
> sizeof ctx
->final
) {
525 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
526 EVP_R_BAD_BLOCK_LENGTH
);
529 n
= ctx
->final
[b
- 1];
530 if (n
== 0 || n
> (int)b
) {
531 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
, EVP_R_BAD_DECRYPT
);
534 for (i
= 0; i
< n
; i
++) {
535 if (ctx
->final
[--b
] != n
) {
536 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX
,
541 n
= ctx
->cipher
->block_size
- n
;
542 for (i
= 0; i
< n
; i
++)
543 out
[i
] = ctx
->final
[i
];
551 EVP_CIPHER_CTX_free(EVP_CIPHER_CTX
*ctx
)
554 EVP_CIPHER_CTX_cleanup(ctx
);
560 EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX
*c
)
562 if (c
->cipher
!= NULL
) {
563 if (c
->cipher
->cleanup
&& !c
->cipher
->cleanup(c
))
565 /* Cleanse cipher context data */
567 explicit_bzero(c
->cipher_data
, c
->cipher
->ctx_size
);
569 free(c
->cipher_data
);
570 #ifndef OPENSSL_NO_ENGINE
572 /* The EVP_CIPHER we used belongs to an ENGINE, release the
573 * functional reference we held for this reason. */
574 ENGINE_finish(c
->engine
);
576 explicit_bzero(c
, sizeof(EVP_CIPHER_CTX
));
581 EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX
*c
, int keylen
)
583 if (c
->cipher
->flags
& EVP_CIPH_CUSTOM_KEY_LENGTH
)
584 return EVP_CIPHER_CTX_ctrl(c
, EVP_CTRL_SET_KEY_LENGTH
,
586 if (c
->key_len
== keylen
)
588 if ((keylen
> 0) && (c
->cipher
->flags
& EVP_CIPH_VARIABLE_LENGTH
)) {
592 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH
, EVP_R_INVALID_KEY_LENGTH
);
597 EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX
*ctx
, int pad
)
600 ctx
->flags
&= ~EVP_CIPH_NO_PADDING
;
602 ctx
->flags
|= EVP_CIPH_NO_PADDING
;
607 EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX
*ctx
, int type
, int arg
, void *ptr
)
612 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_NO_CIPHER_SET
);
616 if (!ctx
->cipher
->ctrl
) {
617 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
, EVP_R_CTRL_NOT_IMPLEMENTED
);
621 ret
= ctx
->cipher
->ctrl(ctx
, type
, arg
, ptr
);
623 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL
,
624 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED
);
631 EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX
*ctx
, unsigned char *key
)
633 if (ctx
->cipher
->flags
& EVP_CIPH_RAND_KEY
)
634 return EVP_CIPHER_CTX_ctrl(ctx
, EVP_CTRL_RAND_KEY
, 0, key
);
635 arc4random_buf(key
, ctx
->key_len
);
640 EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX
*out
, const EVP_CIPHER_CTX
*in
)
642 if ((in
== NULL
) || (in
->cipher
== NULL
)) {
643 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, EVP_R_INPUT_NOT_INITIALIZED
);
646 #ifndef OPENSSL_NO_ENGINE
647 /* Make sure it's safe to copy a cipher context using an ENGINE */
648 if (in
->engine
&& !ENGINE_init(in
->engine
)) {
649 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_ENGINE_LIB
);
654 EVP_CIPHER_CTX_cleanup(out
);
655 memcpy(out
, in
, sizeof *out
);
657 if (in
->cipher_data
&& in
->cipher
->ctx_size
) {
658 out
->cipher_data
= malloc(in
->cipher
->ctx_size
);
659 if (!out
->cipher_data
) {
660 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY
, ERR_R_MALLOC_FAILURE
);
663 memcpy(out
->cipher_data
, in
->cipher_data
, in
->cipher
->ctx_size
);
666 if (in
->cipher
->flags
& EVP_CIPH_CUSTOM_COPY
)
667 return in
->cipher
->ctrl((EVP_CIPHER_CTX
*)in
,
668 EVP_CTRL_COPY
, 0, out
);