Latest update.
This commit is contained in:
+19
-41
@@ -8,7 +8,6 @@ OPENSSL_clear_realloc, OPENSSL_clear_free, OPENSSL_cleanse,
|
||||
CRYPTO_malloc, CRYPTO_zalloc, CRYPTO_realloc, CRYPTO_free,
|
||||
OPENSSL_strdup, OPENSSL_strndup,
|
||||
OPENSSL_memdup, OPENSSL_strlcpy, OPENSSL_strlcat,
|
||||
OPENSSL_hexstr2buf, OPENSSL_buf2hexstr, OPENSSL_hexchar2int,
|
||||
CRYPTO_strdup, CRYPTO_strndup,
|
||||
OPENSSL_mem_debug_push, OPENSSL_mem_debug_pop,
|
||||
CRYPTO_mem_debug_push, CRYPTO_mem_debug_pop,
|
||||
@@ -40,10 +39,6 @@ OPENSSL_MALLOC_FD
|
||||
void OPENSSL_clear_free(void *str, size_t num)
|
||||
void OPENSSL_cleanse(void *ptr, size_t len);
|
||||
|
||||
unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
|
||||
char *OPENSSL_buf2hexstr(const unsigned char *buffer, long len);
|
||||
int OPENSSL_hexchar2int(unsigned char c);
|
||||
|
||||
void *CRYPTO_malloc(size_t num, const char *file, int line)
|
||||
void *CRYPTO_zalloc(size_t num, const char *file, int line)
|
||||
void *CRYPTO_realloc(void *p, size_t num, const char *file, int line)
|
||||
@@ -72,17 +67,18 @@ OPENSSL_MALLOC_FD
|
||||
|
||||
int CRYPTO_mem_ctrl(int mode);
|
||||
|
||||
int OPENSSL_mem_debug_push(const char *info)
|
||||
int OPENSSL_mem_debug_pop(void);
|
||||
|
||||
int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
|
||||
int CRYPTO_mem_debug_pop(void);
|
||||
|
||||
int CRYPTO_mem_leaks(BIO *b);
|
||||
int CRYPTO_mem_leaks_fp(FILE *fp);
|
||||
int CRYPTO_mem_leaks_cb(int (*cb)(const char *str, size_t len, void *u),
|
||||
void *u);
|
||||
|
||||
Deprecated:
|
||||
|
||||
int OPENSSL_mem_debug_push(const char *info)
|
||||
int OPENSSL_mem_debug_pop(void);
|
||||
int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
|
||||
int CRYPTO_mem_debug_pop(void);
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
OpenSSL memory allocation is handled by the B<OPENSSL_xxx> API. These are
|
||||
@@ -118,20 +114,6 @@ OPENSSL_strlcpy(),
|
||||
OPENSSL_strlcat() and OPENSSL_strnlen() are equivalents of the common C
|
||||
library functions and are provided for portability.
|
||||
|
||||
OPENSSL_hexstr2buf() parses B<str> as a hex string and returns a
|
||||
pointer to the parsed value. The memory is allocated by calling
|
||||
OPENSSL_malloc() and should be released by calling OPENSSL_free().
|
||||
If B<len> is not NULL, it is filled in with the output length.
|
||||
Colons between two-character hex "bytes" are ignored.
|
||||
An odd number of hex digits is an error.
|
||||
|
||||
OPENSSL_buf2hexstr() takes the specified buffer and length, and returns
|
||||
a hex string for value, or NULL on error.
|
||||
B<Buffer> cannot be NULL; if B<len> is 0 an empty string is returned.
|
||||
|
||||
OPENSSL_hexchar2int() converts a character to the hexadecimal equivalent,
|
||||
or returns -1 on error.
|
||||
|
||||
If no allocations have been done, it is possible to "swap out" the default
|
||||
implementations for OPENSSL_malloc(), OPENSSL_realloc and OPENSSL_free()
|
||||
and replace them with alternate versions (hooks).
|
||||
@@ -155,15 +137,6 @@ the B<CRYPTO_MEM_CHECK_ON>.
|
||||
To disable tracking call CRYPTO_mem_ctrl() with a B<mode> argument of
|
||||
the B<CRYPTO_MEM_CHECK_OFF>.
|
||||
|
||||
While checking memory, it can be useful to store additional context
|
||||
about what is being done.
|
||||
For example, identifying the field names when parsing a complicated
|
||||
data structure.
|
||||
OPENSSL_mem_debug_push() (which calls CRYPTO_mem_debug_push())
|
||||
attachs an identifying string to the allocation stack.
|
||||
This must be a global or other static string; it is not copied.
|
||||
OPENSSL_mem_debug_pop() removes identifying state from the stack.
|
||||
|
||||
At the end of the program, calling CRYPTO_mem_leaks() or
|
||||
CRYPTO_mem_leaks_fp() will report all "leaked" memory, writing it
|
||||
to the specified BIO B<b> or FILE B<fp>. These functions return 1 if
|
||||
@@ -207,6 +180,9 @@ to use this (will not work on all platforms):
|
||||
export OPENSSL_MALLOC_FD
|
||||
...app invocation... 3>/tmp/log$$
|
||||
|
||||
OPENSSL_mem_debug_push(), OPENSSL_mem_debug_pop(),
|
||||
CRYPTO_mem_debug_push(), and CRYPTO_mem_debug_pop()
|
||||
have been deprecated and replaced with functions that only return zero.
|
||||
|
||||
=head1 RETURN VALUES
|
||||
|
||||
@@ -221,7 +197,6 @@ OPENSSL_malloc(), OPENSSL_zalloc(), OPENSSL_realloc(),
|
||||
OPENSSL_clear_realloc(),
|
||||
CRYPTO_malloc(), CRYPTO_zalloc(), CRYPTO_realloc(),
|
||||
CRYPTO_clear_realloc(),
|
||||
OPENSSL_buf2hexstr(), OPENSSL_hexstr2buf(),
|
||||
OPENSSL_strdup(), and OPENSSL_strndup()
|
||||
return a pointer to allocated memory or NULL on error.
|
||||
|
||||
@@ -232,16 +207,19 @@ always because allocations have already happened).
|
||||
CRYPTO_mem_ctrl() returns -1 if an error occurred, otherwise the
|
||||
previous value of the mode.
|
||||
|
||||
OPENSSL_mem_debug_push() and OPENSSL_mem_debug_pop()
|
||||
return 1 on success or 0 on failure.
|
||||
|
||||
=head1 NOTES
|
||||
|
||||
While it's permitted to swap out only a few and not all the functions
|
||||
with CRYPTO_set_mem_functions(), it's recommended to swap them all out
|
||||
at once. I<This applies specially if OpenSSL was built with the
|
||||
configuration option> C<crypto-mdebug> I<enabled. In case, swapping out
|
||||
only, say, the malloc() implementation is outright dangerous.>
|
||||
at once, especially if OpenSSL was built with the
|
||||
configuration option> C<crypto-mdebug>.
|
||||
|
||||
=head1 HISTORY
|
||||
|
||||
OPENSSL_mem_debug_push(), OPENSSL_mem_debug_pop(),
|
||||
CRYPTO_mem_debug_push(), and CRYPTO_mem_debug_pop()
|
||||
were deprecated in OpenSSL 3.0.
|
||||
|
||||
|
||||
=head1 COPYRIGHT
|
||||
|
||||
|
||||
Reference in New Issue
Block a user