nearly ready for 0.3.0
[gnupg.git] / util / secmem.c
1 /* secmem.c  -  memory allocation from a secure heap
2  *      Copyright (C) 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG 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  * GNUPG 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 = -1; 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           #ifdef EAGAIN  /* OpenBSD returns this */
87             && errno != EAGAIN
88           #endif
89           )
90             log_error("canĀ“t lock memory: %s\n", strerror(err));
91         show_warning = 1;
92     }
93
94   #else
95     log_info("Please note that you don't have secure memory on this system\n");
96   #endif
97 }
98
99
100 static void
101 init_pool( size_t n)
102 {
103     poolsize = n;
104
105     if( disable_secmem )
106         log_bug("secure memory is disabled");
107
108   #if HAVE_MMAP && defined(MAP_ANONYMOUS)
109     poolsize = (poolsize + 4095) & ~4095;
110     pool = mmap( 0, poolsize, PROT_READ|PROT_WRITE,
111                               MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
112     if( pool == (void*)-1 )
113         log_error("can't mmap pool of %u bytes: %s - using malloc\n",
114                             (unsigned)poolsize, strerror(errno));
115     else {
116         pool_is_mmapped = 1;
117         pool_okay = 1;
118     }
119
120   #endif
121     if( !pool_okay ) {
122         pool = malloc( poolsize );
123         if( !pool )
124             log_fatal("can't allocate memory pool of %u bytes\n",
125                                                        (unsigned)poolsize);
126         else
127             pool_okay = 1;
128     }
129     lock_pool( pool, poolsize );
130     poollen = 0;
131 }
132
133
134 /* concatenate unused blocks */
135 static void
136 compress_pool(void)
137 {
138
139 }
140
141 void
142 secmem_set_flags( unsigned flags )
143 {
144     no_warning = flags & 1;
145 }
146
147 unsigned
148 secmem_get_flags(void)
149 {
150     return no_warning ? 1:0;
151 }
152
153 void
154 secmem_init( size_t n )
155 {
156     if( !n )
157         disable_secmem=1;
158     else {
159         if( n < DEFAULT_POOLSIZE )
160             n = DEFAULT_POOLSIZE;
161         if( !pool_okay )
162             init_pool(n);
163         else
164             log_error("Oops, secure memory pool already initialized\n");
165     }
166 }
167
168
169 void *
170 secmem_malloc( size_t size )
171 {
172     MEMBLOCK *mb, *mb2;
173     int compressed=0;
174
175     if( !pool_okay )
176         log_bug("secmem not initialized\n");
177     if( show_warning ) {
178         show_warning = 0;
179         if( !no_warning )
180             log_info(_("Warning: using insecure memory!\n"));
181     }
182
183     /* blocks are always a multiple of 32 */
184     size += sizeof(MEMBLOCK);
185     size = ((size + 31) / 32) * 32;
186
187   retry:
188     /* try to get it from the used blocks */
189     for(mb = unused_blocks,mb2=NULL; mb; mb2=mb, mb = mb->u.next )
190         if( mb->size >= size ) {
191             if( mb2 )
192                 mb2->u.next = mb->u.next;
193             else
194                 unused_blocks = mb->u.next;
195             goto leave;
196         }
197     /* allocate a new block */
198     if( (poollen + size <= poolsize) ) {
199         mb = pool + poollen;
200         poollen += size;
201         mb->size = size;
202     }
203     else if( !compressed ) {
204         compressed=1;
205         compress_pool();
206         goto retry;
207     }
208     else
209         return NULL;
210
211   leave:
212     cur_alloced += mb->size;
213     cur_blocks++;
214     if( cur_alloced > max_alloced )
215         max_alloced = cur_alloced;
216     if( cur_blocks > max_blocks )
217         max_blocks = cur_blocks;
218     return &mb->u.d;
219 }
220
221
222 void *
223 secmem_realloc( void *p, size_t newsize )
224 {
225     MEMBLOCK *mb;
226     size_t size;
227     void *a;
228
229     mb = (MEMBLOCK*)((char*)p - ((size_t) &((MEMBLOCK*)0)->u.d));
230     size = mb->size;
231     if( newsize < size )
232         return p; /* it is easier not to shrink the memory */
233     a = secmem_malloc( newsize );
234     memcpy(a, p, size);
235     memset(a+size, 0, newsize-size);
236     secmem_free(p);
237     return a;
238 }
239
240
241 void
242 secmem_free( void *a )
243 {
244     MEMBLOCK *mb;
245     size_t size;
246
247     if( !a )
248         return;
249
250     mb = (MEMBLOCK*)((char*)a - ((size_t) &((MEMBLOCK*)0)->u.d));
251     size = mb->size;
252     memset(mb, 0xff, size );
253     memset(mb, 0xaa, size );
254     memset(mb, 0x55, size );
255     memset(mb, 0x00, size );
256     mb->size = size;
257     mb->u.next = unused_blocks;
258     unused_blocks = mb;
259     cur_blocks--;
260     cur_alloced -= size;
261 }
262
263 int
264 m_is_secure( const void *p )
265 {
266     return p >= pool && p < (pool+poolsize);
267 }
268
269 void
270 secmem_term()
271 {
272     if( !pool_okay )
273         return;
274
275     memset( pool, 0xff, poolsize);
276     memset( pool, 0xaa, poolsize);
277     memset( pool, 0x55, poolsize);
278     memset( pool, 0x00, poolsize);
279   #if HAVE_MMAP
280     if( pool_is_mmapped )
281         munmap( pool, poolsize );
282   #endif
283     pool = NULL;
284     pool_okay = 0;
285     poolsize=0;
286     poollen=0;
287     unused_blocks=NULL;
288 }
289
290
291 void
292 secmem_dump_stats()
293 {
294     if( disable_secmem )
295         return;
296     fprintf(stderr,
297                 "secmem usage: %u/%u bytes in %u/%u blocks of pool %lu/%lu\n",
298                 cur_alloced, max_alloced, cur_blocks, max_blocks,
299                 (ulong)poollen, (ulong)poolsize );
300 }
301