New release
[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   #include <fcntl.h>
32 #endif
33
34 #include "types.h"
35 #include "memory.h"
36 #include "util.h"
37 #include "i18n.h"
38
39 #if defined(MAP_ANON) && !defined(MAP_ANONYMOUS)
40   #define MAP_ANONYMOUS MAP_ANON
41 #endif
42
43 #define DEFAULT_POOLSIZE 8196
44
45 typedef struct memblock_struct MEMBLOCK;
46 struct memblock_struct {
47     unsigned size;
48     union {
49         MEMBLOCK *next;
50         long align_dummy;
51         char d[1];
52     } u;
53 };
54
55
56
57 static void  *pool;
58 static int   pool_okay;
59 static int   pool_is_mmapped;
60 static size_t poolsize; /* allocated length */
61 static size_t poollen;  /* used length */
62 static MEMBLOCK *unused_blocks;
63 static unsigned max_alloced;
64 static unsigned cur_alloced;
65 static unsigned max_blocks;
66 static unsigned cur_blocks;
67 static int disable_secmem;
68 static int show_warning;
69 static int no_warning;
70
71 static void
72 lock_pool( void *p, size_t n )
73 {
74   #ifdef HAVE_MLOCK
75     uid_t uid;
76     int err;
77
78     err = mlock( p, n );
79     if( err && errno )
80         err = errno;
81
82     uid = getuid();
83     if( uid && !geteuid() ) {
84         if( setuid( uid ) )
85             log_fatal("failed to reset uid: %s\n", strerror(errno));
86     }
87
88     if( err ) {
89         if( errno != EPERM
90           #ifdef EAGAIN  /* OpenBSD returns this */
91             && errno != EAGAIN
92           #endif
93           )
94             log_error("canĀ“t lock memory: %s\n", strerror(err));
95         show_warning = 1;
96     }
97
98   #else
99     log_info("Please note that you don't have secure memory on this system\n");
100   #endif
101 }
102
103
104 static void
105 init_pool( size_t n)
106 {
107     size_t pgsize;
108
109     poolsize = n;
110
111     if( disable_secmem )
112         log_bug("secure memory is disabled");
113
114   #ifdef HAVE_GETPAGESIZE
115     pgsize = getpagesize();
116   #else
117     pgsize = 4096;
118   #endif
119
120   #if HAVE_MMAP
121     poolsize = (poolsize + pgsize -1 ) & ~(pgsize-1);
122     #ifdef MAP_ANONYMOUS
123        pool = mmap( 0, poolsize, PROT_READ|PROT_WRITE,
124                                  MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
125     #else /* map /dev/zero instead */
126     {   int fd;
127
128         fd = open("/dev/zero", O_RDWR);
129         if( fd == -1 ) {
130             log_error("can't open /dev/zero: %s\n", strerror(errno) );
131             pool = (void*)-1;
132         }
133         else {
134             pool = mmap( 0, poolsize, PROT_READ|PROT_WRITE,
135                                       MAP_PRIVATE, fd, 0);
136         }
137     }
138     #endif
139     if( pool == (void*)-1 )
140         log_error("can't mmap pool of %u bytes: %s - using malloc\n",
141                             (unsigned)poolsize, strerror(errno));
142     else {
143         pool_is_mmapped = 1;
144         pool_okay = 1;
145     }
146
147   #endif
148     if( !pool_okay ) {
149         pool = malloc( poolsize );
150         if( !pool )
151             log_fatal("can't allocate memory pool of %u bytes\n",
152                                                        (unsigned)poolsize);
153         else
154             pool_okay = 1;
155     }
156     lock_pool( pool, poolsize );
157     poollen = 0;
158 }
159
160
161 /* concatenate unused blocks */
162 static void
163 compress_pool(void)
164 {
165
166 }
167
168 void
169 secmem_set_flags( unsigned flags )
170 {
171     no_warning = flags & 1;
172 }
173
174 unsigned
175 secmem_get_flags(void)
176 {
177     return no_warning ? 1:0;
178 }
179
180 void
181 secmem_init( size_t n )
182 {
183     if( !n ) {
184         uid_t uid;
185
186         disable_secmem=1;
187         uid = getuid();
188         if( uid != geteuid() ) {
189             if( setuid( uid ) )
190                 log_fatal("failed to drop setuid\n" );
191         }
192     }
193     else {
194         if( n < DEFAULT_POOLSIZE )
195             n = DEFAULT_POOLSIZE;
196         if( !pool_okay )
197             init_pool(n);
198         else
199             log_error("Oops, secure memory pool already initialized\n");
200     }
201 }
202
203
204 void *
205 secmem_malloc( size_t size )
206 {
207     MEMBLOCK *mb, *mb2;
208     int compressed=0;
209
210     if( !pool_okay )
211         log_bug("secmem not initialized\n");
212     if( show_warning ) {
213         show_warning = 0;
214         if( !no_warning )
215             log_info(_("Warning: using insecure memory!\n"));
216     }
217
218     /* blocks are always a multiple of 32 */
219     size += sizeof(MEMBLOCK);
220     size = ((size + 31) / 32) * 32;
221
222   retry:
223     /* try to get it from the used blocks */
224     for(mb = unused_blocks,mb2=NULL; mb; mb2=mb, mb = mb->u.next )
225         if( mb->size >= size ) {
226             if( mb2 )
227                 mb2->u.next = mb->u.next;
228             else
229                 unused_blocks = mb->u.next;
230             goto leave;
231         }
232     /* allocate a new block */
233     if( (poollen + size <= poolsize) ) {
234         mb = (void*)((char*)pool + poollen);
235         poollen += size;
236         mb->size = size;
237     }
238     else if( !compressed ) {
239         compressed=1;
240         compress_pool();
241         goto retry;
242     }
243     else
244         return NULL;
245
246   leave:
247     cur_alloced += mb->size;
248     cur_blocks++;
249     if( cur_alloced > max_alloced )
250         max_alloced = cur_alloced;
251     if( cur_blocks > max_blocks )
252         max_blocks = cur_blocks;
253     return &mb->u.d;
254 }
255
256
257 void *
258 secmem_realloc( void *p, size_t newsize )
259 {
260     MEMBLOCK *mb;
261     size_t size;
262     void *a;
263
264     mb = (MEMBLOCK*)((char*)p - ((size_t) &((MEMBLOCK*)0)->u.d));
265     size = mb->size;
266     if( newsize < size )
267         return p; /* it is easier not to shrink the memory */
268     a = secmem_malloc( newsize );
269     memcpy(a, p, size);
270     memset((char*)a+size, 0, newsize-size);
271     secmem_free(p);
272     return a;
273 }
274
275
276 void
277 secmem_free( void *a )
278 {
279     MEMBLOCK *mb;
280     size_t size;
281
282     if( !a )
283         return;
284
285     mb = (MEMBLOCK*)((char*)a - ((size_t) &((MEMBLOCK*)0)->u.d));
286     size = mb->size;
287     memset(mb, 0xff, size );
288     memset(mb, 0xaa, size );
289     memset(mb, 0x55, size );
290     memset(mb, 0x00, size );
291     mb->size = size;
292     mb->u.next = unused_blocks;
293     unused_blocks = mb;
294     cur_blocks--;
295     cur_alloced -= size;
296 }
297
298 int
299 m_is_secure( const void *p )
300 {
301     return p >= pool && p < (void*)((char*)pool+poolsize);
302 }
303
304 void
305 secmem_term()
306 {
307     if( !pool_okay )
308         return;
309
310     memset( pool, 0xff, poolsize);
311     memset( pool, 0xaa, poolsize);
312     memset( pool, 0x55, poolsize);
313     memset( pool, 0x00, poolsize);
314   #if HAVE_MMAP
315     if( pool_is_mmapped )
316         munmap( pool, poolsize );
317   #endif
318     pool = NULL;
319     pool_okay = 0;
320     poolsize=0;
321     poollen=0;
322     unused_blocks=NULL;
323 }
324
325
326 void
327 secmem_dump_stats()
328 {
329     if( disable_secmem )
330         return;
331     fprintf(stderr,
332                 "secmem usage: %u/%u bytes in %u/%u blocks of pool %lu/%lu\n",
333                 cur_alloced, max_alloced, cur_blocks, max_blocks,
334                 (ulong)poollen, (ulong)poolsize );
335 }
336