crypto/evp/bio_enc.c

   1 /* crypto/evp/bio_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 <errno.h>
  61 #include "cryptlib.h"
  62 #include <openssl/buffer.h>
  63 #include <openssl/evp.h>
  64
  65 static int enc_write(BIO *h,char *buf,int num);
  66 static int enc_read(BIO *h,char *buf,int size);
  67 /*static int enc_puts(BIO *h,char *str); */
  68 /*static int enc_gets(BIO *h,char *str,int size); */
  69 static long enc_ctrl(BIO *h,int cmd,long arg1,char *arg2);
  70 static int enc_new(BIO *h);
  71 static int enc_free(BIO *data);
  72 #define ENC_BLOCK_SIZE  (1024*4)
  73
  74 typedef struct enc_struct
  75         {
  76         int buf_len;
  77         int buf_off;
  78         int cont;               /* <= 0 when finished */
  79         int finished;
  80         int ok;                 /* bad decrypt */
  81         EVP_CIPHER_CTX cipher;
  82         char buf[ENC_BLOCK_SIZE+10];
  83         } BIO_ENC_CTX;
  84
  85 static BIO_METHOD methods_enc=
  86         {
  87         BIO_TYPE_CIPHER,"cipher",
  88         enc_write,
  89         enc_read,
  90         NULL, /* enc_puts, */
  91         NULL, /* enc_gets, */
  92         enc_ctrl,
  93         enc_new,
  94         enc_free,
  95         };
  96
  97 BIO_METHOD *BIO_f_cipher(void)
  98         {
  99         return(&methods_enc);
 100         }
 101
 102 static int enc_new(BIO *bi)
 103         {
 104         BIO_ENC_CTX *ctx;
 105
 106         ctx=(BIO_ENC_CTX *)Malloc(sizeof(BIO_ENC_CTX));
 107         EVP_CIPHER_CTX_init(&ctx->cipher);
 108         if (ctx == NULL) return(0);
 109
 110         ctx->buf_len=0;
 111         ctx->buf_off=0;
 112         ctx->cont=1;
 113         ctx->finished=0;
 114         ctx->ok=1;
 115
 116         bi->init=0;
 117         bi->ptr=(char *)ctx;
 118         bi->flags=0;
 119         return(1);
 120         }
 121
 122 static int enc_free(BIO *a)
 123         {
 124         BIO_ENC_CTX *b;
 125
 126         if (a == NULL) return(0);
 127         b=(BIO_ENC_CTX *)a->ptr;
 128         EVP_CIPHER_CTX_cleanup(&(b->cipher));
 129         memset(a->ptr,0,sizeof(BIO_ENC_CTX));
 130         Free(a->ptr);
 131         a->ptr=NULL;
 132         a->init=0;
 133         a->flags=0;
 134         return(1);
 135         }
 136
 137 static int enc_read(BIO *b, char *out, int outl)
 138         {
 139         int ret=0,i;
 140         BIO_ENC_CTX *ctx;
 141
 142         if (out == NULL) return(0);
 143         ctx=(BIO_ENC_CTX *)b->ptr;
 144
 145         if ((ctx == NULL) || (b->next_bio == NULL)) return(0);
 146
 147         /* First check if there are bytes decoded/encoded */
 148         if (ctx->buf_len > 0)
 149                 {
 150                 i=ctx->buf_len-ctx->buf_off;
 151                 if (i > outl) i=outl;
 152                 memcpy(out,&(ctx->buf[ctx->buf_off]),i);
 153                 ret=i;
 154                 out+=i;
 155                 outl-=i;
 156                 ctx->buf_off+=i;
 157                 if (ctx->buf_len == ctx->buf_off)
 158                         {
 159                         ctx->buf_len=0;
 160                         ctx->buf_off=0;
 161                         }
 162                 }
 163
 164         /* At this point, we have room of outl bytes and an empty
 165          * buffer, so we should read in some more. */
 166
 167         while (outl > 0)
 168                 {
 169                 if (ctx->cont <= 0) break;
 170
 171                 /* read in at offset 8, read the EVP_Cipher
 172                  * documentation about why */
 173                 i=BIO_read(b->next_bio,&(ctx->buf[8]),ENC_BLOCK_SIZE);
 174
 175                 if (i <= 0)
 176                         {
 177                         /* Should be continue next time we are called? */
 178                         if (!BIO_should_retry(b->next_bio))
 179                                 {
 180                                 ctx->cont=i;
 181                                 i=EVP_CipherFinal(&(ctx->cipher),
 182                                         (unsigned char *)ctx->buf,
 183                                         &(ctx->buf_len));
 184                                 ctx->ok=i;
 185                                 ctx->buf_off=0;
 186                                 }
 187                         else
 188                                 {
 189                                 ret=(ret == 0)?i:ret;
 190                                 break;
 191                                 }
 192                         }
 193                 else
 194                         {
 195                         EVP_CipherUpdate(&(ctx->cipher),
 196                                 (unsigned char *)ctx->buf,&ctx->buf_len,
 197                                 (unsigned char *)&(ctx->buf[8]),i);
 198                         ctx->cont=1;
 199                         /* Note: it is possible for EVP_CipherUpdate to
 200                          * decrypt zero bytes because this is or looks like
 201                          * the final block: if this happens we should retry
 202                          * and either read more data or decrypt the final
 203                          * block
 204                          */
 205                         if(ctx->buf_len == 0) continue;
 206                         }
 207
 208                 if (ctx->buf_len <= outl)
 209                         i=ctx->buf_len;
 210                 else
 211                         i=outl;
 212                 if (i <= 0) break;
 213                 memcpy(out,ctx->buf,i);
 214                 ret+=i;
 215                 ctx->buf_off=i;
 216                 outl-=i;
 217                 out+=i;
 218                 }
 219
 220         BIO_clear_retry_flags(b);
 221         BIO_copy_next_retry(b);
 222         return((ret == 0)?ctx->cont:ret);
 223         }
 224
 225 static int enc_write(BIO *b, char *in, int inl)
 226         {
 227         int ret=0,n,i;
 228         BIO_ENC_CTX *ctx;
 229
 230         ctx=(BIO_ENC_CTX *)b->ptr;
 231         ret=inl;
 232
 233         BIO_clear_retry_flags(b);
 234         n=ctx->buf_len-ctx->buf_off;
 235         while (n > 0)
 236                 {
 237                 i=BIO_write(b->next_bio,&(ctx->buf[ctx->buf_off]),n);
 238                 if (i <= 0)
 239                         {
 240                         BIO_copy_next_retry(b);
 241                         return(i);
 242                         }
 243                 ctx->buf_off+=i;
 244                 n-=i;
 245                 }
 246         /* at this point all pending data has been written */
 247
 248         if ((in == NULL) || (inl <= 0)) return(0);
 249
 250         ctx->buf_off=0;
 251         while (inl > 0)
 252                 {
 253                 n=(inl > ENC_BLOCK_SIZE)?ENC_BLOCK_SIZE:inl;
 254                 EVP_CipherUpdate(&(ctx->cipher),
 255                         (unsigned char *)ctx->buf,&ctx->buf_len,
 256                         (unsigned char *)in,n);
 257                 inl-=n;
 258                 in+=n;
 259
 260                 ctx->buf_off=0;
 261                 n=ctx->buf_len;
 262                 while (n > 0)
 263                         {
 264                         i=BIO_write(b->next_bio,&(ctx->buf[ctx->buf_off]),n);
 265                         if (i <= 0)
 266                                 {
 267                                 BIO_copy_next_retry(b);
 268                                 return(i);
 269                                 }
 270                         n-=i;
 271                         ctx->buf_off+=i;
 272                         }
 273                 ctx->buf_len=0;
 274                 ctx->buf_off=0;
 275                 }
 276         BIO_copy_next_retry(b);
 277         return(ret);
 278         }
 279
 280 static long enc_ctrl(BIO *b, int cmd, long num, char *ptr)
 281         {
 282         BIO *dbio;
 283         BIO_ENC_CTX *ctx,*dctx;
 284         long ret=1;
 285         int i;
 286         EVP_CIPHER_CTX **c_ctx;
 287
 288         ctx=(BIO_ENC_CTX *)b->ptr;
 289
 290         switch (cmd)
 291                 {
 292         case BIO_CTRL_RESET:
 293                 ctx->ok=1;
 294                 ctx->finished=0;
 295                 EVP_CipherInit(&(ctx->cipher),NULL,NULL,NULL,
 296                         ctx->cipher.encrypt);
 297                 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 298                 break;
 299         case BIO_CTRL_EOF:      /* More to read */
 300                 if (ctx->cont <= 0)
 301                         ret=1;
 302                 else
 303                         ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 304                 break;
 305         case BIO_CTRL_WPENDING:
 306                 ret=ctx->buf_len-ctx->buf_off;
 307                 if (ret <= 0)
 308                         ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 309                 break;
 310         case BIO_CTRL_PENDING: /* More to read in buffer */
 311                 ret=ctx->buf_len-ctx->buf_off;
 312                 if (ret <= 0)
 313                         ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 314                 break;
 315         case BIO_CTRL_FLUSH:
 316                 /* do a final write */
 317 again:
 318                 while (ctx->buf_len != ctx->buf_off)
 319                         {
 320                         i=enc_write(b,NULL,0);
 321                         if (i < 0)
 322                                 {
 323                                 ret=i;
 324                                 break;
 325                                 }
 326                         }
 327
 328                 if (!ctx->finished)
 329                         {
 330                         ctx->finished=1;
 331                         ctx->buf_off=0;
 332                         ret=EVP_CipherFinal(&(ctx->cipher),
 333                                 (unsigned char *)ctx->buf,
 334                                 &(ctx->buf_len));
 335                         ctx->ok=(int)ret;
 336                         if (ret <= 0) break;
 337
 338                         /* push out the bytes */
 339                         goto again;
 340                         }
 341
 342                 /* Finally flush the underlying BIO */
 343                 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 344                 break;
 345         case BIO_C_GET_CIPHER_STATUS:
 346                 ret=(long)ctx->ok;
 347                 break;
 348         case BIO_C_DO_STATE_MACHINE:
 349                 BIO_clear_retry_flags(b);
 350                 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 351                 BIO_copy_next_retry(b);
 352                 break;
 353         case BIO_C_GET_CIPHER_CTX:
 354                 c_ctx=(EVP_CIPHER_CTX **)ptr;
 355                 (*c_ctx)= &(ctx->cipher);
 356                 b->init=1;
 357                 break;
 358         case BIO_CTRL_DUP:
 359                 dbio=(BIO *)ptr;
 360                 dctx=(BIO_ENC_CTX *)dbio->ptr;
 361                 memcpy(&(dctx->cipher),&(ctx->cipher),sizeof(ctx->cipher));
 362                 dbio->init=1;
 363                 break;
 364         default:
 365                 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
 366                 break;
 367                 }
 368         return(ret);
 369         }
 370
 371 /*
 372 void BIO_set_cipher_ctx(b,c)
 373 BIO *b;
 374 EVP_CIPHER_ctx *c;
 375         {
 376         if (b == NULL) return;
 377
 378         if ((b->callback != NULL) &&
 379                 (b->callback(b,BIO_CB_CTRL,(char *)c,BIO_CTRL_SET,e,0L) <= 0))
 380                 return;
 381
 382         b->init=1;
 383         ctx=(BIO_ENC_CTX *)b->ptr;
 384         memcpy(ctx->cipher,c,sizeof(EVP_CIPHER_CTX));
 385
 386         if (b->callback != NULL)
 387                 b->callback(b,BIO_CB_CTRL,(char *)c,BIO_CTRL_SET,e,1L);
 388         }
 389 */
 390
 391 void BIO_set_cipher(BIO *b, const EVP_CIPHER *c, unsigned char *k,
 392              unsigned char *i, int e)
 393         {
 394         BIO_ENC_CTX *ctx;
 395
 396         if (b == NULL) return;
 397
 398         if ((b->callback != NULL) &&
 399                 (b->callback(b,BIO_CB_CTRL,(const char *)c,BIO_CTRL_SET,e,0L) <= 0))
 400                 return;
 401
 402         b->init=1;
 403         ctx=(BIO_ENC_CTX *)b->ptr;
 404         EVP_CipherInit(&(ctx->cipher),c,k,i,e);
 405
 406         if (b->callback != NULL)
 407                 b->callback(b,BIO_CB_CTRL,(const char *)c,BIO_CTRL_SET,e,1L);
 408         }
 409