doc/man3/OPENSSL_malloc.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OPENSSL_malloc_init,
   6 OPENSSL_malloc, OPENSSL_zalloc, OPENSSL_realloc, OPENSSL_free,
   7 OPENSSL_clear_realloc, OPENSSL_clear_free, OPENSSL_cleanse,
   8 CRYPTO_malloc, CRYPTO_zalloc, CRYPTO_realloc, CRYPTO_free,
   9 OPENSSL_strdup, OPENSSL_strndup,
  10 OPENSSL_memdup, OPENSSL_strlcpy, OPENSSL_strlcat,
  11 OPENSSL_hexstr2buf, OPENSSL_buf2hexstr, OPENSSL_hexchar2int,
  12 CRYPTO_strdup, CRYPTO_strndup,
  13 OPENSSL_mem_debug_push, OPENSSL_mem_debug_pop,
  14 CRYPTO_mem_debug_push, CRYPTO_mem_debug_pop,
  15 CRYPTO_clear_realloc, CRYPTO_clear_free,
  16 CRYPTO_get_mem_functions, CRYPTO_set_mem_functions,
  17 CRYPTO_set_mem_debug, CRYPTO_mem_ctrl,
  18 CRYPTO_mem_leaks, CRYPTO_mem_leaks_fp
  19 OPENSSL_MALLOC_FAILURES,
  20 OPENSSL_MALLOC_FD
  21 - Memory allocation functions
  22
  23 =head1 SYNOPSIS
  24
  25  #include <openssl/crypto.h>
  26
  27  int OPENSSL_malloc_init(void)
  28
  29  void *OPENSSL_malloc(size_t num)
  30  void *OPENSSL_zalloc(size_t num)
  31  void *OPENSSL_realloc(void *addr, size_t num)
  32  void OPENSSL_free(void *addr)
  33  char *OPENSSL_strdup(const char *str)
  34  char *OPENSSL_strndup(const char *str, size_t s)
  35  size_t OPENSSL_strlcat(char *dst, const char *src, size_t size);
  36  size_t OPENSSL_strlcpy(char *dst, const char *src, size_t size);
  37  void *OPENSSL_memdup(void *data, size_t s)
  38  void *OPENSSL_clear_realloc(void *p, size_t old_len, size_t num)
  39  void OPENSSL_clear_free(void *str, size_t num)
  40  void OPENSSL_cleanse(void *ptr, size_t len);
  41
  42  unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
  43  char *OPENSSL_buf2hexstr(const unsigned char *buffer, long len);
  44  int OPENSSL_hexchar2int(unsigned char c);
  45
  46  void *CRYPTO_malloc(size_t num, const char *file, int line)
  47  void *CRYPTO_zalloc(size_t num, const char *file, int line)
  48  void *CRYPTO_realloc(void *p, size_t num, const char *file, int line)
  49  void CRYPTO_free(void *str, const char *, int)
  50  char *CRYPTO_strdup(const char *p, const char *file, int line)
  51  char *CRYPTO_strndup(const char *p, size_t num, const char *file, int line)
  52  void *CRYPTO_clear_realloc(void *p, size_t old_len, size_t num, const char *file, int line)
  53  void CRYPTO_clear_free(void *str, size_t num, const char *, int)
  54
  55  void CRYPTO_get_mem_functions(
  56          void *(**m)(size_t, const char *, int),
  57          void *(**r)(void *, size_t, const char *, int),
  58          void (**f)(void *, const char *, int))
  59  int CRYPTO_set_mem_functions(
  60          void *(*m)(size_t, const char *, int),
  61          void *(*r)(void *, size_t, const char *, int),
  62          void (*f)(void *, const char *, int))
  63
  64  int CRYPTO_set_mem_debug(int onoff)
  65
  66  env OPENSSL_MALLOC_FAILURES=... <application>
  67  env OPENSSL_MALLOC_FD=... <application>
  68
  69  int CRYPTO_mem_ctrl(int mode);
  70
  71  int OPENSSL_mem_debug_push(const char *info)
  72  int OPENSSL_mem_debug_pop(void);
  73
  74  int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
  75  int CRYPTO_mem_debug_pop(void);
  76
  77  void CRYPTO_mem_leaks(BIO *b);
  78  void CRYPTO_mem_leaks_fp(FILE *fp);
  79
  80 =head1 DESCRIPTION
  81
  82 OpenSSL memory allocation is handled by the B<OPENSSL_xxx> API. These are
  83 generally macro's that add the standard C B<__FILE__> and B<__LINE__>
  84 parameters and call a lower-level B<CRYPTO_xxx> API.
  85 Some functions do not add those parameters, but exist for consistency.
  86
  87 OPENSSL_malloc_init() sets the lower-level memory allocation functions
  88 to their default implementation.
  89 It is generally not necessary to call this, except perhaps in certain
  90 shared-library situations.
  91
  92 OPENSSL_malloc(), OPENSSL_realloc(), and OPENSSL_free() are like the
  93 C malloc(), realloc(), and free() functions.
  94 OPENSSL_zalloc() calls memset() to zero the memory before returning.
  95
  96 OPENSSL_clear_realloc() and OPENSSL_clear_free() should be used
  97 when the buffer at B<addr> holds sensitive information.
  98 The old buffer is filled with zero's by calling OPENSSL_cleanse()
  99 before ultimately calling OPENSSL_free().
 100
 101 OPENSSL_cleanse() fills B<ptr> of size B<len> with a string of 0's.
 102 Use OPENSSL_cleanse() with care if the memory is a mapping of a file.
 103 If the storage controller uses write compression, then its possible
 104 that sensitive tail bytes will survive zeroization because the block of
 105 zeros will be compressed. If the storage controller uses wear leveling,
 106 then the old sensitive data will not be overwritten; rather, a block of
 107 0's will be written at a new physical location.
 108
 109 OPENSSL_strdup(), OPENSSL_strndup() and OPENSSL_memdup() are like the
 110 equivalent C functions, except that memory is allocated by calling the
 111 OPENSSL_malloc() and should be released by calling OPENSSL_free().
 112
 113 OPENSSL_strlcpy(),
 114 OPENSSL_strlcat() and OPENSSL_strnlen() are equivalents of the common C
 115 library functions and are provided for portability.
 116
 117 OPENSSL_hexstr2buf() parses B<str> as a hex string and returns a
 118 pointer to the parsed value. The memory is allocated by calling
 119 OPENSSL_malloc() and should be released by calling OPENSSL_free().
 120 If B<len> is not NULL, it is filled in with the output length.
 121 Colons between two-character hex "bytes" are ignored.
 122 An odd number of hex digits is an error.
 123
 124 OPENSSL_buf2hexstr() takes the specified buffer and length, and returns
 125 a hex string for value, or NULL on error.
 126 B<Buffer> cannot be NULL; if B<len> is 0 an empty string is returned.
 127
 128 OPENSSL_hexchar2int() converts a character to the hexadecimal equivalent,
 129 or returns -1 on error.
 130
 131 If no allocations have been done, it is possible to "swap out" the default
 132 implementations for OPENSSL_malloc(), OPENSSL_realloc and OPENSSL_free()
 133 and replace them with alternate versions (hooks).
 134 CRYPTO_get_mem_functions() function fills in the given arguments with the
 135 function pointers for the current implementations.
 136 With CRYPTO_set_mem_functions(), you can specify a different set of functions.
 137 If any of B<m>, B<r>, or B<f> are NULL, then the function is not changed.
 138
 139 The default implementation can include some debugging capability (if enabled
 140 at build-time).
 141 This adds some overhead by keeping a list of all memory allocations, and
 142 removes items from the list when they are free'd.
 143 This is most useful for identifying memory leaks.
 144 CRYPTO_set_mem_debug() turns this tracking on and off.  In order to have
 145 any effect, is must be called before any of the allocation functions
 146 (e.g., CRYPTO_malloc()) are called, and is therefore normally one of the
 147 first lines of main() in an application.
 148
 149 If the library is built with the C<crypto-mdebug> option, then two additional
 150 environment variables can be used for testing failure handling.  The variable
 151 B<OPENSSL_MALLOC_FAILURES> controls how often allocations should fail.
 152 It is a set of fields separated by semicolons, which each field is a count
 153 (defaulting to zero) and an optional atsign and percentage (defaulting
 154 to 100).  If the count is zero, then it lasts forever.  For example,
 155 C<100;@25> or C<100@0;0@25> means the first 100 allocations pass, then all
 156 other allocations (until the program exits or crashes) have a 25% chance of
 157 failing.
 158
 159 If the variable B<OPENSSL_MALLOC_FD> is parsed as a positive integer, then
 160 it is taken as an open file descriptor, and a record of all allocations is
 161 written to that descriptor.  If an allocation will fail, and the platform
 162 supports it, then a backtrace will be written to the descriptor.  This can
 163 be useful because a malloc may fail but not be checked, and problems will
 164 only occur later.  The following example in classic shell syntax shows how
 165 to use this (will not work on all platforms):
 166
 167   OPENSSL_MALLOC_FAILURES='200;@10'
 168   export OPENSSL_MALLOC_FAILURES
 169   OPENSSL_MALLOC_FD=3
 170   export OPENSSL_MALLOC_FD
 171   ...app invocation... 3>/tmp/log$$
 172
 173 CRYPTO_mem_ctrl() provides fine-grained control of memory leak tracking.
 174 To enable tracking call CRYPTO_mem_ctrl() with a B<mode> argument of
 175 the B<CRYPTO_MEM_CHECK_ON>.
 176 To disable tracking call CRYPTO_mem_ctrl() with a B<mode> argument of
 177 the B<CRYPTO_MEM_CHECK_OFF>.
 178
 179 While checking memory, it can be useful to store additional context
 180 about what is being done.
 181 For example, identifying the field names when parsing a complicated
 182 data structure.
 183 OPENSSL_mem_debug_push() (which calls CRYPTO_mem_debug_push())
 184 attachs an identifying string to the allocation stack.
 185 This must be a global or other static string; it is not copied.
 186 OPENSSL_mem_debug_pop() removes identifying state from the stack.
 187
 188 At the end of the program, calling CRYPTO_mem_leaks() or
 189 CRYPTO_mem_leaks_fp() will report all "leaked" memory, writing it
 190 to the specified BIO B<b> or FILE B<fp>. These functions return 1 if
 191 there are no leaks, 0 if there are leaks and -1 if an error occurred.
 192
 193 =head1 RETURN VALUES
 194
 195 OPENSSL_malloc_init(), OPENSSL_free(), OPENSSL_clear_free()
 196 CRYPTO_free(), CRYPTO_clear_free() and CRYPTO_get_mem_functions()
 197 return no value.
 198
 199 CRYPTO_mem_leaks() and CRYPTO_mem_leaks_fp() return 1 if there
 200 are no leaks, 0 if there are leaks and -1 if an error occurred.
 201
 202 OPENSSL_malloc(), OPENSSL_zalloc(), OPENSSL_realloc(),
 203 OPENSSL_clear_realloc(),
 204 CRYPTO_malloc(), CRYPTO_zalloc(), CRYPTO_realloc(),
 205 CRYPTO_clear_realloc(),
 206 OPENSSL_buf2hexstr(), OPENSSL_hexstr2buf(),
 207 OPENSSL_strdup(), and OPENSSL_strndup()
 208 return a pointer to allocated memory or NULL on error.
 209
 210 CRYPTO_set_mem_functions() and CRYPTO_set_mem_debug()
 211 return 1 on success or 0 on failure (almost
 212 always because allocations have already happened).
 213
 214 CRYPTO_mem_ctrl() returns -1 if an error occurred, otherwise the
 215 previous value of the mode.
 216
 217 OPENSSL_mem_debug_push() and OPENSSL_mem_debug_pop()
 218 return 1 on success or 0 on failure.
 219
 220 =head1 NOTES
 221
 222 While it's permitted to swap out only a few and not all the functions
 223 with CRYPTO_set_mem_functions(), it's recommended to swap them all out
 224 at once.  I<This applies specially if OpenSSL was built with the
 225 configuration option> C<crypto-mdebug> I<enabled.  In case, swapping out
 226 only, say, the malloc() implementation is outright dangerous.>
 227
 228 =head1 COPYRIGHT
 229
 230 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 231
 232 Licensed under the OpenSSL license (the "License").  You may not use
 233 this file except in compliance with the License.  You can obtain a copy
 234 in the file LICENSE in the source distribution or at
 235 L<https://www.openssl.org/source/license.html>.
 236
 237 =cut