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). */
130 unsigned long flags = ctx->flags;
131 EVP_CIPHER_CTX_cleanup(ctx);
132 /* Restore encrypt and flags */
136 #ifndef OPENSSL_NO_ENGINE
139 if (!ENGINE_init(impl))
141 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);
150 /* There's an ENGINE for this job ... (apparently) */
151 const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
154 /* One positive side-effect of US's export
155 * control history, is that we should at least
156 * be able to avoid using US mispellings of
157 * "initialisation"? */
158 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
161 /* We'll use the ENGINE's private cipher definition */
163 /* Store the ENGINE functional reference so we know
164 * 'cipher' came from an ENGINE and we need to release
175 const EVP_CIPHER *fcipher;
177 fcipher = FIPS_get_cipherbynid(EVP_CIPHER_type(cipher));
180 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
184 if (ctx->cipher->ctx_size)
186 ctx->cipher_data=OPENSSL_malloc(ctx->cipher->ctx_size);
187 if (!ctx->cipher_data)
189 EVPerr(EVP_F_EVP_CIPHERINIT_EX, ERR_R_MALLOC_FAILURE);
195 ctx->cipher_data = NULL;
197 ctx->key_len = cipher->key_len;
198 /* Preserve wrap enable flag, zero everything else */
199 ctx->flags &= EVP_CIPHER_CTX_FLAG_WRAP_ALLOW;
200 if(ctx->cipher->flags & EVP_CIPH_CTRL_INIT)
202 if(!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL))
204 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_INITIALIZATION_ERROR);
209 else if(!ctx->cipher)
211 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_NO_CIPHER_SET);
214 #ifndef OPENSSL_NO_ENGINE
219 return FIPS_cipherinit(ctx, cipher, key, iv, enc);
221 /* we assume block size is a power of 2 in *cryptUpdate */
222 OPENSSL_assert(ctx->cipher->block_size == 1
223 || ctx->cipher->block_size == 8
224 || ctx->cipher->block_size == 16);
226 if(!(ctx->flags & EVP_CIPHER_CTX_FLAG_WRAP_ALLOW)
227 && EVP_CIPHER_CTX_mode(ctx) == EVP_CIPH_WRAP_MODE)
229 EVPerr(EVP_F_EVP_CIPHERINIT_EX, EVP_R_WRAP_MODE_NOT_ALLOWED);
233 if(!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
234 switch(EVP_CIPHER_CTX_mode(ctx)) {
236 case EVP_CIPH_STREAM_CIPHER:
237 case EVP_CIPH_ECB_MODE:
240 case EVP_CIPH_CFB_MODE:
241 case EVP_CIPH_OFB_MODE:
246 case EVP_CIPH_CBC_MODE:
248 OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) <=
249 (int)sizeof(ctx->iv));
250 if(iv) memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
251 memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
254 case EVP_CIPH_CTR_MODE:
256 /* Don't reuse IV for CTR mode */
258 memcpy(ctx->iv, iv, EVP_CIPHER_CTX_iv_length(ctx));
268 if(key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
269 if(!ctx->cipher->init(ctx,key,iv,enc)) return 0;
273 ctx->block_mask=ctx->cipher->block_size-1;
277 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
278 const unsigned char *in, int inl)
281 return EVP_EncryptUpdate(ctx,out,outl,in,inl);
282 else return EVP_DecryptUpdate(ctx,out,outl,in,inl);
285 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
288 return EVP_EncryptFinal_ex(ctx,out,outl);
289 else return EVP_DecryptFinal_ex(ctx,out,outl);
292 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
295 return EVP_EncryptFinal(ctx,out,outl);
296 else return EVP_DecryptFinal(ctx,out,outl);
299 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
300 const unsigned char *key, const unsigned char *iv)
302 return EVP_CipherInit(ctx, cipher, key, iv, 1);
305 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, ENGINE *impl,
306 const unsigned char *key, const unsigned char *iv)
308 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
311 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
312 const unsigned char *key, const unsigned char *iv)
314 return EVP_CipherInit(ctx, cipher, key, iv, 0);
317 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
318 const unsigned char *key, const unsigned char *iv)
320 return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
323 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
324 const unsigned char *in, int inl)
328 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
330 i = M_do_cipher(ctx, out, in, inl);
344 if(ctx->buf_len == 0 && (inl&(ctx->block_mask)) == 0)
346 if(M_do_cipher(ctx,out,in,inl))
358 bl=ctx->cipher->block_size;
359 OPENSSL_assert(bl <= (int)sizeof(ctx->buf));
364 memcpy(&(ctx->buf[i]),in,inl);
372 memcpy(&(ctx->buf[i]),in,j);
373 if(!M_do_cipher(ctx,out,ctx->buf,bl)) return 0;
386 if(!M_do_cipher(ctx,out,in,inl)) return 0;
391 memcpy(ctx->buf,&(in[inl]),i);
396 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
399 ret = EVP_EncryptFinal_ex(ctx, out, outl);
403 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
406 unsigned int i, b, bl;
408 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
410 ret = M_do_cipher(ctx, out, NULL, 0);
418 b=ctx->cipher->block_size;
419 OPENSSL_assert(b <= sizeof ctx->buf);
426 if (ctx->flags & EVP_CIPH_NO_PADDING)
430 EVPerr(EVP_F_EVP_ENCRYPTFINAL_EX,EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
440 ret=M_do_cipher(ctx,out,ctx->buf,b);
449 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
450 const unsigned char *in, int inl)
455 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
457 fix_len = M_do_cipher(ctx, out, in, inl);
474 if (ctx->flags & EVP_CIPH_NO_PADDING)
475 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
477 b=ctx->cipher->block_size;
478 OPENSSL_assert(b <= sizeof ctx->final);
482 memcpy(out,ctx->final,b);
490 if(!EVP_EncryptUpdate(ctx,out,outl,in,inl))
493 /* if we have 'decrypted' a multiple of block size, make sure
494 * we have a copy of this last block */
495 if (b > 1 && !ctx->buf_len)
499 memcpy(ctx->final,&out[*outl],b);
510 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
513 ret = EVP_DecryptFinal_ex(ctx, out, outl);
517 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
523 if (ctx->cipher->flags & EVP_CIPH_FLAG_CUSTOM_CIPHER)
525 i = M_do_cipher(ctx, out, NULL, 0);
533 b=ctx->cipher->block_size;
534 if (ctx->flags & EVP_CIPH_NO_PADDING)
538 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
546 if (ctx->buf_len || !ctx->final_used)
548 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_WRONG_FINAL_BLOCK_LENGTH);
551 OPENSSL_assert(b <= sizeof ctx->final);
553 if (n == 0 || n > (int)b)
555 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_BAD_DECRYPT);
560 if (ctx->final[--b] != n)
562 EVPerr(EVP_F_EVP_DECRYPTFINAL_EX,EVP_R_BAD_DECRYPT);
566 n=ctx->cipher->block_size-n;
568 out[i]=ctx->final[i];
576 void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx)
580 EVP_CIPHER_CTX_cleanup(ctx);
585 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *c)
588 if (c->cipher != NULL)
590 if(c->cipher->cleanup && !c->cipher->cleanup(c))
592 /* Cleanse cipher context data */
594 OPENSSL_cleanse(c->cipher_data, c->cipher->ctx_size);
597 OPENSSL_free(c->cipher_data);
599 #ifndef OPENSSL_NO_ENGINE
601 /* The EVP_CIPHER we used belongs to an ENGINE, release the
602 * functional reference we held for this reason. */
603 ENGINE_finish(c->engine);
606 FIPS_cipher_ctx_cleanup(c);
608 memset(c,0,sizeof(EVP_CIPHER_CTX));
612 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
614 if(c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH)
615 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
616 if(c->key_len == keylen) return 1;
617 if((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH))
622 EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH,EVP_R_INVALID_KEY_LENGTH);
626 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
628 if (pad) ctx->flags &= ~EVP_CIPH_NO_PADDING;
629 else ctx->flags |= EVP_CIPH_NO_PADDING;
633 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
637 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
641 if(!ctx->cipher->ctrl) {
642 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
646 ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
648 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
654 int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key)
656 if (ctx->cipher->flags & EVP_CIPH_RAND_KEY)
657 return EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_RAND_KEY, 0, key);
658 if (RAND_bytes(key, ctx->key_len) <= 0)
663 int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in)
665 if ((in == NULL) || (in->cipher == NULL))
667 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY,EVP_R_INPUT_NOT_INITIALIZED);
670 #ifndef OPENSSL_NO_ENGINE
671 /* Make sure it's safe to copy a cipher context using an ENGINE */
672 if (in->engine && !ENGINE_init(in->engine))
674 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY,ERR_R_ENGINE_LIB);
679 EVP_CIPHER_CTX_cleanup(out);
680 memcpy(out,in,sizeof *out);
682 if (in->cipher_data && in->cipher->ctx_size)
684 out->cipher_data=OPENSSL_malloc(in->cipher->ctx_size);
685 if (!out->cipher_data)
687 EVPerr(EVP_F_EVP_CIPHER_CTX_COPY,ERR_R_MALLOC_FAILURE);
690 memcpy(out->cipher_data,in->cipher_data,in->cipher->ctx_size);
693 if (in->cipher->flags & EVP_CIPH_CUSTOM_COPY)
694 return in->cipher->ctrl((EVP_CIPHER_CTX *)in, EVP_CTRL_COPY, 0, out);