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