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