2 * Copyright 2004-2014, Akamai Technologies. All Rights Reserved.
3 * This file is distributed under the terms of the OpenSSL license.
7 * This file is in two halves. The first half implements the public API
8 * to be used by external consumers, and to be used by OpenSSL to store
9 * data in a "secure arena." The second half implements the secure arena.
10 * For details on that implementation, see below (look for uppercase
11 * "SECURE HEAP IMPLEMENTATION").
13 #include <openssl/crypto.h>
16 #if defined(OPENSSL_SYS_LINUX) || defined(OPENSSL_SYS_UNIX)
22 # include <sys/types.h>
23 # include <sys/mman.h>
24 # include <sys/param.h>
25 # include <sys/stat.h>
29 #define LOCK() CRYPTO_w_lock(CRYPTO_LOCK_MALLOC)
30 #define UNLOCK() CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC)
31 #define CLEAR(p, s) OPENSSL_cleanse(p, s)
33 # define PAGE_SIZE 4096
37 static size_t secure_mem_used;
39 static int secure_mem_initialized;
43 * These are the functions that must be implemented by a secure heap (sh).
45 static int sh_init(size_t size, int minsize);
46 static char *sh_malloc(size_t size);
47 static void sh_free(char *ptr);
48 static void sh_done(void);
49 static int sh_actual_size(char *ptr);
50 static int sh_allocated(const char *ptr);
53 int CRYPTO_secure_malloc_init(size_t size, int minsize)
61 OPENSSL_assert(!secure_mem_initialized);
62 if (!secure_mem_initialized) {
63 ret = sh_init(size, minsize);
64 secure_mem_initialized = 1;
70 #endif /* IMPLEMENTED */
73 void CRYPTO_secure_malloc_done()
78 secure_mem_initialized = 0;
80 #endif /* IMPLEMENTED */
83 int CRYPTO_secure_malloc_initialized()
86 return secure_mem_initialized;
89 #endif /* IMPLEMENTED */
92 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
98 if (!secure_mem_initialized) {
100 return CRYPTO_malloc(num, file, line);
103 ret = sh_malloc(num);
104 actual_size = ret ? sh_actual_size(ret) : 0;
105 secure_mem_used += actual_size;
109 return CRYPTO_malloc(num, file, line);
110 #endif /* IMPLEMENTED */
113 void CRYPTO_secure_free(void *ptr)
120 if (!secure_mem_initialized) {
125 actual_size = sh_actual_size(ptr);
126 CLEAR(ptr, actual_size);
127 secure_mem_used -= actual_size;
132 #endif /* IMPLEMENTED */
135 int CRYPTO_secure_allocated(const void *ptr)
140 if (!secure_mem_initialized)
143 ret = sh_allocated(ptr);
148 #endif /* IMPLEMENTED */
151 size_t CRYPTO_secure_used()
154 return secure_mem_used;
157 #endif /* IMPLEMENTED */
160 size_t CRYPTO_secure_actual_size(void *ptr)
166 actual_size = sh_actual_size(ptr);
178 * SECURE HEAP IMPLEMENTATION
184 * The implementation provided here uses a fixed-sized mmap() heap,
185 * which is locked into memory, not written to core files, and protected
186 * on either side by an unmapped page, which will catch pointer overruns
187 * (or underruns) and an attempt to read data out of the secure heap.
188 * Free'd memory is zero'd or otherwise cleansed.
190 * This is a pretty standard buddy allocator. We keep areas in a multiple
191 * of "sh.minsize" units. The freelist and bitmaps are kept separately,
192 * so all (and only) data is kept in the mmap'd heap.
194 * This code assumes eight-bit bytes. The numbers 3 and 7 are all over the
198 # define TESTBIT(t, b) (t[(b) >> 3] & (1 << ((b) & 7)))
199 # define SETBIT(t, b) (t[(b) >> 3] |= (1 << ((b) & 7)))
200 # define CLEARBIT(t, b) (t[(b) >> 3] &= (0xFF & ~(1 << ((b) & 7))))
202 #define WITHIN_ARENA(p) \
203 ((char*)(p) >= sh.arena && (char*)(p) < &sh.arena[sh.arena_size])
204 #define WITHIN_FREELIST(p) \
205 ((char*)(p) >= (char*)sh.freelist && (char*)(p) < (char*)&sh.freelist[sh.freelist_size])
208 typedef struct sh_list_st
210 struct sh_list_st *next;
211 struct sh_list_st **p_next;
223 unsigned char *bittable;
224 unsigned char *bitmalloc;
225 int bittable_size; /* size in bits */
230 static int sh_getlist(char *ptr)
232 int list = sh.freelist_size - 1;
233 int bit = (sh.arena_size + ptr - sh.arena) / sh.minsize;
235 for (; bit; bit >>= 1, list--) {
236 if (TESTBIT(sh.bittable, bit))
238 OPENSSL_assert((bit & 1) == 0);
245 static int sh_testbit(char *ptr, int list, unsigned char *table)
249 OPENSSL_assert(list >= 0 && list < sh.freelist_size);
250 OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
251 bit = (1 << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
252 OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
253 return TESTBIT(table, bit);
256 static void sh_clearbit(char *ptr, int list, unsigned char *table)
260 OPENSSL_assert(list >= 0 && list < sh.freelist_size);
261 OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
262 bit = (1 << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
263 OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
264 OPENSSL_assert(TESTBIT(table, bit));
265 CLEARBIT(table, bit);
268 static void sh_setbit(char *ptr, int list, unsigned char *table)
272 OPENSSL_assert(list >= 0 && list < sh.freelist_size);
273 OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
274 bit = (1 << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
275 OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
276 OPENSSL_assert(!TESTBIT(table, bit));
280 static void sh_add_to_list(char **list, char *ptr)
284 OPENSSL_assert(WITHIN_FREELIST(list));
285 OPENSSL_assert(WITHIN_ARENA(ptr));
287 temp = (SH_LIST *)ptr;
288 temp->next = *(SH_LIST **)list;
289 OPENSSL_assert(temp->next == NULL || WITHIN_ARENA(temp->next));
290 temp->p_next = (SH_LIST **)list;
292 if (temp->next != NULL) {
293 OPENSSL_assert((char **)temp->next->p_next == list);
294 temp->next->p_next = &(temp->next);
300 static void sh_remove_from_list(char *ptr, char *list)
302 SH_LIST *temp, *temp2;
304 temp = (SH_LIST *)ptr;
305 if (temp->next != NULL)
306 temp->next->p_next = temp->p_next;
307 *temp->p_next = temp->next;
308 if (temp->next == NULL)
312 OPENSSL_assert(WITHIN_FREELIST(temp2->p_next) || WITHIN_ARENA(temp2->p_next));
316 static int sh_init(size_t size, int minsize)
322 memset(&sh, 0, sizeof sh);
324 /* make sure size and minsize are powers of 2 */
325 OPENSSL_assert(size > 0);
326 OPENSSL_assert((size & (size - 1)) == 0);
327 OPENSSL_assert(minsize > 0);
328 OPENSSL_assert((minsize & (minsize - 1)) == 0);
329 if (size <= 0 || (size & (size - 1)) != 0)
331 if (minsize <= 0 || (minsize & (minsize - 1)) != 0)
334 sh.arena_size = size;
335 sh.minsize = minsize;
336 sh.bittable_size = (sh.arena_size / sh.minsize) * 2;
338 sh.freelist_size = -1;
339 for (i = sh.bittable_size; i; i >>= 1)
342 sh.freelist = OPENSSL_zalloc(sh.freelist_size * sizeof (char *));
343 OPENSSL_assert(sh.freelist != NULL);
344 if (sh.freelist == NULL)
347 sh.bittable = OPENSSL_zalloc(sh.bittable_size >> 3);
348 OPENSSL_assert(sh.bittable != NULL);
349 if (sh.bittable == NULL)
352 sh.bitmalloc = OPENSSL_zalloc(sh.bittable_size >> 3);
353 OPENSSL_assert(sh.bitmalloc != NULL);
354 if (sh.bitmalloc == NULL)
357 /* Allocate space for heap, and two extra pages as guards */
358 #if defined(_SC_PAGE_SIZE) || defined (_SC_PAGESIZE)
360 # if defined(_SC_PAGE_SIZE)
361 long tmppgsize = sysconf(_SC_PAGE_SIZE);
363 long tmppgsize = sysconf(_SC_PAGESIZE);
368 pgsize = (size_t)tmppgsize;
373 sh.map_size = pgsize + sh.arena_size + pgsize;
376 sh.map_result = mmap(NULL, sh.map_size,
377 PROT_READ|PROT_WRITE, MAP_ANON|MAP_PRIVATE, -1, 0);
382 sh.map_result = MAP_FAILED;
383 if ((fd = open("/dev/zero", O_RDWR)) >= 0) {
384 sh.map_result = mmap(NULL, sh.map_size,
385 PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
389 OPENSSL_assert(sh.map_result != MAP_FAILED);
390 if (sh.map_result == MAP_FAILED)
392 sh.arena = (char *)(sh.map_result + pgsize);
393 sh_setbit(sh.arena, 0, sh.bittable);
394 sh_add_to_list(&sh.freelist[0], sh.arena);
396 /* Now try to add guard pages and lock into memory. */
399 /* Starting guard is already aligned from mmap. */
400 if (mprotect(sh.map_result, pgsize, PROT_NONE) < 0)
403 /* Ending guard page - need to round up to page boundary */
404 aligned = (pgsize + sh.arena_size + (pgsize - 1)) & ~(pgsize - 1);
405 if (mprotect(sh.map_result + aligned, pgsize, PROT_NONE) < 0)
408 if (mlock(sh.arena, sh.arena_size) < 0)
411 if (madvise(sh.arena, sh.arena_size, MADV_DONTDUMP) < 0)
422 static void sh_done()
424 OPENSSL_free(sh.freelist);
425 OPENSSL_free(sh.bittable);
426 OPENSSL_free(sh.bitmalloc);
427 if (sh.map_result != NULL && sh.map_size)
428 munmap(sh.map_result, sh.map_size);
429 memset(&sh, 0, sizeof sh);
432 static int sh_allocated(const char *ptr)
434 return WITHIN_ARENA(ptr) ? 1 : 0;
437 static char *sh_find_my_buddy(char *ptr, int list)
442 bit = (1 << list) + (ptr - sh.arena) / (sh.arena_size >> list);
445 if (TESTBIT(sh.bittable, bit) && !TESTBIT(sh.bitmalloc, bit))
446 chunk = sh.arena + ((bit & ((1 << list) - 1)) * (sh.arena_size >> list));
451 static char *sh_malloc(size_t size)
457 list = sh.freelist_size - 1;
458 for (i = sh.minsize; i < size; i <<= 1)
463 /* try to find a larger entry to split */
464 for (slist = list; slist >= 0; slist--)
465 if (sh.freelist[slist] != NULL)
470 /* split larger entry */
471 while (slist != list) {
472 char *temp = sh.freelist[slist];
474 /* remove from bigger list */
475 OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
476 sh_clearbit(temp, slist, sh.bittable);
477 sh_remove_from_list(temp, sh.freelist[slist]);
478 OPENSSL_assert(temp != sh.freelist[slist]);
480 /* done with bigger list */
483 /* add to smaller list */
484 OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
485 sh_setbit(temp, slist, sh.bittable);
486 sh_add_to_list(&sh.freelist[slist], temp);
487 OPENSSL_assert(sh.freelist[slist] == temp);
490 temp += sh.arena_size >> slist;
491 OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
492 sh_setbit(temp, slist, sh.bittable);
493 sh_add_to_list(&sh.freelist[slist], temp);
494 OPENSSL_assert(sh.freelist[slist] == temp);
496 OPENSSL_assert(temp-(sh.arena_size >> slist) == sh_find_my_buddy(temp, slist));
499 /* peel off memory to hand back */
500 chunk = sh.freelist[list];
501 OPENSSL_assert(sh_testbit(chunk, list, sh.bittable));
502 sh_setbit(chunk, list, sh.bitmalloc);
503 sh_remove_from_list(chunk, sh.freelist[list]);
505 OPENSSL_assert(WITHIN_ARENA(chunk));
510 static void sh_free(char *ptr)
517 OPENSSL_assert(WITHIN_ARENA(ptr));
518 if (!WITHIN_ARENA(ptr))
521 list = sh_getlist(ptr);
522 OPENSSL_assert(sh_testbit(ptr, list, sh.bittable));
523 sh_clearbit(ptr, list, sh.bitmalloc);
524 sh_add_to_list(&sh.freelist[list], ptr);
526 /* Try to coalesce two adjacent free areas. */
527 while ((buddy = sh_find_my_buddy(ptr, list)) != NULL) {
528 OPENSSL_assert(ptr == sh_find_my_buddy(buddy, list));
529 OPENSSL_assert(ptr != NULL);
530 OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
531 sh_clearbit(ptr, list, sh.bittable);
532 sh_remove_from_list(ptr, sh.freelist[list]);
533 OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
534 sh_clearbit(buddy, list, sh.bittable);
535 sh_remove_from_list(buddy, sh.freelist[list]);
542 OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
543 sh_setbit(ptr, list, sh.bittable);
544 sh_add_to_list(&sh.freelist[list], ptr);
545 OPENSSL_assert(sh.freelist[list] == ptr);
549 static int sh_actual_size(char *ptr)
553 OPENSSL_assert(WITHIN_ARENA(ptr));
554 if (!WITHIN_ARENA(ptr))
556 list = sh_getlist(ptr);
557 OPENSSL_assert(sh_testbit(ptr, list, sh.bittable));
558 return sh.arena_size / (1 << list);
560 #endif /* IMPLEMENTED */