1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "BUF_MEM_NEW 3"
136 .TH BUF_MEM_NEW 3 "2021-02-16" "1.1.1j" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow, BUF_MEM_grow_clean, BUF_reverse \&\- simple character array structure
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/buffer.h>
148 \& BUF_MEM *BUF_MEM_new(void);
150 \& BUF_MEM *BUF_MEM_new_ex(unsigned long flags);
152 \& void BUF_MEM_free(BUF_MEM *a);
154 \& int BUF_MEM_grow(BUF_MEM *str, int len);
155 \& size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
157 \& void BUF_reverse(unsigned char *out, const unsigned char *in, size_t size);
160 .IX Header "DESCRIPTION"
161 The buffer library handles simple character arrays. Buffers are used for
162 various purposes in the library, most notably memory BIOs.
164 \&\fBBUF_MEM_new()\fR allocates a new buffer of zero size.
166 \&\fBBUF_MEM_new_ex()\fR allocates a buffer with the specified flags.
167 The flag \fB\s-1BUF_MEM_FLAG_SECURE\s0\fR specifies that the \fBdata\fR pointer
168 should be allocated on the secure heap; see \fBCRYPTO_secure_malloc\fR\|(3).
170 \&\fBBUF_MEM_free()\fR frees up an already existing buffer. The data is zeroed
171 before freeing up in case the buffer contains sensitive data.
173 \&\fBBUF_MEM_grow()\fR changes the size of an already existing buffer to
174 \&\fBlen\fR. Any data already in the buffer is preserved if it increases in
177 \&\fBBUF_MEM_grow_clean()\fR is similar to \fBBUF_MEM_grow()\fR but it sets any free'd
178 or additionally-allocated memory to zero.
180 \&\fBBUF_reverse()\fR reverses \fBsize\fR bytes at \fBin\fR into \fBout\fR. If \fBin\fR
181 is \s-1NULL,\s0 the array is reversed in-place.
183 .IX Header "RETURN VALUES"
184 \&\fBBUF_MEM_new()\fR returns the buffer or \s-1NULL\s0 on error.
186 \&\fBBUF_MEM_free()\fR has no return value.
188 \&\fBBUF_MEM_grow()\fR and \fBBUF_MEM_grow_clean()\fR return
189 zero on error or the new size (i.e., \fBlen\fR).
191 .IX Header "SEE ALSO"
193 \&\fBCRYPTO_secure_malloc\fR\|(3).
196 The \fBBUF_MEM_new_ex()\fR function was added in OpenSSL 1.1.0.
198 .IX Header "COPYRIGHT"
199 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
201 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
202 this file except in compliance with the License. You can obtain a copy
203 in the file \s-1LICENSE\s0 in the source distribution or at
204 <https://www.openssl.org/source/license.html>.