crypto/bio/bss_mem.c

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 #include <stdio.h>
  59 #include <errno.h>
  60 #include "bio_lcl.h"
  61 #include "internal/cryptlib.h"
  62
  63 static int mem_write(BIO *h, const char *buf, int num);
  64 static int mem_read(BIO *h, char *buf, int size);
  65 static int mem_puts(BIO *h, const char *str);
  66 static int mem_gets(BIO *h, char *str, int size);
  67 static long mem_ctrl(BIO *h, int cmd, long arg1, void *arg2);
  68 static int mem_new(BIO *h);
  69 static int secmem_new(BIO *h);
  70 static int mem_free(BIO *data);
  71 static int mem_buf_free(BIO *data, int free_all);
  72 static int mem_buf_sync(BIO *h);
  73
  74 static const BIO_METHOD mem_method = {
  75     BIO_TYPE_MEM,
  76     "memory buffer",
  77     mem_write,
  78     mem_read,
  79     mem_puts,
  80     mem_gets,
  81     mem_ctrl,
  82     mem_new,
  83     mem_free,
  84     NULL,
  85 };
  86
  87 static const BIO_METHOD secmem_method = {
  88     BIO_TYPE_MEM,
  89     "secure memory buffer",
  90     mem_write,
  91     mem_read,
  92     mem_puts,
  93     mem_gets,
  94     mem_ctrl,
  95     secmem_new,
  96     mem_free,
  97     NULL,
  98 };
  99
 100 /* BIO memory stores buffer and read pointer  */
 101 typedef struct bio_buf_mem_st {
 102     struct buf_mem_st *buf;   /* allocated buffer */
 103     struct buf_mem_st *readp; /* read pointer */
 104 } BIO_BUF_MEM;
 105
 106 /*
 107  * bio->num is used to hold the value to return on 'empty', if it is 0,
 108  * should_retry is not set
 109  */
 110
 111 const BIO_METHOD *BIO_s_mem(void)
 112 {
 113     return (&mem_method);
 114 }
 115
 116 const BIO_METHOD *BIO_s_secmem(void)
 117 {
 118     return(&secmem_method);
 119 }
 120
 121 BIO *BIO_new_mem_buf(const void *buf, int len)
 122 {
 123     BIO *ret;
 124     BUF_MEM *b;
 125     BIO_BUF_MEM *bb;
 126     size_t sz;
 127
 128     if (buf == NULL) {
 129         BIOerr(BIO_F_BIO_NEW_MEM_BUF, BIO_R_NULL_PARAMETER);
 130         return NULL;
 131     }
 132     sz = (len < 0) ? strlen(buf) : (size_t)len;
 133     if ((ret = BIO_new(BIO_s_mem())) == NULL)
 134         return NULL;
 135     bb = (BIO_BUF_MEM *)ret->ptr;
 136     b = bb->buf;
 137     /* Cast away const and trust in the MEM_RDONLY flag. */
 138     b->data = (void *)buf;
 139     b->length = sz;
 140     b->max = sz;
 141     *bb->readp = *bb->buf;
 142     ret->flags |= BIO_FLAGS_MEM_RDONLY;
 143     /* Since this is static data retrying wont help */
 144     ret->num = 0;
 145     return ret;
 146 }
 147
 148 static int mem_init(BIO *bi, unsigned long flags)
 149 {
 150     BIO_BUF_MEM *bb = OPENSSL_zalloc(sizeof(*bb));
 151
 152     if (bb == NULL)
 153         return(0);
 154     if ((bb->buf = BUF_MEM_new_ex(flags)) == NULL)
 155         return(0);
 156     if ((bb->readp = OPENSSL_zalloc(sizeof(*bb->readp))) == NULL)
 157         return(0);
 158     *bb->readp = *bb->buf;
 159     bi->shutdown = 1;
 160     bi->init = 1;
 161     bi->num = -1;
 162     bi->ptr = (char *)bb;
 163     return(1);
 164 }
 165
 166 static int mem_new(BIO *bi)
 167 {
 168     return (mem_init(bi, 0L));
 169 }
 170
 171 static int secmem_new(BIO *bi)
 172 {
 173     return (mem_init(bi, BUF_MEM_FLAG_SECURE));
 174 }
 175
 176 static int mem_free(BIO *a)
 177 {
 178     return (mem_buf_free(a, 1));
 179 }
 180
 181 static int mem_buf_free(BIO *a, int free_all)
 182 {
 183     if (a == NULL)
 184         return (0);
 185     if (a->shutdown) {
 186         if ((a->init) && (a->ptr != NULL)) {
 187             BUF_MEM *b;
 188             BIO_BUF_MEM *bb = (BIO_BUF_MEM *)a->ptr;
 189
 190             if(bb != NULL) {
 191                 b = bb->buf;
 192                 if (a->flags & BIO_FLAGS_MEM_RDONLY)
 193                     b->data = NULL;
 194                 BUF_MEM_free(b);
 195                 if(free_all) {
 196                     OPENSSL_free(bb->readp);
 197                     OPENSSL_free(bb);
 198                 }
 199             }
 200             a->ptr = NULL;
 201         }
 202     }
 203     return (1);
 204 }
 205
 206 /*
 207  * Reallocate memory buffer if read pointer differs
 208  */
 209 static int mem_buf_sync(BIO *b)
 210 {
 211     if((b != NULL) && (b->init) && (b->ptr != NULL)) {
 212         BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 213
 214         if(bbm->readp->data != bbm->buf->data) {
 215             memmove(bbm->buf->data, bbm->readp->data, bbm->readp->length);
 216             bbm->buf->length = bbm->readp->length;
 217             bbm->readp->data = bbm->buf->data;
 218         }
 219     }
 220     return (0);
 221 }
 222
 223 static int mem_read(BIO *b, char *out, int outl)
 224 {
 225     int ret = -1;
 226     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 227     BUF_MEM *bm = bbm->readp;
 228
 229     BIO_clear_retry_flags(b);
 230     ret = (outl >= 0 && (size_t)outl > bm->length) ? (int)bm->length : outl;
 231     if ((out != NULL) && (ret > 0)) {
 232         memcpy(out, bm->data, ret);
 233         bm->length -= ret;
 234         bm->data += ret;
 235     } else if (bm->length == 0) {
 236         ret = b->num;
 237         if (ret != 0)
 238             BIO_set_retry_read(b);
 239     }
 240     return (ret);
 241 }
 242
 243 static int mem_write(BIO *b, const char *in, int inl)
 244 {
 245     int ret = -1;
 246     int blen;
 247     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 248
 249     if (in == NULL) {
 250         BIOerr(BIO_F_MEM_WRITE, BIO_R_NULL_PARAMETER);
 251         goto end;
 252     }
 253     if (b->flags & BIO_FLAGS_MEM_RDONLY) {
 254         BIOerr(BIO_F_MEM_WRITE, BIO_R_WRITE_TO_READ_ONLY_BIO);
 255         goto end;
 256     }
 257     BIO_clear_retry_flags(b);
 258     blen = bbm->readp->length;
 259     mem_buf_sync(b);
 260     if (BUF_MEM_grow_clean(bbm->buf, blen + inl) == 0)
 261         goto end;
 262     memcpy(bbm->buf->data + blen, in, inl);
 263     *bbm->readp = *bbm->buf;
 264     ret = inl;
 265  end:
 266     return (ret);
 267 }
 268
 269 static long mem_ctrl(BIO *b, int cmd, long num, void *ptr)
 270 {
 271     long ret = 1;
 272     char **pptr;
 273     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 274     BUF_MEM *bm;
 275
 276     switch (cmd) {
 277     case BIO_CTRL_RESET:
 278         bm = bbm->buf;
 279         if (bm->data != NULL) {
 280             /* For read only case reset to the start again */
 281             if ((b->flags & BIO_FLAGS_MEM_RDONLY) || (b->flags & BIO_FLAGS_NONCLEAR_RST)) {
 282                 bm->length = bm->max;
 283             } else {
 284                 memset(bm->data, 0, bm->max);
 285                 bm->length = 0;
 286             }
 287             *bbm->readp = *bbm->buf;
 288         }
 289         break;
 290     case BIO_CTRL_EOF:
 291         bm = bbm->readp;
 292         ret = (long)(bm->length == 0);
 293         break;
 294     case BIO_C_SET_BUF_MEM_EOF_RETURN:
 295         b->num = (int)num;
 296         break;
 297     case BIO_CTRL_INFO:
 298         bm = bbm->readp;
 299         ret = (long)bm->length;
 300         if (ptr != NULL) {
 301             pptr = (char **)ptr;
 302             *pptr = (char *)&(bm->data[0]);
 303         }
 304         break;
 305     case BIO_C_SET_BUF_MEM:
 306         mem_buf_free(b, 0);
 307         b->shutdown = (int)num;
 308         bbm->buf = ptr;
 309         *bbm->readp = *bbm->buf;
 310         b->ptr = bbm;
 311         break;
 312     case BIO_C_GET_BUF_MEM_PTR:
 313         if (ptr != NULL) {
 314             mem_buf_sync(b);
 315             bm = bbm->readp;
 316             pptr = (char **)ptr;
 317             *pptr = (char *)bm;
 318         }
 319         break;
 320     case BIO_CTRL_GET_CLOSE:
 321         ret = (long)b->shutdown;
 322         break;
 323     case BIO_CTRL_SET_CLOSE:
 324         b->shutdown = (int)num;
 325         break;
 326     case BIO_CTRL_WPENDING:
 327         ret = 0L;
 328         break;
 329     case BIO_CTRL_PENDING:
 330         bm = bbm->readp;
 331         ret = (long)bm->length;
 332         break;
 333     case BIO_CTRL_DUP:
 334     case BIO_CTRL_FLUSH:
 335         ret = 1;
 336         break;
 337     case BIO_CTRL_PUSH:
 338     case BIO_CTRL_POP:
 339     default:
 340         ret = 0;
 341         break;
 342     }
 343     return (ret);
 344 }
 345
 346 static int mem_gets(BIO *bp, char *buf, int size)
 347 {
 348     int i, j;
 349     int ret = -1;
 350     char *p;
 351     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)bp->ptr;
 352     BUF_MEM *bm = bbm->readp;
 353
 354     BIO_clear_retry_flags(bp);
 355     j = bm->length;
 356     if ((size - 1) < j)
 357         j = size - 1;
 358     if (j <= 0) {
 359         *buf = '\0';
 360         return 0;
 361     }
 362     p = bm->data;
 363     for (i = 0; i < j; i++) {
 364         if (p[i] == '\n') {
 365             i++;
 366             break;
 367         }
 368     }
 369
 370     /*
 371      * i is now the max num of bytes to copy, either j or up to
 372      * and including the first newline
 373      */
 374
 375     i = mem_read(bp, buf, i);
 376     if (i > 0)
 377         buf[i] = '\0';
 378     ret = i;
 379     return (ret);
 380 }
 381
 382 static int mem_puts(BIO *bp, const char *str)
 383 {
 384     int n, ret;
 385
 386     n = strlen(str);
 387     ret = mem_write(bp, str, n);
 388     /* memory semantics is that it will always work */
 389     return (ret);
 390 }