• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.] */
56 
57 #include <openssl/bio.h>
58 
59 #include <limits.h>
60 #include <string.h>
61 
62 #include <openssl/buf.h>
63 #include <openssl/err.h>
64 #include <openssl/mem.h>
65 
66 #include "../internal.h"
67 
68 
BIO_new_mem_buf(const void * buf,int len)69 BIO *BIO_new_mem_buf(const void *buf, int len) {
70   BIO *ret;
71   BUF_MEM *b;
72   const size_t size = len < 0 ? strlen((char *)buf) : (size_t)len;
73 
74   if (!buf && len != 0) {
75     OPENSSL_PUT_ERROR(BIO, BIO_R_NULL_PARAMETER);
76     return NULL;
77   }
78 
79   ret = BIO_new(BIO_s_mem());
80   if (ret == NULL) {
81     return NULL;
82   }
83 
84   b = (BUF_MEM *)ret->ptr;
85   // BIO_FLAGS_MEM_RDONLY ensures |b->data| is not written to.
86   b->data = (void *)buf;
87   b->length = size;
88   b->max = size;
89 
90   ret->flags |= BIO_FLAGS_MEM_RDONLY;
91 
92   // |num| is used to store the value that this BIO will return when it runs
93   // out of data. If it's negative then the retry flags will also be set. Since
94   // this is static data, retrying wont help
95   ret->num = 0;
96 
97   return ret;
98 }
99 
mem_new(BIO * bio)100 static int mem_new(BIO *bio) {
101   BUF_MEM *b;
102 
103   b = BUF_MEM_new();
104   if (b == NULL) {
105     return 0;
106   }
107 
108   // |shutdown| is used to store the close flag: whether the BIO has ownership
109   // of the BUF_MEM.
110   bio->shutdown = 1;
111   bio->init = 1;
112   bio->num = -1;
113   bio->ptr = (char *)b;
114 
115   return 1;
116 }
117 
mem_free(BIO * bio)118 static int mem_free(BIO *bio) {
119   BUF_MEM *b;
120 
121   if (bio == NULL) {
122     return 0;
123   }
124 
125   if (!bio->shutdown || !bio->init || bio->ptr == NULL) {
126     return 1;
127   }
128 
129   b = (BUF_MEM *)bio->ptr;
130   if (bio->flags & BIO_FLAGS_MEM_RDONLY) {
131     b->data = NULL;
132   }
133   BUF_MEM_free(b);
134   bio->ptr = NULL;
135   return 1;
136 }
137 
mem_read(BIO * bio,char * out,int outl)138 static int mem_read(BIO *bio, char *out, int outl) {
139   int ret;
140   BUF_MEM *b = (BUF_MEM*) bio->ptr;
141 
142   BIO_clear_retry_flags(bio);
143   ret = outl;
144   if (b->length < INT_MAX && ret > (int)b->length) {
145     ret = b->length;
146   }
147 
148   if (ret > 0) {
149     OPENSSL_memcpy(out, b->data, ret);
150     b->length -= ret;
151     if (bio->flags & BIO_FLAGS_MEM_RDONLY) {
152       b->data += ret;
153     } else {
154       OPENSSL_memmove(b->data, &b->data[ret], b->length);
155     }
156   } else if (b->length == 0) {
157     ret = bio->num;
158     if (ret != 0) {
159       BIO_set_retry_read(bio);
160     }
161   }
162   return ret;
163 }
164 
mem_write(BIO * bio,const char * in,int inl)165 static int mem_write(BIO *bio, const char *in, int inl) {
166   int ret = -1;
167   int blen;
168   BUF_MEM *b;
169 
170   b = (BUF_MEM *)bio->ptr;
171 
172   if (bio->flags & BIO_FLAGS_MEM_RDONLY) {
173     OPENSSL_PUT_ERROR(BIO, BIO_R_WRITE_TO_READ_ONLY_BIO);
174     goto err;
175   }
176 
177   BIO_clear_retry_flags(bio);
178   blen = b->length;
179   if (INT_MAX - blen < inl) {
180     goto err;
181   }
182   if (BUF_MEM_grow_clean(b, blen + inl) != ((size_t) blen) + inl) {
183     goto err;
184   }
185   OPENSSL_memcpy(&b->data[blen], in, inl);
186   ret = inl;
187 
188 err:
189   return ret;
190 }
191 
mem_gets(BIO * bio,char * buf,int size)192 static int mem_gets(BIO *bio, char *buf, int size) {
193   int i, j;
194   char *p;
195   BUF_MEM *b = (BUF_MEM *)bio->ptr;
196 
197   BIO_clear_retry_flags(bio);
198   j = b->length;
199   if (size - 1 < j) {
200     j = size - 1;
201   }
202   if (j <= 0) {
203     if (size > 0) {
204       *buf = 0;
205     }
206     return 0;
207   }
208 
209   p = b->data;
210   for (i = 0; i < j; i++) {
211     if (p[i] == '\n') {
212       i++;
213       break;
214     }
215   }
216 
217   // i is now the max num of bytes to copy, either j or up to and including the
218   // first newline
219 
220   i = mem_read(bio, buf, i);
221   if (i > 0) {
222     buf[i] = '\0';
223   }
224   return i;
225 }
226 
mem_ctrl(BIO * bio,int cmd,long num,void * ptr)227 static long mem_ctrl(BIO *bio, int cmd, long num, void *ptr) {
228   long ret = 1;
229   char **pptr;
230 
231   BUF_MEM *b = (BUF_MEM *)bio->ptr;
232 
233   switch (cmd) {
234     case BIO_CTRL_RESET:
235       if (b->data != NULL) {
236         // For read only case reset to the start again
237         if (bio->flags & BIO_FLAGS_MEM_RDONLY) {
238           b->data -= b->max - b->length;
239           b->length = b->max;
240         } else {
241           OPENSSL_memset(b->data, 0, b->max);
242           b->length = 0;
243         }
244       }
245       break;
246     case BIO_CTRL_EOF:
247       ret = (long)(b->length == 0);
248       break;
249     case BIO_C_SET_BUF_MEM_EOF_RETURN:
250       bio->num = (int)num;
251       break;
252     case BIO_CTRL_INFO:
253       ret = (long)b->length;
254       if (ptr != NULL) {
255         pptr = (char **)ptr;
256         *pptr = (char *)&b->data[0];
257       }
258       break;
259     case BIO_C_SET_BUF_MEM:
260       mem_free(bio);
261       bio->shutdown = (int)num;
262       bio->ptr = ptr;
263       break;
264     case BIO_C_GET_BUF_MEM_PTR:
265       if (ptr != NULL) {
266         pptr = (char **)ptr;
267         *pptr = (char *)b;
268       }
269       break;
270     case BIO_CTRL_GET_CLOSE:
271       ret = (long)bio->shutdown;
272       break;
273     case BIO_CTRL_SET_CLOSE:
274       bio->shutdown = (int)num;
275       break;
276 
277     case BIO_CTRL_WPENDING:
278       ret = 0L;
279       break;
280     case BIO_CTRL_PENDING:
281       ret = (long)b->length;
282       break;
283     case BIO_CTRL_FLUSH:
284       ret = 1;
285       break;
286     default:
287       ret = 0;
288       break;
289   }
290   return ret;
291 }
292 
293 static const BIO_METHOD mem_method = {
294     BIO_TYPE_MEM,    "memory buffer",
295     mem_write,       mem_read,
296     NULL /* puts */, mem_gets,
297     mem_ctrl,        mem_new,
298     mem_free,        NULL /* callback_ctrl */,
299 };
300 
BIO_s_mem(void)301 const BIO_METHOD *BIO_s_mem(void) { return &mem_method; }
302 
BIO_mem_contents(const BIO * bio,const uint8_t ** out_contents,size_t * out_len)303 int BIO_mem_contents(const BIO *bio, const uint8_t **out_contents,
304                      size_t *out_len) {
305   const BUF_MEM *b;
306   if (bio->method != &mem_method) {
307     return 0;
308   }
309 
310   b = (BUF_MEM *)bio->ptr;
311   *out_contents = (uint8_t *)b->data;
312   *out_len = b->length;
313   return 1;
314 }
315 
BIO_get_mem_data(BIO * bio,char ** contents)316 long BIO_get_mem_data(BIO *bio, char **contents) {
317   return BIO_ctrl(bio, BIO_CTRL_INFO, 0, (char *) contents);
318 }
319 
BIO_get_mem_ptr(BIO * bio,BUF_MEM ** out)320 int BIO_get_mem_ptr(BIO *bio, BUF_MEM **out) {
321   return BIO_ctrl(bio, BIO_C_GET_BUF_MEM_PTR, 0, (char *) out);
322 }
323 
BIO_set_mem_buf(BIO * bio,BUF_MEM * b,int take_ownership)324 int BIO_set_mem_buf(BIO *bio, BUF_MEM *b, int take_ownership) {
325   return BIO_ctrl(bio, BIO_C_SET_BUF_MEM, take_ownership, (char *) b);
326 }
327 
BIO_set_mem_eof_return(BIO * bio,int eof_value)328 int BIO_set_mem_eof_return(BIO *bio, int eof_value) {
329   return BIO_ctrl(bio, BIO_C_SET_BUF_MEM_EOF_RETURN, eof_value, NULL);
330 }
331