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