add coprocess facility
[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
41 static int fd = -1;
42 #ifdef USE_SHM_COPROCESSING
43   static int shm_id = -1;
44   static volatile char *shm_area;
45   static size_t shm_size;
46   static int shm_is_locked;
47 #endif /*USE_SHM_COPROCESSING*/
48
49 void
50 set_status_fd ( int newfd )
51 {
52     fd = newfd;
53 }
54
55
56 void
57 write_status ( int no )
58 {
59     write_status_text( no, NULL );
60 }
61
62 void
63 write_status_text ( int no, const char *text)
64 {
65     const char *s;
66
67     if( fd == -1 )
68         return;  /* not enabled */
69
70     switch( no ) {
71       case STATUS_ENTER  : s = "ENTER\n"; break;
72       case STATUS_LEAVE  : s = "LEAVE\n"; break;
73       case STATUS_ABORT  : s = "ABORT\n"; break;
74       case STATUS_GOODSIG: s = "GOODSIG\n"; break;
75       case STATUS_SIGEXPIRED: s = "SIGEXPIRED\n"; break;
76       case STATUS_KEYREVOKED: s = "KEYREVOKED\n"; break;
77       case STATUS_BADSIG : s = "BADSIG\n"; break;
78       case STATUS_ERRSIG : s = "ERRSIG\n"; break;
79       case STATUS_BADARMOR : s = "BADARMOR\n"; break;
80       case STATUS_RSA_OR_IDEA : s= "RSA_OR_IDEA\n"; break;
81       case STATUS_TRUST_UNDEFINED: s = "TRUST_UNDEFINED\n"; break;
82       case STATUS_TRUST_NEVER    : s = "TRUST_NEVER\n"; break;
83       case STATUS_TRUST_MARGINAL : s = "TRUST_MARGINAL\n"; break;
84       case STATUS_TRUST_FULLY    : s = "TRUST_FULLY\n"; break;
85       case STATUS_TRUST_ULTIMATE : s = "TRUST_ULTIMATE\n"; break;
86       case STATUS_SHM_INFO       : s = "SHM_INFO\n"; break;
87       case STATUS_SHM_GET        : s = "SHM_GET\n"; break;
88       case STATUS_SHM_GET_BOOL   : s = "SHM_GET_BOOL\n"; break;
89       case STATUS_SHM_GET_HIDDEN : s = "SHM_GET_HIDDEN\n"; break;
90       default: s = "?\n"; break;
91     }
92
93     write( fd, "[GNUPG:] ", 9 );
94     if( text ) {
95         write( fd, s, strlen(s)-1 );
96         write( fd, " ", 1 );
97         write( fd, text, strlen(text) );
98         write( fd, "\n", 1 );
99     }
100     else
101         write( fd, s, strlen(s) );
102 }
103
104
105 #ifdef USE_SHM_COPROCESSING
106 void
107 init_shm_coprocessing ( ulong requested_shm_size, int lock_mem )
108 {
109     char buf[100];
110
111     requested_shm_size = (requested_shm_size + 4095) & ~4095;
112     if ( requested_shm_size > 2 * 4096 )
113         log_fatal("too much shared memory requested; only 8k are allowed\n");
114     shm_size = 4096 /* one page for us */ + requested_shm_size;
115
116     /* FIXME: Need other permissions ... */
117     shm_id = shmget( IPC_PRIVATE, shm_size, IPC_CREAT | 0777 );
118     if ( shm_id == -1 )
119         log_fatal("can't get %uk of shared memory: %s\n",
120                                 (unsigned)shm_size/1024, strerror(errno));
121     shm_area = shmat( shm_id, 0, 0 );
122     if ( shm_area == (char*)-1 )
123         log_fatal("can't attach %uk shared memory: %s\n",
124                                 (unsigned)shm_size/1024, strerror(errno));
125     log_info("mapped %uk shared memory at %p, id=%d\n",
126                             (unsigned)shm_size/1024, shm_area, shm_id );
127     if( lock_mem ) {
128         if ( shmctl (shm_id, SHM_LOCK, 0) )
129             log_info("Locking shared memory %d failed: %s\n",
130                                 shm_id, strerror(errno));
131         else
132             shm_is_locked = 1;
133     }
134
135   #ifdef IPC_RMID_DEFERRED_RELEASE
136     if ( shmctl ( shm_id, IPC_RMID, 0) )
137         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
138                                             shm_id, strerror(errno));
139   #else
140     #error Must add a cleanup function
141   #endif
142
143     /* write info; Protocol version, id, size, locked size */
144     sprintf( buf, "pv=1 pid=%d shmid=%d sz=%u lz=%u", (int)getpid(),
145             shm_id, (unsigned)shm_size, shm_is_locked? (unsigned)shm_size:0 );
146     write_status_text( STATUS_SHM_INFO, buf );
147 }
148
149
150 /****************
151  * Request a string from client
152  * If bool, returns static string on true (do not free) or NULL for false
153  */
154 static char *
155 do_shm_get( const char *keyword, int hidden, int bool )
156 {
157     size_t n;
158     byte *p;
159     char *string;
160
161     if( !shm_area )
162         BUG();
163
164     shm_area[0] = 0;  /* msb of length of control block */
165     shm_area[1] = 32; /* and lsb */
166     shm_area[2] = 1;  /* indicate that we are waiting on a reply */
167     shm_area[3] = 0;  /* clear data available flag */
168
169     write_status_text( bool? STATUS_SHM_GET_BOOL :
170                        hidden? STATUS_SHM_GET_HIDDEN : STATUS_SHM_GET, keyword );
171
172     do {
173         pause_on_sigusr(1);
174         if( shm_area[0] || shm_area[1] != 32 || shm_area[2] != 1 )
175             log_fatal("client modified shm control block - abort\n");
176     } while( !shm_area[3] );
177     shm_area[2] = 0; /* reset request flag */
178     p = (byte*)shm_area+32;
179     n = p[0] << 8 | p[1];
180     p += 2;
181     if( n+32+2+1 > 4095 )
182         log_fatal("client returns too large data (%u bytes)\n", (unsigned)n );
183
184     if( bool )
185         return p[0]? "" : NULL;
186
187     string = hidden? m_alloc_secure( n+1 ) : m_alloc( n+1 );
188     memcpy(string, p, n );
189     string[n] = 0; /* make sure it is a string */
190     if( hidden ) /* invalidate the memory */
191         memset( p, 0, n );
192
193     return string;
194 }
195
196 #endif /* USE_SHM_COPROCESSING */
197
198
199 int
200 cpr_enabled()
201 {
202   #ifdef USE_SHM_COPROCESSING
203     if( opt.shm_coprocess )
204         return 1;
205   #endif
206     return 0;
207 }
208
209 char *
210 cpr_get( const char *keyword, const char *prompt )
211 {
212   #ifdef USE_SHM_COPROCESSING
213     if( opt.shm_coprocess )
214         return do_shm_get( keyword, 0, 0 );
215   #endif
216     return tty_get( prompt );
217 }
218
219 char *
220 cpr_get_hidden( const char *keyword, const char *prompt )
221 {
222   #ifdef USE_SHM_COPROCESSING
223     if( opt.shm_coprocess )
224         return do_shm_get( keyword, 1, 0 );
225   #endif
226     return tty_get_hidden( prompt );
227 }
228
229 void
230 cpr_kill_prompt(void)
231 {
232   #ifdef USE_SHM_COPROCESSING
233     if( opt.shm_coprocess )
234         return;
235   #endif
236     return tty_kill_prompt();
237 }
238
239 int
240 cpr_get_answer_is_yes( const char *keyword, const char *prompt )
241 {
242   #ifdef USE_SHM_COPROCESSING
243     if( opt.shm_coprocess )
244         return !!do_shm_get( keyword, 0, 1 );
245   #endif
246     return tty_get_answer_is_yes( prompt );
247 }
248