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