5 BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow
6 BUF_MEM_grow_clean, BUF_reverse
7 - simple character array structure
9 standard C library equivalents
13 #include <openssl/buffer.h>
15 BUF_MEM *BUF_MEM_new(void);
17 BUF_MEM *BUF_MEM_new_ex(unsigned long flags);
19 void BUF_MEM_free(BUF_MEM *a);
21 int BUF_MEM_grow(BUF_MEM *str, int len);
22 size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len);
24 void BUF_reverse(unsigned char *out, const unsigned char *in, size_t size);
28 The buffer library handles simple character arrays. Buffers are used for
29 various purposes in the library, most notably memory BIOs.
31 BUF_MEM_new() allocates a new buffer of zero size.
33 BUF_MEM_new_ex() allocates a buffer with the specified flags.
34 The flag B<BUF_MEM_FLAG_SECURE> specifies that the B<data> pointer
35 should be allocated on the secure heap; see L<CRYPTO_secure_malloc(3)>.
37 BUF_MEM_free() frees up an already existing buffer. The data is zeroed
38 before freeing up in case the buffer contains sensitive data.
40 BUF_MEM_grow() changes the size of an already existing buffer to
41 B<len>. Any data already in the buffer is preserved if it increases in
44 BUF_MEM_grow_clean() is similar to BUF_MEM_grow() but it sets any free'd
45 or additionally-allocated memory to zero.
47 BUF_reverse() reverses B<size> bytes at B<in> into B<out>. If B<out>
48 is NULL, the array is reversed in-place.
52 BUF_MEM_new() returns the buffer or NULL on error.
54 BUF_MEM_free() has no return value.
56 BUF_MEM_grow() and BUF_MEM_grow_clean() return
57 zero on error or the new size (i.e., B<len>).
62 L<CRYPTO_secure_malloc(3)>.
66 BUF_MEM_new_ex() was added in OpenSSL 1.1.0.
70 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
72 Licensed under the OpenSSL license (the "License"). You may not use
73 this file except in compliance with the License. You can obtain a copy
74 in the file LICENSE in the source distribution or at
75 L<https://www.openssl.org/source/license.html>.