agent/
[gnupg.git] / agent / query.c
index ee18a14..a5a3d01 100644 (file)
@@ -1,5 +1,5 @@
 /* query.c - fork of the pinentry to query stuff from the user
- *     Copyright (C) 2001 Free Software Foundation, Inc.
+ * Copyright (C) 2001, 2002, 2004 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
 #include <assert.h>
 #include <unistd.h>
 #include <sys/stat.h>
-#ifdef USE_GNU_PTH
-# include <pth.h>
+#ifndef HAVE_W32_SYSTEM
+#include <sys/wait.h>
 #endif
+#include <pth.h>
 
 #include "agent.h"
 #include "i18n.h"
-#include "../assuan/assuan.h"
+#include <assuan.h>
 
 #ifdef _POSIX_OPEN_MAX
 #define MAX_OPEN_FDS _POSIX_OPEN_MAX
 #define MAX_OPEN_FDS 20
 #endif
 
-static ASSUAN_CONTEXT entry_ctx = NULL;
-#ifdef USE_GNU_PTH
-static pth_mutex_t entry_lock = PTH_MUTEX_INIT;
-#endif
 
-/* data to be passed to our callbacks */
-struct entry_parm_s {
+/* Because access to the pinentry must be serialized (it is and shall
+   be a global mutual dialog) we should better timeout further
+   requests after some time.  2 minutes seem to be a reasonable
+   time. */
+#define LOCK_TIMEOUT  (1*60)
+
+/* The assuan context of the current pinentry. */
+static assuan_context_t entry_ctx;
+
+/* The control variable of the connection owning the current pinentry.
+   This is only valid if ENTRY_CTX is not NULL.  Note, that we care
+   only about the value of the pointer and that it should never be
+   dereferenced.  */
+static ctrl_t entry_owner;
+
+/* A mutex used to serialize access to the pinentry. */
+static pth_mutex_t entry_lock;
+
+/* The thread ID of the popup working thread. */
+static pth_t  popup_tid;
+
+/* A flag used in communication between the popup working thread and
+   its stop function. */
+static int popup_finished;
+
+
+
+/* Data to be passed to our callbacks, */
+struct entry_parm_s
+{
   int lines;
   size_t size;
-  char *buffer;
+  unsigned char *buffer;
 };
 
 
 
 \f
+/* This function must be called once to initialize this module.  This
+   has to be done before a second thread is spawned.  We can't do the
+   static initialization because Pth emulation code might not be able
+   to do a static init; in particular, it is not possible for W32. */
+void
+initialize_module_query (void)
+{
+  static int initialized;
+
+  if (!initialized)
+    {
+      if (pth_mutex_init (&entry_lock))
+        initialized = 1;
+    }
+}
+
+
+
+static void
+dump_mutex_state (pth_mutex_t *m)
+{
+  if (!(m->mx_state & PTH_MUTEX_INITIALIZED))
+    log_printf ("not_initialized");
+  else if (!(m->mx_state & PTH_MUTEX_LOCKED))
+    log_printf ("not_locked");
+  else
+    log_printf ("locked tid=0x%lx count=%lu", (long)m->mx_owner, m->mx_count);
+}
+
+
+/* This function may be called to print infromation pertaining to the
+   current state of this module to the log. */
+void
+agent_query_dump_state (void)
+{
+  log_info ("agent_query_dump_state: entry_lock=");
+  dump_mutex_state (&entry_lock);
+  log_printf ("\n");
+  log_info ("agent_query_dump_state: entry_ctx=%p pid=%ld popup_tid=%p\n",
+            entry_ctx, (long)assuan_get_pid (entry_ctx), popup_tid);
+}
+
+/* Called to make sure that a popup window owned by the current
+   connection gets closed. */
+void
+agent_reset_query (ctrl_t ctrl)
+{
+  if (entry_ctx && popup_tid && entry_owner == ctrl)
+    {
+      agent_popup_message_stop (ctrl);
+    }
+}
+
+
+/* Unlock the pinentry so that another thread can start one and
+   disconnect that pinentry - we do this after the unlock so that a
+   stalled pinentry does not block other threads.  Fixme: We should
+   have a timeout in Assuan for the disconnect operation. */
 static int 
 unlock_pinentry (int rc)
 {
-#ifdef USE_GNU_PTH
+  assuan_context_t ctx = entry_ctx;
+
+  entry_ctx = NULL;
   if (!pth_mutex_release (&entry_lock))
     {
       log_error ("failed to release the entry lock\n");
       if (!rc)
-        rc = GNUPG_Internal_Error;
+        rc = gpg_error (GPG_ERR_INTERNAL);
     }
-#endif
+  assuan_disconnect (ctx);
   return rc;
 }
 
+
+/* To make sure we leave no secrets in our image after forking of the
+   pinentry, we use this callback. */
+static void
+atfork_cb (void *opaque, int where)
+{
+  if (!where)
+    gcry_control (GCRYCTL_TERM_SECMEM);
+}
+
+
 /* Fork off the pin entry if this has not already been done.  Note,
    that this function must always be used to aquire the lock for the
    pinentry - we will serialize _all_ pinentry calls.
  */
 static int
-start_pinentry (void)
+start_pinentry (ctrl_t ctrl)
 {
   int rc;
   const char *pgmname;
@@ -83,25 +179,35 @@ start_pinentry (void)
   const char *argv[5];
   int no_close_list[3];
   int i;
+  pth_event_t evt;
 
-#ifdef USE_GNU_PTH
-  if (!pth_mutex_acquire (&entry_lock, 0, NULL))
+  evt = pth_event (PTH_EVENT_TIME, pth_timeout (LOCK_TIMEOUT, 0));
+  if (!pth_mutex_acquire (&entry_lock, 0, evt))
     {
-      log_error ("failed to acquire the entry lock\n");
-      return GNUPG_Internal_Error;
+      if (pth_event_occurred (evt))
+        rc = gpg_error (GPG_ERR_TIMEOUT);
+      else
+        rc = gpg_error (GPG_ERR_INTERNAL);
+      pth_event_free (evt, PTH_FREE_THIS);
+      log_error (_("failed to acquire the pinentry lock: %s\n"),
+                 gpg_strerror (rc));
+      return rc;
     }
-#endif
+  pth_event_free (evt, PTH_FREE_THIS);
+
+  entry_owner = ctrl;
 
   if (entry_ctx)
     return 0; 
 
   if (opt.verbose)
-    log_info ("no running PIN Entry - starting it\n");
+    log_info ("starting a new PIN Entry\n");
       
   if (fflush (NULL))
     {
+      gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
       log_error ("error flushing pending output: %s\n", strerror (errno));
-      return unlock_pinentry (seterr (Write_Error));
+      return unlock_pinentry (tmperr);
     }
 
   if (!opt.pinentry_program || !*opt.pinentry_program)
@@ -111,12 +217,11 @@ start_pinentry (void)
   else
     pgmname++;
 
-  /* FIXME: We must do this thread specific */
   argv[0] = pgmname;
-  if (opt.display && !opt.keep_display)
+  if (ctrl->display && !opt.keep_display)
     {
       argv[1] = "--display";
-      argv[2] = opt.display;
+      argv[2] = ctrl->display;
       argv[3] = NULL;
     }
   else
@@ -131,14 +236,14 @@ start_pinentry (void)
     }
   no_close_list[i] = -1;
 
-  /* connect to the pinentry and perform initial handshaking */
-  rc = assuan_pipe_connect (&ctx, opt.pinentry_program, (char**)argv,
-                            no_close_list);
+  /* Connect to the pinentry and perform initial handshaking */
+  rc = assuan_pipe_connect2 (&ctx, opt.pinentry_program, (char**)argv,
+                             no_close_list, atfork_cb, NULL);
   if (rc)
     {
       log_error ("can't connect to the PIN entry module: %s\n",
                  assuan_strerror (rc));
-      return unlock_pinentry (seterr (No_PIN_Entry));
+      return unlock_pinentry (gpg_error (GPG_ERR_NO_PIN_ENTRY));
     }
   entry_ctx = ctx;
 
@@ -150,42 +255,42 @@ start_pinentry (void)
                         NULL, NULL, NULL, NULL, NULL, NULL);
   if (rc)
     return unlock_pinentry (map_assuan_err (rc));
