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)
79 const char EVP_version[]="EVP" OPENSSL_VERSION_PTEXT;
81 void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx)
83 memset(ctx,0,sizeof(EVP_CIPHER_CTX));
84 /* ctx->cipher=NULL; */
87 EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void)
89 EVP_CIPHER_CTX *ctx=OPENSSL_malloc(sizeof *ctx);
91 EVP_CIPHER_CTX_init(ctx);
95 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
96 const unsigned char *key, const unsigned char *iv, int enc)
99 EVP_CIPHER_CTX_init(ctx);
100 return EVP_CipherInit_ex(ctx,cipher,NULL,key,iv,enc);
103 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
104 const unsigned char *key, const unsigned char *iv, int enc)
114 #ifndef OPENSSL_NO_ENGINE
115 /* Whether it's nice or not, "Inits" can be used on "Final"'d contexts
116 * so this context may already have an ENGINE! Try to avoid releasing
117 * the previous handle, re-querying for an ENGINE, and having a
118 * reinitialisation, when it may all be unecessary. */
119 if (ctx->engine && ctx->cipher && (!cipher ||
120 (cipher && (cipher->nid == ctx->cipher->nid))))
125 /* Ensure a context left lying around from last time is cleared
126 * (the previous check attempted to avoid this if the same
127 * ENGINE and EVP_CIPHER could be used). */
128 EVP_CIPHER_CTX_cleanup(ctx);
130 /* Restore encrypt field: it is zeroed by cleanup */
132 #ifndef OPENSSL_NO_ENGINE
135 if (!ENGINE_init(impl))
137 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
142 /* Ask if an ENGINE is reserved for this job */
143 impl = ENGINE_get_cipher_engine(cipher->nid);
146 /* There's an ENGINE for this job ... (apparently) */
147 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
150 /* One positive side-effect of US's export
151 * control history, is that we should at least
152 * be able to avoid using US mispellings of
153 * "initialisation"? */
154 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
157 /* We'll use the ENGINE's private cipher definition */
159 /* Store the ENGINE functional reference so we know
160 * 'cipher' came from an ENGINE and we need to release
169 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
172 if (ctx->cipher->ctx_size)
174 ctx->cipher_data=OPENSSL_malloc(ctx->cipher->ctx_size);
175 if (!ctx->cipher_data)
177 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
183 ctx->cipher_data = NULL;
185 ctx->key_len = cipher->key_len;
187 if(ctx->cipher->flags & EVP_CIPH_CTRL_INIT)
189 if(!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL))
191 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
197 else if(!ctx->cipher)
199 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
202 #ifndef OPENSSL_NO_ENGINE
206 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
208 /* we assume block size is a power of 2 in *cryptUpdate */
209 OPENSSL_assert(ctx->cipher->block_size == 1
210 || ctx->cipher->block_size == 8
211 || ctx->cipher->block_size == 16);
213 if(!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
214 switch(EVP_CIPHER_CTX_mode(ctx)) {
216 case EVP_CIPH_STREAM_CIPHER:
217 case EVP_CIPH_ECB_MODE:
220 case EVP_CIPH_CFB_MODE:
221 case EVP_CIPH_OFB_MODE:
226 case EVP_CIPH_CBC_MODE:
228 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
229 (int)sizeof(ctx->iv));
230 if(iv) memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
231 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
234 case EVP_CIPH_CTR_MODE:
235 /* Don't reuse IV for CTR mode */
237 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
246 if(key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
247 if(!ctx->cipher->init(ctx,key,iv,enc)) return 0;
251 ctx->block_mask=ctx->cipher->block_size-1;
256 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
257 const unsigned char *in, int inl)
260 return EVP_EncryptUpdate(ctx,out,outl,in,inl);
261 else return EVP_DecryptUpdate(ctx,out,outl,in,inl);
264 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
267 return EVP_EncryptFinal_ex(ctx,out,outl);
268 else return EVP_DecryptFinal_ex(ctx,out,outl);
271 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
274 return EVP_EncryptFinal(ctx,out,outl);
275 else return EVP_DecryptFinal(ctx,out,outl);
278 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
279 const unsigned char *key, const unsigned char *iv)
281 return EVP_CipherInit(ctx, cipher, key, iv, 1);
284 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, ENGINE *impl,
285 const unsigned char *key, 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, ENGINE *impl,
297 const unsigned char *key, const unsigned char *iv)
299 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
302 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
303 const unsigned char *in, int inl)
307 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
309 i = M_do_cipher(ctx, out, in, inl);
323 if(ctx->buf_len == 0 && (inl&(ctx->block_mask)) == 0)
325 if(M_do_cipher(ctx,out,in,inl))
337 bl=ctx->cipher->block_size;
338 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
343 memcpy(&(ctx->buf[i]),in,inl);
351 memcpy(&(ctx->buf[i]),in,j);
352 if(!M_do_cipher(ctx,out,ctx->buf,bl)) return 0;
365 if(!M_do_cipher(ctx,out,in,inl)) return 0;
370 memcpy(ctx->buf,&(in[inl]),i);
375 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
378 ret = EVP_EncryptFinal_ex(ctx, out, outl);
382 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
385 unsigned int i, b, bl;
387 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
389 ret = M_do_cipher(ctx, out, NULL, 0);
397 b=ctx->cipher->block_size;
398 OPENSSL_assert(b <= sizeof ctx->buf);
405 if (ctx->flags & EVP_CIPH_NO_PADDING)
409 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
419 ret=M_do_cipher(ctx,out,ctx->buf,b);
428 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
429 const unsigned char *in, int inl)
434 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
436 fix_len = M_do_cipher(ctx, out, in, inl);
453 if (ctx->flags & EVP_CIPH_NO_PADDING)
454 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
456 b=ctx->cipher->block_size;
457 OPENSSL_assert(b <= sizeof ctx->final);
461 memcpy(out,ctx->final,b);
469 if(!EVP_EncryptUpdate(ctx,out,outl,in,inl))
472 /* if we have 'decrypted' a multiple of block size, make sure
473 * we have a copy of this last block */
474 if (b > 1 && !ctx->buf_len)
478 memcpy(ctx->final,&out[*outl],b);
489 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
492 ret = EVP_DecryptFinal_ex(ctx, out, outl);
496 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
502 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
504 i = M_do_cipher(ctx, out, NULL, 0);
512 b=ctx->cipher->block_size;
513 if (ctx->flags & EVP_CIPH_NO_PADDING)
517 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
525 if (ctx->buf_len || !ctx->final_used)
527 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_WRONG_FINAL_BLOCK_LENGTH);
530 OPENSSL_assert(b <= sizeof ctx->final);
532 if (n == 0 || n > (int)b)
534 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_BAD_DECRYPT);
539 if (ctx->final[--b] != n)
541 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_BAD_DECRYPT);
545 n=ctx->cipher->block_size-n;
547 out[i]=ctx->final[i];
555 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
559 EVP_CIPHER_CTX_cleanup(ctx);
564 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *c)
567 if (c->cipher != NULL)
569 if(c->cipher->cleanup && !c->cipher->cleanup(c))
571 /* Cleanse cipher context data */
573 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
576 OPENSSL_free(c->cipher_data);
578 #ifndef OPENSSL_NO_ENGINE
580 /* The EVP_CIPHER we used belongs to an ENGINE, release the
581 * functional reference we held for this reason. */
582 ENGINE_finish(c->engine);
585 FIPS_cipher_ctx_cleanup(c);
587 memset(c,0,sizeof(EVP_CIPHER_CTX));
591 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
593 if(c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
594 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
595 if(c->key_len == keylen) return 1;
596 if((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH))
601 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH,EVP_R_INVALID_KEY_LENGTH);
605 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
607 if (pad) ctx->flags &= ~EVP_CIPH_NO_PADDING;
608 else ctx->flags |= EVP_CIPH_NO_PADDING;
612 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
616 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
620 if(!ctx->cipher->ctrl) {
621 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
625 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
627 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
633 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
635 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
636 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
637 if (RAND_bytes(key, ctx->key_len) <= 0)
642 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
644 if ((in == NULL) || (in->cipher == NULL))
646 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY,EVP_R_INPUT_NOT_INITIALIZED);
649 #ifndef OPENSSL_NO_ENGINE
650 /* Make sure it's safe to copy a cipher context using an ENGINE */
651 if (in->engine && !ENGINE_init(in->engine))
653 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY,ERR_R_ENGINE_LIB);
658 EVP_CIPHER_CTX_cleanup(out);
659 memcpy(out,in,sizeof *out);
661 if (in->cipher_data && in->cipher->ctx_size)
663 out->cipher_data=OPENSSL_malloc(in->cipher->ctx_size);
664 if (!out->cipher_data)
666 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY,ERR_R_MALLOC_FAILURE);
669 memcpy(out->cipher_data,in->cipher_data,in->cipher->ctx_size);
672 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
673 return in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out);