DOC: Rewrite the section on reporting errors in doc/man3/ERR_put_error.pod

[openssl.git] / doc / man3 / OPENSSL_secure_malloc.pod

diff --git a/doc/man3/OPENSSL_secure_malloc.pod b/doc/man3/OPENSSL_secure_malloc.pod
index feaa12d3a89f010ad19c434347b1e5d6caa621f6..c5d4bb2dbbb8c2c753e34844cbff759e6e515432 100644 (file)
--- a/doc/man3/OPENSSL_secure_malloc.pod
+++ b/doc/man3/OPENSSL_secure_malloc.pod
@@ -7,13 +7,14 @@ 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
 
 =head1 SYNOPSIS
 
  #include <openssl/crypto.h>
 
- int CRYPTO_secure_malloc_init(size_t size, int minsize);
+ int CRYPTO_secure_malloc_init(size_t size, size_t minsize);
 
  int CRYPTO_secure_malloc_initialized();
 
@@ -33,6 +34,7 @@ CRYPTO_secure_used - secure heap storage
 
  size_t OPENSSL_secure_actual_size(const void *ptr);
 
+ int CRYPTO_secure_allocated(const void *ptr);
  size_t CRYPTO_secure_used();
 
 =head1 DESCRIPTION
@@ -51,8 +53,10 @@ put all intermediate values and computations there.
 
 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.
+allocate from the heap or zero to use a reasonable default value.
+Both C<size> and, if specified, C<minsize> must be a power of two and
+C<minsize> should generally be small, for example 16 or 32.
+C<minsize> must be less than a quarter of C<size> in any case.
 
 CRYPTO_secure_malloc_initialized() indicates whether or not the secure
 heap as been initialized and is available.
@@ -90,6 +94,8 @@ 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.
 
+OPENSSL_secure_allocated() tells if a pointer is allocated in the secure heap.
+
 CRYPTO_secure_used() returns the number of bytes allocated in the
 secure heap.
 
@@ -122,9 +128,12 @@ L<BN_new(3)>
 
 The OPENSSL_secure_clear_free() function was added in OpenSSL 1.1.0g.
 
+The second argument to CRYPTO_secure_malloc_init() was changed from an B<int> to
+a B<size_t> in OpenSSL 3.0.
+
 =head1 COPYRIGHT
 
-Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy