Fix CRYPTO_clear_realloc() bug.
[openssl.git] / crypto / mem.c
index 77df8062986bece0afe788c55fc847b7d6956044..9bdd5043a977a4ff6dbc9f9708653c83095e02e8 100644 (file)
@@ -1,25 +1,24 @@
-/* crypto/mem.c */
 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  * All rights reserved.
  *
  * This package is an SSL implementation written
  * by Eric Young (eay@cryptsoft.com).
  * The implementation was written so as to conform with Netscapes SSL.
- * 
+ *
  * This library is free for commercial and non-commercial use as long as
  * the following conditions are aheared to.  The following conditions
  * apply to all code found in this distribution, be it the RC4, RSA,
  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  * included with this distribution is covered by the same copyright terms
  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
- * 
+ *
  * Copyright remains Eric Young's, and as such any Copyright notices in
  * the code are not to be removed.
  * If this package is used in a product, Eric Young should be given attribution
  * as the author of the parts of the library used.
  * This can be in the form of a textual message at program startup or
  * in documentation (online or textual) provided with the package.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *     Eric Young (eay@cryptsoft.com)"
  *    The word 'cryptographic' can be left out if the rouines from the library
  *    being used are not cryptographic related :-).
- * 4. If you include any Windows specific code (or a derivative thereof) from 
+ * 4. If you include any Windows specific code (or a derivative thereof) from
  *    the apps directory (application code) you must include an acknowledgement:
  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -49,7 +48,7 @@
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
- * 
+ *
  * The licence and distribution terms for any publically available version or
  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  * copied and put under another distribution licence
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <limits.h>
 #include <openssl/crypto.h>
-#ifdef CRYPTO_MDEBUG_TIME
-# include <time.h>     
-#endif
-#include <openssl/buffer.h>
-#include <openssl/bio.h>
-#include <openssl/lhash.h>
-#include "cryptlib.h"
+#include "internal/cryptlib.h"
 
-/* #ifdef CRYPTO_MDEBUG */
-/* static int mh_mode=CRYPTO_MEM_CHECK_ON; */
-/* #else */
-static int mh_mode=CRYPTO_MEM_CHECK_OFF;
-/* #endif */
-/* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
- * thinks that certain allocations should not be checked (e.g. the data
- * structures used for memory checking).  It is not suitable as an initial
- * state: the library will unexpectedly enable memory checking when it
- * executes one of those sections that want to disable checking
- * temporarily.
- *
- * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
+/*
+ * the following pointers may be changed as long as 'allow_customize' is set
  */
+static int allow_customize = 1;
 
