1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
59 #include "internal/cryptlib.h"
60 #include <openssl/evp.h>
61 #include <openssl/err.h>
62 #include <openssl/rand.h>
63 #include <openssl/engine.h>
64 #include "internal/evp_int.h"
67 int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *c)
71 if (c->cipher != NULL) {
72 if (c->cipher->cleanup && !c->cipher->cleanup(c))
74 /* Cleanse cipher context data */
75 if (c->cipher_data && c->cipher->ctx_size)
76 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
78 OPENSSL_free(c->cipher_data);
79 #ifndef OPENSSL_NO_ENGINE
80 ENGINE_finish(c->engine);
82 memset(c, 0, sizeof(*c));
86 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
88 return OPENSSL_zalloc(sizeof(EVP_CIPHER_CTX));
91 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
93 EVP_CIPHER_CTX_reset(ctx);
97 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
98 const unsigned char *key, const unsigned char *iv, int enc)
100 EVP_CIPHER_CTX_reset(ctx);
101 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
104 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
105 ENGINE *impl, const unsigned char *key,
106 const unsigned char *iv, int enc)
115 #ifndef OPENSSL_NO_ENGINE
117 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
118 * this context may already have an ENGINE! Try to avoid releasing the
119 * previous handle, re-querying for an ENGINE, and having a
120 * reinitialisation, when it may all be unnecessary.
122 if (ctx->engine && ctx->cipher
123 && (cipher == NULL || cipher->nid == ctx->cipher->nid))
128 * Ensure a context left lying around from last time is cleared (the
129 * previous check attempted to avoid this if the same ENGINE and
130 * EVP_CIPHER could be used).
133 unsigned long flags = ctx->flags;
134 EVP_CIPHER_CTX_reset(ctx);
135 /* Restore encrypt and flags */
139 #ifndef OPENSSL_NO_ENGINE
141 if (!ENGINE_init(impl)) {
142 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
146 /* Ask if an ENGINE is reserved for this job */
147 impl = ENGINE_get_cipher_engine(cipher->nid);
149 /* There's an ENGINE for this job ... (apparently) */
150 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
153 * One positive side-effect of US's export control history,
154 * is that we should at least be able to avoid using US
155 * misspellings of "initialisation"?
157 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
160 /* We'll use the ENGINE's private cipher definition */
163 * Store the ENGINE functional reference so we know 'cipher' came
164 * from an ENGINE and we need to release it when done.
171 ctx->cipher = cipher;
172 if (ctx->cipher->ctx_size) {
173 ctx->cipher_data = OPENSSL_zalloc(ctx->cipher->ctx_size);
174 if (ctx->cipher_data == NULL) {
175 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
179 ctx->cipher_data = NULL;
181 ctx->key_len = cipher->key_len;
182 /* Preserve wrap enable flag, zero everything else */
183 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
184 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
185 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
186 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
190 } else if (!ctx->cipher) {
191 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
194 #ifndef OPENSSL_NO_ENGINE
197 /* we assume block size is a power of 2 in *cryptUpdate */
198 OPENSSL_assert(ctx->cipher->block_size == 1
199 || ctx->cipher->block_size == 8
200 || ctx->cipher->block_size == 16);
202 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
203 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
204 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
208 if (!(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(ctx)) & EVP_CIPH_CUSTOM_IV)) {
209 switch (EVP_CIPHER_CTX_mode(ctx)) {
211 case EVP_CIPH_STREAM_CIPHER:
212 case EVP_CIPH_ECB_MODE:
215 case EVP_CIPH_CFB_MODE:
216 case EVP_CIPH_OFB_MODE:
221 case EVP_CIPH_CBC_MODE:
223 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
224 (int)sizeof(ctx->iv));
226 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
227 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
230 case EVP_CIPH_CTR_MODE:
232 /* Don't reuse IV for CTR mode */
234 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
242 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
243 if (!ctx->cipher->init(ctx, key, iv, enc))
248 ctx->block_mask = ctx->cipher->block_size - 1;
252 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
253 const unsigned char *in, int inl)
256 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
258 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
261 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
264 return EVP_EncryptFinal_ex(ctx, out, outl);
266 return EVP_DecryptFinal_ex(ctx, out, outl);
269 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
272 return EVP_EncryptFinal(ctx, out, outl);
274 return EVP_DecryptFinal(ctx, out, outl);
277 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
278 const unsigned char *key, const unsigned char *iv)
280 return EVP_CipherInit(ctx, cipher, key, iv, 1);
283 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
284 ENGINE *impl, const unsigned char *key,
285 const unsigned char *iv)
287 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
290 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
291 const unsigned char *key, const unsigned char *iv)
293 return EVP_CipherInit(ctx, cipher, key, iv, 0);
296 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
297 ENGINE *impl, const unsigned char *key,
298 const unsigned char *iv)
300 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
303 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
304 const unsigned char *in, int inl)
308 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
309 i = ctx->cipher->do_cipher(ctx, out, in, inl);
322 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
323 if (ctx->cipher->do_cipher(ctx, out, in, inl)) {
332 bl = ctx->cipher->block_size;
333 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
336 memcpy(&(ctx->buf[i]), in, inl);
342 memcpy(&(ctx->buf[i]), in, j);
343 if (!ctx->cipher->do_cipher(ctx, out, ctx->buf, bl))
355 if (!ctx->cipher->do_cipher(ctx, out, in, inl))
361 memcpy(ctx->buf, &(in[inl]), i);
366 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
369 ret = EVP_EncryptFinal_ex(ctx, out, outl);
373 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
376 unsigned int i, b, bl;
378 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
379 ret = ctx->cipher->do_cipher(ctx, out, NULL, 0);
387 b = ctx->cipher->block_size;
388 OPENSSL_assert(b <= sizeof ctx->buf);
394 if (ctx->flags & EVP_CIPH_NO_PADDING) {
396 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
397 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
405 for (i = bl; i < b; i++)
407 ret = ctx->cipher->do_cipher(ctx, out, ctx->buf, b);
415 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
416 const unsigned char *in, int inl)
421 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
422 fix_len = ctx->cipher->do_cipher(ctx, out, in, inl);
436 if (ctx->flags & EVP_CIPH_NO_PADDING)
437 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
439 b = ctx->cipher->block_size;
440 OPENSSL_assert(b <= sizeof ctx->final);
442 if (ctx->final_used) {
443 memcpy(out, ctx->final, b);
449 if (!EVP_EncryptUpdate(ctx, out, outl, in, inl))
453 * if we have 'decrypted' a multiple of block size, make sure we have a
454 * copy of this last block
456 if (b > 1 && !ctx->buf_len) {
459 memcpy(ctx->final, &out[*outl], b);
469 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
472 ret = EVP_DecryptFinal_ex(ctx, out, outl);
476 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
482 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
483 i = ctx->cipher->do_cipher(ctx, out, NULL, 0);
491 b = ctx->cipher->block_size;
492 if (ctx->flags & EVP_CIPH_NO_PADDING) {
494 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
495 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
502 if (ctx->buf_len || !ctx->final_used) {
503 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
506 OPENSSL_assert(b <= sizeof ctx->final);
509 * The following assumes that the ciphertext has been authenticated.
510 * Otherwise it provides a padding oracle.
512 n = ctx->final[b - 1];
513 if (n == 0 || n > (int)b) {
514 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
517 for (i = 0; i < n; i++) {
518 if (ctx->final[--b] != n) {
519 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
523 n = ctx->cipher->block_size - n;
524 for (i = 0; i < n; i++)
525 out[i] = ctx->final[i];
532 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
534 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
535 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
536 if (c->key_len == keylen)
538 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
542 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
546 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
549 ctx->flags &= ~EVP_CIPH_NO_PADDING;
551 ctx->flags |= EVP_CIPH_NO_PADDING;
555 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
559 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
563 if (!ctx->cipher->ctrl) {
564 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
568 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
570 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
571 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
577 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
579 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
580 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
581 if (RAND_bytes(key, ctx->key_len) <= 0)
586 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
588 if ((in == NULL) || (in->cipher == NULL)) {
589 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
592 #ifndef OPENSSL_NO_ENGINE
593 /* Make sure it's safe to copy a cipher context using an ENGINE */
594 if (in->engine && !ENGINE_init(in->engine)) {
595 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
600 EVP_CIPHER_CTX_reset(out);
601 memcpy(out, in, sizeof(*out));
603 if (in->cipher_data && in->cipher->ctx_size) {
604 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
605 if (out->cipher_data == NULL) {
606 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
609 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
612 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
613 return in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out);