* call-scd.c (inq_needpin): Skip leading spaces in of PIN
[gnupg.git] / agent / query.c
index 7780abb..d3b42a4 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.
  *
@@ -33,7 +33,7 @@
 
 #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
 
+
+/* 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)
+
+
 static ASSUAN_CONTEXT entry_ctx = NULL;
 #ifdef USE_GNU_PTH
-static pth_mutex_t entry_lock = PTH_MUTEX_INIT;
+static pth_mutex_t entry_lock;
 #endif
 
 /* data to be passed to our callbacks */
@@ -56,26 +64,64 @@ struct entry_parm_s {
 
 
 \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 particualr, it is not possible for W32. */
+void
+initialize_module_query (void)
+{
+#ifdef USE_GNU_PTH
+  static int initialized;
+
+  if (!initialized)
+    if (pth_mutex_init (&entry_lock))
+      initialized = 1;
+#endif /*USE_GNU_PTH*/
+}
+
+
+
+
+/* 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)
 {
+  ASSUAN_CONTEXT ctx = entry_ctx;
+
 #ifdef USE_GNU_PTH
   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
+  entry_ctx = NULL;
+  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 ctrl)
 {
   int rc;
   const char *pgmname;
@@ -85,23 +131,36 @@ start_pinentry (void)
   int i;
 
 #ifdef USE_GNU_PTH
-  if (!pth_mutex_acquire (&entry_lock, 0, NULL))
+ {
+   pth_event_t evt;
+
+   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;
     }
+   pth_event_free (evt, PTH_FREE_THIS);
+ }
 #endif
 
   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 +170,11 @@ start_pinentry (void)
   else
     pgmname++;
 
-  /* FIXME: We must do this thread specific */
   argv[0] = pgmname;
-  if (opt.display)
+  if (ctrl->display && !opt.keep_display)
     {
       argv[1] = "--display";
-      argv[2] = opt.display;
+      argv[2] = ctrl->display;
       argv[3] = NULL;
     }
   else
@@ -131,14 +189,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 +208,42 @@ start_pinentry (void)
                         NULL, NULL, NULL, NULL, NULL, NULL);
   if (rc)
     return unlock_pinentry (map_assuan_err (rc));
-  if (opt.ttyname)
+  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)
+  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,26 +288,35 @@ 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];
   struct entry_parm_s parm;
   const char *errtext = NULL;
-  int is_pin;
+  int is_pin = 0;
 
   if (opt.batch)
     return 0; /* fixme: we should return BAD PIN */
 
   if (!pininfo || pininfo->max_length < 1)
-    return seterr (Invalid_Value);
-  if (!desc_text)
-    desc_text = _("Please enter you PIN, so that the secret key "
+    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");
+  else if (!desc_text)
+    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;
 
@@ -259,13 +326,24 @@ 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);
@@ -278,7 +356,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;
@@ -292,7 +371,7 @@ agent_askpin (const char *desc_text, struct pin_entry_info_s *pininfo)
       else if (rc)
         return unlock_pinentry (map_assuan_err (rc));
 
-      if (!errtext && is_pin)
+      if (!errtext && pininfo->min_digits)
         {
           /* do some basic checks on the entered PIN. */
           if (!all_digitsp (pininfo->pin))
@@ -311,7 +390,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)
@@ -322,8 +402,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));
 }
 
 
@@ -332,7 +412,8 @@ 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 ctrl,
+                      char **retpass, const char *desc, const char *prompt,
                       const char *errtext)
 {
 
@@ -344,9 +425,9 @@ agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
 
   *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;
 
@@ -382,7 +463,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,8 +476,9 @@ agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
   hexstring = gcry_malloc_secure (strlen (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)
@@ -411,15 +493,16 @@ 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
+   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 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;