See ChangeLog: Tue Jun 29 21:44:25 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       default: s = "?\n"; break;
119     }
120
121     write( fd, "[GNUPG:] ", 9 );
122     if( text ) {
123         write( fd, s, strlen(s)-1 );
124         write( fd, " ", 1 );
125         write( fd, text, strlen(text) );
126         write( fd, "\n", 1 );
127     }
128     else
129         write( fd, s, strlen(s) );
130 }
131
132
133 #ifdef USE_SHM_COPROCESSING
134
135 #ifndef IPC_RMID_DEFERRED_RELEASE
136 static void
137 remove_shmid( void )
138 {
139     if( shm_id != -1 ) {
140         shmctl ( shm_id, IPC_RMID, 0);
141         shm_id = -1;
142     }
143 }
144 #endif
145
146 void
147 init_shm_coprocessing ( ulong requested_shm_size, int lock_mem )
148 {
149     char buf[100];
150     struct shmid_ds shmds;
151
152   #ifndef IPC_RMID_DEFERRED_RELEASE
153     atexit( remove_shmid );
154   #endif
155     requested_shm_size = (requested_shm_size + 4095) & ~4095;
156     if ( requested_shm_size > 2 * 4096 )
157         log_fatal("too much shared memory requested; only 8k are allowed\n");
158     shm_size = 4096 /* one page for us */ + requested_shm_size;
159
160     shm_id = shmget( IPC_PRIVATE, shm_size, IPC_CREAT | 0700 );
161     if ( shm_id == -1 )
162         log_fatal("can't get %uk of shared memory: %s\n",
163                                 (unsigned)shm_size/1024, strerror(errno));
164     shm_area = shmat( shm_id, 0, 0 );
165     if ( shm_area == (char*)-1 )
166         log_fatal("can't attach %uk shared memory: %s\n",
167                                 (unsigned)shm_size/1024, strerror(errno));
168     log_debug("mapped %uk shared memory at %p, id=%d\n",
169                             (unsigned)shm_size/1024, shm_area, shm_id );
170     if( lock_mem ) {
171       #ifdef USE_CAPABILITIES
172         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
173       #endif
174       #ifdef IPC_HAVE_SHM_LOCK
175         if ( shmctl (shm_id, SHM_LOCK, 0) )
176             log_info("locking shared memory %d failed: %s\n",
177                                 shm_id, strerror(errno));
178         else
179             shm_is_locked = 1;
180       #elif defined(HAVE_MLOCK) && !defined(HAVE_BROKEN_MLOCK)
181         /* (need the cast for Solaris with Sun's workshop compilers) */
182         if ( mlock ( (char*)shm_area, shm_size) )
183             log_info("locking shared memory %d failed: %s\n",
184                                 shm_id, strerror(errno));
185         else
186             shm_is_locked = 1;
187       #else
188         log_info("Locking shared memory %d failed: No way to do it\n", shm_id );
189       #endif
190       #ifdef USE_CAPABILITIES
191         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
192       #endif
193     }
194
195
196
197   #ifdef IPC_RMID_DEFERRED_RELEASE
198     if( shmctl( shm_id, IPC_RMID, 0) )
199         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
200                                             shm_id, strerror(errno));
201   #endif
202
203     if( shmctl( shm_id, IPC_STAT, &shmds ) )
204         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
205                                             shm_id, strerror(errno));
206     if( shmds.shm_perm.uid != getuid() ) {
207         shmds.shm_perm.uid = getuid();
208         if( shmctl( shm_id, IPC_SET, &shmds ) )
209             log_fatal("shmctl IPC_SET of %d failed: %s\n",
210                                                 shm_id, strerror(errno));
211     }
212
213     /* write info; Protocol version, id, size, locked size */
214     sprintf( buf, "pv=1 pid=%d shmid=%d sz=%u lz=%u", (int)getpid(),
215             shm_id, (unsigned)shm_size, shm_is_locked? (unsigned)shm_size:0 );
216     write_status_text( STATUS_SHM_INFO, buf );
217 }
218
219
220 /****************
221  * Request a string from client
222  * If bool, returns static string on true (do not free) or NULL for false
223  */
224 static char *
225 do_shm_get( const char *keyword, int hidden, int bool )
226 {
227     size_t n;
228     byte *p;
229     char *string;
230
231     if( !shm_area )
232         BUG();
233
234     shm_area[0] = 0;  /* msb of length of control block */
235     shm_area[1] = 32; /* and lsb */
236     shm_area[2] = 1;  /* indicate that we are waiting on a reply */
237     shm_area[3] = 0;  /* clear data available flag */
238
239     write_status_text( bool? STATUS_SHM_GET_BOOL :
240                        hidden? STATUS_SHM_GET_HIDDEN : STATUS_SHM_GET, keyword );
241
242     do {
243         pause_on_sigusr(1);
244         if( shm_area[0] || shm_area[1] != 32 || shm_area[2] != 1 )
245             log_fatal("client modified shm control block - abort\n");
246     } while( !shm_area[3] );
247     shm_area[2] = 0; /* reset request flag */
248     p = (byte*)shm_area+32;
249     n = p[0] << 8 | p[1];
250     p += 2;
251     if( n+32+2+1 > 4095 )
252         log_fatal("client returns too large data (%u bytes)\n", (unsigned)n );
253
254     if( bool )
255         return p[0]? "" : NULL;
256
257     string = hidden? m_alloc_secure( n+1 ) : m_alloc( n+1 );
258     memcpy(string, p, n );
259     string[n] = 0; /* make sure it is a string */
260     if( hidden ) /* invalidate the memory */
261         memset( p, 0, n );
262
263     return string;
264 }
265
266 #endif /* USE_SHM_COPROCESSING */
267
268
269
270 int
271 cpr_enabled()
272 {
273   #ifdef USE_SHM_COPROCESSING
274     if( opt.shm_coprocess )
275         return 1;
276   #endif
277     return 0;
278 }
279
280 char *
281 cpr_get( const char *keyword, const char *prompt )
282 {
283     char *p;
284
285   #ifdef USE_SHM_COPROCESSING
286     if( opt.shm_coprocess )
287         return do_shm_get( keyword, 0, 0 );
288   #endif
289     for(;;) {
290         p = tty_get( prompt );
291         if( *p=='?' && !p[1] && !(keyword && !*keyword)) {
292             m_free(p);
293             display_online_help( keyword );
294         }
295         else
296             return p;
297     }
298 }
299
300 char *
301 cpr_get_utf8( const char *keyword, const char *prompt )
302 {
303     char *p;
304     p = cpr_get( keyword, prompt );
305     if( p ) {
306         char *utf8 = native_to_utf8( p );
307         m_free( p );
308         p = utf8;
309     }
310     return p;
311 }
312
313 char *
314 cpr_get_hidden( const char *keyword, const char *prompt )
315 {
316     char *p;
317
318   #ifdef USE_SHM_COPROCESSING
319     if( opt.shm_coprocess )
320         return do_shm_get( keyword, 1, 0 );
321   #endif
322     for(;;) {
323         p = tty_get_hidden( prompt );
324         if( *p == '?' && !p[1] ) {
325             m_free(p);
326             display_online_help( keyword );
327         }
328         else
329             return p;
330     }
331 }
332
333 void
334 cpr_kill_prompt(void)
335 {
336   #ifdef USE_SHM_COPROCESSING
337     if( opt.shm_coprocess )
338         return;
339   #endif
340     tty_kill_prompt();
341     return;
342 }
343
344 int
345 cpr_get_answer_is_yes( const char *keyword, const char *prompt )
346 {
347     int yes;
348     char *p;
349
350   #ifdef USE_SHM_COPROCESSING
351     if( opt.shm_coprocess )
352         return !!do_shm_get( keyword, 0, 1 );
353   #endif
354     for(;;) {
355         p = tty_get( prompt );
356         trim_spaces(p); /* it is okay to do this here */
357         if( *p == '?' && !p[1] ) {
358             m_free(p);
359             display_online_help( keyword );
360         }
361         else {
362             tty_kill_prompt();
363             yes = answer_is_yes(p);
364             m_free(p);
365             return yes;
366         }
367     }
368 }
369
370 int
371 cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt )
372 {
373     int yes;
374     char *p;
375
376   #ifdef USE_SHM_COPROCESSING
377     if( opt.shm_coprocess )
378         return !!do_shm_get( keyword, 0, 1 );
379   #endif
380     for(;;) {
381         p = tty_get( prompt );
382         trim_spaces(p); /* it is okay to do this here */
383         if( *p == '?' && !p[1] ) {
384             m_free(p);
385             display_online_help( keyword );
386         }
387         else {
388             tty_kill_prompt();
389             yes = answer_is_yes_no_quit(p);
390             m_free(p);
391             return yes;
392         }
393     }
394 }
395