bug fixes
[gnupg.git] / util / secmem.c
1 /* secmem.c  -  memory allocation from a secure heap
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * G10 is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <stdarg.h>
27 #if defined(HAVE_MLOCK) || defined(HAVE_MMAP)
28   #include <unistd.h>
29   #include <sys/mman.h>
30   #include <sys/types.h>
31 #endif
32
33 #include "types.h"
34 #include "memory.h"
35 #include "util.h"
36 #include "i18n.h"
37
38
39 #define DEFAULT_POOLSIZE 8196
40
41 typedef struct memblock_struct MEMBLOCK;
42 struct memblock_struct {
43     unsigned size;
44     union {
45         MEMBLOCK *next;
46         long align_dummy;
47         char d[1];
48     } u;
49 };
50
51
52
53 static void  *pool;
54 static int   pool_okay;
55 static int   pool_is_mmapped;
56 static size_t poolsize; /* allocated length */
57 static size_t poollen;  /* used length */
58 static MEMBLOCK *unused_blocks;
59 static unsigned max_alloced;
60 static unsigned cur_alloced;
61 static unsigned max_blocks;
62 static unsigned cur_blocks;
63 static int disable_secmem;
64 static int show_warning;
65 static int no_warning;
66
67 static void
68 lock_pool( void *p, size_t n )
69 {
70   #ifdef HAVE_MLOCK
71     uid_t uid;
72     int err;
73
74     err = mlock( p, n );
75     if( err && errno )
76         err = errno;
77
78     uid = getuid();
79     if( uid && !geteuid() ) {
80         if( setuid( uid ) )
81             log_fatal("failed to reset uid: %s\n", strerror(errno));
82     }
83
84     if( err ) {
85         if( errno != EPERM )
86             log_error("can´t lock memory: %s\n", strerror(err));
87         show_warning = 1;
88     }
89
90   #else
91     log_info("Please note that you don´t have secure memory on this system\n");
92   #endif
93 }
94
95
96 static void
97 init_pool( size_t n)
98 {
99     poolsize = n;
100
101     if( disable_secmem )
102         log_bug("secure memory is disabled");
103
104   #if HAVE_MMAP && defined(MAP_ANONYMOUS)
105     poolsize = (poolsize + 4095) & ~4095;
106     pool = mmap( 0, poolsize, PROT_READ|PROT_WRITE,
107                               MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
108     if( pool == (void*)-1 )
109         log_error("can't mmap pool of %u bytes: %s - using malloc\n",
110                             (unsigned)poolsize, strerror(errno));
111     else {
112         pool_is_mmapped = 1;
113         pool_okay = 1;
114     }
115
116   #endif
117     if( !pool_okay ) {
118         pool = malloc( poolsize );
119         if( !pool )
120             log_fatal("can't allocate memory pool of %u bytes\n",
121                                                        (unsigned)poolsize);
122         else
123             pool_okay = 1;
124     }
125     lock_pool( pool, poolsize );
126     poollen = 0;
127 }
128
129
130 /* concatenate unused blocks */
131 static void
132 compress_pool(void)
133 {
134
135 }
136
137 void
138 secmem_set_flags( unsigned flags )
139 {
140     no_warning = flags & 1;
141 }
142
143 unsigned
144 secmem_get_flags(void)
145 {
146     return no_warning ? 1:0;
147 }
148
149 void
150 secmem_init( size_t n )
151 {
152     if( !n )
153         disable_secmem=1;
154     else {
155         if( n < DEFAULT_POOLSIZE )
156             n = DEFAULT_POOLSIZE;
157         if( !pool_okay )
158             init_pool(n);
159         else
160             log_error("Oops, secure memory pool already initialized\n");
161     }
162 }
163
164
165 void *
166 secmem_malloc( size_t size )
167 {
168     MEMBLOCK *mb, *mb2;
169     int compressed=0;
170
171     if( !pool_okay )
172         log_bug("secmem not initialized\n");
173     if( show_warning ) {
174         show_warning = 0;
175         if( !no_warning )
176             log_info(_("Warning: using insecure memory!\n"));
177     }
178
179     /* blocks are always a multiple of 32 */
180     size += sizeof(MEMBLOCK);
181     size = ((size + 31) / 32) * 32;
182
183   retry:
184     /* try to get it from the used blocks */
185     for(mb = unused_blocks,mb2=NULL; mb; mb2=mb, mb = mb->u.next )
186         if( mb->size >= size ) {
187             if( mb2 )
188                 mb2->u.next = mb->u.next;
189             else
190                 unused_blocks = mb->u.next;
191             goto leave;
192         }
193     /* allocate a new block */
194     if( (poollen + size <= poolsize) ) {
195         mb = pool + poollen;
196         poollen += size;
197         mb->size = size;
198     }
199     else if( !compressed ) {
200         compressed=1;
201         compress_pool();
202         goto retry;
203     }
204     else
205         return NULL;
206
207   leave:
208     cur_alloced += mb->size;
209     cur_blocks++;
210     if( cur_alloced > max_alloced )
211         max_alloced = cur_alloced;
212     if( cur_blocks > max_blocks )
213         max_blocks = cur_blocks;
214     return &mb->u.d;
215 }
216
217
218 void
219 secmem_free( void *a )
220 {
221     MEMBLOCK *mb;
222     size_t size;
223
224     if( !a )
225         return;
226
227     mb = (MEMBLOCK*)((char*)a - ((size_t) &((MEMBLOCK*)0)->u.d));
228     size = mb->size;
229     memset(mb, 0xff, size );
230     memset(mb, 0xaa, size );
231     memset(mb, 0x55, size );
232     memset(mb, 0x00, size );
233     mb->size = size;
234     mb->u.next = unused_blocks;
235     unused_blocks = mb;
236     cur_blocks--;
237     cur_alloced -= size;
238 }
239
240 void
241 secmem_term()
242 {
243     if( !pool_okay )
244         return;
245
246     memset( pool, 0xff, poolsize);
247     memset( pool, 0xaa, poolsize);
248     memset( pool, 0x55, poolsize);
249     memset( pool, 0x00, poolsize);
250   #if HAVE_MMAP
251     if( pool_is_mmapped )
252         munmap( pool, poolsize );
253   #endif
254     pool = NULL;
255     pool_okay = 0;
256     poolsize=0;
257     poollen=0;
258     unused_blocks=NULL;
259 }
260
261
262 void
263 secmem_dump_stats()
264 {
265     if( disable_secmem )
266         return;
267     fprintf(stderr,
268                 "secmem usage: %u/%u bytes in %u/%u blocks of pool %lu/%lu\n",
269                 cur_alloced, max_alloced, cur_blocks, max_blocks,
270                 (ulong)poollen, (ulong)poolsize );
271 }
272