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