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