g10: Avoid an unnecessary copy.
[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 <npth.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 mutually exclusive dialog) we better timeout pending
51    requests after some time.  1 minute 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 npth_mutex_t entry_lock;
66
67 /* The thread ID of the popup working thread. */
68 static npth_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 (npth_mutex_init (&entry_lock, NULL))
99         initialized = 1;
100     }
101 }
102
103
104
105 /* This function may be called to print infromation pertaining to the
106    current state of this module to the log. */
107 void
108 agent_query_dump_state (void)
109 {
110   log_info ("agent_query_dump_state: entry_ctx=%p pid=%ld popup_tid=%p\n",
111             entry_ctx, (long)assuan_get_pid (entry_ctx), (void*)popup_tid);
112 }
113
114 /* Called to make sure that a popup window owned by the current
115    connection gets closed. */
116 void
117 agent_reset_query (ctrl_t ctrl)
118 {
119   if (entry_ctx && popup_tid && entry_owner == ctrl)
120     {
121       agent_popup_message_stop (ctrl);
122     }
123 }
124
125
126 /* Unlock the pinentry so that another thread can start one and
127    disconnect that pinentry - we do this after the unlock so that a
128    stalled pinentry does not block other threads.  Fixme: We should
129    have a timeout in Assuan for the disconnect operation. */
130 static int
131 unlock_pinentry (int rc)
132 {
133   assuan_context_t ctx = entry_ctx;
134   int err;
135
136   if (rc)
137     {
138       if (DBG_IPC)
139         log_debug ("error calling pinentry: %s <%s>\n",
140                    gpg_strerror (rc), gpg_strsource (rc));
141
142       /* Change the source of the error to pinentry so that the final
143          consumer of the error code knows that the problem is with
144          pinentry.  For backward compatibility we do not do that for
145          some common error codes.  */
146       switch (gpg_err_code (rc))
147         {
148         case GPG_ERR_NO_PIN_ENTRY:
149         case GPG_ERR_CANCELED:
150         case GPG_ERR_FULLY_CANCELED:
151         case GPG_ERR_ASS_UNKNOWN_INQUIRE:
152         case GPG_ERR_ASS_TOO_MUCH_DATA:
153         case GPG_ERR_NO_PASSPHRASE:
154         case GPG_ERR_BAD_PASSPHRASE:
155         case GPG_ERR_BAD_PIN:
156           break;
157
158         default:
159           rc = gpg_err_make (GPG_ERR_SOURCE_PINENTRY, gpg_err_code (rc));
160           break;
161         }
162     }
163
164   entry_ctx = NULL;
165   err = npth_mutex_unlock (&entry_lock);
166   if (err)
167     {
168       log_error ("failed to release the entry lock: %s\n", strerror (err));
169       if (!rc)
170         rc = gpg_error_from_errno (err);
171     }
172   assuan_release (ctx);
173   return rc;
174 }
175
176
177 /* To make sure we leave no secrets in our image after forking of the
178    pinentry, we use this callback. */
179 static void
180 atfork_cb (void *opaque, int where)
181 {
182   ctrl_t ctrl = opaque;
183
184   if (!where)
185     {
186       int iterator = 0;
187       const char *name, *assname, *value;
188
189       gcry_control (GCRYCTL_TERM_SECMEM);
190
191       while ((name = session_env_list_stdenvnames (&iterator, &assname)))
192         {
193           /* For all new envvars (!ASSNAME) and the two medium old
194              ones which do have an assuan name but are conveyed using
195              environment variables, update the environment of the
196              forked process.  */
197           if (!assname
198               || !strcmp (name, "XAUTHORITY")
199               || !strcmp (name, "PINENTRY_USER_DATA"))
200             {
201               value = session_env_getenv (ctrl->session_env, name);
202               if (value)
203                 gnupg_setenv (name, value, 1);
204             }
205         }
206     }
207 }
208
209
210 static gpg_error_t
211 getinfo_pid_cb (void *opaque, const void *buffer, size_t length)
212 {
213   unsigned long *pid = opaque;
214   char pidbuf[50];
215
216   /* There is only the pid in the server's response.  */
217   if (length >= sizeof pidbuf)
218     length = sizeof pidbuf -1;
219   if (length)
220     {
221       strncpy (pidbuf, buffer, length);
222       pidbuf[length] = 0;
223       *pid = strtoul (pidbuf, NULL, 10);
224     }
225   return 0;
226 }
227
228 /* Fork off the pin entry if this has not already been done.  Note,
229    that this function must always be used to aquire the lock for the
230    pinentry - we will serialize _all_ pinentry calls.
231  */
232 static int
233 start_pinentry (ctrl_t ctrl)
234 {
235   int rc = 0;
236   const char *full_pgmname;
237   const char *pgmname;
238   assuan_context_t ctx;
239   const char *argv[5];
240   assuan_fd_t no_close_list[3];
241   int i;
242   const char *tmpstr;
243   unsigned long pinentry_pid;
244   const char *value;
245   struct timespec abstime;
246   int err;
247
248   npth_clock_gettime (&abstime);
249   abstime.tv_sec += LOCK_TIMEOUT;
250   err = npth_mutex_timedlock (&entry_lock, &abstime);
251   if (err)
252     {
253       if (err == ETIMEDOUT)
254         rc = gpg_error (GPG_ERR_TIMEOUT);
255       else
256         rc = gpg_error_from_errno (rc);
257       log_error (_("failed to acquire the pinentry lock: %s\n"),
258                  gpg_strerror (rc));
259       return rc;
260     }
261
262   entry_owner = ctrl;
263
264   if (entry_ctx)
265     return 0;
266
267   if (opt.verbose)
268     log_info ("starting a new PIN Entry\n");
269
270 #ifdef HAVE_W32_SYSTEM
271   fflush (stdout);
272   fflush (stderr);
273 #endif
274   if (fflush (NULL))
275     {
276 #ifndef HAVE_W32_SYSTEM
277       gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
278 #endif
279       log_error ("error flushing pending output: %s\n", strerror (errno));
280       /* At least Windows XP fails here with EBADF.  According to docs
281          and Wine an fflush(NULL) is the same as _flushall.  However
282          the Wine implementaion does not flush stdin,stdout and stderr
283          - see above.  Let's try to ignore the error. */
284 #ifndef HAVE_W32_SYSTEM
285       return unlock_pinentry (tmperr);
286 #endif
287     }
288
289   full_pgmname = opt.pinentry_program;
290   if (!full_pgmname || !*full_pgmname)
291     full_pgmname = gnupg_module_name (GNUPG_MODULE_NAME_PINENTRY);
292   if ( !(pgmname = strrchr (full_pgmname, '/')))
293     pgmname = full_pgmname;
294   else
295     pgmname++;
296
297   /* OS X needs the entire file name in argv[0], so that it can locate
298      the resource bundle.  For other systems we stick to the usual
299      convention of supplying only the name of the program.  */
300 #ifdef __APPLE__
301   argv[0] = full_pgmname;
302 #else /*!__APPLE__*/
303   argv[0] = pgmname;
304 #endif /*__APPLE__*/
305
306   if (!opt.keep_display
307       && (value = session_env_getenv (ctrl->session_env, "DISPLAY")))
308     {
309       argv[1] = "--display";
310       argv[2] = value;
311       argv[3] = NULL;
312     }
313   else
314     argv[1] = NULL;
315
316   i=0;
317   if (!opt.running_detached)
318     {
319       if (log_get_fd () != -1)
320         no_close_list[i++] = assuan_fd_from_posix_fd (log_get_fd ());
321       no_close_list[i++] = assuan_fd_from_posix_fd (fileno (stderr));
322     }
323   no_close_list[i] = ASSUAN_INVALID_FD;
324
325   rc = assuan_new (&ctx);
326   if (rc)
327     {
328       log_error ("can't allocate assuan context: %s\n", gpg_strerror (rc));
329       return rc;
330     }
331   /* We don't want to log the pinentry communication to make the logs
332      easier to read.  We might want to add a new debug option to enable
333      pinentry logging.  */
334 #ifdef ASSUAN_NO_LOGGING
335   assuan_set_flag (ctx, ASSUAN_NO_LOGGING, !opt.debug_pinentry);
336 #endif
337
338   /* Connect to the pinentry and perform initial handshaking.  Note
339      that atfork is used to change the environment for pinentry.  We
340      start the server in detached mode to suppress the console window
341      under Windows.  */
342   rc = assuan_pipe_connect (ctx, full_pgmname, argv,
343                             no_close_list, atfork_cb, ctrl,
344                             ASSUAN_PIPE_CONNECT_DETACHED);
345   if (rc)
346     {
347       log_error ("can't connect to the PIN entry module '%s': %s\n",
348                  full_pgmname, gpg_strerror (rc));
349       assuan_release (ctx);
350       return unlock_pinentry (gpg_error (GPG_ERR_NO_PIN_ENTRY));
351     }
352   entry_ctx = ctx;
353
354   if (DBG_IPC)
355     log_debug ("connection to PIN entry established\n");
356
357   rc = assuan_transact (entry_ctx,
358                         opt.no_grab? "OPTION no-grab":"OPTION grab",
359                         NULL, NULL, NULL, NULL, NULL, NULL);
360   if (rc)
361     return unlock_pinentry (rc);
362
363   value = session_env_getenv (ctrl->session_env, "GPG_TTY");
364   if (value)
365     {
366       char *optstr;
367       if (asprintf (&optstr, "OPTION ttyname=%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   value = session_env_getenv (ctrl->session_env, "TERM");
376   if (value)
377     {
378       char *optstr;
379       if (asprintf (&optstr, "OPTION ttytype=%s", value) < 0 )
380         return unlock_pinentry (out_of_core ());
381       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
382                             NULL);
383       xfree (optstr);
384       if (rc)
385         return unlock_pinentry (rc);
386     }
387   if (ctrl->lc_ctype)
388     {
389       char *optstr;
390       if (asprintf (&optstr, "OPTION lc-ctype=%s", ctrl->lc_ctype) < 0 )
391         return unlock_pinentry (out_of_core ());
392       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
393                             NULL);
394       xfree (optstr);
395       if (rc)
396         return unlock_pinentry (rc);
397     }
398   if (ctrl->lc_messages)
399     {
400       char *optstr;
401       if (asprintf (&optstr, "OPTION lc-messages=%s", ctrl->lc_messages) < 0 )
402         return unlock_pinentry (out_of_core ());
403       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
404                             NULL);
405       xfree (optstr);
406       if (rc)
407         return unlock_pinentry (rc);
408     }
409
410
411   if (opt.allow_external_cache)
412     {
413       /* Indicate to the pinentry that it may read from an external cache.
414
415          It is essential that the pinentry respect this.  If the
416          cached password is not up to date and retry == 1, then, using
417          a version of GPG Agent that doesn't support this, won't issue
418          another pin request and the user won't get a chance to
419          correct the password.  */
420       rc = assuan_transact (entry_ctx, "OPTION allow-external-password-cache",
421                             NULL, NULL, NULL, NULL, NULL, NULL);
422       if (rc && gpg_err_code (rc) != GPG_ERR_UNKNOWN_OPTION)
423         return unlock_pinentry (rc);
424     }
425
426   if (opt.allow_emacs_pinentry)
427     {
428       /* Indicate to the pinentry that it may read passphrase through
429          Emacs minibuffer, if possible.  */
430       rc = assuan_transact (entry_ctx, "OPTION allow-emacs-prompt",
431                             NULL, NULL, NULL, NULL, NULL, NULL);
432       if (rc && gpg_err_code (rc) != GPG_ERR_UNKNOWN_OPTION)
433         return unlock_pinentry (rc);
434     }
435
436
437   {
438     /* Provide a few default strings for use by the pinentries.  This
439        may help a pinentry to avoid implementing localization code.  */
440     static struct { const char *key, *value; int what; } tbl[] = {
441       /* TRANSLATORS: These are labels for buttons etc used in
442          Pinentries.  An underscore indicates that the next letter
443          should be used as an accelerator.  Double the underscore for
444          a literal one.  The actual to be translated text starts after
445          the second vertical bar.  Note that gpg-agent has been set to
446          utf-8 so that the strings are in the expected encoding.  */
447       { "ok",     N_("|pinentry-label|_OK") },
448       { "cancel", N_("|pinentry-label|_Cancel") },
449       { "yes",    N_("|pinentry-label|_Yes") },
450       { "no",     N_("|pinentry-label|_No") },
451       { "prompt", N_("|pinentry-label|PIN:") },
452       { "pwmngr", N_("|pinentry-label|_Save in password manager"), 1 },
453       { "cf-visi",N_("Do you really want to make your "
454                      "passphrase visible on the screen?") },
455       { "tt-visi",N_("|pinentry-tt|Make passphrase visible") },
456       { "tt-hide",N_("|pinentry-tt|Hide passphrase") },
457       { NULL, NULL}
458     };
459     char *optstr;
460     int idx;
461     const char *s, *s2;
462
463     for (idx=0; tbl[idx].key; idx++)
464       {
465         if (!opt.allow_external_cache && tbl[idx].what == 1)
466           continue;  /* No need for it.  */
467         s = L_(tbl[idx].value);
468         if (*s == '|' && (s2=strchr (s+1,'|')))
469           s = s2+1;
470         if (asprintf (&optstr, "OPTION default-%s=%s", tbl[idx].key, s) < 0 )
471           return unlock_pinentry (out_of_core ());
472         assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
473                          NULL);
474         xfree (optstr);
475       }
476   }
477
478   /* Tell the pinentry that we would prefer that the given character
479      is used as the invisible character by the entry widget.  */
480   if (opt.pinentry_invisible_char)
481     {
482       char *optstr;
483       if ((optstr = xtryasprintf ("OPTION invisible-char=%s",
484                                   opt.pinentry_invisible_char)))
485         {
486           assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
487                            NULL);
488           /* We ignore errors because this is just a fancy thing and
489              older pinentries do not support this feature.  */
490           xfree (optstr);
491         }
492     }
493
494   /* Tell the pinentry the name of a file it shall touch after having
495      messed with the tty.  This is optional and only supported by
496      newer pinentries and thus we do no error checking. */
497   tmpstr = opt.pinentry_touch_file;
498   if (tmpstr && !strcmp (tmpstr, "/dev/null"))
499     tmpstr = NULL;
500   else if (!tmpstr)
501     tmpstr = get_agent_socket_name ();
502   if (tmpstr)
503     {
504       char *optstr;
505
506       if (asprintf (&optstr, "OPTION touch-file=%s", tmpstr ) < 0 )
507         ;
508       else
509         {
510           assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
511                            NULL);
512           xfree (optstr);
513         }
514     }
515
516
517   /* Now ask the Pinentry for its PID.  If the Pinentry is new enough
518      it will send the pid back and we will use an inquire to notify
519      our client.  The client may answer the inquiry either with END or
520      with CAN to cancel the pinentry. */
521   rc = assuan_transact (entry_ctx, "GETINFO pid",
522                         getinfo_pid_cb, &pinentry_pid,
523                         NULL, NULL, NULL, NULL);
524   if (rc)
525     {
526       log_info ("You may want to update to a newer pinentry\n");
527       rc = 0;
528     }
529   else if (!rc && (pid_t)pinentry_pid == (pid_t)(-1))
530     log_error ("pinentry did not return a PID\n");
531   else
532     {
533       rc = agent_inq_pinentry_launched (ctrl, pinentry_pid);
534       if (gpg_err_code (rc) == GPG_ERR_CANCELED
535           || gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
536         return unlock_pinentry (gpg_err_make (GPG_ERR_SOURCE_DEFAULT,
537                                               gpg_err_code (rc)));
538       rc = 0;
539     }
540
541   return 0;
542 }
543
544
545 /* Returns True if the pinentry is currently active. If WAITSECONDS is
546    greater than zero the function will wait for this many seconds
547    before returning.  */
548 int
549 pinentry_active_p (ctrl_t ctrl, int waitseconds)
550 {
551   int err;
552   (void)ctrl;
553
554   if (waitseconds > 0)
555     {
556       struct timespec abstime;
557       int rc;
558
559       npth_clock_gettime (&abstime);
560       abstime.tv_sec += waitseconds;
561       err = npth_mutex_timedlock (&entry_lock, &abstime);
562       if (err)
563         {
564           if (err == ETIMEDOUT)
565             rc = gpg_error (GPG_ERR_TIMEOUT);
566           else
567             rc = gpg_error (GPG_ERR_INTERNAL);
568           return rc;
569         }
570     }
571   else
572     {
573       err = npth_mutex_trylock (&entry_lock);
574       if (err)
575         return gpg_error (GPG_ERR_LOCKED);
576     }
577
578   err = npth_mutex_unlock (&entry_lock);
579   if (err)
580     log_error ("failed to release the entry lock at %d: %s\n", __LINE__,
581                strerror (errno));
582   return 0;
583 }
584
585
586 static gpg_error_t
587 getpin_cb (void *opaque, const void *buffer, size_t length)
588 {
589   struct entry_parm_s *parm = opaque;
590
591   if (!buffer)
592     return 0;
593
594   /* we expect the pin to fit on one line */
595   if (parm->lines || length >= parm->size)
596     return gpg_error (GPG_ERR_ASS_TOO_MUCH_DATA);
597
598   /* fixme: we should make sure that the assuan buffer is allocated in
599      secure memory or read the response byte by byte */
600   memcpy (parm->buffer, buffer, length);
601   parm->buffer[length] = 0;
602   parm->lines++;
603   return 0;
604 }
605
606
607 static int
608 all_digitsp( const char *s)
609 {
610   for (; *s && *s >= '0' && *s <= '9'; s++)
611     ;
612   return !*s;
613 }
614
615
616 /* Return a new malloced string by unescaping the string S.  Escaping
617    is percent escaping and '+'/space mapping.  A binary Nul will
618    silently be replaced by a 0xFF.  Function returns NULL to indicate
619    an out of memory status.  Parsing stops at the end of the string or
620    a white space character. */
621 static char *
622 unescape_passphrase_string (const unsigned char *s)
623 {
624   char *buffer, *d;
625
626   buffer = d = xtrymalloc_secure (strlen ((const char*)s)+1);
627   if (!buffer)
628     return NULL;
629   while (*s && !spacep (s))
630     {
631       if (*s == '%' && s[1] && s[2])
632         {
633           s++;
634           *d = xtoi_2 (s);
635           if (!*d)
636             *d = '\xff';
637           d++;
638           s += 2;
639         }
640       else if (*s == '+')
641         {
642           *d++ = ' ';
643           s++;
644         }
645       else
646         *d++ = *s++;
647     }
648   *d = 0;
649   return buffer;
650 }
651
652
653 /* Estimate the quality of the passphrase PW and return a value in the
654    range 0..100.  */
655 static int
656 estimate_passphrase_quality (const char *pw)
657 {
658   int goodlength = opt.min_passphrase_len + opt.min_passphrase_len/3;
659   int length;
660   const char *s;
661
662   if (goodlength < 1)
663     return 0;
664
665   for (length = 0, s = pw; *s; s++)
666     if (!spacep (s))
667       length ++;
668
669   if (length > goodlength)
670     return 100;
671   return ((length*10) / goodlength)*10;
672 }
673
674
675 /* Handle the QUALITY inquiry. */
676 static gpg_error_t
677 inq_quality (void *opaque, const char *line)
678 {
679   assuan_context_t ctx = opaque;
680   const char *s;
681   char *pin;
682   int rc;
683   int percent;
684   char numbuf[20];
685
686   if ((s = has_leading_keyword (line, "QUALITY")))
687     {
688       pin = unescape_passphrase_string (s);
689       if (!pin)
690         rc = gpg_error_from_syserror ();
691       else
692         {
693           percent = estimate_passphrase_quality (pin);
694           if (check_passphrase_constraints (NULL, pin, NULL))
695             percent = -percent;
696           snprintf (numbuf, sizeof numbuf, "%d", percent);
697           rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
698           xfree (pin);
699         }
700     }
701   else
702     {
703       log_error ("unsupported inquiry '%s' from pinentry\n", line);
704       rc = gpg_error (GPG_ERR_ASS_UNKNOWN_INQUIRE);
705     }
706
707   return rc;
708 }
709
710
711 /* Helper for agent_askpin and agent_get_passphrase.  */
712 static int
713 setup_qualitybar (ctrl_t ctrl)
714 {
715   int rc;
716   char line[ASSUAN_LINELENGTH];
717   char *tmpstr, *tmpstr2;
718   const char *tooltip;
719
720   /* TRANSLATORS: This string is displayed by Pinentry as the label
721      for the quality bar.  */
722   tmpstr = try_percent_escape (L_("Quality:"), "\t\r\n\f\v");
723   snprintf (line, DIM(line)-1, "SETQUALITYBAR %s", tmpstr? tmpstr:"");
724   line[DIM(line)-1] = 0;
725   xfree (tmpstr);
726   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
727   if (rc == 103 /*(Old assuan error code)*/
728       || gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
729     ; /* Ignore Unknown Command from old Pinentry versions.  */
730   else if (rc)
731     return rc;
732
733   tmpstr2 = gnupg_get_help_string ("pinentry.qualitybar.tooltip", 0);
734   if (tmpstr2)
735     tooltip = tmpstr2;
736   else
737     {
738       /* TRANSLATORS: This string is a tooltip, shown by pinentry when
739          hovering over the quality bar.  Please use an appropriate
740          string to describe what this is about.  The length of the
741          tooltip is limited to about 900 characters.  If you do not
742          translate this entry, a default english text (see source)
743          will be used. */
744       tooltip =  L_("pinentry.qualitybar.tooltip");
745       if (!strcmp ("pinentry.qualitybar.tooltip", tooltip))
746         tooltip = ("The quality of the text entered above.\n"
747                    "Please ask your administrator for "
748                    "details about the criteria.");
749     }
750   tmpstr = try_percent_escape (tooltip, "\t\r\n\f\v");
751   xfree (tmpstr2);
752   snprintf (line, DIM(line)-1, "SETQUALITYBAR_TT %s", tmpstr? tmpstr:"");
753   line[DIM(line)-1] = 0;
754   xfree (tmpstr);
755   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
756   if (rc == 103 /*(Old assuan error code)*/
757           || gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
758     ; /* Ignore Unknown Command from old pinentry versions.  */
759   else if (rc)
760     return rc;
761
762   return 0;
763 }
764
765 enum
766   {
767     PINENTRY_STATUS_CLOSE_BUTTON = 1 << 0,
768     PINENTRY_STATUS_PIN_REPEATED = 1 << 8,
769     PINENTRY_STATUS_PASSWORD_FROM_CACHE = 1 << 9
770   };
771
772 /* Check the button_info line for a close action.  Also check for the
773    PIN_REPEATED flag.  */
774 static gpg_error_t
775 pinentry_status_cb (void *opaque, const char *line)
776 {
777   unsigned int *flag = opaque;
778   const char *args;
779
780   if ((args = has_leading_keyword (line, "BUTTON_INFO")))
781     {
782       if (!strcmp (args, "close"))
783         *flag |= PINENTRY_STATUS_CLOSE_BUTTON;
784     }
785   else if (has_leading_keyword (line, "PIN_REPEATED"))
786     {
787       *flag |= PINENTRY_STATUS_PIN_REPEATED;
788     }
789   else if (has_leading_keyword (line, "PASSWORD_FROM_CACHE"))
790     {
791       *flag |= PINENTRY_STATUS_PASSWORD_FROM_CACHE;
792     }
793
794   return 0;
795 }
796
797
798
799 \f
800 /* Call the Entry and ask for the PIN.  We do check for a valid PIN
801    number here and repeat it as long as we have invalid formed
802    numbers.  KEYINFO and CACHE_MODE are used to tell pinentry something
803    about the key. */
804 int
805 agent_askpin (ctrl_t ctrl,
806               const char *desc_text, const char *prompt_text,
807               const char *initial_errtext,
808               struct pin_entry_info_s *pininfo,
809               const char *keyinfo, cache_mode_t cache_mode)
810 {
811   int rc;
812   char line[ASSUAN_LINELENGTH];
813   struct entry_parm_s parm;
814   const char *errtext = NULL;
815   int is_pin = 0;
816   int saveflag;
817   unsigned int pinentry_status;
818
819   if (opt.batch)
820     return 0; /* fixme: we should return BAD PIN */
821
822   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
823     {
824       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
825         return gpg_error (GPG_ERR_CANCELED);
826       if (ctrl->pinentry_mode == PINENTRY_MODE_LOOPBACK)
827         {
828           unsigned char *passphrase;
829           size_t size;
830
831           *pininfo->pin = 0; /* Reset the PIN. */
832           rc = pinentry_loopback(ctrl, "PASSPHRASE", &passphrase, &size,
833                   pininfo->max_length);
834           if (rc)
835             return rc;
836
837           memcpy(&pininfo->pin, passphrase, size);
838           xfree(passphrase);
839           pininfo->pin[size] = 0;
840           if (pininfo->check_cb)
841             {
842               /* More checks by utilizing the optional callback. */
843               pininfo->cb_errtext = NULL;
844               rc = pininfo->check_cb (pininfo);
845             }
846           return rc;
847         }
848       return gpg_error(GPG_ERR_NO_PIN_ENTRY);
849     }
850
851   if (!pininfo || pininfo->max_length < 1)
852     return gpg_error (GPG_ERR_INV_VALUE);
853   if (!desc_text && pininfo->min_digits)
854     desc_text = L_("Please enter your PIN, so that the secret key "
855                    "can be unlocked for this session");
856   else if (!desc_text)
857     desc_text = L_("Please enter your passphrase, so that the secret key "
858                    "can be unlocked for this session");
859
860   if (prompt_text)
861     is_pin = !!strstr (prompt_text, "PIN");
862   else
863     is_pin = desc_text && strstr (desc_text, "PIN");
864
865   rc = start_pinentry (ctrl);
866   if (rc)
867     return rc;
868
869   /* If we have a KEYINFO string and are normal, user, or ssh cache
870      mode, we tell that the Pinentry so it may use it for own caching
871      purposes.  Most pinentries won't have this implemented and thus
872      we do not error out in this case.  */
873   if (keyinfo && (cache_mode == CACHE_MODE_NORMAL
874                   || cache_mode == CACHE_MODE_USER
875                   || cache_mode == CACHE_MODE_SSH))
876     snprintf (line, DIM(line)-1, "SETKEYINFO %c/%s",
877               cache_mode == CACHE_MODE_USER? 'u' :
878               cache_mode == CACHE_MODE_SSH? 's' : 'n',
879               keyinfo);
880   else
881     snprintf (line, DIM(line)-1, "SETKEYINFO --clear");
882
883   rc = assuan_transact (entry_ctx, line,
884                         NULL, NULL, NULL, NULL, NULL, NULL);
885   if (rc && gpg_err_code (rc) != GPG_ERR_ASS_UNKNOWN_CMD)
886     return unlock_pinentry (rc);
887
888   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
889   line[DIM(line)-1] = 0;
890   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
891   if (rc)
892     return unlock_pinentry (rc);
893
894   snprintf (line, DIM(line)-1, "SETPROMPT %s",
895             prompt_text? prompt_text : is_pin? L_("PIN:") : L_("Passphrase:"));
896   line[DIM(line)-1] = 0;
897   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
898   if (rc)
899     return unlock_pinentry (rc);
900
901   /* If a passphrase quality indicator has been requested and a
902      minimum passphrase length has not been disabled, send the command
903      to the pinentry.  */
904   if (pininfo->with_qualitybar && opt.min_passphrase_len )
905     {
906       rc = setup_qualitybar (ctrl);
907       if (rc)
908         return unlock_pinentry (rc);
909     }
910
911   if (initial_errtext)
912     {
913       snprintf (line, DIM(line)-1, "SETERROR %s", initial_errtext);
914       line[DIM(line)-1] = 0;
915       rc = assuan_transact (entry_ctx, line,
916                             NULL, NULL, NULL, NULL, NULL, NULL);
917       if (rc)
918         return unlock_pinentry (rc);
919     }
920
921   if (pininfo->with_repeat)
922     {
923       snprintf (line, DIM(line)-1, "SETREPEATERROR %s",
924                 L_("does not match - try again"));
925       line[DIM(line)-1] = 0;
926       rc = assuan_transact (entry_ctx, line,
927                             NULL, NULL, NULL, NULL, NULL, NULL);
928       if (rc)
929         pininfo->with_repeat = 0; /* Pinentry does not support it.  */
930     }
931   pininfo->repeat_okay = 0;
932
933   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
934     {
935       memset (&parm, 0, sizeof parm);
936       parm.size = pininfo->max_length;
937       *pininfo->pin = 0; /* Reset the PIN. */
938       parm.buffer = (unsigned char*)pininfo->pin;
939
940       if (errtext)
941         {
942           /* TRANSLATORS: The string is appended to an error message in
943              the pinentry.  The %s is the actual error message, the
944              two %d give the current and maximum number of tries. */
945           snprintf (line, DIM(line)-1, L_("SETERROR %s (try %d of %d)"),
946                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
947           line[DIM(line)-1] = 0;
948           rc = assuan_transact (entry_ctx, line,
949                                 NULL, NULL, NULL, NULL, NULL, NULL);
950           if (rc)
951             return unlock_pinentry (rc);
952           errtext = NULL;
953         }
954
955       if (pininfo->with_repeat)
956         {
957           snprintf (line, DIM(line)-1, "SETREPEAT %s", L_("Repeat:"));
958           line[DIM(line)-1] = 0;
959           rc = assuan_transact (entry_ctx, line,
960                                 NULL, NULL, NULL, NULL, NULL, NULL);
961           if (rc)
962             return unlock_pinentry (rc);
963         }
964
965       saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
966       assuan_begin_confidential (entry_ctx);
967       pinentry_status = 0;
968       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
969                             inq_quality, entry_ctx,
970                             pinentry_status_cb, &pinentry_status);
971       assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
972       /* Most pinentries out in the wild return the old Assuan error code
973          for canceled which gets translated to an assuan Cancel error and
974          not to the code for a user cancel.  Fix this here. */
975       if (rc && gpg_err_source (rc)
976           && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
977         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
978
979
980       /* Change error code in case the window close button was clicked
981          to cancel the operation.  */
982       if ((pinentry_status & PINENTRY_STATUS_CLOSE_BUTTON)
983           && gpg_err_code (rc) == GPG_ERR_CANCELED)
984         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
985
986       if (gpg_err_code (rc) == GPG_ERR_ASS_TOO_MUCH_DATA)
987         errtext = is_pin? L_("PIN too long")
988                         : L_("Passphrase too long");
989       else if (rc)
990         return unlock_pinentry (rc);
991
992       if (!errtext && pininfo->min_digits)
993         {
994           /* do some basic checks on the entered PIN. */
995           if (!all_digitsp (pininfo->pin))
996             errtext = L_("Invalid characters in PIN");
997           else if (pininfo->max_digits
998                    && strlen (pininfo->pin) > pininfo->max_digits)
999             errtext = L_("PIN too long");
1000           else if (strlen (pininfo->pin) < pininfo->min_digits)
1001             errtext = L_("PIN too short");
1002         }
1003
1004       if (!errtext && pininfo->check_cb)
1005         {
1006           /* More checks by utilizing the optional callback. */
1007           pininfo->cb_errtext = NULL;
1008           rc = pininfo->check_cb (pininfo);
1009           if (rc == -1 && pininfo->cb_errtext)
1010             errtext = pininfo->cb_errtext;
1011           else if (gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
1012                    || gpg_err_code (rc) == GPG_ERR_BAD_PIN)
1013             errtext = (is_pin? L_("Bad PIN") : L_("Bad Passphrase"));
1014           else if (rc)
1015             return unlock_pinentry (rc);
1016         }
1017
1018       if (!errtext)
1019         {
1020           if (pininfo->with_repeat
1021               && (pinentry_status & PINENTRY_STATUS_PIN_REPEATED))
1022             pininfo->repeat_okay = 1;
1023           return unlock_pinentry (0); /* okay, got a PIN or passphrase */
1024         }
1025
1026       if ((pinentry_status & PINENTRY_STATUS_PASSWORD_FROM_CACHE))
1027         /* The password was read from the cache.  Don't count this
1028            against the retry count.  */
1029         pininfo->failed_tries --;
1030     }
1031
1032   return unlock_pinentry (gpg_error (pininfo->min_digits? GPG_ERR_BAD_PIN
1033                           : GPG_ERR_BAD_PASSPHRASE));
1034 }
1035
1036
1037 \f
1038 /* Ask for the passphrase using the supplied arguments.  The returned
1039    passphrase needs to be freed by the caller. */
1040 int
1041 agent_get_passphrase (ctrl_t ctrl,
1042                       char **retpass, const char *desc, const char *prompt,
1043                       const char *errtext, int with_qualitybar,
1044                       const char *keyinfo, cache_mode_t cache_mode)
1045 {
1046
1047   int rc;
1048   char line[ASSUAN_LINELENGTH];
1049   struct entry_parm_s parm;
1050   int saveflag;
1051   unsigned int pinentry_status;
1052
1053   *retpass = NULL;
1054   if (opt.batch)
1055     return gpg_error (GPG_ERR_BAD_PASSPHRASE);
1056
1057   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1058     {
1059       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
1060         return gpg_error (GPG_ERR_CANCELED);
1061
1062       if (ctrl->pinentry_mode == PINENTRY_MODE_LOOPBACK)
1063         {
1064           size_t size;
1065           size_t len = ASSUAN_LINELENGTH/2;
1066           unsigned char *buffer = gcry_malloc_secure (len);
1067
1068           rc = pinentry_loopback(ctrl, "PASSPHRASE", &buffer, &size, len);
1069           if (rc)
1070             xfree(buffer);
1071           else
1072             {
1073               buffer[size] = 0;
1074               *retpass = buffer;
1075             }
1076           return rc;
1077         }
1078       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
1079     }
1080
1081   rc = start_pinentry (ctrl);
1082   if (rc)
1083     return rc;
1084
1085   if (!prompt)
1086     prompt = desc && strstr (desc, "PIN")? L_("PIN:"): L_("Passphrase:");
1087
1088
1089   /* If we have a KEYINFO string and are normal, user, or ssh cache
1090      mode, we tell that the Pinentry so it may use it for own caching
1091      purposes.  Most pinentries won't have this implemented and thus
1092      we do not error out in this case.  */
1093   if (keyinfo && (cache_mode == CACHE_MODE_NORMAL
1094                   || cache_mode == CACHE_MODE_USER
1095                   || cache_mode == CACHE_MODE_SSH))
1096     snprintf (line, DIM(line)-1, "SETKEYINFO %c/%s",
1097               cache_mode == CACHE_MODE_USER? 'u' :
1098               cache_mode == CACHE_MODE_SSH? 's' : 'n',
1099               keyinfo);
1100   else
1101     snprintf (line, DIM(line)-1, "SETKEYINFO --clear");
1102
1103   rc = assuan_transact (entry_ctx, line,
1104                         NULL, NULL, NULL, NULL, NULL, NULL);
1105   if (rc && gpg_err_code (rc) != GPG_ERR_ASS_UNKNOWN_CMD)
1106     return unlock_pinentry (rc);
1107
1108
1109   if (desc)
1110     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1111   else
1112     snprintf (line, DIM(line)-1, "RESET");
1113   line[DIM(line)-1] = 0;
1114   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1115   if (rc)
1116     return unlock_pinentry (rc);
1117
1118   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt);
1119   line[DIM(line)-1] = 0;
1120   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1121   if (rc)
1122     return unlock_pinentry (rc);
1123
1124   if (with_qualitybar && opt.min_passphrase_len)
1125     {
1126       rc = setup_qualitybar (ctrl);
1127       if (rc)
1128         return unlock_pinentry (rc);
1129     }
1130
1131   if (errtext)
1132     {
1133       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
1134       line[DIM(line)-1] = 0;
1135       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1136       if (rc)
1137         return unlock_pinentry (rc);
1138     }
1139
1140   memset (&parm, 0, sizeof parm);
1141   parm.size = ASSUAN_LINELENGTH/2 - 5;
1142   parm.buffer = gcry_malloc_secure (parm.size+10);
1143   if (!parm.buffer)
1144     return unlock_pinentry (out_of_core ());
1145
1146   saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
1147   assuan_begin_confidential (entry_ctx);
1148   pinentry_status = 0;
1149   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
1150                         inq_quality, entry_ctx,
1151                         pinentry_status_cb, &pinentry_status);
1152   assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
1153   /* Most pinentries out in the wild return the old Assuan error code
1154      for canceled which gets translated to an assuan Cancel error and
1155      not to the code for a user cancel.  Fix this here. */
1156   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1157     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1158   /* Change error code in case the window close button was clicked
1159      to cancel the operation.  */
1160   if ((pinentry_status & PINENTRY_STATUS_CLOSE_BUTTON)
1161       && gpg_err_code (rc) == GPG_ERR_CANCELED)
1162     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
1163
1164   if (rc)
1165     xfree (parm.buffer);
1166   else
1167     *retpass = parm.buffer;
1168   return unlock_pinentry (rc);
1169 }
1170
1171
1172 \f
1173 /* Pop up the PIN-entry, display the text and the prompt and ask the
1174    user to confirm this.  We return 0 for success, ie. the user
1175    confirmed it, GPG_ERR_NOT_CONFIRMED for what the text says or an
1176    other error.  If WITH_CANCEL it true an extra cancel button is
1177    displayed to allow the user to easily return a GPG_ERR_CANCELED.
1178    if the Pinentry does not support this, the user can still cancel by
1179    closing the Pinentry window.  */
1180 int
1181 agent_get_confirmation (ctrl_t ctrl,
1182                         const char *desc, const char *ok,
1183                         const char *notok, int with_cancel)
1184 {
1185   int rc;
1186   char line[ASSUAN_LINELENGTH];
1187
1188   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1189     {
1190       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
1191         return gpg_error (GPG_ERR_CANCELED);
1192
1193       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
1194     }
1195
1196   rc = start_pinentry (ctrl);
1197   if (rc)
1198     return rc;
1199
1200   if (desc)
1201     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1202   else
1203     snprintf (line, DIM(line)-1, "RESET");
1204   line[DIM(line)-1] = 0;
1205   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1206   /* Most pinentries out in the wild return the old Assuan error code
1207      for canceled which gets translated to an assuan Cancel error and
1208      not to the code for a user cancel.  Fix this here. */
1209   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1210     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1211
1212   if (rc)
1213     return unlock_pinentry (rc);
1214
1215   if (ok)
1216     {
1217       snprintf (line, DIM(line)-1, "SETOK %s", ok);
1218       line[DIM(line)-1] = 0;
1219       rc = assuan_transact (entry_ctx,
1220                             line, NULL, NULL, NULL, NULL, NULL, NULL);
1221       if (rc)
1222         return unlock_pinentry (rc);
1223     }
1224   if (notok)
1225     {
1226       /* Try to use the newer NOTOK feature if a cancel button is
1227          requested.  If no cancel button is requested we keep on using
1228          the standard cancel.  */
1229       if (with_cancel)
1230         {
1231           snprintf (line, DIM(line)-1, "SETNOTOK %s", notok);
1232           line[DIM(line)-1] = 0;
1233           rc = assuan_transact (entry_ctx,
1234                                 line, NULL, NULL, NULL, NULL, NULL, NULL);
1235         }
1236       else
1237         rc = GPG_ERR_ASS_UNKNOWN_CMD;
1238
1239       if (gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
1240         {
1241           snprintf (line, DIM(line)-1, "SETCANCEL %s", notok);
1242           line[DIM(line)-1] = 0;
1243           rc = assuan_transact (entry_ctx, line,
1244                                 NULL, NULL, NULL, NULL, NULL, NULL);
1245         }
1246       if (rc)
1247         return unlock_pinentry (rc);
1248     }
1249
1250   rc = assuan_transact (entry_ctx, "CONFIRM",
1251                         NULL, NULL, NULL, NULL, NULL, NULL);
1252   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1253     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1254
1255   return unlock_pinentry (rc);
1256 }
1257
1258
1259 \f
1260 /* Pop up the PINentry, display the text DESC and a button with the
1261    text OK_BTN (which may be NULL to use the default of "OK") and wait
1262    for the user to hit this button.  The return value is not
1263    relevant.  */
1264 int
1265 agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn)
1266 {
1267   int rc;
1268   char line[ASSUAN_LINELENGTH];
1269
1270   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1271     return gpg_error (GPG_ERR_CANCELED);
1272
1273   rc = start_pinentry (ctrl);
1274   if (rc)
1275     return rc;
1276
1277   if (desc)
1278     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1279   else
1280     snprintf (line, DIM(line)-1, "RESET");
1281   line[DIM(line)-1] = 0;
1282   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1283   /* Most pinentries out in the wild return the old Assuan error code
1284      for canceled which gets translated to an assuan Cancel error and
1285      not to the code for a user cancel.  Fix this here. */
1286   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1287     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1288
1289   if (rc)
1290     return unlock_pinentry (rc);
1291
1292   if (ok_btn)
1293     {
1294       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1295       line[DIM(line)-1] = 0;
1296       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL,
1297                             NULL, NULL, NULL);
1298       if (rc)
1299         return unlock_pinentry (rc);
1300     }
1301
1302   rc = assuan_transact (entry_ctx, "CONFIRM --one-button", NULL, NULL, NULL,
1303                         NULL, NULL, NULL);
1304   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1305     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1306
1307   return unlock_pinentry (rc);
1308 }
1309
1310
1311 /* The thread running the popup message. */
1312 static void *
1313 popup_message_thread (void *arg)
1314 {
1315   (void)arg;
1316
1317   /* We use the --one-button hack instead of the MESSAGE command to
1318      allow the use of old Pinentries.  Those old Pinentries will then
1319      show an additional Cancel button but that is mostly a visual
1320      annoyance. */
1321   assuan_transact (entry_ctx, "CONFIRM --one-button",
1322                    NULL, NULL, NULL, NULL, NULL, NULL);
1323   popup_finished = 1;
1324   return NULL;
1325 }
1326
1327
1328 /* Pop up a message window similar to the confirm one but keep it open
1329    until agent_popup_message_stop has been called.  It is crucial for
1330    the caller to make sure that the stop function gets called as soon
1331    as the message is not anymore required because the message is
1332    system modal and all other attempts to use the pinentry will fail
1333    (after a timeout). */
1334 int
1335 agent_popup_message_start (ctrl_t ctrl, const char *desc, const char *ok_btn)
1336 {
1337   int rc;
1338   char line[ASSUAN_LINELENGTH];
1339   npth_attr_t tattr;
1340   int err;
1341
1342   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1343     return gpg_error (GPG_ERR_CANCELED);
1344
1345   rc = start_pinentry (ctrl);
1346   if (rc)
1347     return rc;
1348
1349   if (desc)
1350     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1351   else
1352     snprintf (line, DIM(line)-1, "RESET");
1353   line[DIM(line)-1] = 0;
1354   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1355   if (rc)
1356     return unlock_pinentry (rc);
1357
1358   if (ok_btn)
1359     {
1360       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1361       line[DIM(line)-1] = 0;
1362       rc = assuan_transact (entry_ctx, line, NULL,NULL,NULL,NULL,NULL,NULL);
1363       if (rc)
1364         return unlock_pinentry (rc);
1365     }
1366
1367   err = npth_attr_init (&tattr);
1368   if (err)
1369     return unlock_pinentry (gpg_error_from_errno (err));
1370   npth_attr_setdetachstate (&tattr, NPTH_CREATE_JOINABLE);
1371
1372   popup_finished = 0;
1373   err = npth_create (&popup_tid, &tattr, popup_message_thread, NULL);
1374   npth_attr_destroy (&tattr);
1375   if (err)
1376     {
1377       rc = gpg_error_from_errno (err);
1378       log_error ("error spawning popup message handler: %s\n",
1379                  strerror (err) );
1380       return unlock_pinentry (rc);
1381     }
1382   npth_setname_np (popup_tid, "popup-message");
1383
1384   return 0;
1385 }
1386
1387 /* Close a popup window. */
1388 void
1389 agent_popup_message_stop (ctrl_t ctrl)
1390 {
1391   int rc;
1392   pid_t pid;
1393
1394   (void)ctrl;
1395
1396   if (!popup_tid || !entry_ctx)
1397     {
1398       log_debug ("agent_popup_message_stop called with no active popup\n");
1399       return;
1400     }
1401
1402   pid = assuan_get_pid (entry_ctx);
1403   if (pid == (pid_t)(-1))
1404     ; /* No pid available can't send a kill. */
1405   else if (popup_finished)
1406     ; /* Already finished and ready for joining. */
1407 #ifdef HAVE_W32_SYSTEM
1408   /* Older versions of assuan set PID to 0 on Windows to indicate an
1409      invalid value.  */
1410   else if (pid != (pid_t) INVALID_HANDLE_VALUE
1411            && pid != 0)
1412     {
1413       HANDLE process = (HANDLE) pid;
1414
1415       /* Arbitrary error code.  */
1416       TerminateProcess (process, 1);
1417     }
1418 #else
1419   else if (pid && ((rc=waitpid (pid, NULL, WNOHANG))==-1 || (rc == pid)) )
1420     { /* The daemon already died.  No need to send a kill.  However
1421          because we already waited for the process, we need to tell
1422          assuan that it should not wait again (done by
1423          unlock_pinentry). */
1424       if (rc == pid)
1425         assuan_set_flag (entry_ctx, ASSUAN_NO_WAITPID, 1);
1426     }
1427   else if (pid > 0)
1428     kill (pid, SIGINT);
1429 #endif
1430
1431   /* Now wait for the thread to terminate. */
1432   rc = npth_join (popup_tid, NULL);
1433   if (rc)
1434     log_debug ("agent_popup_message_stop: pth_join failed: %s\n",
1435                strerror (rc));
1436   /* Thread IDs are opaque, but we try our best here by resetting it
1437      to the same content that a static global variable has.  */
1438   memset (&popup_tid, '\0', sizeof (popup_tid));
1439   entry_owner = NULL;
1440
1441   /* Now we can close the connection. */
1442   unlock_pinentry (0);
1443 }
1444
1445 int
1446 agent_clear_passphrase (ctrl_t ctrl,
1447                         const char *keyinfo, cache_mode_t cache_mode)
1448 {
1449   int rc;
1450   char line[ASSUAN_LINELENGTH];
1451
1452   if (! (keyinfo && (cache_mode == CACHE_MODE_NORMAL
1453                      || cache_mode == CACHE_MODE_USER
1454                      || cache_mode == CACHE_MODE_SSH)))
1455     return gpg_error (GPG_ERR_NOT_SUPPORTED);
1456
1457   rc = start_pinentry (ctrl);
1458   if (rc)
1459     return rc;
1460
1461   snprintf (line, DIM(line)-1, "CLEARPASSPHRASE %c/%s",
1462             cache_mode == CACHE_MODE_USER? 'u' :
1463             cache_mode == CACHE_MODE_SSH? 's' : 'n',
1464             keyinfo);
1465   rc = assuan_transact (entry_ctx, line,
1466                         NULL, NULL, NULL, NULL, NULL, NULL);
1467
1468   return unlock_pinentry (rc);
1469 }