diff options
Diffstat (limited to 'doc/crypto/OPENSSL_secure_malloc.pod')
-rw-r--r-- | doc/crypto/OPENSSL_secure_malloc.pod | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/doc/crypto/OPENSSL_secure_malloc.pod b/doc/crypto/OPENSSL_secure_malloc.pod index 588c4b15f9..5e221e90b4 100644 --- a/doc/crypto/OPENSSL_secure_malloc.pod +++ b/doc/crypto/OPENSSL_secure_malloc.pod @@ -2,7 +2,8 @@ =head1 NAME -CRYPTO_secure_malloc_init, CRYPTO_secure_malloc_done, OPENSSL_secure_malloc, OPENSSL_secure_free, OPENSSL_secure_allocated - use secure heap storage +CRYPTO_secure_malloc_init, CRYPTO_secure_malloc_done, OPENSSL_secure_malloc, +OPENSSL_secure_free, OPENSSL_secure_allocated - secure heap storage =head1 SYNOPSIS @@ -15,10 +16,15 @@ CRYPTO_secure_malloc_init, CRYPTO_secure_malloc_done, OPENSSL_secure_malloc, OPE 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); - int OPENSSL_secure_allocated(const 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 @@ -49,15 +55,25 @@ 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 @@ -78,9 +94,15 @@ 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)> +L<bn_internal(3)>. =cut |