crypto/evp/bio_ok.c

   1 /* crypto/evp/bio_ok.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 /*-
  60         From: Arne Ansper <arne@cyber.ee>
  61
  62         Why BIO_f_reliable?
  63
  64         I wrote function which took BIO* as argument, read data from it
  65         and processed it. Then I wanted to store the input file in
  66         encrypted form. OK I pushed BIO_f_cipher to the BIO stack
  67         and everything was OK. BUT if user types wrong password
  68         BIO_f_cipher outputs only garbage and my function crashes. Yes
  69         I can and I should fix my function, but BIO_f_cipher is
  70         easy way to add encryption support to many existing applications
  71         and it's hard to debug and fix them all.
  72
  73         So I wanted another BIO which would catch the incorrect passwords and
  74         file damages which cause garbage on BIO_f_cipher's output.
  75
  76         The easy way is to push the BIO_f_md and save the checksum at
  77         the end of the file. However there are several problems with this
  78         approach:
  79
  80         1) you must somehow separate checksum from actual data.
  81         2) you need lot's of memory when reading the file, because you
  82         must read to the end of the file and verify the checksum before
  83         letting the application to read the data.
  84
  85         BIO_f_reliable tries to solve both problems, so that you can
  86         read and write arbitrary long streams using only fixed amount
  87         of memory.
  88
  89         BIO_f_reliable splits data stream into blocks. Each block is prefixed
  90         with it's length and suffixed with it's digest. So you need only
  91         several Kbytes of memory to buffer single block before verifying
  92         it's digest.
  93
  94         BIO_f_reliable goes further and adds several important capabilities:
  95
  96         1) the digest of the block is computed over the whole stream
  97         -- so nobody can rearrange the blocks or remove or replace them.
  98
  99         2) to detect invalid passwords right at the start BIO_f_reliable
 100         adds special prefix to the stream. In order to avoid known plain-text
 101         attacks this prefix is generated as follows:
 102
 103                 *) digest is initialized with random seed instead of
 104                 standardized one.
 105                 *) same seed is written to output
 106                 *) well-known text is then hashed and the output
 107                 of the digest is also written to output.
 108
 109         reader can now read the seed from stream, hash the same string
 110         and then compare the digest output.
 111
 112         Bad things: BIO_f_reliable knows what's going on in EVP_Digest. I
 113         initially wrote and tested this code on x86 machine and wrote the
 114         digests out in machine-dependent order :( There are people using
 115         this code and I cannot change this easily without making existing
 116         data files unreadable.
 117
 118 */
 119
 120 #include <stdio.h>
 121 #include <errno.h>
 122 #include <assert.h>
 123 #include "cryptlib.h"
 124 #include <openssl/buffer.h>
 125 #include <openssl/bio.h>
 126 #include <openssl/evp.h>
 127 #include <openssl/rand.h>
 128
 129 static int ok_write(BIO *h, const char *buf, int num);
 130 static int ok_read(BIO *h, char *buf, int size);
 131 static long ok_ctrl(BIO *h, int cmd, long arg1, void *arg2);
 132 static int ok_new(BIO *h);
 133 static int ok_free(BIO *data);
 134 static long ok_callback_ctrl(BIO *h, int cmd, bio_info_cb *fp);
 135
 136 static __owur int sig_out(BIO *b);
 137 static __owur int sig_in(BIO *b);
 138 static __owur int block_out(BIO *b);
 139 static __owur int block_in(BIO *b);
 140 #define OK_BLOCK_SIZE   (1024*4)
 141 #define OK_BLOCK_BLOCK  4
 142 #define IOBS            (OK_BLOCK_SIZE+ OK_BLOCK_BLOCK+ 3*EVP_MAX_MD_SIZE)
 143 #define WELLKNOWN "The quick brown fox jumped over the lazy dog's back."
 144
 145 typedef struct ok_struct {
 146     size_t buf_len;
 147     size_t buf_off;
 148     size_t buf_len_save;
 149     size_t buf_off_save;
 150     int cont;                   /* <= 0 when finished */
 151     int finished;
 152     EVP_MD_CTX md;
 153     int blockout;               /* output block is ready */
 154     int sigio;                  /* must process signature */
 155     unsigned char buf[IOBS];
 156 } BIO_OK_CTX;
 157
 158 static BIO_METHOD methods_ok = {
 159     BIO_TYPE_CIPHER, "reliable",
 160     ok_write,
 161     ok_read,
 162     NULL,                       /* ok_puts, */
 163     NULL,                       /* ok_gets, */
 164     ok_ctrl,
 165     ok_new,
 166     ok_free,
 167     ok_callback_ctrl,
 168 };
 169
 170 BIO_METHOD *BIO_f_reliable(void)
 171 {
 172     return (&methods_ok);
 173 }
 174
 175 static int ok_new(BIO *bi)
 176 {
 177     BIO_OK_CTX *ctx;
 178
 179     ctx = OPENSSL_malloc(sizeof(*ctx));
 180     if (ctx == NULL)
 181         return (0);
 182
 183     ctx->buf_len = 0;
 184     ctx->buf_off = 0;
 185     ctx->buf_len_save = 0;
 186     ctx->buf_off_save = 0;
 187     ctx->cont = 1;
 188     ctx->finished = 0;
 189     ctx->blockout = 0;
 190     ctx->sigio = 1;
 191
 192     EVP_MD_CTX_init(&ctx->md);
 193
 194     bi->init = 0;
 195     bi->ptr = (char *)ctx;
 196     bi->flags = 0;
 197     return (1);
 198 }
 199
 200 static int ok_free(BIO *a)
 201 {
 202     if (a == NULL)
 203         return (0);
 204     EVP_MD_CTX_cleanup(&((BIO_OK_CTX *)a->ptr)->md);
 205     OPENSSL_clear_free(a->ptr, sizeof(BIO_OK_CTX));
 206     a->ptr = NULL;
 207     a->init = 0;
 208     a->flags = 0;
 209     return (1);
 210 }
 211
 212 static int ok_read(BIO *b, char *out, int outl)
 213 {
 214     int ret = 0, i, n;
 215     BIO_OK_CTX *ctx;
 216
 217     if (out == NULL)
 218         return (0);
 219     ctx = (BIO_OK_CTX *)b->ptr;
 220
 221     if ((ctx == NULL) || (b->next_bio == NULL) || (b->init == 0))
 222         return (0);
 223
 224     while (outl > 0) {
 225
 226         /* copy clean bytes to output buffer */
 227         if (ctx->blockout) {
 228             i = ctx->buf_len - ctx->buf_off;
 229             if (i > outl)
 230                 i = outl;
 231             memcpy(out, &(ctx->buf[ctx->buf_off]), i);
 232             ret += i;
 233             out += i;
 234             outl -= i;
 235             ctx->buf_off += i;
 236
 237             /* all clean bytes are out */
 238             if (ctx->buf_len == ctx->buf_off) {
 239                 ctx->buf_off = 0;
 240
 241                 /*
 242                  * copy start of the next block into proper place
 243                  */
 244                 if (ctx->buf_len_save - ctx->buf_off_save > 0) {
 245                     ctx->buf_len = ctx->buf_len_save - ctx->buf_off_save;
 246                     memmove(ctx->buf, &(ctx->buf[ctx->buf_off_save]),
 247                             ctx->buf_len);
 248                 } else {
 249                     ctx->buf_len = 0;
 250                 }
 251                 ctx->blockout = 0;
 252             }
 253         }
 254
 255         /* output buffer full -- cancel */
 256         if (outl == 0)
 257             break;
 258
 259         /* no clean bytes in buffer -- fill it */
 260         n = IOBS - ctx->buf_len;
 261         i = BIO_read(b->next_bio, &(ctx->buf[ctx->buf_len]), n);
 262
 263         if (i <= 0)
 264             break;              /* nothing new */
 265
 266         ctx->buf_len += i;
 267
 268         /* no signature yet -- check if we got one */
 269         if (ctx->sigio == 1) {
 270             if (!sig_in(b)) {
 271                 BIO_clear_retry_flags(b);
 272                 return 0;
 273             }
 274         }
 275
 276         /* signature ok -- check if we got block */
 277         if (ctx->sigio == 0) {
 278             if (!block_in(b)) {
 279                 BIO_clear_retry_flags(b);
 280                 return 0;
 281             }
 282         }
 283
 284         /* invalid block -- cancel */
 285         if (ctx->cont <= 0)
 286             break;
 287
 288     }
 289
 290     BIO_clear_retry_flags(b);
 291     BIO_copy_next_retry(b);
 292     return (ret);
 293 }
 294
 295 static int ok_write(BIO *b, const char *in, int inl)
 296 {
 297     int ret = 0, n, i;
 298     BIO_OK_CTX *ctx;
 299
 300     if (inl <= 0)
 301         return inl;
 302
 303     ctx = (BIO_OK_CTX *)b->ptr;
 304     ret = inl;
 305
 306     if ((ctx == NULL) || (b->next_bio == NULL) || (b->init == 0))
 307         return (0);
 308
 309     if (ctx->sigio && !sig_out(b))
 310         return 0;
 311
 312     do {
 313         BIO_clear_retry_flags(b);
 314         n = ctx->buf_len - ctx->buf_off;
 315         while (ctx->blockout && n > 0) {
 316             i = BIO_write(b->next_bio, &(ctx->buf[ctx->buf_off]), n);
 317             if (i <= 0) {
 318                 BIO_copy_next_retry(b);
 319                 if (!BIO_should_retry(b))
 320                     ctx->cont = 0;
 321                 return (i);
 322             }
 323             ctx->buf_off += i;
 324             n -= i;
 325         }
 326
 327         /* at this point all pending data has been written */
 328         ctx->blockout = 0;
 329         if (ctx->buf_len == ctx->buf_off) {
 330             ctx->buf_len = OK_BLOCK_BLOCK;
 331             ctx->buf_off = 0;
 332         }
 333
 334         if ((in == NULL) || (inl <= 0))
 335             return (0);
 336
 337         n = (inl + ctx->buf_len > OK_BLOCK_SIZE + OK_BLOCK_BLOCK) ?
 338             (int)(OK_BLOCK_SIZE + OK_BLOCK_BLOCK - ctx->buf_len) : inl;
 339
 340         memcpy((unsigned char *)(&(ctx->buf[ctx->buf_len])),
 341                (unsigned char *)in, n);
 342         ctx->buf_len += n;
 343         inl -= n;
 344         in += n;
 345
 346         if (ctx->buf_len >= OK_BLOCK_SIZE + OK_BLOCK_BLOCK) {
 347             if (!block_out(b)) {
 348                 BIO_clear_retry_flags(b);
 349                 return 0;
 350             }
 351         }
 352     } while (inl > 0);
 353
 354     BIO_clear_retry_flags(b);
 355     BIO_copy_next_retry(b);
 356     return (ret);
 357 }
 358
 359 static long ok_ctrl(BIO *b, int cmd, long num, void *ptr)
 360 {
 361     BIO_OK_CTX *ctx;
 362     EVP_MD *md;
 363     const EVP_MD **ppmd;
 364     long ret = 1;
 365     int i;
 366
 367     ctx = b->ptr;
 368
 369     switch (cmd) {
 370     case BIO_CTRL_RESET:
 371         ctx->buf_len = 0;
 372         ctx->buf_off = 0;
 373         ctx->buf_len_save = 0;
 374         ctx->buf_off_save = 0;
 375         ctx->cont = 1;
 376         ctx->finished = 0;
 377         ctx->blockout = 0;
 378         ctx->sigio = 1;
 379         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 380         break;
 381     case BIO_CTRL_EOF:         /* More to read */
 382         if (ctx->cont <= 0)
 383             ret = 1;
 384         else
 385             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 386         break;
 387     case BIO_CTRL_PENDING:     /* More to read in buffer */
 388     case BIO_CTRL_WPENDING:    /* More to read in buffer */
 389         ret = ctx->blockout ? ctx->buf_len - ctx->buf_off : 0;
 390         if (ret <= 0)
 391             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 392         break;
 393     case BIO_CTRL_FLUSH:
 394         /* do a final write */
 395         if (ctx->blockout == 0)
 396             if (!block_out(b))
 397                 return 0;
 398
 399         while (ctx->blockout) {
 400             i = ok_write(b, NULL, 0);
 401             if (i < 0) {
 402                 ret = i;
 403                 break;
 404             }
 405         }
 406
 407         ctx->finished = 1;
 408         ctx->buf_off = ctx->buf_len = 0;
 409         ctx->cont = (int)ret;
 410
 411         /* Finally flush the underlying BIO */
 412         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 413         break;
 414     case BIO_C_DO_STATE_MACHINE:
 415         BIO_clear_retry_flags(b);
 416         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 417         BIO_copy_next_retry(b);
 418         break;
 419     case BIO_CTRL_INFO:
 420         ret = (long)ctx->cont;
 421         break;
 422     case BIO_C_SET_MD:
 423         md = ptr;
 424         if (!EVP_DigestInit_ex(&ctx->md, md, NULL))
 425             return 0;
 426         b->init = 1;
 427         break;
 428     case BIO_C_GET_MD:
 429         if (b->init) {
 430             ppmd = ptr;
 431             *ppmd = ctx->md.digest;
 432         } else
 433             ret = 0;
 434         break;
 435     default:
 436         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 437         break;
 438     }
 439     return (ret);
 440 }
 441
 442 static long ok_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
 443 {
 444     long ret = 1;
 445
 446     if (b->next_bio == NULL)
 447         return (0);
 448     switch (cmd) {
 449     default:
 450         ret = BIO_callback_ctrl(b->next_bio, cmd, fp);
 451         break;
 452     }
 453     return (ret);
 454 }
 455
 456 static void longswap(void *_ptr, size_t len)
 457 {
 458     const union {
 459         long one;
 460         char little;
 461     } is_endian = {
 462         1
 463     };
 464
 465     if (is_endian.little) {
 466         size_t i;
 467         unsigned char *p = _ptr, c;
 468
 469         for (i = 0; i < len; i += 4) {
 470             c = p[0], p[0] = p[3], p[3] = c;
 471             c = p[1], p[1] = p[2], p[2] = c;
 472         }
 473     }
 474 }
 475
 476 static int sig_out(BIO *b)
 477 {
 478     BIO_OK_CTX *ctx;
 479     EVP_MD_CTX *md;
 480
 481     ctx = b->ptr;
 482     md = &ctx->md;
 483
 484     if (ctx->buf_len + 2 * md->digest->md_size > OK_BLOCK_SIZE)
 485         return 1;
 486
 487     if (!EVP_DigestInit_ex(md, md->digest, NULL))
 488         goto berr;
 489     /*
 490      * FIXME: there's absolutely no guarantee this makes any sense at all,
 491      * particularly now EVP_MD_CTX has been restructured.
 492      */
 493     if (RAND_bytes(md->md_data, md->digest->md_size) <= 0)
 494         goto berr;
 495     memcpy(&(ctx->buf[ctx->buf_len]), md->md_data, md->digest->md_size);
 496     longswap(&(ctx->buf[ctx->buf_len]), md->digest->md_size);
 497     ctx->buf_len += md->digest->md_size;
 498
 499     if (!EVP_DigestUpdate(md, WELLKNOWN, strlen(WELLKNOWN)))
 500         goto berr;
 501     if (!EVP_DigestFinal_ex(md, &(ctx->buf[ctx->buf_len]), NULL))
 502         goto berr;
 503     ctx->buf_len += md->digest->md_size;
 504     ctx->blockout = 1;
 505     ctx->sigio = 0;
 506     return 1;
 507  berr:
 508     BIO_clear_retry_flags(b);
 509     return 0;
 510 }
 511
 512 static int sig_in(BIO *b)
 513 {
 514     BIO_OK_CTX *ctx;
 515     EVP_MD_CTX *md;
 516     unsigned char tmp[EVP_MAX_MD_SIZE];
 517     int ret = 0;
 518
 519     ctx = b->ptr;
 520     md = &ctx->md;
 521
 522     if ((int)(ctx->buf_len - ctx->buf_off) < 2 * md->digest->md_size)
 523         return 1;
 524
 525     if (!EVP_DigestInit_ex(md, md->digest, NULL))
 526         goto berr;
 527     memcpy(md->md_data, &(ctx->buf[ctx->buf_off]), md->digest->md_size);
 528     longswap(md->md_data, md->digest->md_size);
 529     ctx->buf_off += md->digest->md_size;
 530
 531     if (!EVP_DigestUpdate(md, WELLKNOWN, strlen(WELLKNOWN)))
 532         goto berr;
 533     if (!EVP_DigestFinal_ex(md, tmp, NULL))
 534         goto berr;
 535     ret = memcmp(&(ctx->buf[ctx->buf_off]), tmp, md->digest->md_size) == 0;
 536     ctx->buf_off += md->digest->md_size;
 537     if (ret == 1) {
 538         ctx->sigio = 0;
 539         if (ctx->buf_len != ctx->buf_off) {
 540             memmove(ctx->buf, &(ctx->buf[ctx->buf_off]),
 541                     ctx->buf_len - ctx->buf_off);
 542         }
 543         ctx->buf_len -= ctx->buf_off;
 544         ctx->buf_off = 0;
 545     } else {
 546         ctx->cont = 0;
 547     }
 548     return 1;
 549  berr:
 550     BIO_clear_retry_flags(b);
 551     return 0;
 552 }
 553
 554 static int block_out(BIO *b)
 555 {
 556     BIO_OK_CTX *ctx;
 557     EVP_MD_CTX *md;
 558     unsigned long tl;
 559
 560     ctx = b->ptr;
 561     md = &ctx->md;
 562
 563     tl = ctx->buf_len - OK_BLOCK_BLOCK;
 564     ctx->buf[0] = (unsigned char)(tl >> 24);
 565     ctx->buf[1] = (unsigned char)(tl >> 16);
 566     ctx->buf[2] = (unsigned char)(tl >> 8);
 567     ctx->buf[3] = (unsigned char)(tl);
 568     if (!EVP_DigestUpdate(md,
 569                           (unsigned char *)&(ctx->buf[OK_BLOCK_BLOCK]), tl))
 570         goto berr;
 571     if (!EVP_DigestFinal_ex(md, &(ctx->buf[ctx->buf_len]), NULL))
 572         goto berr;
 573     ctx->buf_len += md->digest->md_size;
 574     ctx->blockout = 1;
 575     return 1;
 576  berr:
 577     BIO_clear_retry_flags(b);
 578     return 0;
 579 }
 580
 581 static int block_in(BIO *b)
 582 {
 583     BIO_OK_CTX *ctx;
 584     EVP_MD_CTX *md;
 585     unsigned long tl = 0;
 586     unsigned char tmp[EVP_MAX_MD_SIZE];
 587
 588     ctx = b->ptr;
 589     md = &ctx->md;
 590
 591     assert(sizeof(tl) >= OK_BLOCK_BLOCK); /* always true */
 592     tl = ctx->buf[0];
 593     tl <<= 8;
 594     tl |= ctx->buf[1];
 595     tl <<= 8;
 596     tl |= ctx->buf[2];
 597     tl <<= 8;
 598     tl |= ctx->buf[3];
 599
 600     if (ctx->buf_len < tl + OK_BLOCK_BLOCK + md->digest->md_size)
 601         return 1;
 602
 603     if (!EVP_DigestUpdate(md,
 604                           (unsigned char *)&(ctx->buf[OK_BLOCK_BLOCK]), tl))
 605         goto berr;
 606     if (!EVP_DigestFinal_ex(md, tmp, NULL))
 607         goto berr;
 608     if (memcmp(&(ctx->buf[tl + OK_BLOCK_BLOCK]), tmp, md->digest->md_size) ==
 609         0) {
 610         /* there might be parts from next block lurking around ! */
 611         ctx->buf_off_save = tl + OK_BLOCK_BLOCK + md->digest->md_size;
 612         ctx->buf_len_save = ctx->buf_len;
 613         ctx->buf_off = OK_BLOCK_BLOCK;
 614         ctx->buf_len = tl + OK_BLOCK_BLOCK;
 615         ctx->blockout = 1;
 616     } else {
 617         ctx->cont = 0;
 618     }
 619     return 1;
 620  berr:
 621     BIO_clear_retry_flags(b);
 622     return 0;
 623 }