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