2004-06-20 Moritz Schulte <moritz@g10code.com>
[gnupg.git] / agent / query.c
1 /* query.c - fork of the pinentry to query stuff from the user
2  * Copyright (C) 2001, 2002, 2004 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 #ifdef USE_GNU_PTH
31 # include <pth.h>
32 #endif
33
34 #include "agent.h"
35 #include "i18n.h"
36 #include <assuan.h>
37
38 #ifdef _POSIX_OPEN_MAX
39 #define MAX_OPEN_FDS _POSIX_OPEN_MAX
40 #else
41 #define MAX_OPEN_FDS 20
42 #endif
43
44 static ASSUAN_CONTEXT entry_ctx = NULL;
45 #ifdef USE_GNU_PTH
46 static pth_mutex_t entry_lock = PTH_MUTEX_INIT;
47 #endif
48
49 /* data to be passed to our callbacks */
50 struct entry_parm_s {
51   int lines;
52   size_t size;
53   char *buffer;
54 };
55
56
57
58 \f
59 /* Unlock the pinentry so that another thread can start one and
60    disconnect that pinentry - we do this after the unlock so that a
61    stalled pinentry does not block other threads.  Fixme: We should
62    have a timeout in Assuan for the disconnetc operation. */
63 static int 
64 unlock_pinentry (int rc)
65 {
66   ASSUAN_CONTEXT ctx = entry_ctx;
67
68 #ifdef USE_GNU_PTH
69   if (!pth_mutex_release (&entry_lock))
70     {
71       log_error ("failed to release the entry lock\n");
72       if (!rc)
73         rc = gpg_error (GPG_ERR_INTERNAL);
74     }
75 #endif
76   entry_ctx = NULL;
77   assuan_disconnect (ctx);
78   return rc;
79 }
80
81
82 /* To make sure we leave no secrets in our image after forking of the
83    pinentry, we use this callback. */
84 static void
85 atfork_cb (void *opaque, int where)
86 {
87   if (!where)
88     gcry_control (GCRYCTL_TERM_SECMEM);
89 }
90
91
92 /* Fork off the pin entry if this has not already been done.  Note,
93    that this function must always be used to aquire the lock for the
94    pinentry - we will serialize _all_ pinentry calls.
95  */
96 static int
97 start_pinentry (CTRL ctrl)
98 {
99   int rc;
100   const char *pgmname;
101   ASSUAN_CONTEXT ctx;
102   const char *argv[5];
103   int no_close_list[3];
104   int i;
105
106 #ifdef USE_GNU_PTH
107   if (!pth_mutex_acquire (&entry_lock, 0, NULL))
108     {
109       log_error ("failed to acquire the entry lock\n");
110       return gpg_error (GPG_ERR_INTERNAL);
111     }
112 #endif
113
114   if (entry_ctx)
115     return 0; 
116
117   if (opt.verbose)
118     log_info ("starting a new PIN Entry\n");
119       
120   if (fflush (NULL))
121     {
122       gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
123       log_error ("error flushing pending output: %s\n", strerror (errno));
124       return unlock_pinentry (tmperr);
125     }
126
127   if (!opt.pinentry_program || !*opt.pinentry_program)
128     opt.pinentry_program = GNUPG_DEFAULT_PINENTRY;
129   if ( !(pgmname = strrchr (opt.pinentry_program, '/')))
130     pgmname = opt.pinentry_program;
131   else
132     pgmname++;
133
134   argv[0] = pgmname;
135   if (ctrl->display && !opt.keep_display)
136     {
137       argv[1] = "--display";
138       argv[2] = ctrl->display;
139       argv[3] = NULL;
140     }
141   else
142     argv[1] = NULL;
143   
144   i=0;
145   if (!opt.running_detached)
146     {
147       if (log_get_fd () != -1)
148         no_close_list[i++] = log_get_fd ();
149       no_close_list[i++] = fileno (stderr);
150     }
151   no_close_list[i] = -1;
152
153   /* Connect to the pinentry and perform initial handshaking */
154   rc = assuan_pipe_connect2 (&ctx, opt.pinentry_program, (char**)argv,
155                              no_close_list, atfork_cb, NULL);
156   if (rc)
157     {
158       log_error ("can't connect to the PIN entry module: %s\n",
159                  assuan_strerror (rc));
160       return unlock_pinentry (gpg_error (GPG_ERR_NO_PIN_ENTRY));
161     }
162   entry_ctx = ctx;
163
164   if (DBG_ASSUAN)
165     log_debug ("connection to PIN entry established\n");
166
167   rc = assuan_transact (entry_ctx, 
168                         opt.no_grab? "OPTION no-grab":"OPTION grab",
169                         NULL, NULL, NULL, NULL, NULL, NULL);
170   if (rc)
171     return unlock_pinentry (map_assuan_err (rc));
172   if (ctrl->ttyname)
173     {
174       char *optstr;
175       if (asprintf (&optstr, "OPTION ttyname=%s", ctrl->ttyname) < 0 )
176         return unlock_pinentry (out_of_core ());
177       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
178                             NULL);
179       free (optstr);
180       if (rc)
181         return unlock_pinentry (map_assuan_err (rc));
182     }
183   if (ctrl->ttytype)
184     {
185       char *optstr;
186       if (asprintf (&optstr, "OPTION ttytype=%s", ctrl->ttytype) < 0 )
187         return unlock_pinentry (out_of_core ());
188       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
189                             NULL);
190       if (rc)
191         return unlock_pinentry (map_assuan_err (rc));
192     }
193   if (ctrl->lc_ctype)
194     {
195       char *optstr;
196       if (asprintf (&optstr, "OPTION lc-ctype=%s", ctrl->lc_ctype) < 0 )
197         return unlock_pinentry (out_of_core ());
198       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
199                             NULL);
200       if (rc)
201         return unlock_pinentry (map_assuan_err (rc));
202     }
203   if (ctrl->lc_messages)
204     {
205       char *optstr;
206       if (asprintf (&optstr, "OPTION lc-messages=%s", ctrl->lc_messages) < 0 )
207         return unlock_pinentry (out_of_core ());
208       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
209                             NULL);
210       if (rc)
211         return unlock_pinentry (map_assuan_err (rc));
212     }
213   return 0;
214 }
215
216
217 static AssuanError
218 getpin_cb (void *opaque, const void *buffer, size_t length)
219 {
220   struct entry_parm_s *parm = opaque;
221
222   if (!buffer)
223     return 0;
224
225   /* we expect the pin to fit on one line */
226   if (parm->lines || length >= parm->size)
227     return ASSUAN_Too_Much_Data;
228
229   /* fixme: we should make sure that the assuan buffer is allocated in
230      secure memory or read the response byte by byte */
231   memcpy (parm->buffer, buffer, length);
232   parm->buffer[length] = 0;
233   parm->lines++;
234   return 0;
235 }
236
237
238 static int
239 all_digitsp( const char *s)
240 {
241   for (; *s && *s >= '0' && *s <= '9'; s++)
242     ;
243   return !*s;
244 }  
245
246
247 \f
248 /* Call the Entry and ask for the PIN.  We do check for a valid PIN
249    number here and repeat it as long as we have invalid formed
250    numbers. */
251 int
252 agent_askpin (CTRL ctrl,
253               const char *desc_text, const char *initial_errtext,
254               struct pin_entry_info_s *pininfo)
255 {
256   int rc;
257   char line[ASSUAN_LINELENGTH];
258   struct entry_parm_s parm;
259   const char *errtext = NULL;
260   int is_pin = 0;
261
262   if (opt.batch)
263     return 0; /* fixme: we should return BAD PIN */
264
265   if (!pininfo || pininfo->max_length < 1)
266     return gpg_error (GPG_ERR_INV_VALUE);
267   if (!desc_text && pininfo->min_digits)
268     desc_text = _("Please enter your PIN, so that the secret key "
269                   "can be unlocked for this session");
270   else if (!desc_text)
271     desc_text = _("Please enter your passphrase, so that the secret key "
272                   "can be unlocked for this session");
273
274   is_pin = desc_text && strstr (desc_text, "PIN");
275
276   rc = start_pinentry (ctrl);
277   if (rc)
278     return rc;
279
280   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
281   line[DIM(line)-1] = 0;
282   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
283   if (rc)
284     return unlock_pinentry (map_assuan_err (rc));
285
286   rc = assuan_transact (entry_ctx,
287                         is_pin? "SETPROMPT PIN:"
288                               : "SETPROMPT Passphrase:",
289                         NULL, NULL, NULL, NULL, NULL, NULL);
290   if (rc)
291     return unlock_pinentry (map_assuan_err (rc));
292
293
294   if (initial_errtext)
295     { 
296       snprintf (line, DIM(line)-1, "SETERROR %s", initial_errtext);
297       line[DIM(line)-1] = 0;
298       rc = assuan_transact (entry_ctx, line,
299                             NULL, NULL, NULL, NULL, NULL, NULL);
300       if (rc)
301         return unlock_pinentry (map_assuan_err (rc));
302     }
303
304   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
305     {
306       memset (&parm, 0, sizeof parm);
307       parm.size = pininfo->max_length;
308       parm.buffer = pininfo->pin;
309
310       if (errtext)
311         { 
312           /* fixme: should we show the try count? It must be translated */
313           snprintf (line, DIM(line)-1, "SETERROR %s (try %d of %d)",
314                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
315           line[DIM(line)-1] = 0;
316           rc = assuan_transact (entry_ctx, line,
317                                 NULL, NULL, NULL, NULL, NULL, NULL);
318           if (rc)
319             return unlock_pinentry (map_assuan_err (rc));
320           errtext = NULL;
321         }
322       
323       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
324                             NULL, NULL, NULL, NULL);
325       if (rc == ASSUAN_Too_Much_Data)
326         errtext = is_pin? _("PIN too long")
327                         : _("Passphrase too long");
328       else if (rc)
329         return unlock_pinentry (map_assuan_err (rc));
330
331       if (!errtext && pininfo->min_digits)
332         {
333           /* do some basic checks on the entered PIN. */
334           if (!all_digitsp (pininfo->pin))
335             errtext = _("Invalid characters in PIN");
336           else if (pininfo->max_digits
337                    && strlen (pininfo->pin) > pininfo->max_digits)
338             errtext = _("PIN too long");
339           else if (strlen (pininfo->pin) < pininfo->min_digits)
340             errtext = _("PIN too short");
341         }
342
343       if (!errtext && pininfo->check_cb)
344         {
345           /* More checks by utilizing the optional callback. */
346           pininfo->cb_errtext = NULL;
347           rc = pininfo->check_cb (pininfo);
348           if (rc == -1 && pininfo->cb_errtext)
349             errtext = pininfo->cb_errtext;
350           else if (gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
351                    || gpg_err_code (rc) == GPG_ERR_BAD_PIN)
352             errtext = (is_pin? _("Bad PIN")
353                        : _("Bad Passphrase"));
354           else if (rc)
355             return unlock_pinentry (map_assuan_err (rc));
356         }
357
358       if (!errtext)
359         return unlock_pinentry (0); /* okay, got a PIN or passphrase */
360     }
361
362   return unlock_pinentry (gpg_error (pininfo->min_digits? GPG_ERR_BAD_PIN
363                           : GPG_ERR_BAD_PASSPHRASE));
364 }
365
366
367 \f
368 /* Ask for the passphrase using the supplied arguments.  The
369    passphrase is returned in RETPASS as an hex encoded string to be
370    freed by the caller */
371 int 
372 agent_get_passphrase (CTRL ctrl,
373                       char **retpass, const char *desc, const char *prompt,
374                       const char *errtext)
375 {
376
377   int rc;
378   char line[ASSUAN_LINELENGTH];
379   struct entry_parm_s parm;
380   unsigned char *p, *hexstring;
381   int i;
382
383   *retpass = NULL;
384   if (opt.batch)
385     return gpg_error (GPG_ERR_BAD_PASSPHRASE); 
386
387   rc = start_pinentry (ctrl);
388   if (rc)
389     return rc;
390
391   if (!prompt)
392     prompt = desc && strstr (desc, "PIN")? "PIN": _("Passphrase");
393
394
395   if (desc)
396     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
397   else
398     snprintf (line, DIM(line)-1, "RESET");
399   line[DIM(line)-1] = 0;
400   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
401   if (rc)
402     return unlock_pinentry (map_assuan_err (rc));
403
404   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt);
405   line[DIM(line)-1] = 0;
406   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
407   if (rc)
408     return unlock_pinentry (map_assuan_err (rc));
409
410   if (errtext)
411     {
412       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
413       line[DIM(line)-1] = 0;
414       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
415       if (rc)
416         return unlock_pinentry (map_assuan_err (rc));
417     }
418
419   memset (&parm, 0, sizeof parm);
420   parm.size = ASSUAN_LINELENGTH/2 - 5;
421   parm.buffer = gcry_malloc_secure (parm.size+10);
422   if (!parm.buffer)
423     return unlock_pinentry (out_of_core ());
424
425   assuan_begin_confidential (entry_ctx);
426   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL, NULL, NULL);
427   if (rc)
428     {
429       xfree (parm.buffer);
430       return unlock_pinentry (map_assuan_err (rc));
431     }
432   
433   hexstring = gcry_malloc_secure (strlen (parm.buffer)*2+1);
434   if (!hexstring)
435     {
436       gpg_error_t tmperr = out_of_core ();
437       xfree (parm.buffer);
438       return unlock_pinentry (tmperr);
439     }
440
441   for (i=0, p=parm.buffer; *p; p++, i += 2)
442     sprintf (hexstring+i, "%02X", *p);
443   
444   xfree (parm.buffer);
445   *retpass = hexstring;
446   return unlock_pinentry (0);
447 }
448
449
450 \f
451 /* Pop up the PIN-entry, display the text and the prompt and ask the
452    user to confirm this.  We return 0 for success, ie. the used
453    confirmed it, GPG_ERR_NOT_CONFIRMED for what the text says or an
454    other error. */
455 int 
456 agent_get_confirmation (CTRL ctrl,
457                         const char *desc, const char *ok, const char *cancel)
458 {
459   int rc;
460   char line[ASSUAN_LINELENGTH];
461
462   rc = start_pinentry (ctrl);
463   if (rc)
464     return rc;
465
466   if (desc)
467     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
468   else
469     snprintf (line, DIM(line)-1, "RESET");
470   line[DIM(line)-1] = 0;
471   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
472   if (rc)
473     return unlock_pinentry (map_assuan_err (rc));
474
475   if (ok)
476     {
477       snprintf (line, DIM(line)-1, "SETOK %s", ok);
478       line[DIM(line)-1] = 0;
479       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
480       if (rc)
481         return unlock_pinentry (map_assuan_err (rc));
482     }
483   if (cancel)
484     {
485       snprintf (line, DIM(line)-1, "SETCANCEL %s", cancel);
486       line[DIM(line)-1] = 0;
487       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
488       if (rc)
489         return unlock_pinentry (map_assuan_err (rc));
490     }
491
492   rc = assuan_transact (entry_ctx, "CONFIRM", NULL, NULL, NULL, NULL, NULL, NULL);
493   return unlock_pinentry (map_assuan_err (rc));
494 }
495
496
497