-static unsigned long order=0;
-
-static LHASH *mh=NULL;
-
-typedef struct mem_st
-       {
-       char *addr;
-       int num;
-       const char *file;
-       int line;
-       unsigned long order;
-#ifdef CRYPTO_MDEBUG_TIME
-       time_t time;
-#endif
-       } MEM;
-
-int CRYPTO_mem_ctrl(int mode)
-       {
-       int ret=mh_mode;
-
-       CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
-       switch (mode)
-               {
-       /* for applications: */
-       case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
-               mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
-               break;
-       case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
-               mh_mode = 0;
-               break;
-
-       /* switch off temporarily (for library-internal use): */
-       case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
-               mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
-               break;
-       case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
-               if (mh_mode&CRYPTO_MEM_CHECK_ON)
-                       mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
-               break;
-
-       default:
-               break;
-               }
-       CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
-       return(ret);
-       }
-
-static int mem_cmp(MEM *a, MEM *b)
-       {
-       return(a->addr - b->addr);
-       }
-
-static unsigned long mem_hash(MEM *a)
-       {
-       unsigned long ret;
-
-       ret=(unsigned long)a->addr;
-
-       ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
-       return(ret);
-       }
-
-static char *(*malloc_locked_func)()=(char *(*)())malloc;
-static void (*free_locked_func)()=(void (*)())free;
-static char *(*malloc_func)()= (char *(*)())malloc;
-static char *(*realloc_func)()=        (char *(*)())realloc;
-static void (*free_func)()=    (void (*)())free;
-
-void CRYPTO_set_mem_functions(char *(*m)(), char *(*r)(), void (*f)())
-       {
-       if ((m == NULL) || (r == NULL) || (f == NULL)) return;
-       malloc_func=m;
-       realloc_func=r;
-       free_func=f;
-       malloc_locked_func=m;
-       free_locked_func=f;
-       }
-
-void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*f)())
-       {
-       if ((m == NULL) || (f == NULL)) return;
-       malloc_locked_func=m;
-       free_locked_func=f;
-       }
-
-void CRYPTO_get_mem_functions(char *(**m)(), char *(**r)(), void (**f)())
-       {
-       if (m != NULL) *m=malloc_func;
-       if (r != NULL) *r=realloc_func;
-       if (f != NULL) *f=free_func;
-       }
-
-void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)())
-       {
-       if (m != NULL) *m=malloc_locked_func;
-       if (f != NULL) *f=free_locked_func;
-       }
-
-void *CRYPTO_malloc_locked(int num)
-       {
-       return(malloc_locked_func(num));
-       }
-
-void CRYPTO_free_locked(void *str)
-       {
-       free_locked_func(str);
-       }
-
-void *CRYPTO_malloc(int num)
-       {
-       return(malloc_func(num));
-       }
+static void *(*malloc_impl)(size_t, const char *, int)
+    = CRYPTO_malloc;
+static void *(*realloc_impl)(void *, size_t, const char *, int)
+    = CRYPTO_realloc;
+static void (*free_impl)(void *, const char *, int)
+    = CRYPTO_free;
 
