1 /* crypto/evp/bio_b64.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
62 #include <openssl/buffer.h>
63 #include <openssl/evp.h>
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 /*static int b64_gets(BIO *h, char *str, int size); */
69 static long b64_ctrl(BIO *h, int cmd, long arg1, void *arg2);
70 static int b64_new(BIO *h);
71 static int b64_free(BIO *data);
72 static long b64_callback_ctrl(BIO *h,int cmd,bio_info_cb *fp);
73 #define B64_BLOCK_SIZE 1024
74 #define B64_BLOCK_SIZE2 768
79 typedef struct b64_struct
81 /*BIO *bio; moved to the BIO structure */
84 int tmp_len; /* used to find the start when decoding */
85 int tmp_nl; /* If true, scan until '\n' */
87 int start; /* have we started decoding yet? */
88 int cont; /* <= 0 when finished */
89 EVP_ENCODE_CTX base64;
90 char buf[EVP_ENCODE_LENGTH(B64_BLOCK_SIZE)+10];
91 char tmp[B64_BLOCK_SIZE];
94 static BIO_METHOD methods_b64=
96 BIO_TYPE_BASE64,"base64 encoding",
100 NULL, /* b64_gets, */
107 BIO_METHOD *BIO_f_base64(void)
109 return(&methods_b64);
112 static int b64_new(BIO *bi)
116 ctx=(BIO_B64_CTX *)OPENSSL_malloc(sizeof(BIO_B64_CTX));
117 if (ctx == NULL) return(0);
134 static int b64_free(BIO *a)
136 if (a == NULL) return(0);
137 OPENSSL_free(a->ptr);
144 static int b64_read(BIO *b, char *out, int outl)
146 int ret=0,i,ii,j,k,x,n,num,ret_code=0;
150 if (out == NULL) return(0);
151 ctx=(BIO_B64_CTX *)b->ptr;
153 if ((ctx == NULL) || (b->next_bio == NULL)) return(0);
155 BIO_clear_retry_flags(b);
157 if (ctx->encode != B64_DECODE)
159 ctx->encode=B64_DECODE;
163 EVP_DecodeInit(&(ctx->base64));
166 /* First check if there are bytes decoded/encoded */
167 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) i=outl;
172 OPENSSL_assert(ctx->buf_off+i < (int)sizeof(ctx->buf));
173 memcpy(out,&(ctx->buf[ctx->buf_off]),i);
178 if (ctx->buf_len == ctx->buf_off)
185 /* At this point, we have room of outl bytes and an empty
186 * buffer, so we should read in some more. */
194 i=BIO_read(b->next_bio,&(ctx->tmp[ctx->tmp_len]),
195 B64_BLOCK_SIZE-ctx->tmp_len);
201 /* Should we continue next time we are called? */
202 if (!BIO_should_retry(b->next_bio))
205 /* If buffer empty break */
206 if(ctx->tmp_len == 0)
208 /* Fall through and process what we have */
212 /* else we retry and add more data to buffer */
219 /* We need to scan, a line at a time until we
220 * have a valid line if we are starting. */
221 if (ctx->start && (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL))
228 q=p=(unsigned char *)ctx->tmp;
232 if (*(q++) != '\n') continue;
234 /* due to a previous very long line,
235 * we need to keep on scanning for a '\n'
236 * before we even start looking for
237 * base64 encoded stuff. */
245 k=EVP_DecodeUpdate(&(ctx->base64),
246 (unsigned char *)ctx->buf,
248 if ((k <= 0) && (num == 0) && (ctx->start))
249 EVP_DecodeInit(&ctx->base64);
252 if (p != (unsigned char *)
255 i-=(p- (unsigned char *)
257 for (x=0; x < i; x++)
260 EVP_DecodeInit(&ctx->base64);
267 /* we fell off the end without starting */
268 if ((j == i) && (num == 0))
270 /* Is this is one long chunk?, if so, keep on
271 * reading until a new line. */
272 if (p == (unsigned char *)&(ctx->tmp[0]))
274 /* Check buffer full */
275 if (i == B64_BLOCK_SIZE)
281 else if (p != q) /* finished on a '\n' */
284 for (ii=0; ii<n; ii++)
288 /* else finished on a '\n' */
296 else if ((i < B64_BLOCK_SIZE) && (ctx->cont > 0))
298 /* If buffer isn't full and we can retry then
299 * restart to read in more data.
304 if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL)
311 jj = i & ~3; /* process per 4 */
313 z=EVP_DecodeBlock((unsigned char *)ctx->buf,
314 (unsigned char *)ctx->tmp,jj);
317 if (ctx->tmp[jj-1] == '=')
320 if (ctx->tmp[jj-2] == '=')
324 /* z is now number of output bytes and jj is the
328 memmove(ctx->tmp, &ctx->tmp[jj], i-jj);
340 i=EVP_DecodeUpdate(&(ctx->base64),
341 (unsigned char *)ctx->buf,&ctx->buf_len,
342 (unsigned char *)ctx->tmp,i);
353 if (ctx->buf_len <= outl)
358 memcpy(out,ctx->buf,i);
361 if (ctx->buf_off == ctx->buf_len)
369 /* BIO_clear_retry_flags(b); */
370 BIO_copy_next_retry(b);
371 return((ret == 0)?ret_code:ret);
374 static int b64_write(BIO *b, const char *in, int inl)
381 ctx=(BIO_B64_CTX *)b->ptr;
382 BIO_clear_retry_flags(b);
384 if (ctx->encode != B64_ENCODE)
386 ctx->encode=B64_ENCODE;
390 EVP_EncodeInit(&(ctx->base64));
393 OPENSSL_assert(ctx->buf_off < (int)sizeof(ctx->buf));
394 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
395 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
396 n=ctx->buf_len-ctx->buf_off;
399 i=BIO_write(b->next_bio,&(ctx->buf[ctx->buf_off]),n);
402 BIO_copy_next_retry(b);
405 OPENSSL_assert(i <= n);
407 OPENSSL_assert(ctx->buf_off <= (int)sizeof(ctx->buf));
408 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
411 /* at this point all pending data has been written */
415 if ((in == NULL) || (inl <= 0)) return(0);
419 n=(inl > B64_BLOCK_SIZE)?B64_BLOCK_SIZE:inl;
421 if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL)
423 if (ctx->tmp_len > 0)
425 OPENSSL_assert(ctx->tmp_len <= 3);
427 /* There's a theoretical possibility for this */
430 memcpy(&(ctx->tmp[ctx->tmp_len]),in,n);
433 if (ctx->tmp_len < 3)
435 ctx->buf_len=EVP_EncodeBlock((unsigned char *)ctx->buf,(unsigned char *)ctx->tmp,ctx->tmp_len);
436 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
437 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
438 /* Since we're now done using the temporary
439 buffer, the length should be 0'd */
446 memcpy(ctx->tmp,in,n);
452 ctx->buf_len=EVP_EncodeBlock((unsigned char *)ctx->buf,(const unsigned char *)in,n);
453 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
454 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
460 EVP_EncodeUpdate(&(ctx->base64),
461 (unsigned char *)ctx->buf,&ctx->buf_len,
462 (unsigned char *)in,n);
463 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
464 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
474 i=BIO_write(b->next_bio,&(ctx->buf[ctx->buf_off]),n);
477 BIO_copy_next_retry(b);
478 return((ret == 0)?i:ret);
480 OPENSSL_assert(i <= n);
483 OPENSSL_assert(ctx->buf_off <= (int)sizeof(ctx->buf));
484 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
492 static long b64_ctrl(BIO *b, int cmd, long num, void *ptr)
498 ctx=(BIO_B64_CTX *)b->ptr;
505 ctx->encode=B64_NONE;
506 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
508 case BIO_CTRL_EOF: /* More to read */
512 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
514 case BIO_CTRL_WPENDING: /* More to write in buffer */
515 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
516 ret=ctx->buf_len-ctx->buf_off;
517 if ((ret == 0) && (ctx->encode != B64_NONE)
518 && (ctx->base64.num != 0))
521 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
523 case BIO_CTRL_PENDING: /* More to read in buffer */
524 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
525 ret=ctx->buf_len-ctx->buf_off;
527 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
530 /* do a final write */
532 while (ctx->buf_len != ctx->buf_off)
534 i=b64_write(b,NULL,0);
538 if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL)
540 if (ctx->tmp_len != 0)
542 ctx->buf_len=EVP_EncodeBlock(
543 (unsigned char *)ctx->buf,
544 (unsigned char *)ctx->tmp,
551 else if (ctx->encode != B64_NONE && ctx->base64.num != 0)
554 EVP_EncodeFinal(&(ctx->base64),
555 (unsigned char *)ctx->buf,
557 /* push out the bytes */
560 /* Finally flush the underlying BIO */
561 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
564 case BIO_C_DO_STATE_MACHINE:
565 BIO_clear_retry_flags(b);
566 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
567 BIO_copy_next_retry(b);
576 ret=BIO_ctrl(b->next_bio,cmd,num,ptr);
582 static long b64_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
586 if (b->next_bio == NULL) return(0);
590 ret=BIO_callback_ctrl(b->next_bio,cmd,fp);
596 static int b64_puts(BIO *b, const char *str)
598 return b64_write(b,str,strlen(str));