Remove obsolete directories from AM_CPPFLAGS.
[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. */
741 int
742 agent_askpin (ctrl_t ctrl,
743               const char *desc_text, const char *prompt_text,
744               const char *initial_errtext,
745               struct pin_entry_info_s *pininfo)
746 {
747   int rc;
748   char line[ASSUAN_LINELENGTH];
749   struct entry_parm_s parm;
750   const char *errtext = NULL;
751   int is_pin = 0;
752   int saveflag;
753   unsigned int close_button;
754
755   if (opt.batch)
756     return 0; /* fixme: we should return BAD PIN */
757
758   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
759     {
760       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
761         return gpg_error (GPG_ERR_CANCELED);
762       if (ctrl->pinentry_mode == PINENTRY_MODE_LOOPBACK)
763         {
764           unsigned char *passphrase;
765           size_t size;
766
767           *pininfo->pin = 0; /* Reset the PIN. */
768           rc = pinentry_loopback(ctrl, "PASSPHRASE", &passphrase, &size,
769                   pininfo->max_length);
770           if (rc)
771             return rc;
772
773           memcpy(&pininfo->pin, passphrase, size);
774           xfree(passphrase);
775           pininfo->pin[size] = 0;
776           if (pininfo->check_cb)
777             {
778               /* More checks by utilizing the optional callback. */
779               pininfo->cb_errtext = NULL;
780               rc = pininfo->check_cb (pininfo);
781             }
782           return rc;
783         }
784       return gpg_error(GPG_ERR_NO_PIN_ENTRY);
785     }
786
787   if (!pininfo || pininfo->max_length < 1)
788     return gpg_error (GPG_ERR_INV_VALUE);
789   if (!desc_text && pininfo->min_digits)
790     desc_text = _("Please enter your PIN, so that the secret key "
791                   "can be unlocked for this session");
792   else if (!desc_text)
793     desc_text = _("Please enter your passphrase, so that the secret key "
794                   "can be unlocked for this session");
795
796   if (prompt_text)
797     is_pin = !!strstr (prompt_text, "PIN");
798   else
799     is_pin = desc_text && strstr (desc_text, "PIN");
800
801   rc = start_pinentry (ctrl);
802   if (rc)
803     return rc;
804
805   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
806   line[DIM(line)-1] = 0;
807   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
808   if (rc)
809     return unlock_pinentry (rc);
810
811   snprintf (line, DIM(line)-1, "SETPROMPT %s",
812             prompt_text? prompt_text : is_pin? "PIN:" : "Passphrase:");
813   line[DIM(line)-1] = 0;
814   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
815   if (rc)
816     return unlock_pinentry (rc);
817
818   /* If a passphrase quality indicator has been requested and a
819      minimum passphrase length has not been disabled, send the command
820      to the pinentry.  */
821   if (pininfo->with_qualitybar && opt.min_passphrase_len )
822     {
823       rc = setup_qualitybar ();
824       if (rc)
825         return unlock_pinentry (rc);
826     }
827
828   if (initial_errtext)
829     {
830       snprintf (line, DIM(line)-1, "SETERROR %s", initial_errtext);
831       line[DIM(line)-1] = 0;
832       rc = assuan_transact (entry_ctx, line,
833                             NULL, NULL, NULL, NULL, NULL, NULL);
834       if (rc)
835         return unlock_pinentry (rc);
836     }
837
838   if (pininfo->with_repeat)
839     {
840       snprintf (line, DIM(line)-1, "SETREPEATERROR %s",
841                 _("does not match - try again"));
842       line[DIM(line)-1] = 0;
843       rc = assuan_transact (entry_ctx, line,
844                             NULL, NULL, NULL, NULL, NULL, NULL);
845       if (rc)
846         pininfo->with_repeat = 0; /* Pinentry does not support it.  */
847     }
848   pininfo->repeat_okay = 0;
849
850   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
851     {
852       memset (&parm, 0, sizeof parm);
853       parm.size = pininfo->max_length;
854       *pininfo->pin = 0; /* Reset the PIN. */
855       parm.buffer = (unsigned char*)pininfo->pin;
856
857       if (errtext)
858         {
859           /* TRANSLATORS: The string is appended to an error message in
860              the pinentry.  The %s is the actual error message, the
861              two %d give the current and maximum number of tries. */
862           snprintf (line, DIM(line)-1, _("SETERROR %s (try %d of %d)"),
863                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
864           line[DIM(line)-1] = 0;
865           rc = assuan_transact (entry_ctx, line,
866                                 NULL, NULL, NULL, NULL, NULL, NULL);
867           if (rc)
868             return unlock_pinentry (rc);
869           errtext = NULL;
870         }
871
872       if (pininfo->with_repeat)
873         {
874           snprintf (line, DIM(line)-1, "SETREPEAT %s", _("Repeat:"));
875           line[DIM(line)-1] = 0;
876           rc = assuan_transact (entry_ctx, line,
877                                 NULL, NULL, NULL, NULL, NULL, NULL);
878           if (rc)
879             return unlock_pinentry (rc);
880         }
881
882       saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
883       assuan_begin_confidential (entry_ctx);
884       close_button = 0;
885       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
886                             inq_quality, entry_ctx,
887                             close_button_status_cb, &close_button);
888       assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
889       /* Most pinentries out in the wild return the old Assuan error code
890          for canceled which gets translated to an assuan Cancel error and
891          not to the code for a user cancel.  Fix this here. */
892       if (rc && gpg_err_source (rc)
893           && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
894         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
895
896
897       /* Change error code in case the window close button was clicked
898          to cancel the operation.  */
899       if ((close_button & 1) && gpg_err_code (rc) == GPG_ERR_CANCELED)
900         rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
901
902       if (gpg_err_code (rc) == GPG_ERR_ASS_TOO_MUCH_DATA)
903         errtext = is_pin? _("PIN too long")
904                         : _("Passphrase too long");
905       else if (rc)
906         return unlock_pinentry (rc);
907
908       if (!errtext && pininfo->min_digits)
909         {
910           /* do some basic checks on the entered PIN. */
911           if (!all_digitsp (pininfo->pin))
912             errtext = _("Invalid characters in PIN");
913           else if (pininfo->max_digits
914                    && strlen (pininfo->pin) > pininfo->max_digits)
915             errtext = _("PIN too long");
916           else if (strlen (pininfo->pin) < pininfo->min_digits)
917             errtext = _("PIN too short");
918         }
919
920       if (!errtext && pininfo->check_cb)
921         {
922           /* More checks by utilizing the optional callback. */
923           pininfo->cb_errtext = NULL;
924           rc = pininfo->check_cb (pininfo);
925           if (rc == -1 && pininfo->cb_errtext)
926             errtext = pininfo->cb_errtext;
927           else if (gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
928                    || gpg_err_code (rc) == GPG_ERR_BAD_PIN)
929             errtext = (is_pin? _("Bad PIN")
930                        : _("Bad Passphrase"));
931           else if (rc)
932             return unlock_pinentry (rc);
933         }
934
935       if (!errtext)
936         {
937           if (pininfo->with_repeat && (close_button & 256))
938             pininfo->repeat_okay = 1;
939           return unlock_pinentry (0); /* okay, got a PIN or passphrase */
940         }
941     }
942
943   return unlock_pinentry (gpg_error (pininfo->min_digits? GPG_ERR_BAD_PIN
944                           : GPG_ERR_BAD_PASSPHRASE));
945 }
946
947
948 \f
949 /* Ask for the passphrase using the supplied arguments.  The returned
950    passphrase needs to be freed by the caller. */
951 int
952 agent_get_passphrase (ctrl_t ctrl,
953                       char **retpass, const char *desc, const char *prompt,
954                       const char *errtext, int with_qualitybar)
955 {
956
957   int rc;
958   char line[ASSUAN_LINELENGTH];
959   struct entry_parm_s parm;
960   int saveflag;
961   unsigned int close_button;
962
963   *retpass = NULL;
964   if (opt.batch)
965     return gpg_error (GPG_ERR_BAD_PASSPHRASE);
966
967   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
968     {
969       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
970         return gpg_error (GPG_ERR_CANCELED);
971
972       if (ctrl->pinentry_mode == PINENTRY_MODE_LOOPBACK)
973         {
974           size_t size;
975           size_t len = ASSUAN_LINELENGTH/2;
976           unsigned char *buffer = gcry_malloc_secure (len);
977
978           rc = pinentry_loopback(ctrl, "PASSPHRASE", &buffer, &size, len);
979           if (rc)
980             xfree(buffer);
981           else
982             {
983               buffer[size] = 0;
984               *retpass = buffer;
985             }
986           return rc;
987         }
988       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
989     }
990
991   rc = start_pinentry (ctrl);
992   if (rc)
993     return rc;
994
995   if (!prompt)
996     prompt = desc && strstr (desc, "PIN")? "PIN": _("Passphrase");
997
998
999   if (desc)
1000     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1001   else
1002     snprintf (line, DIM(line)-1, "RESET");
1003   line[DIM(line)-1] = 0;
1004   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1005   if (rc)
1006     return unlock_pinentry (rc);
1007
1008   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt);
1009   line[DIM(line)-1] = 0;
1010   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1011   if (rc)
1012     return unlock_pinentry (rc);
1013
1014   if (with_qualitybar && opt.min_passphrase_len)
1015     {
1016       rc = setup_qualitybar ();
1017       if (rc)
1018         return unlock_pinentry (rc);
1019     }
1020
1021   if (errtext)
1022     {
1023       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
1024       line[DIM(line)-1] = 0;
1025       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1026       if (rc)
1027         return unlock_pinentry (rc);
1028     }
1029
1030   memset (&parm, 0, sizeof parm);
1031   parm.size = ASSUAN_LINELENGTH/2 - 5;
1032   parm.buffer = gcry_malloc_secure (parm.size+10);
1033   if (!parm.buffer)
1034     return unlock_pinentry (out_of_core ());
1035
1036   saveflag = assuan_get_flag (entry_ctx, ASSUAN_CONFIDENTIAL);
1037   assuan_begin_confidential (entry_ctx);
1038   close_button = 0;
1039   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm,
1040                         inq_quality, entry_ctx,
1041                         close_button_status_cb, &close_button);
1042   assuan_set_flag (entry_ctx, ASSUAN_CONFIDENTIAL, saveflag);
1043   /* Most pinentries out in the wild return the old Assuan error code
1044      for canceled which gets translated to an assuan Cancel error and
1045      not to the code for a user cancel.  Fix this here. */
1046   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1047     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1048   /* Change error code in case the window close button was clicked
1049      to cancel the operation.  */
1050   if ((close_button & 1) && gpg_err_code (rc) == GPG_ERR_CANCELED)
1051     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_FULLY_CANCELED);
1052
1053   if (rc)
1054     xfree (parm.buffer);
1055   else
1056     *retpass = parm.buffer;
1057   return unlock_pinentry (rc);
1058 }
1059
1060
1061 \f
1062 /* Pop up the PIN-entry, display the text and the prompt and ask the
1063    user to confirm this.  We return 0 for success, ie. the user
1064    confirmed it, GPG_ERR_NOT_CONFIRMED for what the text says or an
1065    other error.  If WITH_CANCEL it true an extra cancel button is
1066    displayed to allow the user to easily return a GPG_ERR_CANCELED.
1067    if the Pinentry does not support this, the user can still cancel by
1068    closing the Pinentry window.  */
1069 int
1070 agent_get_confirmation (ctrl_t ctrl,
1071                         const char *desc, const char *ok,
1072                         const char *notok, int with_cancel)
1073 {
1074   int rc;
1075   char line[ASSUAN_LINELENGTH];
1076
1077   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1078     {
1079       if (ctrl->pinentry_mode == PINENTRY_MODE_CANCEL)
1080         return gpg_error (GPG_ERR_CANCELED);
1081
1082       return gpg_error (GPG_ERR_NO_PIN_ENTRY);
1083     }
1084
1085   rc = start_pinentry (ctrl);
1086   if (rc)
1087     return rc;
1088
1089   if (desc)
1090     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1091   else
1092     snprintf (line, DIM(line)-1, "RESET");
1093   line[DIM(line)-1] = 0;
1094   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1095   /* Most pinentries out in the wild return the old Assuan error code
1096      for canceled which gets translated to an assuan Cancel error and
1097      not to the code for a user cancel.  Fix this here. */
1098   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1099     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1100
1101   if (rc)
1102     return unlock_pinentry (rc);
1103
1104   if (ok)
1105     {
1106       snprintf (line, DIM(line)-1, "SETOK %s", ok);
1107       line[DIM(line)-1] = 0;
1108       rc = assuan_transact (entry_ctx,
1109                             line, NULL, NULL, NULL, NULL, NULL, NULL);
1110       if (rc)
1111         return unlock_pinentry (rc);
1112     }
1113   if (notok)
1114     {
1115       /* Try to use the newer NOTOK feature if a cancel button is
1116          requested.  If no cancel button is requested we keep on using
1117          the standard cancel.  */
1118       if (with_cancel)
1119         {
1120           snprintf (line, DIM(line)-1, "SETNOTOK %s", notok);
1121           line[DIM(line)-1] = 0;
1122           rc = assuan_transact (entry_ctx,
1123                                 line, NULL, NULL, NULL, NULL, NULL, NULL);
1124         }
1125       else
1126         rc = GPG_ERR_ASS_UNKNOWN_CMD;
1127
1128       if (gpg_err_code (rc) == GPG_ERR_ASS_UNKNOWN_CMD)
1129         {
1130           snprintf (line, DIM(line)-1, "SETCANCEL %s", notok);
1131           line[DIM(line)-1] = 0;
1132           rc = assuan_transact (entry_ctx, line,
1133                                 NULL, NULL, NULL, NULL, NULL, NULL);
1134         }
1135       if (rc)
1136         return unlock_pinentry (rc);
1137     }
1138
1139   rc = assuan_transact (entry_ctx, "CONFIRM",
1140                         NULL, NULL, NULL, NULL, NULL, NULL);
1141   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1142     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1143
1144   return unlock_pinentry (rc);
1145 }
1146
1147
1148 \f
1149 /* Pop up the PINentry, display the text DESC and a button with the
1150    text OK_BTN (which may be NULL to use the default of "OK") and wait
1151    for the user to hit this button.  The return value is not
1152    relevant.  */
1153 int
1154 agent_show_message (ctrl_t ctrl, const char *desc, const char *ok_btn)
1155 {
1156   int rc;
1157   char line[ASSUAN_LINELENGTH];
1158
1159   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1160     return gpg_error (GPG_ERR_CANCELED);
1161
1162   rc = start_pinentry (ctrl);
1163   if (rc)
1164     return rc;
1165
1166   if (desc)
1167     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1168   else
1169     snprintf (line, DIM(line)-1, "RESET");
1170   line[DIM(line)-1] = 0;
1171   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1172   /* Most pinentries out in the wild return the old Assuan error code
1173      for canceled which gets translated to an assuan Cancel error and
1174      not to the code for a user cancel.  Fix this here. */
1175   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1176     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1177
1178   if (rc)
1179     return unlock_pinentry (rc);
1180
1181   if (ok_btn)
1182     {
1183       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1184       line[DIM(line)-1] = 0;
1185       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL,
1186                             NULL, NULL, NULL);
1187       if (rc)
1188         return unlock_pinentry (rc);
1189     }
1190
1191   rc = assuan_transact (entry_ctx, "CONFIRM --one-button", NULL, NULL, NULL,
1192                         NULL, NULL, NULL);
1193   if (rc && gpg_err_source (rc) && gpg_err_code (rc) == GPG_ERR_ASS_CANCELED)
1194     rc = gpg_err_make (gpg_err_source (rc), GPG_ERR_CANCELED);
1195
1196   return unlock_pinentry (rc);
1197 }
1198
1199
1200 /* The thread running the popup message. */
1201 static void *
1202 popup_message_thread (void *arg)
1203 {
1204   (void)arg;
1205
1206   /* We use the --one-button hack instead of the MESSAGE command to
1207      allow the use of old Pinentries.  Those old Pinentries will then
1208      show an additional Cancel button but that is mostly a visual
1209      annoyance. */
1210   assuan_transact (entry_ctx, "CONFIRM --one-button",
1211                    NULL, NULL, NULL, NULL, NULL, NULL);
1212   popup_finished = 1;
1213   return NULL;
1214 }
1215
1216
1217 /* Pop up a message window similar to the confirm one but keep it open
1218    until agent_popup_message_stop has been called.  It is crucial for
1219    the caller to make sure that the stop function gets called as soon
1220    as the message is not anymore required because the message is
1221    system modal and all other attempts to use the pinentry will fail
1222    (after a timeout). */
1223 int
1224 agent_popup_message_start (ctrl_t ctrl, const char *desc, const char *ok_btn)
1225 {
1226   int rc;
1227   char line[ASSUAN_LINELENGTH];
1228   npth_attr_t tattr;
1229   int err;
1230
1231   if (ctrl->pinentry_mode != PINENTRY_MODE_ASK)
1232     return gpg_error (GPG_ERR_CANCELED);
1233
1234   rc = start_pinentry (ctrl);
1235   if (rc)
1236     return rc;
1237
1238   if (desc)
1239     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
1240   else
1241     snprintf (line, DIM(line)-1, "RESET");
1242   line[DIM(line)-1] = 0;
1243   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
1244   if (rc)
1245     return unlock_pinentry (rc);
1246
1247   if (ok_btn)
1248     {
1249       snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
1250       line[DIM(line)-1] = 0;
1251       rc = assuan_transact (entry_ctx, line, NULL,NULL,NULL,NULL,NULL,NULL);
1252       if (rc)
1253         return unlock_pinentry (rc);
1254     }
1255
1256   err = npth_attr_init (&tattr);
1257   if (err)
1258     return unlock_pinentry (gpg_error_from_errno (err));
1259   npth_attr_setdetachstate (&tattr, NPTH_CREATE_JOINABLE);
1260
1261   popup_finished = 0;
1262   err = npth_create (&popup_tid, &tattr, popup_message_thread, NULL);
1263   npth_attr_destroy (&tattr);
1264   if (err)
1265     {
1266       rc = gpg_error_from_errno (err);
1267       log_error ("error spawning popup message handler: %s\n",
1268                  strerror (err) );
1269       return unlock_pinentry (rc);
1270     }
1271   npth_setname_np (popup_tid, "popup-message");
1272
1273   return 0;
1274 }
1275
1276 /* Close a popup window. */
1277 void
1278 agent_popup_message_stop (ctrl_t ctrl)
1279 {
1280   int rc;
1281   pid_t pid;
1282
1283   (void)ctrl;
1284
1285   if (!popup_tid || !entry_ctx)
1286     {
1287       log_debug ("agent_popup_message_stop called with no active popup\n");
1288       return;
1289     }
1290
1291   pid = assuan_get_pid (entry_ctx);
1292   if (pid == (pid_t)(-1))
1293     ; /* No pid available can't send a kill. */
1294   else if (popup_finished)
1295     ; /* Already finished and ready for joining. */
1296 #ifdef HAVE_W32_SYSTEM
1297   /* Older versions of assuan set PID to 0 on Windows to indicate an
1298      invalid value.  */
1299   else if (pid != (pid_t) INVALID_HANDLE_VALUE
1300            && pid != 0)
1301     {
1302       HANDLE process = (HANDLE) pid;
1303
1304       /* Arbitrary error code.  */
1305       TerminateProcess (process, 1);
1306     }
1307 #else
1308   else if (pid && ((rc=waitpid (pid, NULL, WNOHANG))==-1 || (rc == pid)) )
1309     { /* The daemon already died.  No need to send a kill.  However
1310          because we already waited for the process, we need to tell
1311          assuan that it should not wait again (done by
1312          unlock_pinentry). */
1313       if (rc == pid)
1314         assuan_set_flag (entry_ctx, ASSUAN_NO_WAITPID, 1);
1315     }
1316   else if (pid > 0)
1317     kill (pid, SIGINT);
1318 #endif
1319
1320   /* Now wait for the thread to terminate. */
1321   rc = npth_join (popup_tid, NULL);
1322   if (rc)
1323     log_debug ("agent_popup_message_stop: pth_join failed: %s\n",
1324                strerror (rc));
1325   /* Thread IDs are opaque, but we try our best here by resetting it
1326      to the same content that a static global variable has.  */
1327   memset (&popup_tid, '\0', sizeof (popup_tid));
1328   entry_owner = NULL;
1329
1330   /* Now we can close the connection. */
1331   unlock_pinentry (0);
1332 }