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