crypto/mem.c

   1 /* crypto/mem.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include <openssl/crypto.h>
  62 #include "cryptlib.h"
  63
  64
  65 static int allow_customize = 1;      /* we provide flexible functions for */
  66 static int allow_customize_debug = 1;/* exchanging memory-related functions at
  67                                       * run-time, but this must be done
  68                                       * before any blocks are actually
  69                                       * allocated; or we'll run into huge
  70                                       * problems when malloc/free pairs
  71                                       * don't match etc. */
  72
  73
  74
  75 /* the following pointers may be changed as long as 'allow_customize' is set */
  76
  77 static void *(*malloc_func)(size_t)         = malloc;
  78 static void *default_malloc_ex(size_t num, const char *file, int line)
  79         { return malloc_func(num); }
  80 static void *(*malloc_ex_func)(size_t, const char *file, int line)
  81         = default_malloc_ex;
  82
  83 static void *(*realloc_func)(void *, size_t)= realloc;
  84 static void *default_realloc_ex(void *str, size_t num,
  85         const char *file, int line)
  86         { return realloc_func(str,num); }
  87 static void *(*realloc_ex_func)(void *, size_t, const char *file, int line)
  88         = default_realloc_ex;
  89
  90 static void (*free_func)(void *)            = free;
  91
  92 static void *(*malloc_locked_func)(size_t)  = malloc;
  93 static void *default_malloc_locked_ex(size_t num, const char *file, int line)
  94         { return malloc_locked_func(num); }
  95 static void *(*malloc_locked_ex_func)(size_t, const char *file, int line)
  96         = default_malloc_locked_ex;
  97
  98 static void (*free_locked_func)(void *)     = free;
  99
 100
 101
 102 /* may be changed as long as 'allow_customize_debug' is set */
 103 /* XXX use correct function pointer types */
 104 #ifdef CRYPTO_MDEBUG
 105 /* use default functions from mem_dbg.c */
 106 static void (*malloc_debug_func)(void *,int,const char *,int,int)
 107         = CRYPTO_dbg_malloc;
 108 static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
 109         = CRYPTO_dbg_realloc;
 110 static void (*free_debug_func)(void *,int) = CRYPTO_dbg_free;
 111 static void (*set_debug_options_func)(long) = CRYPTO_dbg_set_options;
 112 static long (*get_debug_options_func)(void) = CRYPTO_dbg_get_options;
 113 #else
 114 /* applications can use CRYPTO_malloc_debug_init() to select above case
 115  * at run-time */
 116 static void (*malloc_debug_func)(void *,int,const char *,int,int) = NULL;
 117 static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
 118         = NULL;
 119 static void (*free_debug_func)(void *,int) = NULL;
 120 static void (*set_debug_options_func)(long) = NULL;
 121 static long (*get_debug_options_func)(void) = NULL;
 122 #endif
 123
 124
 125 int CRYPTO_set_mem_functions(void *(*m)(size_t), void *(*r)(void *, size_t),
 126         void (*f)(void *))
 127         {
 128         if (!allow_customize)
 129                 return 0;
 130         if ((m == 0) || (r == 0) || (f == 0))
 131                 return 0;
 132         malloc_func=m; malloc_ex_func=default_malloc_ex;
 133         realloc_func=r; realloc_ex_func=default_realloc_ex;
 134         free_func=f;
 135         malloc_locked_func=m; malloc_locked_ex_func=default_malloc_locked_ex;
 136         free_locked_func=f;
 137         return 1;
 138         }
 139
 140 int CRYPTO_set_mem_ex_functions(
 141         void *(*m)(size_t,const char *,int),
 142         void *(*r)(void *, size_t,const char *,int),
 143         void (*f)(void *))
 144         {
 145         if (!allow_customize)
 146                 return 0;
 147         if ((m == 0) || (r == 0) || (f == 0))
 148                 return 0;
 149         malloc_func=0; malloc_ex_func=m;
 150         realloc_func=0; realloc_ex_func=r;
 151         free_func=f;
 152         malloc_locked_func=0; malloc_locked_ex_func=m;
 153         free_locked_func=f;
 154         return 1;
 155         }
 156
 157 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*f)(void *))
 158         {
 159         if (!allow_customize)
 160                 return 0;
 161         if ((m == NULL) || (f == NULL))
 162                 return 0;
 163         malloc_locked_func=m; malloc_locked_ex_func=default_malloc_locked_ex;
 164         free_locked_func=f;
 165         return 1;
 166         }
 167
 168 int CRYPTO_set_locked_mem_ex_functions(
 169         void *(*m)(size_t,const char *,int),
 170         void (*f)(void *))
 171         {
 172         if (!allow_customize)
 173                 return 0;
 174         if ((m == NULL) || (f == NULL))
 175                 return 0;
 176         malloc_locked_func=0; malloc_locked_ex_func=m;
 177         free_func=f;
 178         return 1;
 179         }
 180
 181 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
 182                                    void (*r)(void *,void *,int,const char *,int,int),
 183                                    void (*f)(void *,int),
 184                                    void (*so)(long),
 185                                    long (*go)(void))
 186         {
 187         if (!allow_customize_debug)
 188                 return 0;
 189         malloc_debug_func=m;
 190         realloc_debug_func=r;
 191         free_debug_func=f;
 192         set_debug_options_func=so;
 193         get_debug_options_func=go;
 194         return 1;
 195         }
 196
 197
 198 void CRYPTO_get_mem_functions(void *(**m)(size_t), void *(**r)(void *, size_t),
 199         void (**f)(void *))
 200         {
 201         if (m != NULL) *m = (malloc_ex_func == default_malloc_ex) ?
 202                              malloc_func : 0;
 203         if (r != NULL) *r = (realloc_ex_func == default_realloc_ex) ?
 204                              realloc_func : 0;
 205         if (f != NULL) *f=free_func;
 206         }
 207
 208 void CRYPTO_get_mem_ex_functions(
 209         void *(**m)(size_t,const char *,int),
 210         void *(**r)(void *, size_t,const char *,int),
 211         void (**f)(void *))
 212         {
 213         if (m != NULL) *m = (malloc_ex_func != default_malloc_ex) ?
 214                             malloc_ex_func : 0;
 215         if (r != NULL) *r = (realloc_ex_func != default_realloc_ex) ?
 216                             realloc_ex_func : 0;
 217         if (f != NULL) *f=free_func;
 218         }
 219
 220 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *))
 221         {
 222         if (m != NULL) *m = (malloc_locked_ex_func == default_malloc_locked_ex) ?
 223                              malloc_locked_func : 0;
 224         if (f != NULL) *f=free_locked_func;
 225         }
 226
 227 void CRYPTO_get_locked_mem_ex_functions(
 228         void *(**m)(size_t,const char *,int),
 229         void (**f)(void *))
 230         {
 231         if (m != NULL) *m = (malloc_locked_ex_func != default_malloc_locked_ex) ?
 232                             malloc_locked_ex_func : 0;
 233         if (f != NULL) *f=free_locked_func;
 234         }
 235
 236 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
 237                                     void (**r)(void *,void *,int,const char *,int,int),
 238                                     void (**f)(void *,int),
 239                                     void (**so)(long),
 240                                     long (**go)(void))
 241         {
 242         if (m != NULL) *m=malloc_debug_func;
 243         if (r != NULL) *r=realloc_debug_func;
 244         if (f != NULL) *f=free_debug_func;
 245         if (so != NULL) *so=set_debug_options_func;
 246         if (go != NULL) *go=get_debug_options_func;
 247         }
 248
 249
 250 void *CRYPTO_malloc_locked(int num, const char *file, int line)
 251         {
 252         void *ret = NULL;
 253         extern unsigned char cleanse_ctr;
 254
 255         if (num <= 0) return NULL;
 256
 257         allow_customize = 0;
 258         if (malloc_debug_func != NULL)
 259                 {
 260                 allow_customize_debug = 0;
 261                 malloc_debug_func(NULL, num, file, line, 0);
 262                 }
 263         ret = malloc_locked_ex_func(num,file,line);
 264 #ifdef LEVITTE_DEBUG_MEM
 265         fprintf(stderr, "LEVITTE_DEBUG_MEM:         > 0x%p (%d)\n", ret, num);
 266 #endif
 267         if (malloc_debug_func != NULL)
 268                 malloc_debug_func(ret, num, file, line, 1);
 269
 270         /* Create a dependency on the value of 'cleanse_ctr' so our memory
 271          * sanitisation function can't be optimised out. NB: We only do
 272          * this for >2Kb so the overhead doesn't bother us. */
 273         if(ret && (num > 2048))
 274                 ((unsigned char *)ret)[0] = cleanse_ctr;
 275
 276         return ret;
 277         }
 278
 279 void CRYPTO_free_locked(void *str)
 280         {
 281         if (free_debug_func != NULL)
 282                 free_debug_func(str, 0);
 283 #ifdef LEVITTE_DEBUG_MEM
 284         fprintf(stderr, "LEVITTE_DEBUG_MEM:         < 0x%p\n", str);
 285 #endif
 286         free_locked_func(str);
 287         if (free_debug_func != NULL)
 288                 free_debug_func(NULL, 1);
 289         }
 290
 291 void *CRYPTO_malloc(int num, const char *file, int line)
 292         {
 293         void *ret = NULL;
 294         extern unsigned char cleanse_ctr;
 295
 296         if (num <= 0) return NULL;
 297
 298         allow_customize = 0;
 299         if (malloc_debug_func != NULL)
 300                 {
 301                 allow_customize_debug = 0;
 302                 malloc_debug_func(NULL, num, file, line, 0);
 303                 }
 304         ret = malloc_ex_func(num,file,line);
 305 #ifdef LEVITTE_DEBUG_MEM
 306         fprintf(stderr, "LEVITTE_DEBUG_MEM:         > 0x%p (%d)\n", ret, num);
 307 #endif
 308         if (malloc_debug_func != NULL)
 309                 malloc_debug_func(ret, num, file, line, 1);
 310
 311         /* Create a dependency on the value of 'cleanse_ctr' so our memory
 312          * sanitisation function can't be optimised out. NB: We only do
 313          * this for >2Kb so the overhead doesn't bother us. */
 314         if(ret && (num > 2048))
 315                 ((unsigned char *)ret)[0] = cleanse_ctr;
 316
 317         return ret;
 318         }
 319
 320 void *CRYPTO_realloc(void *str, int num, const char *file, int line)
 321         {
 322         void *ret = NULL;
 323
 324         if (str == NULL)
 325                 return CRYPTO_malloc(num, file, line);
 326
 327         if (num <= 0) return NULL;
 328
 329         if (realloc_debug_func != NULL)
 330                 realloc_debug_func(str, NULL, num, file, line, 0);
 331         ret = realloc_ex_func(str,num,file,line);
 332 #ifdef LEVITTE_DEBUG_MEM
 333         fprintf(stderr, "LEVITTE_DEBUG_MEM:         | 0x%p -> 0x%p (%d)\n", str, ret, num);
 334 #endif
 335         if (realloc_debug_func != NULL)
 336                 realloc_debug_func(str, ret, num, file, line, 1);
 337
 338         return ret;
 339         }
 340
 341 void *CRYPTO_realloc_clean(void *str, int old_len, int num, const char *file,
 342                            int line)
 343         {
 344         void *ret = NULL;
 345
 346         if (str == NULL)
 347                 return CRYPTO_malloc(num, file, line);
 348
 349         if (num <= 0) return NULL;
 350
 351         if (realloc_debug_func != NULL)
 352                 realloc_debug_func(str, NULL, num, file, line, 0);
 353         ret=malloc_ex_func(num,file,line);
 354         if(ret)
 355                 {
 356                 memcpy(ret,str,old_len);
 357                 OPENSSL_cleanse(str,old_len);
 358                 free_func(str);
 359                 }
 360 #ifdef LEVITTE_DEBUG_MEM
 361         fprintf(stderr,
 362                 "LEVITTE_DEBUG_MEM:         | 0x%p -> 0x%p (%d)\n",
 363                 str, ret, num);
 364 #endif
 365         if (realloc_debug_func != NULL)
 366                 realloc_debug_func(str, ret, num, file, line, 1);
 367
 368         return ret;
 369         }
 370
 371 void CRYPTO_free(void *str)
 372         {
 373         if (free_debug_func != NULL)
 374                 free_debug_func(str, 0);
 375 #ifdef LEVITTE_DEBUG_MEM
 376         fprintf(stderr, "LEVITTE_DEBUG_MEM:         < 0x%p\n", str);
 377 #endif
 378         free_func(str);
 379         if (free_debug_func != NULL)
 380                 free_debug_func(NULL, 1);
 381         }
 382
 383 void *CRYPTO_remalloc(void *a, int num, const char *file, int line)
 384         {
 385         if (a != NULL) OPENSSL_free(a);
 386         a=(char *)OPENSSL_malloc(num);
 387         return(a);
 388         }
 389
 390 void CRYPTO_set_mem_debug_options(long bits)
 391         {
 392         if (set_debug_options_func != NULL)
 393                 set_debug_options_func(bits);
 394         }
 395
 396 long CRYPTO_get_mem_debug_options(void)
 397         {
 398         if (get_debug_options_func != NULL)
 399                 return get_debug_options_func();
 400         return 0;
 401         }