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 CRYPTO_strdup, CRYPTO_strndup,
  12 OPENSSL_mem_debug_push, OPENSSL_mem_debug_pop,
  13 CRYPTO_mem_debug_push, CRYPTO_mem_debug_pop,
  14 CRYPTO_clear_realloc, CRYPTO_clear_free,
  15 CRYPTO_get_mem_functions, CRYPTO_set_mem_functions,
  16 CRYPTO_get_alloc_counts,
  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  void *CRYPTO_malloc(size_t num, const char *file, int line)
  43  void *CRYPTO_zalloc(size_t num, const char *file, int line)
  44  void *CRYPTO_realloc(void *p, size_t num, const char *file, int line)
  45  void CRYPTO_free(void *str, const char *, int)
  46  char *CRYPTO_strdup(const char *p, const char *file, int line)
  47  char *CRYPTO_strndup(const char *p, size_t num, const char *file, int line)
  48  void *CRYPTO_clear_realloc(void *p, size_t old_len, size_t num,
  49                             const char *file, int line)
  50  void CRYPTO_clear_free(void *str, size_t num, const char *, int)
  51
  52  void CRYPTO_get_mem_functions(
  53          void *(**m)(size_t, const char *, int),
  54          void *(**r)(void *, size_t, const char *, int),
  55          void (**f)(void *, const char *, int))
  56  int CRYPTO_set_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
  61  void CRYPTO_get_alloc_counts(int *m, int *r, int *f)
  62
  63  env OPENSSL_MALLOC_FAILURES=... <application>
  64  env OPENSSL_MALLOC_FD=... <application>
  65
  66 Deprecated:
  67
  68  int CRYPTO_mem_leaks(BIO *b);
  69  int CRYPTO_mem_leaks_fp(FILE *fp);
  70  int CRYPTO_mem_leaks_cb(int (*cb)(const char *str, size_t len, void *u),
  71                          void *u);
  72
  73  int CRYPTO_set_mem_debug(int onoff)
  74  int CRYPTO_mem_ctrl(int mode);
  75  int OPENSSL_mem_debug_push(const char *info)
  76  int OPENSSL_mem_debug_pop(void);
  77  int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
  78  int CRYPTO_mem_debug_pop(void);
  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() does nothing and does not need to be called. It is
  88 included for compatibility with older versions of OpenSSL.
  89
  90 OPENSSL_malloc(), OPENSSL_realloc(), and OPENSSL_free() are like the
  91 C malloc(), realloc(), and free() functions.
  92 OPENSSL_zalloc() calls memset() to zero the memory before returning.
  93
  94 OPENSSL_clear_realloc() and OPENSSL_clear_free() should be used
  95 when the buffer at B<addr> holds sensitive information.
  96 The old buffer is filled with zero's by calling OPENSSL_cleanse()
  97 before ultimately calling OPENSSL_free().
  98
  99 OPENSSL_cleanse() fills B<ptr> of size B<len> with a string of 0's.
 100 Use OPENSSL_cleanse() with care if the memory is a mapping of a file.
 101 If the storage controller uses write compression, then its possible
 102 that sensitive tail bytes will survive zeroization because the block of
 103 zeros will be compressed. If the storage controller uses wear leveling,
 104 then the old sensitive data will not be overwritten; rather, a block of
 105 0's will be written at a new physical location.
 106
 107 OPENSSL_strdup(), OPENSSL_strndup() and OPENSSL_memdup() are like the
 108 equivalent C functions, except that memory is allocated by calling the
 109 OPENSSL_malloc() and should be released by calling OPENSSL_free().
 110
 111 OPENSSL_strlcpy(),
 112 OPENSSL_strlcat() and OPENSSL_strnlen() are equivalents of the common C
 113 library functions and are provided for portability.
 114
 115 If no allocations have been done, it is possible to "swap out" the default
 116 implementations for OPENSSL_malloc(), OPENSSL_realloc() and OPENSSL_free()
 117 and replace them with alternate versions.
 118 CRYPTO_get_mem_functions() function fills in the given arguments with the
 119 function pointers for the current implementations.
 120 With CRYPTO_set_mem_functions(), you can specify a different set of functions.
 121 If any of B<m>, B<r>, or B<f> are NULL, then the function is not changed.
 122 While it's permitted to swap out only a few and not all the functions
 123 with CRYPTO_set_mem_functions(), it's recommended to swap them all out
 124 at once.
 125
 126 If the library is built with the C<crypto-mdebug> option, then one
 127 function, CRYPTO_get_alloc_counts(), and two additional environment
 128 variables, B<OPENSSL_MALLOC_FAILURES> and B<OPENSSL_MALLOC_FD>,
 129 are available.
 130
 131 The function CRYPTO_get_alloc_counts() fills in the number of times
 132 each of CRYPTO_malloc(), CRYPTO_realloc(), and CRYPTO_free() have been
 133 called, into the values pointed to by B<mcount>, B<rcount>, and B<fcount>,
 134 respectively.  If a pointer is NULL, then the corresponding count is not stored.
 135
 136 The variable
 137 B<OPENSSL_MALLOC_FAILURES> controls how often allocations should fail.
 138 It is a set of fields separated by semicolons, which each field is a count
 139 (defaulting to zero) and an optional atsign and percentage (defaulting
 140 to 100).  If the count is zero, then it lasts forever.  For example,
 141 C<100;@25> or C<100@0;0@25> means the first 100 allocations pass, then all
 142 other allocations (until the program exits or crashes) have a 25% chance of
 143 failing.
 144
 145 If the variable B<OPENSSL_MALLOC_FD> is parsed as a positive integer, then
 146 it is taken as an open file descriptor, and a record of all allocations is
 147 written to that descriptor.  If an allocation will fail, and the platform
 148 supports it, then a backtrace will be written to the descriptor.  This can
 149 be useful because a malloc may fail but not be checked, and problems will
 150 only occur later.  The following example in classic shell syntax shows how
 151 to use this (will not work on all platforms):
 152
 153   OPENSSL_MALLOC_FAILURES='200;@10'
 154   export OPENSSL_MALLOC_FAILURES
 155   OPENSSL_MALLOC_FD=3
 156   export OPENSSL_MALLOC_FD
 157   ...app invocation... 3>/tmp/log$$
 158
 159 =head1 RETURN VALUES
 160
 161 OPENSSL_malloc_init(), OPENSSL_free(), OPENSSL_clear_free()
 162 CRYPTO_free(), CRYPTO_clear_free() and CRYPTO_get_mem_functions()
 163 return no value.
 164
 165 OPENSSL_malloc(), OPENSSL_zalloc(), OPENSSL_realloc(),
 166 OPENSSL_clear_realloc(),
 167 CRYPTO_malloc(), CRYPTO_zalloc(), CRYPTO_realloc(),
 168 CRYPTO_clear_realloc(),
 169 OPENSSL_strdup(), and OPENSSL_strndup()
 170 return a pointer to allocated memory or NULL on error.
 171
 172 CRYPTO_set_mem_functions() returns 1 on success or 0 on failure (almost
 173 always because allocations have already happened).
 174
 175 CRYPTO_mem_leaks(), CRYPTO_mem_leaks_fp(), CRYPTO_mem_leaks_cb(),
 176 CRYPTO_set_mem_debug(), and CRYPTO_mem_ctrl() are deprecated and return -1.
 177 OPENSSL_mem_debug_push(), OPENSSL_mem_debug_pop(),
 178 CRYPTO_mem_debug_push(), and CRYPTO_mem_debug_pop()
 179 are deprecated and return 0.
 180
 181 =head1 HISTORY
 182
 183 OPENSSL_mem_debug_push(), OPENSSL_mem_debug_pop(),
 184 CRYPTO_mem_debug_push(), CRYPTO_mem_debug_pop(),
 185 CRYPTO_mem_leaks(), CRYPTO_mem_leaks_fp(),
 186 CRYPTO_mem_leaks_cb(), CRYPTO_set_mem_debug(), CRYPTO_mem_ctrl()
 187 were deprecated in OpenSSL 3.0.
 188 The memory-leak checking has been deprecated in OpenSSL 3.0 in favor of
 189 clang's memory and leak sanitizer.
 190
 191
 192 =head1 COPYRIGHT
 193
 194 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
 195
 196 Licensed under the Apache License 2.0 (the "License").  You may not use
 197 this file except in compliance with the License.  You can obtain a copy
 198 in the file LICENSE in the source distribution or at
 199 L<https://www.openssl.org/source/license.html>.
 200
 201 =cut