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