crypto/mem_sec.c

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