$NetBSD: BUF_MEM_new.3,v 1.9 2024/09/08 13:08:17 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BUF_MEM_new 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BUF_MEM_new, BUF_MEM_new_ex, BUF_MEM_free, BUF_MEM_grow, BUF_MEM_grow_clean, BUF_reverse \- simple character array structure Header "SYNOPSIS" .Vb 1 #include <openssl/buffer.h> \& BUF_MEM *BUF_MEM_new(void); \& BUF_MEM *BUF_MEM_new_ex(unsigned long flags); \& void BUF_MEM_free(BUF_MEM *a); \& int BUF_MEM_grow(BUF_MEM *str, int len); size_t BUF_MEM_grow_clean(BUF_MEM *str, size_t len); \& void BUF_reverse(unsigned char *out, const unsigned char *in, size_t size); .Ve Header "DESCRIPTION" The buffer library handles simple character arrays. Buffers are used for various purposes in the library, most notably memory BIOs.

\fBBUF_MEM_new() allocates a new buffer of zero size.

\fBBUF_MEM_new_ex() allocates a buffer with the specified flags. The flag BUF_MEM_FLAG_SECURE specifies that the data pointer should be allocated on the secure heap; see CRYPTO_secure_malloc\|(3).

\fBBUF_MEM_free() frees up an already existing buffer. The data is zeroed before freeing up in case the buffer contains sensitive data. If the argument is NULL, nothing is done.

\fBBUF_MEM_grow() changes the size of an already existing buffer to \fBlen. Any data already in the buffer is preserved if it increases in size.

\fBBUF_MEM_grow_clean() is similar to BUF_MEM_grow() but it sets any free'd or additionally-allocated memory to zero.

\fBBUF_reverse() reverses size bytes at in into out. If in is NULL, the array is reversed in-place.

Header "RETURN VALUES" \fBBUF_MEM_new() returns the buffer or NULL on error.

\fBBUF_MEM_free() has no return value.

\fBBUF_MEM_grow() and BUF_MEM_grow_clean() return zero on error or the new size (i.e., len).

Header "SEE ALSO" \fBbio\|(7), \fBCRYPTO_secure_malloc\|(3). Header "HISTORY" The BUF_MEM_new_ex() function was added in OpenSSL 1.1.0. Header "COPYRIGHT" Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.