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
109 && (!cipher || (cipher && (cipher->nid == ctx->cipher->nid))))
114 * Ensure a context left lying around from last time is cleared (the
115 * previous check attempted to avoid this if the same ENGINE and
116 * EVP_CIPHER could be used).
119 unsigned long flags = ctx->flags;
120 EVP_CIPHER_CTX_cleanup(ctx);
121 /* Restore encrypt and flags */
125 #ifndef OPENSSL_NO_ENGINE
127 if (!ENGINE_init(impl)) {
128 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
132 /* Ask if an ENGINE is reserved for this job */
133 impl = ENGINE_get_cipher_engine(cipher->nid);
135 /* There's an ENGINE for this job ... (apparently) */
136 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
139 * One positive side-effect of US's export control history,
140 * is that we should at least be able to avoid using US
141 * mispellings of "initialisation"?
143 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
146 /* We'll use the ENGINE's private cipher definition */
149 * Store the ENGINE functional reference so we know 'cipher' came
150 * from an ENGINE and we need to release it when done.
157 ctx->cipher = cipher;
158 if (ctx->cipher->ctx_size) {
159 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
160 if (ctx->cipher_data == NULL) {
161 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
165 ctx->cipher_data = NULL;
167 ctx->key_len = cipher->key_len;
168 /* Preserve wrap enable flag, zero everything else */
169 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
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, EVP_R_INITIALIZATION_ERROR);
176 } else if (!ctx->cipher) {
177 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
180 #ifndef OPENSSL_NO_ENGINE
183 /* we assume block size is a power of 2 in *cryptUpdate */
184 OPENSSL_assert(ctx->cipher->block_size == 1
185 || ctx->cipher->block_size == 8
186 || ctx->cipher->block_size == 16);
188 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
189 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
190 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
194 if (!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
195 switch (EVP_CIPHER_CTX_mode(ctx)) {
197 case EVP_CIPH_STREAM_CIPHER:
198 case EVP_CIPH_ECB_MODE:
201 case EVP_CIPH_CFB_MODE:
202 case EVP_CIPH_OFB_MODE:
207 case EVP_CIPH_CBC_MODE:
209 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
210 (int)sizeof(ctx->iv));
212 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
213 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
216 case EVP_CIPH_CTR_MODE:
218 /* Don't reuse IV for CTR mode */
220 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
228 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
229 if (!ctx->cipher->init(ctx, key, iv, enc))
234 ctx->block_mask = ctx->cipher->block_size - 1;
238 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
239 const unsigned char *in, int inl)
242 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
244 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
247 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
250 return EVP_EncryptFinal_ex(ctx, out, outl);
252 return EVP_DecryptFinal_ex(ctx, out, outl);
255 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
258 return EVP_EncryptFinal(ctx, out, outl);
260 return EVP_DecryptFinal(ctx, out, outl);
263 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
264 const unsigned char *key, const unsigned char *iv)
266 return EVP_CipherInit(ctx, cipher, key, iv, 1);
269 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
270 ENGINE *impl, const unsigned char *key,
271 const unsigned char *iv)
273 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
276 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
277 const unsigned char *key, const unsigned char *iv)
279 return EVP_CipherInit(ctx, cipher, key, iv, 0);
282 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
283 ENGINE *impl, const unsigned char *key,
284 const unsigned char *iv)
286 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
289 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
290 const unsigned char *in, int inl)
294 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
295 i = ctx->cipher->do_cipher(ctx, out, in, inl);
308 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
309 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
318 bl = ctx->cipher->block_size;
319 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
322 memcpy(&(ctx->buf[i]), in, inl);
328 memcpy(&(ctx->buf[i]), in, j);
329 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
341 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
347 memcpy(ctx->buf, &(in[inl]), i);
352 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
355 ret = EVP_EncryptFinal_ex(ctx, out, outl);
359 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
362 unsigned int i, b, bl;
364 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
365 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
373 b = ctx->cipher->block_size;
374 OPENSSL_assert(b <= sizeof ctx->buf);
380 if (ctx->flags & EVP_CIPH_NO_PADDING) {
382 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
383 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
391 for (i = bl; i < b; i++)
393 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
401 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
402 const unsigned char *in, int inl)
407 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
408 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
422 if (ctx->flags & EVP_CIPH_NO_PADDING)
423 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
425 b = ctx->cipher->block_size;
426 OPENSSL_assert(b <= sizeof ctx->final);
428 if (ctx->final_used) {
429 memcpy(out, ctx->final, b);
435 if (!EVP_EncryptUpdate(ctx, out, outl, in, inl))
439 * if we have 'decrypted' a multiple of block size, make sure we have a
440 * copy of this last block
442 if (b > 1 && !ctx->buf_len) {
445 memcpy(ctx->final, &out[*outl], b);
455 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
458 ret = EVP_DecryptFinal_ex(ctx, out, outl);
462 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
468 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
469 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
477 b = ctx->cipher->block_size;
478 if (ctx->flags & EVP_CIPH_NO_PADDING) {
480 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
481 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
488 if (ctx->buf_len || !ctx->final_used) {
489 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
492 OPENSSL_assert(b <= sizeof ctx->final);
495 * The following assumes that the ciphertext has been authenticated.
496 * Otherwise it provides a padding oracle.
498 n = ctx->final[b - 1];
499 if (n == 0 || n > (int)b) {
500 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
503 for (i = 0; i < n; i++) {
504 if (ctx->final[--b] != n) {
505 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
509 n = ctx->cipher->block_size - n;
510 for (i = 0; i < n; i++)
511 out[i] = ctx->final[i];
518 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
520 EVP_CIPHER_CTX_cleanup(ctx);
524 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *c)
528 if (c->cipher != NULL) {
529 if (c->cipher->cleanup && !c->cipher->cleanup(c))
531 /* Cleanse cipher context data */
532 if (c->cipher_data && c->cipher->ctx_size)
533 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
535 OPENSSL_free(c->cipher_data);
536 #ifndef OPENSSL_NO_ENGINE
539 * The EVP_CIPHER we used belongs to an ENGINE, release the
540 * functional reference we held for this reason.
542 ENGINE_finish(c->engine);
544 memset(c, 0, sizeof(*c));
548 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
550 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
551 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
552 if (c->key_len == keylen)
554 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
558 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
562 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
565 ctx->flags &= ~EVP_CIPH_NO_PADDING;
567 ctx->flags |= EVP_CIPH_NO_PADDING;
571 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
575 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
579 if (!ctx->cipher->ctrl) {
580 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
584 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
586 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
587 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
593 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
595 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
596 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
597 if (RAND_bytes(key, ctx->key_len) <= 0)
602 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
604 if ((in == NULL) || (in->cipher == NULL)) {
605 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
608 #ifndef OPENSSL_NO_ENGINE
609 /* Make sure it's safe to copy a cipher context using an ENGINE */
610 if (in->engine && !ENGINE_init(in->engine)) {
611 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
616 EVP_CIPHER_CTX_cleanup(out);
617 memcpy(out, in, sizeof(*out));
619 if (in->cipher_data && in->cipher->ctx_size) {
620 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
621 if (out->cipher_data == NULL) {
622 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
625 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
628 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
629 return in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out);