-void *CRYPTO_realloc(void *str, int num)
-       {
-       return(realloc_func(str,num));
-       }
-
-void CRYPTO_free(void *str)
-       {
-       free_func(str);
-       }
-
-static unsigned long break_order_num=0;
-void *CRYPTO_dbg_malloc(int num, const char *file, int line)
-       {
-       char *ret;
-       MEM *m,*mm;
-
-       if ((ret=malloc_func(num)) == NULL)
-               return(NULL);
-
-       if (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
-               {
-               MemCheck_off();
-               if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
-                       {
-                       Free(ret);
-                       MemCheck_on();
-                       return(NULL);
-                       }
-               CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
-               if (mh == NULL)
-                       {
-                       if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
-                               {
-                               Free(ret);
-                               Free(m);
-                               ret=NULL;
-                               goto err;
-                               }
-                       }
-
-               m->addr=ret;
-               m->file=file;
-               m->line=line;
-               m->num=num;
-               if (order == break_order_num)
-                       {
-                       /* BREAK HERE */
-                       m->order=order;
-                       }
-               m->order=order++;
-#ifdef CRYPTO_MDEBUG_TIME
-               m->time=time(NULL);
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+static int call_malloc_debug = 1;
+#else
+static int call_malloc_debug = 0;
 #endif
-               if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
-                       {
-                       /* Not good, but don't sweat it */
-                       Free(mm);
-                       }
-err:
-               CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
-               MemCheck_on();
-               }
-       return(ret);
-       }
-
-void CRYPTO_dbg_free(void *addr)
-       {
-       MEM m,*mp;
-
-       if ((mh_mode & CRYPTO_MEM_CHECK_ENABLE) && (mh != NULL))
-               {
-               MemCheck_off();
-               CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
-               m.addr=addr;
-               mp=(MEM *)lh_delete(mh,(char *)&m);
-               if (mp != NULL)
-                       Free(mp);
-               CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
-               MemCheck_on();
-               }
-       free_func(addr);
-       }
-
-void *CRYPTO_dbg_realloc(void *addr, int num, const char *file, int line)
-       {
-       char *ret;
-       MEM m,*mp;
-
-       ret=realloc_func(addr,num);
-       if (ret == addr) return(ret);
-
-       if (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
-               {
-               MemCheck_off();
-               if (ret == NULL) return(NULL);
-               m.addr=addr;
-               CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
-               mp=(MEM *)lh_delete(mh,(char *)&m);
-               if (mp != NULL)
-                       {
-                       mp->addr=ret;
-                       lh_insert(mh,(char *)mp);
-                       }
-               CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
-               MemCheck_on();
-               }
-       return(ret);
-       }
-
-void *CRYPTO_remalloc(void *a, int n)
-       {
-       if (a != NULL) Free(a);
-       a=(char *)Malloc(n);
-       return(a);
-       }
-
-void *CRYPTO_dbg_remalloc(void *a, int n, const char *file, int line)
-       {
-       if (a != NULL) CRYPTO_dbg_free(a);
-       a=(char *)CRYPTO_dbg_malloc(n,file,line);
-       return(a);
-       }
 
-
-typedef struct mem_leak_st
-       {
-       BIO *bio;
-       int chunks;
-       long bytes;
-       } MEM_LEAK;
-
-static void print_leak(MEM *m, MEM_LEAK *l)
-       {
-       char buf[128];
-
-       if(m->addr == (char *)l->bio)
-           return;
-#ifdef CRYPTO_MDEBUG_TIME
-       {
-       struct tm *lcl = localtime(&m->time);
-       sprintf(buf,"[%02d:%02d:%02d] %5lu file=%s, line=%d, number=%d, address=%08lX\n",
-               lcl->tm_hour,lcl->tm_min,lcl->tm_sec,
-               m->order,m->file,m->line,m->num,(unsigned long)m->addr);
-       }
+int CRYPTO_set_mem_functions(
+        void *(*m)(size_t, const char *, int),
+        void *(*r)(void *, size_t, const char *, int),
+        void (*f)(void *, const char *, int))
+{
+    if (!allow_customize)
+        return 0;
+    if (m)
+        malloc_impl = m;
+    if (r)
+        realloc_impl = r;
+    if (f)
+        free_impl = f;
+    return 1;
+}
+
+int CRYPTO_set_mem_debug(int flag)
+{
+    if (!allow_customize)
+        return 0;
+    call_malloc_debug = flag;
+    return 1;
+}
+
+void CRYPTO_get_mem_functions(
+        void *(**m)(size_t, const char *, int),
+        void *(**r)(void *, size_t, const char *, int),
+        void (**f)(void *, const char *, int))
+{
+    if (m != NULL)
+        *m = malloc_impl;
+    if (r != NULL)
+        *r = realloc_impl;
+    if (f != NULL)
+        *f = free_impl;
+}
+
+void *CRYPTO_malloc(size_t num, const char *file, int line)
+{
+    void *ret = NULL;
+
+    if (malloc_impl != NULL && malloc_impl != CRYPTO_malloc)
+        return malloc_impl(num, file, line);
+
+    if (num <= 0)
+        return NULL;
+
+    allow_customize = 0;
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+    if (call_malloc_debug) {
+        CRYPTO_mem_debug_malloc(NULL, num, 0, file, line);
+        ret = malloc(num);
+        CRYPTO_mem_debug_malloc(ret, num, 1, file, line);
+    } else {
+        ret = malloc(num);
+    }
 #else
-       sprintf(buf,"%5lu file=%s, line=%d, number=%d, address=%08lX\n",
-               m->order,m->file,m->line,m->num,(unsigned long)m->addr);
+    osslargused(file); osslargused(line);
+    ret = malloc(num);
 #endif
-       BIO_puts(l->bio,buf);
-       l->chunks++;
-       l->bytes+=m->num;
-       }
-
-void CRYPTO_mem_leaks(BIO *b)
-       {
-       MEM_LEAK ml;
-       char buf[80];
 
-       if (mh == NULL) return;
-       ml.bio=b;
-       ml.bytes=0;
-       ml.chunks=0;
-       CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
-       lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
-       CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
-       if (ml.chunks != 0)
-               {
-               sprintf(buf,"%ld bytes leaked in %d chunks\n",
-                       ml.bytes,ml.chunks);
-               BIO_puts(b,buf);
-               }
-
-#if 0
-       lh_stats_bio(mh,b);
-       lh_node_stats_bio(mh,b);
-       lh_node_usage_stats_bio(mh,b);
+    return ret;
+}
+
+void *CRYPTO_zalloc(size_t num, const char *file, int line)
+{
+    void *ret = CRYPTO_malloc(num, file, line);
+
+    if (ret != NULL)
+        memset(ret, 0, num);
+    return ret;
+}
+
+void *CRYPTO_realloc(void *str, size_t num, const char *file, int line)
+{
+    if (realloc_impl != NULL && realloc_impl != &CRYPTO_realloc)
+        return realloc_impl(str, num, file, line);
+
+    if (str == NULL)
+        return CRYPTO_malloc(num, file, line);
+
+    if (num == 0) {
+        CRYPTO_free(str, file, line);
+        return NULL;
+    }
+
+    allow_customize = 0;
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+    if (call_malloc_debug) {
+        void *ret;
+        CRYPTO_mem_debug_realloc(str, NULL, num, 0, file, line);
+        ret = realloc(str, num);
+        CRYPTO_mem_debug_realloc(str, ret, num, 1, file, line);
+        return ret;
+    }
+#else
+    osslargused(file); osslargused(line);
 #endif
-       }
-
-static void (*mem_cb)()=NULL;
-
-static void cb_leak(MEM *m, char *cb)
-       {
-       void (*mem_callback)()=(void (*)())cb;
-       mem_callback(m->order,m->file,m->line,m->num,m->addr);
-       }
-
-void CRYPTO_mem_leaks_cb(void (*cb)())
-       {
-       if (mh == NULL) return;
-       CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
-       mem_cb=cb;
-       lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
-       mem_cb=NULL;
-       CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
-       }
-
-#ifndef NO_FP_API
-void CRYPTO_mem_leaks_fp(FILE *fp)
-       {
-       BIO *b;
-
-       if (mh == NULL) return;
-       if ((b=BIO_new(BIO_s_file())) == NULL)
-               return;
-       BIO_set_fp(b,fp,BIO_NOCLOSE);
-       CRYPTO_mem_leaks(b);
-       BIO_free(b);
-       }
+    return realloc(str, num);
+
+}
+
+void *CRYPTO_clear_realloc(void *str, size_t old_len, size_t num,
+                           const char *file, int line)
+{
+    void *ret = NULL;
+
+    if (str == NULL)
+        return CRYPTO_malloc(num, file, line);
+
+    if (num == 0) {
+        CRYPTO_clear_free(str, old_len, file, line);
+        return NULL;
+    }
+
+    /* Can't shrink the buffer since memcpy below copies |old_len| bytes. */
+    if (num < old_len) {
+        memset((char*)str + num, 0, old_len - num);
+        return str;
+    }
+
+    ret = CRYPTO_malloc(num, file, line);
+    if (ret != NULL) {
+        memcpy(ret, str, old_len);
+        CRYPTO_clear_free(str, old_len, file, line);
+    }
+    return ret;
+}
+
+void CRYPTO_free(void *str, const char *file, int line)
+{
+    if (free_impl != NULL && free_impl != &CRYPTO_free) {
+        free_impl(str, file, line);
+        return;
+    }
+
+#ifndef OPENSSL_NO_CRYPTO_MDEBUG
+    if (call_malloc_debug) {
+        CRYPTO_mem_debug_free(str, 0, file, line);
+        free(str);
+        CRYPTO_mem_debug_free(str, 1, file, line);
+    } else {
+        free(str);
+    }
+#else
+    free(str);
 #endif
-
+}
+
+void CRYPTO_clear_free(void *str, size_t num, const char *file, int line)
+{
+    if (str == NULL)
+        return;
+    if (num)
+        OPENSSL_cleanse(str, num);
+    CRYPTO_free(str, file, line);
+}