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