2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
61 #include <openssl/crypto.h>
62 #include "internal/cryptlib.h"
64 static int allow_customize = 1; /* we provide flexible functions for */
65 static int allow_customize_debug = 1; /* exchanging memory-related functions
66 * at run-time, but this must be done
67 * before any blocks are actually
68 * allocated; or we'll run into huge
69 * problems when malloc/free pairs
73 * the following pointers may be changed as long as 'allow_customize' is set
76 static void *(*malloc_func) (size_t) = malloc;
77 static void *default_malloc_ex(size_t num, const char *file, int line)
79 return malloc_func(num);
82 static void *(*malloc_ex_func) (size_t, const char *file, int line)
85 static void *(*realloc_func) (void *, size_t) = realloc;
86 static void *default_realloc_ex(void *str, size_t num,
87 const char *file, int line)
89 return realloc_func(str, num);
92 static void *(*realloc_ex_func) (void *, size_t, const char *file, int line)
95 static void (*free_func) (void *) = free;
97 static void *(*malloc_secure_func)(size_t) = malloc;
98 static void *default_malloc_secure_ex(size_t num, const char *file, int line)
100 return malloc_secure_func(num);
102 static void *(*malloc_secure_ex_func)(size_t, const char *file, int line)
103 = default_malloc_secure_ex;
104 static void (*free_secure_func)(void *) = free;
106 static void *(*malloc_locked_func) (size_t) = malloc;
107 static void *default_malloc_locked_ex(size_t num, const char *file, int line)
109 return malloc_locked_func(num);
112 static void *(*malloc_locked_ex_func) (size_t, const char *file, int line)
113 = default_malloc_locked_ex;
115 static void (*free_locked_func) (void *) = free;
117 /* may be changed as long as 'allow_customize_debug' is set */
118 /* XXX use correct function pointer types */
120 /* use default functions from mem_dbg.c */
121 static void (*malloc_debug_func) (void *, int, const char *, int, int)
123 static void (*realloc_debug_func) (void *, void *, int, const char *, int,
125 = CRYPTO_dbg_realloc;
126 static void (*free_debug_func) (void *, int) = CRYPTO_dbg_free;
127 static void (*set_debug_options_func) (long) = CRYPTO_dbg_set_options;
128 static long (*get_debug_options_func) (void) = CRYPTO_dbg_get_options;
131 * applications can use CRYPTO_malloc_debug_init() to select above case at
134 static void (*malloc_debug_func) (void *, int, const char *, int, int) = NULL;
135 static void (*realloc_debug_func) (void *, void *, int, const char *, int,
138 static void (*free_debug_func) (void *, int) = NULL;
139 static void (*set_debug_options_func) (long) = NULL;
140 static long (*get_debug_options_func) (void) = NULL;
143 int CRYPTO_set_mem_functions(void *(*m) (size_t), void *(*r) (void *, size_t),
146 /* Dummy call just to ensure OPENSSL_init() gets linked in */
148 if (!allow_customize)
150 if ((m == 0) || (r == 0) || (f == 0))
153 malloc_ex_func = default_malloc_ex;
155 realloc_ex_func = default_realloc_ex;
157 /* If user wants to intercept the secure or locked functions, do it
158 * after the basic functions. */
159 malloc_secure_func = m;
160 malloc_secure_ex_func = default_malloc_secure_ex;
161 free_secure_func = f;
162 malloc_locked_func = m;
163 malloc_locked_ex_func = default_malloc_locked_ex;
164 free_locked_func = f;
168 int CRYPTO_set_mem_ex_functions(void *(*m) (size_t, const char *, int),
169 void *(*r) (void *, size_t, const char *,
170 int), void (*f) (void *))
172 if (!allow_customize)
174 if ((m == 0) || (r == 0) || (f == 0))
181 malloc_secure_func = 0;
182 malloc_secure_ex_func = m;
183 free_secure_func = f;
184 malloc_locked_func = 0;
185 malloc_locked_ex_func = m;
186 free_locked_func = f;
190 int CRYPTO_set_secure_mem_functions(void *(*m)(size_t), void (*f)(void *))
192 /* Dummy call just to ensure OPENSSL_init() gets linked in */
194 if (!allow_customize)
196 if ((m == 0) || (f == 0))
198 malloc_secure_func = m;
199 malloc_secure_ex_func = default_malloc_secure_ex;
200 free_secure_func = f;
201 /* If user wants to intercept the locked functions, do it after
202 * the secure functions. */
203 malloc_locked_func = m;
204 malloc_locked_ex_func = default_malloc_secure_ex;
205 free_locked_func = f;
209 int CRYPTO_set_secure_mem_ex_functions(void *(*m)(size_t, const char *, int),
212 if (!allow_customize)
214 if ((m == NULL) || (f == NULL))
216 malloc_secure_func = 0;
217 malloc_secure_ex_func = m;
218 free_secure_func = f;
219 malloc_locked_func = 0;
220 malloc_locked_ex_func = m;
221 free_locked_func = f;
225 int CRYPTO_set_locked_mem_functions(void *(*m) (size_t), void (*f) (void *))
227 if (!allow_customize)
229 if ((m == NULL) || (f == NULL))
231 malloc_locked_func = m;
232 malloc_locked_ex_func = default_malloc_locked_ex;
233 free_locked_func = f;
237 int CRYPTO_set_locked_mem_ex_functions(void *(*m) (size_t, const char *, int),
240 if (!allow_customize)
242 if ((m == NULL) || (f == NULL))
244 malloc_locked_func = 0;
245 malloc_locked_ex_func = m;
246 free_locked_func = f;
250 int CRYPTO_set_mem_debug_functions(void (*m)
251 (void *, int, const char *, int, int),
252 void (*r) (void *, void *, int,
253 const char *, int, int),
254 void (*f) (void *, int), void (*so) (long),
257 if (!allow_customize_debug)
259 malloc_debug_func = m;
260 realloc_debug_func = r;
262 set_debug_options_func = so;
263 get_debug_options_func = go;
267 void CRYPTO_get_mem_functions(void *(**m) (size_t),
268 void *(**r) (void *, size_t),
272 *m = (malloc_ex_func == default_malloc_ex) ? malloc_func : 0;
274 *r = (realloc_ex_func == default_realloc_ex) ? realloc_func : 0;
279 void CRYPTO_get_mem_ex_functions(void *(**m) (size_t, const char *, int),
280 void *(**r) (void *, size_t, const char *,
281 int), void (**f) (void *))
284 *m = (malloc_ex_func != default_malloc_ex) ? malloc_ex_func : 0;
286 *r = (realloc_ex_func != default_realloc_ex) ? realloc_ex_func : 0;
291 void CRYPTO_get_secure_mem_functions(void *(**m)(size_t), void (**f)(void *))
294 *m = (malloc_secure_ex_func == default_malloc_secure_ex) ?
295 malloc_secure_func : 0;
300 void CRYPTO_get_secure_mem_ex_functions(void *(**m)(size_t,const char *,int),
304 *m = (malloc_secure_ex_func != default_malloc_secure_ex) ?
305 malloc_secure_ex_func : 0;
310 void CRYPTO_get_locked_mem_functions(void *(**m) (size_t),
314 *m = (malloc_locked_ex_func == default_malloc_locked_ex) ?
315 malloc_locked_func : 0;
317 *f = free_locked_func;
320 void CRYPTO_get_locked_mem_ex_functions(void
321 *(**m) (size_t, const char *, int),
325 *m = (malloc_locked_ex_func != default_malloc_locked_ex) ?
326 malloc_locked_ex_func : 0;
328 *f = free_locked_func;
331 void CRYPTO_get_mem_debug_functions(void (**m)
332 (void *, int, const char *, int, int),
333 void (**r) (void *, void *, int,
334 const char *, int, int),
335 void (**f) (void *, int),
336 void (**so) (long), long (**go) (void))
339 *m = malloc_debug_func;
341 *r = realloc_debug_func;
343 *f = free_debug_func;
345 *so = set_debug_options_func;
347 *go = get_debug_options_func;
350 void *CRYPTO_malloc_locked(int num, const char *file, int line)
359 if (malloc_debug_func != NULL) {
360 if (allow_customize_debug)
361 allow_customize_debug = 0;
362 malloc_debug_func(NULL, num, file, line, 0);
364 ret = malloc_locked_ex_func(num, file, line);
365 #ifdef LEVITTE_DEBUG_MEM
366 fprintf(stderr, "LEVITTE_DEBUG_MEM: > 0x%p (%d)\n", ret, num);
368 if (malloc_debug_func != NULL)
369 malloc_debug_func(ret, num, file, line, 1);
371 #ifndef OPENSSL_CPUID_OBJ
373 * Create a dependency on the value of 'cleanse_ctr' so our memory
374 * sanitisation function can't be optimised out. NB: We only do this for
375 * >2Kb so the overhead doesn't bother us.
377 if (ret && (num > 2048)) {
378 extern unsigned char cleanse_ctr;
379 ((unsigned char *)ret)[0] = cleanse_ctr;
386 void CRYPTO_free_locked(void *str)
388 if (free_debug_func != NULL)
389 free_debug_func(str, 0);
390 #ifdef LEVITTE_DEBUG_MEM
391 fprintf(stderr, "LEVITTE_DEBUG_MEM: < 0x%p\n", str);
393 free_locked_func(str);
394 if (free_debug_func != NULL)
395 free_debug_func(NULL, 1);
398 void *CRYPTO_malloc(int num, const char *file, int line)
407 if (malloc_debug_func != NULL) {
408 if (allow_customize_debug)
409 allow_customize_debug = 0;
410 malloc_debug_func(NULL, num, file, line, 0);
412 ret = malloc_ex_func(num, file, line);
413 #ifdef LEVITTE_DEBUG_MEM
414 fprintf(stderr, "LEVITTE_DEBUG_MEM: > 0x%p (%d)\n", ret, num);
416 if (malloc_debug_func != NULL)
417 malloc_debug_func(ret, num, file, line, 1);
419 #ifndef OPENSSL_CPUID_OBJ
421 * Create a dependency on the value of 'cleanse_ctr' so our memory
422 * sanitisation function can't be optimised out. NB: We only do this for
423 * >2Kb so the overhead doesn't bother us.
425 if (ret && (num > 2048)) {
426 extern unsigned char cleanse_ctr;
427 ((unsigned char *)ret)[0] = cleanse_ctr;
434 char *CRYPTO_strdup(const char *str, const char *file, int line)
436 char *ret = CRYPTO_malloc(strlen(str) + 1, file, line);
445 void *CRYPTO_realloc(void *str, int num, const char *file, int line)
450 return CRYPTO_malloc(num, file, line);
455 if (realloc_debug_func != NULL)
456 realloc_debug_func(str, NULL, num, file, line, 0);
457 ret = realloc_ex_func(str, num, file, line);
458 #ifdef LEVITTE_DEBUG_MEM
459 fprintf(stderr, "LEVITTE_DEBUG_MEM: | 0x%p -> 0x%p (%d)\n", str,
462 if (realloc_debug_func != NULL)
463 realloc_debug_func(str, ret, num, file, line, 1);
468 void *CRYPTO_realloc_clean(void *str, int old_len, int num, const char *file,
474 return CRYPTO_malloc(num, file, line);
480 * We don't support shrinking the buffer. Note the memcpy that copies
481 * |old_len| bytes to the new buffer, below.
486 if (realloc_debug_func != NULL)
487 realloc_debug_func(str, NULL, num, file, line, 0);
488 ret = malloc_ex_func(num, file, line);
490 memcpy(ret, str, old_len);
491 OPENSSL_clear_free(str, old_len);
493 #ifdef LEVITTE_DEBUG_MEM
495 "LEVITTE_DEBUG_MEM: | 0x%p -> 0x%p (%d)\n",
498 if (realloc_debug_func != NULL)
499 realloc_debug_func(str, ret, num, file, line, 1);
504 void CRYPTO_free(void *str)
506 if (free_debug_func != NULL)
507 free_debug_func(str, 0);
508 #ifdef LEVITTE_DEBUG_MEM
509 fprintf(stderr, "LEVITTE_DEBUG_MEM: < 0x%p\n", str);
512 if (free_debug_func != NULL)
513 free_debug_func(NULL, 1);
516 void CRYPTO_clear_free(void *str, size_t num)
521 OPENSSL_cleanse(str, num);
525 void *CRYPTO_remalloc(void *a, int num, const char *file, int line)
528 a = OPENSSL_malloc(num);
532 void CRYPTO_set_mem_debug_options(long bits)
534 if (set_debug_options_func != NULL)
535 set_debug_options_func(bits);
538 long CRYPTO_get_mem_debug_options(void)
540 if (get_debug_options_func != NULL)
541 return get_debug_options_func();