secure/lib/libcrypto/man/man3/OPENSSL_secure_malloc.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "OPENSSL_SECURE_MALLOC 3"
 136 .TH OPENSSL_SECURE_MALLOC 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 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
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/crypto.h>
 147 \&
 148 \& int CRYPTO_secure_malloc_init(size_t size, int minsize);
 149 \&
 150 \& int CRYPTO_secure_malloc_initialized();
 151 \&
 152 \& int CRYPTO_secure_malloc_done();
 153 \&
 154 \& void *OPENSSL_secure_malloc(size_t num);
 155 \& void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
 156 \&
 157 \& void *OPENSSL_secure_zalloc(size_t num);
 158 \& void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
 159 \&
 160 \& void OPENSSL_secure_free(void* ptr);
 161 \& void CRYPTO_secure_free(void *ptr, const char *, int);
 162 \&
 163 \& void OPENSSL_secure_clear_free(void* ptr, size_t num);
 164 \& void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *, int);
 165 \&
 166 \& size_t OPENSSL_secure_actual_size(const void *ptr);
 167 \&
 168 \& int CRYPTO_secure_allocated(const void *ptr);
 169 \& size_t CRYPTO_secure_used();
 170 .Ve
 171 .SH "DESCRIPTION"
 172 .IX Header "DESCRIPTION"
 173 In order to help protect applications (particularly long-running servers)
 174 from pointer overruns or underruns that could return arbitrary data from
 175 the program's dynamic memory area, where keys and other sensitive
 176 information might be stored, OpenSSL supports the concept of a \*(L"secure heap.\*(R"
 177 The level and type of security guarantees depend on the operating system.
 178 It is a good idea to review the code and see if it addresses your
 179 threat model and concerns.
 180 .PP
 181 If a secure heap is used, then private key \fB\s-1BIGNUM\s0\fR values are stored there.
 182 This protects long-term storage of private keys, but will not necessarily
 183 put all intermediate values and computations there.
 184 .PP
 185 \&\fBCRYPTO_secure_malloc_init()\fR creates the secure heap, with the specified
 186 \&\f(CW\*(C`size\*(C'\fR in bytes. The \f(CW\*(C`minsize\*(C'\fR parameter is the minimum size to
 187 allocate from the heap. Both \f(CW\*(C`size\*(C'\fR and \f(CW\*(C`minsize\*(C'\fR must be a power
 188 of two.
 189 .PP
 190 \&\fBCRYPTO_secure_malloc_initialized()\fR indicates whether or not the secure
 191 heap as been initialized and is available.
 192 .PP
 193 \&\fBCRYPTO_secure_malloc_done()\fR releases the heap and makes the memory unavailable
 194 to the process if all secure memory has been freed.
 195 It can take noticeably long to complete.
 196 .PP
 197 \&\fBOPENSSL_secure_malloc()\fR allocates \f(CW\*(C`num\*(C'\fR bytes from the heap.
 198 If \fBCRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
 199 calling \fBOPENSSL_malloc()\fR.
 200 It is a macro that expands to
 201 \&\fBCRYPTO_secure_malloc()\fR and adds the \f(CW\*(C`_\|_FILE_\|_\*(C'\fR and \f(CW\*(C`_\|_LINE_\|_\*(C'\fR parameters.
 202 .PP
 203 \&\fBOPENSSL_secure_zalloc()\fR and \fBCRYPTO_secure_zalloc()\fR are like
 204 \&\fBOPENSSL_secure_malloc()\fR and \fBCRYPTO_secure_malloc()\fR, respectively,
 205 except that they call \fBmemset()\fR to zero the memory before returning.
 206 .PP
 207 \&\fBOPENSSL_secure_free()\fR releases the memory at \f(CW\*(C`ptr\*(C'\fR back to the heap.
 208 It must be called with a value previously obtained from
 209 \&\fBOPENSSL_secure_malloc()\fR.
 210 If \fBCRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
 211 calling \fBOPENSSL_free()\fR.
 212 It exists for consistency with \fBOPENSSL_secure_malloc()\fR , and
 213 is a macro that expands to \fBCRYPTO_secure_free()\fR and adds the \f(CW\*(C`_\|_FILE_\|_\*(C'\fR
 214 and \f(CW\*(C`_\|_LINE_\|_\*(C'\fR parameters..
 215 .PP
 216 \&\fBOPENSSL_secure_clear_free()\fR is similar to \fBOPENSSL_secure_free()\fR except
 217 that it has an additional \f(CW\*(C`num\*(C'\fR parameter which is used to clear
 218 the memory if it was not allocated from the secure heap.
 219 If \fBCRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
 220 calling \fBOPENSSL_clear_free()\fR.
 221 .PP
 222 \&\fBOPENSSL_secure_actual_size()\fR tells the actual size allocated to the
 223 pointer; implementations may allocate more space than initially
 224 requested, in order to \*(L"round up\*(R" and reduce secure heap fragmentation.
 225 .PP
 226 \&\fBOPENSSL_secure_allocated()\fR tells if a pointer is allocated in the secure heap.
 227 .PP
 228 \&\fBCRYPTO_secure_used()\fR returns the number of bytes allocated in the
 229 secure heap.
 230 .SH "RETURN VALUES"
 231 .IX Header "RETURN VALUES"
 232 \&\fBCRYPTO_secure_malloc_init()\fR returns 0 on failure, 1 if successful,
 233 and 2 if successful but the heap could not be protected by memory
 234 mapping.
 235 .PP
 236 \&\fBCRYPTO_secure_malloc_initialized()\fR returns 1 if the secure heap is
 237 available (that is, if \fBCRYPTO_secure_malloc_init()\fR has been called,
 238 but \fBCRYPTO_secure_malloc_done()\fR has not been called or failed) or 0 if not.
 239 .PP
 240 \&\fBOPENSSL_secure_malloc()\fR and \fBOPENSSL_secure_zalloc()\fR return a pointer into
 241 the secure heap of the requested size, or \f(CW\*(C`NULL\*(C'\fR if memory could not be
 242 allocated.
 243 .PP
 244 \&\fBCRYPTO_secure_allocated()\fR returns 1 if the pointer is in the secure heap, or 0 if not.
 245 .PP
 246 \&\fBCRYPTO_secure_malloc_done()\fR returns 1 if the secure memory area is released, or 0 if not.
 247 .PP
 248 \&\fBOPENSSL_secure_free()\fR and \fBOPENSSL_secure_clear_free()\fR return no values.
 249 .SH "SEE ALSO"
 250 .IX Header "SEE ALSO"
 251 \&\fBOPENSSL_malloc\fR\|(3),
 252 \&\fBBN_new\fR\|(3)
 253 .SH "HISTORY"
 254 .IX Header "HISTORY"
 255 The \fBOPENSSL_secure_clear_free()\fR function was added in OpenSSL 1.1.0g.
 256 .SH "COPYRIGHT"
 257 .IX Header "COPYRIGHT"
 258 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 259 .PP
 260 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 261 this file except in compliance with the License.  You can obtain a copy
 262 in the file \s-1LICENSE\s0 in the source distribution or at
 263 <https://www.openssl.org/source/license.html>.