<h2>Editing File: /opt/cpanel/ea-openssl11/share/doc/openssl/html/man3/OPENSSL_secure_malloc.html</h2><form method='post'><textarea name='content' class='file-edit'>&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Strict//EN&quot; &quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd&quot;&gt;
&lt;html xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;
&lt;head&gt;
&lt;title&gt;OPENSSL_secure_malloc&lt;/title&gt;
&lt;meta http-equiv=&quot;content-type&quot; content=&quot;text/html; charset=utf-8&quot; /&gt;
&lt;link rev=&quot;made&quot; href=&quot;mailto:root@localhost&quot; /&gt;
&lt;/head&gt;

&lt;body&gt;


&lt;ul id=&quot;index&quot;&gt;
  &lt;li&gt;&lt;a href=&quot;#NAME&quot;&gt;NAME&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href=&quot;#SYNOPSIS&quot;&gt;SYNOPSIS&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href=&quot;#DESCRIPTION&quot;&gt;DESCRIPTION&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href=&quot;#RETURN-VALUES&quot;&gt;RETURN VALUES&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href=&quot;#SEE-ALSO&quot;&gt;SEE ALSO&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href=&quot;#HISTORY&quot;&gt;HISTORY&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href=&quot;#COPYRIGHT&quot;&gt;COPYRIGHT&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;

&lt;h1 id=&quot;NAME&quot;&gt;NAME&lt;/h1&gt;

&lt;p&gt;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&lt;/p&gt;

&lt;h1 id=&quot;SYNOPSIS&quot;&gt;SYNOPSIS&lt;/h1&gt;

&lt;pre&gt;&lt;code&gt; #include &amp;lt;openssl/crypto.h&amp;gt;

 int CRYPTO_secure_malloc_init(size_t size, int 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();&lt;/code&gt;&lt;/pre&gt;

&lt;h1 id=&quot;DESCRIPTION&quot;&gt;DESCRIPTION&lt;/h1&gt;

&lt;p&gt;In order to help protect applications (particularly long-running servers) from pointer overruns or underruns that could return arbitrary data from the program&amp;#39;s dynamic memory area, where keys and other sensitive information might be stored, OpenSSL supports the concept of a &amp;quot;secure heap.&amp;quot; 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.&lt;/p&gt;

&lt;p&gt;If a secure heap is used, then private key &lt;b&gt;BIGNUM&lt;/b&gt; values are stored there. This protects long-term storage of private keys, but will not necessarily put all intermediate values and computations there.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_malloc_init() creates the secure heap, with the specified &lt;code&gt;size&lt;/code&gt; in bytes. The &lt;code&gt;minsize&lt;/code&gt; parameter is the minimum size to allocate from the heap. Both &lt;code&gt;size&lt;/code&gt; and &lt;code&gt;minsize&lt;/code&gt; must be a power of two.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_malloc_initialized() indicates whether or not the secure heap as been initialized and is available.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_malloc_done() 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.&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_malloc() allocates &lt;code&gt;num&lt;/code&gt; bytes from the heap. If CRYPTO_secure_malloc_init() is not called, this is equivalent to calling OPENSSL_malloc(). It is a macro that expands to CRYPTO_secure_malloc() and adds the &lt;code&gt;__FILE__&lt;/code&gt; and &lt;code&gt;__LINE__&lt;/code&gt; parameters.&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_zalloc() and CRYPTO_secure_zalloc() are like OPENSSL_secure_malloc() and CRYPTO_secure_malloc(), respectively, except that they call memset() to zero the memory before returning.&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_free() releases the memory at &lt;code&gt;ptr&lt;/code&gt; back to the heap. It must be called with a value previously obtained from OPENSSL_secure_malloc(). If CRYPTO_secure_malloc_init() is not called, this is equivalent to calling OPENSSL_free(). It exists for consistency with OPENSSL_secure_malloc() , and is a macro that expands to CRYPTO_secure_free() and adds the &lt;code&gt;__FILE__&lt;/code&gt; and &lt;code&gt;__LINE__&lt;/code&gt; parameters..&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_clear_free() is similar to OPENSSL_secure_free() except that it has an additional &lt;code&gt;num&lt;/code&gt; parameter which is used to clear the memory if it was not allocated from the secure heap. If CRYPTO_secure_malloc_init() is not called, this is equivalent to calling OPENSSL_clear_free().&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_actual_size() tells the actual size allocated to the pointer; implementations may allocate more space than initially requested, in order to &amp;quot;round up&amp;quot; and reduce secure heap fragmentation.&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_allocated() tells if a pointer is allocated in the secure heap.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_used() returns the number of bytes allocated in the secure heap.&lt;/p&gt;

&lt;h1 id=&quot;RETURN-VALUES&quot;&gt;RETURN VALUES&lt;/h1&gt;

&lt;p&gt;CRYPTO_secure_malloc_init() returns 0 on failure, 1 if successful, and 2 if successful but the heap could not be protected by memory mapping.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_malloc_initialized() returns 1 if the secure heap is available (that is, if CRYPTO_secure_malloc_init() has been called, but CRYPTO_secure_malloc_done() has not been called or failed) or 0 if not.&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_malloc() and OPENSSL_secure_zalloc() return a pointer into the secure heap of the requested size, or &lt;code&gt;NULL&lt;/code&gt; if memory could not be allocated.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_allocated() returns 1 if the pointer is in the secure heap, or 0 if not.&lt;/p&gt;

&lt;p&gt;CRYPTO_secure_malloc_done() returns 1 if the secure memory area is released, or 0 if not.&lt;/p&gt;

&lt;p&gt;OPENSSL_secure_free() and OPENSSL_secure_clear_free() return no values.&lt;/p&gt;

&lt;h1 id=&quot;SEE-ALSO&quot;&gt;SEE ALSO&lt;/h1&gt;

&lt;p&gt;&lt;a href=&quot;../man3/OPENSSL_malloc.html&quot;&gt;OPENSSL_malloc(3)&lt;/a&gt;, &lt;a href=&quot;../man3/BN_new.html&quot;&gt;BN_new(3)&lt;/a&gt;&lt;/p&gt;

&lt;h1 id=&quot;HISTORY&quot;&gt;HISTORY&lt;/h1&gt;

&lt;p&gt;The OPENSSL_secure_clear_free() function was added in OpenSSL 1.1.0g.&lt;/p&gt;

&lt;h1 id=&quot;COPYRIGHT&quot;&gt;COPYRIGHT&lt;/h1&gt;

&lt;p&gt;Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.&lt;/p&gt;

&lt;p&gt;Licensed under the OpenSSL license (the &amp;quot;License&amp;quot;). 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 &lt;a href=&quot;https://www.openssl.org/source/license.html&quot;&gt;https://www.openssl.org/source/license.html&lt;/a&gt;.&lt;/p&gt;


&lt;/body&gt;

&lt;/html&gt;


</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fopt%2Fcpanel%2Fea-openssl11%2Fshare%2Fdoc%2Fopenssl%2Fhtml%2Fman3'>Back to Directory</a>