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