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