| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "BIO_S_MEM 3SSL" |
| 58 |
.TH BIO_S_MEM 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
BIO_s_secmem, BIO_s_dgram_mem, |
| 65 |
BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf, |
| 66 |
BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO |
| 67 |
.SH SYNOPSIS |
| 68 |
.IX Header "SYNOPSIS" |
| 69 |
.Vb 1 |
| 70 |
\& #include <openssl/bio.h> |
| 71 |
\& |
| 72 |
\& const BIO_METHOD *BIO_s_mem(void); |
| 73 |
\& const BIO_METHOD *BIO_s_dgram_mem(void); |
| 74 |
\& const BIO_METHOD *BIO_s_secmem(void); |
| 75 |
\& |
| 76 |
\& BIO_set_mem_eof_return(BIO *b, int v); |
| 77 |
\& long BIO_get_mem_data(BIO *b, char **pp); |
| 78 |
\& BIO_set_mem_buf(BIO *b, BUF_MEM *bm, int c); |
| 79 |
\& BIO_get_mem_ptr(BIO *b, BUF_MEM **pp); |
| 80 |
\& |
| 81 |
\& BIO *BIO_new_mem_buf(const void *buf, int len); |
| 82 |
.Ve |
| 83 |
.SH DESCRIPTION |
| 84 |
.IX Header "DESCRIPTION" |
| 85 |
\&\fBBIO_s_mem()\fR returns the memory BIO method function. |
| 86 |
.PP |
| 87 |
A memory BIO is a source/sink BIO which uses memory for its I/O. Data |
| 88 |
written to a memory BIO is stored in a BUF_MEM structure which is extended |
| 89 |
as appropriate to accommodate the stored data. |
| 90 |
.PP |
| 91 |
\&\fBBIO_s_secmem()\fR is like \fBBIO_s_mem()\fR except that the secure heap is used |
| 92 |
for buffer storage. |
| 93 |
.PP |
| 94 |
\&\fBBIO_s_dgram_mem()\fR is a memory BIO that respects datagram semantics. A single |
| 95 |
call to \fBBIO_write\fR\|(3) will write a single datagram to the memory BIO. A |
| 96 |
subsequent call to \fBBIO_read\fR\|(3) will read the data in that datagram. The |
| 97 |
\&\fBBIO_read\fR\|(3) call will never return more data than was written in the original |
| 98 |
\&\fBBIO_write\fR\|(3) call even if there were subsequent \fBBIO_write\fR\|(3) calls that |
| 99 |
wrote more datagrams. Each successive call to \fBBIO_read\fR\|(3) will read the next |
| 100 |
datagram. If a \fBBIO_read\fR\|(3) call supplies a read buffer that is smaller than |
| 101 |
the size of the datagram, then the read buffer will be completely filled and the |
| 102 |
remaining data from the datagram will be discarded. |
| 103 |
.PP |
| 104 |
It is not possible to write a zero length datagram. Calling \fBBIO_write\fR\|(3) in |
| 105 |
this case will return 0 and no datagrams will be written. Calling \fBBIO_read\fR\|(3) |
| 106 |
when there are no datagrams in the BIO to read will return a negative result and |
| 107 |
the "retry" flags will be set (i.e. calling \fBBIO_should_retry\fR\|(3) will return |
| 108 |
true). A datagram mem BIO will never return true from \fBBIO_eof\fR\|(3). |
| 109 |
.PP |
| 110 |
Any data written to a memory BIO can be recalled by reading from it. |
| 111 |
Unless the memory BIO is read only any data read from it is deleted from |
| 112 |
the BIO. |
| 113 |
.PP |
| 114 |
Memory BIOs except \fBBIO_s_dgram_mem()\fR support \fBBIO_gets()\fR and \fBBIO_puts()\fR. |
| 115 |
.PP |
| 116 |
\&\fBBIO_s_dgram_mem()\fR supports \fBBIO_sendmmsg\fR\|(3) and \fBBIO_recvmmsg\fR\|(3) calls |
| 117 |
and calls related to \fBBIO_ADDR\fR and MTU handling similarly to the |
| 118 |
\&\fBBIO_s_dgram_pair\fR\|(3). |
| 119 |
.PP |
| 120 |
If the BIO_CLOSE flag is set when a memory BIO is freed then the underlying |
| 121 |
BUF_MEM structure is also freed. |
| 122 |
.PP |
| 123 |
Calling \fBBIO_reset()\fR on a read write memory BIO clears any data in it if the |
| 124 |
flag BIO_FLAGS_NONCLEAR_RST is not set, otherwise it just restores the read |
| 125 |
pointer to the state it was just after the last write was performed and the |
| 126 |
data can be read again. On a read only BIO it similarly restores the BIO to |
| 127 |
its original state and the read only data can be read again. |
| 128 |
.PP |
| 129 |
\&\fBBIO_eof()\fR is true if no data is in the BIO. |
| 130 |
.PP |
| 131 |
\&\fBBIO_ctrl_pending()\fR returns the number of bytes currently stored. |
| 132 |
.PP |
| 133 |
\&\fBBIO_set_mem_eof_return()\fR sets the behaviour of memory BIO \fBb\fR when it is |
| 134 |
empty. If the \fBv\fR is zero then an empty memory BIO will return EOF (that is |
| 135 |
it will return zero and BIO_should_retry(b) will be false. If \fBv\fR is non |
| 136 |
zero then it will return \fBv\fR when it is empty and it will set the read retry |
| 137 |
flag (that is BIO_read_retry(b) is true). To avoid ambiguity with a normal |
| 138 |
positive return value \fBv\fR should be set to a negative value, typically \-1. |
| 139 |
Calling this macro will fail for datagram mem BIOs. |
| 140 |
.PP |
| 141 |
\&\fBBIO_get_mem_data()\fR sets *\fBpp\fR to a pointer to the start of the memory BIOs data |
| 142 |
and returns the total amount of data available. It is implemented as a macro. |
| 143 |
Note the pointer returned by this call is informative, no transfer of ownership |
| 144 |
of this memory is implied. See notes on \fBBIO_set_close()\fR. |
| 145 |
.PP |
| 146 |
\&\fBBIO_set_mem_buf()\fR sets the internal BUF_MEM structure to \fBbm\fR and sets the |
| 147 |
close flag to \fBc\fR, that is \fBc\fR should be either BIO_CLOSE or BIO_NOCLOSE. |
| 148 |
It is a macro. |
| 149 |
.PP |
| 150 |
\&\fBBIO_get_mem_ptr()\fR places the underlying BUF_MEM structure in *\fBpp\fR. It is |
| 151 |
a macro. |
| 152 |
.PP |
| 153 |
\&\fBBIO_new_mem_buf()\fR creates a memory BIO using \fBlen\fR bytes of data at \fBbuf\fR, |
| 154 |
if \fBlen\fR is \-1 then the \fBbuf\fR is assumed to be nul terminated and its |
| 155 |
length is determined by \fBstrlen\fR. The BIO is set to a read only state and |
| 156 |
as a result cannot be written to. This is useful when some data needs to be |
| 157 |
made available from a static area of memory in the form of a BIO. The |
| 158 |
supplied data is read directly from the supplied buffer: it is \fBnot\fR copied |
| 159 |
first, so the supplied area of memory must be unchanged until the BIO is freed. |
| 160 |
.PP |
| 161 |
All of the five functions described above return an error with |
| 162 |
\&\fBBIO_s_dgram_mem()\fR. |
| 163 |
.SH NOTES |
| 164 |
.IX Header "NOTES" |
| 165 |
Writes to memory BIOs will always succeed if memory is available: that is |
| 166 |
their size can grow indefinitely. An exception is \fBBIO_s_dgram_mem()\fR when |
| 167 |
\&\fBBIO_set_write_buf_size\fR\|(3) is called on it. In such case the write buffer |
| 168 |
size will be fixed and any writes that would overflow the buffer will return |
| 169 |
an error. |
| 170 |
.PP |
| 171 |
Every write after partial read (not all data in the memory buffer was read) |
| 172 |
to a read write memory BIO will have to move the unread data with an internal |
| 173 |
copy operation, if a BIO contains a lot of data and it is read in small |
| 174 |
chunks intertwined with writes the operation can be very slow. Adding |
| 175 |
a buffering BIO to the chain can speed up the process. |
| 176 |
.PP |
| 177 |
Calling \fBBIO_set_mem_buf()\fR on a secmem or dgram BIO will give undefined results, |
| 178 |
including perhaps a program crash. |
| 179 |
.PP |
| 180 |
Switching a memory BIO from read write to read only is not supported and |
| 181 |
can give undefined results including a program crash. There are two notable |
| 182 |
exceptions to the rule. The first one is to assign a static memory buffer |
| 183 |
immediately after BIO creation and set the BIO as read only. |
| 184 |
.PP |
| 185 |
The other supported sequence is to start with a read write BIO then temporarily |
| 186 |
switch it to read only and call \fBBIO_reset()\fR on the read only BIO immediately |
| 187 |
before switching it back to read write. Before the BIO is freed it must be |
| 188 |
switched back to the read write mode. |
| 189 |
.PP |
| 190 |
Calling \fBBIO_get_mem_ptr()\fR on read only BIO will return a BUF_MEM that |
| 191 |
contains only the remaining data to be read. If the close status of the |
| 192 |
BIO is set to BIO_NOCLOSE, before freeing the BUF_MEM the data pointer |
| 193 |
in it must be set to NULL as the data pointer does not point to an |
| 194 |
allocated memory. |
| 195 |
.PP |
| 196 |
Calling \fBBIO_reset()\fR on a read write memory BIO with BIO_FLAGS_NONCLEAR_RST |
| 197 |
flag set can have unexpected outcome when the reads and writes to the |
| 198 |
BIO are intertwined. As documented above the BIO will be reset to the |
| 199 |
state after the last completed write operation. The effects of reads |
| 200 |
preceding that write operation cannot be undone. |
| 201 |
.PP |
| 202 |
Calling \fBBIO_get_mem_ptr()\fR prior to a \fBBIO_reset()\fR call with |
| 203 |
BIO_FLAGS_NONCLEAR_RST set has the same effect as a write operation. |
| 204 |
.PP |
| 205 |
Calling \fBBIO_set_close()\fR with BIO_NOCLOSE orphans the BUF_MEM internal to the |
| 206 |
BIO, _not_ its actual data buffer. See the examples section for the proper |
| 207 |
method for claiming ownership of the data pointer for a deferred free operation. |
| 208 |
.SH "RETURN VALUES" |
| 209 |
.IX Header "RETURN VALUES" |
| 210 |
\&\fBBIO_s_mem()\fR, \fBBIO_s_dgram_mem()\fR and \fBBIO_s_secmem()\fR return a valid memory |
| 211 |
\&\fBBIO_METHOD\fR structure. |
| 212 |
.PP |
| 213 |
\&\fBBIO_set_mem_eof_return()\fR, \fBBIO_set_mem_buf()\fR and \fBBIO_get_mem_ptr()\fR |
| 214 |
return 1 on success or a value which is less than or equal to 0 if an error occurred. |
| 215 |
.PP |
| 216 |
\&\fBBIO_get_mem_data()\fR returns the total number of bytes available on success, |
| 217 |
0 if b is NULL, or a negative value in case of other errors. |
| 218 |
.PP |
| 219 |
\&\fBBIO_new_mem_buf()\fR returns a valid \fBBIO\fR structure on success or NULL on error. |
| 220 |
.SH EXAMPLES |
| 221 |
.IX Header "EXAMPLES" |
| 222 |
Create a memory BIO and write some data to it: |
| 223 |
.PP |
| 224 |
.Vb 1 |
| 225 |
\& BIO *mem = BIO_new(BIO_s_mem()); |
| 226 |
\& |
| 227 |
\& BIO_puts(mem, "Hello World\en"); |
| 228 |
.Ve |
| 229 |
.PP |
| 230 |
Create a read only memory BIO: |
| 231 |
.PP |
| 232 |
.Vb 2 |
| 233 |
\& char data[] = "Hello World"; |
| 234 |
\& BIO *mem = BIO_new_mem_buf(data, \-1); |
| 235 |
.Ve |
| 236 |
.PP |
| 237 |
Extract the BUF_MEM structure from a memory BIO and then free up the BIO: |
| 238 |
.PP |
| 239 |
.Vb 1 |
| 240 |
\& BUF_MEM *bptr; |
| 241 |
\& |
| 242 |
\& BIO_get_mem_ptr(mem, &bptr); |
| 243 |
\& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */ |
| 244 |
\& BIO_free(mem); |
| 245 |
.Ve |
| 246 |
.PP |
| 247 |
Extract the BUF_MEM ptr, claim ownership of the internal data and free the BIO |
| 248 |
and BUF_MEM structure: |
| 249 |
.PP |
| 250 |
.Vb 2 |
| 251 |
\& BUF_MEM *bptr; |
| 252 |
\& char *data; |
| 253 |
\& |
| 254 |
\& BIO_get_mem_data(bio, &data); |
| 255 |
\& BIO_get_mem_ptr(bio, &bptr); |
| 256 |
\& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free orphans BUF_MEM */ |
| 257 |
\& BIO_free(bio); |
| 258 |
\& bptr\->data = NULL; /* Tell BUF_MEM to orphan data */ |
| 259 |
\& BUF_MEM_free(bptr); |
| 260 |
\& ... |
| 261 |
\& free(data); |
| 262 |
.Ve |
| 263 |
.SH HISTORY |
| 264 |
.IX Header "HISTORY" |
| 265 |
\&\fBBIO_s_dgram_mem()\fR was added in OpenSSL 3.2. |
| 266 |
.SH COPYRIGHT |
| 267 |
.IX Header "COPYRIGHT" |
| 268 |
Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. |
| 269 |
.PP |
| 270 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 271 |
this file except in compliance with the License. You can obtain a copy |
| 272 |
in the file LICENSE in the source distribution or at |
| 273 |
<https://www.openssl.org/source/license.html>. |