crypto/bio/bf_lbuf.c

   1 /* crypto/bio/bf_buff.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 "cryptlib.h"
  62 #include <openssl/bio.h>
  63 #include <openssl/evp.h>
  64
  65 static int linebuffer_write(BIO *h, const char *buf, int num);
  66 static int linebuffer_read(BIO *h, char *buf, int size);
  67 static int linebuffer_puts(BIO *h, const char *str);
  68 static int linebuffer_gets(BIO *h, char *str, int size);
  69 static long linebuffer_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  70 static int linebuffer_new(BIO *h);
  71 static int linebuffer_free(BIO *data);
  72 static long linebuffer_callback_ctrl(BIO *h, int cmd, bio_info_cb *fp);
  73
  74 /* A 10k maximum should be enough for most purposes */
  75 #define DEFAULT_LINEBUFFER_SIZE 1024*10
  76
  77 /* #define DEBUG */
  78
  79 static BIO_METHOD methods_linebuffer = {
  80     BIO_TYPE_LINEBUFFER,
  81     "linebuffer",
  82     linebuffer_write,
  83     linebuffer_read,
  84     linebuffer_puts,
  85     linebuffer_gets,
  86     linebuffer_ctrl,
  87     linebuffer_new,
  88     linebuffer_free,
  89     linebuffer_callback_ctrl,
  90 };
  91
  92 BIO_METHOD *BIO_f_linebuffer(void)
  93 {
  94     return (&methods_linebuffer);
  95 }
  96
  97 typedef struct bio_linebuffer_ctx_struct {
  98     char *obuf;                 /* the output char array */
  99     int obuf_size;              /* how big is the output buffer */
 100     int obuf_len;               /* how many bytes are in it */
 101 } BIO_LINEBUFFER_CTX;
 102
 103 static int linebuffer_new(BIO *bi)
 104 {
 105     BIO_LINEBUFFER_CTX *ctx;
 106
 107     ctx = OPENSSL_malloc(sizeof(*ctx));
 108     if (ctx == NULL)
 109         return (0);
 110     ctx->obuf = OPENSSL_malloc(DEFAULT_LINEBUFFER_SIZE);
 111     if (ctx->obuf == NULL) {
 112         OPENSSL_free(ctx);
 113         return (0);
 114     }
 115     ctx->obuf_size = DEFAULT_LINEBUFFER_SIZE;
 116     ctx->obuf_len = 0;
 117
 118     bi->init = 1;
 119     bi->ptr = (char *)ctx;
 120     bi->flags = 0;
 121     return (1);
 122 }
 123
 124 static int linebuffer_free(BIO *a)
 125 {
 126     BIO_LINEBUFFER_CTX *b;
 127
 128     if (a == NULL)
 129         return (0);
 130     b = (BIO_LINEBUFFER_CTX *)a->ptr;
 131     OPENSSL_free(b->obuf);
 132     OPENSSL_free(a->ptr);
 133     a->ptr = NULL;
 134     a->init = 0;
 135     a->flags = 0;
 136     return (1);
 137 }
 138
 139 static int linebuffer_read(BIO *b, char *out, int outl)
 140 {
 141     int ret = 0;
 142
 143     if (out == NULL)
 144         return (0);
 145     if (b->next_bio == NULL)
 146         return (0);
 147     ret = BIO_read(b->next_bio, out, outl);
 148     BIO_clear_retry_flags(b);
 149     BIO_copy_next_retry(b);
 150     return (ret);
 151 }
 152
 153 static int linebuffer_write(BIO *b, const char *in, int inl)
 154 {
 155     int i, num = 0, foundnl;
 156     BIO_LINEBUFFER_CTX *ctx;
 157
 158     if ((in == NULL) || (inl <= 0))
 159         return (0);
 160     ctx = (BIO_LINEBUFFER_CTX *)b->ptr;
 161     if ((ctx == NULL) || (b->next_bio == NULL))
 162         return (0);
 163
 164     BIO_clear_retry_flags(b);
 165
 166     do {
 167         const char *p;
 168
 169         for (p = in; p < in + inl && *p != '\n'; p++) ;
 170         if (*p == '\n') {
 171             p++;
 172             foundnl = 1;
 173         } else
 174             foundnl = 0;
 175
 176         /*
 177          * If a NL was found and we already have text in the save buffer,
 178          * concatenate them and write
 179          */
 180         while ((foundnl || p - in > ctx->obuf_size - ctx->obuf_len)
 181                && ctx->obuf_len > 0) {
 182             int orig_olen = ctx->obuf_len;
 183
 184             i = ctx->obuf_size - ctx->obuf_len;
 185             if (p - in > 0) {
 186                 if (i >= p - in) {
 187                     memcpy(&(ctx->obuf[ctx->obuf_len]), in, p - in);
 188                     ctx->obuf_len += p - in;
 189                     inl -= p - in;
 190                     num += p - in;
 191                     in = p;
 192                 } else {
 193                     memcpy(&(ctx->obuf[ctx->obuf_len]), in, i);
 194                     ctx->obuf_len += i;
 195                     inl -= i;
 196                     in += i;
 197                     num += i;
 198                 }
 199             }
 200             i = BIO_write(b->next_bio, ctx->obuf, ctx->obuf_len);
 201             if (i <= 0) {
 202                 ctx->obuf_len = orig_olen;
 203                 BIO_copy_next_retry(b);
 204
 205                 if (i < 0)
 206                     return ((num > 0) ? num : i);
 207                 if (i == 0)
 208                     return (num);
 209             }
 210             if (i < ctx->obuf_len)
 211                 memmove(ctx->obuf, ctx->obuf + i, ctx->obuf_len - i);
 212             ctx->obuf_len -= i;
 213         }
 214
 215         /*
 216          * Now that the save buffer is emptied, let's write the input buffer
 217          * if a NL was found and there is anything to write.
 218          */
 219         if ((foundnl || p - in > ctx->obuf_size) && p - in > 0) {
 220             i = BIO_write(b->next_bio, in, p - in);
 221             if (i <= 0) {
 222                 BIO_copy_next_retry(b);
 223                 if (i < 0)
 224                     return ((num > 0) ? num : i);
 225                 if (i == 0)
 226                     return (num);
 227             }
 228             num += i;
 229             in += i;
 230             inl -= i;
 231         }
 232     }
 233     while (foundnl && inl > 0);
 234     /*
 235      * We've written as much as we can.  The rest of the input buffer, if
 236      * any, is text that doesn't and with a NL and therefore needs to be
 237      * saved for the next trip.
 238      */
 239     if (inl > 0) {
 240         memcpy(&(ctx->obuf[ctx->obuf_len]), in, inl);
 241         ctx->obuf_len += inl;
 242         num += inl;
 243     }
 244     return num;
 245 }
 246
 247 static long linebuffer_ctrl(BIO *b, int cmd, long num, void *ptr)
 248 {
 249     BIO *dbio;
 250     BIO_LINEBUFFER_CTX *ctx;
 251     long ret = 1;
 252     char *p;
 253     int r;
 254     int obs;
 255
 256     ctx = (BIO_LINEBUFFER_CTX *)b->ptr;
 257
 258     switch (cmd) {
 259     case BIO_CTRL_RESET:
 260         ctx->obuf_len = 0;
 261         if (b->next_bio == NULL)
 262             return (0);
 263         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 264         break;
 265     case BIO_CTRL_INFO:
 266         ret = (long)ctx->obuf_len;
 267         break;
 268     case BIO_CTRL_WPENDING:
 269         ret = (long)ctx->obuf_len;
 270         if (ret == 0) {
 271             if (b->next_bio == NULL)
 272                 return (0);
 273             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 274         }
 275         break;
 276     case BIO_C_SET_BUFF_SIZE:
 277         obs = (int)num;
 278         p = ctx->obuf;
 279         if ((obs > DEFAULT_LINEBUFFER_SIZE) && (obs != ctx->obuf_size)) {
 280             p = OPENSSL_malloc((int)num);
 281             if (p == NULL)
 282                 goto malloc_error;
 283         }
 284         if (ctx->obuf != p) {
 285             if (ctx->obuf_len > obs) {
 286                 ctx->obuf_len = obs;
 287             }
 288             memcpy(p, ctx->obuf, ctx->obuf_len);
 289             OPENSSL_free(ctx->obuf);
 290             ctx->obuf = p;
 291             ctx->obuf_size = obs;
 292         }
 293         break;
 294     case BIO_C_DO_STATE_MACHINE:
 295         if (b->next_bio == NULL)
 296             return (0);
 297         BIO_clear_retry_flags(b);
 298         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 299         BIO_copy_next_retry(b);
 300         break;
 301
 302     case BIO_CTRL_FLUSH:
 303         if (b->next_bio == NULL)
 304             return (0);
 305         if (ctx->obuf_len <= 0) {
 306             ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 307             break;
 308         }
 309
 310         for (;;) {
 311             BIO_clear_retry_flags(b);
 312             if (ctx->obuf_len > 0) {
 313                 r = BIO_write(b->next_bio, ctx->obuf, ctx->obuf_len);
 314                 BIO_copy_next_retry(b);
 315                 if (r <= 0)
 316                     return ((long)r);
 317                 if (r < ctx->obuf_len)
 318                     memmove(ctx->obuf, ctx->obuf + r, ctx->obuf_len - r);
 319                 ctx->obuf_len -= r;
 320             } else {
 321                 ctx->obuf_len = 0;
 322                 ret = 1;
 323                 break;
 324             }
 325         }
 326         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 327         break;
 328     case BIO_CTRL_DUP:
 329         dbio = (BIO *)ptr;
 330         if (!BIO_set_write_buffer_size(dbio, ctx->obuf_size))
 331             ret = 0;
 332         break;
 333     default:
 334         if (b->next_bio == NULL)
 335             return (0);
 336         ret = BIO_ctrl(b->next_bio, cmd, num, ptr);
 337         break;
 338     }
 339     return (ret);
 340  malloc_error:
 341     BIOerr(BIO_F_LINEBUFFER_CTRL, ERR_R_MALLOC_FAILURE);
 342     return (0);
 343 }
 344
 345 static long linebuffer_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
 346 {
 347     long ret = 1;
 348
 349     if (b->next_bio == NULL)
 350         return (0);
 351     switch (cmd) {
 352     default:
 353         ret = BIO_callback_ctrl(b->next_bio, cmd, fp);
 354         break;
 355     }
 356     return (ret);
 357 }
 358
 359 static int linebuffer_gets(BIO *b, char *buf, int size)
 360 {
 361     if (b->next_bio == NULL)
 362         return (0);
 363     return (BIO_gets(b->next_bio, buf, size));
 364 }
 365
 366 static int linebuffer_puts(BIO *b, const char *str)
 367 {
 368     return (linebuffer_write(b, str, strlen(str)));
 369 }