agent: Send the new SETKEYINFO command to the Pinentry.
[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 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 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 Wime implementaion does not flush stdin,stdout and stderr
283          - see above.  Lets 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, 1);
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     /* Provide a few default strings for use by the pinentries.  This
412        may help a pinentry to avoid implementing localization code.  */
413     static struct { const char *key, *value; } tbl[] = {
414       /* TRANSLATORS: These are labels for buttons etc used in
415          Pinentries.  An underscore indicates that the next letter
416          should be used as an accelerator.  Double the underscore for
417          a literal one.  The actual to be translated text starts after
418          the second vertical bar.  */
419       { "ok",     N_("|pinentry-label|_OK") },
420       { "cancel", N_("|pinentry-label|_Cancel") },
421       { "prompt", N_("|pinentry-label|PIN:") },
422       { NULL, NULL}
423     };
424     char *optstr;
425     int idx;
426     const char *s, *s2;
427
428     for (idx=0; tbl[idx].key; idx++)
429       {
430         s = _(tbl[idx].value);
431         if (*s == '|' && (s2=strchr (s+1,'|')))
432           s = s2+1;
433         if (asprintf (&optstr, "OPTION default-%s=%s", tbl[idx].key, s) < 0 )
434           return unlock_pinentry (out_of_core ());
435         assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
436                          NULL);
437         xfree (optstr);
438       }
439   }
440
441
442   /* Tell the pinentry the name of a file it shall touch after having
443      messed with the tty.  This is optional and only supported by
444      newer pinentries and thus we do no error checking. */
445   tmpstr = opt.pinentry_touch_file;
446   if (tmpstr && !strcmp (tmpstr, "/dev/null"))
447     tmpstr = NULL;
448   else if (!tmpstr)
449     tmpstr = get_agent_socket_name ();
450   if (tmpstr)
451     {
452       char *optstr;
453
454       if (asprintf (&optstr, "OPTION touch-file=%s", tmpstr ) < 0 )
455         ;
456       else
457         {
458           assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
459                            NULL);
460           xfree (optstr);
461         }
462     }
463
464
465   /* Now ask the Pinentry for its PID.  If the Pinentry is new enough
466      it will send the pid back and we will use an inquire to notify
467      our client.  The client may answer the inquiry either with END or
468      with CAN to cancel the pinentry. */
469   rc = assuan_transact (entry_ctx, "GETINFO pid",
470                         getinfo_pid_cb, &pinentry_pid,
471                         NULL, NULL, NULL, NULL);
472   if (rc)
473     {
474       log_info ("You may want to update to a newer pinentry\n");
475       rc = 0;
476     }
477   else if (!rc && (pid_t)pinentry_pid == (pid_t)(-1))
478     log_error ("pinentry did not return a PID\n");
479   else
480     {
481       rc = agent_inq_pinentry_launched (ctrl, pinentry_pid);
482       if (gpg_err_code (rc) == GPG_ERR_CANCELED
483           || gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
484         return unlock_pinentry (gpg_err_make (GPG_ERR_SOURCE_DEFAULT,
485                                               gpg_err_code (rc)));
486       rc = 0;
487     }
488
489   return 0;
490 }
491
492
493 /* Returns True is the pinentry is currently active. If WAITSECONDS is
494    greater than zero the function will wait for this many seconds
495    before returning.  */
496 int
497 pinentry_active_p (ctrl_t ctrl, int waitseconds)
498 {
499   int err;
500   (void)ctrl;
501
502   if (waitseconds > 0)
503     {
504       struct timespec abstime;
505       int rc;
506
507       npth_clock_gettime (&abstime);
508       abstime.tv_sec += waitseconds;
509       err = npth_mutex_timedlock (&entry_lock, &abstime);
510       if (err)
511         {
512           if (err == ETIMEDOUT)
513             rc = gpg_error (GPG_ERR_TIMEOUT);
514           else
515             rc = gpg_error (GPG_ERR_INTERNAL);
516           return rc;
517         }
518     }
519   else
520     {
521       err = npth_mutex_trylock (&entry_lock);
522       if (err)
523         return gpg_error (GPG_ERR_LOCKED);
524     }
525
526   err = npth_mutex_unlock (&entry_lock);
527   if (err)
528     log_error ("failed to release the entry lock at %d: %s\n", __LINE__,
529                strerror (errno));
530   return 0;
531 }
532
533
534 static gpg_error_t
535 getpin_cb (void *opaque, const void *buffer, size_t length)
536 {
537   struct entry_parm_s *parm = opaque;
538
539   if (!buffer)
540     return 0;
541
542   /* we expect the pin to fit on one line */
543   if (parm->lines || length >= parm->size)
544     return gpg_error (GPG_ERR_ASS_TOO_MUCH_DATA);
545
546   /* fixme: we should make sure that the assuan buffer is allocated in
547      secure memory or read the response byte by byte */
548   memcpy (parm->buffer, buffer, length);
549   parm->buffer[length] = 0;
550   parm->lines++;
551   return 0;
552 }
553
554
555 static int
556 all_digitsp( const char *s)
557 {
558   for (; *s && *s >= '0' && *s <= '9'; s++)
559     ;
560   return !*s;
561 }
562
563
564 /* Return a new malloced string by unescaping the string S.  Escaping
565    is percent escaping and '+'/space mapping.  A binary Nul will
566    silently be replaced by a 0xFF.  Function returns NULL to indicate
567    an out of memory status.  PArsing stops at the end of the string or
568    a white space character. */
569 static char *
570 unescape_passphrase_string (const unsigned char *s)
571 {
572   char *buffer, *d;
573
574   buffer = d = xtrymalloc_secure (strlen ((const char*)s)+1);
575   if (!buffer)
576     return NULL;
577   while (*s && !spacep (s))
578     {
579       if (*s == '%' && s[1] && s[2])
580         {
581           s++;
582           *d = xtoi_2 (s);
583           if (!*d)
584             *d = '\xff';
585           d++;
586           s += 2;
587         }
588       else if (*s == '+')
589         {
590           *d++ = ' ';
591           s++;
592         }
593       else
594         *d++ = *s++;
595     }
596   *d = 0;
597   return buffer;
598 }
599
600
601 /* Estimate the quality of the passphrase PW and return a value in the
602    range 0..100.  */
603 static int
604 estimate_passphrase_quality (const char *pw)
605 {
606   int goodlength = opt.min_passphrase_len + opt.min_passphrase_len/3;
607   int length;
608   const char *s;
609
610   if (goodlength < 1)
611     return 0;
612
613   for (length = 0, s = pw; *s; s++)
614     if (!spacep (s))
615       length ++;
616
617   if (length > goodlength)
618     return 100;
619   return ((length*10) / goodlength)*10;
620 }
621
622
623 /* Handle the QUALITY inquiry. */
624 static gpg_error_t
625 inq_quality (void *opaque, const char *line)
626 {
627   assuan_context_t ctx = opaque;
628   const char *s;
629   char *pin;
630   int rc;
631   int percent;
632   char numbuf[20];
633
634   if ((s = has_leading_keyword (line, "QUALITY")))
635     {
636       pin = unescape_passphrase_string (s);
637       if (!pin)
638         rc = gpg_error_from_syserror ();
639       else
640         {
641           percent = estimate_passphrase_quality (pin);
642           if (check_passphrase_constraints (NULL, pin, 1))
643             percent = -percent;
644           snprintf (numbuf, sizeof numbuf, "%d", percent);
645           rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
646           xfree (pin);
647         }
648     }
649   else
650     {
651       log_error ("unsupported inquiry '%s' from pinentry\n", line);
652       rc = gpg_error (GPG_ERR_ASS_UNKNOWN_INQUIRE);
653     }
654
655   return rc;
656 }
657
658
659 /* Helper for agent_askpin and agent_get_passphrase.  */
660 static int
661 setup_qualitybar (void)
662 {
663   int rc;
664   char line[ASSUAN_LINELENGTH];
665   char *tmpstr, *tmpstr2;
666   const char *tooltip;
667
668   /* TRANSLATORS: This string is displayed by Pinentry as the label
669      for the quality bar.  */
670   tmpstr = try_percent_escape (_("Quality:"), "\t\r\n\f\v");
671   snprintf (line, DIM(line)-1, "SETQUALITYBAR %s", tmpstr? tmpstr:"");
672   line[DIM(line)-1] = 0;
673   xfree (tmpstr);
674   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
675   if (rc == 103 /*(Old assuan error code)*/
676       || gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
677     ; /* Ignore Unknown Command from old Pinentry versions.  */
678   else if (rc)
679     return rc;
680
681   tmpstr2 = gnupg_get_help_string ("pinentry.qualitybar.tooltip", 0);
682   if (tmpstr2)
683     tooltip = tmpstr2;
684   else
685     {
686       /* TRANSLATORS: This string is a tooltip, shown by pinentry when
687          hovering over the quality bar.  Please use an appropriate
688          string to describe what this is about.  The length of the
689          tooltip is limited to about 900 characters.  If you do not
690          translate this entry, a default english text (see source)
691          will be used. */
692       tooltip =  _("pinentry.qualitybar.tooltip");
693       if (!strcmp ("pinentry.qualitybar.tooltip", tooltip))
694         tooltip = ("The quality of the text entered above.\n"
695                    "Please ask your administrator for "
696                    "details about the criteria.");
697     }
698   tmpstr = try_percent_escape (tooltip, "\t\r\n\f\v");
699   xfree (tmpstr2);
700   snprintf (line, DIM(line)-1, "SETQUALITYBAR_TT %s", tmpstr? tmpstr:"");
701   line[DIM(line)-1] = 0;
702   xfree (tmpstr);
703   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
704   if (rc == 103 /*(Old assuan error code)*/
705           || gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
706     ; /* Ignore Unknown Command from old pinentry versions.  */
707   else if (rc)
708     return rc;
709
710   return 0;
711 }
712
713
714 /* Check the button_info line for a close action.  Also check for the
715    PIN_REPEATED flag.  */
716 static gpg_error_t
717 close_button_status_cb (void *opaque, const char *line)
718 {
719   unsigned int *flag = opaque;
720   const char *args;
721
722   if ((args = has_leading_keyword (line, "BUTTON_INFO")))
723     {
724       if (!strcmp (args, "close"))
725         *flag = 1;
726     }
727   else if (has_leading_keyword (line, "PIN_REPEATED"))
728     {
729       *flag |= 256;
730     }
731
732   return 0;
733 }
734
735
736
737 \f
738 /* Call the Entry and ask for the PIN.  We do check for a valid PIN
739    number here and repeat it as long as we have invalid formed
740    numbers.  KEYINFO and CACHEMODE are used to tell pinentry something
741    about the key. */
742 int
743 agent_askpin (ctrl_t ctrl,
744               const char *desc_text, const char *prompt_text,
745               const char *initial_errtext,
746               struct pin_entry_info_s *pininfo,
747               const char *keyinfo, cache_mode_t cache_mode)
748 {
749   int rc;
750   char line[ASSUAN_LINELENGTH];
751   struct entry_parm_s parm;
752   const char *errtext = NULL;
753   int is_pin = 0;
754   int saveflag;
755   unsigned int close_button;
756
757   if (opt.batch)
758     return 0; /* fixme: we should return BAD PIN */
759
760   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
761     {
762       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
763         return gpg_error (GPG_ERR_CANCELED);
764       if (ctrl->pinentry_mode == PINENTRY_MODE_LOOPBACK)
765         {
766           unsigned char *passphrase;
767           size_t size;
768
769           *pininfo->pin = 0; /* Reset the PIN. */
770           rc = pinentry_loopback(ctrl, "PASSPHRASE", &passphrase, &size,
771                   pininfo->max_length);
772           if (rc)
773             return rc;
774
775           memcpy(&pininfo->pin, passphrase, size);
776           xfree(passphrase);
777           pininfo->pin[size] = 0;
778           if (pininfo->check_cb)
779             {
780               /* More checks by utilizing the optional callback. */
781               pininfo->cb_errtext = NULL;
782               rc = pininfo->check_cb (pininfo);
783             }
784           return rc;
785         }
786       return gpg_error(GPG_ERR_NO_PIN_ENTRY);
787     }
788
789   if (!pininfo || pininfo->max_length < 1)
790     return gpg_error (GPG_ERR_INV_VALUE);
791   if (!desc_text && pininfo->min_digits)
792     desc_text = _("Please enter your PIN, so that the secret key "
793                   "can be unlocked for this session");
794   else if (!desc_text)
795     desc_text = _("Please enter your passphrase, so that the secret key "
796                   "can be unlocked for this session");
797
798   if (prompt_text)
799     is_pin = !!strstr (prompt_text, "PIN");
800   else
801     is_pin = desc_text && strstr (desc_text, "PIN");
802
803   rc = start_pinentry (ctrl);
804   if (rc)
805     return rc;
806
807   /* If we have a KYEINFO string and are normal, user, or ssh cache
808      mode, we tell that the Pinentry so it may use it for own caching
809      purposes.  Most pinentries won't have this implemented and thus
810      we do not error out in this case.  */
811   if (keyinfo && (cache_mode == CACHE_MODE_NORMAL
812                   || cache_mode == CACHE_MODE_USER
813                   || cache_mode == CACHE_MODE_SSH))
814     {
815       snprintf (line, DIM(line)-1, "SETKEYINFO %c/%s",
816                 cache_mode == CACHE_MODE_USER? 'u' :
817                 cache_mode == CACHE_MODE_SSH? 's' : 'n',
818                 keyinfo);
819       rc = assuan_transact (entry_ctx, line,
820                             NULL, NULL, NULL, NULL, NULL, NULL);
821       if (rc && gpg_err_code (rc) != GPG_ERR_ASS_UNKNOWN_CMD)
822         return unlock_pinentry (rc);
823     }
824
825   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
826   line[DIM(line)-1] = 0;
827   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
828   if (rc)
829     return unlock_pinentry (rc);
830
831   snprintf (line, DIM(line)-1, "SETPROMPT %s",
832             prompt_text? prompt_text : is_pin? "PIN:" : "Passphrase:");
833   line[DIM(line)-1] = 0;
834   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
835   if (rc)
836     return unlock_pinentry (rc);
837
838   /* If a passphrase quality indicator has been requested and a
839      minimum passphrase length has not been disabled, send the command
840      to the pinentry.  */
841   if (pininfo->with_qualitybar && opt.min_passphrase_len )
842     {
843       rc = setup_qualitybar ();
844       if (rc)
845         return unlock_pinentry (rc);
846     }
847
848   if (initial_errtext)
849     {
850       snprintf (line, DIM(line)-1, "SETERROR %s", initial_errtext);
851       line[DIM(line)-1] = 0;
852       rc = assuan_transact (entry_ctx, line,
853                             NULL, NULL, NULL, NULL, NULL, NULL);
854       if (rc)
855         return unlock_pinentry (rc);
856     }
857
858   if (pininfo->with_repeat)
859     {
860       snprintf (line, DIM(line)-1, "SETREPEATERROR %s",
861                 _("does not match - try again"));
862       line[DIM(line)-1] = 0;
863       rc = assuan_transact (entry_ctx, line,
864                             NULL, NULL, NULL, NULL, NULL, NULL);
865       if (rc)
866         pininfo->with_repeat = 0; /* Pinentry does not support it.  */
867     }
868   pininfo->repeat_okay = 0;
869
870   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
871     {
872       memset (&parm, 0, sizeof parm);
873       parm.size = pininfo->max_length;
874       *pininfo->pin = 0; /* Reset the PIN. */
875       parm.buffer = (unsigned char*)pininfo->pin;
876
877       if (errtext)
878         {
879           /* TRANSLATORS: The string is appended to an error message in
880              the pinentry.  The %s is the actual error message, the
881              two %d give the current and maximum number of tries. */
882           snprintf (line, DIM(line)-1, _("SETERROR %s (try %d of %d)"),
883                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
884           line[DIM(line)-1] = 0;
885           rc = assuan_transact (entry_ctx, line,
886                                 NULL, NULL, NULL, NULL, NULL, NULL);
887           if (rc)
888             return unlock_pinentry (rc);
889           errtext = NULL;
890         }
891
892       if (pininfo->with_repeat)
893         {
894           snprintf (line, DIM(line)-1, "SETREPEAT %s", _("Repeat:"));
895           line[DIM(line)-1] = 0;
896           rc = assuan_transact (entry_ctx, line,
897                                 NULL, NULL, NULL, NULL, NULL, NULL);
898           if (rc)
899             return unlock_pinentry (rc);
900         }
901
902       saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
903       assuan_begin_confidential (entry_ctx);
904       close_button = 0;
905       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
906                             inq_quality, entry_ctx,
907                             close_button_status_cb, &close_button);
908       assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
909       /* Most pinentries out in the wild return the old Assuan error code
910          for canceled which gets translated to an assuan Cancel error and
911          not to the code for a user cancel.  Fix this here. */
912       if (rc && gpg_err_source (rc)
913           && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
914         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
915
916
917       /* Change error code in case the window close button was clicked
918          to cancel the operation.  */
919       if ((close_button & 1) && gpg_err_code (rc) == GPG_ERR_CANCELED)
920         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
921
922       if (gpg_err_code (rc) == GPG_ERR_ASS_TOO_MUCH_DATA)
923         errtext = is_pin? _("PIN too long")
924                         : _("Passphrase too long");
925       else if (rc)
926         return unlock_pinentry (rc);
927
928       if (!errtext && pininfo->min_digits)
929         {
930           /* do some basic checks on the entered PIN. */
931           if (!all_digitsp (pininfo->pin))
932             errtext = _("Invalid characters in PIN");
933           else if (pininfo->max_digits
934                    && strlen (pininfo->pin) > pininfo->max_digits)
935             errtext = _("PIN too long");
936           else if (strlen (pininfo->pin) < pininfo->min_digits)
937             errtext = _("PIN too short");
938         }
939
940       if (!errtext && pininfo->check_cb)
941         {
942           /* More checks by utilizing the optional callback. */
943           pininfo->cb_errtext = NULL;
944           rc = pininfo->check_cb (pininfo);
945           if (rc == -1 && pininfo->cb_errtext)
946             errtext = pininfo->cb_errtext;
947           else if (gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
948                    || gpg_err_code (rc) == GPG_ERR_BAD_PIN)
949             errtext = (is_pin? _("Bad PIN")
950                        : _("Bad Passphrase"));
951           else if (rc)
952             return unlock_pinentry (rc);
953         }
954
955       if (!errtext)
956         {
957           if (pininfo->with_repeat && (close_button & 256))
958             pininfo->repeat_okay = 1;
959           return unlock_pinentry (0); /* okay, got a PIN or passphrase */
960         }
961     }
962
963   return unlock_pinentry (gpg_error (pininfo->min_digits? GPG_ERR_BAD_PIN
964                           : GPG_ERR_BAD_PASSPHRASE));
965 }
966
967
968 \f
969 /* Ask for the passphrase using the supplied arguments.  The returned
970    passphrase needs to be freed by the caller. */
971 int
972 agent_get_passphrase (ctrl_t ctrl,
973                       char **retpass, const char *desc, const char *prompt,
974                       const char *errtext, int with_qualitybar)
975 {
976
977   int rc;
978   char line[ASSUAN_LINELENGTH];
979   struct entry_parm_s parm;
980   int saveflag;
981   unsigned int close_button;
982
983   *retpass = NULL;
984   if (opt.batch)
985     return gpg_error (GPG_ERR_BAD_PASSPHRASE);
986
987   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
988     {
989       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
990         return gpg_error (GPG_ERR_CANCELED);
991
992       if (ctrl->pinentry_mode == PINENTRY_MODE_LOOPBACK)
993         {
994           size_t size;
995           size_t len = ASSUAN_LINELENGTH/2;
996           unsigned char *buffer = gcry_malloc_secure (len);
997
998           rc = pinentry_loopback(ctrl, "PASSPHRASE", &buffer, &size, len);
999           if (rc)
1000             xfree(buffer);
1001           else
1002             {
1003               buffer[size] = 0;
1004               *retpass = buffer;
1005             }
1006           return rc;
1007         }
1008       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
1009     }
1010
1011   rc = start_pinentry (ctrl);
1012   if (rc)
1013     return rc;
1014
1015   if (!prompt)
1016     prompt = desc && strstr (desc, "PIN")? "PIN": _("Passphrase");
1017
1018
1019   if (desc)
1020     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1021   else
1022     snprintf (line, DIM(line)-1, "RESET");
1023   line[DIM(line)-1] = 0;
1024   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1025   if (rc)
1026     return unlock_pinentry (rc);
1027
1028   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt);
1029   line[DIM(line)-1] = 0;
1030   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1031   if (rc)
1032     return unlock_pinentry (rc);
1033
1034   if (with_qualitybar && opt.min_passphrase_len)
1035     {
1036       rc = setup_qualitybar ();
1037       if (rc)
1038         return unlock_pinentry (rc);
1039     }
1040
1041   if (errtext)
1042     {
1043       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
1044       line[DIM(line)-1] = 0;
1045       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1046       if (rc)
1047         return unlock_pinentry (rc);
1048     }
1049
1050   memset (&parm, 0, sizeof parm);
1051   parm.size = ASSUAN_LINELENGTH/2 - 5;
1052   parm.buffer = gcry_malloc_secure (parm.size+10);
1053   if (!parm.buffer)
1054     return unlock_pinentry (out_of_core ());
1055
1056   saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
1057   assuan_begin_confidential (entry_ctx);
1058   close_button = 0;
1059   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
1060                         inq_quality, entry_ctx,
1061                         close_button_status_cb, &close_button);
1062   assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
1063   /* Most pinentries out in the wild return the old Assuan error code
1064      for canceled which gets translated to an assuan Cancel error and
1065      not to the code for a user cancel.  Fix this here. */
1066   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1067     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1068   /* Change error code in case the window close button was clicked
1069      to cancel the operation.  */
1070   if ((close_button & 1) && gpg_err_code (rc) == GPG_ERR_CANCELED)
1071     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
1072
1073   if (rc)
1074     xfree (parm.buffer);
1075   else
1076     *retpass = parm.buffer;
1077   return unlock_pinentry (rc);
1078 }
1079
1080
1081 \f
1082 /* Pop up the PIN-entry, display the text and the prompt and ask the
1083    user to confirm this.  We return 0 for success, ie. the user
1084    confirmed it, GPG_ERR_NOT_CONFIRMED for what the text says or an
1085    other error.  If WITH_CANCEL it true an extra cancel button is
1086    displayed to allow the user to easily return a GPG_ERR_CANCELED.
1087    if the Pinentry does not support this, the user can still cancel by
1088    closing the Pinentry window.  */
1089 int
1090 agent_get_confirmation (ctrl_t ctrl,
1091                         const char *desc, const char *ok,
1092                         const char *notok, int with_cancel)
1093 {
1094   int rc;
1095   char line[ASSUAN_LINELENGTH];
1096
1097   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1098     {
1099       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
1100         return gpg_error (GPG_ERR_CANCELED);
1101
1102       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
1103     }
1104
1105   rc = start_pinentry (ctrl);
1106   if (rc)
1107     return rc;
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   /* Most pinentries out in the wild return the old Assuan error code
1116      for canceled which gets translated to an assuan Cancel error and
1117      not to the code for a user cancel.  Fix this here. */
1118   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1119     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1120
1121   if (rc)
1122     return unlock_pinentry (rc);
1123
1124   if (ok)
1125     {
1126       snprintf (line, DIM(line)-1, "SETOK %s", ok);
1127       line[DIM(line)-1] = 0;
1128       rc = assuan_transact (entry_ctx,
1129                             line, NULL, NULL, NULL, NULL, NULL, NULL);
1130       if (rc)
1131         return unlock_pinentry (rc);
1132     }
1133   if (notok)
1134     {
1135       /* Try to use the newer NOTOK feature if a cancel button is
1136          requested.  If no cancel button is requested we keep on using
1137          the standard cancel.  */
1138       if (with_cancel)
1139         {
1140           snprintf (line, DIM(line)-1, "SETNOTOK %s", notok);
1141           line[DIM(line)-1] = 0;
1142           rc = assuan_transact (entry_ctx,
1143                                 line, NULL, NULL, NULL, NULL, NULL, NULL);
1144         }
1145       else
1146         rc = GPG_ERR_ASS_UNKNOWN_CMD;
1147
1148       if (gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
1149         {
1150           snprintf (line, DIM(line)-1, "SETCANCEL %s", notok);
1151           line[DIM(line)-1] = 0;
1152           rc = assuan_transact (entry_ctx, line,
1153                                 NULL, NULL, NULL, NULL, NULL, NULL);
1154         }
1155       if (rc)
1156         return unlock_pinentry (rc);
1157     }
1158
1159   rc = assuan_transact (entry_ctx, "CONFIRM",
1160                         NULL, NULL, NULL, NULL, NULL, NULL);
1161   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1162     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1163
1164   return unlock_pinentry (rc);
1165 }
1166
1167
1168 \f
1169 /* Pop up the PINentry, display the text DESC and a button with the
1170    text OK_BTN (which may be NULL to use the default of "OK") and wait
1171    for the user to hit this button.  The return value is not
1172    relevant.  */
1173 int
1174 agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn)
1175 {
1176   int rc;
1177   char line[ASSUAN_LINELENGTH];
1178
1179   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1180     return gpg_error (GPG_ERR_CANCELED);
1181
1182   rc = start_pinentry (ctrl);
1183   if (rc)
1184     return rc;
1185
1186   if (desc)
1187     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1188   else
1189     snprintf (line, DIM(line)-1, "RESET");
1190   line[DIM(line)-1] = 0;
1191   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1192   /* Most pinentries out in the wild return the old Assuan error code
1193      for canceled which gets translated to an assuan Cancel error and
1194      not to the code for a user cancel.  Fix this here. */
1195   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1196     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1197
1198   if (rc)
1199     return unlock_pinentry (rc);
1200
1201   if (ok_btn)
1202     {
1203       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1204       line[DIM(line)-1] = 0;
1205       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL,
1206                             NULL, NULL, NULL);
1207       if (rc)
1208         return unlock_pinentry (rc);
1209     }
1210
1211   rc = assuan_transact (entry_ctx, "CONFIRM --one-button", NULL, NULL, NULL,
1212                         NULL, NULL, NULL);
1213   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1214     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1215
1216   return unlock_pinentry (rc);
1217 }
1218
1219
1220 /* The thread running the popup message. */
1221 static void *
1222 popup_message_thread (void *arg)
1223 {
1224   (void)arg;
1225
1226   /* We use the --one-button hack instead of the MESSAGE command to
1227      allow the use of old Pinentries.  Those old Pinentries will then
1228      show an additional Cancel button but that is mostly a visual
1229      annoyance. */
1230   assuan_transact (entry_ctx, "CONFIRM --one-button",
1231                    NULL, NULL, NULL, NULL, NULL, NULL);
1232   popup_finished = 1;
1233   return NULL;
1234 }
1235
1236
1237 /* Pop up a message window similar to the confirm one but keep it open
1238    until agent_popup_message_stop has been called.  It is crucial for
1239    the caller to make sure that the stop function gets called as soon
1240    as the message is not anymore required because the message is
1241    system modal and all other attempts to use the pinentry will fail
1242    (after a timeout). */
1243 int
1244 agent_popup_message_start (ctrl_t ctrl, const char *desc, const char *ok_btn)
1245 {
1246   int rc;
1247   char line[ASSUAN_LINELENGTH];
1248   npth_attr_t tattr;
1249   int err;
1250
1251   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1252     return gpg_error (GPG_ERR_CANCELED);
1253
1254   rc = start_pinentry (ctrl);
1255   if (rc)
1256     return rc;
1257
1258   if (desc)
1259     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1260   else
1261     snprintf (line, DIM(line)-1, "RESET");
1262   line[DIM(line)-1] = 0;
1263   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1264   if (rc)
1265     return unlock_pinentry (rc);
1266
1267   if (ok_btn)
1268     {
1269       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1270       line[DIM(line)-1] = 0;
1271       rc = assuan_transact (entry_ctx, line, NULL,NULL,NULL,NULL,NULL,NULL);
1272       if (rc)
1273         return unlock_pinentry (rc);
1274     }
1275
1276   err = npth_attr_init (&tattr);
1277   if (err)
1278     return unlock_pinentry (gpg_error_from_errno (err));
1279   npth_attr_setdetachstate (&tattr, NPTH_CREATE_JOINABLE);
1280
1281   popup_finished = 0;
1282   err = npth_create (&popup_tid, &tattr, popup_message_thread, NULL);
1283   npth_attr_destroy (&tattr);
1284   if (err)
1285     {
1286       rc = gpg_error_from_errno (err);
1287       log_error ("error spawning popup message handler: %s\n",
1288                  strerror (err) );
1289       return unlock_pinentry (rc);
1290     }
1291   npth_setname_np (popup_tid, "popup-message");
1292
1293   return 0;
1294 }
1295
1296 /* Close a popup window. */
1297 void
1298 agent_popup_message_stop (ctrl_t ctrl)
1299 {
1300   int rc;
1301   pid_t pid;
1302
1303   (void)ctrl;
1304
1305   if (!popup_tid || !entry_ctx)
1306     {
1307       log_debug ("agent_popup_message_stop called with no active popup\n");
1308       return;
1309     }
1310
1311   pid = assuan_get_pid (entry_ctx);
1312   if (pid == (pid_t)(-1))
1313     ; /* No pid available can't send a kill. */
1314   else if (popup_finished)
1315     ; /* Already finished and ready for joining. */
1316 #ifdef HAVE_W32_SYSTEM
1317   /* Older versions of assuan set PID to 0 on Windows to indicate an
1318      invalid value.  */
1319   else if (pid != (pid_t) INVALID_HANDLE_VALUE
1320            && pid != 0)
1321     {
1322       HANDLE process = (HANDLE) pid;
1323
1324       /* Arbitrary error code.  */
1325       TerminateProcess (process, 1);
1326     }
1327 #else
1328   else if (pid && ((rc=waitpid (pid, NULL, WNOHANG))==-1 || (rc == pid)) )
1329     { /* The daemon already died.  No need to send a kill.  However
1330          because we already waited for the process, we need to tell
1331          assuan that it should not wait again (done by
1332          unlock_pinentry). */
1333       if (rc == pid)
1334         assuan_set_flag (entry_ctx, ASSUAN_NO_WAITPID, 1);
1335     }
1336   else if (pid > 0)
1337     kill (pid, SIGINT);
1338 #endif
1339
1340   /* Now wait for the thread to terminate. */
1341   rc = npth_join (popup_tid, NULL);
1342   if (rc)
1343     log_debug ("agent_popup_message_stop: pth_join failed: %s\n",
1344                strerror (rc));
1345   /* Thread IDs are opaque, but we try our best here by resetting it
1346      to the same content that a static global variable has.  */
1347   memset (&popup_tid, '\0', sizeof (popup_tid));
1348   entry_owner = NULL;
1349
1350   /* Now we can close the connection. */
1351   unlock_pinentry (0);
1352 }