66688277a2b8aa6681011b87bba982f31713815c
[dragonfly.git] / secure / lib / libcrypto / man / buffer.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.23)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "buffer 3"
127 .TH buffer 3 "2013-02-05" "1.0.1d" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 BUF_MEM_new, BUF_MEM_free, BUF_MEM_grow, BUF_strdup \- simple
134 character arrays structure
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 1
138 \& #include <openssl/buffer.h>
139 \&
140 \& BUF_MEM *BUF_MEM_new(void);
141 \&
142 \& void   BUF_MEM_free(BUF_MEM *a);
143 \&
144 \& int    BUF_MEM_grow(BUF_MEM *str, int len);
145 \&
146 \& char * BUF_strdup(const char *str);
147 .Ve
148 .SH "DESCRIPTION"
149 .IX Header "DESCRIPTION"
150 The buffer library handles simple character arrays. Buffers are used for
151 various purposes in the library, most notably memory BIOs.
152 .PP
153 The library uses the \s-1BUF_MEM\s0 structure defined in buffer.h:
154 .PP
155 .Vb 6
156 \& typedef struct buf_mem_st
157 \& {
158 \&        int length;     /* current number of bytes */
159 \&        char *data;
160 \&        int max;        /* size of buffer */
161 \& } BUF_MEM;
162 .Ve
163 .PP
164 \&\fBlength\fR is the current size of the buffer in bytes, \fBmax\fR is the amount of
165 memory allocated to the buffer. There are three functions which handle these
166 and one \*(L"miscellaneous\*(R" function.
167 .PP
168 \&\fIBUF_MEM_new()\fR allocates a new buffer of zero size.
169 .PP
170 \&\fIBUF_MEM_free()\fR frees up an already existing buffer. The data is zeroed
171 before freeing up in case the buffer contains sensitive data.
172 .PP
173 \&\fIBUF_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
175 size.
176 .PP
177 \&\fIBUF_strdup()\fR copies a null terminated string into a block of allocated
178 memory and returns a pointer to the allocated block.
179 Unlike the standard C library \fIstrdup()\fR this function uses \fIOPENSSL_malloc()\fR and so
180 should be used in preference to the standard library \fIstrdup()\fR because it can
181 be used for memory leak checking or replacing the \fImalloc()\fR function.
182 .PP
183 The memory allocated from \fIBUF_strdup()\fR should be freed up using the \fIOPENSSL_free()\fR
184 function.
185 .SH "RETURN VALUES"
186 .IX Header "RETURN VALUES"
187 \&\fIBUF_MEM_new()\fR returns the buffer or \s-1NULL\s0 on error.
188 .PP
189 \&\fIBUF_MEM_free()\fR has no return value.
190 .PP
191 \&\fIBUF_MEM_grow()\fR returns zero on error or the new size (i.e. \fBlen\fR).
192 .SH "SEE ALSO"
193 .IX Header "SEE ALSO"
194 \&\fIbio\fR\|(3)
195 .SH "HISTORY"
196 .IX Header "HISTORY"
197 \&\fIBUF_MEM_new()\fR, \fIBUF_MEM_free()\fR and \fIBUF_MEM_grow()\fR are available in all
198 versions of SSLeay and OpenSSL. \fIBUF_strdup()\fR was added in SSLeay 0.8.