Reinstate accidentally deleted code.
[openssl.git] / 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 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 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              unsigned char *in, int inl)
133         {
134         int i,j;
135         unsigned int total=0;
136
137         *outl=0;
138         if (inl == 0) return;
139         if ((ctx->num+inl) < ctx->length)
140                 {
141                 memcpy(&(ctx->enc_data[ctx->num]),in,inl);
142                 ctx->num+=inl;
143                 return;
144                 }
145         if (ctx->num != 0)
146                 {
147                 i=ctx->length-ctx->num;
148                 memcpy(&(ctx->enc_data[ctx->num]),in,i);
149                 in+=i;
150                 inl-=i;
151                 j=EVP_EncodeBlock(out,ctx->enc_data,ctx->length);
152                 ctx->num=0;
153                 out+=j;
154                 *(out++)='\n';
155                 *out='\0';
156                 total=j+1;
157                 }
158         while (inl >= ctx->length)
159                 {
160                 j=EVP_EncodeBlock(out,in,ctx->length);
161                 in+=ctx->length;
162                 inl-=ctx->length;
163                 out+=j;
164                 *(out++)='\n';
165                 *out='\0';
166                 total+=j+1;
167                 }
168         if (inl != 0)
169                 memcpy(&(ctx->enc_data[0]),in,inl);
170         ctx->num=inl;
171         *outl=total;
172         }
173
174 void EVP_EncodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl)
175         {
176         unsigned int ret=0;
177
178         if (ctx->num != 0)
179                 {
180                 ret=EVP_EncodeBlock(out,ctx->enc_data,ctx->num);
181                 out[ret++]='\n';
182                 out[ret]='\0';
183                 ctx->num=0;
184                 }
185         *outl=ret;
186         }
187
188 int EVP_EncodeBlock(unsigned char *t, const unsigned char *f, int dlen)
189         {
190         int i,ret=0;
191         unsigned long l;
192
193         for (i=dlen; i > 0; i-=3)
194                 {
195                 if (i >= 3)
196                         {
197                         l=      (((unsigned long)f[0])<<16L)|
198                                 (((unsigned long)f[1])<< 8L)|f[2];
199                         *(t++)=conv_bin2ascii(l>>18L);
200                         *(t++)=conv_bin2ascii(l>>12L);
201                         *(t++)=conv_bin2ascii(l>> 6L);
202                         *(t++)=conv_bin2ascii(l     );
203                         }
204                 else
205                         {
206                         l=((unsigned long)f[0])<<16L;
207                         if (i == 2) l|=((unsigned long)f[1]<<8L);
208
209                         *(t++)=conv_bin2ascii(l>>18L);
210                         *(t++)=conv_bin2ascii(l>>12L);
211                         *(t++)=(i == 1)?'=':conv_bin2ascii(l>> 6L);
212                         *(t++)='=';
213                         }
214                 ret+=4;
215                 f+=3;
216                 }
217
218         *t='\0';
219         return(ret);
220         }
221
222 void EVP_DecodeInit(EVP_ENCODE_CTX *ctx)
223         {
224         ctx->length=30;
225         ctx->num=0;
226         ctx->line_num=0;
227         ctx->expect_nl=0;
228         }
229
230 /* -1 for error
231  *  0 for last line
232  *  1 for full line
233  */
234 int EVP_DecodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl,
235              unsigned char *in, int inl)
236         {
237         int seof= -1,eof=0,rv= -1,ret=0,i,v,tmp,n,ln,tmp2,exp_nl;
238         unsigned char *d;
239
240         n=ctx->num;
241         d=ctx->enc_data;
242         ln=ctx->line_num;
243         exp_nl=ctx->expect_nl;
244
245         /* last line of input. */
246         if ((inl == 0) || ((n == 0) && (conv_ascii2bin(in[0]) == B64_EOF)))
247                 { rv=0; goto end; }
248                 
249         /* We parse the input data */
250         for (i=0; i<inl; i++)
251                 {
252                 /* If the current line is > 80 characters, scream alot */
253                 if (ln >= 80) { rv= -1; goto end; }
254
255                 /* Get char and put it into the buffer */
256                 tmp= *(in++);
257                 v=conv_ascii2bin(tmp);
258                 /* only save the good data :-) */
259                 if (!B64_NOT_BASE64(v))
260                         {
261                         d[n++]=tmp;
262                         ln++;
263                         }
264                 else if (v == B64_ERROR)
265                         {
266                         rv= -1;
267                         goto end;
268                         }
269
270                 /* have we seen a '=' which is 'definitly' the last
271                  * input line.  seof will point to the character that
272                  * holds it. and eof will hold how many characters to
273                  * chop off. */
274                 if (tmp == '=')
275                         {
276                         if (seof == -1) seof=n;
277                         eof++;
278                         }
279
280                 /* eoln */
281                 if (v == B64_EOLN)
282                         {
283                         ln=0;
284                         if (exp_nl)
285                                 {
286                                 exp_nl=0;
287                                 continue;
288                                 }
289                         }
290                 exp_nl=0;
291
292                 /* If we are at the end of input and it looks like a
293                  * line, process it. */
294                 if (((i+1) == inl) && (((n&3) == 0) || eof))
295                         {
296                         v=B64_EOF;
297                         /* In case things were given us in really small
298                            records (so two '=' were given in separate
299                            updates), eof may contain the incorrect number
300                            of ending bytes to skip, so let's redo the count */
301                         eof = 0;
302                         if (d[n-1] == '=') eof++;
303                         if (d[n-2] == '=') eof++;
304                         /* There will never be more than two '=' */
305                         }
306
307                 if ((v == B64_EOF) || (n >= 64))
308                         {
309                         /* This is needed to work correctly on 64 byte input
310                          * lines.  We process the line and then need to
311                          * accept the '\n' */
312                         if ((v != B64_EOF) && (n >= 64)) exp_nl=1;
313                         tmp2=v;
314                         if (n > 0)
315                                 {
316                                 v=EVP_DecodeBlock(out,d,n);
317                                 if (v < 0) { rv=0; goto end; }
318                                 n=0;
319                                 ret+=(v-eof);
320                                 }
321                         else
322                                 {
323                                 eof=1;
324                                 v=0;
325                                 }
326
327                         /* This is the case where we have had a short
328                          * but valid input line */
329                         if ((v < ctx->length) && eof)
330                                 {
331                                 rv=0;
332                                 goto end;
333                                 }
334                         else
335                                 ctx->length=v;
336
337                         if (seof >= 0) { rv=0; goto end; }
338                         out+=v;
339                         }
340                 }
341         rv=1;
342 end:
343         *outl=ret;
344         ctx->num=n;
345         ctx->line_num=ln;
346         ctx->expect_nl=exp_nl;
347         return(rv);
348         }
349
350 int EVP_DecodeBlock(unsigned char *t, const unsigned char *f, int n)
351         {
352         int i,ret=0,a,b,c,d;
353         unsigned long l;
354
355         /* trim white space from the start of the line. */
356         while ((conv_ascii2bin(*f) == B64_WS) && (n > 0))
357                 {
358                 f++;
359                 n--;
360                 }
361
362         /* strip off stuff at the end of the line
363          * ascii2bin values B64_WS, B64_EOLN, B64_EOLN and B64_EOF */
364         while ((n > 3) && (B64_NOT_BASE64(conv_ascii2bin(f[n-1]))))
365                 n--;
366
367         if (n%4 != 0) return(-1);
368
369         for (i=0; i<n; i+=4)
370                 {
371                 a=conv_ascii2bin(*(f++));
372                 b=conv_ascii2bin(*(f++));
373                 c=conv_ascii2bin(*(f++));
374                 d=conv_ascii2bin(*(f++));
375                 if (    (a & 0x80) || (b & 0x80) ||
376                         (c & 0x80) || (d & 0x80))
377                         return(-1);
378                 l=(     (((unsigned long)a)<<18L)|
379                         (((unsigned long)b)<<12L)|
380                         (((unsigned long)c)<< 6L)|
381                         (((unsigned long)d)     ));
382                 *(t++)=(unsigned char)(l>>16L)&0xff;
383                 *(t++)=(unsigned char)(l>> 8L)&0xff;
384                 *(t++)=(unsigned char)(l     )&0xff;
385                 ret+=3;
386                 }
387         return(ret);
388         }
389
390 int EVP_DecodeFinal(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl)
391         {
392         int i;
393
394         *outl=0;
395         if (ctx->num != 0)
396                 {
397                 i=EVP_DecodeBlock(out,ctx->enc_data,ctx->num);
398                 if (i < 0) return(-1);
399                 ctx->num=0;
400                 *outl=i;
401                 return(1);
402                 }
403         else
404                 return(1);
405         }
406
407 #ifdef undef
408 int EVP_DecodeValid(unsigned char *buf, int len)
409         {
410         int i,num=0,bad=0;
411
412         if (len == 0) return(-1);
413         while (conv_ascii2bin(*buf) == B64_WS)
414                 {
415                 buf++;
416                 len--;
417                 if (len == 0) return(-1);
418                 }
419
420         for (i=len; i >= 4; i-=4)
421                 {
422                 if (    (conv_ascii2bin(buf[0]) >= 0x40) ||
423                         (conv_ascii2bin(buf[1]) >= 0x40) ||
424                         (conv_ascii2bin(buf[2]) >= 0x40) ||
425                         (conv_ascii2bin(buf[3]) >= 0x40))
426                         return(-1);
427                 buf+=4;
428                 num+=1+(buf[2] != '=')+(buf[3] != '=');
429                 }
430         if ((i == 1) && (conv_ascii2bin(buf[0]) == B64_EOLN))
431                 return(num);
432         if ((i == 2) && (conv_ascii2bin(buf[0]) == B64_EOLN) &&
433                 (conv_ascii2bin(buf[0]) == B64_EOLN))
434                 return(num);
435         return(1);
436         }
437 #endif