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 static const BIO_METHOD mem_method = {
  74     BIO_TYPE_MEM,
  75     "memory buffer",
  76     mem_write,
  77     mem_read,
  78     mem_puts,
  79     mem_gets,
  80     mem_ctrl,
  81     mem_new,
  82     mem_free,
  83     NULL,
  84 };
  85 static const BIO_METHOD secmem_method = {
  86     BIO_TYPE_MEM,
  87     "secure memory buffer",
  88     mem_write,
  89     mem_read,
  90     mem_puts,
  91     mem_gets,
  92     mem_ctrl,
  93     secmem_new,
  94     mem_free,
  95     NULL,
  96 };
  97
  98 /*
  99  * bio->num is used to hold the value to return on 'empty', if it is 0,
 100  * should_retry is not set
 101  */
 102
 103 const BIO_METHOD *BIO_s_mem(void)
 104 {
 105     return (&mem_method);
 106 }
 107
 108 const BIO_METHOD *BIO_s_secmem(void)
 109 {
 110     return(&secmem_method);
 111 }
 112
 113 BIO *BIO_new_mem_buf(const void *buf, int len)
 114 {
 115     BIO *ret;
 116     BUF_MEM *b;
 117     BIO_BUF_MEM *bb;
 118     size_t sz;
 119
 120     if (buf == NULL) {
 121         BIOerr(BIO_F_BIO_NEW_MEM_BUF, BIO_R_NULL_PARAMETER);
 122         return NULL;
 123     }
 124     sz = (len < 0) ? strlen(buf) : (size_t)len;
 125     if ((ret = BIO_new(BIO_s_mem())) == NULL)
 126         return NULL;
 127     bb = (BIO_BUF_MEM *)ret->ptr;
 128     b = bb->buf;
 129     /* Cast away const and trust in the MEM_RDONLY flag. */
 130     b->data = (void *)buf;
 131     b->length = sz;
 132     b->max = sz;
 133     *bb->readp = *bb->buf;
 134     ret->flags |= BIO_FLAGS_MEM_RDONLY;
 135     /* Since this is static data retrying wont help */
 136     ret->num = 0;
 137     return ret;
 138 }
 139
 140 static int mem_init(BIO *bi, unsigned long flags)
 141 {
 142     BIO_BUF_MEM *bb = OPENSSL_zalloc(sizeof(*bb));
 143
 144     if (bb == NULL)
 145         return(0);
 146     if ((bb->buf = BUF_MEM_new_ex(flags)) == NULL)
 147         return(0);
 148     if ((bb->readp = OPENSSL_zalloc(sizeof(*bb->readp))) == NULL)
 149         return(0);
 150     *bb->readp = *bb->buf;
 151     bi->shutdown = 1;
 152     bi->init = 1;
 153     bi->num = -1;
 154     bi->ptr = (char *)bb;
 155     return(1);
 156 }
 157
 158 static int mem_new(BIO *bi)
 159 {
 160     return (mem_init(bi, 0L));
 161 }
 162
 163 static int secmem_new(BIO *bi)
 164 {
 165     return (mem_init(bi, BUF_MEM_FLAG_SECURE));
 166 }
 167
 168 static int mem_free(BIO *a)
 169 {
 170     return (mem_buf_free(a, 1));
 171 }
 172
 173 static int mem_buf_free(BIO *a, int free_all)
 174 {
 175     if (a == NULL)
 176         return (0);
 177     if (a->shutdown) {
 178         if ((a->init) && (a->ptr != NULL)) {
 179             BUF_MEM *b;
 180             BIO_BUF_MEM *bb = (BIO_BUF_MEM *)a->ptr;
 181
 182             if(bb != NULL) {
 183                 b = bb->buf;
 184                 if (a->flags & BIO_FLAGS_MEM_RDONLY)
 185                     b->data = NULL;
 186                 BUF_MEM_free(b);
 187                 if(free_all) {
 188                     OPENSSL_free(bb->readp);
 189                     OPENSSL_free(bb);
 190                 }
 191             }
 192             a->ptr = NULL;
 193         }
 194     }
 195     return (1);
 196 }
 197
 198 /*
 199  * Reallocate memory buffer if read pointer differs
 200  */
 201 static int mem_buf_sync(BIO *b)
 202 {
 203     if((b != NULL) && (b->init) && (b->ptr != NULL)) {
 204         BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 205
 206         if(bbm->readp->data != bbm->buf->data) {
 207             memmove(bbm->buf->data, bbm->readp->data, bbm->readp->length);
 208             bbm->buf->length = bbm->readp->length;
 209             bbm->readp->data = bbm->buf->data;
 210         }
 211     }
 212     return (0);
 213 }
 214
 215 static int mem_read(BIO *b, char *out, int outl)
 216 {
 217     int ret = -1;
 218     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 219     BUF_MEM *bm = bbm->readp;
 220
 221     BIO_clear_retry_flags(b);
 222     ret = (outl >= 0 && (size_t)outl > bm->length) ? (int)bm->length : outl;
 223     if ((out != NULL) && (ret > 0)) {
 224         memcpy(out, bm->data, ret);
 225         bm->length -= ret;
 226         bm->data += ret;
 227     } else if (bm->length == 0) {
 228         ret = b->num;
 229         if (ret != 0)
 230             BIO_set_retry_read(b);
 231     }
 232     return (ret);
 233 }
 234
 235 static int mem_write(BIO *b, const char *in, int inl)
 236 {
 237     int ret = -1;
 238     int blen;
 239     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 240
 241     if (in == NULL) {
 242         BIOerr(BIO_F_MEM_WRITE, BIO_R_NULL_PARAMETER);
 243         goto end;
 244     }
 245     if (b->flags & BIO_FLAGS_MEM_RDONLY) {
 246         BIOerr(BIO_F_MEM_WRITE, BIO_R_WRITE_TO_READ_ONLY_BIO);
 247         goto end;
 248     }
 249     BIO_clear_retry_flags(b);
 250     blen = bbm->readp->length;
 251     mem_buf_sync(b);
 252     if (BUF_MEM_grow_clean(bbm->buf, blen + inl) == 0)
 253         goto end;
 254     memcpy(bbm->buf->data + blen, in, inl);
 255     *bbm->readp = *bbm->buf;
 256     ret = inl;
 257  end:
 258     return (ret);
 259 }
 260
 261 static long mem_ctrl(BIO *b, int cmd, long num, void *ptr)
 262 {
 263     long ret = 1;
 264     char **pptr;
 265     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
 266     BUF_MEM *bm;
 267
 268     switch (cmd) {
 269     case BIO_CTRL_RESET:
 270         bm = bbm->buf;
 271         if (bm->data != NULL) {
 272             /* For read only case reset to the start again */
 273             if ((b->flags & BIO_FLAGS_MEM_RDONLY) || (b->flags & BIO_FLAGS_NONCLEAR_RST)) {
 274                 bm->length = bm->max;
 275             } else {
 276                 memset(bm->data, 0, bm->max);
 277                 bm->length = 0;
 278             }
 279             *bbm->readp = *bbm->buf;
 280         }
 281         break;
 282     case BIO_CTRL_EOF:
 283         bm = bbm->readp;
 284         ret = (long)(bm->length == 0);
 285         break;
 286     case BIO_C_SET_BUF_MEM_EOF_RETURN:
 287         b->num = (int)num;
 288         break;
 289     case BIO_CTRL_INFO:
 290         bm = bbm->readp;
 291         ret = (long)bm->length;
 292         if (ptr != NULL) {
 293             pptr = (char **)ptr;
 294             *pptr = (char *)&(bm->data[0]);
 295         }
 296         break;
 297     case BIO_C_SET_BUF_MEM:
 298         mem_buf_free(b, 0);
 299         b->shutdown = (int)num;
 300         bbm->buf = ptr;
 301         *bbm->readp = *bbm->buf;
 302         b->ptr = bbm;
 303         break;
 304     case BIO_C_GET_BUF_MEM_PTR:
 305         if (ptr != NULL) {
 306             mem_buf_sync(b);
 307             bm = bbm->readp;
 308             pptr = (char **)ptr;
 309             *pptr = (char *)bm;
 310         }
 311         break;
 312     case BIO_CTRL_GET_CLOSE:
 313         ret = (long)b->shutdown;
 314         break;
 315     case BIO_CTRL_SET_CLOSE:
 316         b->shutdown = (int)num;
 317         break;
 318     case BIO_CTRL_WPENDING:
 319         ret = 0L;
 320         break;
 321     case BIO_CTRL_PENDING:
 322         bm = bbm->readp;
 323         ret = (long)bm->length;
 324         break;
 325     case BIO_CTRL_DUP:
 326     case BIO_CTRL_FLUSH:
 327         ret = 1;
 328         break;
 329     case BIO_CTRL_PUSH:
 330     case BIO_CTRL_POP:
 331     default:
 332         ret = 0;
 333         break;
 334     }
 335     return (ret);
 336 }
 337
 338 static int mem_gets(BIO *bp, char *buf, int size)
 339 {
 340     int i, j;
 341     int ret = -1;
 342     char *p;
 343     BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)bp->ptr;
 344     BUF_MEM *bm = bbm->readp;
 345
 346     BIO_clear_retry_flags(bp);
 347     j = bm->length;
 348     if ((size - 1) < j)
 349         j = size - 1;
 350     if (j <= 0) {
 351         *buf = '\0';
 352         return 0;
 353     }
 354     p = bm->data;
 355     for (i = 0; i < j; i++) {
 356         if (p[i] == '\n') {
 357             i++;
 358             break;
 359         }
 360     }
 361
 362     /*
 363      * i is now the max num of bytes to copy, either j or up to
 364      * and including the first newline
 365      */
 366
 367     i = mem_read(bp, buf, i);
 368     if (i > 0)
 369         buf[i] = '\0';
 370     ret = i;
 371     return (ret);
 372 }
 373
 374 static int mem_puts(BIO *bp, const char *str)
 375 {
 376     int n, ret;
 377
 378     n = strlen(str);
 379     ret = mem_write(bp, str, n);
 380     /* memory semantics is that it will always work */
 381     return (ret);
 382 }