Debian Codegraph @

upstream/debian-unstable/man3/BUF_MEM_new.3ssl

raw
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 "BUF_MEM_NEW 3SSL"
58 .TH BUF_MEM_NEW 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 BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow,
65 BUF_MEM_grow_clean, BUF_reverse
66 \&\- simple character array structure
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/buffer.h>
71 \&
72 \& BUF_MEM *BUF_MEM_new(void);
73 \&
74 \& BUF_MEM *BUF_MEM_new_ex(unsigned long flags);
75 \&
76 \& void BUF_MEM_free(BUF_MEM *a);
77 \&
78 \& int BUF_MEM_grow(BUF_MEM *str, int len);
79 \& size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
80 \&
81 \& void BUF_reverse(unsigned char *out, const unsigned char *in, size_t size);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 The buffer library handles simple character arrays. Buffers are used for
86 various purposes in the library, most notably memory BIOs.
87 .PP
88 \&\fBBUF_MEM_new()\fR allocates a new buffer of zero size.
89 .PP
90 \&\fBBUF_MEM_new_ex()\fR allocates a buffer with the specified flags.
91 The flag \fBBUF_MEM_FLAG_SECURE\fR specifies that the \fBdata\fR pointer
92 should be allocated on the secure heap; see \fBCRYPTO_secure_malloc\fR\|(3).
93 .PP
94 \&\fBBUF_MEM_free()\fR frees up an already existing buffer. The data is zeroed
95 before freeing up in case the buffer contains sensitive data.
96 If the argument is NULL, nothing is done.
97 .PP
98 \&\fBBUF_MEM_grow()\fR changes the size of an already existing buffer to
99 \&\fBlen\fR. Any data already in the buffer is preserved if it increases in
100 size.
101 .PP
102 \&\fBBUF_MEM_grow_clean()\fR is similar to \fBBUF_MEM_grow()\fR but it sets any free'd
103 or additionally-allocated memory to zero.
104 .PP
105 \&\fBBUF_reverse()\fR reverses \fBsize\fR bytes at \fBin\fR into \fBout\fR. If \fBin\fR
106 is NULL, the array is reversed in-place.
107 .SH "RETURN VALUES"
108 .IX Header "RETURN VALUES"
109 \&\fBBUF_MEM_new()\fR returns the buffer or NULL on error.
110 .PP
111 \&\fBBUF_MEM_free()\fR has no return value.
112 .PP
113 \&\fBBUF_MEM_grow()\fR and \fBBUF_MEM_grow_clean()\fR return
114 zero on error or the new size (i.e., \fBlen\fR).
115 .SH "SEE ALSO"
116 .IX Header "SEE ALSO"
117 \&\fBbio\fR\|(7),
118 \&\fBCRYPTO_secure_malloc\fR\|(3).
119 .SH HISTORY
120 .IX Header "HISTORY"
121 The \fBBUF_MEM_new_ex()\fR function was added in OpenSSL 1.1.0.
122 .SH COPYRIGHT
123 .IX Header "COPYRIGHT"
124 Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
125 .PP
126 Licensed under the Apache License 2.0 (the "License"). You may not use
127 this file except in compliance with the License. You can obtain a copy
128 in the file LICENSE in the source distribution or at
129 <https://www.openssl.org/source/license.html>.