mem.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  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. #include <stdio.h>
  59. #include <stdlib.h>
  60. #include <openssl/crypto.h>
  61. #include "cryptlib.h"
  62. static int allow_customize = 1; /* we provide flexible functions for */
  63. static int allow_customize_debug = 1; /* exchanging memory-related functions
  64. * at run-time, but this must be done
  65. * before any blocks are actually
  66. * allocated; or we'll run into huge
  67. * problems when malloc/free pairs
  68. * don't match etc. */
  69. /*
  70. * the following pointers may be changed as long as 'allow_customize' is set
  71. */
  72. static void *(*malloc_func) (size_t) = malloc;
  73. static void *default_malloc_ex(size_t num, const char *file, int line)
  74. {
  75. return malloc_func(num);
  76. }
  77. static void *(*malloc_ex_func) (size_t, const char *file, int line)
  78. = default_malloc_ex;
  79. static void *(*realloc_func) (void *, size_t) = realloc;
  80. static void *default_realloc_ex(void *str, size_t num,
  81. const char *file, int line)
  82. {
  83. return realloc_func(str, num);
  84. }
  85. static void *(*realloc_ex_func) (void *, size_t, const char *file, int line)
  86. = default_realloc_ex;
  87. static void (*free_func) (void *) = free;
  88. static void *(*malloc_locked_func) (size_t) = malloc;
  89. static void *default_malloc_locked_ex(size_t num, const char *file, int line)
  90. {
  91. return malloc_locked_func(num);
  92. }
  93. static void *(*malloc_locked_ex_func) (size_t, const char *file, int line)
  94. = default_malloc_locked_ex;
  95. static void (*free_locked_func) (void *) = free;
  96. /* may be changed as long as 'allow_customize_debug' is set */
  97. /* XXX use correct function pointer types */
  98. #ifdef CRYPTO_MDEBUG
  99. /* use default functions from mem_dbg.c */
  100. static void (*malloc_debug_func) (void *, int, const char *, int, int)
  101. = CRYPTO_dbg_malloc;
  102. static void (*realloc_debug_func) (void *, void *, int, const char *, int,
  103. int)
  104. = CRYPTO_dbg_realloc;
  105. static void (*free_debug_func) (void *, int) = CRYPTO_dbg_free;
  106. static void (*set_debug_options_func) (long) = CRYPTO_dbg_set_options;
  107. static long (*get_debug_options_func) (void) = CRYPTO_dbg_get_options;
  108. #else
  109. /*
  110. * applications can use CRYPTO_malloc_debug_init() to select above case at
  111. * run-time
  112. */
  113. static void (*malloc_debug_func) (void *, int, const char *, int, int) = NULL;
  114. static void (*realloc_debug_func) (void *, void *, int, const char *, int,
  115. int)
  116. = NULL;
  117. static void (*free_debug_func) (void *, int) = NULL;
  118. static void (*set_debug_options_func) (long) = NULL;
  119. static long (*get_debug_options_func) (void) = NULL;
  120. #endif
  121. int CRYPTO_set_mem_functions(void *(*m) (size_t), void *(*r) (void *, size_t),
  122. void (*f) (void *))
  123. {
  124. /* Dummy call just to ensure OPENSSL_init() gets linked in */
  125. OPENSSL_init();
  126. if (!allow_customize)
  127. return 0;
  128. if ((m == 0) || (r == 0) || (f == 0))
  129. return 0;
  130. malloc_func = m;
  131. malloc_ex_func = default_malloc_ex;
  132. realloc_func = r;
  133. realloc_ex_func = default_realloc_ex;
  134. free_func = f;
  135. malloc_locked_func = m;
  136. malloc_locked_ex_func = default_malloc_locked_ex;
  137. free_locked_func = f;
  138. return 1;
  139. }
  140. int CRYPTO_set_mem_ex_functions(void *(*m) (size_t, const char *, int),
  141. void *(*r) (void *, size_t, const char *,
  142. int), void (*f) (void *))
  143. {
  144. if (!allow_customize)
  145. return 0;
  146. if ((m == 0) || (r == 0) || (f == 0))
  147. return 0;
  148. malloc_func = 0;
  149. malloc_ex_func = m;
  150. realloc_func = 0;
  151. realloc_ex_func = r;
  152. free_func = f;
  153. malloc_locked_func = 0;
  154. malloc_locked_ex_func = m;
  155. free_locked_func = f;
  156. return 1;
  157. }
  158. int CRYPTO_set_locked_mem_functions(void *(*m) (size_t), void (*f) (void *))
  159. {
  160. if (!allow_customize)
  161. return 0;
  162. if ((m == NULL) || (f == NULL))
  163. return 0;
  164. malloc_locked_func = m;
  165. malloc_locked_ex_func = default_malloc_locked_ex;
  166. free_locked_func = f;
  167. return 1;
  168. }
  169. int CRYPTO_set_locked_mem_ex_functions(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;
  177. malloc_locked_ex_func = m;
  178. free_func = f;
  179. return 1;
  180. }
  181. int CRYPTO_set_mem_debug_functions(void (*m)
  182. (void *, int, const char *, int, int),
  183. void (*r) (void *, void *, int,
  184. const char *, int, int),
  185. void (*f) (void *, int), void (*so) (long),
  186. long (*go) (void))
  187. {
  188. if (!allow_customize_debug)
  189. return 0;
  190. OPENSSL_init();
  191. malloc_debug_func = m;
  192. realloc_debug_func = r;
  193. free_debug_func = f;
  194. set_debug_options_func = so;
  195. get_debug_options_func = go;
  196. return 1;
  197. }
  198. void CRYPTO_get_mem_functions(void *(**m) (size_t),
  199. void *(**r) (void *, size_t),
  200. void (**f) (void *))
  201. {
  202. if (m != NULL)
  203. *m = (malloc_ex_func == default_malloc_ex) ? malloc_func : 0;
  204. if (r != NULL)
  205. *r = (realloc_ex_func == default_realloc_ex) ? realloc_func : 0;
  206. if (f != NULL)
  207. *f = free_func;
  208. }
  209. void CRYPTO_get_mem_ex_functions(void *(**m) (size_t, const char *, int),
  210. void *(**r) (void *, size_t, const char *,
  211. int), void (**f) (void *))
  212. {
  213. if (m != NULL)
  214. *m = (malloc_ex_func != default_malloc_ex) ? malloc_ex_func : 0;
  215. if (r != NULL)
  216. *r = (realloc_ex_func != default_realloc_ex) ? realloc_ex_func : 0;
  217. if (f != NULL)
  218. *f = free_func;
  219. }
  220. void CRYPTO_get_locked_mem_functions(void *(**m) (size_t),
  221. void (**f) (void *))
  222. {
  223. if (m != NULL)
  224. *m = (malloc_locked_ex_func == default_malloc_locked_ex) ?
  225. malloc_locked_func : 0;
  226. if (f != NULL)
  227. *f = free_locked_func;
  228. }
  229. void CRYPTO_get_locked_mem_ex_functions(void
  230. *(**m) (size_t, const char *, int),
  231. void (**f) (void *))
  232. {
  233. if (m != NULL)
  234. *m = (malloc_locked_ex_func != default_malloc_locked_ex) ?
  235. malloc_locked_ex_func : 0;
  236. if (f != NULL)
  237. *f = free_locked_func;
  238. }
  239. void CRYPTO_get_mem_debug_functions(void (**m)
  240. (void *, int, const char *, int, int),
  241. void (**r) (void *, void *, int,
  242. const char *, int, int),
  243. void (**f) (void *, int),
  244. void (**so) (long), long (**go) (void))
  245. {
  246. if (m != NULL)
  247. *m = malloc_debug_func;
  248. if (r != NULL)
  249. *r = realloc_debug_func;
  250. if (f != NULL)
  251. *f = free_debug_func;
  252. if (so != NULL)
  253. *so = set_debug_options_func;
  254. if (go != NULL)
  255. *go = get_debug_options_func;
  256. }
  257. void *CRYPTO_malloc_locked(int num, const char *file, int line)
  258. {
  259. void *ret = NULL;
  260. if (num <= 0)
  261. return NULL;
  262. if (allow_customize)
  263. allow_customize = 0;
  264. if (malloc_debug_func != NULL) {
  265. if (allow_customize_debug)
  266. allow_customize_debug = 0;
  267. malloc_debug_func(NULL, num, file, line, 0);
  268. }
  269. ret = malloc_locked_ex_func(num, file, line);
  270. #ifdef LEVITTE_DEBUG_MEM
  271. fprintf(stderr, "LEVITTE_DEBUG_MEM: > 0x%p (%d)\n", ret, num);
  272. #endif
  273. if (malloc_debug_func != NULL)
  274. malloc_debug_func(ret, num, file, line, 1);
  275. #ifndef OPENSSL_CPUID_OBJ
  276. /*
  277. * Create a dependency on the value of 'cleanse_ctr' so our memory
  278. * sanitisation function can't be optimised out. NB: We only do this for
  279. * >2Kb so the overhead doesn't bother us.
  280. */
  281. if (ret && (num > 2048)) {
  282. extern unsigned char cleanse_ctr;
  283. ((unsigned char *)ret)[0] = cleanse_ctr;
  284. }
  285. #endif
  286. return ret;
  287. }
  288. void CRYPTO_free_locked(void *str)
  289. {
  290. if (free_debug_func != NULL)
  291. free_debug_func(str, 0);
  292. #ifdef LEVITTE_DEBUG_MEM
  293. fprintf(stderr, "LEVITTE_DEBUG_MEM: < 0x%p\n", str);
  294. #endif
  295. free_locked_func(str);
  296. if (free_debug_func != NULL)
  297. free_debug_func(NULL, 1);
  298. }
  299. void *CRYPTO_malloc(int num, const char *file, int line)
  300. {
  301. void *ret = NULL;
  302. if (num <= 0)
  303. return NULL;
  304. if (allow_customize)
  305. allow_customize = 0;
  306. if (malloc_debug_func != NULL) {
  307. if (allow_customize_debug)
  308. allow_customize_debug = 0;
  309. malloc_debug_func(NULL, num, file, line, 0);
  310. }
  311. ret = malloc_ex_func(num, file, line);
  312. #ifdef LEVITTE_DEBUG_MEM
  313. fprintf(stderr, "LEVITTE_DEBUG_MEM: > 0x%p (%d)\n", ret, num);
  314. #endif
  315. if (malloc_debug_func != NULL)
  316. malloc_debug_func(ret, num, file, line, 1);
  317. #ifndef OPENSSL_CPUID_OBJ
  318. /*
  319. * Create a dependency on the value of 'cleanse_ctr' so our memory
  320. * sanitisation function can't be optimised out. NB: We only do this for
  321. * >2Kb so the overhead doesn't bother us.
  322. */
  323. if (ret && (num > 2048)) {
  324. extern unsigned char cleanse_ctr;
  325. ((unsigned char *)ret)[0] = cleanse_ctr;
  326. }
  327. #endif
  328. return ret;
  329. }
  330. char *CRYPTO_strdup(const char *str, const char *file, int line)
  331. {
  332. char *ret = CRYPTO_malloc(strlen(str) + 1, file, line);
  333. if (ret == NULL)
  334. return NULL;
  335. strcpy(ret, str);
  336. return ret;
  337. }
  338. void *CRYPTO_realloc(void *str, int num, const char *file, int line)
  339. {
  340. void *ret = NULL;
  341. if (str == NULL)
  342. return CRYPTO_malloc(num, file, line);
  343. if (num <= 0)
  344. return NULL;
  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,
  350. ret, num);
  351. #endif
  352. if (realloc_debug_func != NULL)
  353. realloc_debug_func(str, ret, num, file, line, 1);
  354. return ret;
  355. }
  356. void *CRYPTO_realloc_clean(void *str, int old_len, int num, const char *file,
  357. int line)
  358. {
  359. void *ret = NULL;
  360. if (str == NULL)
  361. return CRYPTO_malloc(num, file, line);
  362. if (num <= 0)
  363. return NULL;
  364. /*
  365. * We don't support shrinking the buffer. Note the memcpy that copies
  366. * |old_len| bytes to the new buffer, below.
  367. */
  368. if (num < old_len)
  369. return NULL;
  370. if (realloc_debug_func != NULL)
  371. realloc_debug_func(str, NULL, num, file, line, 0);
  372. ret = malloc_ex_func(num, file, line);
  373. if (ret) {
  374. memcpy(ret, str, old_len);
  375. OPENSSL_cleanse(str, old_len);
  376. free_func(str);
  377. }
  378. #ifdef LEVITTE_DEBUG_MEM
  379. fprintf(stderr,
  380. "LEVITTE_DEBUG_MEM: | 0x%p -> 0x%p (%d)\n",
  381. str, ret, num);
  382. #endif
  383. if (realloc_debug_func != NULL)
  384. realloc_debug_func(str, ret, num, file, line, 1);
  385. return ret;
  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. void *CRYPTO_remalloc(void *a, int num, const char *file, int line)
  399. {
  400. if (a != NULL)
  401. OPENSSL_free(a);
  402. a = (char *)OPENSSL_malloc(num);
  403. return (a);
  404. }
  405. void CRYPTO_set_mem_debug_options(long bits)
  406. {
  407. if (set_debug_options_func != NULL)
  408. set_debug_options_func(bits);
  409. }
  410. long CRYPTO_get_mem_debug_options(void)
  411. {
  412. if (get_debug_options_func != NULL)
  413. return get_debug_options_func();
  414. return 0;
  415. }