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