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