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