2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
13 #include "internal/cryptlib.h"
15 static int mem_write(BIO *h, const char *buf, int num);
16 static int mem_read(BIO *h, char *buf, int size);
17 static int mem_puts(BIO *h, const char *str);
18 static int mem_gets(BIO *h, char *str, int size);
19 static long mem_ctrl(BIO *h, int cmd, long arg1, void *arg2);
20 static int mem_new(BIO *h);
21 static int secmem_new(BIO *h);
22 static int mem_free(BIO *data);
23 static int mem_buf_free(BIO *data);
24 static int mem_buf_sync(BIO *h);
26 static const BIO_METHOD mem_method = {
29 /* TODO: Convert to new style write function */
32 /* TODO: Convert to new style read function */
40 NULL, /* mem_callback_ctrl */
43 static const BIO_METHOD secmem_method = {
45 "secure memory buffer",
46 /* TODO: Convert to new style write function */
49 /* TODO: Convert to new style read function */
57 NULL, /* mem_callback_ctrl */
60 /* BIO memory stores buffer and read pointer */
61 typedef struct bio_buf_mem_st {
62 struct buf_mem_st *buf; /* allocated buffer */
63 struct buf_mem_st *readp; /* read pointer */
67 * bio->num is used to hold the value to return on 'empty', if it is 0,
68 * should_retry is not set
71 const BIO_METHOD *BIO_s_mem(void)
76 const BIO_METHOD *BIO_s_secmem(void)
78 return(&secmem_method);
81 BIO *BIO_new_mem_buf(const void *buf, int len)
89 BIOerr(BIO_F_BIO_NEW_MEM_BUF, BIO_R_NULL_PARAMETER);
92 sz = (len < 0) ? strlen(buf) : (size_t)len;
93 if ((ret = BIO_new(BIO_s_mem())) == NULL)
95 bb = (BIO_BUF_MEM *)ret->ptr;
97 /* Cast away const and trust in the MEM_RDONLY flag. */
98 b->data = (void *)buf;
101 *bb->readp = *bb->buf;
102 ret->flags |= BIO_FLAGS_MEM_RDONLY;
103 /* Since this is static data retrying won't help */
108 static int mem_init(BIO *bi, unsigned long flags)
110 BIO_BUF_MEM *bb = OPENSSL_zalloc(sizeof(*bb));
114 if ((bb->buf = BUF_MEM_new_ex(flags)) == NULL) {
118 if ((bb->readp = OPENSSL_zalloc(sizeof(*bb->readp))) == NULL) {
119 BUF_MEM_free(bb->buf);
123 *bb->readp = *bb->buf;
127 bi->ptr = (char *)bb;
131 static int mem_new(BIO *bi)
133 return mem_init(bi, 0L);
136 static int secmem_new(BIO *bi)
138 return mem_init(bi, BUF_MEM_FLAG_SECURE);
141 static int mem_free(BIO *a)
148 bb = (BIO_BUF_MEM *)a->ptr;
149 if (!mem_buf_free(a))
151 OPENSSL_free(bb->readp);
156 static int mem_buf_free(BIO *a)
161 if (a->shutdown && a->init && a->ptr != NULL) {
162 BIO_BUF_MEM *bb = (BIO_BUF_MEM *)a->ptr;
163 BUF_MEM *b = bb->buf;
165 if (a->flags & BIO_FLAGS_MEM_RDONLY)
173 * Reallocate memory buffer if read pointer differs
175 static int mem_buf_sync(BIO *b)
177 if (b != NULL && b->init != 0 && b->ptr != NULL) {
178 BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
180 if (bbm->readp->data != bbm->buf->data) {
181 memmove(bbm->buf->data, bbm->readp->data, bbm->readp->length);
182 bbm->buf->length = bbm->readp->length;
183 bbm->readp->data = bbm->buf->data;
189 static int mem_read(BIO *b, char *out, int outl)
192 BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
193 BUF_MEM *bm = bbm->readp;
195 BIO_clear_retry_flags(b);
196 ret = (outl >= 0 && (size_t)outl > bm->length) ? (int)bm->length : outl;
197 if ((out != NULL) && (ret > 0)) {
198 memcpy(out, bm->data, ret);
201 } else if (bm->length == 0) {
204 BIO_set_retry_read(b);
209 static int mem_write(BIO *b, const char *in, int inl)
213 BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
216 BIOerr(BIO_F_MEM_WRITE, BIO_R_NULL_PARAMETER);
219 if (b->flags & BIO_FLAGS_MEM_RDONLY) {
220 BIOerr(BIO_F_MEM_WRITE, BIO_R_WRITE_TO_READ_ONLY_BIO);
223 BIO_clear_retry_flags(b);
226 blen = bbm->readp->length;
228 if (BUF_MEM_grow_clean(bbm->buf, blen + inl) == 0)
230 memcpy(bbm->buf->data + blen, in, inl);
231 *bbm->readp = *bbm->buf;
237 static long mem_ctrl(BIO *b, int cmd, long num, void *ptr)
241 BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
247 if (bm->data != NULL) {
248 /* For read only case reset to the start again */
249 if ((b->flags & BIO_FLAGS_MEM_RDONLY) || (b->flags & BIO_FLAGS_NONCLEAR_RST)) {
250 bm->length = bm->max;
252 memset(bm->data, 0, bm->max);
255 *bbm->readp = *bbm->buf;
260 ret = (long)(bm->length == 0);
262 case BIO_C_SET_BUF_MEM_EOF_RETURN:
267 ret = (long)bm->length;
270 *pptr = (char *)&(bm->data[0]);
273 case BIO_C_SET_BUF_MEM:
275 b->shutdown = (int)num;
277 *bbm->readp = *bbm->buf;
279 case BIO_C_GET_BUF_MEM_PTR:
287 case BIO_CTRL_GET_CLOSE:
288 ret = (long)b->shutdown;
290 case BIO_CTRL_SET_CLOSE:
291 b->shutdown = (int)num;
293 case BIO_CTRL_WPENDING:
296 case BIO_CTRL_PENDING:
298 ret = (long)bm->length;
313 static int mem_gets(BIO *bp, char *buf, int size)
318 BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)bp->ptr;
319 BUF_MEM *bm = bbm->readp;
321 BIO_clear_retry_flags(bp);
330 for (i = 0; i < j; i++) {
338 * i is now the max num of bytes to copy, either j or up to
339 * and including the first newline
342 i = mem_read(bp, buf, i);
349 static int mem_puts(BIO *bp, const char *str)
354 ret = mem_write(bp, str, n);
355 /* memory semantics is that it will always work */