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