Diagnose EOF on memory BIOs (or you just get mysterious errors with no error
[openssl.git] / 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 "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                 if (b->num != 0)
167                         BIO_set_retry_read(b);
168                 ret= b->num;
169                 if(ret < 0)
170                     BIOerr(BIO_F_MEM_READ,BIO_R_EOF_ON_MEMORY_BIO);
171                 }
172         return(ret);
173         }
174
175 static int mem_write(BIO *b, const char *in, int inl)
176         {
177         int ret= -1;
178         int blen;
179         BUF_MEM *bm;
180
181         bm=(BUF_MEM *)b->ptr;
182         if (in == NULL)
183                 {
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(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 mem_ctrl(BIO *b, int cmd, long num, void *ptr)
204         {
205         long ret=1;
206         char **pptr;
207
208         BUF_MEM *bm=(BUF_MEM *)b->ptr;
209
210         switch (cmd)
211                 {
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                         else {
218                                 memset(bm->data,0,bm->max);
219                                 bm->length=0;
220                         }
221                 }
222                 break;
223         case BIO_CTRL_EOF:
224                 ret=(long)(bm->length == 0);
225                 break;
226         case BIO_C_SET_BUF_MEM_EOF_RETURN:
227                 b->num=(int)num;
228                 break;
229         case BIO_CTRL_INFO:
230                 ret=(long)bm->length;
231                 if (ptr != NULL)
232                         {
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                         {
245                         pptr=(char **)ptr;
246                         *pptr=(char *)bm;
247                         }
248                 break;
249         case BIO_CTRL_GET_CLOSE:
250                 ret=(long)b->shutdown;
251                 break;
252         case BIO_CTRL_SET_CLOSE:
253                 b->shutdown=(int)num;
254                 break;
255
256         case BIO_CTRL_WPENDING:
257                 ret=0L;
258                 break;
259         case BIO_CTRL_PENDING:
260                 ret=(long)bm->length;
261                 break;
262         case BIO_CTRL_DUP:
263         case BIO_CTRL_FLUSH:
264                 ret=1;
265                 break;
266         case BIO_CTRL_PUSH:
267         case BIO_CTRL_POP:
268         default:
269                 ret=0;
270                 break;
271                 }
272         return(ret);
273         }
274
275 static int 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 (j <= 0) return(0);
285         p=bm->data;
286         for (i=0; i<j; i++)
287                 {
288                 if (p[i] == '\n') break;
289                 }
290         if (i == j)
291                 {
292                 BIO_set_retry_read(bp);
293                 /* return(-1);  change the semantics 0.6.6a */ 
294                 }
295         else
296                 i++;
297         /* i is the max to copy */
298         if ((size-1) < i) i=size-1;
299         i=mem_read(bp,buf,i);
300         if (i > 0) buf[i]='\0';
301         ret=i;
302         return(ret);
303         }
304
305 static int mem_puts(BIO *bp, const char *str)
306         {
307         int n,ret;
308
309         n=strlen(str);
310         ret=mem_write(bp,str,n);
311         /* memory semantics is that it will always work */
312         return(ret);
313         }
314