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