]>
git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/evp/bio_b64.c
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.]
61 #include "internal/cryptlib.h"
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
);
69 * static int b64_gets(BIO *h, char *str, int size);
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
81 typedef struct b64_struct
{
83 * BIO *bio; moved to the BIO structure
87 int tmp_len
; /* used to find the start when decoding */
88 int tmp_nl
; /* If true, scan until '\n' */
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
];
97 static BIO_METHOD methods_b64
= {
98 BIO_TYPE_BASE64
, "base64 encoding",
102 NULL
, /* b64_gets, */
109 BIO_METHOD
*BIO_f_base64(void)
111 return (&methods_b64
);
114 static int b64_new(BIO
*bi
)
118 ctx
= OPENSSL_malloc(sizeof(*ctx
));
131 bi
->ptr
= (char *)ctx
;
137 static int b64_free(BIO
*a
)
141 OPENSSL_free(a
->ptr
);
148 static int b64_read(BIO
*b
, char *out
, int outl
)
150 int ret
= 0, i
, ii
, j
, k
, x
, n
, num
, ret_code
= 0;
152 unsigned char *p
, *q
;
156 ctx
= (BIO_B64_CTX
*)b
->ptr
;
158 if ((ctx
== NULL
) || (b
->next_bio
== NULL
))
161 BIO_clear_retry_flags(b
);
163 if (ctx
->encode
!= B64_DECODE
) {
164 ctx
->encode
= B64_DECODE
;
168 EVP_DecodeInit(&(ctx
->base64
));
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
;
177 OPENSSL_assert(ctx
->buf_off
+ i
< (int)sizeof(ctx
->buf
));
178 memcpy(out
, &(ctx
->buf
[ctx
->buf_off
]), i
);
183 if (ctx
->buf_len
== ctx
->buf_off
) {
190 * At this point, we have room of outl bytes and an empty buffer, so we
191 * should read in some more.
199 i
= BIO_read(b
->next_bio
, &(ctx
->tmp
[ctx
->tmp_len
]),
200 B64_BLOCK_SIZE
- ctx
->tmp_len
);
205 /* Should we continue next time we are called? */
206 if (!BIO_should_retry(b
->next_bio
)) {
208 /* If buffer empty break */
209 if (ctx
->tmp_len
== 0)
211 /* Fall through and process what we have */
215 /* else we retry and add more data to buffer */
223 * We need to scan, a line at a time until we have a valid line if we
226 if (ctx
->start
&& (BIO_get_flags(b
) & BIO_FLAGS_BASE64_NO_NL
)) {
229 } else if (ctx
->start
) {
230 q
= p
= (unsigned char *)ctx
->tmp
;
232 for (j
= 0; j
< i
; j
++) {
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.
247 k
= EVP_DecodeUpdate(&(ctx
->base64
),
248 (unsigned char *)ctx
->buf
,
250 if ((k
<= 0) && (num
== 0) && (ctx
->start
))
251 EVP_DecodeInit(&ctx
->base64
);
253 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 reading until a
273 if (p
== (unsigned char *)&(ctx
->tmp
[0])) {
274 /* Check buffer full */
275 if (i
== B64_BLOCK_SIZE
) {
279 } else if (p
!= q
) { /* finished on a '\n' */
281 for (ii
= 0; ii
< n
; ii
++)
282 ctx
->tmp
[ii
] = p
[ii
];
285 /* else finished on a '\n' */
290 } else if ((i
< B64_BLOCK_SIZE
) && (ctx
->cont
> 0)) {
292 * If buffer isn't full and we can retry then restart to read in
298 if (BIO_get_flags(b
) & BIO_FLAGS_BASE64_NO_NL
) {
301 jj
= i
& ~3; /* process per 4 */
302 z
= EVP_DecodeBlock((unsigned char *)ctx
->buf
,
303 (unsigned char *)ctx
->tmp
, jj
);
305 if (ctx
->tmp
[jj
- 1] == '=') {
307 if (ctx
->tmp
[jj
- 2] == '=')
312 * z is now number of output bytes and jj is the number consumed
315 memmove(ctx
->tmp
, &ctx
->tmp
[jj
], i
- jj
);
316 ctx
->tmp_len
= i
- jj
;
324 i
= EVP_DecodeUpdate(&(ctx
->base64
),
325 (unsigned char *)ctx
->buf
, &ctx
->buf_len
,
326 (unsigned char *)ctx
->tmp
, i
);
336 if (ctx
->buf_len
<= outl
)
341 memcpy(out
, ctx
->buf
, i
);
344 if (ctx
->buf_off
== ctx
->buf_len
) {
351 /* BIO_clear_retry_flags(b); */
352 BIO_copy_next_retry(b
);
353 return ((ret
== 0) ? ret_code
: ret
);
356 static int b64_write(BIO
*b
, const char *in
, int inl
)
363 ctx
= (BIO_B64_CTX
*)b
->ptr
;
364 BIO_clear_retry_flags(b
);
366 if (ctx
->encode
!= B64_ENCODE
) {
367 ctx
->encode
= B64_ENCODE
;
371 EVP_EncodeInit(&(ctx
->base64
));
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
;
379 i
= BIO_write(b
->next_bio
, &(ctx
->buf
[ctx
->buf_off
]), n
);
381 BIO_copy_next_retry(b
);
384 OPENSSL_assert(i
<= n
);
386 OPENSSL_assert(ctx
->buf_off
<= (int)sizeof(ctx
->buf
));
387 OPENSSL_assert(ctx
->buf_len
>= ctx
->buf_off
);
390 /* at this point all pending data has been written */
394 if ((in
== NULL
) || (inl
<= 0))
398 n
= (inl
> B64_BLOCK_SIZE
) ? B64_BLOCK_SIZE
: inl
;
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
;
405 * There's a theoretical possibility for this
409 memcpy(&(ctx
->tmp
[ctx
->tmp_len
]), in
, n
);
412 if (ctx
->tmp_len
< 3)
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
);
420 * Since we're now done using the temporary buffer, the
421 * length should be 0'd
426 memcpy(ctx
->tmp
, in
, n
);
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
);
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
);
453 i
= BIO_write(b
->next_bio
, &(ctx
->buf
[ctx
->buf_off
]), n
);
455 BIO_copy_next_retry(b
);
456 return ((ret
== 0) ? i
: ret
);
458 OPENSSL_assert(i
<= n
);
461 OPENSSL_assert(ctx
->buf_off
<= (int)sizeof(ctx
->buf
));
462 OPENSSL_assert(ctx
->buf_len
>= ctx
->buf_off
);
470 static long b64_ctrl(BIO
*b
, int cmd
, long num
, void *ptr
)
476 ctx
= (BIO_B64_CTX
*)b
->ptr
;
482 ctx
->encode
= B64_NONE
;
483 ret
= BIO_ctrl(b
->next_bio
, cmd
, num
, ptr
);
485 case BIO_CTRL_EOF
: /* More to read */
489 ret
= BIO_ctrl(b
->next_bio
, cmd
, num
, ptr
);
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))
498 ret
= BIO_ctrl(b
->next_bio
, cmd
, num
, ptr
);
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
;
504 ret
= BIO_ctrl(b
->next_bio
, cmd
, num
, ptr
);
507 /* do a final write */
509 while (ctx
->buf_len
!= ctx
->buf_off
) {
510 i
= b64_write(b
, NULL
, 0);
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
,
523 } else if (ctx
->encode
!= B64_NONE
&& ctx
->base64
.num
!= 0) {
525 EVP_EncodeFinal(&(ctx
->base64
),
526 (unsigned char *)ctx
->buf
, &(ctx
->buf_len
));
527 /* push out the bytes */
530 /* Finally flush the underlying BIO */
531 ret
= BIO_ctrl(b
->next_bio
, cmd
, num
, ptr
);
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
);
546 ret
= BIO_ctrl(b
->next_bio
, cmd
, num
, ptr
);
552 static long b64_callback_ctrl(BIO
*b
, int cmd
, bio_info_cb
*fp
)
556 if (b
->next_bio
== NULL
)
560 ret
= BIO_callback_ctrl(b
->next_bio
, cmd
, fp
);
566 static int b64_puts(BIO
*b
, const char *str
)
568 return b64_write(b
, str
, strlen(str
));