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