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