266 lines
9.8 KiB
Groff
Executable File
266 lines
9.8 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_SECURE_MALLOC 3"
|
|
.TH OPENSSL_SECURE_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"
|
|
CRYPTO_secure_malloc_init, CRYPTO_secure_malloc_initialized,
|
|
CRYPTO_secure_malloc_done, OPENSSL_secure_malloc, CRYPTO_secure_malloc,
|
|
OPENSSL_secure_zalloc, CRYPTO_secure_zalloc, OPENSSL_secure_free,
|
|
CRYPTO_secure_free, OPENSSL_secure_clear_free,
|
|
CRYPTO_secure_clear_free, OPENSSL_secure_actual_size,
|
|
CRYPTO_secure_allocated,
|
|
CRYPTO_secure_used \- secure heap storage
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/crypto.h>
|
|
\&
|
|
\& int CRYPTO_secure_malloc_init(size_t size, size_t minsize);
|
|
\&
|
|
\& int CRYPTO_secure_malloc_initialized();
|
|
\&
|
|
\& int CRYPTO_secure_malloc_done();
|
|
\&
|
|
\& void *OPENSSL_secure_malloc(size_t num);
|
|
\& void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
|
|
\&
|
|
\& void *OPENSSL_secure_zalloc(size_t num);
|
|
\& void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
|
|
\&
|
|
\& void OPENSSL_secure_free(void* ptr);
|
|
\& void CRYPTO_secure_free(void *ptr, const char *, int);
|
|
\&
|
|
\& void OPENSSL_secure_clear_free(void* ptr, size_t num);
|
|
\& void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *, int);
|
|
\&
|
|
\& size_t OPENSSL_secure_actual_size(const void *ptr);
|
|
\&
|
|
\& int CRYPTO_secure_allocated(const void *ptr);
|
|
\& size_t CRYPTO_secure_used();
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
In order to help protect applications (particularly long-running servers)
|
|
from pointer overruns or underruns that could return arbitrary data from
|
|
the program's dynamic memory area, where keys and other sensitive
|
|
information might be stored, OpenSSL supports the concept of a \*(L"secure heap.\*(R"
|
|
The level and type of security guarantees depend on the operating system.
|
|
It is a good idea to review the code and see if it addresses your
|
|
threat model and concerns.
|
|
.PP
|
|
If a secure heap is used, then private key \fB\s-1BIGNUM\s0\fR values are stored there.
|
|
This protects long-term storage of private keys, but will not necessarily
|
|
put all intermediate values and computations there.
|
|
.PP
|
|
\&\fICRYPTO_secure_malloc_init()\fR creates the secure heap, with the specified
|
|
\&\f(CW\*(C`size\*(C'\fR in bytes. The \f(CW\*(C`minsize\*(C'\fR parameter is the minimum size to
|
|
allocate from the heap or zero to use a reasonable default value.
|
|
Both \f(CW\*(C`size\*(C'\fR and, if specified, \f(CW\*(C`minsize\*(C'\fR must be a power of two and
|
|
\&\f(CW\*(C`minsize\*(C'\fR should generally be small, for example 16 or 32.
|
|
\&\f(CW\*(C`minsize\*(C'\fR must be less than a quarter of \f(CW\*(C`size\*(C'\fR in any case.
|
|
.PP
|
|
\&\fICRYPTO_secure_malloc_initialized()\fR indicates whether or not the secure
|
|
heap as been initialized and is available.
|
|
.PP
|
|
\&\fICRYPTO_secure_malloc_done()\fR releases the heap and makes the memory unavailable
|
|
to the process if all secure memory has been freed.
|
|
It can take noticeably long to complete.
|
|
.PP
|
|
\&\fIOPENSSL_secure_malloc()\fR allocates \f(CW\*(C`num\*(C'\fR bytes from the heap.
|
|
If \fICRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
|
|
calling \fIOPENSSL_malloc()\fR.
|
|
It is a macro that expands to
|
|
\&\fICRYPTO_secure_malloc()\fR and adds the \f(CW\*(C`_\|_FILE_\|_\*(C'\fR and \f(CW\*(C`_\|_LINE_\|_\*(C'\fR parameters.
|
|
.PP
|
|
\&\fIOPENSSL_secure_zalloc()\fR and \fICRYPTO_secure_zalloc()\fR are like
|
|
\&\fIOPENSSL_secure_malloc()\fR and \fICRYPTO_secure_malloc()\fR, respectively,
|
|
except that they call \fImemset()\fR to zero the memory before returning.
|
|
.PP
|
|
\&\fIOPENSSL_secure_free()\fR releases the memory at \f(CW\*(C`ptr\*(C'\fR back to the heap.
|
|
It must be called with a value previously obtained from
|
|
\&\fIOPENSSL_secure_malloc()\fR.
|
|
If \fICRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
|
|
calling \fIOPENSSL_free()\fR.
|
|
It exists for consistency with \fIOPENSSL_secure_malloc()\fR , and
|
|
is a macro that expands to \fICRYPTO_secure_free()\fR and adds the \f(CW\*(C`_\|_FILE_\|_\*(C'\fR
|
|
and \f(CW\*(C`_\|_LINE_\|_\*(C'\fR parameters..
|
|
.PP
|
|
\&\fIOPENSSL_secure_clear_free()\fR is similar to \fIOPENSSL_secure_free()\fR except
|
|
that it has an additional \f(CW\*(C`num\*(C'\fR parameter which is used to clear
|
|
the memory if it was not allocated from the secure heap.
|
|
If \fICRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
|
|
calling \fIOPENSSL_clear_free()\fR.
|
|
.PP
|
|
\&\fIOPENSSL_secure_actual_size()\fR tells the actual size allocated to the
|
|
pointer; implementations may allocate more space than initially
|
|
requested, in order to \*(L"round up\*(R" and reduce secure heap fragmentation.
|
|
.PP
|
|
\&\fIOPENSSL_secure_allocated()\fR tells if a pointer is allocated in the secure heap.
|
|
.PP
|
|
\&\fICRYPTO_secure_used()\fR returns the number of bytes allocated in the
|
|
secure heap.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fICRYPTO_secure_malloc_init()\fR returns 0 on failure, 1 if successful,
|
|
and 2 if successful but the heap could not be protected by memory
|
|
mapping.
|
|
.PP
|
|
\&\fICRYPTO_secure_malloc_initialized()\fR returns 1 if the secure heap is
|
|
available (that is, if \fICRYPTO_secure_malloc_init()\fR has been called,
|
|
but \fICRYPTO_secure_malloc_done()\fR has not been called or failed) or 0 if not.
|
|
.PP
|
|
\&\fIOPENSSL_secure_malloc()\fR and \fIOPENSSL_secure_zalloc()\fR return a pointer into
|
|
the secure heap of the requested size, or \f(CW\*(C`NULL\*(C'\fR if memory could not be
|
|
allocated.
|
|
.PP
|
|
\&\fICRYPTO_secure_allocated()\fR returns 1 if the pointer is in the secure heap, or 0 if not.
|
|
.PP
|
|
\&\fICRYPTO_secure_malloc_done()\fR returns 1 if the secure memory area is released, or 0 if not.
|
|
.PP
|
|
\&\fIOPENSSL_secure_free()\fR and \fIOPENSSL_secure_clear_free()\fR return no values.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIOPENSSL_malloc\fR\|(3),
|
|
\&\fIBN_new\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fIOPENSSL_secure_clear_free()\fR function was added in OpenSSL 1.1.0g.
|
|
.PP
|
|
The second argument to \fICRYPTO_secure_malloc_init()\fR was changed from an \fBint\fR to
|
|
a \fBsize_t\fR in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-2016 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>.
|