Make the inquire cancel fix a little bit more robust.
[gnupg.git] / agent / call-pinentry.c
1 /* call-pinentry.c - Spawn the pinentry to query stuff from the user
2  * Copyright (C) 2001, 2002, 2004, 2007, 2008,
3  *               2010  Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
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 #ifndef HAVE_W32_SYSTEM
31 # include <sys/wait.h>
32 # include <sys/types.h>
33 # include <signal.h>
34 #endif
35 #include <pth.h>
36
37 #include "agent.h"
38 #include <assuan.h>
39 #include "sysutils.h"
40 #include "i18n.h"
41
42 #ifdef _POSIX_OPEN_MAX
43 #define MAX_OPEN_FDS _POSIX_OPEN_MAX
44 #else
45 #define MAX_OPEN_FDS 20
46 #endif
47
48
49 /* Because access to the pinentry must be serialized (it is and shall
50    be a global mutual dialog) we should better timeout further
51    requests after some time.  2 minutes seem to be a reasonable
52    time. */
53 #define LOCK_TIMEOUT  (1*60)
54
55 /* The assuan context of the current pinentry. */
56 static assuan_context_t entry_ctx;
57
58 /* The control variable of the connection owning the current pinentry.
59    This is only valid if ENTRY_CTX is not NULL.  Note, that we care
60    only about the value of the pointer and that it should never be
61    dereferenced.  */
62 static ctrl_t entry_owner;
63
64 /* A mutex used to serialize access to the pinentry. */
65 static pth_mutex_t entry_lock;
66
67 /* The thread ID of the popup working thread. */
68 static pth_t  popup_tid;
69
70 /* A flag used in communication between the popup working thread and
71    its stop function. */
72 static int popup_finished;
73
74
75
76 /* Data to be passed to our callbacks, */
77 struct entry_parm_s
78 {
79   int lines;
80   size_t size;
81   unsigned char *buffer;
82 };
83
84
85
86 \f
87 /* This function must be called once to initialize this module.  This
88    has to be done before a second thread is spawned.  We can't do the
89    static initialization because Pth emulation code might not be able
90    to do a static init; in particular, it is not possible for W32. */
91 void
92 initialize_module_call_pinentry (void)
93 {
94   static int initialized;
95
96   if (!initialized)
97     {
98       if (pth_mutex_init (&entry_lock))
99         initialized = 1;
100     }
101 }
102
103
104
105 static void
106 dump_mutex_state (pth_mutex_t *m)
107 {
108 #ifdef _W32_PTH_H
109   (void)m;
110   log_printf ("unknown under W32");
111 #else
112   if (!(m->mx_state & PTH_MUTEX_INITIALIZED))
113     log_printf ("not_initialized");
114   else if (!(m->mx_state & PTH_MUTEX_LOCKED))
115     log_printf ("not_locked");
116   else
117     log_printf ("locked tid=0x%lx count=%lu", (long)m->mx_owner, m->mx_count);
118 #endif
119 }
120
121
122 /* This function may be called to print infromation pertaining to the
123    current state of this module to the log. */
124 void
125 agent_query_dump_state (void)
126 {
127   log_info ("agent_query_dump_state: entry_lock=");
128   dump_mutex_state (&entry_lock);
129   log_printf ("\n");
130   log_info ("agent_query_dump_state: entry_ctx=%p pid=%ld popup_tid=%p\n",
131             entry_ctx, (long)assuan_get_pid (entry_ctx), popup_tid);
132 }
133
134 /* Called to make sure that a popup window owned by the current
135    connection gets closed. */
136 void
137 agent_reset_query (ctrl_t ctrl)
138 {
139   if (entry_ctx && popup_tid && entry_owner == ctrl)
140     {
141       agent_popup_message_stop (ctrl);
142     }
143 }
144
145
146 /* Unlock the pinentry so that another thread can start one and
147    disconnect that pinentry - we do this after the unlock so that a
148    stalled pinentry does not block other threads.  Fixme: We should
149    have a timeout in Assuan for the disconnect operation. */
150 static int
151 unlock_pinentry (int rc)
152 {
153   assuan_context_t ctx = entry_ctx;
154
155   entry_ctx = NULL;
156   if (!pth_mutex_release (&entry_lock))
157     {
158       log_error ("failed to release the entry lock\n");
159       if (!rc)
160         rc = gpg_error (GPG_ERR_INTERNAL);
161     }
162   assuan_release (ctx);
163   return rc;
164 }
165
166
167 /* To make sure we leave no secrets in our image after forking of the
168    pinentry, we use this callback. */
169 static void
170 atfork_cb (void *opaque, int where)
171 {
172   ctrl_t ctrl = opaque;
173
174   if (!where)
175     {
176       int iterator = 0;
177       const char *name, *assname, *value;
178
179       gcry_control (GCRYCTL_TERM_SECMEM);
180
181       while ((name = session_env_list_stdenvnames (&iterator, &assname)))
182         {
183           /* For all new envvars (!ASSNAME) and the two medium old
184              ones which do have an assuan name but are conveyed using
185              environment variables, update the environment of the
186              forked process.  */
187           if (!assname
188               || !strcmp (name, "XAUTHORITY")
189               || !strcmp (name, "PINENTRY_USER_DATA"))
190             {
191               value = session_env_getenv (ctrl->session_env, name);
192               if (value)
193                 gnupg_setenv (name, value, 1);
194             }
195         }
196     }
197 }
198
199
200 static gpg_error_t
201 getinfo_pid_cb (void *opaque, const void *buffer, size_t length)
202 {
203   unsigned long *pid = opaque;
204   char pidbuf[50];
205
206   /* There is only the pid in the server's response.  */
207   if (length >= sizeof pidbuf)
208     length = sizeof pidbuf -1;
209   if (length)
210     {
211       strncpy (pidbuf, buffer, length);
212       pidbuf[length] = 0;
213       *pid = strtoul (pidbuf, NULL, 10);
214     }
215   return 0;
216 }
217
218 /* Fork off the pin entry if this has not already been done.  Note,
219    that this function must always be used to aquire the lock for the
220    pinentry - we will serialize _all_ pinentry calls.
221  */
222 static int
223 start_pinentry (ctrl_t ctrl)
224 {
225   int rc;
226   const char *pgmname;
227   assuan_context_t ctx;
228   const char *argv[5];
229   int no_close_list[3];
230   int i;
231   pth_event_t evt;
232   const char *tmpstr;
233   unsigned long pinentry_pid;
234   const char *value;
235
236   evt = pth_event (PTH_EVENT_TIME, pth_timeout (LOCK_TIMEOUT, 0));
237   if (!pth_mutex_acquire (&entry_lock, 0, evt))
238     {
239       if (pth_event_occurred (evt))
240         rc = gpg_error (GPG_ERR_TIMEOUT);
241       else
242         rc = gpg_error (GPG_ERR_INTERNAL);
243       pth_event_free (evt, PTH_FREE_THIS);
244       log_error (_("failed to acquire the pinentry lock: %s\n"),
245                  gpg_strerror (rc));
246       return rc;
247     }
248   pth_event_free (evt, PTH_FREE_THIS);
249
250   entry_owner = ctrl;
251
252   if (entry_ctx)
253     return 0;
254
255   if (opt.verbose)
256     log_info ("starting a new PIN Entry\n");
257
258 #ifdef HAVE_W32_SYSTEM
259   fflush (stdout);
260   fflush (stderr);
261 #endif
262   if (fflush (NULL))
263     {
264 #ifndef HAVE_W32_SYSTEM
265       gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
266 #endif
267       log_error ("error flushing pending output: %s\n", strerror (errno));
268       /* At least Windows XP fails here with EBADF.  According to docs
269          and Wine an fflush(NULL) is the same as _flushall.  However
270          the Wime implementaion does not flush stdin,stdout and stderr
271          - see above.  Lets try to ignore the error. */
272 #ifndef HAVE_W32_SYSTEM
273       return unlock_pinentry (tmperr);
274 #endif
275     }
276
277   if (!opt.pinentry_program || !*opt.pinentry_program)
278     opt.pinentry_program = gnupg_module_name (GNUPG_MODULE_NAME_PINENTRY);
279   pgmname = opt.pinentry_program;
280   if ( !(pgmname = strrchr (opt.pinentry_program, '/')))
281     pgmname = opt.pinentry_program;
282   else
283     pgmname++;
284
285   /* OS X needs the entire file name in argv[0], so that it can locate
286      the resource bundle.  For other systems we stick to the usual
287      convention of supplying only the name of the program.  */
288 #ifdef __APPLE__
289   argv[0] = opt.pinentry_program;
290 #else /*!__APPLE__*/
291   argv[0] = pgmname;
292 #endif /*__APPLE__*/
293
294   if (!opt.keep_display
295       && (value = session_env_getenv (ctrl->session_env, "DISPLAY")))
296     {
297       argv[1] = "--display";
298       argv[2] = value;
299       argv[3] = NULL;
300     }
301   else
302     argv[1] = NULL;
303
304   i=0;
305   if (!opt.running_detached)
306     {
307       if (log_get_fd () != -1)
308         no_close_list[i++] = assuan_fd_from_posix_fd (log_get_fd ());
309       no_close_list[i++] = assuan_fd_from_posix_fd (fileno (stderr));
310     }
311   no_close_list[i] = -1;
312
313   rc = assuan_new (&ctx);
314   if (rc)
315     {
316       log_error ("can't allocate assuan context: %s\n", gpg_strerror (rc));
317       return rc;
318     }
319   /* We don't want to log the pinentry communication to make the logs
320      easier to read.  We might want to add a new debug option to enable
321      pinentry logging.  */
322 #ifdef ASSUAN_NO_LOGGING
323   assuan_set_flag (ctx, ASSUAN_NO_LOGGING, 1);
324 #endif
325
326   /* Connect to the pinentry and perform initial handshaking.  Note
327      that atfork is used to change the environment for pinentry.  We
328      start the server in detached mode to suppress the console window
329      under Windows.  */
330   rc = assuan_pipe_connect (ctx, opt.pinentry_program, argv,
331                             no_close_list, atfork_cb, ctrl,
332                             ASSUAN_PIPE_CONNECT_DETACHED);
333   if (rc)
334     {
335       log_error ("can't connect to the PIN entry module `%s': %s\n",
336                  opt.pinentry_program, gpg_strerror (rc));
337       assuan_release (ctx);
338       return unlock_pinentry (gpg_error (GPG_ERR_NO_PIN_ENTRY));
339     }
340   entry_ctx = ctx;
341
342   if (DBG_ASSUAN)
343     log_debug ("connection to PIN entry established\n");
344
345   rc = assuan_transact (entry_ctx,
346                         opt.no_grab? "OPTION no-grab":"OPTION grab",
347                         NULL, NULL, NULL, NULL, NULL, NULL);
348   if (rc)
349     return unlock_pinentry (rc);
350
351   value = session_env_getenv (ctrl->session_env, "GPG_TTY");
352   if (value)
353     {
354       char *optstr;
355       if (asprintf (&optstr, "OPTION ttyname=%s", value) < 0 )
356         return unlock_pinentry (out_of_core ());
357       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
358                             NULL);
359       xfree (optstr);
360       if (rc)
361         return unlock_pinentry (rc);
362     }
363   value = session_env_getenv (ctrl->session_env, "TERM");
364   if (value)
365     {
366       char *optstr;
367       if (asprintf (&optstr, "OPTION ttytype=%s", value) < 0 )
368         return unlock_pinentry (out_of_core ());
369       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
370                             NULL);
371       xfree (optstr);
372       if (rc)
373         return unlock_pinentry (rc);
374     }
375   if (ctrl->lc_ctype)
376     {
377       char *optstr;
378       if (asprintf (&optstr, "OPTION lc-ctype=%s", ctrl->lc_ctype) < 0 )
379         return unlock_pinentry (out_of_core ());
380       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
381                             NULL);
382       xfree (optstr);
383       if (rc)
384         return unlock_pinentry (rc);
385     }
386   if (ctrl->lc_messages)
387     {
388       char *optstr;
389       if (asprintf (&optstr, "OPTION lc-messages=%s", ctrl->lc_messages) < 0 )
390         return unlock_pinentry (out_of_core ());
391       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
392                             NULL);
393       xfree (optstr);
394       if (rc)
395         return unlock_pinentry (rc);
396     }
397
398   {
399     /* Provide a few default strings for use by the pinentries.  This
400        may help a pinentry to avoid implementing localization code.  */
401     static struct { const char *key, *value; } tbl[] = {
402       /* TRANSLATORS: These are labels for buttons etc used in
403          Pinentries.  An underscore indicates that the next letter
404          should be used as an accelerator.  Double the underscore for
405          a literal one.  The actual to be translated text starts after
406          the second vertical bar.  */
407       { "ok",     N_("|pinentry-label|_OK") },
408       { "cancel", N_("|pinentry-label|_Cancel") },
409       { "prompt", N_("|pinentry-label|PIN:") },
410       { NULL, NULL}
411     };
412     char *optstr;
413     int idx;
414     const char *s, *s2;
415
416     for (idx=0; tbl[idx].key; idx++)
417       {
418         s = _(tbl[idx].value);
419         if (*s == '|' && (s2=strchr (s+1,'|')))
420           s = s2+1;
421         if (asprintf (&optstr, "OPTION default-%s=%s", tbl[idx].key, s) < 0 )
422           return unlock_pinentry (out_of_core ());
423         assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
424                          NULL);
425         xfree (optstr);
426       }
427   }
428
429
430   /* Tell the pinentry the name of a file it shall touch after having
431      messed with the tty.  This is optional and only supported by
432      newer pinentries and thus we do no error checking. */
433   tmpstr = opt.pinentry_touch_file;
434   if (tmpstr && !strcmp (tmpstr, "/dev/null"))
435     tmpstr = NULL;
436   else if (!tmpstr)
437     tmpstr = get_agent_socket_name ();
438   if (tmpstr)
439     {
440       char *optstr;
441
442       if (asprintf (&optstr, "OPTION touch-file=%s", tmpstr ) < 0 )
443         ;
444       else
445         {
446           assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
447                            NULL);
448           xfree (optstr);
449         }
450     }
451
452
453   /* Now ask the Pinentry for its PID.  If the Pinentry is new enough
454      it will send the pid back and we will use an inquire to notify
455      our client.  The client may answer the inquiry either with END or
456      with CAN to cancel the pinentry. */
457   rc = assuan_transact (entry_ctx, "GETINFO pid",
458                         getinfo_pid_cb, &pinentry_pid,
459                         NULL, NULL, NULL, NULL);
460   if (rc)
461     {
462       log_info ("You may want to update to a newer pinentry\n");
463       rc = 0;
464     }
465   else if (!rc && (pid_t)pinentry_pid == (pid_t)(-1))
466     log_error ("pinentry did not return a PID\n");
467   else
468     {
469       rc = agent_inq_pinentry_launched (ctrl, pinentry_pid);
470       if (gpg_err_code (rc) == GPG_ERR_CANCELED
471           || gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
472         return unlock_pinentry (gpg_err_make (GPG_ERR_SOURCE_DEFAULT,
473                                               gpg_err_code (rc)));
474       rc = 0;
475     }
476
477   return 0;
478 }
479
480
481 /* Returns True is the pinentry is currently active. If WAITSECONDS is
482    greater than zero the function will wait for this many seconds
483    before returning.  */
484 int
485 pinentry_active_p (ctrl_t ctrl, int waitseconds)
486 {
487   (void)ctrl;
488
489   if (waitseconds > 0)
490     {
491       pth_event_t evt;
492       int rc;
493
494       evt = pth_event (PTH_EVENT_TIME, pth_timeout (waitseconds, 0));
495       if (!pth_mutex_acquire (&entry_lock, 0, evt))
496         {
497           if (pth_event_occurred (evt))
498             rc = gpg_error (GPG_ERR_TIMEOUT);
499           else
500             rc = gpg_error (GPG_ERR_INTERNAL);
501           pth_event_free (evt, PTH_FREE_THIS);
502           return rc;
503         }
504       pth_event_free (evt, PTH_FREE_THIS);
505     }
506   else
507     {
508       if (!pth_mutex_acquire (&entry_lock, 1, NULL))
509         return gpg_error (GPG_ERR_LOCKED);
510     }
511
512   if (!pth_mutex_release (&entry_lock))
513     log_error ("failed to release the entry lock at %d\n", __LINE__);
514   return 0;
515 }
516
517
518 static gpg_error_t
519 getpin_cb (void *opaque, const void *buffer, size_t length)
520 {
521   struct entry_parm_s *parm = opaque;
522
523   if (!buffer)
524     return 0;
525
526   /* we expect the pin to fit on one line */
527   if (parm->lines || length >= parm->size)
528     return gpg_error (GPG_ERR_ASS_TOO_MUCH_DATA);
529
530   /* fixme: we should make sure that the assuan buffer is allocated in
531      secure memory or read the response byte by byte */
532   memcpy (parm->buffer, buffer, length);
533   parm->buffer[length] = 0;
534   parm->lines++;
535   return 0;
536 }
537
538
539 static int
540 all_digitsp( const char *s)
541 {
542   for (; *s && *s >= '0' && *s <= '9'; s++)
543     ;
544   return !*s;
545 }
546
547
548 /* Return a new malloced string by unescaping the string S.  Escaping
549    is percent escaping and '+'/space mapping.  A binary Nul will
550    silently be replaced by a 0xFF.  Function returns NULL to indicate
551    an out of memory status.  PArsing stops at the end of the string or
552    a white space character. */
553 static char *
554 unescape_passphrase_string (const unsigned char *s)
555 {
556   char *buffer, *d;
557
558   buffer = d = xtrymalloc_secure (strlen ((const char*)s)+1);
559   if (!buffer)
560     return NULL;
561   while (*s && !spacep (s))
562     {
563       if (*s == '%' && s[1] && s[2])
564         {
565           s++;
566           *d = xtoi_2 (s);
567           if (!*d)
568             *d = '\xff';
569           d++;
570           s += 2;
571         }
572       else if (*s == '+')
573         {
574           *d++ = ' ';
575           s++;
576         }
577       else
578         *d++ = *s++;
579     }
580   *d = 0;
581   return buffer;
582 }
583
584
585 /* Estimate the quality of the passphrase PW and return a value in the
586    range 0..100.  */
587 static int
588 estimate_passphrase_quality (const char *pw)
589 {
590   int goodlength = opt.min_passphrase_len + opt.min_passphrase_len/3;
591   int length;
592   const char *s;
593
594   if (goodlength < 1)
595     return 0;
596
597   for (length = 0, s = pw; *s; s++)
598     if (!spacep (s))
599       length ++;
600
601   if (length > goodlength)
602     return 100;
603   return ((length*10) / goodlength)*10;
604 }
605
606
607 /* Handle the QUALITY inquiry. */
608 static gpg_error_t
609 inq_quality (void *opaque, const char *line)
610 {
611   assuan_context_t ctx = opaque;
612   char *pin;
613   int rc;
614   int percent;
615   char numbuf[20];
616
617   if (!strncmp (line, "QUALITY", 7) && (line[7] == ' ' || !line[7]))
618     {
619       line += 7;
620       while (*line == ' ')
621         line++;
622
623       pin = unescape_passphrase_string (line);
624       if (!pin)
625         rc = gpg_error_from_syserror ();
626       else
627         {
628           percent = estimate_passphrase_quality (pin);
629           if (check_passphrase_constraints (NULL, pin, 1))
630             percent = -percent;
631           snprintf (numbuf, sizeof numbuf, "%d", percent);
632           rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
633           xfree (pin);
634         }
635     }
636   else
637     {
638       log_error ("unsupported inquiry `%s' from pinentry\n", line);
639       rc = gpg_error (GPG_ERR_ASS_UNKNOWN_INQUIRE);
640     }
641
642   return rc;
643 }
644
645
646 /* Helper for agent_askpin and agent_get_passphrase.  */
647 static int
648 setup_qualitybar (void)
649 {
650   int rc;
651   char line[ASSUAN_LINELENGTH];
652   char *tmpstr, *tmpstr2;
653   const char *tooltip;
654
655   /* TRANSLATORS: This string is displayed by Pinentry as the label
656      for the quality bar.  */
657   tmpstr = try_percent_escape (_("Quality:"), "\t\r\n\f\v");
658   snprintf (line, DIM(line)-1, "SETQUALITYBAR %s", tmpstr? tmpstr:"");
659   line[DIM(line)-1] = 0;
660   xfree (tmpstr);
661   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
662   if (rc == 103 /*(Old assuan error code)*/
663       || gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
664     ; /* Ignore Unknown Command from old Pinentry versions.  */
665   else if (rc)
666     return rc;
667
668   tmpstr2 = gnupg_get_help_string ("pinentry.qualitybar.tooltip", 0);
669   if (tmpstr2)
670     tooltip = tmpstr2;
671   else
672     {
673       /* TRANSLATORS: This string is a tooltip, shown by pinentry when
674          hovering over the quality bar.  Please use an appropriate
675          string to describe what this is about.  The length of the
676          tooltip is limited to about 900 characters.  If you do not
677          translate this entry, a default english text (see source)
678          will be used. */
679       tooltip =  _("pinentry.qualitybar.tooltip");
680       if (!strcmp ("pinentry.qualitybar.tooltip", tooltip))
681         tooltip = ("The quality of the text entered above.\n"
682                    "Please ask your administrator for "
683                    "details about the criteria.");
684     }
685   tmpstr = try_percent_escape (tooltip, "\t\r\n\f\v");
686   xfree (tmpstr2);
687   snprintf (line, DIM(line)-1, "SETQUALITYBAR_TT %s", tmpstr? tmpstr:"");
688   line[DIM(line)-1] = 0;
689   xfree (tmpstr);
690   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
691   if (rc == 103 /*(Old assuan error code)*/
692           || gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
693     ; /* Ignore Unknown Command from old pinentry versions.  */
694   else if (rc)
695     return rc;
696
697   return 0;
698 }
699
700
701 /* Check the button_info line for a close action.  */
702 static gpg_error_t
703 close_button_status_cb (void *opaque, const char *line)
704 {
705   int *flag = opaque;
706   const char *keyword = line;
707   int keywordlen;
708
709   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
710     ;
711   while (spacep (line))
712     line++;
713   if (keywordlen == 11 && !memcmp (keyword, "BUTTON_INFO", keywordlen))
714     {
715       if ( !strcmp (line, "close") )
716         *flag = 1;
717     }
718
719   return 0;
720 }
721
722
723
724 \f
725 /* Call the Entry and ask for the PIN.  We do check for a valid PIN
726    number here and repeat it as long as we have invalid formed
727    numbers. */
728 int
729 agent_askpin (ctrl_t ctrl,
730               const char *desc_text, const char *prompt_text,
731               const char *initial_errtext,
732               struct pin_entry_info_s *pininfo)
733 {
734   int rc;
735   char line[ASSUAN_LINELENGTH];
736   struct entry_parm_s parm;
737   const char *errtext = NULL;
738   int is_pin = 0;
739   int saveflag;
740   int close_button;
741
742   if (opt.batch)
743     return 0; /* fixme: we should return BAD PIN */
744
745   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
746     {
747       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
748         return gpg_error (GPG_ERR_CANCELED);
749       /*FIXME:  Implement loopback mode.  */
750       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
751     }
752
753   if (!pininfo || pininfo->max_length < 1)
754     return gpg_error (GPG_ERR_INV_VALUE);
755   if (!desc_text && pininfo->min_digits)
756     desc_text = _("Please enter your PIN, so that the secret key "
757                   "can be unlocked for this session");
758   else if (!desc_text)
759     desc_text = _("Please enter your passphrase, so that the secret key "
760                   "can be unlocked for this session");
761
762   if (prompt_text)
763     is_pin = !!strstr (prompt_text, "PIN");
764   else
765     is_pin = desc_text && strstr (desc_text, "PIN");
766
767   rc = start_pinentry (ctrl);
768   if (rc)
769     return rc;
770
771   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
772   line[DIM(line)-1] = 0;
773   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
774   if (rc)
775     return unlock_pinentry (rc);
776
777   snprintf (line, DIM(line)-1, "SETPROMPT %s",
778             prompt_text? prompt_text : is_pin? "PIN:" : "Passphrase:");
779   line[DIM(line)-1] = 0;
780   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
781   if (rc)
782     return unlock_pinentry (rc);
783
784   /* If a passphrase quality indicator has been requested and a
785      minimum passphrase length has not been disabled, send the command
786      to the pinentry.  */
787   if (pininfo->with_qualitybar && opt.min_passphrase_len )
788     {
789       rc = setup_qualitybar ();
790       if (rc)
791         return unlock_pinentry (rc);
792     }
793
794   if (initial_errtext)
795     {
796       snprintf (line, DIM(line)-1, "SETERROR %s", initial_errtext);
797       line[DIM(line)-1] = 0;
798       rc = assuan_transact (entry_ctx, line,
799                             NULL, NULL, NULL, NULL, NULL, NULL);
800       if (rc)
801         return unlock_pinentry (rc);
802     }
803
804   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
805     {
806       memset (&parm, 0, sizeof parm);
807       parm.size = pininfo->max_length;
808       *pininfo->pin = 0; /* Reset the PIN. */
809       parm.buffer = (unsigned char*)pininfo->pin;
810
811       if (errtext)
812         {
813           /* TRANLATORS: The string is appended to an error message in
814              the pinentry.  The %s is the actual error message, the
815              two %d give the current and maximum number of tries. */
816           snprintf (line, DIM(line)-1, _("SETERROR %s (try %d of %d)"),
817                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
818           line[DIM(line)-1] = 0;
819           rc = assuan_transact (entry_ctx, line,
820                                 NULL, NULL, NULL, NULL, NULL, NULL);
821           if (rc)
822             return unlock_pinentry (rc);
823           errtext = NULL;
824         }
825
826       saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
827       assuan_begin_confidential (entry_ctx);
828       close_button = 0;
829       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
830                             inq_quality, entry_ctx,
831                             close_button_status_cb, &close_button);
832       assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
833       /* Most pinentries out in the wild return the old Assuan error code
834          for canceled which gets translated to an assuan Cancel error and
835          not to the code for a user cancel.  Fix this here. */
836       if (rc && gpg_err_source (rc)
837           && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
838         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
839
840       /* Change error code in case the window close button was clicked
841          to cancel the operation.  */
842       if (close_button && gpg_err_code (rc) == GPG_ERR_CANCELED)
843         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
844
845       if (gpg_err_code (rc) == GPG_ERR_ASS_TOO_MUCH_DATA)
846         errtext = is_pin? _("PIN too long")
847                         : _("Passphrase too long");
848       else if (rc)
849         return unlock_pinentry (rc);
850
851       if (!errtext && pininfo->min_digits)
852         {
853           /* do some basic checks on the entered PIN. */
854           if (!all_digitsp (pininfo->pin))
855             errtext = _("Invalid characters in PIN");
856           else if (pininfo->max_digits
857                    && strlen (pininfo->pin) > pininfo->max_digits)
858             errtext = _("PIN too long");
859           else if (strlen (pininfo->pin) < pininfo->min_digits)
860             errtext = _("PIN too short");
861         }
862
863       if (!errtext && pininfo->check_cb)
864         {
865           /* More checks by utilizing the optional callback. */
866           pininfo->cb_errtext = NULL;
867           rc = pininfo->check_cb (pininfo);
868           if (rc == -1 && pininfo->cb_errtext)
869             errtext = pininfo->cb_errtext;
870           else if (gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
871                    || gpg_err_code (rc) == GPG_ERR_BAD_PIN)
872             errtext = (is_pin? _("Bad PIN")
873                        : _("Bad Passphrase"));
874           else if (rc)
875             return unlock_pinentry (rc);
876         }
877
878       if (!errtext)
879         return unlock_pinentry (0); /* okay, got a PIN or passphrase */
880     }
881
882   return unlock_pinentry (gpg_error (pininfo->min_digits? GPG_ERR_BAD_PIN
883                           : GPG_ERR_BAD_PASSPHRASE));
884 }
885
886
887 \f
888 /* Ask for the passphrase using the supplied arguments.  The returned
889    passphrase needs to be freed by the caller. */
890 int
891 agent_get_passphrase (ctrl_t ctrl,
892                       char **retpass, const char *desc, const char *prompt,
893                       const char *errtext, int with_qualitybar)
894 {
895
896   int rc;
897   char line[ASSUAN_LINELENGTH];
898   struct entry_parm_s parm;
899   int saveflag;
900   int close_button;
901
902   *retpass = NULL;
903   if (opt.batch)
904     return gpg_error (GPG_ERR_BAD_PASSPHRASE);
905
906   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
907     {
908       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
909         return gpg_error (GPG_ERR_CANCELED);
910
911       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
912     }
913
914   rc = start_pinentry (ctrl);
915   if (rc)
916     return rc;
917
918   if (!prompt)
919     prompt = desc && strstr (desc, "PIN")? "PIN": _("Passphrase");
920
921
922   if (desc)
923     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
924   else
925     snprintf (line, DIM(line)-1, "RESET");
926   line[DIM(line)-1] = 0;
927   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
928   if (rc)
929     return unlock_pinentry (rc);
930
931   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt);
932   line[DIM(line)-1] = 0;
933   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
934   if (rc)
935     return unlock_pinentry (rc);
936
937   if (with_qualitybar && opt.min_passphrase_len)
938     {
939       rc = setup_qualitybar ();
940       if (rc)
941         return unlock_pinentry (rc);
942     }
943
944   if (errtext)
945     {
946       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
947       line[DIM(line)-1] = 0;
948       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
949       if (rc)
950         return unlock_pinentry (rc);
951     }
952
953   memset (&parm, 0, sizeof parm);
954   parm.size = ASSUAN_LINELENGTH/2 - 5;
955   parm.buffer = gcry_malloc_secure (parm.size+10);
956   if (!parm.buffer)
957     return unlock_pinentry (out_of_core ());
958
959   saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
960   assuan_begin_confidential (entry_ctx);
961   close_button = 0;
962   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
963                         inq_quality, entry_ctx,
964                         close_button_status_cb, &close_button);
965   assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
966   /* Most pinentries out in the wild return the old Assuan error code
967      for canceled which gets translated to an assuan Cancel error and
968      not to the code for a user cancel.  Fix this here. */
969   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
970     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
971   /* Change error code in case the window close button was clicked
972      to cancel the operation.  */
973   if (close_button && gpg_err_code (rc) == GPG_ERR_CANCELED)
974     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
975
976   if (rc)
977     xfree (parm.buffer);
978   else
979     *retpass = parm.buffer;
980   return unlock_pinentry (rc);
981 }
982
983
984 \f
985 /* Pop up the PIN-entry, display the text and the prompt and ask the
986    user to confirm this.  We return 0 for success, ie. the user
987    confirmed it, GPG_ERR_NOT_CONFIRMED for what the text says or an
988    other error.  If WITH_CANCEL it true an extra cancel button is
989    displayed to allow the user to easily return a GPG_ERR_CANCELED.
990    if the Pinentry does not support this, the user can still cancel by
991    closing the Pinentry window.  */
992 int
993 agent_get_confirmation (ctrl_t ctrl,
994                         const char *desc, const char *ok,
995                         const char *notok, int with_cancel)
996 {
997   int rc;
998   char line[ASSUAN_LINELENGTH];
999
1000   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1001     {
1002       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
1003         return gpg_error (GPG_ERR_CANCELED);
1004
1005       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
1006     }
1007
1008   rc = start_pinentry (ctrl);
1009   if (rc)
1010     return rc;
1011
1012   if (desc)
1013     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1014   else
1015     snprintf (line, DIM(line)-1, "RESET");
1016   line[DIM(line)-1] = 0;
1017   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1018   /* Most pinentries out in the wild return the old Assuan error code
1019      for canceled which gets translated to an assuan Cancel error and
1020      not to the code for a user cancel.  Fix this here. */
1021   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1022     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1023
1024   if (rc)
1025     return unlock_pinentry (rc);
1026
1027   if (ok)
1028     {
1029       snprintf (line, DIM(line)-1, "SETOK %s", ok);
1030       line[DIM(line)-1] = 0;
1031       rc = assuan_transact (entry_ctx,
1032                             line, NULL, NULL, NULL, NULL, NULL, NULL);
1033       if (rc)
1034         return unlock_pinentry (rc);
1035     }
1036   if (notok)
1037     {
1038       /* Try to use the newer NOTOK feature if a cancel button is
1039          requested.  If no cancel button is requested we keep on using
1040          the standard cancel.  */
1041       if (with_cancel)
1042         {
1043           snprintf (line, DIM(line)-1, "SETNOTOK %s", notok);
1044           line[DIM(line)-1] = 0;
1045           rc = assuan_transact (entry_ctx,
1046                                 line, NULL, NULL, NULL, NULL, NULL, NULL);
1047         }
1048       else
1049         rc = GPG_ERR_ASS_UNKNOWN_CMD;
1050
1051       if (gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
1052         {
1053           snprintf (line, DIM(line)-1, "SETCANCEL %s", notok);
1054           line[DIM(line)-1] = 0;
1055           rc = assuan_transact (entry_ctx, line,
1056                                 NULL, NULL, NULL, NULL, NULL, NULL);
1057         }
1058       if (rc)
1059         return unlock_pinentry (rc);
1060     }
1061
1062   rc = assuan_transact (entry_ctx, "CONFIRM",
1063                         NULL, NULL, NULL, NULL, NULL, NULL);
1064   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1065     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1066
1067   return unlock_pinentry (rc);
1068 }
1069
1070
1071 \f
1072 /* Pop up the PINentry, display the text DESC and a button with the
1073    text OK_BTN (which may be NULL to use the default of "OK") and wait
1074    for the user to hit this button.  The return value is not
1075    relevant.  */
1076 int
1077 agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn)
1078 {
1079   int rc;
1080   char line[ASSUAN_LINELENGTH];
1081
1082   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1083     return gpg_error (GPG_ERR_CANCELED);
1084
1085   rc = start_pinentry (ctrl);
1086   if (rc)
1087     return rc;
1088
1089   if (desc)
1090     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1091   else
1092     snprintf (line, DIM(line)-1, "RESET");
1093   line[DIM(line)-1] = 0;
1094   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1095   /* Most pinentries out in the wild return the old Assuan error code
1096      for canceled which gets translated to an assuan Cancel error and
1097      not to the code for a user cancel.  Fix this here. */
1098   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1099     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1100
1101   if (rc)
1102     return unlock_pinentry (rc);
1103
1104   if (ok_btn)
1105     {
1106       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1107       line[DIM(line)-1] = 0;
1108       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL,
1109                             NULL, NULL, NULL);
1110       if (rc)
1111         return unlock_pinentry (rc);
1112     }
1113
1114   rc = assuan_transact (entry_ctx, "CONFIRM --one-button", NULL, NULL, NULL,
1115                         NULL, NULL, NULL);
1116   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1117     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1118
1119   return unlock_pinentry (rc);
1120 }
1121
1122
1123 /* The thread running the popup message. */
1124 static void *
1125 popup_message_thread (void *arg)
1126 {
1127   (void)arg;
1128
1129   /* We use the --one-button hack instead of the MESSAGE command to
1130      allow the use of old Pinentries.  Those old Pinentries will then
1131      show an additional Cancel button but that is mostly a visual
1132      annoyance. */
1133   assuan_transact (entry_ctx, "CONFIRM --one-button",
1134                    NULL, NULL, NULL, NULL, NULL, NULL);
1135   popup_finished = 1;
1136   return NULL;
1137 }
1138
1139
1140 /* Pop up a message window similar to the confirm one but keep it open
1141    until agent_popup_message_stop has been called.  It is crucial for
1142    the caller to make sure that the stop function gets called as soon
1143    as the message is not anymore required because the message is
1144    system modal and all other attempts to use the pinentry will fail
1145    (after a timeout). */
1146 int
1147 agent_popup_message_start (ctrl_t ctrl, const char *desc, const char *ok_btn)
1148 {
1149   int rc;
1150   char line[ASSUAN_LINELENGTH];
1151   pth_attr_t tattr;
1152
1153   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1154     return gpg_error (GPG_ERR_CANCELED);
1155
1156   rc = start_pinentry (ctrl);
1157   if (rc)
1158     return rc;
1159
1160   if (desc)
1161     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1162   else
1163     snprintf (line, DIM(line)-1, "RESET");
1164   line[DIM(line)-1] = 0;
1165   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1166   if (rc)
1167     return unlock_pinentry (rc);
1168
1169   if (ok_btn)
1170     {
1171       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1172       line[DIM(line)-1] = 0;
1173       rc = assuan_transact (entry_ctx, line, NULL,NULL,NULL,NULL,NULL,NULL);
1174       if (rc)
1175         return unlock_pinentry (rc);
1176     }
1177
1178   tattr = pth_attr_new();
1179   pth_attr_set (tattr, PTH_ATTR_JOINABLE, 1);
1180   pth_attr_set (tattr, PTH_ATTR_STACK_SIZE, 256*1024);
1181   pth_attr_set (tattr, PTH_ATTR_NAME, "popup-message");
1182
1183   popup_finished = 0;
1184   popup_tid = pth_spawn (tattr, popup_message_thread, NULL);
1185   if (!popup_tid)
1186     {
1187       rc = gpg_error_from_syserror ();
1188       log_error ("error spawning popup message handler: %s\n",
1189                  strerror (errno) );
1190       pth_attr_destroy (tattr);
1191       return unlock_pinentry (rc);
1192     }
1193   pth_attr_destroy (tattr);
1194
1195   return 0;
1196 }
1197
1198 /* Close a popup window. */
1199 void
1200 agent_popup_message_stop (ctrl_t ctrl)
1201 {
1202   int rc;
1203   pid_t pid;
1204
1205   (void)ctrl;
1206
1207   if (!popup_tid || !entry_ctx)
1208     {
1209       log_debug ("agent_popup_message_stop called with no active popup\n");
1210       return;
1211     }
1212
1213   pid = assuan_get_pid (entry_ctx);
1214   if (pid == (pid_t)(-1))
1215     ; /* No pid available can't send a kill. */
1216   else if (popup_finished)
1217     ; /* Already finished and ready for joining. */
1218 #ifdef HAVE_W32_SYSTEM
1219   /* Older versions of assuan set PID to 0 on Windows to indicate an
1220      invalid value.  */
1221   else if (pid != (pid_t) INVALID_HANDLE_VALUE
1222            && pid != 0)
1223     {
1224       HANDLE process = (HANDLE) pid;
1225
1226       /* Arbitrary error code.  */
1227       TerminateProcess (process, 1);
1228     }
1229 #else
1230   else if (pid && ((rc=waitpid (pid, NULL, WNOHANG))==-1 || (rc == pid)) )
1231     { /* The daemon already died.  No need to send a kill.  However
1232          because we already waited for the process, we need to tell
1233          assuan that it should not wait again (done by
1234          unlock_pinentry). */
1235       if (rc == pid)
1236         assuan_set_flag (entry_ctx, ASSUAN_NO_WAITPID, 1);
1237     }
1238   else if (pid > 0)
1239     kill (pid, SIGKILL);  /* Need to use SIGKILL due to bad
1240                              interaction of SIGINT with Pth. */
1241 #endif
1242
1243   /* Now wait for the thread to terminate. */
1244   rc = pth_join (popup_tid, NULL);
1245   if (!rc)
1246     log_debug ("agent_popup_message_stop: pth_join failed: %s\n",
1247                strerror (errno));
1248   popup_tid = NULL;
1249   entry_owner = NULL;
1250
1251   /* Now we can close the connection. */
1252   unlock_pinentry (0);
1253 }