ready to release 0.4.3
[gnupg.git] / g10 / status.c
1 /* status.c
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 <unistd.h>
27 #ifdef USE_SHM_COPROCESSING
28   #ifdef HAVE_SYS_IPC_H
29     #include <sys/ipc.h>
30   #endif
31   #ifdef HAVE_SYS_SHM_H
32     #include <sys/shm.h>
33   #endif
34   #if defined(HAVE_MLOCK)
35     #include <sys/mman.h>
36   #endif
37 #endif
38 #include "util.h"
39 #include "status.h"
40 #include "ttyio.h"
41 #include "options.h"
42 #include "main.h"
43 #include "i18n.h"
44
45 static int fd = -1;
46 #ifdef USE_SHM_COPROCESSING
47   static int shm_id = -1;
48   static volatile char *shm_area;
49   static size_t shm_size;
50   static int shm_is_locked;
51 #endif /*USE_SHM_COPROCESSING*/
52
53 void
54 set_status_fd ( int newfd )
55 {
56     fd = newfd;
57 }
58
59
60 void
61 write_status ( int no )
62 {
63     write_status_text( no, NULL );
64 }
65
66 void
67 write_status_text ( int no, const char *text)
68 {
69     const char *s;
70
71     if( fd == -1 )
72         return;  /* not enabled */
73
74     switch( no ) {
75       case STATUS_ENTER  : s = "ENTER\n"; break;
76       case STATUS_LEAVE  : s = "LEAVE\n"; break;
77       case STATUS_ABORT  : s = "ABORT\n"; break;
78       case STATUS_GOODSIG: s = "GOODSIG\n"; break;
79       case STATUS_SIGEXPIRED: s = "SIGEXPIRED\n"; break;
80       case STATUS_KEYREVOKED: s = "KEYREVOKED\n"; break;
81       case STATUS_BADSIG : s = "BADSIG\n"; break;
82       case STATUS_ERRSIG : s = "ERRSIG\n"; break;
83       case STATUS_BADARMOR : s = "BADARMOR\n"; break;
84       case STATUS_RSA_OR_IDEA : s= "RSA_OR_IDEA\n"; break;
85       case STATUS_TRUST_UNDEFINED: s = "TRUST_UNDEFINED\n"; break;
86       case STATUS_TRUST_NEVER    : s = "TRUST_NEVER\n"; break;
87       case STATUS_TRUST_MARGINAL : s = "TRUST_MARGINAL\n"; break;
88       case STATUS_TRUST_FULLY    : s = "TRUST_FULLY\n"; break;
89       case STATUS_TRUST_ULTIMATE : s = "TRUST_ULTIMATE\n"; break;
90       case STATUS_SHM_INFO       : s = "SHM_INFO\n"; break;
91       case STATUS_SHM_GET        : s = "SHM_GET\n"; break;
92       case STATUS_SHM_GET_BOOL   : s = "SHM_GET_BOOL\n"; break;
93       case STATUS_SHM_GET_HIDDEN : s = "SHM_GET_HIDDEN\n"; break;
94       case STATUS_NEED_PASSPHRASE: s = "NEED_PASSPHRASE\n"; break;
95       default: s = "?\n"; break;
96     }
97
98     write( fd, "[GNUPG:] ", 9 );
99     if( text ) {
100         write( fd, s, strlen(s)-1 );
101         write( fd, " ", 1 );
102         write( fd, text, strlen(text) );
103         write( fd, "\n", 1 );
104     }
105     else
106         write( fd, s, strlen(s) );
107 }
108
109
110 #ifdef USE_SHM_COPROCESSING
111
112 #ifndef IPC_RMID_DEFERRED_RELEASE
113 static void
114 remove_shmid( void )
115 {
116     if( shm_id != -1 ) {
117         shmctl ( shm_id, IPC_RMID, 0);
118         shm_id = -1;
119     }
120 }
121 #endif
122
123 void
124 init_shm_coprocessing ( ulong requested_shm_size, int lock_mem )
125 {
126     char buf[100];
127     struct shmid_ds shmds;
128
129   #ifndef IPC_RMID_DEFERRED_RELEASE
130     atexit( remove_shmid );
131   #endif
132     requested_shm_size = (requested_shm_size + 4095) & ~4095;
133     if ( requested_shm_size > 2 * 4096 )
134         log_fatal("too much shared memory requested; only 8k are allowed\n");
135     shm_size = 4096 /* one page for us */ + requested_shm_size;
136
137     shm_id = shmget( IPC_PRIVATE, shm_size, IPC_CREAT | 0700 );
138     if ( shm_id == -1 )
139         log_fatal("can't get %uk of shared memory: %s\n",
140                                 (unsigned)shm_size/1024, strerror(errno));
141     shm_area = shmat( shm_id, 0, 0 );
142     if ( shm_area == (char*)-1 )
143         log_fatal("can't attach %uk shared memory: %s\n",
144                                 (unsigned)shm_size/1024, strerror(errno));
145     log_info("mapped %uk shared memory at %p, id=%d\n",
146                             (unsigned)shm_size/1024, shm_area, shm_id );
147     if( lock_mem ) {
148       #ifdef IPC_HAVE_SHM_LOCK
149         if ( shmctl (shm_id, SHM_LOCK, 0) )
150             log_info("locking shared memory %d failed: %s\n",
151                                 shm_id, strerror(errno));
152         else
153             shm_is_locked = 1;
154       #elif defined(HAVE_MLOCK) && !defined(HAVE_BROKEN_MLOCK)
155         if ( mlock (shm_area, shm_size) )
156             log_info("locking shared memory %d failed: %s\n",
157                                 shm_id, strerror(errno));
158         else
159             shm_is_locked = 1;
160       #else
161         log_info("Locking shared memory %d failed: No way to do it\n", shm_id );
162       #endif
163     }
164
165
166
167   #ifdef IPC_RMID_DEFERRED_RELEASE
168     if( shmctl( shm_id, IPC_RMID, 0) )
169         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
170                                             shm_id, strerror(errno));
171   #endif
172
173     if( shmctl( shm_id, IPC_STAT, &shmds ) )
174         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
175                                             shm_id, strerror(errno));
176     if( shmds.shm_perm.uid != getuid() ) {
177         shmds.shm_perm.uid = getuid();
178         if( shmctl( shm_id, IPC_SET, &shmds ) )
179             log_fatal("shmctl IPC_SET of %d failed: %s\n",
180                                                 shm_id, strerror(errno));
181     }
182
183     /* write info; Protocol version, id, size, locked size */
184     sprintf( buf, "pv=1 pid=%d shmid=%d sz=%u lz=%u", (int)getpid(),
185             shm_id, (unsigned)shm_size, shm_is_locked? (unsigned)shm_size:0 );
186     write_status_text( STATUS_SHM_INFO, buf );
187 }
188
189
190 /****************
191  * Request a string from client
192  * If bool, returns static string on true (do not free) or NULL for false
193  */
194 static char *
195 do_shm_get( const char *keyword, int hidden, int bool )
196 {
197     size_t n;
198     byte *p;
199     char *string;
200
201     if( !shm_area )
202         BUG();
203
204     shm_area[0] = 0;  /* msb of length of control block */
205     shm_area[1] = 32; /* and lsb */
206     shm_area[2] = 1;  /* indicate that we are waiting on a reply */
207     shm_area[3] = 0;  /* clear data available flag */
208
209     write_status_text( bool? STATUS_SHM_GET_BOOL :
210                        hidden? STATUS_SHM_GET_HIDDEN : STATUS_SHM_GET, keyword );
211
212     do {
213         pause_on_sigusr(1);
214         if( shm_area[0] || shm_area[1] != 32 || shm_area[2] != 1 )
215             log_fatal("client modified shm control block - abort\n");
216     } while( !shm_area[3] );
217     shm_area[2] = 0; /* reset request flag */
218     p = (byte*)shm_area+32;
219     n = p[0] << 8 | p[1];
220     p += 2;
221     if( n+32+2+1 > 4095 )
222         log_fatal("client returns too large data (%u bytes)\n", (unsigned)n );
223
224     if( bool )
225         return p[0]? "" : NULL;
226
227     string = hidden? m_alloc_secure( n+1 ) : m_alloc( n+1 );
228     memcpy(string, p, n );
229     string[n] = 0; /* make sure it is a string */
230     if( hidden ) /* invalidate the memory */
231         memset( p, 0, n );
232
233     return string;
234 }
235
236 #endif /* USE_SHM_COPROCESSING */
237
238 static void
239 display_help( const char *keyword )
240 {
241     const char *p;
242     int hint = 0;
243
244     tty_kill_prompt();
245     if( !keyword ) {
246         tty_printf(_("No help available") );
247         hint++;
248     }
249     else {
250         p = _(keyword);
251         if( !strcmp( p, keyword ) ) {
252             tty_printf(_("No help available for '%s'"), keyword );
253             hint++;
254         }
255         else
256             tty_printf("%s", p );
257     }
258     tty_printf("\n");
259     if( hint )
260         tty_printf("You should set your LANG variable to a valid value.\n"
261                    "Set LANG to \"en\" to see the English help texts.\n" );
262 }
263
264
265 int
266 cpr_enabled()
267 {
268   #ifdef USE_SHM_COPROCESSING
269     if( opt.shm_coprocess )
270         return 1;
271   #endif
272     return 0;
273 }
274
275 char *
276 cpr_get( const char *keyword, const char *prompt )
277 {
278     char *p;
279
280   #ifdef USE_SHM_COPROCESSING
281     if( opt.shm_coprocess )
282         return do_shm_get( keyword, 0, 0 );
283   #endif
284     for(;;) {
285         p = tty_get( prompt );
286         if( *p == '?' && !p[1] ) {
287             m_free(p);
288             display_help( keyword );
289         }
290         else
291             return p;
292     }
293 }
294
295 char *
296 cpr_get_hidden( const char *keyword, const char *prompt )
297 {
298     char *p;
299
300   #ifdef USE_SHM_COPROCESSING
301     if( opt.shm_coprocess )
302         return do_shm_get( keyword, 1, 0 );
303   #endif
304     for(;;) {
305         p = tty_get_hidden( prompt );
306         if( *p == '?' && !p[1] ) {
307             m_free(p);
308             display_help( keyword );
309         }
310         else
311             return p;
312     }
313 }
314
315 void
316 cpr_kill_prompt(void)
317 {
318   #ifdef USE_SHM_COPROCESSING
319     if( opt.shm_coprocess )
320         return;
321   #endif
322     return tty_kill_prompt();
323 }
324
325 int
326 cpr_get_answer_is_yes( const char *keyword, const char *prompt )
327 {
328     int yes;
329     char *p;
330
331   #ifdef USE_SHM_COPROCESSING
332     if( opt.shm_coprocess )
333         return !!do_shm_get( keyword, 0, 1 );
334   #endif
335     for(;;) {
336         p = tty_get( prompt );
337         trim_spaces(p); /* it is okay to do this here */
338         if( *p == '?' && !p[1] ) {
339             m_free(p);
340             display_help( keyword );
341         }
342         else {
343             tty_kill_prompt();
344             yes = answer_is_yes(p);
345             m_free(p);
346             return yes;
347         }
348     }
349 }
350