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.]
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>
68 # include <openssl/fips.h>
73 # define M_do_cipher(ctx, out, in, inl) FIPS_cipher(ctx, out, in, inl)
75 # define M_do_cipher(ctx, out, in, inl) ctx->cipher->do_cipher(ctx, out, in, inl)
78 const char EVP_version[] = "EVP" OPENSSL_VERSION_PTEXT;
80 void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx)
82 memset(ctx, 0, sizeof(EVP_CIPHER_CTX));
83 /* ctx->cipher=NULL; */
86 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
88 EVP_CIPHER_CTX *ctx = OPENSSL_malloc(sizeof *ctx);
90 EVP_CIPHER_CTX_init(ctx);
94 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
95 const unsigned char *key, const unsigned char *iv, int enc)
98 EVP_CIPHER_CTX_init(ctx);
99 return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc);
102 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
103 ENGINE *impl, const unsigned char *key,
104 const unsigned char *iv, int enc)
113 #ifndef OPENSSL_NO_ENGINE
115 * Whether it's nice or not, "Inits" can be used on "Final"'d contexts so
116 * this context may already have an ENGINE! Try to avoid releasing the
117 * previous handle, re-querying for an ENGINE, and having a
118 * reinitialisation, when it may all be unecessary.
120 if (ctx->engine && ctx->cipher && (!cipher ||
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_cleanup(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 * mispellings 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.
173 const EVP_CIPHER *fcipher = NULL;
175 fcipher = evp_get_fips_cipher(cipher);
178 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
181 ctx->cipher = cipher;
182 if (ctx->cipher->ctx_size) {
183 ctx->cipher_data = OPENSSL_malloc(ctx->cipher->ctx_size);
184 if (!ctx->cipher_data) {
185 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
189 ctx->cipher_data = NULL;
191 ctx->key_len = cipher->key_len;
192 /* Preserve wrap enable flag, zero everything else */
193 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
194 if (ctx->cipher->flags & EVP_CIPH_CTRL_INIT) {
195 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL)) {
196 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
200 } else if (!ctx->cipher) {
201 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
204 #ifndef OPENSSL_NO_ENGINE
209 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
211 /* we assume block size is a power of 2 in *cryptUpdate */
212 OPENSSL_assert(ctx->cipher->block_size == 1
213 || ctx->cipher->block_size == 8
214 || ctx->cipher->block_size == 16);
216 if (!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
217 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE) {
218 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
222 if (!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
223 switch (EVP_CIPHER_CTX_mode(ctx)) {
225 case EVP_CIPH_STREAM_CIPHER:
226 case EVP_CIPH_ECB_MODE:
229 case EVP_CIPH_CFB_MODE:
230 case EVP_CIPH_OFB_MODE:
235 case EVP_CIPH_CBC_MODE:
237 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
238 (int)sizeof(ctx->iv));
240 memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
241 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
244 case EVP_CIPH_CTR_MODE:
246 /* Don't reuse IV for CTR mode */
248 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
257 if (key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
258 if (!ctx->cipher->init(ctx, key, iv, enc))
263 ctx->block_mask = ctx->cipher->block_size - 1;
267 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
268 const unsigned char *in, int inl)
271 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
273 return EVP_DecryptUpdate(ctx, out, outl, in, inl);
276 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
279 return EVP_EncryptFinal_ex(ctx, out, outl);
281 return EVP_DecryptFinal_ex(ctx, out, outl);
284 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
287 return EVP_EncryptFinal(ctx, out, outl);
289 return EVP_DecryptFinal(ctx, out, outl);
292 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
293 const unsigned char *key, const unsigned char *iv)
295 return EVP_CipherInit(ctx, cipher, key, iv, 1);
298 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
299 ENGINE *impl, const unsigned char *key,
300 const unsigned char *iv)
302 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
305 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
306 const unsigned char *key, const unsigned char *iv)
308 return EVP_CipherInit(ctx, cipher, key, iv, 0);
311 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
312 ENGINE *impl, const unsigned char *key,
313 const unsigned char *iv)
315 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
318 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
319 const unsigned char *in, int inl)
323 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
324 i = M_do_cipher(ctx, out, in, inl);
337 if (ctx->buf_len == 0 && (inl & (ctx->block_mask)) == 0) {
338 if (M_do_cipher(ctx, out, in, inl)) {
347 bl = ctx->cipher->block_size;
348 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
351 memcpy(&(ctx->buf[i]), in, inl);
357 memcpy(&(ctx->buf[i]), in, j);
358 if (!M_do_cipher(ctx, out, ctx->buf, bl))
370 if (!M_do_cipher(ctx, out, in, inl))
376 memcpy(ctx->buf, &(in[inl]), i);
381 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
384 ret = EVP_EncryptFinal_ex(ctx, out, outl);
388 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
391 unsigned int i, b, bl;
393 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
394 ret = M_do_cipher(ctx, out, NULL, 0);
402 b = ctx->cipher->block_size;
403 OPENSSL_assert(b <= sizeof ctx->buf);
409 if (ctx->flags & EVP_CIPH_NO_PADDING) {
411 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,
412 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
420 for (i = bl; i < b; i++)
422 ret = M_do_cipher(ctx, out, ctx->buf, b);
430 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
431 const unsigned char *in, int inl)
436 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
437 fix_len = M_do_cipher(ctx, out, in, inl);
451 if (ctx->flags & EVP_CIPH_NO_PADDING)
452 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
454 b = ctx->cipher->block_size;
455 OPENSSL_assert(b <= sizeof ctx->final);
457 if (ctx->final_used) {
458 memcpy(out, ctx->final, b);
464 if (!EVP_EncryptUpdate(ctx, out, outl, in, inl))
468 * if we have 'decrypted' a multiple of block size, make sure we have a
469 * copy of this last block
471 if (b > 1 && !ctx->buf_len) {
474 memcpy(ctx->final, &out[*outl], b);
484 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
487 ret = EVP_DecryptFinal_ex(ctx, out, outl);
491 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
497 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER) {
498 i = M_do_cipher(ctx, out, NULL, 0);
506 b = ctx->cipher->block_size;
507 if (ctx->flags & EVP_CIPH_NO_PADDING) {
509 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,
510 EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
517 if (ctx->buf_len || !ctx->final_used) {
518 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_WRONG_FINAL_BLOCK_LENGTH);
521 OPENSSL_assert(b <= sizeof ctx->final);
524 * The following assumes that the ciphertext has been authenticated.
525 * Otherwise it provides a padding oracle.
527 n = ctx->final[b - 1];
528 if (n == 0 || n > (int)b) {
529 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
532 for (i = 0; i < n; i++) {
533 if (ctx->final[--b] != n) {
534 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX, EVP_R_BAD_DECRYPT);
538 n = ctx->cipher->block_size - n;
539 for (i = 0; i < n; i++)
540 out[i] = ctx->final[i];
547 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
550 EVP_CIPHER_CTX_cleanup(ctx);
555 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *c)
558 if (c->cipher != NULL) {
559 if (c->cipher->cleanup && !c->cipher->cleanup(c))
561 /* Cleanse cipher context data */
563 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
566 OPENSSL_free(c->cipher_data);
568 #ifndef OPENSSL_NO_ENGINE
571 * The EVP_CIPHER we used belongs to an ENGINE, release the
572 * functional reference we held for this reason.
574 ENGINE_finish(c->engine);
577 FIPS_cipher_ctx_cleanup(c);
579 memset(c, 0, sizeof(EVP_CIPHER_CTX));
583 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
585 if (c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
586 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
587 if (c->key_len == keylen)
589 if ((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH)) {
593 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH, EVP_R_INVALID_KEY_LENGTH);
597 int 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;
606 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
610 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
614 if (!ctx->cipher->ctrl) {
615 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
619 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
621 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL,
622 EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
628 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
630 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
631 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
632 if (RAND_bytes(key, ctx->key_len) <= 0)
637 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
639 if ((in == NULL) || (in->cipher == NULL)) {
640 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, EVP_R_INPUT_NOT_INITIALIZED);
643 #ifndef OPENSSL_NO_ENGINE
644 /* Make sure it's safe to copy a cipher context using an ENGINE */
645 if (in->engine && !ENGINE_init(in->engine)) {
646 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_ENGINE_LIB);
651 EVP_CIPHER_CTX_cleanup(out);
652 memcpy(out, in, sizeof *out);
654 if (in->cipher_data && in->cipher->ctx_size) {
655 out->cipher_data = OPENSSL_malloc(in->cipher->ctx_size);
656 if (!out->cipher_data) {
657 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY, ERR_R_MALLOC_FAILURE);
660 memcpy(out->cipher_data, in->cipher_data, in->cipher->ctx_size);
663 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
664 return in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out);