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>
67 #include "internal/evp_int.h"
70 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *c)
74 if (c->cipher != NULL) {
75 if (c->cipher->cleanup && !c->cipher->cleanup(c))
77 /* Cleanse cipher context data */
78 if (c->cipher_data && c->cipher->ctx_size)
79 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
81 OPENSSL_free(c->cipher_data);
82 #ifndef OPENSSL_NO_ENGINE
85 * The EVP_CIPHER we used belongs to an ENGINE, release the
86 * functional reference we held for this reason.
88 ENGINE_finish(c->engine);
90 memset(c, 0, sizeof(*c));
94 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
96 return OPENSSL_zalloc(sizeof(EVP_CIPHER_CTX));
99 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
101 EVP_CIPHER_CTX_reset(ctx);
105 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
106 const unsigned char *key, const unsigned char *iv, int enc)
108 EVP_CIPHER_CTX_reset(ctx);
109 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
112 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
113 ENGINE *impl, const unsigned char *key,
114 const unsigned char *iv, int enc)
123 #ifndef OPENSSL_NO_ENGINE
125 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
126 * this context may already have an ENGINE! Try to avoid releasing the
127 * previous handle, re-querying for an ENGINE, and having a
128 * reinitialisation, when it may all be unecessary.
130 if (ctx->engine && ctx->cipher
131 && (!cipher || (cipher && (cipher->nid == ctx->cipher->nid))))
136 * Ensure a context left lying around from last time is cleared (the
137 * previous check attempted to avoid this if the same ENGINE and
138 * EVP_CIPHER could be used).
141 unsigned long flags = ctx->flags;
142 EVP_CIPHER_CTX_reset(ctx);
143 /* Restore encrypt and flags */
147 #ifndef OPENSSL_NO_ENGINE
149 if (!ENGINE_init(impl)) {
150 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
154 /* Ask if an ENGINE is reserved for this job */
155 impl = ENGINE_get_cipher_engine(cipher->nid);
157 /* There's an ENGINE for this job ... (apparently) */
158 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
161 * One positive side-effect of US's export control history,
162 * is that we should at least be able to avoid using US
163 * mispellings of "initialisation"?
165 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
168 /* We'll use the ENGINE's private cipher definition */
171 * Store the ENGINE functional reference so we know 'cipher' came
172 * from an ENGINE and we need to release it when done.
179 ctx->cipher = cipher;
180 if (ctx->cipher->ctx_size) {
181 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
182 if (ctx->cipher_data == NULL) {
183 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
187 ctx->cipher_data = NULL;
189 ctx->key_len = cipher->key_len;
190 /* Preserve wrap enable flag, zero everything else */
191 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
192 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
193 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
194 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
198 } else if (!ctx->cipher) {
199 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
202 #ifndef OPENSSL_NO_ENGINE
205 /* we assume block size is a power of 2 in *cryptUpdate */
206 OPENSSL_assert(ctx->cipher->block_size == 1
207 || ctx->cipher->block_size == 8
208 || ctx->cipher->block_size == 16);
210 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
211 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
212 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
216 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
217 switch (EVP_CIPHER_CTX_mode(ctx)) {
219 case EVP_CIPH_STREAM_CIPHER:
220 case EVP_CIPH_ECB_MODE:
223 case EVP_CIPH_CFB_MODE:
224 case EVP_CIPH_OFB_MODE:
229 case EVP_CIPH_CBC_MODE:
231 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
232 (int)sizeof(ctx->iv));
234 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
235 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
238 case EVP_CIPH_CTR_MODE:
240 /* Don't reuse IV for CTR mode */
242 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
250 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
251 if (!ctx->cipher->init(ctx, key, iv, enc))
256 ctx->block_mask = ctx->cipher->block_size - 1;
260 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
261 const unsigned char *in, int inl)
264 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
266 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
269 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
272 return EVP_EncryptFinal_ex(ctx, out, outl);
274 return EVP_DecryptFinal_ex(ctx, out, outl);
277 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
280 return EVP_EncryptFinal(ctx, out, outl);
282 return EVP_DecryptFinal(ctx, out, outl);
285 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
286 const unsigned char *key, const unsigned char *iv)
288 return EVP_CipherInit(ctx, cipher, key, iv, 1);
291 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
292 ENGINE *impl, const unsigned char *key,
293 const unsigned char *iv)
295 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
298 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
299 const unsigned char *key, const unsigned char *iv)
301 return EVP_CipherInit(ctx, cipher, key, iv, 0);
304 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
305 ENGINE *impl, const unsigned char *key,
306 const unsigned char *iv)
308 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
311 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
312 const unsigned char *in, int inl)
316 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
317 i = ctx->cipher->do_cipher(ctx, out, in, inl);
330 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
331 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
340 bl = ctx->cipher->block_size;
341 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
344 memcpy(&(ctx->buf[i]), in, inl);
350 memcpy(&(ctx->buf[i]), in, j);
351 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
363 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
369 memcpy(ctx->buf, &(in[inl]), i);
374 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
377 ret = EVP_EncryptFinal_ex(ctx, out, outl);
381 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
384 unsigned int i, b, bl;
386 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
387 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
395 b = ctx->cipher->block_size;
396 OPENSSL_assert(b <= sizeof ctx->buf);
402 if (ctx->flags & EVP_CIPH_NO_PADDING) {
404 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
405 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
413 for (i = bl; i < b; i++)
415 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
423 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
424 const unsigned char *in, int inl)
429 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
430 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
444 if (ctx->flags & EVP_CIPH_NO_PADDING)
445 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
447 b = ctx->cipher->block_size;
448 OPENSSL_assert(b <= sizeof ctx->final);
450 if (ctx->final_used) {
451 memcpy(out, ctx->final, b);
457 if (!EVP_EncryptUpdate(ctx, out, outl, in, inl))
461 * if we have 'decrypted' a multiple of block size, make sure we have a
462 * copy of this last block
464 if (b > 1 && !ctx->buf_len) {
467 memcpy(ctx->final, &out[*outl], b);
477 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
480 ret = EVP_DecryptFinal_ex(ctx, out, outl);
484 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
490 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
491 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
499 b = ctx->cipher->block_size;
500 if (ctx->flags & EVP_CIPH_NO_PADDING) {
502 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
503 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
510 if (ctx->buf_len || !ctx->final_used) {
511 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
514 OPENSSL_assert(b <= sizeof ctx->final);
517 * The following assumes that the ciphertext has been authenticated.
518 * Otherwise it provides a padding oracle.
520 n = ctx->final[b - 1];
521 if (n == 0 || n > (int)b) {
522 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
525 for (i = 0; i < n; i++) {
526 if (ctx->final[--b] != n) {
527 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
531 n = ctx->cipher->block_size - n;
532 for (i = 0; i < n; i++)
533 out[i] = ctx->final[i];
540 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
542 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
543 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
544 if (c->key_len == keylen)
546 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
550 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
554 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
557 ctx->flags &= ~EVP_CIPH_NO_PADDING;
559 ctx->flags |= EVP_CIPH_NO_PADDING;
563 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
567 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
571 if (!ctx->cipher->ctrl) {
572 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
576 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
578 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
579 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
585 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
587 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
588 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
589 if (RAND_bytes(key, ctx->key_len) <= 0)
594 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
596 if ((in == NULL) || (in->cipher == NULL)) {
597 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
600 #ifndef OPENSSL_NO_ENGINE
601 /* Make sure it's safe to copy a cipher context using an ENGINE */
602 if (in->engine && !ENGINE_init(in->engine)) {
603 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
608 EVP_CIPHER_CTX_reset(out);
609 memcpy(out, in, sizeof(*out));
611 if (in->cipher_data && in->cipher->ctx_size) {
612 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
613 if (out->cipher_data == NULL) {
614 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
617 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
620 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
621 return in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out);