-  if (opt.ttyname && !opt.keep_tty)
+  if (ctrl->ttyname)
     {
       char *optstr;
-      if (asprintf (&optstr, "OPTION ttyname=%s", opt.ttyname) < 0 )
-       return unlock_pinentry (GNUPG_Out_Of_Core);
+      if (asprintf (&optstr, "OPTION ttyname=%s", ctrl->ttyname) < 0 )
+       return unlock_pinentry (out_of_core ());
       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
                            NULL);
       free (optstr);
       if (rc)
        return unlock_pinentry (map_assuan_err (rc));
     }
-  if (opt.ttytype && !opt.keep_tty)
+  if (ctrl->ttytype)
     {
       char *optstr;
-      if (asprintf (&optstr, "OPTION ttytype=%s", opt.ttytype) < 0 )
-       return unlock_pinentry (GNUPG_Out_Of_Core);
+      if (asprintf (&optstr, "OPTION ttytype=%s", ctrl->ttytype) < 0 )
+       return unlock_pinentry (out_of_core ());
       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
                            NULL);
       if (rc)
        return unlock_pinentry (map_assuan_err (rc));
     }
-  if (opt.lc_ctype)
+  if (ctrl->lc_ctype)
     {
       char *optstr;
-      if (asprintf (&optstr, "OPTION lc-ctype=%s", opt.lc_ctype) < 0 )
-       return unlock_pinentry (GNUPG_Out_Of_Core);
+      if (asprintf (&optstr, "OPTION lc-ctype=%s", ctrl->lc_ctype) < 0 )
+       return unlock_pinentry (out_of_core ());
       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
                            NULL);
       if (rc)
        return unlock_pinentry (map_assuan_err (rc));
     }
