332 lines
13 KiB
Groff
Executable File
332 lines
13 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "OPENSSL_MALLOC 3"
|
|
.TH OPENSSL_MALLOC 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
OPENSSL_malloc_init,
|
|
OPENSSL_malloc, OPENSSL_zalloc, OPENSSL_realloc, OPENSSL_free,
|
|
OPENSSL_clear_realloc, OPENSSL_clear_free, OPENSSL_cleanse,
|
|
CRYPTO_malloc, CRYPTO_zalloc, CRYPTO_realloc, CRYPTO_free,
|
|
OPENSSL_strdup, OPENSSL_strndup,
|
|
OPENSSL_memdup, OPENSSL_strlcpy, OPENSSL_strlcat,
|
|
CRYPTO_strdup, CRYPTO_strndup,
|
|
OPENSSL_mem_debug_push, OPENSSL_mem_debug_pop,
|
|
CRYPTO_mem_debug_push, CRYPTO_mem_debug_pop,
|
|
CRYPTO_clear_realloc, CRYPTO_clear_free,
|
|
CRYPTO_malloc_fn, CRYPTO_realloc_fn, CRYPTO_free_fn,
|
|
CRYPTO_get_mem_functions, CRYPTO_set_mem_functions,
|
|
CRYPTO_get_alloc_counts,
|
|
CRYPTO_set_mem_debug, CRYPTO_mem_ctrl,
|
|
CRYPTO_mem_leaks, CRYPTO_mem_leaks_fp, CRYPTO_mem_leaks_cb,
|
|
OPENSSL_MALLOC_FAILURES,
|
|
OPENSSL_MALLOC_FD
|
|
\&\- Memory allocation functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/crypto.h>
|
|
\&
|
|
\& int OPENSSL_malloc_init(void);
|
|
\&
|
|
\& void *OPENSSL_malloc(size_t num);
|
|
\& void *OPENSSL_zalloc(size_t num);
|
|
\& void *OPENSSL_realloc(void *addr, size_t num);
|
|
\& void OPENSSL_free(void *addr);
|
|
\& char *OPENSSL_strdup(const char *str);
|
|
\& char *OPENSSL_strndup(const char *str, size_t s);
|
|
\& size_t OPENSSL_strlcat(char *dst, const char *src, size_t size);
|
|
\& size_t OPENSSL_strlcpy(char *dst, const char *src, size_t size);
|
|
\& void *OPENSSL_memdup(void *data, size_t s);
|
|
\& void *OPENSSL_clear_realloc(void *p, size_t old_len, size_t num);
|
|
\& void OPENSSL_clear_free(void *str, size_t num);
|
|
\& void OPENSSL_cleanse(void *ptr, size_t len);
|
|
\&
|
|
\& void *CRYPTO_malloc(size_t num, const char *file, int line);
|
|
\& void *CRYPTO_zalloc(size_t num, const char *file, int line);
|
|
\& void *CRYPTO_realloc(void *p, size_t num, const char *file, int line);
|
|
\& void CRYPTO_free(void *str, const char *, int);
|
|
\& char *CRYPTO_strdup(const char *p, const char *file, int line);
|
|
\& char *CRYPTO_strndup(const char *p, size_t num, const char *file, int line);
|
|
\& void *CRYPTO_clear_realloc(void *p, size_t old_len, size_t num,
|
|
\& const char *file, int line);
|
|
\& void CRYPTO_clear_free(void *str, size_t num, const char *, int)
|
|
\&
|
|
\& typedef void *(*CRYPTO_malloc_fn)(size_t num, const char *file, int line);
|
|
\& typedef void *(*CRYPTO_realloc_fn)(void *addr, size_t num, const char *file,
|
|
\& int line);
|
|
\& typedef void (*CRYPTO_free_fn)(void *addr, const char *file, int line);
|
|
\& void CRYPTO_get_mem_functions(CRYPTO_malloc_fn *malloc_fn,
|
|
\& CRYPTO_realloc_fn *realloc_fn,
|
|
\& CRYPTO_free_fn *free_fn);
|
|
\& int CRYPTO_set_mem_functions(CRYPTO_malloc_fn malloc_fn,
|
|
\& CRYPTO_realloc_fn realloc_fn,
|
|
\& CRYPTO_free_fn free_fn);
|
|
\&
|
|
\& void CRYPTO_get_alloc_counts(int *mcount, int *rcount, int *fcount);
|
|
\&
|
|
\& env OPENSSL_MALLOC_FAILURES=... <application>
|
|
\& env OPENSSL_MALLOC_FD=... <application>
|
|
.Ve
|
|
.PP
|
|
Deprecated:
|
|
.PP
|
|
.Vb 4
|
|
\& int CRYPTO_mem_leaks(BIO *b);
|
|
\& int CRYPTO_mem_leaks_fp(FILE *fp);
|
|
\& int CRYPTO_mem_leaks_cb(int (*cb)(const char *str, size_t len, void *u),
|
|
\& void *u);
|
|
\&
|
|
\& int CRYPTO_set_mem_debug(int onoff)
|
|
\& int CRYPTO_mem_ctrl(int mode);
|
|
\& int OPENSSL_mem_debug_push(const char *info)
|
|
\& int OPENSSL_mem_debug_pop(void);
|
|
\& int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
|
|
\& int CRYPTO_mem_debug_pop(void);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
OpenSSL memory allocation is handled by the \fBOPENSSL_xxx\fR \s-1API\s0. These are
|
|
generally macro's that add the standard C \fB_\|_FILE_\|_\fR and \fB_\|_LINE_\|_\fR
|
|
parameters and call a lower-level \fBCRYPTO_xxx\fR \s-1API\s0.
|
|
Some functions do not add those parameters, but exist for consistency.
|
|
.PP
|
|
\&\fIOPENSSL_malloc_init()\fR does nothing and does not need to be called. It is
|
|
included for compatibility with older versions of OpenSSL.
|
|
.PP
|
|
\&\fIOPENSSL_malloc()\fR, \fIOPENSSL_realloc()\fR, and \fIOPENSSL_free()\fR are like the
|
|
C \fImalloc()\fR, \fIrealloc()\fR, and \fIfree()\fR functions.
|
|
\&\fIOPENSSL_zalloc()\fR calls \fImemset()\fR to zero the memory before returning.
|
|
.PP
|
|
\&\fIOPENSSL_clear_realloc()\fR and \fIOPENSSL_clear_free()\fR should be used
|
|
when the buffer at \fBaddr\fR holds sensitive information.
|
|
The old buffer is filled with zero's by calling \fIOPENSSL_cleanse()\fR
|
|
before ultimately calling \fIOPENSSL_free()\fR.
|
|
.PP
|
|
\&\fIOPENSSL_cleanse()\fR fills \fBptr\fR of size \fBlen\fR with a string of 0's.
|
|
Use \fIOPENSSL_cleanse()\fR with care if the memory is a mapping of a file.
|
|
If the storage controller uses write compression, then its possible
|
|
that sensitive tail bytes will survive zeroization because the block of
|
|
zeros will be compressed. If the storage controller uses wear leveling,
|
|
then the old sensitive data will not be overwritten; rather, a block of
|
|
0's will be written at a new physical location.
|
|
.PP
|
|
\&\fIOPENSSL_strdup()\fR, \fIOPENSSL_strndup()\fR and \fIOPENSSL_memdup()\fR are like the
|
|
equivalent C functions, except that memory is allocated by calling the
|
|
\&\fIOPENSSL_malloc()\fR and should be released by calling \fIOPENSSL_free()\fR.
|
|
.PP
|
|
\&\fIOPENSSL_strlcpy()\fR,
|
|
\&\fIOPENSSL_strlcat()\fR and \fIOPENSSL_strnlen()\fR are equivalents of the common C
|
|
library functions and are provided for portability.
|
|
.PP
|
|
If no allocations have been done, it is possible to \*(L"swap out\*(R" the default
|
|
implementations for \fIOPENSSL_malloc()\fR, \fIOPENSSL_realloc()\fR and \fIOPENSSL_free()\fR
|
|
and replace them with alternate versions.
|
|
\&\fICRYPTO_get_mem_functions()\fR function fills in the given arguments with the
|
|
function pointers for the current implementations.
|
|
With \fICRYPTO_set_mem_functions()\fR, you can specify a different set of functions.
|
|
If any of \fBmalloc_fn\fR, \fBrealloc_fn\fR, or \fBfree_fn\fR are \s-1NULL\s0, then
|
|
the function is not changed.
|
|
While it's permitted to swap out only a few and not all the functions
|
|
with \fICRYPTO_set_mem_functions()\fR, it's recommended to swap them all out
|
|
at once.
|
|
.PP
|
|
If the library is built with the \f(CW\*(C`crypto\-mdebug\*(C'\fR option, then one
|
|
function, \fICRYPTO_get_alloc_counts()\fR, and two additional environment
|
|
variables, \fB\s-1OPENSSL_MALLOC_FAILURES\s0\fR and \fB\s-1OPENSSL_MALLOC_FD\s0\fR,
|
|
are available.
|
|
.PP
|
|
The function \fICRYPTO_get_alloc_counts()\fR fills in the number of times
|
|
each of \fICRYPTO_malloc()\fR, \fICRYPTO_realloc()\fR, and \fICRYPTO_free()\fR have been
|
|
called, into the values pointed to by \fBmcount\fR, \fBrcount\fR, and \fBfcount\fR,
|
|
respectively. If a pointer is \s-1NULL\s0, then the corresponding count is not stored.
|
|
.PP
|
|
The variable
|
|
\&\fB\s-1OPENSSL_MALLOC_FAILURES\s0\fR controls how often allocations should fail.
|
|
It is a set of fields separated by semicolons, which each field is a count
|
|
(defaulting to zero) and an optional atsign and percentage (defaulting
|
|
to 100). If the count is zero, then it lasts forever. For example,
|
|
\&\f(CW\*(C`100;@25\*(C'\fR or \f(CW\*(C`100@0;0@25\*(C'\fR means the first 100 allocations pass, then all
|
|
other allocations (until the program exits or crashes) have a 25% chance of
|
|
failing.
|
|
.PP
|
|
If the variable \fB\s-1OPENSSL_MALLOC_FD\s0\fR is parsed as a positive integer, then
|
|
it is taken as an open file descriptor, and a record of all allocations is
|
|
written to that descriptor. If an allocation will fail, and the platform
|
|
supports it, then a backtrace will be written to the descriptor. This can
|
|
be useful because a malloc may fail but not be checked, and problems will
|
|
only occur later. The following example in classic shell syntax shows how
|
|
to use this (will not work on all platforms):
|
|
.PP
|
|
.Vb 5
|
|
\& OPENSSL_MALLOC_FAILURES=\*(Aq200;@10\*(Aq
|
|
\& export OPENSSL_MALLOC_FAILURES
|
|
\& OPENSSL_MALLOC_FD=3
|
|
\& export OPENSSL_MALLOC_FD
|
|
\& ...app invocation... 3>/tmp/log$$
|
|
.Ve
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIOPENSSL_malloc_init()\fR, \fIOPENSSL_free()\fR, \fIOPENSSL_clear_free()\fR
|
|
\&\fICRYPTO_free()\fR, \fICRYPTO_clear_free()\fR and \fICRYPTO_get_mem_functions()\fR
|
|
return no value.
|
|
.PP
|
|
\&\fIOPENSSL_malloc()\fR, \fIOPENSSL_zalloc()\fR, \fIOPENSSL_realloc()\fR,
|
|
\&\fIOPENSSL_clear_realloc()\fR,
|
|
\&\fICRYPTO_malloc()\fR, \fICRYPTO_zalloc()\fR, \fICRYPTO_realloc()\fR,
|
|
\&\fICRYPTO_clear_realloc()\fR,
|
|
\&\fIOPENSSL_strdup()\fR, and \fIOPENSSL_strndup()\fR
|
|
return a pointer to allocated memory or \s-1NULL\s0 on error.
|
|
.PP
|
|
\&\fICRYPTO_set_mem_functions()\fR returns 1 on success or 0 on failure (almost
|
|
always because allocations have already happened).
|
|
.PP
|
|
\&\fICRYPTO_mem_leaks()\fR, \fICRYPTO_mem_leaks_fp()\fR, \fICRYPTO_mem_leaks_cb()\fR,
|
|
\&\fICRYPTO_set_mem_debug()\fR, and \fICRYPTO_mem_ctrl()\fR are deprecated and return \-1.
|
|
\&\fIOPENSSL_mem_debug_push()\fR, \fIOPENSSL_mem_debug_pop()\fR,
|
|
\&\fICRYPTO_mem_debug_push()\fR, and \fICRYPTO_mem_debug_pop()\fR
|
|
are deprecated and return 0.
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
\&\fIOPENSSL_mem_debug_push()\fR, \fIOPENSSL_mem_debug_pop()\fR,
|
|
\&\fICRYPTO_mem_debug_push()\fR, \fICRYPTO_mem_debug_pop()\fR,
|
|
\&\fICRYPTO_mem_leaks()\fR, \fICRYPTO_mem_leaks_fp()\fR,
|
|
\&\fICRYPTO_mem_leaks_cb()\fR, \fICRYPTO_set_mem_debug()\fR, \fICRYPTO_mem_ctrl()\fR
|
|
were deprecated in OpenSSL 3.0.
|
|
The memory-leak checking has been deprecated in OpenSSL 3.0 in favor of
|
|
clang's memory and leak sanitizer.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|