See ChangeLog: Fri Aug 18 14:27:14 CEST 2000 Werner Koch
[gnupg.git] / g10 / status.c
1 /* status.c
2  *      Copyright (C) 1998, 1999, 2000 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
42 #include <gcrypt.h>
43 #include "util.h"
44 #include "status.h"
45 #include "ttyio.h"
46 #include "options.h"
47 #include "main.h"
48 #include "i18n.h"
49
50 static int fd = -1;
51 #ifdef USE_SHM_COPROCESSING
52   static int shm_id = -1;
53   static volatile char *shm_area;
54   static size_t shm_size;
55   static int shm_is_locked;
56 #endif /*USE_SHM_COPROCESSING*/
57
58
59 static void
60 progress_cb ( void *ctx, int c )
61 {
62     char buf[50];
63
64     if ( c == '\n' )
65         sprintf ( buf, "%.20s X 100 100", (char*)ctx );
66     else
67         sprintf ( buf, "%.20s %c 0 0", (char*)ctx, c );
68     write_status_text ( STATUS_PROGRESS, buf );
69 }
70
71
72 void
73 set_status_fd ( int newfd )
74 {
75     fd = newfd;
76     if ( fd != -1 ) {
77       #if 0
78         #warning fixme - progress functions
79         register_primegen_progress ( progress_cb, "primegen" );
80         register_pk_dsa_progress ( progress_cb, "pk_dsa" );
81         register_pk_elg_progress ( progress_cb, "pk_elg" );
82       #endif
83     }
84 }
85
86 int
87 is_status_enabled()
88 {
89     return fd != -1;
90 }
91
92 void
93 write_status ( int no )
94 {
95     write_status_text( no, NULL );
96 }
97
98 void
99 write_status_text ( int no, const char *text)
100 {
101     const char *s;
102
103     if( fd == -1 )
104         return;  /* not enabled */
105
106     switch( no ) {
107       case STATUS_ENTER  : s = "ENTER\n"; break;
108       case STATUS_LEAVE  : s = "LEAVE\n"; break;
109       case STATUS_ABORT  : s = "ABORT\n"; break;
110       case STATUS_GOODSIG: s = "GOODSIG\n"; break;
111       case STATUS_SIGEXPIRED: s = "SIGEXPIRED\n"; break;
112       case STATUS_KEYREVOKED: s = "KEYREVOKED\n"; break;
113       case STATUS_BADSIG : s = "BADSIG\n"; break;
114       case STATUS_ERRSIG : s = "ERRSIG\n"; break;
115       case STATUS_BADARMOR : s = "BADARMOR\n"; break;
116       case STATUS_RSA_OR_IDEA : s= "RSA_OR_IDEA\n"; break;
117       case STATUS_TRUST_UNDEFINED: s = "TRUST_UNDEFINED\n"; break;
118       case STATUS_TRUST_NEVER    : s = "TRUST_NEVER\n"; break;
119       case STATUS_TRUST_MARGINAL : s = "TRUST_MARGINAL\n"; break;
120       case STATUS_TRUST_FULLY    : s = "TRUST_FULLY\n"; break;
121       case STATUS_TRUST_ULTIMATE : s = "TRUST_ULTIMATE\n"; break;
122       case STATUS_GET_BOOL       : s = "GET_BOOL\n"; break;
123       case STATUS_GET_LINE       : s = "GET_LINE\n"; break;
124       case STATUS_GET_HIDDEN     : s = "GET_HIDDEN\n"; break;
125       case STATUS_GOT_IT         : s = "GOT_IT\n"; break;
126       case STATUS_SHM_INFO       : s = "SHM_INFO\n"; break;
127       case STATUS_SHM_GET        : s = "SHM_GET\n"; break;
128       case STATUS_SHM_GET_BOOL   : s = "SHM_GET_BOOL\n"; break;
129       case STATUS_SHM_GET_HIDDEN : s = "SHM_GET_HIDDEN\n"; break;
130       case STATUS_NEED_PASSPHRASE: s = "NEED_PASSPHRASE\n"; break;
131       case STATUS_VALIDSIG       : s = "VALIDSIG\n"; break;
132       case STATUS_SIG_ID         : s = "SIG_ID\n"; break;
133       case STATUS_ENC_TO         : s = "ENC_TO\n"; break;
134       case STATUS_NODATA         : s = "NODATA\n"; break;
135       case STATUS_BAD_PASSPHRASE : s = "BAD_PASSPHRASE\n"; break;
136       case STATUS_NO_PUBKEY      : s = "NO_PUBKEY\n"; break;
137       case STATUS_NO_SECKEY      : s = "NO_SECKEY\n"; break;
138       case STATUS_NEED_PASSPHRASE_SYM: s = "NEED_PASSPHRASE_SYM\n"; break;
139       case STATUS_DECRYPTION_FAILED: s = "DECRYPTION_FAILED\n"; break;
140       case STATUS_DECRYPTION_OKAY: s = "DECRYPTION_OKAY\n"; break;
141       case STATUS_MISSING_PASSPHRASE: s = "MISSING_PASSPHRASE\n"; break;
142       case STATUS_GOOD_PASSPHRASE : s = "GOOD_PASSPHRASE\n"; break;
143       case STATUS_GOODMDC        : s = "GOODMDC\n"; break;
144       case STATUS_BADMDC         : s = "BADMDC\n"; break;
145       case STATUS_ERRMDC         : s = "ERRMDC\n"; break;
146       case STATUS_IMPORTED       : s = "IMPORTED\n"; break;
147       case STATUS_IMPORT_RES     : s = "IMPORT_RES\n"; break;
148       case STATUS_FILE_START     : s = "FILE_START\n"; break;
149       case STATUS_FILE_DONE      : s = "FILE_DONE\n"; break;
150       case STATUS_FILE_ERROR     : s = "FILE_ERROR\n"; break;
151       case STATUS_BEGIN_DECRYPTION:s = "BEGIN_DECRYPTION\n"; break;
152       case STATUS_END_DECRYPTION : s = "END_DECRYPTION\n"; break;
153       case STATUS_BEGIN_ENCRYPTION:s = "BEGIN_ENCRYPTION\n"; break;
154       case STATUS_END_ENCRYPTION : s = "END_ENCRYPTION\n"; break;
155       case STATUS_DELETE_PROBLEM : s = "DELETE_PROBLEM\n"; break;
156       case STATUS_PROGRESS       : s = "PROGRESS\n"; break;
157       case STATUS_SIG_CREATED    : s = "SIG_CREATED\n"; break;
158       default: s = "?\n"; break;
159     }
160
161     write( fd, "[GNUPG:] ", 9 );
162     if( text ) {
163         write( fd, s, strlen(s)-1 );
164         write( fd, " ", 1 );
165         write( fd, text, strlen(text) );
166         write( fd, "\n", 1 );
167     }
168     else
169         write( fd, s, strlen(s) );
170 }
171
172
173 #ifdef USE_SHM_COPROCESSING
174
175 #ifndef IPC_RMID_DEFERRED_RELEASE
176 static void
177 remove_shmid( void )
178 {
179     if( shm_id != -1 ) {
180         shmctl ( shm_id, IPC_RMID, 0);
181         shm_id = -1;
182     }
183 }
184 #endif
185
186 void
187 init_shm_coprocessing ( ulong requested_shm_size, int lock_mem )
188 {
189     char buf[100];
190     struct shmid_ds shmds;
191
192   #ifndef IPC_RMID_DEFERRED_RELEASE
193     atexit( remove_shmid );
194   #endif
195     requested_shm_size = (requested_shm_size + 4095) & ~4095;
196     if ( requested_shm_size > 2 * 4096 )
197         log_fatal("too much shared memory requested; only 8k are allowed\n");
198     shm_size = 4096 /* one page for us */ + requested_shm_size;
199
200     shm_id = shmget( IPC_PRIVATE, shm_size, IPC_CREAT | 0700 );
201     if ( shm_id == -1 )
202         log_fatal("can't get %uk of shared memory: %s\n",
203                                 (unsigned)shm_size/1024, strerror(errno));
204
205   #if !defined(IPC_HAVE_SHM_LOCK) \
206       && defined(HAVE_MLOCK) && !defined(HAVE_BROKEN_MLOCK)
207     /* part of the old code which uses mlock */
208     shm_area = shmat( shm_id, 0, 0 );
209     if ( shm_area == (char*)-1 )
210         log_fatal("can't attach %uk shared memory: %s\n",
211                                 (unsigned)shm_size/1024, strerror(errno));
212     log_debug("mapped %uk shared memory at %p, id=%d\n",
213                             (unsigned)shm_size/1024, shm_area, shm_id );
214     if( lock_mem ) {
215       #ifdef USE_CAPABILITIES
216         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
217       #endif
218         /* (need the cast for Solaris with Sun's workshop compilers) */
219         if ( mlock ( (char*)shm_area, shm_size) )
220             log_info("locking shared memory %d failed: %s\n",
221                                 shm_id, strerror(errno));
222         else
223             shm_is_locked = 1;
224       #ifdef USE_CAPABILITIES
225         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
226       #endif
227     }
228
229   #ifdef IPC_RMID_DEFERRED_RELEASE
230     if( shmctl( shm_id, IPC_RMID, 0) )
231         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
232                                             shm_id, strerror(errno));
233   #endif
234
235     if( shmctl( shm_id, IPC_STAT, &shmds ) )
236         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
237                                             shm_id, strerror(errno));
238     if( shmds.shm_perm.uid != getuid() ) {
239         shmds.shm_perm.uid = getuid();
240         if( shmctl( shm_id, IPC_SET, &shmds ) )
241             log_fatal("shmctl IPC_SET of %d failed: %s\n",
242                                                 shm_id, strerror(errno));
243     }
244
245   #else /* this is the new code which handles the changes in the SHM semantics
246          * introduced with Linux 2.4.  The changes is that we now change the
247          * permissions and then attach to the memory.
248          */
249
250     if( lock_mem ) {
251       #ifdef USE_CAPABILITIES
252         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
253       #endif
254       #ifdef IPC_HAVE_SHM_LOCK
255         if ( shmctl (shm_id, SHM_LOCK, 0) )
256             log_info("locking shared memory %d failed: %s\n",
257                                 shm_id, strerror(errno));
258         else
259             shm_is_locked = 1;
260       #else
261         log_info("Locking shared memory %d failed: No way to do it\n", shm_id );
262       #endif
263       #ifdef USE_CAPABILITIES
264         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
265       #endif
266     }
267
268     if( shmctl( shm_id, IPC_STAT, &shmds ) )
269         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
270                                             shm_id, strerror(errno));
271     if( shmds.shm_perm.uid != getuid() ) {
272         shmds.shm_perm.uid = getuid();
273         if( shmctl( shm_id, IPC_SET, &shmds ) )
274             log_fatal("shmctl IPC_SET of %d failed: %s\n",
275                                                 shm_id, strerror(errno));
276     }
277
278     shm_area = shmat( shm_id, 0, 0 );
279     if ( shm_area == (char*)-1 )
280         log_fatal("can't attach %uk shared memory: %s\n",
281                                 (unsigned)shm_size/1024, strerror(errno));
282     log_debug("mapped %uk shared memory at %p, id=%d\n",
283                             (unsigned)shm_size/1024, shm_area, shm_id );
284
285   #ifdef IPC_RMID_DEFERRED_RELEASE
286     if( shmctl( shm_id, IPC_RMID, 0) )
287         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
288                                             shm_id, strerror(errno));
289   #endif
290
291   #endif
292     /* write info; Protocol version, id, size, locked size */
293     sprintf( buf, "pv=1 pid=%d shmid=%d sz=%u lz=%u", (int)getpid(),
294             shm_id, (unsigned)shm_size, shm_is_locked? (unsigned)shm_size:0 );
295     write_status_text( STATUS_SHM_INFO, buf );
296 }
297
298 /****************
299  * Request a string from client
300  * If bool, returns static string on true (do not free) or NULL for false
301  */
302 static char *
303 do_shm_get( const char *keyword, int hidden, int bool )
304 {
305     size_t n;
306     byte *p;
307     char *string;
308
309     if( !shm_area )
310         BUG();
311
312     shm_area[0] = 0;  /* msb of length of control block */
313     shm_area[1] = 32; /* and lsb */
314     shm_area[2] = 1;  /* indicate that we are waiting on a reply */
315     shm_area[3] = 0;  /* clear data available flag */
316
317     write_status_text( bool? STATUS_SHM_GET_BOOL :
318                        hidden? STATUS_SHM_GET_HIDDEN : STATUS_SHM_GET, keyword );
319
320     do {
321         pause_on_sigusr(1);
322         if( shm_area[0] || shm_area[1] != 32 || shm_area[2] != 1 )
323             log_fatal("client modified shm control block - abort\n");
324     } while( !shm_area[3] );
325     shm_area[2] = 0; /* reset request flag */
326     p = (byte*)shm_area+32;
327     n = p[0] << 8 | p[1];
328     p += 2;
329     if( n+32+2+1 > 4095 )
330         log_fatal("client returns too large data (%u bytes)\n", (unsigned)n );
331
332     if( bool )
333         return p[0]? "" : NULL;
334
335     string = hidden? gcry_xmalloc_secure( n+1 ) : gcry_xmalloc( n+1 );
336     memcpy(string, p, n );
337     string[n] = 0; /* make sure it is a string */
338     if( hidden ) /* invalidate the memory */
339         memset( p, 0, n );
340
341     return string;
342 }
343
344 #endif /* USE_SHM_COPROCESSING */
345
346
347 /****************
348  * Request a string from the client over the command-fd
349  * If bool, returns static string on true (do not free) or NULL for false
350  */
351 static char *
352 do_get_from_fd( const char *keyword, int hidden, int bool )
353 {
354     int i, len;
355     char *string;
356
357     write_status_text( bool? STATUS_GET_BOOL :
358                        hidden? STATUS_GET_HIDDEN : STATUS_GET_LINE, keyword );
359
360     for( string = NULL, i = len = 200; ; i++ ) {
361         if( i >= len-1 ) {
362             char *save = string;
363             len += 100;
364             string = hidden? gcry_xmalloc_secure ( len ) : gcry_malloc ( len );
365             if( save )
366                 memcpy(string, save, i );
367             else
368                 i=0;
369         }
370         /* Hmmm: why not use our read_line function here */
371         if( read( opt.command_fd, string+i, 1) != 1 || string[i] == '\n' )
372             break;
373     }
374     string[i] = 0;
375
376     write_status( STATUS_GOT_IT );
377
378     if( bool )   /* Fixme: is this correct??? */
379         return string[0] == 'Y' ? "" : NULL;
380
381     return string;
382 }
383
384
385
386 int
387 cpr_enabled()
388 {
389     if( opt.command_fd != -1 )
390         return 1;
391   #ifdef USE_SHM_COPROCESSING
392     if( opt.shm_coprocess )
393         return 1;
394   #endif
395     return 0;
396 }
397
398 char *
399 cpr_get( const char *keyword, const char *prompt )
400 {
401     char *p;
402
403     if( opt.command_fd != -1 )
404         return do_get_from_fd ( keyword, 0, 0 );
405   #ifdef USE_SHM_COPROCESSING
406     if( opt.shm_coprocess )
407         return do_shm_get( keyword, 0, 0 );
408   #endif
409     for(;;) {
410         p = tty_get( prompt );
411         if( *p=='?' && !p[1] && !(keyword && !*keyword)) {
412             gcry_free(p);
413             display_online_help( keyword );
414         }
415         else
416             return p;
417     }
418 }
419
420 char *
421 cpr_get_utf8( const char *keyword, const char *prompt )
422 {
423     char *p;
424     p = cpr_get( keyword, prompt );
425     if( p ) {
426         char *utf8 = native_to_utf8( p );
427         gcry_free( p );
428         p = utf8;
429     }
430     return p;
431 }
432
433 char *
434 cpr_get_hidden( const char *keyword, const char *prompt )
435 {
436     char *p;
437
438     if( opt.command_fd != -1 )
439         return do_get_from_fd ( keyword, 1, 0 );
440   #ifdef USE_SHM_COPROCESSING
441     if( opt.shm_coprocess )
442         return do_shm_get( keyword, 1, 0 );
443   #endif
444     for(;;) {
445         p = tty_get_hidden( prompt );
446         if( *p == '?' && !p[1] ) {
447             gcry_free(p);
448             display_online_help( keyword );
449         }
450         else
451             return p;
452     }
453 }
454
455 void
456 cpr_kill_prompt(void)
457 {
458     if( opt.command_fd != -1 )
459         return;
460   #ifdef USE_SHM_COPROCESSING
461     if( opt.shm_coprocess )
462         return;
463   #endif
464     tty_kill_prompt();
465     return;
466 }
467
468 int
469 cpr_get_answer_is_yes( const char *keyword, const char *prompt )
470 {
471     int yes;
472     char *p;
473
474     if( opt.command_fd != -1 )
475         return !!do_get_from_fd ( keyword, 0, 1 );
476   #ifdef USE_SHM_COPROCESSING
477     if( opt.shm_coprocess )
478         return !!do_shm_get( keyword, 0, 1 );
479   #endif
480     for(;;) {
481         p = tty_get( prompt );
482         trim_spaces(p); /* it is okay to do this here */
483         if( *p == '?' && !p[1] ) {
484             gcry_free(p);
485             display_online_help( keyword );
486         }
487         else {
488             tty_kill_prompt();
489             yes = answer_is_yes(p);
490             gcry_free(p);
491             return yes;
492         }
493     }
494 }
495
496 int
497 cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt )
498 {
499     int yes;
500     char *p;
501
502     if( opt.command_fd != -1 )
503         return !!do_get_from_fd ( keyword, 0, 1 );
504   #ifdef USE_SHM_COPROCESSING
505     if( opt.shm_coprocess )
506         return !!do_shm_get( keyword, 0, 1 );
507   #endif
508     for(;;) {
509         p = tty_get( prompt );
510         trim_spaces(p); /* it is okay to do this here */
511         if( *p == '?' && !p[1] ) {
512             gcry_free(p);
513             display_online_help( keyword );
514         }
515         else {
516             tty_kill_prompt();
517             yes = answer_is_yes_no_quit(p);
518             gcry_free(p);
519             return yes;
520         }
521     }
522 }
523