-  if (opt.lc_messages)
+  if (ctrl->lc_messages)
     {
       char *optstr;
-      if (asprintf (&optstr, "OPTION lc-messages=%s", opt.lc_messages) < 0 )
-       return unlock_pinentry (GNUPG_Out_Of_Core);
+      if (asprintf (&optstr, "OPTION lc-messages=%s", ctrl->lc_messages) < 0 )
+       return unlock_pinentry (out_of_core ());
       rc = assuan_transact (entry_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
                            NULL);
       if (rc)
@@ -230,7 +335,10 @@ all_digitsp( const char *s)
    number here and repeat it as long as we have invalid formed
    numbers. */
 int
-agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
+agent_askpin (ctrl_t ctrl,
+              const char *desc_text, const char *prompt_text,
+              const char *initial_errtext,
+              struct pin_entry_info_s *pininfo)
 {
   int rc;
   char line[ASSUAN_LINELENGTH];
@@ -242,7 +350,7 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
     return 0; /* fixme: we should return BAD PIN */
 
   if (!pininfo || pininfo->max_length < 1)
-    return seterr (Invalid_Value);
+    return gpg_error (GPG_ERR_INV_VALUE);
   if (!desc_text && pininfo->min_digits)
     desc_text = _("Please enter your PIN, so that the secret key "
                   "can be unlocked for this session");
@@ -250,9 +358,12 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
     desc_text = _("Please enter your passphrase, so that the secret key "
                   "can be unlocked for this session");
 
-  is_pin = desc_text && strstr (desc_text, "PIN");
+  if (prompt_text)
+    is_pin = !!strstr (prompt_text, "PIN");
+  else
+    is_pin = desc_text && strstr (desc_text, "PIN");
 
-  rc = start_pinentry ();
+  rc = start_pinentry (ctrl);
   if (rc)
     return rc;
 
@@ -262,18 +373,29 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
   if (rc)
     return unlock_pinentry (map_assuan_err (rc));
 
-  rc = assuan_transact (entry_ctx,
-                        is_pin? "SETPROMPT PIN:"
-                              : "SETPROMPT Passphrase:",
-                        NULL, NULL, NULL, NULL, NULL, NULL);
+  snprintf (line, DIM(line)-1, "SETPROMPT %s",
+            prompt_text? prompt_text : is_pin? "PIN:" : "Passphrase:");
+  line[DIM(line)-1] = 0;
+  rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
   if (rc)
     return unlock_pinentry (map_assuan_err (rc));
 
+
+  if (initial_errtext)
+    { 
+      snprintf (line, DIM(line)-1, "SETERROR %s", initial_errtext);
+      line[DIM(line)-1] = 0;
+      rc = assuan_transact (entry_ctx, line,
+                            NULL, NULL, NULL, NULL, NULL, NULL);
+      if (rc)
+        return unlock_pinentry (map_assuan_err (rc));
+    }
+
   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
     {
       memset (&parm, 0, sizeof parm);
       parm.size = pininfo->max_length;
-      parm.buffer = pininfo->pin;
+      parm.buffer = (unsigned char*)pininfo->pin;
 
       if (errtext)
         { 
@@ -281,7 +403,8 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
           snprintf (line, DIM(line)-1, "SETERROR %s (try %d of %d)",
                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
           line[DIM(line)-1] = 0;
-          rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
+          rc = assuan_transact (entry_ctx, line,
+                                NULL, NULL, NULL, NULL, NULL, NULL);
           if (rc)
             return unlock_pinentry (map_assuan_err (rc));
           errtext = NULL;
@@ -314,7 +437,8 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
           rc = pininfo->check_cb (pininfo);
           if (rc == -1 && pininfo->cb_errtext)
             errtext = pininfo->cb_errtext;
-          else if (rc == GNUPG_Bad_Passphrase || rc == GNUPG_Bad_PIN)
+          else if (gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
+                   || gpg_err_code (rc) == GPG_ERR_BAD_PIN)
             errtext = (is_pin? _("Bad PIN")
                        : _("Bad Passphrase"));
           else if (rc)
@@ -325,8 +449,8 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
         return unlock_pinentry (0); /* okay, got a PIN or passphrase */
     }
 
-  return unlock_pinentry (pininfo->min_digits? GNUPG_Bad_PIN
-                          : GNUPG_Bad_Passphrase);
+  return unlock_pinentry (gpg_error (pininfo->min_digits? GPG_ERR_BAD_PIN
+                          : GPG_ERR_BAD_PASSPHRASE));
 }
 
 
@@ -335,21 +459,23 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
    passphrase is returned in RETPASS as an hex encoded string to be
    freed by the caller */
 int 
-agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
+agent_get_passphrase (ctrl_t ctrl,
+                      char **retpass, const char *desc, const char *prompt,
                       const char *errtext)
 {
 
   int rc;
   char line[ASSUAN_LINELENGTH];
   struct entry_parm_s parm;
-  unsigned char *p, *hexstring;
+  unsigned char *p;
+  char *hexstring;
   int i;
 
   *retpass = NULL;
   if (opt.batch)
-    return GNUPG_Bad_Passphrase
+    return gpg_error (GPG_ERR_BAD_PASSPHRASE)
 
-  rc = start_pinentry ();
+  rc = start_pinentry (ctrl);
   if (rc)
     return rc;
 
@@ -385,7 +511,7 @@ agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
   parm.size = ASSUAN_LINELENGTH/2 - 5;
   parm.buffer = gcry_malloc_secure (parm.size+10);
   if (!parm.buffer)
-    return unlock_pinentry (seterr (Out_Of_Core));
+    return unlock_pinentry (out_of_core ());
 
   assuan_begin_confidential (entry_ctx);
   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL, NULL, NULL);
@@ -395,11 +521,12 @@ agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
       return unlock_pinentry (map_assuan_err (rc));
     }
   
-  hexstring = gcry_malloc_secure (strlen (parm.buffer)*2+1);
+  hexstring = gcry_malloc_secure (strlen ((char*)parm.buffer)*2+1);
   if (!hexstring)
     {
+      gpg_error_t tmperr = out_of_core ();
       xfree (parm.buffer);
-      return unlock_pinentry (seterr (Out_Of_Core));
+      return unlock_pinentry (tmperr);
     }
 
   for (i=0, p=parm.buffer; *p; p++, i += 2)
@@ -413,16 +540,17 @@ agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
 
 \f
 /* Pop up the PIN-entry, display the text and the prompt and ask the
-   user to confirm this.  We return 0 for success, ie. the used
-   confirmed it, GNUPG_Not_Confirmed for what the text says or an
+   user to confirm this.  We return 0 for success, ie. the user
+   confirmed it, GPG_ERR_NOT_CONFIRMED for what the text says or an
    other error. */
 int 
-agent_get_confirmation (const char *desc, const char *ok, const char *cancel)
+agent_get_confirmation (ctrl_t ctrl,
+                        const char *desc, const char *ok, const char *cancel)
 {
   int rc;
   char line[ASSUAN_LINELENGTH];
 
-  rc = start_pinentry ();
+  rc = start_pinentry (ctrl);
   if (rc)
     return rc;
 
@@ -457,4 +585,119 @@ agent_get_confirmation (const char *desc, const char *ok, const char *cancel)
 }
 
 
+/* The thread running the popup message. */
+static void *
+popup_message_thread (void *arg)
+{
+  assuan_transact (entry_ctx, "CONFIRM", NULL, NULL, NULL, NULL, NULL, NULL);
+  popup_finished = 1;
+  return NULL;
+}
+
+
+/* Pop up a message window similar to the confirm one but keep it open
+   until agent_popup_message_stop has been called.  It is crucial for
+   the caller to make sure that the stop function gets called as soon
+   as the message is not anymore required becuase the message is
+   system modal and all other attempts to use the pinentry will fail
+   (after a timeout). */
+int 
+agent_popup_message_start (ctrl_t ctrl, const char *desc,
+                           const char *ok_btn, const char *cancel_btn)
+{
+  int rc;
+  char line[ASSUAN_LINELENGTH];
+  pth_attr_t tattr;
+
+  rc = start_pinentry (ctrl);
+  if (rc)
+    return rc;
+
+  if (desc)
+    snprintf (line, DIM(line)-1, "SETDESC %s", desc);
+  else
+    snprintf (line, DIM(line)-1, "RESET");
+  line[DIM(line)-1] = 0;
+  rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
+  if (rc)
+    return unlock_pinentry (map_assuan_err (rc));
+
+  if (ok_btn)
+    {
+      snprintf (line, DIM(line)-1, "SETOK %s", ok_btn);
+      line[DIM(line)-1] = 0;
+      rc = assuan_transact (entry_ctx, line, NULL,NULL,NULL,NULL,NULL,NULL);
+      if (rc)
+        return unlock_pinentry (map_assuan_err (rc));
+    }
+  if (cancel_btn)
+    {
+      snprintf (line, DIM(line)-1, "SETCANCEL %s", cancel_btn);
+      line[DIM(line)-1] = 0;
+      rc = assuan_transact (entry_ctx, line, NULL,NULL,NULL,NULL,NULL,NULL);
+      if (rc)
+        return unlock_pinentry (map_assuan_err (rc));
+    }
+
+  tattr = pth_attr_new();
+  pth_attr_set (tattr, PTH_ATTR_JOINABLE, 1);
+  pth_attr_set (tattr, PTH_ATTR_STACK_SIZE, 256*1024);
+  pth_attr_set (tattr, PTH_ATTR_NAME, "popup-message");
+
+  popup_finished = 0;
+  popup_tid = pth_spawn (tattr, popup_message_thread, NULL);
+  if (!popup_tid)
+    {
+      rc = gpg_error_from_errno (errno);
+      log_error ("error spawning popup message handler: %s\n",
+                 strerror (errno) );
+      pth_attr_destroy (tattr);
+      return unlock_pinentry (rc);
+    }
+  pth_attr_destroy (tattr);
+
+  return 0;
+}
+
+/* Close a popup window. */
+void
+agent_popup_message_stop (ctrl_t ctrl)
+{
+  int rc;
+  pid_t pid;
+
+  if (!popup_tid || !entry_ctx)
+    {
+      log_debug ("agent_popup_message_stop called with no active popup\n");
+      return; 
+    }
+
+  pid = assuan_get_pid (entry_ctx);
+  if (pid == (pid_t)(-1))
+    ; /* No pid available can't send a kill. */
+  else if (popup_finished)
+    ; /* Already finished and ready for joining. */
+  else if (pid && ((rc=waitpid (pid, NULL, WNOHANG))==-1 || (rc == pid)) )
+    { /* The daemon already died.  No need to send a kill.  However
+         because we already waited for the process, we need to tell
+         assuan that it should not wait again (done by
+         unlock_pinentry). */
+      if (rc == pid)
+        assuan_set_flag (entry_ctx, ASSUAN_NO_WAITPID, 1);
+    }
+  else
+    kill (pid, SIGINT);
+
+  /* Now wait for the thread to terminate. */
+  rc = pth_join (popup_tid, NULL);
+  if (!rc)
+    log_debug ("agent_popup_message_stop: pth_join failed: %s\n",
+               strerror (errno));
+  popup_tid = NULL;
+  entry_owner = NULL;
+
+  /* Now we can close the connection. */
+  unlock_pinentry (0);
+}
+