bbd86bf542
Only two macros CRYPTO_MDEBUG and CRYPTO_MDEBUG_ABORT to control this.
If CRYPTO_MDEBUG is not set, #ifdef out the whole debug machinery.
(Thanks to Jakob Bohm for the suggestion!)
Make the "change wrapper functions" be the only paradigm.
Wrote documentation!
Format the 'set func' functions so their paramlists are legible.
Format some multi-line comments.
Remove ability to get/set the "memory debug" functions at runtme.
Remove MemCheck_* and CRYPTO_malloc_debug_init macros.
Add CRYPTO_mem_debug(int flag) function.
Add test/memleaktest.
Rename CRYPTO_malloc_init to OPENSSL_malloc_init; remove needless calls.
Reviewed-by: Richard Levitte <levitte@openssl.org>
109 lines
3.7 KiB
Plaintext
109 lines
3.7 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
CRYPTO_secure_malloc_init, CRYPTO_secure_malloc_done, OPENSSL_secure_malloc,
|
|
OPENSSL_secure_free, OPENSSL_secure_allocated - secure heap storage
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/crypto.h>
|
|
|
|
int CRYPTO_secure_malloc_init(size_t size, int minsize);
|
|
|
|
int CRYPTO_secure_malloc_initialized();
|
|
|
|
void CRYPTO_secure_malloc_done();
|
|
|
|
void *OPENSSL_secure_malloc(int num);
|
|
void *CRYPTO_secure_malloc(int num, const char *file, int line);
|
|
|
|
void OPENSSL_secure_free(void* ptr);
|
|
void CRYPTO_secure_free(void *ptr);
|
|
|
|
size_t OPENSSL_secure_actual_size(const void *ptr);
|
|
int OPENSSL_secure_allocated(const void *ptr);
|
|
|
|
size_t CYRPTO_secure_malloc_used();
|
|
|
|
=head1 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 "secure heap."
|
|
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.
|
|
|
|
If a secure heap is used, then private key B<BIGNUM> values are stored there.
|
|
This protects long-term storage of private keys, but will not necessarily
|
|
put all intermediate values and computations there.
|
|
|
|
B<CRYPTO_secure_malloc_init> creates the secure heap, with the specified
|
|
C<size> in bytes. The C<minsize> parameter is the minimum size to
|
|
allocate from the heap. Both C<size> and C<minsize> must be a power
|
|
of two. It is an error to call this after any B<OPENSSL_secure_malloc>
|
|
calls have been made.
|
|
|
|
B<CRYPTO_secure_malloc_initialized> indicates whether or not the secure
|
|
heap as been initialized and is available.
|
|
|
|
B<CRYPTO_secure_malloc_done> releases the heap and makes the memory unavailable
|
|
to the process. It can take noticeably long to complete.
|
|
|
|
B<OPENSSL_secure_malloc> allocates C<num> bytes from the heap.
|
|
If B<CRYPTO_secure_malloc_init> is not called, this is equivalent to
|
|
calling B<OPENSSL_malloc>.
|
|
It is a macro that expands to
|
|
B<CRYPTO_secure_malloc> and adds the B<__FILE__> and B<__LINE__> parameters.
|
|
|
|
B<OPENSSL_secure_free> releases the memory at C<ptr> back to the heap.
|
|
It must be called with a value previously obtained from
|
|
B<OPENSSL_secure_malloc>.
|
|
If B<CRYPTO_secure_malloc_init> is not called, this is equivalent to
|
|
calling B<OPENSSL_free>.
|
|
It exists for consistency with B<OPENSSL_secure_malloc> , and
|
|
is a macro that expands to B<CRYPTO_secure_free>.
|
|
|
|
B<OPENSSL_secure_allocated> tells whether or not a pointer is within
|
|
the secure heap.
|
|
B<OPENSSL_secure_actual_size> tells the actual size allocated to the
|
|
pointer; implementations may allocate more space than initially
|
|
requested, in order to "round up" and reduce secure heap fragmentation.
|
|
|
|
B<CRYPTO_secure_malloc_used> returns the number of bytes allocated in the
|
|
secure heap.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
B<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.
|
|
|
|
B<CRYPTO_secure_malloc_initialized> returns 1 if the secure heap is
|
|
available (that is, if B<CRYPTO_secure_malloc_init> has been called,
|
|
but B<CRYPTO_secure_malloc_done> has not) or 0 if not.
|
|
|
|
B<OPENSSL_secure_malloc> returns a pointer into the secure heap of
|
|
the requested size, or C<NULL> if memory could not be allocated.
|
|
|
|
B<CRYPTO_secure_allocated> returns 1 if the pointer is in the
|
|
the secure heap, or 0 if not.
|
|
|
|
B<CRYPTO_secure_malloc_done> and B<OPENSSL_secure_free>
|
|
return no values.
|
|
|
|
=head1 BUGS
|
|
|
|
The size parameters should be B<size_t> not B<int> and will be changed
|
|
in a future release.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<OPENSSL_malloc(3)>,
|
|
L<BN_new(3)>,
|
|
L<bn_internal(3)>.
|
|
|
|
=cut
|