secure/lib/libcrypto/man/BIO_s_mem.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_S_MEM 3"
 132 .TH BIO_S_MEM 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BIO_s_secmem, BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf, BIO_get_mem_ptr, BIO_new_mem_buf \- memory BIO
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& const BIO_METHOD *BIO_s_mem(void);
 145 \& const BIO_METHOD *BIO_s_secmem(void);
 146 \&
 147 \& BIO_set_mem_eof_return(BIO *b, int v)
 148 \& long BIO_get_mem_data(BIO *b, char **pp)
 149 \& BIO_set_mem_buf(BIO *b, BUF_MEM *bm, int c)
 150 \& BIO_get_mem_ptr(BIO *b, BUF_MEM **pp)
 151 \&
 152 \& BIO *BIO_new_mem_buf(const void *buf, int len);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fIBIO_s_mem()\fR returns the memory \s-1BIO\s0 method function.
 157 .PP
 158 A memory \s-1BIO\s0 is a source/sink \s-1BIO\s0 which uses memory for its I/O. Data
 159 written to a memory \s-1BIO\s0 is stored in a \s-1BUF_MEM\s0 structure which is extended
 160 as appropriate to accommodate the stored data.
 161 .PP
 162 \&\fIBIO_s_secmem()\fR is like \fIBIO_s_mem()\fR except that the secure heap is used
 163 for buffer storage.
 164 .PP
 165 Any data written to a memory \s-1BIO\s0 can be recalled by reading from it.
 166 Unless the memory \s-1BIO\s0 is read only any data read from it is deleted from
 167 the \s-1BIO.\s0
 168 .PP
 169 Memory BIOs support \fIBIO_gets()\fR and \fIBIO_puts()\fR.
 170 .PP
 171 If the \s-1BIO_CLOSE\s0 flag is set when a memory \s-1BIO\s0 is freed then the underlying
 172 \&\s-1BUF_MEM\s0 structure is also freed.
 173 .PP
 174 Calling \fIBIO_reset()\fR on a read write memory \s-1BIO\s0 clears any data in it if the
 175 flag \s-1BIO_FLAGS_NONCLEAR_RST\s0 is not set. On a read only \s-1BIO\s0 or if the flag
 176 \&\s-1BIO_FLAGS_NONCLEAR_RST\s0 is set it restores the \s-1BIO\s0 to its original state and
 177 the data can be read again.
 178 .PP
 179 \&\fIBIO_eof()\fR is true if no data is in the \s-1BIO.\s0
 180 .PP
 181 \&\fIBIO_ctrl_pending()\fR returns the number of bytes currently stored.
 182 .PP
 183 \&\fIBIO_set_mem_eof_return()\fR sets the behaviour of memory \s-1BIO\s0 \fBb\fR when it is
 184 empty. If the \fBv\fR is zero then an empty memory \s-1BIO\s0 will return \s-1EOF\s0 (that is
 185 it will return zero and BIO_should_retry(b) will be false. If \fBv\fR is non
 186 zero then it will return \fBv\fR when it is empty and it will set the read retry
 187 flag (that is BIO_read_retry(b) is true). To avoid ambiguity with a normal
 188 positive return value \fBv\fR should be set to a negative value, typically \-1.
 189 .PP
 190 \&\fIBIO_get_mem_data()\fR sets *\fBpp\fR to a pointer to the start of the memory BIOs data
 191 and returns the total amount of data available. It is implemented as a macro.
 192 .PP
 193 \&\fIBIO_set_mem_buf()\fR sets the internal \s-1BUF_MEM\s0 structure to \fBbm\fR and sets the
 194 close flag to \fBc\fR, that is \fBc\fR should be either \s-1BIO_CLOSE\s0 or \s-1BIO_NOCLOSE.\s0
 195 It is a macro.
 196 .PP
 197 \&\fIBIO_get_mem_ptr()\fR places the underlying \s-1BUF_MEM\s0 structure in *\fBpp\fR. It is
 198 a macro.
 199 .PP
 200 \&\fIBIO_new_mem_buf()\fR creates a memory \s-1BIO\s0 using \fBlen\fR bytes of data at \fBbuf\fR,
 201 if \fBlen\fR is \-1 then the \fBbuf\fR is assumed to be nul terminated and its
 202 length is determined by \fBstrlen\fR. The \s-1BIO\s0 is set to a read only state and
 203 as a result cannot be written to. This is useful when some data needs to be
 204 made available from a static area of memory in the form of a \s-1BIO.\s0 The
 205 supplied data is read directly from the supplied buffer: it is \fBnot\fR copied
 206 first, so the supplied area of memory must be unchanged until the \s-1BIO\s0 is freed.
 207 .SH "NOTES"
 208 .IX Header "NOTES"
 209 Writes to memory BIOs will always succeed if memory is available: that is
 210 their size can grow indefinitely.
 211 .PP
 212 Every read from a read write memory \s-1BIO\s0 will remove the data just read with
 213 an internal copy operation, if a \s-1BIO\s0 contains a lot of data and it is
 214 read in small chunks the operation can be very slow. The use of a read only
 215 memory \s-1BIO\s0 avoids this problem. If the \s-1BIO\s0 must be read write then adding
 216 a buffering \s-1BIO\s0 to the chain will speed up the process.
 217 .PP
 218 Calling \fIBIO_set_mem_buf()\fR on a \s-1BIO\s0 created with \fIBIO_new_secmem()\fR will
 219 give undefined results, including perhaps a program crash.
 220 .SH "BUGS"
 221 .IX Header "BUGS"
 222 There should be an option to set the maximum size of a memory \s-1BIO.\s0
 223 .SH "EXAMPLE"
 224 .IX Header "EXAMPLE"
 225 Create a memory \s-1BIO\s0 and write some data to it:
 226 .PP
 227 .Vb 1
 228 \& BIO *mem = BIO_new(BIO_s_mem());
 229 \&
 230 \& BIO_puts(mem, "Hello World\en");
 231 .Ve
 232 .PP
 233 Create a read only memory \s-1BIO:\s0
 234 .PP
 235 .Vb 2
 236 \& char data[] = "Hello World";
 237 \& BIO *mem = BIO_new_mem_buf(data, \-1);
 238 .Ve
 239 .PP
 240 Extract the \s-1BUF_MEM\s0 structure from a memory \s-1BIO\s0 and then free up the \s-1BIO:\s0
 241 .PP
 242 .Vb 1
 243 \& BUF_MEM *bptr;
 244 \&
 245 \& BIO_get_mem_ptr(mem, &bptr);
 246 \& BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */
 247 \& BIO_free(mem);
 248 .Ve
 249 .SH "RETURN VALUES"
 250 .IX Header "RETURN VALUES"
 251 \&\fIBIO_s_mem()\fR and \fIBIO_s_secmem()\fR return a valid memory \fB\s-1BIO_METHOD\s0\fR structure.
 252 .PP
 253 \&\fIBIO_set_mem_eof_return()\fR, \fIBIO_get_mem_data()\fR, \fIBIO_set_mem_buf()\fR and \fIBIO_get_mem_ptr()\fR
 254 return 1 on success or a value which is less than or equal to 0 if an error occurred.
 255 .PP
 256 \&\fIBIO_new_mem_buf()\fR returns a valid \fB\s-1BIO\s0\fR structure on success or \s-1NULL\s0 on error.
 257 .SH "COPYRIGHT"
 258 .IX Header "COPYRIGHT"
 259 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 260 .PP
 261 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 262 this file except in compliance with the License.  You can obtain a copy
 263 in the file \s-1LICENSE\s0 in the source distribution or at
 264 <https://www.openssl.org/source/license.html>.