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 "cryptlib.h"
  61 #include <openssl/evp.h>
  62
  63 #ifndef CHARSET_EBCDIC
  64 #define conv_bin2ascii(a)       (data_bin2ascii[(a)&0x3f])
  65 #define conv_ascii2bin(a)       (data_ascii2bin[(a)&0x7f])
  66 #else
  67 /* We assume that PEM encoded files are EBCDIC files
  68  * (i.e., printable text files). Convert them here while decoding.
  69  * When encoding, output is EBCDIC (text) format again.
  70  * (No need for conversion in the conv_bin2ascii macro, as the
  71  * underlying textstring data_bin2ascii[] is already EBCDIC)
  72  */
  73 #define conv_bin2ascii(a)       (data_bin2ascii[(a)&0x3f])
  74 #define conv_ascii2bin(a)       (data_ascii2bin[os_toascii[a]&0x7f])
  75 #endif
  76
  77 /* 64 char lines
  78  * pad input with 0
  79  * left over chars are set to =
  80  * 1 byte  => xx==
  81  * 2 bytes => xxx=
  82  * 3 bytes => xxxx
  83  */
  84 #define BIN_PER_LINE    (64/4*3)
  85 #define CHUNKS_PER_LINE (64/4)
  86 #define CHAR_PER_LINE   (64+1)
  87
  88 static const unsigned char data_bin2ascii[65]="ABCDEFGHIJKLMNOPQRSTUVWXYZ\
  89 abcdefghijklmnopqrstuvwxyz0123456789+/";
  90
  91 /* 0xF0 is a EOLN
  92  * 0xF1 is ignore but next needs to be 0xF0 (for \r\n processing).
  93  * 0xF2 is EOF
  94  * 0xE0 is ignore at start of line.
  95  * 0xFF is error
  96  */
  97
  98 #define B64_EOLN                0xF0
  99 #define B64_CR                  0xF1
 100 #define B64_EOF                 0xF2
 101 #define B64_WS                  0xE0
 102 #define B64_ERROR               0xFF
 103 #define B64_NOT_BASE64(a)       (((a)|0x13) == 0xF3)
 104
 105 static const unsigned char data_ascii2bin[128]={
 106         0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 107         0xFF,0xE0,0xF0,0xFF,0xFF,0xF1,0xFF,0xFF,
 108         0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 109         0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 110         0xE0,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,
 111         0xFF,0xFF,0xFF,0x3E,0xFF,0xF2,0xFF,0x3F,
 112         0x34,0x35,0x36,0x37,0x38,0x39,0x3A,0x3B,
 113         0x3C,0x3D,0xFF,0xFF,0xFF,0x00,0xFF,0xFF,
 114         0xFF,0x00,0x01,0x02,0x03,0x04,0x05,0x06,
 115         0x07,0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,
 116         0x0F,0x10,0x11,0x12,0x13,0x14,0x15,0x16,
 117         0x17,0x18,0x19,0xFF,0xFF,0xFF,0xFF,0xFF,
 118         0xFF,0x1A,0x1B,0x1C,0x1D,0x1E,0x1F,0x20,
 119         0x21,0x22,0x23,0x24,0x25,0x26,0x27,0x28,
 120         0x29,0x2A,0x2B,0x2C,0x2D,0x2E,0x2F,0x30,
 121         0x31,0x32,0x33,0xFF,0xFF,0xFF,0xFF,0xFF,
 122         };
 123
 124 void EVP_EncodeInit(EVP_ENCODE_CTX *ctx)
 125         {
 126         ctx->length=48;
 127         ctx->num=0;
 128         ctx->line_num=0;
 129         }
 130
 131 void EVP_EncodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
 132                       const unsigned char *in, size_t inl)
 133         {
 134         size_t i,j;
 135         unsigned int total=0;
 136
 137         *outl=0;
 138         if (inl == 0) return;
 139         OPENSSL_assert(ctx->length <= sizeof(ctx->enc_data));
 140         if ((ctx->num+inl) < ctx->length)
 141                 {
 142                 memcpy(&(ctx->enc_data[ctx->num]),in,inl);
 143                 ctx->num+=inl;
 144                 return;
 145                 }
 146         if (ctx->num != 0)
 147                 {
 148                 i=ctx->length-ctx->num;
 149                 memcpy(&(ctx->enc_data[ctx->num]),in,i);
 150                 in+=i;
 151                 inl-=i;
 152                 j=EVP_EncodeBlock(out,ctx->enc_data,ctx->length);
 153                 ctx->num=0;
 154                 out+=j;
 155                 *(out++)='\n';
 156                 *out='\0';
 157                 total=j+1;
 158                 }
 159         while (inl >= ctx->length)
 160                 {
 161                 j=EVP_EncodeBlock(out,in,ctx->length);
 162                 in+=ctx->length;
 163                 inl-=ctx->length;
 164                 out+=j;
 165                 *(out++)='\n';
 166                 *out='\0';
 167                 total+=j+1;
 168                 }
 169         if (inl != 0)
 170                 memcpy(&(ctx->enc_data[0]),in,inl);
 171         ctx->num=inl;
 172         *outl=total;
 173         }
 174
 175 void EVP_EncodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl)
 176         {
 177         unsigned int ret=0;
 178
 179         if (ctx->num != 0)
 180                 {
 181                 ret=EVP_EncodeBlock(out,ctx->enc_data,ctx->num);
 182                 out[ret++]='\n';
 183                 out[ret]='\0';
 184                 ctx->num=0;
 185                 }
 186         *outl=ret;
 187         }
 188
 189 int EVP_EncodeBlock(unsigned char *t, const unsigned char *f, size_t dlen)
 190         {
 191         int i,ret=0;
 192         unsigned long l;
 193
 194         for (i=dlen; i > 0; i-=3)
 195                 {
 196                 if (i >= 3)
 197                         {
 198                         l=      (((unsigned long)f[0])<<16L)|
 199                                 (((unsigned long)f[1])<< 8L)|f[2];
 200                         *(t++)=conv_bin2ascii(l>>18L);
 201                         *(t++)=conv_bin2ascii(l>>12L);
 202                         *(t++)=conv_bin2ascii(l>> 6L);
 203                         *(t++)=conv_bin2ascii(l     );
 204                         }
 205                 else
 206                         {
 207                         l=((unsigned long)f[0])<<16L;
 208                         if (i == 2) l|=((unsigned long)f[1]<<8L);
 209
 210                         *(t++)=conv_bin2ascii(l>>18L);
 211                         *(t++)=conv_bin2ascii(l>>12L);
 212                         *(t++)=(i == 1)?'=':conv_bin2ascii(l>> 6L);
 213                         *(t++)='=';
 214                         }
 215                 ret+=4;
 216                 f+=3;
 217                 }
 218
 219         *t='\0';
 220         return(ret);
 221         }
 222
 223 void EVP_DecodeInit(EVP_ENCODE_CTX *ctx)
 224         {
 225         ctx->length=30;
 226         ctx->num=0;
 227         ctx->line_num=0;
 228         ctx->expect_nl=0;
 229         }
 230
 231 /* -1 for error
 232  *  0 for last line
 233  *  1 for full line
 234  */
 235 int EVP_DecodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
 236                      const unsigned char *in, size_t inl)
 237         {
 238         int seof= -1,eof=0,rv= -1,ret=0,i,v,tmp,ln,tmp2,exp_nl;
 239         size_t n;
 240         unsigned char *d;
 241
 242         n=ctx->num;
 243         d=ctx->enc_data;
 244         ln=ctx->line_num;
 245         exp_nl=ctx->expect_nl;
 246
 247         /* last line of input. */
 248         if ((inl == 0) || ((n == 0) && (conv_ascii2bin(in[0]) == B64_EOF)))
 249                 { rv=0; goto end; }
 250
 251         /* We parse the input data */
 252         for (i=0; i<inl; i++)
 253                 {
 254                 /* If the current line is > 80 characters, scream alot */
 255                 if (ln >= 80) { rv= -1; goto end; }
 256
 257                 /* Get char and put it into the buffer */
 258                 tmp= *(in++);
 259                 v=conv_ascii2bin(tmp);
 260                 /* only save the good data :-) */
 261                 if (!B64_NOT_BASE64(v))
 262                         {
 263                         OPENSSL_assert(n < (int)sizeof(ctx->enc_data));
 264                         d[n++]=tmp;
 265                         ln++;
 266                         }
 267                 else if (v == B64_ERROR)
 268                         {
 269                         rv= -1;
 270                         goto end;
 271                         }
 272
 273                 /* have we seen a '=' which is 'definitly' the last
 274                  * input line.  seof will point to the character that
 275                  * holds it. and eof will hold how many characters to
 276                  * chop off. */
 277                 if (tmp == '=')
 278                         {
 279                         if (seof == -1) seof=n;
 280                         eof++;
 281                         }
 282
 283                 if (v == B64_CR)
 284                         {
 285                         ln = 0;
 286                         if (exp_nl)
 287                                 continue;
 288                         }
 289
 290                 /* eoln */
 291                 if (v == B64_EOLN)
 292                         {
 293                         ln=0;
 294                         if (exp_nl)
 295                                 {
 296                                 exp_nl=0;
 297                                 continue;
 298                                 }
 299                         }
 300                 exp_nl=0;
 301
 302                 /* If we are at the end of input and it looks like a
 303                  * line, process it. */
 304                 if (((i+1) == inl) && (((n&3) == 0) || eof))
 305                         {
 306                         v=B64_EOF;
 307                         /* In case things were given us in really small
 308                            records (so two '=' were given in separate
 309                            updates), eof may contain the incorrect number
 310                            of ending bytes to skip, so let's redo the count */
 311                         eof = 0;
 312                         if (d[n-1] == '=') eof++;
 313                         if (d[n-2] == '=') eof++;
 314                         /* There will never be more than two '=' */
 315                         }
 316
 317                 if ((v == B64_EOF && (n&3) == 0) || (n >= 64))
 318                         {
 319                         /* This is needed to work correctly on 64 byte input
 320                          * lines.  We process the line and then need to
 321                          * accept the '\n' */
 322                         if ((v != B64_EOF) && (n >= 64)) exp_nl=1;
 323                         tmp2=v;
 324                         if (n > 0)
 325                                 {
 326                                 v=EVP_DecodeBlock(out,d,n);
 327                                 n=0;
 328                                 if (v < 0) { rv=0; goto end; }
 329                                 ret+=(v-eof);
 330                                 }
 331                         else
 332                                 {
 333                                 eof=1;
 334                                 v=0;
 335                                 }
 336
 337                         /* This is the case where we have had a short
 338                          * but valid input line */
 339                         if ((v < ctx->length) && eof)
 340                                 {
 341                                 rv=0;
 342                                 goto end;
 343                                 }
 344                         else
 345                                 ctx->length=v;
 346
 347                         if (seof >= 0) { rv=0; goto end; }
 348                         out+=v;
 349                         }
 350                 }
 351         rv=1;
 352 end:
 353         *outl=ret;
 354         ctx->num=n;
 355         ctx->line_num=ln;
 356         ctx->expect_nl=exp_nl;
 357         return(rv);
 358         }
 359
 360 int EVP_DecodeBlock(unsigned char *t, const unsigned char *f, size_t n)
 361         {
 362         int i,ret=0,a,b,c,d;
 363         unsigned long l;
 364
 365         /* trim white space from the start of the line. */
 366         while ((conv_ascii2bin(*f) == B64_WS) && (n > 0))
 367                 {
 368                 f++;
 369                 n--;
 370                 }
 371
 372         /* strip off stuff at the end of the line
 373          * ascii2bin values B64_WS, B64_EOLN, B64_EOLN and B64_EOF */
 374         while ((n > 3) && (B64_NOT_BASE64(conv_ascii2bin(f[n-1]))))
 375                 n--;
 376
 377         if (n%4 != 0) return(-1);
 378
 379         for (i=0; i<n; i+=4)
 380                 {
 381                 a=conv_ascii2bin(*(f++));
 382                 b=conv_ascii2bin(*(f++));
 383                 c=conv_ascii2bin(*(f++));
 384                 d=conv_ascii2bin(*(f++));
 385                 if (    (a & 0x80) || (b & 0x80) ||
 386                         (c & 0x80) || (d & 0x80))
 387                         return(-1);
 388                 l=(     (((unsigned long)a)<<18L)|
 389                         (((unsigned long)b)<<12L)|
 390                         (((unsigned long)c)<< 6L)|
 391                         (((unsigned long)d)     ));
 392                 *(t++)=(unsigned char)(l>>16L)&0xff;
 393                 *(t++)=(unsigned char)(l>> 8L)&0xff;
 394                 *(t++)=(unsigned char)(l     )&0xff;
 395                 ret+=3;
 396                 }
 397         return(ret);
 398         }
 399
 400 int EVP_DecodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl)
 401         {
 402         int i;
 403
 404         *outl=0;
 405         if (ctx->num != 0)
 406                 {
 407                 i=EVP_DecodeBlock(out,ctx->enc_data,ctx->num);
 408                 if (i < 0) return(-1);
 409                 ctx->num=0;
 410                 *outl=i;
 411                 return(1);
 412                 }
 413         else
 414                 return(1);
 415         }
 416
 417 #ifdef undef
 418 int EVP_DecodeValid(unsigned char *buf, int len)
 419         {
 420         int i,num=0,bad=0;
 421
 422         if (len == 0) return(-1);
 423         while (conv_ascii2bin(*buf) == B64_WS)
 424                 {
 425                 buf++;
 426                 len--;
 427                 if (len == 0) return(-1);
 428                 }
 429
 430         for (i=len; i >= 4; i-=4)
 431                 {
 432                 if (    (conv_ascii2bin(buf[0]) >= 0x40) ||
 433                         (conv_ascii2bin(buf[1]) >= 0x40) ||
 434                         (conv_ascii2bin(buf[2]) >= 0x40) ||
 435                         (conv_ascii2bin(buf[3]) >= 0x40))
 436                         return(-1);
 437                 buf+=4;
 438                 num+=1+(buf[2] != '=')+(buf[3] != '=');
 439                 }
 440         if ((i == 1) && (conv_ascii2bin(buf[0]) == B64_EOLN))
 441                 return(num);
 442         if ((i == 2) && (conv_ascii2bin(buf[0]) == B64_EOLN) &&
 443                 (conv_ascii2bin(buf[0]) == B64_EOLN))
 444                 return(num);
 445         return(1);
 446         }
 447 #endif