* Makefile.am (pkglib_PROGRAMS): Put protect-tool there.
[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   /* FIXME: change the default location of the program */
107   if (!opt.pinentry_program || !*opt.pinentry_program)
108     opt.pinentry_program = "../../pinentry/kpinentry/kpinentry";
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
240   if (opt.batch)
241     return 0; /* fixme: we should return BAD PIN */
242
243   if (!pininfo || pininfo->max_length < 1)
244     return seterr (Invalid_Value);
245   if (!desc_text)
246     desc_text = trans ("Please enter you PIN, so that the secret key "
247                        "can be unlocked for this session");
248   
249   rc = start_pinentry ();
250   if (rc)
251     return rc;
252
253   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
254   line[DIM(line)-1] = 0;
255   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
256   if (rc)
257     return unlock_pinentry (map_assuan_err (rc));
258
259   rc = assuan_transact (entry_ctx,
260                         pininfo->min_digits? "SETPROMPT PIN:"
261                                            : "SETPROMPT Passphrase:",
262                         NULL, NULL, NULL, NULL, NULL, NULL);
263   if (rc)
264     return unlock_pinentry (map_assuan_err (rc));
265
266   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
267     {
268       memset (&parm, 0, sizeof parm);
269       parm.size = pininfo->max_length;
270       parm.buffer = pininfo->pin;
271
272       if (errtext)
273         { 
274           /* fixme: should we show the try count? It must be translated */
275           snprintf (line, DIM(line)-1, "SETERROR %s (try %d of %d)",
276                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
277           line[DIM(line)-1] = 0;
278           rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
279           if (rc)
280             return unlock_pinentry (map_assuan_err (rc));
281           errtext = NULL;
282         }
283       
284       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
285                             NULL, NULL, NULL, NULL);
286       if (rc == ASSUAN_Too_Much_Data)
287         errtext = pininfo->min_digits? trans ("PIN too long")
288                                      : trans ("Passphrase too long");
289       else if (rc)
290         return unlock_pinentry (map_assuan_err (rc));
291
292       if (!errtext && pininfo->min_digits)
293         {
294           /* do some basic checks on the entered PIN. */
295           if (!all_digitsp (pininfo->pin))
296             errtext = trans ("Invalid characters in PIN");
297           else if (pininfo->max_digits
298                    && strlen (pininfo->pin) > pininfo->max_digits)
299             errtext = trans ("PIN too long");
300           else if (strlen (pininfo->pin) < pininfo->min_digits)
301             errtext = trans ("PIN too short");
302         }
303
304       if (!errtext && pininfo->check_cb)
305         {
306           /* More checks by utilizing the optional callback. */
307           pininfo->cb_errtext = NULL;
308           rc = pininfo->check_cb (pininfo);
309           if (rc == -1 && pininfo->cb_errtext)
310             errtext = pininfo->cb_errtext;
311           else if (rc == GNUPG_Bad_Passphrase || rc == GNUPG_Bad_PIN)
312             errtext = (pininfo->min_digits? trans ("Bad PIN")
313                        : trans ("Bad Passphrase"));
314           else if (rc)
315             return unlock_pinentry (map_assuan_err (rc));
316         }
317
318       if (!errtext)
319         return unlock_pinentry (0); /* okay, got a PIN or passphrase */
320     }
321
322   return unlock_pinentry (pininfo->min_digits? GNUPG_Bad_PIN
323                           : GNUPG_Bad_Passphrase);
324 }
325
326
327 \f
328 /* Ask for the passphrase using the supplied arguments.  The
329    passphrase is returned in RETPASS as an hex encoded string to be
330    freed by the caller */
331 int 
332 agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
333                       const char *errtext)
334 {
335
336   int rc;
337   char line[ASSUAN_LINELENGTH];
338   struct entry_parm_s parm;
339   unsigned char *p, *hexstring;
340   int i;
341
342   *retpass = NULL;
343   if (opt.batch)
344     return GNUPG_Bad_Passphrase; 
345
346   rc = start_pinentry ();
347   if (rc)
348     return rc;
349
350   if (desc)
351     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
352   else
353     snprintf (line, DIM(line)-1, "RESET");
354   line[DIM(line)-1] = 0;
355   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
356   if (rc)
357     return unlock_pinentry (map_assuan_err (rc));
358
359   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt? prompt : "Passphrase");
360   line[DIM(line)-1] = 0;
361   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
362   if (rc)
363     return unlock_pinentry (map_assuan_err (rc));
364
365   if (errtext)
366     {
367       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
368       line[DIM(line)-1] = 0;
369       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
370       if (rc)
371         return unlock_pinentry (map_assuan_err (rc));
372     }
373
374   memset (&parm, 0, sizeof parm);
375   parm.size = ASSUAN_LINELENGTH/2 - 5;
376   parm.buffer = gcry_malloc_secure (parm.size+10);
377   if (!parm.buffer)
378     return unlock_pinentry (seterr (Out_Of_Core));
379
380   assuan_begin_confidential (entry_ctx);
381   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL, NULL, NULL);
382   if (rc)
383     {
384       xfree (parm.buffer);
385       return unlock_pinentry (map_assuan_err (rc));
386     }
387   
388   hexstring = gcry_malloc_secure (strlen (parm.buffer)*2+1);
389   if (!hexstring)
390     {
391       xfree (parm.buffer);
392       return unlock_pinentry (seterr (Out_Of_Core));
393     }
394
395   for (i=0, p=parm.buffer; *p; p++, i += 2)
396     sprintf (hexstring+i, "%02X", *p);
397   
398   xfree (parm.buffer);
399   *retpass = hexstring;
400   return unlock_pinentry (0);
401 }
402
403
404 \f
405 /* Pop up the PIN-entry, display the text and the prompt and ask the
406    user to confirm this.  We return 0 for success, ie. the used
407    confirmed it, GNUPG_Not_Confirmed for what the text says or an
408    other error. */
409 int 
410 agent_get_confirmation (const char *desc, const char *ok, const char *cancel)
411 {
412   int rc;
413   char line[ASSUAN_LINELENGTH];
414
415   rc = start_pinentry ();
416   if (rc)
417     return rc;
418
419   if (desc)
420     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
421   else
422     snprintf (line, DIM(line)-1, "RESET");
423   line[DIM(line)-1] = 0;
424   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
425   if (rc)
426     return unlock_pinentry (map_assuan_err (rc));
427
428   if (ok)
429     {
430       snprintf (line, DIM(line)-1, "SETOK %s", ok);
431       line[DIM(line)-1] = 0;
432       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
433       if (rc)
434         return unlock_pinentry (map_assuan_err (rc));
435     }
436   if (cancel)
437     {
438       snprintf (line, DIM(line)-1, "SETCANCEL %s", cancel);
439       line[DIM(line)-1] = 0;
440       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
441       if (rc)
442         return unlock_pinentry (map_assuan_err (rc));
443     }
444
445   rc = assuan_transact (entry_ctx, "CONFIRM", NULL, NULL, NULL, NULL, NULL, NULL);
446   return unlock_pinentry (map_assuan_err (rc));
447 }
448
449
450