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