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