secure/lib/libcrypto/man/OPENSSL_secure_malloc.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "OPENSSL_SECURE_MALLOC 3"
 132 .TH OPENSSL_SECURE_MALLOC 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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_used \- secure heap storage
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/crypto.h>
 143 \&
 144 \& int CRYPTO_secure_malloc_init(size_t size, int minsize);
 145 \&
 146 \& int CRYPTO_secure_malloc_initialized();
 147 \&
 148 \& int CRYPTO_secure_malloc_done();
 149 \&
 150 \& void *OPENSSL_secure_malloc(size_t num);
 151 \& void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
 152 \&
 153 \& void *OPENSSL_secure_zalloc(size_t num);
 154 \& void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
 155 \&
 156 \& void OPENSSL_secure_free(void* ptr);
 157 \& void CRYPTO_secure_free(void *ptr, const char *, int);
 158 \&
 159 \& void OPENSSL_secure_clear_free(void* ptr, size_t num);
 160 \& void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *, int);
 161 \&
 162 \& size_t OPENSSL_secure_actual_size(const void *ptr);
 163 \&
 164 \& size_t CRYPTO_secure_used();
 165 .Ve
 166 .SH "DESCRIPTION"
 167 .IX Header "DESCRIPTION"
 168 In order to help protect applications (particularly long-running servers)
 169 from pointer overruns or underruns that could return arbitrary data from
 170 the program's dynamic memory area, where keys and other sensitive
 171 information might be stored, OpenSSL supports the concept of a \*(L"secure heap.\*(R"
 172 The level and type of security guarantees depend on the operating system.
 173 It is a good idea to review the code and see if it addresses your
 174 threat model and concerns.
 175 .PP
 176 If a secure heap is used, then private key \fB\s-1BIGNUM\s0\fR values are stored there.
 177 This protects long-term storage of private keys, but will not necessarily
 178 put all intermediate values and computations there.
 179 .PP
 180 \&\fICRYPTO_secure_malloc_init()\fR creates the secure heap, with the specified
 181 \&\f(CW\*(C`size\*(C'\fR in bytes. The \f(CW\*(C`minsize\*(C'\fR parameter is the minimum size to
 182 allocate from the heap. Both \f(CW\*(C`size\*(C'\fR and \f(CW\*(C`minsize\*(C'\fR must be a power
 183 of two.
 184 .PP
 185 \&\fICRYPTO_secure_malloc_initialized()\fR indicates whether or not the secure
 186 heap as been initialized and is available.
 187 .PP
 188 \&\fICRYPTO_secure_malloc_done()\fR releases the heap and makes the memory unavailable
 189 to the process if all secure memory has been freed.
 190 It can take noticeably long to complete.
 191 .PP
 192 \&\fIOPENSSL_secure_malloc()\fR allocates \f(CW\*(C`num\*(C'\fR bytes from the heap.
 193 If \fICRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
 194 calling \fIOPENSSL_malloc()\fR.
 195 It is a macro that expands to
 196 \&\fICRYPTO_secure_malloc()\fR and adds the \f(CW\*(C`_\|_FILE_\|_\*(C'\fR and \f(CW\*(C`_\|_LINE_\|_\*(C'\fR parameters.
 197 .PP
 198 \&\fIOPENSSL_secure_zalloc()\fR and \fICRYPTO_secure_zalloc()\fR are like
 199 \&\fIOPENSSL_secure_malloc()\fR and \fICRYPTO_secure_malloc()\fR, respectively,
 200 except that they call \fImemset()\fR to zero the memory before returning.
 201 .PP
 202 \&\fIOPENSSL_secure_free()\fR releases the memory at \f(CW\*(C`ptr\*(C'\fR back to the heap.
 203 It must be called with a value previously obtained from
 204 \&\fIOPENSSL_secure_malloc()\fR.
 205 If \fICRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
 206 calling \fIOPENSSL_free()\fR.
 207 It exists for consistency with \fIOPENSSL_secure_malloc()\fR , and
 208 is a macro that expands to \fICRYPTO_secure_free()\fR and adds the \f(CW\*(C`_\|_FILE_\|_\*(C'\fR
 209 and \f(CW\*(C`_\|_LINE_\|_\*(C'\fR parameters..
 210 .PP
 211 \&\fIOPENSSL_secure_clear_free()\fR is similar to \fIOPENSSL_secure_free()\fR except
 212 that it has an additional \f(CW\*(C`num\*(C'\fR parameter which is used to clear
 213 the memory if it was not allocated from the secure heap.
 214 If \fICRYPTO_secure_malloc_init()\fR is not called, this is equivalent to
 215 calling \fIOPENSSL_clear_free()\fR.
 216 .PP
 217 \&\fIOPENSSL_secure_actual_size()\fR tells the actual size allocated to the
 218 pointer; implementations may allocate more space than initially
 219 requested, in order to \*(L"round up\*(R" and reduce secure heap fragmentation.
 220 .PP
 221 \&\fICRYPTO_secure_used()\fR returns the number of bytes allocated in the
 222 secure heap.
 223 .SH "RETURN VALUES"
 224 .IX Header "RETURN VALUES"
 225 \&\fICRYPTO_secure_malloc_init()\fR returns 0 on failure, 1 if successful,
 226 and 2 if successful but the heap could not be protected by memory
 227 mapping.
 228 .PP
 229 \&\fICRYPTO_secure_malloc_initialized()\fR returns 1 if the secure heap is
 230 available (that is, if \fICRYPTO_secure_malloc_init()\fR has been called,
 231 but \fICRYPTO_secure_malloc_done()\fR has not been called or failed) or 0 if not.
 232 .PP
 233 \&\fIOPENSSL_secure_malloc()\fR and \fIOPENSSL_secure_zalloc()\fR return a pointer into
 234 the secure heap of the requested size, or \f(CW\*(C`NULL\*(C'\fR if memory could not be
 235 allocated.
 236 .PP
 237 \&\fICRYPTO_secure_allocated()\fR returns 1 if the pointer is in the secure heap, or 0 if not.
 238 .PP
 239 \&\fICRYPTO_secure_malloc_done()\fR returns 1 if the secure memory area is released, or 0 if not.
 240 .PP
 241 \&\fIOPENSSL_secure_free()\fR and \fIOPENSSL_secure_clear_free()\fR return no values.
 242 .SH "SEE ALSO"
 243 .IX Header "SEE ALSO"
 244 \&\fIOPENSSL_malloc\fR\|(3),
 245 \&\fIBN_new\fR\|(3)
 246 .SH "HISTORY"
 247 .IX Header "HISTORY"
 248 \&\fIOPENSSL_secure_clear_free()\fR was added in OpenSSL 1.1.0g.
 249 .SH "COPYRIGHT"
 250 .IX Header "COPYRIGHT"
 251 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 252 .PP
 253 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 254 this file except in compliance with the License.  You can obtain a copy
 255 in the file \s-1LICENSE\s0 in the source distribution or at
 256 <https://www.openssl.org/source/license.html>.