* gpg-agent.c: Removed unused cruft and implement the socket
[gnupg.git] / agent / query.c
1 /* query.c - fork of the pinentry to query stuff from the user
2  *      Copyright (C) 2001 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 <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <assert.h>
28 #include <unistd.h>
29 #include <sys/stat.h>
30
31 #include "agent.h"
32 #include "../assuan/assuan.h"
33
34 #ifdef _POSIX_OPEN_MAX
35 #define MAX_OPEN_FDS _POSIX_OPEN_MAX
36 #else
37 #define MAX_OPEN_FDS 20
38 #endif
39
40 static ASSUAN_CONTEXT entry_ctx = NULL;
41
42 /* data to be passed to our callbacks */
43 struct entry_parm_s {
44   int lines;
45   size_t size;
46   char *buffer;
47 };
48
49
50
51 \f
52 /* Fork off the pin entry if this has not already been done */
53 static int
54 start_pinentry (void)
55 {
56   int rc;
57   const char *pgmname;
58   ASSUAN_CONTEXT ctx;
59   const char *argv[3];
60
61   if (entry_ctx)
62     return 0; /* No need to serialize things becuase the agent is
63                  expected to tun as a single-thread (or may be in
64                  future using libpth) */
65
66
67   log_debug ("no running PIN Entry - starting it\n");
68       
69   if (fflush (NULL))
70     {
71       log_error ("error flushing pending output: %s\n", strerror (errno));
72       return seterr (Write_Error);
73     }
74
75   /* FIXME: change the default location of the program */
76   if (!opt.pinentry_program || !*opt.pinentry_program)
77     opt.pinentry_program = "../../pinentry/kpinentry/kpinentry";
78   if ( !(pgmname = strrchr (opt.pinentry_program, '/')))
79     pgmname = opt.pinentry_program;
80   else
81     pgmname++;
82
83   argv[0] = pgmname;
84   argv[1] = NULL;
85
86   /* connect to the pinentry and perform initial handshaking */
87   rc = assuan_pipe_connect (&ctx, opt.pinentry_program, (char**)argv, 0);
88   if (rc)
89     {
90       log_error ("can't connect to the PIN entry module: %s\n",
91                  assuan_strerror (rc));
92       return seterr (No_PIN_Entry);
93     }
94   entry_ctx = ctx;
95   
96   log_debug ("connection to PIN entry established\n");
97
98   if (DBG_COMMAND)
99     {
100       log_debug ("waiting for debugger [hit RETURN when ready] .....\n");
101       getchar ();
102       log_debug ("... okay\n");
103     }
104
105   return 0;
106 }
107
108
109 static AssuanError
110 getpin_cb (void *opaque, const void *buffer, size_t length)
111 {
112   struct entry_parm_s *parm = opaque;
113
114   /* we expect the pin to fit on one line */
115   if (parm->lines || length >= parm->size)
116     return ASSUAN_Too_Much_Data;
117
118   /* fixme: we should make sure that the assuan buffer is allocated in
119      secure memory or read the response byte by byte */
120   memcpy (parm->buffer, buffer, length);
121   parm->buffer[length] = 0;
122   parm->lines++;
123   return 0;
124 }
125
126
127 static int
128 all_digitsp( const char *s)
129 {
130   for (; *s && *s >= '0' && *s <= '9'; s++)
131     ;
132   return !*s;
133 }  
134
135
136 \f
137 /* Call the Entry and ask for the PIN.  We do check for a valid PIN
138    number here and repeat it as long as we have invalid formed
139    numbers. */
140 int
141 agent_askpin (const char *desc_text,
142               struct pin_entry_info_s *pininfo)
143 {
144   int rc;
145   char line[ASSUAN_LINELENGTH];
146   struct entry_parm_s parm;
147   const char *errtext = NULL;
148
149   if (opt.batch)
150     return 0; /* fixme: we should return BAD PIN */
151
152   if (!pininfo || pininfo->max_length < 1)
153     return seterr (Invalid_Value);
154   if (!desc_text)
155     desc_text = trans ("Please enter you PIN, so that the secret key "
156                        "can be unlocked for this session");
157   
158   rc = start_pinentry ();
159   if (rc)
160     return rc;
161
162   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
163   line[DIM(line)-1] = 0;
164   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
165   if (rc)
166     return map_assuan_err (rc);
167
168   rc = assuan_transact (entry_ctx,
169                         pininfo->min_digits? "SETPROMPT PIN:"
170                                            : "SETPROMPT Passphrase:",
171                         NULL, NULL, NULL, NULL);
172   if (rc)
173     return map_assuan_err (rc);
174
175   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
176     {
177       memset (&parm, 0, sizeof parm);
178       parm.size = pininfo->max_length;
179       parm.buffer = pininfo->pin;
180
181       if (errtext)
182         { 
183           /* fixme: should we show the try count? It must be translated */
184           snprintf (line, DIM(line)-1, "SETERROR %s (try %d of %d)",
185                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
186           line[DIM(line)-1] = 0;
187           rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
188           if (rc)
189             return map_assuan_err (rc);
190           errtext = NULL;
191         }
192       
193       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL);
194       if (rc == ASSUAN_Too_Much_Data)
195         errtext = pininfo->min_digits? trans ("PIN too long")
196                                      : trans ("Passphrase too long");
197       else if (rc)
198         return map_assuan_err (rc);
199       if (!errtext && !pininfo->min_digits)
200         return 0; /* okay, got a passphrase */
201       if (!errtext && !all_digitsp (pininfo->pin))
202         errtext = trans ("Invalid characters in PIN");
203       if (!errtext && pininfo->max_digits
204           && strlen (pininfo->pin) > pininfo->max_digits)
205         errtext = trans ("PIN too long");
206       if (!errtext
207           && strlen (pininfo->pin) < pininfo->min_digits)
208         errtext = trans ("PIN too short");
209
210       if (!errtext)
211         return 0; /* okay, got a PIN */
212     }
213
214   return pininfo->min_digits? GNUPG_Bad_PIN : GNUPG_Bad_Passphrase;
215 }
216
217
218 \f
219 /* Ask for the passphrase using the supplied arguments.  The
220    passphrase is returned in RETPASS as an hex encoded string to be
221    freed by the caller */
222 int 
223 agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
224                       const char *errtext)
225 {
226
227   int rc;
228   char line[ASSUAN_LINELENGTH];
229   struct entry_parm_s parm;
230   unsigned char *p, *hexstring;
231   int i;
232
233   *retpass = NULL;
234   if (opt.batch)
235     return GNUPG_Bad_Passphrase; 
236
237   rc = start_pinentry ();
238   if (rc)
239     return rc;
240
241   if (desc)
242     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
243   else
244     snprintf (line, DIM(line)-1, "RESET");
245   line[DIM(line)-1] = 0;
246   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
247   if (rc)
248     return map_assuan_err (rc);
249
250   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt? prompt : "Passphrase");
251   line[DIM(line)-1] = 0;
252   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
253   if (rc)
254     return map_assuan_err (rc);
255
256   if (errtext)
257     {
258       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
259       line[DIM(line)-1] = 0;
260       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
261       if (rc)
262         return map_assuan_err (rc);
263     }
264
265   memset (&parm, 0, sizeof parm);
266   parm.size = ASSUAN_LINELENGTH/2 - 5;
267   parm.buffer = gcry_malloc_secure (parm.size+10);
268   if (!parm.buffer)
269     return seterr (Out_Of_Core);
270
271   assuan_begin_confidential (entry_ctx);
272   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL);
273   if (rc)
274     {
275       xfree (parm.buffer);
276       return map_assuan_err (rc);
277     }
278   
279   hexstring = gcry_malloc_secure (strlen (parm.buffer)*2+1);
280   if (!hexstring)
281     {
282       xfree (parm.buffer);
283       return seterr (Out_Of_Core);
284     }
285
286   for (i=0, p=parm.buffer; *p; p++, i += 2)
287     sprintf (hexstring+i, "%02X", *p);
288   
289   xfree (parm.buffer);
290   *retpass = hexstring;
291   return 0;
292 }
293
294
295
296
297