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);
133 static int b64_free(BIO
*a
)
135 if (a
== NULL
) return(0);
136 OPENSSL_free(a
->ptr
);
143 static int b64_read(BIO
*b
, char *out
, int outl
)
145 int ret
=0,i
,ii
,j
,k
,x
,n
,num
,ret_code
=0;
149 if (out
== NULL
) return(0);
150 ctx
=(BIO_B64_CTX
*)b
->ptr
;
152 if ((ctx
== NULL
) || (b
->next_bio
== NULL
)) return(0);
154 if (ctx
->encode
!= B64_DECODE
)
156 ctx
->encode
=B64_DECODE
;
160 EVP_DecodeInit(&(ctx
->base64
));
163 /* First check if there are bytes decoded/encoded */
164 if (ctx
->buf_len
> 0)
166 i
=ctx
->buf_len
-ctx
->buf_off
;
167 if (i
> outl
) i
=outl
;
168 OPENSSL_assert(ctx
->buf_off
+i
< sizeof ctx
->buf
);
169 memcpy(out
,&(ctx
->buf
[ctx
->buf_off
]),i
);
174 if (ctx
->buf_len
== ctx
->buf_off
)
181 /* At this point, we have room of outl bytes and an empty
182 * buffer, so we should read in some more. */
191 i
=BIO_read(b
->next_bio
,&(ctx
->tmp
[ctx
->tmp_len
]),
192 B64_BLOCK_SIZE
-ctx
->tmp_len
);
198 /* Should be continue next time we are called? */
199 if (!BIO_should_retry(b
->next_bio
))
202 /* If buffer empty break */
203 if(ctx
->tmp_len
== 0)
205 /* Fall through and process what we have */
209 /* else we retry and add more data to buffer */
216 /* We need to scan, a line at a time until we
217 * have a valid line if we are starting. */
218 if (ctx
->start
&& (BIO_get_flags(b
) & BIO_FLAGS_BASE64_NO_NL
))
225 q
=p
=(unsigned char *)ctx
->tmp
;
228 if (*(q
++) != '\n') continue;
230 /* due to a previous very long line,
231 * we need to keep on scanning for a '\n'
232 * before we even start looking for
233 * base64 encoded stuff. */
241 k
=EVP_DecodeUpdate(&(ctx
->base64
),
242 (unsigned char *)ctx
->buf
,
244 if ((k
<= 0) && (num
== 0) && (ctx
->start
))
245 EVP_DecodeInit(&ctx
->base64
);
248 if (p
!= (unsigned char *)
251 i
-=(p
- (unsigned char *)
253 for (x
=0; x
< i
; x
++)
256 EVP_DecodeInit(&ctx
->base64
);
263 /* we fell off the end without starting */
266 /* Is this is one long chunk?, if so, keep on
267 * reading until a new line. */
268 if (p
== (unsigned char *)&(ctx
->tmp
[0]))
270 /* Check buffer full */
271 if (i
== B64_BLOCK_SIZE
)
277 else if (p
!= q
) /* finished on a '\n' */
280 for (ii
=0; ii
<n
; ii
++)
284 /* else finished on a '\n' */
290 /* If buffer isn't full and we can retry then
291 * restart to read in more data.
293 else if ((i
< B64_BLOCK_SIZE
) && (ctx
->cont
> 0))
296 if (BIO_get_flags(b
) & BIO_FLAGS_BASE64_NO_NL
)
301 z
=EVP_DecodeBlock((unsigned char *)ctx
->buf
,
302 (unsigned char *)ctx
->tmp
,jj
);
305 if (ctx
->tmp
[jj
-1] == '=')
308 if (ctx
->tmp
[jj
-2] == '=')
312 /* z is now number of output bytes and jj is the
316 memcpy((unsigned char *)ctx
->tmp
,
317 (unsigned char *)&(ctx
->tmp
[jj
]),i
-jj
);
331 i
=EVP_DecodeUpdate(&(ctx
->base64
),
332 (unsigned char *)ctx
->buf
,&ctx
->buf_len
,
333 (unsigned char *)ctx
->tmp
,i
);
344 if (ctx
->buf_len
<= outl
)
349 memcpy(out
,ctx
->buf
,i
);
352 if (ctx
->buf_off
== ctx
->buf_len
)
360 BIO_clear_retry_flags(b
);
361 BIO_copy_next_retry(b
);
362 return((ret
== 0)?ret_code
:ret
);
365 static int b64_write(BIO
*b
, const char *in
, int inl
)
370 ctx
=(BIO_B64_CTX
*)b
->ptr
;
371 BIO_clear_retry_flags(b
);
373 if (ctx
->encode
!= B64_ENCODE
)
375 ctx
->encode
=B64_ENCODE
;
379 EVP_EncodeInit(&(ctx
->base64
));
382 n
=ctx
->buf_len
-ctx
->buf_off
;
385 i
=BIO_write(b
->next_bio
,&(ctx
->buf
[ctx
->buf_off
]),n
);
388 BIO_copy_next_retry(b
);
394 /* at this point all pending data has been written */
398 if ((in
== NULL
) || (inl
<= 0)) return(0);
402 n
=(inl
> B64_BLOCK_SIZE
)?B64_BLOCK_SIZE
:inl
;
404 if (BIO_get_flags(b
) & BIO_FLAGS_BASE64_NO_NL
)
406 if (ctx
->tmp_len
> 0)
409 /* There's a teoretical possibility for this */
412 memcpy(&(ctx
->tmp
[ctx
->tmp_len
]),in
,n
);
414 if (ctx
->tmp_len
< 3)
416 ctx
->buf_len
=EVP_EncodeBlock(
417 (unsigned char *)ctx
->buf
,
418 (unsigned char *)ctx
->tmp
,
420 /* Since we're now done using the temporary
421 buffer, the length should be 0'd */
428 memcpy(&(ctx
->tmp
[0]),in
,n
);
433 ctx
->buf_len
=EVP_EncodeBlock(
434 (unsigned char *)ctx
->buf
,
435 (unsigned char *)in
,n
);
440 EVP_EncodeUpdate(&(ctx
->base64
),
441 (unsigned char *)ctx
->buf
,&ctx
->buf_len
,
442 (unsigned char *)in
,n
);
451 i
=BIO_write(b
->next_bio
,&(ctx
->buf
[ctx
->buf_off
]),n
);
454 BIO_copy_next_retry(b
);
455 return((ret
== 0)?i
:ret
);
466 static long b64_ctrl(BIO
*b
, int cmd
, long num
, void *ptr
)
472 ctx
=(BIO_B64_CTX
*)b
->ptr
;
479 ctx
->encode
=B64_NONE
;
480 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
482 case BIO_CTRL_EOF
: /* More to read */
486 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
488 case BIO_CTRL_WPENDING
: /* More to write in buffer */
489 ret
=ctx
->buf_len
-ctx
->buf_off
;
490 if ((ret
== 0) && (ctx
->encode
!= B64_NONE
)
491 && (ctx
->base64
.num
!= 0))
494 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
496 case BIO_CTRL_PENDING
: /* More to read in buffer */
497 ret
=ctx
->buf_len
-ctx
->buf_off
;
499 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
502 /* do a final write */
504 while (ctx
->buf_len
!= ctx
->buf_off
)
506 i
=b64_write(b
,NULL
,0);
510 if (BIO_get_flags(b
) & BIO_FLAGS_BASE64_NO_NL
)
512 if (ctx
->tmp_len
!= 0)
514 ctx
->buf_len
=EVP_EncodeBlock(
515 (unsigned char *)ctx
->buf
,
516 (unsigned char *)ctx
->tmp
,
523 else if (ctx
->encode
!= B64_NONE
&& ctx
->base64
.num
!= 0)
526 EVP_EncodeFinal(&(ctx
->base64
),
527 (unsigned char *)ctx
->buf
,
529 /* push out the bytes */
532 /* Finally flush the underlying BIO */
533 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
536 case BIO_C_DO_STATE_MACHINE
:
537 BIO_clear_retry_flags(b
);
538 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
539 BIO_copy_next_retry(b
);
548 ret
=BIO_ctrl(b
->next_bio
,cmd
,num
,ptr
);
554 static long b64_callback_ctrl(BIO
*b
, int cmd
, bio_info_cb
*fp
)
558 if (b
->next_bio
== NULL
) return(0);
562 ret
=BIO_callback_ctrl(b
->next_bio
,cmd
,fp
);