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