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