crypto/openssl/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 #if defined(CRYPTO_MDEBUG) && !defined(OPENSSL_FIPS)
 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
 114 static int  (*push_info_func)(const char *info, const char *file, int line)
 115         = CRYPTO_dbg_push_info;
 116 static int  (*pop_info_func)(void)
 117         = CRYPTO_dbg_pop_info;
 118 static int (*remove_all_info_func)(void)
 119         = CRYPTO_dbg_remove_all_info;
 120
 121 #else
 122 /* applications can use CRYPTO_malloc_debug_init() to select above case
 123  * at run-time */
 124 static void (*malloc_debug_func)(void *,int,const char *,int,int) = NULL;
 125 static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
 126         = NULL;
 127 static void (*free_debug_func)(void *,int) = NULL;
 128 static void (*set_debug_options_func)(long) = NULL;
 129 static long (*get_debug_options_func)(void) = NULL;
 130
 131
 132 static int  (*push_info_func)(const char *info, const char *file, int line)
 133         = NULL;
 134 static int  (*pop_info_func)(void) = NULL;
 135 static int (*remove_all_info_func)(void) = NULL;
 136
 137 #endif
 138
 139
 140 int CRYPTO_set_mem_functions(void *(*m)(size_t), void *(*r)(void *, size_t),
 141         void (*f)(void *))
 142         {
 143         if (!allow_customize)
 144                 return 0;
 145         if ((m == 0) || (r == 0) || (f == 0))
 146                 return 0;
 147         malloc_func=m; malloc_ex_func=default_malloc_ex;
 148         realloc_func=r; realloc_ex_func=default_realloc_ex;
 149         free_func=f;
 150         malloc_locked_func=m; malloc_locked_ex_func=default_malloc_locked_ex;
 151         free_locked_func=f;
 152         return 1;
 153         }
 154
 155 int CRYPTO_set_mem_ex_functions(
 156         void *(*m)(size_t,const char *,int),
 157         void *(*r)(void *, size_t,const char *,int),
 158         void (*f)(void *))
 159         {
 160         if (!allow_customize)
 161                 return 0;
 162         if ((m == 0) || (r == 0) || (f == 0))
 163                 return 0;
 164         malloc_func=0; malloc_ex_func=m;
 165         realloc_func=0; realloc_ex_func=r;
 166         free_func=f;
 167         malloc_locked_func=0; malloc_locked_ex_func=m;
 168         free_locked_func=f;
 169         return 1;
 170         }
 171
 172 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*f)(void *))
 173         {
 174         if (!allow_customize)
 175                 return 0;
 176         if ((m == NULL) || (f == NULL))
 177                 return 0;
 178         malloc_locked_func=m; malloc_locked_ex_func=default_malloc_locked_ex;
 179         free_locked_func=f;
 180         return 1;
 181         }
 182
 183 int CRYPTO_set_locked_mem_ex_functions(
 184         void *(*m)(size_t,const char *,int),
 185         void (*f)(void *))
 186         {
 187         if (!allow_customize)
 188                 return 0;
 189         if ((m == NULL) || (f == NULL))
 190                 return 0;
 191         malloc_locked_func=0; malloc_locked_ex_func=m;
 192         free_func=f;
 193         return 1;
 194         }
 195
 196 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
 197                                    void (*r)(void *,void *,int,const char *,int,int),
 198                                    void (*f)(void *,int),
 199                                    void (*so)(long),
 200                                    long (*go)(void))
 201         {
 202         if (!allow_customize_debug)
 203                 return 0;
 204         malloc_debug_func=m;
 205         realloc_debug_func=r;
 206         free_debug_func=f;
 207         set_debug_options_func=so;
 208         get_debug_options_func=go;
 209         return 1;
 210         }
 211
 212 void CRYPTO_set_mem_info_functions(
 213         int  (*push_info_fn)(const char *info, const char *file, int line),
 214         int  (*pop_info_fn)(void),
 215         int (*remove_all_info_fn)(void))
 216         {
 217         push_info_func = push_info_fn;
 218         pop_info_func = pop_info_fn;
 219         remove_all_info_func = remove_all_info_fn;
 220         }
 221
 222 void CRYPTO_get_mem_functions(void *(**m)(size_t), void *(**r)(void *, size_t),
 223         void (**f)(void *))
 224         {
 225         if (m != NULL) *m = (malloc_ex_func == default_malloc_ex) ?
 226                              malloc_func : 0;
 227         if (r != NULL) *r = (realloc_ex_func == default_realloc_ex) ?
 228                              realloc_func : 0;
 229         if (f != NULL) *f=free_func;
 230         }
 231
 232 void CRYPTO_get_mem_ex_functions(
 233         void *(**m)(size_t,const char *,int),
 234         void *(**r)(void *, size_t,const char *,int),
 235         void (**f)(void *))
 236         {
 237         if (m != NULL) *m = (malloc_ex_func != default_malloc_ex) ?
 238                             malloc_ex_func : 0;
 239         if (r != NULL) *r = (realloc_ex_func != default_realloc_ex) ?
 240                             realloc_ex_func : 0;
 241         if (f != NULL) *f=free_func;
 242         }
 243
 244 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *))
 245         {
 246         if (m != NULL) *m = (malloc_locked_ex_func == default_malloc_locked_ex) ?
 247                              malloc_locked_func : 0;
 248         if (f != NULL) *f=free_locked_func;
 249         }
 250
 251 void CRYPTO_get_locked_mem_ex_functions(
 252         void *(**m)(size_t,const char *,int),
 253         void (**f)(void *))
 254         {
 255         if (m != NULL) *m = (malloc_locked_ex_func != default_malloc_locked_ex) ?
 256                             malloc_locked_ex_func : 0;
 257         if (f != NULL) *f=free_locked_func;
 258         }
 259
 260 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
 261                                     void (**r)(void *,void *,int,const char *,int,int),
 262                                     void (**f)(void *,int),
 263                                     void (**so)(long),
 264                                     long (**go)(void))
 265         {
 266         if (m != NULL) *m=malloc_debug_func;
 267         if (r != NULL) *r=realloc_debug_func;
 268         if (f != NULL) *f=free_debug_func;
 269         if (so != NULL) *so=set_debug_options_func;
 270         if (go != NULL) *go=get_debug_options_func;
 271         }
 272
 273
 274 void *CRYPTO_malloc_locked(int num, const char *file, int line)
 275         {
 276         void *ret = NULL;
 277         extern unsigned char cleanse_ctr;
 278
 279         if (num <= 0) return NULL;
 280
 281         allow_customize = 0;
 282         if (malloc_debug_func != NULL)
 283                 {
 284                 allow_customize_debug = 0;
 285                 malloc_debug_func(NULL, num, file, line, 0);
 286                 }
 287         ret = malloc_locked_ex_func(num,file,line);
 288 #ifdef LEVITTE_DEBUG_MEM
 289         fprintf(stderr, "LEVITTE_DEBUG_MEM:         > 0x%p (%d)\n", ret, num);
 290 #endif
 291         if (malloc_debug_func != NULL)
 292                 malloc_debug_func(ret, num, file, line, 1);
 293
 294         /* Create a dependency on the value of 'cleanse_ctr' so our memory
 295          * sanitisation function can't be optimised out. NB: We only do
 296          * this for >2Kb so the overhead doesn't bother us. */
 297         if(ret && (num > 2048))
 298                 ((unsigned char *)ret)[0] = cleanse_ctr;
 299
 300         return ret;
 301         }
 302
 303 void CRYPTO_free_locked(void *str)
 304         {
 305         if (free_debug_func != NULL)
 306                 free_debug_func(str, 0);
 307 #ifdef LEVITTE_DEBUG_MEM
 308         fprintf(stderr, "LEVITTE_DEBUG_MEM:         < 0x%p\n", str);
 309 #endif
 310         free_locked_func(str);
 311         if (free_debug_func != NULL)
 312                 free_debug_func(NULL, 1);
 313         }
 314
 315 void *CRYPTO_malloc(int num, const char *file, int line)
 316         {
 317         void *ret = NULL;
 318         extern unsigned char cleanse_ctr;
 319
 320         if (num <= 0) return NULL;
 321
 322         allow_customize = 0;
 323         if (malloc_debug_func != NULL)
 324                 {
 325                 allow_customize_debug = 0;
 326                 malloc_debug_func(NULL, num, file, line, 0);
 327                 }
 328         ret = malloc_ex_func(num,file,line);
 329 #ifdef LEVITTE_DEBUG_MEM
 330         fprintf(stderr, "LEVITTE_DEBUG_MEM:         > 0x%p (%d)\n", ret, num);
 331 #endif
 332         if (malloc_debug_func != NULL)
 333                 malloc_debug_func(ret, num, file, line, 1);
 334
 335         /* Create a dependency on the value of 'cleanse_ctr' so our memory
 336          * sanitisation function can't be optimised out. NB: We only do
 337          * this for >2Kb so the overhead doesn't bother us. */
 338         if(ret && (num > 2048))
 339                 ((unsigned char *)ret)[0] = cleanse_ctr;
 340
 341         return ret;
 342         }
 343
 344 void *CRYPTO_realloc(void *str, int num, const char *file, int line)
 345         {
 346         void *ret = NULL;
 347
 348         if (str == NULL)
 349                 return CRYPTO_malloc(num, file, line);
 350
 351         if (num <= 0) return NULL;
 352
 353         if (realloc_debug_func != NULL)
 354                 realloc_debug_func(str, NULL, num, file, line, 0);
 355         ret = realloc_ex_func(str,num,file,line);
 356 #ifdef LEVITTE_DEBUG_MEM
 357         fprintf(stderr, "LEVITTE_DEBUG_MEM:         | 0x%p -> 0x%p (%d)\n", str, ret, num);
 358 #endif
 359         if (realloc_debug_func != NULL)
 360                 realloc_debug_func(str, ret, num, file, line, 1);
 361
 362         return ret;
 363         }
 364
 365 void *CRYPTO_realloc_clean(void *str, int old_len, int num, const char *file,
 366                            int line)
 367         {
 368         void *ret = NULL;
 369
 370         if (str == NULL)
 371                 return CRYPTO_malloc(num, file, line);
 372
 373         if (num <= 0) return NULL;
 374
 375         if (realloc_debug_func != NULL)
 376                 realloc_debug_func(str, NULL, num, file, line, 0);
 377         ret=malloc_ex_func(num,file,line);
 378         if(ret)
 379                 {
 380                 memcpy(ret,str,old_len);
 381                 OPENSSL_cleanse(str,old_len);
 382                 free_func(str);
 383                 }
 384 #ifdef LEVITTE_DEBUG_MEM
 385         fprintf(stderr,
 386                 "LEVITTE_DEBUG_MEM:         | 0x%p -> 0x%p (%d)\n",
 387                 str, ret, num);
 388 #endif
 389         if (realloc_debug_func != NULL)
 390                 realloc_debug_func(str, ret, num, file, line, 1);
 391
 392         return ret;
 393         }
 394
 395 void CRYPTO_free(void *str)
 396         {
 397         if (free_debug_func != NULL)
 398                 free_debug_func(str, 0);
 399 #ifdef LEVITTE_DEBUG_MEM
 400         fprintf(stderr, "LEVITTE_DEBUG_MEM:         < 0x%p\n", str);
 401 #endif
 402         free_func(str);
 403         if (free_debug_func != NULL)
 404                 free_debug_func(NULL, 1);
 405         }
 406
 407 void *CRYPTO_remalloc(void *a, int num, const char *file, int line)
 408         {
 409         if (a != NULL) OPENSSL_free(a);
 410         a=(char *)OPENSSL_malloc(num);
 411         return(a);
 412         }
 413
 414 void CRYPTO_set_mem_debug_options(long bits)
 415         {
 416         if (set_debug_options_func != NULL)
 417                 set_debug_options_func(bits);
 418         }
 419
 420 long CRYPTO_get_mem_debug_options(void)
 421         {
 422         if (get_debug_options_func != NULL)
 423                 return get_debug_options_func();
 424         return 0;
 425         }
 426
 427 int CRYPTO_push_info_(const char *info, const char *file, int line)
 428         {
 429         if (push_info_func)
 430                 return push_info_func(info, file, line);
 431         return 1;
 432         }
 433
 434 int CRYPTO_pop_info(void)
 435         {
 436         if (pop_info_func)
 437                 return pop_info_func();
 438         return 1;
 439         }
 440
 441 int CRYPTO_remove_all_info(void)
 442         {
 443         if (remove_all_info_func)
 444                 return remove_all_info_func();
 445         return 1;
 446         }