crypto/openssl/crypto/bio/bss_mem.c

   1 /* crypto/bio/bss_mem.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
  64 static int mem_write(BIO *h, const char *buf, int num);
  65 static int mem_read(BIO *h, char *buf, int size);
  66 static int mem_puts(BIO *h, const char *str);
  67 static int mem_gets(BIO *h, char *str, int size);
  68 static long mem_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  69 static int mem_new(BIO *h);
  70 static int mem_free(BIO *data);
  71 static BIO_METHOD mem_method = {
  72     BIO_TYPE_MEM,
  73     "memory buffer",
  74     mem_write,
  75     mem_read,
  76     mem_puts,
  77     mem_gets,
  78     mem_ctrl,
  79     mem_new,
  80     mem_free,
  81     NULL,
  82 };
  83
  84 /*
  85  * bio->num is used to hold the value to return on 'empty', if it is 0,
  86  * should_retry is not set
  87  */
  88
  89 BIO_METHOD *BIO_s_mem(void)
  90 {
  91     return (&mem_method);
  92 }
  93
  94 BIO *BIO_new_mem_buf(void *buf, int len)
  95 {
  96     BIO *ret;
  97     BUF_MEM *b;
  98     if (!buf) {
  99         BIOerr(BIO_F_BIO_NEW_MEM_BUF, BIO_R_NULL_PARAMETER);
 100         return NULL;
 101     }
 102     if (len == -1)
 103         len = strlen(buf);
 104     if (!(ret = BIO_new(BIO_s_mem())))
 105         return NULL;
 106     b = (BUF_MEM *)ret->ptr;
 107     b->data = buf;
 108     b->length = len;
 109     b->max = len;
 110     ret->flags |= BIO_FLAGS_MEM_RDONLY;
 111     /* Since this is static data retrying wont help */
 112     ret->num = 0;
 113     return ret;
 114 }
 115
 116 static int mem_new(BIO *bi)
 117 {
 118     BUF_MEM *b;
 119
 120     if ((b = BUF_MEM_new()) == NULL)
 121         return (0);
 122     bi->shutdown = 1;
 123     bi->init = 1;
 124     bi->num = -1;
 125     bi->ptr = (char *)b;
 126     return (1);
 127 }
 128
 129 static int mem_free(BIO *a)
 130 {
 131     if (a == NULL)
 132         return (0);
 133     if (a->shutdown) {
 134         if ((a->init) && (a->ptr != NULL)) {
 135             BUF_MEM *b;
 136             b = (BUF_MEM *)a->ptr;
 137             if (a->flags & BIO_FLAGS_MEM_RDONLY)
 138                 b->data = NULL;
 139             BUF_MEM_free(b);
 140             a->ptr = NULL;
 141         }
 142     }
 143     return (1);
 144 }
 145
 146 static int mem_read(BIO *b, char *out, int outl)
 147 {
 148     int ret = -1;
 149     BUF_MEM *bm;
 150     int i;
 151     char *from, *to;
 152
 153     bm = (BUF_MEM *)b->ptr;
 154     BIO_clear_retry_flags(b);
 155     ret = (outl > bm->length) ? bm->length : outl;
 156     if ((out != NULL) && (ret > 0)) {
 157         memcpy(out, bm->data, ret);
 158         bm->length -= ret;
 159         /* memmove(&(bm->data[0]),&(bm->data[ret]), bm->length); */
 160         if (b->flags & BIO_FLAGS_MEM_RDONLY)
 161             bm->data += ret;
 162         else {
 163             from = (char *)&(bm->data[ret]);
 164             to = (char *)&(bm->data[0]);
 165             for (i = 0; i < bm->length; i++)
 166                 to[i] = from[i];
 167         }
 168     } else if (bm->length == 0) {
 169         ret = b->num;
 170         if (ret != 0)
 171             BIO_set_retry_read(b);
 172     }
 173     return (ret);
 174 }
 175
 176 static int mem_write(BIO *b, const char *in, int inl)
 177 {
 178     int ret = -1;
 179     int blen;
 180     BUF_MEM *bm;
 181
 182     bm = (BUF_MEM *)b->ptr;
 183     if (in == NULL) {
 184         BIOerr(BIO_F_MEM_WRITE, BIO_R_NULL_PARAMETER);
 185         goto end;
 186     }
 187
 188     if (b->flags & BIO_FLAGS_MEM_RDONLY) {
 189         BIOerr(BIO_F_MEM_WRITE, BIO_R_WRITE_TO_READ_ONLY_BIO);
 190         goto end;
 191     }
 192
 193     BIO_clear_retry_flags(b);
 194     blen = bm->length;
 195     if (BUF_MEM_grow_clean(bm, blen + inl) != (blen + inl))
 196         goto end;
 197     memcpy(&(bm->data[blen]), in, inl);
 198     ret = inl;
 199  end:
 200     return (ret);
 201 }
 202
 203 static long mem_ctrl(BIO *b, int cmd, long num, void *ptr)
 204 {
 205     long ret = 1;
 206     char **pptr;
 207
 208     BUF_MEM *bm = (BUF_MEM *)b->ptr;
 209
 210     switch (cmd) {
 211     case BIO_CTRL_RESET:
 212         if (bm->data != NULL) {
 213             /* For read only case reset to the start again */
 214             if (b->flags & BIO_FLAGS_MEM_RDONLY) {
 215                 bm->data -= bm->max - bm->length;
 216                 bm->length = bm->max;
 217             } else {
 218                 memset(bm->data, 0, bm->max);
 219                 bm->length = 0;
 220             }
 221         }
 222         break;
 223     case BIO_CTRL_EOF:
 224         ret = (long)(bm->length == 0);
 225         break;
 226     case BIO_C_SET_BUF_MEM_EOF_RETURN:
 227         b->num = (int)num;
 228         break;
 229     case BIO_CTRL_INFO:
 230         ret = (long)bm->length;
 231         if (ptr != NULL) {
 232             pptr = (char **)ptr;
 233             *pptr = (char *)&(bm->data[0]);
 234         }
 235         break;
 236     case BIO_C_SET_BUF_MEM:
 237         mem_free(b);
 238         b->shutdown = (int)num;
 239         b->ptr = ptr;
 240         break;
 241     case BIO_C_GET_BUF_MEM_PTR:
 242         if (ptr != NULL) {
 243             pptr = (char **)ptr;
 244             *pptr = (char *)bm;
 245         }
 246         break;
 247     case BIO_CTRL_GET_CLOSE:
 248         ret = (long)b->shutdown;
 249         break;
 250     case BIO_CTRL_SET_CLOSE:
 251         b->shutdown = (int)num;
 252         break;
 253
 254     case BIO_CTRL_WPENDING:
 255         ret = 0L;
 256         break;
 257     case BIO_CTRL_PENDING:
 258         ret = (long)bm->length;
 259         break;
 260     case BIO_CTRL_DUP:
 261     case BIO_CTRL_FLUSH:
 262         ret = 1;
 263         break;
 264     case BIO_CTRL_PUSH:
 265     case BIO_CTRL_POP:
 266     default:
 267         ret = 0;
 268         break;
 269     }
 270     return (ret);
 271 }
 272
 273 static int mem_gets(BIO *bp, char *buf, int size)
 274 {
 275     int i, j;
 276     int ret = -1;
 277     char *p;
 278     BUF_MEM *bm = (BUF_MEM *)bp->ptr;
 279
 280     BIO_clear_retry_flags(bp);
 281     j = bm->length;
 282     if ((size - 1) < j)
 283         j = size - 1;
 284     if (j <= 0) {
 285         *buf = '\0';
 286         return 0;
 287     }
 288     p = bm->data;
 289     for (i = 0; i < j; i++) {
 290         if (p[i] == '\n') {
 291             i++;
 292             break;
 293         }
 294     }
 295
 296     /*
 297      * i is now the max num of bytes to copy, either j or up to
 298      * and including the first newline
 299      */
 300
 301     i = mem_read(bp, buf, i);
 302     if (i > 0)
 303         buf[i] = '\0';
 304     ret = i;
 305     return (ret);
 306 }
 307
 308 static int mem_puts(BIO *bp, const char *str)
 309 {
 310     int n, ret;
 311
 312     n = strlen(str);
 313     ret = mem_write(bp, str, n);
 314     /* memory semantics is that it will always work */
 315     return (ret);
 316 }