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