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