Zero cipher_data in EVP_CIPHER_CTX_cleanup
[openssl.git] / crypto / evp / evp_enc.c
1 /* crypto/evp/evp_enc.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  * 
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).
15  * 
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.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  * 
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
51  * SUCH DAMAGE.
52  * 
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.]
57  */
58
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/evp.h>
62 #include <openssl/err.h>
63 #include <openssl/engine.h>
64 #include "evp_locl.h"
65
66 #include <assert.h>
67
68 const char *EVP_version="EVP" OPENSSL_VERSION_PTEXT;
69
70 void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx)
71         {
72         memset(ctx,0,sizeof(EVP_CIPHER_CTX));
73         /* ctx->cipher=NULL; */
74         }
75
76
77 int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
78              const unsigned char *key, const unsigned char *iv, int enc)
79         {
80         if (cipher)
81                 EVP_CIPHER_CTX_init(ctx);
82         return EVP_CipherInit_ex(ctx,cipher,NULL,key,iv,enc);
83         }
84
85 int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
86              const unsigned char *key, const unsigned char *iv, int enc)
87         {
88         if (enc == -1)
89                 enc = ctx->encrypt;
90         else
91                 {
92                 if (enc)
93                         enc = 1;
94                 ctx->encrypt = enc;
95                 }
96         /* Whether it's nice or not, "Inits" can be used on "Final"'d contexts
97          * so this context may already have an ENGINE! Try to avoid releasing
98          * the previous handle, re-querying for an ENGINE, and having a
99          * reinitialisation, when it may all be unecessary. */
100         if (ctx->engine && ctx->cipher && (!cipher ||
101                         (cipher && (cipher->nid == ctx->cipher->nid))))
102                 goto skip_to_init;
103         if (cipher)
104                 {
105                 /* Ensure a context left lying around from last time is cleared
106                  * (the previous check attempted to avoid this if the same
107                  * ENGINE and EVP_CIPHER could be used). */
108                 EVP_CIPHER_CTX_cleanup(ctx);
109
110                 /* Restore encrypt field: it is zeroed by cleanup */
111                 ctx->encrypt = enc;
112                 if(impl)
113                         {
114                         if (!ENGINE_init(impl))
115                                 {
116                                 EVPerr(EVP_F_EVP_CIPHERINIT, EVP_R_INITIALIZATION_ERROR);
117                                 return 0;
118                                 }
119                         }
120                 else
121                         /* Ask if an ENGINE is reserved for this job */
122                         impl = ENGINE_get_cipher_engine(cipher->nid);
123                 if(impl)
124                         {
125                         /* There's an ENGINE for this job ... (apparently) */
126                         const EVP_CIPHER *c = ENGINE_get_cipher(impl, cipher->nid);
127                         if(!c)
128                                 {
129                                 /* One positive side-effect of US's export
130                                  * control history, is that we should at least
131                                  * be able to avoid using US mispellings of
132                                  * "initialisation"? */
133                                 EVPerr(EVP_F_EVP_CIPHERINIT, EVP_R_INITIALIZATION_ERROR);
134                                 return 0;
135                                 }
136                         /* We'll use the ENGINE's private cipher definition */
137                         cipher = c;
138                         /* Store the ENGINE functional reference so we know
139                          * 'cipher' came from an ENGINE and we need to release
140                          * it when done. */
141                         ctx->engine = impl;
142                         }
143                 else
144                         ctx->engine = NULL;
145
146                 ctx->cipher=cipher;
147                 ctx->cipher_data=OPENSSL_malloc(ctx->cipher->ctx_size);
148                 ctx->key_len = cipher->key_len;
149                 ctx->flags = 0;
150                 if(ctx->cipher->flags & EVP_CIPH_CTRL_INIT)
151                         {
152                         if(!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_INIT, 0, NULL))
153                                 {
154                                 EVPerr(EVP_F_EVP_CIPHERINIT, EVP_R_INITIALIZATION_ERROR);
155                                 return 0;
156                                 }
157                         }
158                 }
159         else if(!ctx->cipher)
160                 {
161                 EVPerr(EVP_F_EVP_CIPHERINIT, EVP_R_NO_CIPHER_SET);
162                 return 0;
163                 }
164 skip_to_init:
165         /* we assume block size is a power of 2 in *cryptUpdate */
166         assert(ctx->cipher->block_size == 1
167                || ctx->cipher->block_size == 8
168                || ctx->cipher->block_size == 16);
169
170         if(!(EVP_CIPHER_CTX_flags(ctx) & EVP_CIPH_CUSTOM_IV)) {
171                 switch(EVP_CIPHER_CTX_mode(ctx)) {
172
173                         case EVP_CIPH_STREAM_CIPHER:
174                         case EVP_CIPH_ECB_MODE:
175                         break;
176
177                         case EVP_CIPH_CFB_MODE:
178                         case EVP_CIPH_OFB_MODE:
179
180                         ctx->num = 0;
181
182                         case EVP_CIPH_CBC_MODE:
183
184                         if(iv) memcpy(ctx->oiv, iv, EVP_CIPHER_CTX_iv_length(ctx));
185                         memcpy(ctx->iv, ctx->oiv, EVP_CIPHER_CTX_iv_length(ctx));
186                         break;
187
188                         default:
189                         return 0;
190                         break;
191                 }
192         }
193
194         if(key || (ctx->cipher->flags & EVP_CIPH_ALWAYS_CALL_INIT)) {
195                 if(!ctx->cipher->init(ctx,key,iv,enc)) return 0;
196         }
197         ctx->buf_len=0;
198         ctx->final_used=0;
199         ctx->block_mask=ctx->cipher->block_size-1;
200         return 1;
201         }
202
203 int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
204              const unsigned char *in, int inl)
205         {
206         if (ctx->encrypt)
207                 return EVP_EncryptUpdate(ctx,out,outl,in,inl);
208         else    return EVP_DecryptUpdate(ctx,out,outl,in,inl);
209         }
210
211 int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
212         {
213         if (ctx->encrypt)
214                 return EVP_EncryptFinal_ex(ctx,out,outl);
215         else    return EVP_DecryptFinal_ex(ctx,out,outl);
216         }
217
218 int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
219         {
220         if (ctx->encrypt)
221                 return EVP_EncryptFinal(ctx,out,outl);
222         else    return EVP_DecryptFinal(ctx,out,outl);
223         }
224
225 int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
226              const unsigned char *key, const unsigned char *iv)
227         {
228         return EVP_CipherInit(ctx, cipher, key, iv, 1);
229         }
230
231 int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, ENGINE *impl,
232                 const unsigned char *key, const unsigned char *iv)
233         {
234         return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 1);
235         }
236
237 int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
238              const unsigned char *key, const unsigned char *iv)
239         {
240         return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, 0);
241         }
242
243 int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, ENGINE *impl,
244              const unsigned char *key, const unsigned char *iv)
245         {
246         return EVP_CipherInit_ex(ctx, cipher, impl, key, iv, 0);
247         }
248
249 int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
250              const unsigned char *in, int inl)
251         {
252         int i,j,bl;
253
254         if(ctx->buf_len == 0 && (inl&(ctx->block_mask)) == 0)
255                 {
256                 if(ctx->cipher->do_cipher(ctx,out,in,inl))
257                         {
258                         *outl=inl;
259                         return 1;
260                         }
261                 else
262                         {
263                         *outl=0;
264                         return 0;
265                         }
266                 }
267         i=ctx->buf_len;
268         bl=ctx->cipher->block_size;
269         if (i != 0)
270                 {
271                 if (i+inl < bl)
272                         {
273                         memcpy(&(ctx->buf[i]),in,inl);
274                         ctx->buf_len+=inl;
275                         *outl=0;
276                         return 1;
277                         }
278                 else
279                         {
280                         j=bl-i;
281                         memcpy(&(ctx->buf[i]),in,j);
282                         if(!ctx->cipher->do_cipher(ctx,out,ctx->buf,bl)) return 0;
283                         inl-=j;
284                         in+=j;
285                         out+=bl;
286                         *outl=bl;
287                         }
288                 }
289         else
290                 *outl = 0;
291         i=inl&(bl-1);
292         inl-=i;
293         if (inl > 0)
294                 {
295                 if(!ctx->cipher->do_cipher(ctx,out,in,inl)) return 0;
296                 *outl+=inl;
297                 }
298
299         if (i != 0)
300                 memcpy(ctx->buf,&(in[inl]),i);
301         ctx->buf_len=i;
302         return 1;
303         }
304
305 int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
306         {
307         int ret;
308         ret = EVP_EncryptFinal_ex(ctx, out, outl);
309         return ret;
310         }
311
312 int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
313         {
314         int i,n,b,bl,ret;
315
316         b=ctx->cipher->block_size;
317         if (b == 1)
318                 {
319                 *outl=0;
320                 return 1;
321                 }
322         bl=ctx->buf_len;
323         if (ctx->flags & EVP_CIPH_NO_PADDING)
324                 {
325                 if(bl)
326                         {
327                         EVPerr(EVP_F_EVP_ENCRYPTFINAL,EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
328                         return 0;
329                         }
330                 *outl = 0;
331                 return 1;
332                 }
333
334         n=b-bl;
335         for (i=bl; i<b; i++)
336                 ctx->buf[i]=n;
337         ret=ctx->cipher->do_cipher(ctx,out,ctx->buf,b);
338
339
340         if(ret)
341                 *outl=b;
342
343         return ret;
344         }
345
346 int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl,
347              const unsigned char *in, int inl)
348         {
349         int b, fix_len;
350
351         if (inl == 0)
352                 {
353                 *outl=0;
354                 return 1;
355                 }
356
357         if (ctx->flags & EVP_CIPH_NO_PADDING)
358                 return EVP_EncryptUpdate(ctx, out, outl, in, inl);
359
360         b=ctx->cipher->block_size;
361
362         if(ctx->final_used)
363                 {
364                 memcpy(out,ctx->final,b);
365                 out+=b;
366                 fix_len = 1;
367                 }
368         else
369                 fix_len = 0;
370
371
372         if(!EVP_EncryptUpdate(ctx,out,outl,in,inl))
373                 return 0;
374
375         /* if we have 'decrypted' a multiple of block size, make sure
376          * we have a copy of this last block */
377         if (b > 1 && !ctx->buf_len)
378                 {
379                 *outl-=b;
380                 ctx->final_used=1;
381                 memcpy(ctx->final,&out[*outl],b);
382                 }
383         else
384                 ctx->final_used = 0;
385
386         if (fix_len)
387                 *outl += b;
388                 
389         return 1;
390         }
391
392 int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
393         {
394         int ret;
395         ret = EVP_DecryptFinal_ex(ctx, out, outl);
396         return ret;
397         }
398
399 int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl)
400         {
401         int i,b;
402         int n;
403
404         *outl=0;
405         b=ctx->cipher->block_size;
406         if (ctx->flags & EVP_CIPH_NO_PADDING)
407                 {
408                 if(ctx->buf_len)
409                         {
410                         EVPerr(EVP_F_EVP_DECRYPTFINAL,EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH);
411                         return 0;
412                         }
413                 *outl = 0;
414                 return 1;
415                 }
416         if (b > 1)
417                 {
418                 if (ctx->buf_len || !ctx->final_used)
419                         {
420                         EVPerr(EVP_F_EVP_DECRYPTFINAL,EVP_R_WRONG_FINAL_BLOCK_LENGTH);
421                         return(0);
422                         }
423                 n=ctx->final[b-1];
424                 if (n > b)
425                         {
426                         EVPerr(EVP_F_EVP_DECRYPTFINAL,EVP_R_BAD_DECRYPT);
427                         return(0);
428                         }
429                 for (i=0; i<n; i++)
430                         {
431                         if (ctx->final[--b] != n)
432                                 {
433                                 EVPerr(EVP_F_EVP_DECRYPTFINAL,EVP_R_BAD_DECRYPT);
434                                 return(0);
435                                 }
436                         }
437                 n=ctx->cipher->block_size-n;
438                 for (i=0; i<n; i++)
439                         out[i]=ctx->final[i];
440                 *outl=n;
441                 }
442         else
443                 *outl=0;
444         return(1);
445         }
446
447 int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *c)
448         {
449         if (c->cipher != NULL)
450                 {
451                 if(c->cipher->cleanup && !c->cipher->cleanup(c))
452                         return 0;
453                 /* Zero cipher context data */
454                 if (c->cipher_data)
455                         memset(c->cipher_data, 0, c->cipher->ctx_size);
456                 }
457         if (c->cipher_data)
458                 OPENSSL_free(c->cipher_data);
459         if (c->engine)
460                 /* The EVP_CIPHER we used belongs to an ENGINE, release the
461                  * functional reference we held for this reason. */
462                 ENGINE_finish(c->engine);
463         memset(c,0,sizeof(EVP_CIPHER_CTX));
464         return 1;
465         }
466
467 int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *c, int keylen)
468         {
469         if(c->cipher->flags & EVP_CIPH_CUSTOM_KEY_LENGTH) 
470                 return EVP_CIPHER_CTX_ctrl(c, EVP_CTRL_SET_KEY_LENGTH, keylen, NULL);
471         if(c->key_len == keylen) return 1;
472         if((keylen > 0) && (c->cipher->flags & EVP_CIPH_VARIABLE_LENGTH))
473                 {
474                 c->key_len = keylen;
475                 return 1;
476                 }
477         EVPerr(EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH,EVP_R_INVALID_KEY_LENGTH);
478         return 0;
479         }
480
481 int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad)
482         {
483         if (pad) ctx->flags &= ~EVP_CIPH_NO_PADDING;
484         else ctx->flags |= EVP_CIPH_NO_PADDING;
485         return 1;
486         }
487
488 int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
489 {
490         int ret;
491         if(!ctx->cipher) {
492                 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_NO_CIPHER_SET);
493                 return 0;
494         }
495
496         if(!ctx->cipher->ctrl) {
497                 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_NOT_IMPLEMENTED);
498                 return 0;
499         }
500
501         ret = ctx->cipher->ctrl(ctx, type, arg, ptr);
502         if(ret == -1) {
503                 EVPerr(EVP_F_EVP_CIPHER_CTX_CTRL, EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED);
504                 return 0;
505         }
506         return ret;
507 }