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