crypto/sec_mem.c

   1 /*
   2  * Copyright 2004-2014, Akamai Technologies. All Rights Reserved.
   3  * This file is distributed under the terms of the OpenSSL license.
   4  */
   5
   6 /*
   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").
  12  */
  13 #include <openssl/crypto.h>
  14 #include <e_os.h>
  15
  16 #if defined(OPENSSL_SYS_LINUX) || defined(OPENSSL_SYS_UNIX)
  17 # define IMPLEMENTED
  18 # include <stdlib.h>
  19 # include <string.h>
  20 # include <assert.h>
  21 # include <unistd.h>
  22 # include <sys/types.h>
  23 # include <sys/mman.h>
  24 # include <sys/param.h>
  25 # include <sys/stat.h>
  26 # include <fcntl.h>
  27 #endif
  28
  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)
  32 #ifndef PAGE_SIZE
  33 # define PAGE_SIZE    4096
  34 #endif
  35
  36 #ifdef IMPLEMENTED
  37 static size_t secure_mem_used;
  38
  39 static int secure_mem_initialized;
  40 static int too_late;
  41
  42 /*
  43  * These are the functions that must be implemented by a secure heap (sh).
  44  */
  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);
  51 #endif
  52
  53 int CRYPTO_secure_malloc_init(size_t size, int minsize)
  54 {
  55 #ifdef IMPLEMENTED
  56     int ret = 0;
  57
  58     if (too_late)
  59         return ret;
  60     LOCK();
  61     OPENSSL_assert(!secure_mem_initialized);
  62     if (!secure_mem_initialized) {
  63         ret = sh_init(size, minsize);
  64         secure_mem_initialized = 1;
  65     }
  66     UNLOCK();
  67     return ret;
  68 #else
  69     return 0;
  70 #endif /* IMPLEMENTED */
  71 }
  72
  73 void CRYPTO_secure_malloc_done()
  74 {
  75 #ifdef IMPLEMENTED
  76     LOCK();
  77     sh_done();
  78     secure_mem_initialized = 0;
  79     UNLOCK();
  80 #endif /* IMPLEMENTED */
  81 }
  82
  83 int CRYPTO_secure_malloc_initialized()
  84 {
  85 #ifdef IMPLEMENTED
  86     return secure_mem_initialized;
  87 #else
  88     return 0;
  89 #endif /* IMPLEMENTED */
  90 }
  91
  92 void *CRYPTO_secure_malloc(int num, const char *file, int line)
  93 {
  94 #ifdef IMPLEMENTED
  95     void *ret;
  96     size_t actual_size;
  97
  98     if (!secure_mem_initialized) {
  99         too_late = 1;
 100         return CRYPTO_malloc(num, file, line);
 101     }
 102     LOCK();
 103     ret = sh_malloc(num);
 104     actual_size = ret ? sh_actual_size(ret) : 0;
 105     secure_mem_used += actual_size;
 106     UNLOCK();
 107     return ret;
 108 #else
 109     return CRYPTO_malloc(num, file, line);
 110 #endif /* IMPLEMENTED */
 111 }
 112
 113 void CRYPTO_secure_free(void *ptr)
 114 {
 115 #ifdef IMPLEMENTED
 116     size_t actual_size;
 117
 118     if (ptr == NULL)
 119         return;
 120     if (!secure_mem_initialized) {
 121         CRYPTO_free(ptr);
 122         return;
 123     }
 124     LOCK();
 125     actual_size = sh_actual_size(ptr);
 126     CLEAR(ptr, actual_size);
 127     secure_mem_used -= actual_size;
 128     sh_free(ptr);
 129     UNLOCK();
 130 #else
 131     CRYPTO_free(ptr);
 132 #endif /* IMPLEMENTED */
 133 }
 134
 135 int CRYPTO_secure_allocated(const void *ptr)
 136 {
 137 #ifdef IMPLEMENTED
 138     int ret;
 139
 140     if (!secure_mem_initialized)
 141         return 0;
 142     LOCK();
 143     ret = sh_allocated(ptr);
 144     UNLOCK();
 145     return ret;
 146 #else
 147     return 0;
 148 #endif /* IMPLEMENTED */
 149 }
 150
 151 /* END OF PAGE ...
 152
 153    ... START OF PAGE */
 154
 155 /*
 156  * SECURE HEAP IMPLEMENTATION
 157  */
 158 #ifdef IMPLEMENTED
 159
 160
 161 /*
 162  * The implementation provided here uses a fixed-sized mmap() heap,
 163  * which is locked into memory, not written to core files, and protected
 164  * on either side by an unmapped page, which will catch pointer overruns
 165  * (or underruns) and an attempt to read data out of the secure heap.
 166  * Free'd memory is zero'd or otherwise cleansed.
 167  *
 168  * This is a pretty standard buddy allocator.  We keep areas in a multiple
 169  * of "sh.minsize" units.  The freelist and bitmaps are kept separately,
 170  * so all (and only) data is kept in the mmap'd heap.
 171  *
 172  * This code assumes eight-bit bytes.  The numbers 3 and 7 are all over the
 173  * place.
 174  */
 175
 176 # define TESTBIT(t, b)  (t[(b) >> 3] &  (1 << ((b) & 7)))
 177 # define SETBIT(t, b)   (t[(b) >> 3] |= (1 << ((b) & 7)))
 178 # define CLEARBIT(t, b) (t[(b) >> 3] &= (0xFF & ~(1 << ((b) & 7))))
 179
 180 #define WITHIN_ARENA(p) \
 181     ((char*)(p) >= sh.arena && (char*)(p) < &sh.arena[sh.arena_size])
 182 #define WITHIN_FREELIST(p) \
 183     ((char*)(p) >= (char*)sh.freelist && (char*)(p) < (char*)&sh.freelist[sh.freelist_size])
 184
 185
 186 typedef struct sh_list_st
 187 {
 188     struct sh_list_st *next;
 189     struct sh_list_st **p_next;
 190 } SH_LIST;
 191
 192 typedef struct sh_st
 193 {
 194     char* map_result;
 195     size_t map_size;
 196     char *arena;
 197     int arena_size;
 198     char **freelist;
 199     int freelist_size;
 200     int minsize;
 201     unsigned char *bittable;
 202     unsigned char *bitmalloc;
 203     int bittable_size; /* size in bits */
 204 } SH;
 205
 206 static SH sh;
 207
 208 static int sh_getlist(char *ptr)
 209 {
 210     int list = sh.freelist_size - 1;
 211     int bit = (sh.arena_size + ptr - sh.arena) / sh.minsize;
 212
 213     for (; bit; bit >>= 1, list--) {
 214         if (TESTBIT(sh.bittable, bit))
 215             break;
 216         OPENSSL_assert((bit & 1) == 0);
 217     }
 218
 219     return list;
 220 }
 221
 222
 223 static int sh_testbit(char *ptr, int list, unsigned char *table)
 224 {
 225     int bit;
 226
 227     OPENSSL_assert(list >= 0 && list < sh.freelist_size);
 228     OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
 229     bit = (1 << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
 230     OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
 231     return TESTBIT(table, bit);
 232 }
 233
 234 static void sh_clearbit(char *ptr, int list, unsigned char *table)
 235 {
 236     int bit;
 237
 238     OPENSSL_assert(list >= 0 && list < sh.freelist_size);
 239     OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
 240     bit = (1 << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
 241     OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
 242     OPENSSL_assert(TESTBIT(table, bit));
 243     CLEARBIT(table, bit);
 244 }
 245
 246 static void sh_setbit(char *ptr, int list, unsigned char *table)
 247 {
 248     int bit;
 249
 250     OPENSSL_assert(list >= 0 && list < sh.freelist_size);
 251     OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
 252     bit = (1 << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
 253     OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
 254     OPENSSL_assert(!TESTBIT(table, bit));
 255     SETBIT(table, bit);
 256 }
 257
 258 static void sh_add_to_list(char **list, char *ptr)
 259 {
 260     SH_LIST *temp;
 261
 262     OPENSSL_assert(WITHIN_FREELIST(list));
 263     OPENSSL_assert(WITHIN_ARENA(ptr));
 264
 265     temp = (SH_LIST *)ptr;
 266     temp->next = *(SH_LIST **)list;
 267     OPENSSL_assert(temp->next == NULL || WITHIN_ARENA(temp->next));
 268     temp->p_next = (SH_LIST **)list;
 269
 270     if (temp->next != NULL) {
 271         OPENSSL_assert((char **)temp->next->p_next == list);
 272         temp->next->p_next = &(temp->next);
 273     }
 274
 275     *list = ptr;
 276 }
 277
 278 static void sh_remove_from_list(char *ptr, char *list)
 279 {
 280     SH_LIST *temp, *temp2;
 281
 282     temp = (SH_LIST *)ptr;
 283     if (temp->next != NULL)
 284         temp->next->p_next = temp->p_next;
 285     *temp->p_next = temp->next;
 286     if (temp->next == NULL)
 287         return;
 288
 289     temp2 = temp->next;
 290     OPENSSL_assert(WITHIN_FREELIST(temp2->p_next) || WITHIN_ARENA(temp2->p_next));
 291 }
 292
 293
 294 static int sh_init(size_t size, int minsize)
 295 {
 296     int i, ret;
 297     size_t pgsize;
 298     size_t aligned;
 299
 300     memset(&sh, 0, sizeof sh);
 301
 302     /* make sure size and minsize are powers of 2 */
 303     OPENSSL_assert(size > 0);
 304     OPENSSL_assert((size & (size - 1)) == 0);
 305     OPENSSL_assert(minsize > 0);
 306     OPENSSL_assert((minsize & (minsize - 1)) == 0);
 307     if (size <= 0 || (size & (size - 1)) != 0)
 308         goto err;
 309     if (minsize <= 0 || (minsize & (minsize - 1)) != 0)
 310         goto err;
 311
 312     sh.arena_size = size;
 313     sh.minsize = minsize;
 314     sh.bittable_size = (sh.arena_size / sh.minsize) * 2;
 315
 316     sh.freelist_size = -1;
 317     for (i = sh.bittable_size; i; i >>= 1)
 318         sh.freelist_size++;
 319
 320     sh.freelist = OPENSSL_zalloc(sh.freelist_size * sizeof (char *));
 321     OPENSSL_assert(sh.freelist != NULL);
 322     if (sh.freelist == NULL)
 323         goto err;
 324
 325     sh.bittable = OPENSSL_zalloc(sh.bittable_size >> 3);
 326     OPENSSL_assert(sh.bittable != NULL);
 327     if (sh.bittable == NULL)
 328         goto err;
 329
 330     sh.bitmalloc = OPENSSL_zalloc(sh.bittable_size >> 3);
 331     OPENSSL_assert(sh.bitmalloc != NULL);
 332     if (sh.bitmalloc == NULL)
 333         goto err;
 334
 335     /* Allocate space for heap, and two extra pages as guards */
 336 #ifdef _SC_PAGE_SIZE
 337     pgsize = (size_t)sysconf(_SC_PAGE_SIZE);
 338 #else
 339     pgsize = PAGE_SIZE;
 340 #endif
 341     sh.map_size = pgsize + sh.arena_size + pgsize;
 342     if (1) {
 343 #ifdef MAP_ANON
 344         sh.map_result = mmap(NULL, sh.map_size,
 345                              PROT_READ|PROT_WRITE, MAP_ANON|MAP_PRIVATE, -1, 0);
 346     } else {
 347 #endif
 348         int fd;
 349
 350         sh.map_result = MAP_FAILED;
 351         if ((fd = open("/dev/zero", O_RDWR)) >= 0) {
 352             sh.map_result = mmap(NULL, sh.map_size,
 353                                  PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
 354             close(fd);
 355         }
 356     }
 357     OPENSSL_assert(sh.map_result != MAP_FAILED);
 358     if (sh.map_result == MAP_FAILED)
 359         goto err;
 360     sh.arena = (char *)(sh.map_result + pgsize);
 361     sh_setbit(sh.arena, 0, sh.bittable);
 362     sh_add_to_list(&sh.freelist[0], sh.arena);
 363
 364     /* Now try to add guard pages and lock into memory. */
 365     ret = 1;
 366
 367     /* Starting guard is already aligned from mmap. */
 368     if (mprotect(sh.map_result, pgsize, PROT_NONE) < 0)
 369         ret = 2;
 370
 371     /* Ending guard page - need to round up to page boundary */
 372     aligned = (pgsize + sh.arena_size + (pgsize - 1)) & ~(pgsize - 1);
 373     if (mprotect(sh.map_result + aligned, pgsize, PROT_NONE) < 0)
 374         ret = 2;
 375
 376     if (mlock(sh.arena, sh.arena_size) < 0)
 377         ret = 2;
 378 #ifdef MADV_DONTDUMP
 379     if (madvise(sh.arena, sh.arena_size, MADV_DONTDUMP) < 0)
 380         ret = 2;
 381 #endif
 382
 383     return ret;
 384
 385  err:
 386     sh_done();
 387     return 0;
 388 }
 389
 390 static void sh_done()
 391 {
 392     OPENSSL_free(sh.freelist);
 393     OPENSSL_free(sh.bittable);
 394     OPENSSL_free(sh.bitmalloc);
 395     if (sh.map_result != NULL && sh.map_size)
 396         munmap(sh.map_result, sh.map_size);
 397     memset(&sh, 0, sizeof sh);
 398 }
 399
 400 static int sh_allocated(const char *ptr)
 401 {
 402     return WITHIN_ARENA(ptr) ? 1 : 0;
 403 }
 404
 405 static char *sh_find_my_buddy(char *ptr, int list)
 406 {
 407     int bit;
 408     char *chunk = NULL;
 409
 410     bit = (1 << list) + (ptr - sh.arena) / (sh.arena_size >> list);
 411     bit ^= 1;
 412
 413     if (TESTBIT(sh.bittable, bit) && !TESTBIT(sh.bitmalloc, bit))
 414         chunk = sh.arena + ((bit & ((1 << list) - 1)) * (sh.arena_size >> list));
 415
 416     return chunk;
 417 }
 418
 419 static char *sh_malloc(size_t size)
 420 {
 421     int list, slist;
 422     size_t i;
 423     char *chunk;
 424
 425     list = sh.freelist_size - 1;
 426     for (i = sh.minsize; i < size; i <<= 1)
 427         list--;
 428     if (list < 0)
 429         return NULL;
 430
 431     /* try to find a larger entry to split */
 432     for (slist = list; slist >= 0; slist--)
 433         if (sh.freelist[slist] != NULL)
 434             break;
 435     if (slist < 0)
 436         return NULL;
 437
 438     /* split larger entry */
 439     while (slist != list) {
 440         char *temp = sh.freelist[slist];
 441
 442         /* remove from bigger list */
 443         OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
 444         sh_clearbit(temp, slist, sh.bittable);
 445         sh_remove_from_list(temp, sh.freelist[slist]);
 446         OPENSSL_assert(temp != sh.freelist[slist]);
 447
 448         /* done with bigger list */
 449         slist++;
 450
 451         /* add to smaller list */
 452         OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
 453         sh_setbit(temp, slist, sh.bittable);
 454         sh_add_to_list(&sh.freelist[slist], temp);
 455         OPENSSL_assert(sh.freelist[slist] == temp);
 456
 457         /* split in 2 */
 458         temp += sh.arena_size >> slist;
 459         OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
 460         sh_setbit(temp, slist, sh.bittable);
 461         sh_add_to_list(&sh.freelist[slist], temp);
 462         OPENSSL_assert(sh.freelist[slist] == temp);
 463
 464         OPENSSL_assert(temp-(sh.arena_size >> slist) == sh_find_my_buddy(temp, slist));
 465     }
 466
 467     /* peel off memory to hand back */
 468     chunk = sh.freelist[list];
 469     OPENSSL_assert(sh_testbit(chunk, list, sh.bittable));
 470     sh_setbit(chunk, list, sh.bitmalloc);
 471     sh_remove_from_list(chunk, sh.freelist[list]);
 472
 473     OPENSSL_assert(WITHIN_ARENA(chunk));
 474
 475     return chunk;
 476 }
 477
 478 static void sh_free(char *ptr)
 479 {
 480     int list;
 481     char *buddy;
 482
 483     if (ptr == NULL)
 484         return;
 485     OPENSSL_assert(WITHIN_ARENA(ptr));
 486     if (!WITHIN_ARENA(ptr))
 487         return;
 488
 489     list = sh_getlist(ptr);
 490     OPENSSL_assert(sh_testbit(ptr, list, sh.bittable));
 491     sh_clearbit(ptr, list, sh.bitmalloc);
 492     sh_add_to_list(&sh.freelist[list], ptr);
 493
 494     /* Try to coalesce two adjacent free areas. */
 495     while ((buddy = sh_find_my_buddy(ptr, list)) != NULL) {
 496         OPENSSL_assert(ptr == sh_find_my_buddy(buddy, list));
 497         OPENSSL_assert(ptr != NULL);
 498         OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
 499         sh_clearbit(ptr, list, sh.bittable);
 500         sh_remove_from_list(ptr, sh.freelist[list]);
 501         OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
 502         sh_clearbit(buddy, list, sh.bittable);
 503         sh_remove_from_list(buddy, sh.freelist[list]);
 504
 505         list--;
 506
 507         if (ptr > buddy)
 508             ptr = buddy;
 509
 510         OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
 511         sh_setbit(ptr, list, sh.bittable);
 512         sh_add_to_list(&sh.freelist[list], ptr);
 513         OPENSSL_assert(sh.freelist[list] == ptr);
 514     }
 515 }
 516
 517 static int sh_actual_size(char *ptr)
 518 {
 519     int list;
 520
 521     OPENSSL_assert(WITHIN_ARENA(ptr));
 522     if (!WITHIN_ARENA(ptr))
 523         return 0;
 524     list = sh_getlist(ptr);
 525     OPENSSL_assert(sh_testbit(ptr, list, sh.bittable));
 526     return sh.arena_size / (1 << list);
 527 }
 528 #endif /* IMPLEMENTED */