crypto/evp/encode.c

   1 /* crypto/evp/encode.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 "internal/cryptlib.h"
  61 #include <openssl/evp.h>
  62 #include "evp_locl.h"
  63
  64 static unsigned char conv_ascii2bin(unsigned char a);
  65 #ifndef CHARSET_EBCDIC
  66 # define conv_bin2ascii(a)       (data_bin2ascii[(a)&0x3f])
  67 #else
  68 /*
  69  * We assume that PEM encoded files are EBCDIC files (i.e., printable text
  70  * files). Convert them here while decoding. When encoding, output is EBCDIC
  71  * (text) format again. (No need for conversion in the conv_bin2ascii macro,
  72  * as the underlying textstring data_bin2ascii[] is already EBCDIC)
  73  */
  74 # define conv_bin2ascii(a)       (data_bin2ascii[(a)&0x3f])
  75 #endif
  76
  77 /*-
  78  * 64 char lines
  79  * pad input with 0
  80  * left over chars are set to =
  81  * 1 byte  => xx==
  82  * 2 bytes => xxx=
  83  * 3 bytes => xxxx
  84  */
  85 #define BIN_PER_LINE    (64/4*3)
  86 #define CHUNKS_PER_LINE (64/4)
  87 #define CHAR_PER_LINE   (64+1)
  88
  89 static const unsigned char data_bin2ascii[65] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ\
  90 abcdefghijklmnopqrstuvwxyz0123456789+/";
  91
  92 /*-
  93  * 0xF0 is a EOLN
  94  * 0xF1 is ignore but next needs to be 0xF0 (for \r\n processing).
  95  * 0xF2 is EOF
  96  * 0xE0 is ignore at start of line.
  97  * 0xFF is error
  98  */
  99
 100 #define B64_EOLN                0xF0
 101 #define B64_CR                  0xF1
 102 #define B64_EOF                 0xF2
 103 #define B64_WS                  0xE0
 104 #define B64_ERROR               0xFF
 105 #define B64_NOT_BASE64(a)       (((a)|0x13) == 0xF3)
 106 #define B64_BASE64(a)           !B64_NOT_BASE64(a)
 107
 108 static const unsigned char data_ascii2bin[128] = {
 109     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
 110     0xFF, 0xE0, 0xF0, 0xFF, 0xFF, 0xF1, 0xFF, 0xFF,
 111     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
 112     0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
 113     0xE0, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
 114     0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xF2, 0xFF, 0x3F,
 115     0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B,
 116     0x3C, 0x3D, 0xFF, 0xFF, 0xFF, 0x00, 0xFF, 0xFF,
 117     0xFF, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06,
 118     0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
 119     0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16,
 120     0x17, 0x18, 0x19, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
 121     0xFF, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20,
 122     0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28,
 123     0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30,
 124     0x31, 0x32, 0x33, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
 125 };
 126
 127 #ifndef CHARSET_EBCDIC
 128 static unsigned char conv_ascii2bin(unsigned char a)
 129 {
 130     if (a & 0x80)
 131         return B64_ERROR;
 132     return data_ascii2bin[a];
 133 }
 134 #else
 135 static unsigned char conv_ascii2bin(unsigned char a)
 136 {
 137     a = os_toascii[a];
 138     if (a & 0x80)
 139         return B64_ERROR;
 140     return data_ascii2bin[a];
 141 }
 142 #endif
 143
 144 EVP_ENCODE_CTX *EVP_ENCODE_CTX_new(void)
 145 {
 146     return (EVP_ENCODE_CTX *)OPENSSL_zalloc(sizeof(EVP_ENCODE_CTX));
 147 }
 148
 149 void EVP_ENCODE_CTX_free(EVP_ENCODE_CTX *ctx)
 150 {
 151     OPENSSL_free(ctx);
 152 }
 153 int EVP_ENCODE_CTX_num(EVP_ENCODE_CTX *ctx)
 154 {
 155     return ctx->num;
 156 }
 157
 158 void EVP_EncodeInit(EVP_ENCODE_CTX *ctx)
 159 {
 160     ctx->length = 48;
 161     ctx->num = 0;
 162     ctx->line_num = 0;
 163 }
 164
 165 void EVP_EncodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
 166                       const unsigned char *in, int inl)
 167 {
 168     int i, j;
 169     unsigned int total = 0;
 170
 171     *outl = 0;
 172     if (inl <= 0)
 173         return;
 174     OPENSSL_assert(ctx->length <= (int)sizeof(ctx->enc_data));
 175     if ((ctx->num + inl) < ctx->length) {
 176         memcpy(&(ctx->enc_data[ctx->num]), in, inl);
 177         ctx->num += inl;
 178         return;
 179     }
 180     if (ctx->num != 0) {
 181         i = ctx->length - ctx->num;
 182         memcpy(&(ctx->enc_data[ctx->num]), in, i);
 183         in += i;
 184         inl -= i;
 185         j = EVP_EncodeBlock(out, ctx->enc_data, ctx->length);
 186         ctx->num = 0;
 187         out += j;
 188         *(out++) = '\n';
 189         *out = '\0';
 190         total = j + 1;
 191     }
 192     while (inl >= ctx->length) {
 193         j = EVP_EncodeBlock(out, in, ctx->length);
 194         in += ctx->length;
 195         inl -= ctx->length;
 196         out += j;
 197         *(out++) = '\n';
 198         *out = '\0';
 199         total += j + 1;
 200     }
 201     if (inl != 0)
 202         memcpy(&(ctx->enc_data[0]), in, inl);
 203     ctx->num = inl;
 204     *outl = total;
 205 }
 206
 207 void EVP_EncodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl)
 208 {
 209     unsigned int ret = 0;
 210
 211     if (ctx->num != 0) {
 212         ret = EVP_EncodeBlock(out, ctx->enc_data, ctx->num);
 213         out[ret++] = '\n';
 214         out[ret] = '\0';
 215         ctx->num = 0;
 216     }
 217     *outl = ret;
 218 }
 219
 220 int EVP_EncodeBlock(unsigned char *t, const unsigned char *f, int dlen)
 221 {
 222     int i, ret = 0;
 223     unsigned long l;
 224
 225     for (i = dlen; i > 0; i -= 3) {
 226         if (i >= 3) {
 227             l = (((unsigned long)f[0]) << 16L) |
 228                 (((unsigned long)f[1]) << 8L) | f[2];
 229             *(t++) = conv_bin2ascii(l >> 18L);
 230             *(t++) = conv_bin2ascii(l >> 12L);
 231             *(t++) = conv_bin2ascii(l >> 6L);
 232             *(t++) = conv_bin2ascii(l);
 233         } else {
 234             l = ((unsigned long)f[0]) << 16L;
 235             if (i == 2)
 236                 l |= ((unsigned long)f[1] << 8L);
 237
 238             *(t++) = conv_bin2ascii(l >> 18L);
 239             *(t++) = conv_bin2ascii(l >> 12L);
 240             *(t++) = (i == 1) ? '=' : conv_bin2ascii(l >> 6L);
 241             *(t++) = '=';
 242         }
 243         ret += 4;
 244         f += 3;
 245     }
 246
 247     *t = '\0';
 248     return (ret);
 249 }
 250
 251 void EVP_DecodeInit(EVP_ENCODE_CTX *ctx)
 252 {
 253     /* Only ctx->num is used during decoding. */
 254     ctx->num = 0;
 255     ctx->length = 0;
 256     ctx->line_num = 0;
 257     ctx->expect_nl = 0;
 258 }
 259
 260 /*-
 261  * -1 for error
 262  *  0 for last line
 263  *  1 for full line
 264  *
 265  * Note: even though EVP_DecodeUpdate attempts to detect and report end of
 266  * content, the context doesn't currently remember it and will accept more data
 267  * in the next call. Therefore, the caller is responsible for checking and
 268  * rejecting a 0 return value in the middle of content.
 269  *
 270  * Note: even though EVP_DecodeUpdate has historically tried to detect end of
 271  * content based on line length, this has never worked properly. Therefore,
 272  * we now return 0 when one of the following is true:
 273  *   - Padding or B64_EOF was detected and the last block is complete.
 274  *   - Input has zero-length.
 275  * -1 is returned if:
 276  *   - Invalid characters are detected.
 277  *   - There is extra trailing padding, or data after padding.
 278  *   - B64_EOF is detected after an incomplete base64 block.
 279  */
 280 int EVP_DecodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
 281                      const unsigned char *in, int inl)
 282 {
 283     int seof = 0, eof = 0, rv = -1, ret = 0, i, v, tmp, n, decoded_len;
 284     unsigned char *d;
 285
 286     n = ctx->num;
 287     d = ctx->enc_data;
 288
 289     if (n > 0 && d[n - 1] == '=') {
 290         eof++;
 291         if (n > 1 && d[n - 2] == '=')
 292             eof++;
 293     }
 294
 295      /* Legacy behaviour: an empty input chunk signals end of input. */
 296     if (inl == 0) {
 297         rv = 0;
 298         goto end;
 299     }
 300
 301     for (i = 0; i < inl; i++) {
 302         tmp = *(in++);
 303         v = conv_ascii2bin(tmp);
 304         if (v == B64_ERROR) {
 305             rv = -1;
 306             goto end;
 307         }
 308
 309         if (tmp == '=') {
 310             eof++;
 311         } else if (eof > 0 && B64_BASE64(v)) {
 312             /* More data after padding. */
 313             rv = -1;
 314             goto end;
 315         }
 316
 317         if (eof > 2) {
 318             rv = -1;
 319             goto end;
 320         }
 321
 322         if (v == B64_EOF) {
 323             seof = 1;
 324             goto tail;
 325         }
 326
 327         /* Only save valid base64 characters. */
 328         if (B64_BASE64(v)) {
 329             if (n >= 64) {
 330                 /*
 331                  * We increment n once per loop, and empty the buffer as soon as
 332                  * we reach 64 characters, so this can only happen if someone's
 333                  * manually messed with the ctx. Refuse to write any more data.
 334                  */
 335                 rv = -1;
 336                 goto end;
 337             }
 338             OPENSSL_assert(n < (int)sizeof(ctx->enc_data));
 339             d[n++] = tmp;
 340         }
 341
 342         if (n == 64) {
 343             decoded_len = EVP_DecodeBlock(out, d, n);
 344             n = 0;
 345             if (decoded_len < 0 || eof > decoded_len) {
 346                 rv = -1;
 347                 goto end;
 348             }
 349             ret += decoded_len - eof;
 350             out += decoded_len - eof;
 351         }
 352     }
 353
 354     /*
 355      * Legacy behaviour: if the current line is a full base64-block (i.e., has
 356      * 0 mod 4 base64 characters), it is processed immediately. We keep this
 357      * behaviour as applications may not be calling EVP_DecodeFinal properly.
 358      */
 359 tail:
 360     if (n > 0) {
 361         if ((n & 3) == 0) {
 362             decoded_len = EVP_DecodeBlock(out, d, n);
 363             n = 0;
 364             if (decoded_len < 0 || eof > decoded_len) {
 365                 rv = -1;
 366                 goto end;
 367             }
 368             ret += (decoded_len - eof);
 369         } else if (seof) {
 370             /* EOF in the middle of a base64 block. */
 371             rv = -1;
 372             goto end;
 373         }
 374     }
 375
 376     rv = seof || (n == 0 && eof) ? 0 : 1;
 377 end:
 378     /* Legacy behaviour. This should probably rather be zeroed on error. */
 379     *outl = ret;
 380     ctx->num = n;
 381     return (rv);
 382 }
 383
 384 int EVP_DecodeBlock(unsigned char *t, const unsigned char *f, int n)
 385 {
 386     int i, ret = 0, a, b, c, d;
 387     unsigned long l;
 388
 389     /* trim white space from the start of the line. */
 390     while ((conv_ascii2bin(*f) == B64_WS) && (n > 0)) {
 391         f++;
 392         n--;
 393     }
 394
 395     /*
 396      * strip off stuff at the end of the line ascii2bin values B64_WS,
 397      * B64_EOLN, B64_EOLN and B64_EOF
 398      */
 399     while ((n > 3) && (B64_NOT_BASE64(conv_ascii2bin(f[n - 1]))))
 400         n--;
 401
 402     if (n % 4 != 0)
 403         return (-1);
 404
 405     for (i = 0; i < n; i += 4) {
 406         a = conv_ascii2bin(*(f++));
 407         b = conv_ascii2bin(*(f++));
 408         c = conv_ascii2bin(*(f++));
 409         d = conv_ascii2bin(*(f++));
 410         if ((a & 0x80) || (b & 0x80) || (c & 0x80) || (d & 0x80))
 411             return (-1);
 412         l = ((((unsigned long)a) << 18L) |
 413              (((unsigned long)b) << 12L) |
 414              (((unsigned long)c) << 6L) | (((unsigned long)d)));
 415         *(t++) = (unsigned char)(l >> 16L) & 0xff;
 416         *(t++) = (unsigned char)(l >> 8L) & 0xff;
 417         *(t++) = (unsigned char)(l) & 0xff;
 418         ret += 3;
 419     }
 420     return (ret);
 421 }
 422
 423 int EVP_DecodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl)
 424 {
 425     int i;
 426
 427     *outl = 0;
 428     if (ctx->num != 0) {
 429         i = EVP_DecodeBlock(out, ctx->enc_data, ctx->num);
 430         if (i < 0)
 431             return (-1);
 432         ctx->num = 0;
 433         *outl = i;
 434         return (1);
 435     } else
 436         return (1);
 437 }