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_zalloc(sizeof(*ctx));
124 ctx->base64 = EVP_ENCODE_CTX_new();
126 bi->ptr = (char *)ctx;
132 static int b64_free(BIO *a)
136 EVP_ENCODE_CTX_free(((BIO_B64_CTX *)a->ptr)->base64);
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;
148 unsigned char *p, *q;
152 ctx = (BIO_B64_CTX *)b->ptr;
154 if ((ctx == NULL) || (b->next_bio == NULL))
157 BIO_clear_retry_flags(b);
159 if (ctx->encode != B64_DECODE) {
160 ctx->encode = B64_DECODE;
164 EVP_DecodeInit(ctx->base64);
167 /* First check if there are bytes decoded/encoded */
168 if (ctx->buf_len > 0) {
169 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
170 i = ctx->buf_len - ctx->buf_off;
173 OPENSSL_assert(ctx->buf_off + i < (int)sizeof(ctx->buf));
174 memcpy(out, &(ctx->buf[ctx->buf_off]), i);
179 if (ctx->buf_len == ctx->buf_off) {
186 * At this point, we have room of outl bytes and an empty buffer, so we
187 * should read in some more.
195 i = BIO_read(b->next_bio, &(ctx->tmp[ctx->tmp_len]),
196 B64_BLOCK_SIZE - ctx->tmp_len);
201 /* Should we continue next time we are called? */
202 if (!BIO_should_retry(b->next_bio)) {
204 /* If buffer empty break */
205 if (ctx->tmp_len == 0)
207 /* Fall through and process what we have */
211 /* else we retry and add more data to buffer */
219 * We need to scan, a line at a time until we have a valid line if we
222 if (ctx->start && (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL)) {
225 } else if (ctx->start) {
226 q = p = (unsigned char *)ctx->tmp;
228 for (j = 0; j < i; j++) {
233 * due to a previous very long line, we need to keep on
234 * scanning for a '\n' before we even start looking for
235 * base64 encoded stuff.
243 k = EVP_DecodeUpdate(ctx->base64,
244 (unsigned char *)ctx->buf,
246 if ((k <= 0) && (num == 0) && (ctx->start))
247 EVP_DecodeInit(ctx->base64);
249 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 */
264 if ((j == i) && (num == 0)) {
266 * Is this is one long chunk?, if so, keep on reading until a
269 if (p == (unsigned char *)&(ctx->tmp[0])) {
270 /* Check buffer full */
271 if (i == B64_BLOCK_SIZE) {
275 } else if (p != q) { /* finished on a '\n' */
277 for (ii = 0; ii < n; ii++)
278 ctx->tmp[ii] = p[ii];
281 /* else finished on a '\n' */
286 } else if ((i < B64_BLOCK_SIZE) && (ctx->cont > 0)) {
288 * If buffer isn't full and we can retry then restart to read in
294 if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL) {
297 jj = i & ~3; /* process per 4 */
298 z = EVP_DecodeBlock((unsigned char *)ctx->buf,
299 (unsigned char *)ctx->tmp, jj);
301 if (ctx->tmp[jj - 1] == '=') {
303 if (ctx->tmp[jj - 2] == '=')
308 * z is now number of output bytes and jj is the number consumed
311 memmove(ctx->tmp, &ctx->tmp[jj], i - jj);
312 ctx->tmp_len = i - jj;
320 i = EVP_DecodeUpdate(ctx->base64,
321 (unsigned char *)ctx->buf, &ctx->buf_len,
322 (unsigned char *)ctx->tmp, i);
332 if (ctx->buf_len <= outl)
337 memcpy(out, ctx->buf, i);
340 if (ctx->buf_off == ctx->buf_len) {
347 /* BIO_clear_retry_flags(b); */
348 BIO_copy_next_retry(b);
349 return ((ret == 0) ? ret_code : ret);
352 static int b64_write(BIO *b, const char *in, int inl)
359 ctx = (BIO_B64_CTX *)b->ptr;
360 BIO_clear_retry_flags(b);
362 if (ctx->encode != B64_ENCODE) {
363 ctx->encode = B64_ENCODE;
367 EVP_EncodeInit(ctx->base64);
370 OPENSSL_assert(ctx->buf_off < (int)sizeof(ctx->buf));
371 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
372 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
373 n = ctx->buf_len - ctx->buf_off;
375 i = BIO_write(b->next_bio, &(ctx->buf[ctx->buf_off]), n);
377 BIO_copy_next_retry(b);
380 OPENSSL_assert(i <= n);
382 OPENSSL_assert(ctx->buf_off <= (int)sizeof(ctx->buf));
383 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
386 /* at this point all pending data has been written */
390 if ((in == NULL) || (inl <= 0))
394 n = (inl > B64_BLOCK_SIZE) ? B64_BLOCK_SIZE : inl;
396 if (BIO_get_flags(b) & BIO_FLAGS_BASE64_NO_NL) {
397 if (ctx->tmp_len > 0) {
398 OPENSSL_assert(ctx->tmp_len <= 3);
399 n = 3 - ctx->tmp_len;
401 * There's a theoretical possibility for this
405 memcpy(&(ctx->tmp[ctx->tmp_len]), in, n);
408 if (ctx->tmp_len < 3)
411 EVP_EncodeBlock((unsigned char *)ctx->buf,
412 (unsigned char *)ctx->tmp, ctx->tmp_len);
413 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
414 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
416 * Since we're now done using the temporary buffer, the
417 * length should be 0'd
422 memcpy(ctx->tmp, in, n);
429 EVP_EncodeBlock((unsigned char *)ctx->buf,
430 (const unsigned char *)in, n);
431 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
432 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
436 EVP_EncodeUpdate(ctx->base64,
437 (unsigned char *)ctx->buf, &ctx->buf_len,
438 (unsigned char *)in, n);
439 OPENSSL_assert(ctx->buf_len <= (int)sizeof(ctx->buf));
440 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
449 i = BIO_write(b->next_bio, &(ctx->buf[ctx->buf_off]), n);
451 BIO_copy_next_retry(b);
452 return ((ret == 0) ? i : ret);
454 OPENSSL_assert(i <= n);
457 OPENSSL_assert(ctx->buf_off <= (int)sizeof(ctx->buf));
458 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
466 static long b64_ctrl(BIO *b, int cmd, long num, void *ptr)
472 ctx = (BIO_B64_CTX *)b->ptr;
478 ctx->encode = B64_NONE;
479 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
481 case BIO_CTRL_EOF: /* More to read */
485 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
487 case BIO_CTRL_WPENDING: /* More to write in buffer */
488 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
489 ret = ctx->buf_len - ctx->buf_off;
490 if ((ret == 0) && (ctx->encode != B64_NONE)
491 && (EVP_ENCODE_CTX_num(ctx->base64) != 0))
494 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
496 case BIO_CTRL_PENDING: /* More to read in buffer */
497 OPENSSL_assert(ctx->buf_len >= ctx->buf_off);
498 ret = ctx->buf_len - ctx->buf_off;
500 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
503 /* do a final write */
505 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) {
511 if (ctx->tmp_len != 0) {
512 ctx->buf_len = EVP_EncodeBlock((unsigned char *)ctx->buf,
513 (unsigned char *)ctx->tmp,
519 } else if (ctx->encode != B64_NONE
520 && EVP_ENCODE_CTX_num(ctx->base64) != 0) {
522 EVP_EncodeFinal(ctx->base64,
523 (unsigned char *)ctx->buf, &(ctx->buf_len));
524 /* push out the bytes */
527 /* Finally flush the underlying BIO */
528 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
531 case BIO_C_DO_STATE_MACHINE:
532 BIO_clear_retry_flags(b);
533 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
534 BIO_copy_next_retry(b);
543 ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
549 static long b64_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
553 if (b->next_bio == NULL)
557 ret = BIO_callback_ctrl(b->next_bio, cmd, fp);
563 static int b64_puts(BIO *b, const char *str)
565 return b64_write(b, str, strlen(str));