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