crypto/evp/bio_b64.c

   1 /* crypto/evp/bio_b64.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 "internal/cryptlib.h"
  62 #include <openssl/buffer.h>
  63 #include <openssl/evp.h>
  64
  65 static int b64_write(BIO *h, const char *buf, int num);
  66 static int b64_read(BIO *h, char *buf, int size);
  67 static int b64_puts(BIO *h, const char *str);
  68 /*
  69  * static int b64_gets(BIO *h, char *str, int size);
  70  */
  71 static long b64_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  72 static int b64_new(BIO *h);
  73 static int b64_free(BIO *data);
  74 static long b64_callback_ctrl(BIO *h, int cmd, bio_info_cb *fp);
  75 #define B64_BLOCK_SIZE  1024
  76 #define B64_BLOCK_SIZE2 768
  77 #define B64_NONE        0
  78 #define B64_ENCODE      1
  79 #define B64_DECODE      2
  80
  81 typedef struct b64_struct {
  82     /*
  83      * BIO *bio; moved to the BIO structure
  84      */
  85     int buf_len;
  86     int buf_off;
  87     int tmp_len;                /* used to find the start when decoding */
  88     int tmp_nl;                 /* If true, scan until '\n' */
  89     int encode;
  90     int start;                  /* have we started decoding yet? */
  91     int cont;                   /* <= 0 when finished */
  92     EVP_ENCODE_CTX base64;
  93     char buf[EVP_ENCODE_LENGTH(B64_BLOCK_SIZE) + 10];
  94     char tmp[B64_BLOCK_SIZE];
  95 } BIO_B64_CTX;
  96
  97 static BIO_METHOD methods_b64 = {
  98     BIO_TYPE_BASE64, "base64 encoding",
  99     b64_write,
 100     b64_read,
 101     b64_puts,
 102     NULL,                       /* b64_gets, */
 103     b64_ctrl,
 104     b64_new,
 105     b64_free,
 106     b64_callback_ctrl,
 107 };
 108
 109 BIO_METHOD *BIO_f_base64(void)
 110 {
 111     return (&methods_b64);
 112 }
 113
 114 static int b64_new(BIO *bi)
 115 {
 116     BIO_B64_CTX *ctx;
 117
 118     ctx = OPENSSL_zalloc(sizeof(*ctx));
 119     if (ctx == NULL)
 120         return (0);
 121
 122     ctx->cont = 1;
 123     ctx->start = 1;
 124     bi->init = 1;
 125     bi->ptr = (char *)ctx;
 126     bi->flags = 0;
 127     bi->num = 0;
 128     return (1);
 129 }
 130
 131 static int b64_free(BIO *a)
 132 {
 133     if (a == NULL)
 134         return (0);
 135     OPENSSL_free(a->ptr);
 136     a->ptr = NULL;
 137     a->init = 0;
 138     a->flags = 0;
 139     return (1);
 140 }
 141
 142 static int b64_read(BIO *b, char *out, int outl)
 143 {
 144     int ret = 0, i, ii, j, k, x, n, num, ret_code = 0;
 145     BIO_B64_CTX *ctx;
 146     unsigned char *p, *q;
 147
 148     if (out == NULL)
 149         return (0);
 150     ctx = (BIO_B64_CTX *)b->ptr;
 151
 152     if ((ctx == NULL) || (b->next_bio == NULL))
 153         return (0);
 154
 155     BIO_clear_retry_flags(b);
 156
 157     if (ctx->encode != B64_DECODE) {
 158         ctx->encode = B64_DECODE;
 159         ctx->buf_len = 0;
 160         ctx->buf_off = 0;
 161         ctx->tmp_len = 0;
 162         EVP_DecodeInit(&(ctx->base64));
 163     }
 164
 165     /* First check if there are bytes decoded/encoded */
 166     if (ctx->buf_len > 0) {
 167         OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 168         i = ctx->buf_len - ctx->buf_off;
 169         if (i > outl)
 170             i = outl;
 171         OPENSSL_assert(ctx->buf_off + i < (int)sizeof(ctx->buf));
 172         memcpy(out, &(ctx->buf[ctx->buf_off]), i);
 173         ret = i;
 174         out += i;
 175         outl -= i;
 176         ctx->buf_off += i;
 177         if (ctx->buf_len == ctx->buf_off) {
 178             ctx->buf_len = 0;
 179             ctx->buf_off = 0;
 180         }
 181     }
 182
 183     /*
 184      * At this point, we have room of outl bytes and an empty buffer, so we
 185      * should read in some more.
 186      */
 187
 188     ret_code = 0;
 189     while (outl > 0) {
 190         if (ctx->cont <= 0)
 191             break;
 192
 193         i = BIO_read(b->next_bio, &(ctx->tmp[ctx->tmp_len]),
 194                      B64_BLOCK_SIZE - ctx->tmp_len);
 195
 196         if (i <= 0) {
 197             ret_code = i;
 198
 199             /* Should we continue next time we are called? */
 200             if (!BIO_should_retry(b->next_bio)) {
 201                 ctx->cont = i;
 202                 /* If buffer empty break */
 203                 if (ctx->tmp_len == 0)
 204                     break;
 205                 /* Fall through and process what we have */
 206                 else
 207                     i = 0;
 208             }
 209             /* else we retry and add more data to buffer */
 210             else
 211                 break;
 212         }
 213         i += ctx->tmp_len;
 214         ctx->tmp_len = i;
 215
 216         /*
 217          * We need to scan, a line at a time until we have a valid line if we
 218          * are starting.
 219          */
 220         if (ctx->start && (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL)) {
 221             /* ctx->start=1; */
 222             ctx->tmp_len = 0;
 223         } else if (ctx->start) {
 224             q = p = (unsigned char *)ctx->tmp;
 225             num = 0;
 226             for (j = 0; j < i; j++) {
 227                 if (*(q++) != '\n')
 228                     continue;
 229
 230                 /*
 231                  * due to a previous very long line, we need to keep on
 232                  * scanning for a '\n' before we even start looking for
 233                  * base64 encoded stuff.
 234                  */
 235                 if (ctx->tmp_nl) {
 236                     p = q;
 237                     ctx->tmp_nl = 0;
 238                     continue;
 239                 }
 240
 241                 k = EVP_DecodeUpdate(&(ctx->base64),
 242                                      (unsigned char *)ctx->buf,
 243                                      &num, p, q - p);
 244                 if ((k <= 0) && (num == 0) && (ctx->start))
 245                     EVP_DecodeInit(&ctx->base64);
 246                 else {
 247                     if (p != (unsigned char *)
 248                         &(ctx->tmp[0])) {
 249                         i -= (p - (unsigned char *)
 250                               &(ctx->tmp[0]));
 251                         for (x = 0; x < i; x++)
 252                             ctx->tmp[x] = p[x];
 253                     }
 254                     EVP_DecodeInit(&ctx->base64);
 255                     ctx->start = 0;
 256                     break;
 257                 }
 258                 p = q;
 259             }
 260
 261             /* we fell off the end without starting */
 262             if ((j == i) && (num == 0)) {
 263                 /*
 264                  * Is this is one long chunk?, if so, keep on reading until a
 265                  * new line.
 266                  */
 267                 if (p == (unsigned char *)&(ctx->tmp[0])) {
 268                     /* Check buffer full */
 269                     if (i == B64_BLOCK_SIZE) {
 270                         ctx->tmp_nl = 1;
 271                         ctx->tmp_len = 0;
 272                     }
 273                 } else if (p != q) { /* finished on a '\n' */
 274                     n = q - p;
 275                     for (ii = 0; ii < n; ii++)
 276                         ctx->tmp[ii] = p[ii];
 277                     ctx->tmp_len = n;
 278                 }
 279                 /* else finished on a '\n' */
 280                 continue;
 281             } else {
 282                 ctx->tmp_len = 0;
 283             }
 284         } else if ((i < B64_BLOCK_SIZE) && (ctx->cont > 0)) {
 285             /*
 286              * If buffer isn't full and we can retry then restart to read in
 287              * more data.
 288              */
 289             continue;
 290         }
 291
 292         if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL) {
 293             int z, jj;
 294
 295             jj = i & ~3;        /* process per 4 */
 296             z = EVP_DecodeBlock((unsigned char *)ctx->buf,
 297                                 (unsigned char *)ctx->tmp, jj);
 298             if (jj > 2) {
 299                 if (ctx->tmp[jj - 1] == '=') {
 300                     z--;
 301                     if (ctx->tmp[jj - 2] == '=')
 302                         z--;
 303                 }
 304             }
 305             /*
 306              * z is now number of output bytes and jj is the number consumed
 307              */
 308             if (jj != i) {
 309                 memmove(ctx->tmp, &ctx->tmp[jj], i - jj);
 310                 ctx->tmp_len = i - jj;
 311             }
 312             ctx->buf_len = 0;
 313             if (z > 0) {
 314                 ctx->buf_len = z;
 315             }
 316             i = z;
 317         } else {
 318             i = EVP_DecodeUpdate(&(ctx->base64),
 319                                  (unsigned char *)ctx->buf, &ctx->buf_len,
 320                                  (unsigned char *)ctx->tmp, i);
 321             ctx->tmp_len = 0;
 322         }
 323         ctx->buf_off = 0;
 324         if (i < 0) {
 325             ret_code = 0;
 326             ctx->buf_len = 0;
 327             break;
 328         }
 329
 330         if (ctx->buf_len <= outl)
 331             i = ctx->buf_len;
 332         else
 333             i = outl;
 334
 335         memcpy(out, ctx->buf, i);
 336         ret += i;
 337         ctx->buf_off = i;
 338         if (ctx->buf_off == ctx->buf_len) {
 339             ctx->buf_len = 0;
 340             ctx->buf_off = 0;
 341         }
 342         outl -= i;
 343         out += i;
 344     }
 345     /* BIO_clear_retry_flags(b); */
 346     BIO_copy_next_retry(b);
 347     return ((ret == 0) ? ret_code : ret);
 348 }
 349
 350 static int b64_write(BIO *b, const char *in, int inl)
 351 {
 352     int ret = 0;
 353     int n;
 354     int i;
 355     BIO_B64_CTX *ctx;
 356
 357     ctx = (BIO_B64_CTX *)b->ptr;
 358     BIO_clear_retry_flags(b);
 359
 360     if (ctx->encode != B64_ENCODE) {
 361         ctx->encode = B64_ENCODE;
 362         ctx->buf_len = 0;
 363         ctx->buf_off = 0;
 364         ctx->tmp_len = 0;
 365         EVP_EncodeInit(&(ctx->base64));
 366     }
 367
 368     OPENSSL_assert(ctx->buf_off < (int)sizeof(ctx->buf));
 369     OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
 370     OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 371     n = ctx->buf_len - ctx->buf_off;
 372     while (n > 0) {
 373         i = BIO_write(b->next_bio, &(ctx->buf[ctx->buf_off]), n);
 374         if (i <= 0) {
 375             BIO_copy_next_retry(b);
 376             return (i);
 377         }
 378         OPENSSL_assert(i <= n);
 379         ctx->buf_off += i;
 380         OPENSSL_assert(ctx->buf_off <= (int)sizeof(ctx->buf));
 381         OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 382         n -= i;
 383     }
 384     /* at this point all pending data has been written */
 385     ctx->buf_off = 0;
 386     ctx->buf_len = 0;
 387
 388     if ((in == NULL) || (inl <= 0))
 389         return (0);
 390
 391     while (inl > 0) {
 392         n = (inl > B64_BLOCK_SIZE) ? B64_BLOCK_SIZE : inl;
 393
 394         if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL) {
 395             if (ctx->tmp_len > 0) {
 396                 OPENSSL_assert(ctx->tmp_len <= 3);
 397                 n = 3 - ctx->tmp_len;
 398                 /*
 399                  * There's a theoretical possibility for this
 400                  */
 401                 if (n > inl)
 402                     n = inl;
 403                 memcpy(&(ctx->tmp[ctx->tmp_len]), in, n);
 404                 ctx->tmp_len += n;
 405                 ret += n;
 406                 if (ctx->tmp_len < 3)
 407                     break;
 408                 ctx->buf_len =
 409                     EVP_EncodeBlock((unsigned char *)ctx->buf,
 410                                     (unsigned char *)ctx->tmp, ctx->tmp_len);
 411                 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
 412                 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 413                 /*
 414                  * Since we're now done using the temporary buffer, the
 415                  * length should be 0'd
 416                  */
 417                 ctx->tmp_len = 0;
 418             } else {
 419                 if (n < 3) {
 420                     memcpy(ctx->tmp, in, n);
 421                     ctx->tmp_len = n;
 422                     ret += n;
 423                     break;
 424                 }
 425                 n -= n % 3;
 426                 ctx->buf_len =
 427                     EVP_EncodeBlock((unsigned char *)ctx->buf,
 428                                     (const unsigned char *)in, n);
 429                 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
 430                 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 431                 ret += n;
 432             }
 433         } else {
 434             EVP_EncodeUpdate(&(ctx->base64),
 435                              (unsigned char *)ctx->buf, &ctx->buf_len,
 436                              (unsigned char *)in, n);
 437             OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
 438             OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 439             ret += n;
 440         }
 441         inl -= n;
 442         in += n;
 443
 444         ctx->buf_off = 0;
 445         n = ctx->buf_len;
 446         while (n > 0) {
 447             i = BIO_write(b->next_bio, &(ctx->buf[ctx->buf_off]), n);
 448             if (i <= 0) {
 449                 BIO_copy_next_retry(b);
 450                 return ((ret == 0) ? i : ret);
 451             }
 452             OPENSSL_assert(i <= n);
 453             n -= i;
 454             ctx->buf_off += i;
 455             OPENSSL_assert(ctx->buf_off <= (int)sizeof(ctx->buf));
 456             OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 457         }
 458         ctx->buf_len = 0;
 459         ctx->buf_off = 0;
 460     }
 461     return (ret);
 462 }
 463
 464 static long b64_ctrl(BIO *b, int cmd, long num, void *ptr)
 465 {
 466     BIO_B64_CTX *ctx;
 467     long ret = 1;
 468     int i;
 469
 470     ctx = (BIO_B64_CTX *)b->ptr;
 471
 472     switch (cmd) {
 473     case BIO_CTRL_RESET:
 474         ctx->cont = 1;
 475         ctx->start = 1;
 476         ctx->encode = B64_NONE;
 477         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 478         break;
 479     case BIO_CTRL_EOF:         /* More to read */
 480         if (ctx->cont <= 0)
 481             ret = 1;
 482         else
 483             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 484         break;
 485     case BIO_CTRL_WPENDING:    /* More to write in buffer */
 486         OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 487         ret = ctx->buf_len - ctx->buf_off;
 488         if ((ret == 0) && (ctx->encode != B64_NONE)
 489             && (ctx->base64.num != 0))
 490             ret = 1;
 491         else if (ret <= 0)
 492             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 493         break;
 494     case BIO_CTRL_PENDING:     /* More to read in buffer */
 495         OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
 496         ret = ctx->buf_len - ctx->buf_off;
 497         if (ret <= 0)
 498             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 499         break;
 500     case BIO_CTRL_FLUSH:
 501         /* do a final write */
 502  again:
 503         while (ctx->buf_len != ctx->buf_off) {
 504             i = b64_write(b, NULL, 0);
 505             if (i < 0)
 506                 return i;
 507         }
 508         if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL) {
 509             if (ctx->tmp_len != 0) {
 510                 ctx->buf_len = EVP_EncodeBlock((unsigned char *)ctx->buf,
 511                                                (unsigned char *)ctx->tmp,
 512                                                ctx->tmp_len);
 513                 ctx->buf_off = 0;
 514                 ctx->tmp_len = 0;
 515                 goto again;
 516             }
 517         } else if (ctx->encode != B64_NONE && ctx->base64.num != 0) {
 518             ctx->buf_off = 0;
 519             EVP_EncodeFinal(&(ctx->base64),
 520                             (unsigned char *)ctx->buf, &(ctx->buf_len));
 521             /* push out the bytes */
 522             goto again;
 523         }
 524         /* Finally flush the underlying BIO */
 525         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 526         break;
 527
 528     case BIO_C_DO_STATE_MACHINE:
 529         BIO_clear_retry_flags(b);
 530         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 531         BIO_copy_next_retry(b);
 532         break;
 533
 534     case BIO_CTRL_DUP:
 535         break;
 536     case BIO_CTRL_INFO:
 537     case BIO_CTRL_GET:
 538     case BIO_CTRL_SET:
 539     default:
 540         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 541         break;
 542     }
 543     return (ret);
 544 }
 545
 546 static long b64_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
 547 {
 548     long ret = 1;
 549
 550     if (b->next_bio == NULL)
 551         return (0);
 552     switch (cmd) {
 553     default:
 554         ret = BIO_callback_ctrl(b->next_bio, cmd, fp);
 555         break;
 556     }
 557     return (ret);
 558 }
 559
 560 static int b64_puts(BIO *b, const char *str)
 561 {
 562     return b64_write(b, str, strlen(str));
 563 }