http: Print human readable GNUTLS status.
[gnupg.git] / common / asshelp.c
index 95c7747..5e3f663 100644 (file)
@@ -3,12 +3,22 @@
  *
  * This file is part of GnuPG.
  *
- * GnuPG is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of either
  *
- * GnuPG is distributed in the hope that it will be useful,
+ *   - the GNU Lesser General Public License as published by the Free
+ *     Software Foundation; either version 3 of the License, or (at
+ *     your option) any later version.
+ *
+ * or
+ *
+ *   - the GNU General Public License as published by the Free
+ *     Software Foundation; either version 2 of the License, or (at
+ *     your option) any later version.
+ *
+ * or both in parallel, as here.
+ *
+ * This file is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
 #include "util.h"
 #include "exechelp.h"
 #include "sysutils.h"
-#include "status.h" 
+#include "status.h"
 #include "asshelp.h"
 
 /* The type we use for lock_agent_spawning.  */
 #ifdef HAVE_W32_SYSTEM
-# define lock_agent_t HANDLE
+# define lock_spawn_t HANDLE
 #else
-# define lock_agent_t dotlock_t
+# define lock_spawn_t dotlock_t
 #endif
 
+/* The time we wait until the agent or the dirmngr are ready for
+   operation after we started them before giving up.  */
+#ifdef HAVE_W32CE_SYSTEM
+# define SECS_TO_WAIT_FOR_AGENT 30
+# define SECS_TO_WAIT_FOR_DIRMNGR 30
+#else
+# define SECS_TO_WAIT_FOR_AGENT 5
+# define SECS_TO_WAIT_FOR_DIRMNGR 5
+#endif
 
 /* A bitfield that specifies the assuan categories to log.  This is
    identical to the default log handler of libassuan.  We need to do
@@ -88,6 +107,19 @@ setup_libassuan_logging (unsigned int *debug_var_address)
   assuan_set_log_cb (my_libassuan_log_handler, debug_var_address);
 }
 
+/* Change the Libassuan log categories to those given by NEWCATS.
+   NEWCATS is 0 the default category of ASSUAN_LOG_CONTROL is
+   selected.  Note, that setup_libassuan_logging overrides the values
+   given here.  */
+void
+set_libassuan_log_cats (unsigned int newcats)
+{
+  if (newcats)
+    log_cats = newcats;
+  else /* Default to log the control channel.  */
+    log_cats = (1 << (ASSUAN_LOG_CONTROL - 1));
+}
+
 
 
 static gpg_error_t
@@ -101,7 +133,7 @@ send_one_option (assuan_context_t ctx, gpg_err_source_t errsource,
 
   if (!value || !*value)
     err = 0;  /* Avoid sending empty strings.  */
-  else if (asprintf (&optstr, "OPTION %s%s=%s", 
+  else if (asprintf (&optstr, "OPTION %s%s=%s",
                      use_putenv? "putenv=":"", name, value) < 0)
     err = gpg_error_from_syserror ();
   else
@@ -127,7 +159,7 @@ send_pinentry_environment (assuan_context_t ctx,
 {
   gpg_error_t err = 0;
 #if defined(HAVE_SETLOCALE)
-  char *old_lc = NULL; 
+  char *old_lc = NULL;
 #endif
   char *dft_lc = NULL;
   const char *dft_ttyname;
@@ -135,7 +167,7 @@ send_pinentry_environment (assuan_context_t ctx,
   const char *name, *assname, *value;
   int is_default;
 
-  iterator = 0; 
+  iterator = 0;
   while ((name = session_env_list_stdenvnames (&iterator, &assname)))
     {
       value = session_env_getenv_or_default (session_env, name, NULL);
@@ -155,7 +187,7 @@ send_pinentry_environment (assuan_context_t ctx,
     }
 
 
-  dft_ttyname = session_env_getenv_or_default (session_env, "GPG_TTY", 
+  dft_ttyname = session_env_getenv_or_default (session_env, "GPG_TTY",
                                                &is_default);
   if (dft_ttyname && !is_default)
     dft_ttyname = NULL;  /* We need the default value.  */
@@ -173,7 +205,7 @@ send_pinentry_environment (assuan_context_t ctx,
 #endif
   if (opt_lc_ctype || (dft_ttyname && dft_lc))
     {
-      err = send_one_option (ctx, errsource, "lc-ctype", 
+      err = send_one_option (ctx, errsource, "lc-ctype",
                              opt_lc_ctype ? opt_lc_ctype : dft_lc, 0);
     }
 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
@@ -199,7 +231,7 @@ send_pinentry_environment (assuan_context_t ctx,
 #endif
   if (opt_lc_messages || (dft_ttyname && dft_lc))
     {
-      err = send_one_option (ctx, errsource, "lc-messages", 
+      err = send_one_option (ctx, errsource, "lc-messages",
                              opt_lc_messages ? opt_lc_messages : dft_lc, 0);
     }
 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
@@ -216,51 +248,76 @@ send_pinentry_environment (assuan_context_t ctx,
 }
 
 
-/* Lock the agent spawning process.  The caller needs to provide the
-   address of a variable to store the lock information.  */
+/* Lock a spawning process.  The caller needs to provide the address
+   of a variable to store the lock information and the name or the
+   process.  */
 static gpg_error_t
-lock_agent_spawning (lock_agent_t *lock, const char *homedir)
+lock_spawning (lock_spawn_t *lock, const char *homedir, const char *name,
+               int verbose)
 {
 #ifdef HAVE_W32_SYSTEM
   int waitrc;
+  int timeout = (!strcmp (name, "agent")
+                 ? SECS_TO_WAIT_FOR_AGENT
+                 : SECS_TO_WAIT_FOR_DIRMNGR);
 
   (void)homedir; /* Not required. */
 
-  *lock = CreateMutex (NULL, FALSE, "GnuPG_spawn_agent_sentinel");
+  *lock = CreateMutexW
+    (NULL, FALSE,
+     !strcmp (name, "agent")?   L"spawn_"GNUPG_NAME"_agent_sentinel":
+     !strcmp (name, "dirmngr")? L"spawn_"GNUPG_NAME"_dirmngr_sentinel":
+     /*                    */   L"spawn_"GNUPG_NAME"_unknown_sentinel");
   if (!*lock)
     {
-      log_error ("failed to create the spawn_agent mutex: %s\n",
-                 w32_strerror (-1));
+      log_error ("failed to create the spawn_%s mutex: %s\n",
+                 name, w32_strerror (-1));
       return gpg_error (GPG_ERR_GENERAL);
     }
 
-  waitrc = WaitForSingleObject (*lock, 5000);
+ retry:
+  waitrc = WaitForSingleObject (*lock, 1000);
   if (waitrc == WAIT_OBJECT_0)
     return 0;
 
+  if (waitrc == WAIT_TIMEOUT && timeout)
+    {
+      timeout--;
+      if (verbose)
+        log_info ("another process is trying to start the %s ... (%ds)\n",
+                  name, timeout);
+      goto retry;
+    }
   if (waitrc == WAIT_TIMEOUT)
-    log_info ("error waiting for the spawn_agent mutex: timeout\n");
+    log_info ("error waiting for the spawn_%s mutex: timeout\n", name);
   else
-    log_info ("error waiting for the spawn_agent mutex: "
-              "(code=%d) %s\n", waitrc, w32_strerror (-1));
+    log_info ("error waiting for the spawn_%s mutex: (code=%d) %s\n",
+              name, waitrc, w32_strerror (-1));
   return gpg_error (GPG_ERR_GENERAL);
 #else /*!HAVE_W32_SYSTEM*/
   char *fname;
 
+  (void)verbose;
+
   *lock = NULL;
 
-  fname = make_filename (homedir, "gnupg_spawn_agent_sentinel", NULL);
+  fname = make_absfilename_try
+    (homedir,
+     !strcmp (name, "agent")?   "gnupg_spawn_agent_sentinel":
+     !strcmp (name, "dirmngr")? "gnupg_spawn_dirmngr_sentinel":
+     /*                    */   "gnupg_spawn_unknown_sentinel",
+     NULL);
   if (!fname)
     return gpg_error_from_syserror ();
 
-  *lock = create_dotlock (fname);
+  *lock = dotlock_create (fname, 0);
   xfree (fname);
   if (!*lock)
     return gpg_error_from_syserror ();
 
   /* FIXME: We should use a timeout of 5000 here - however
      make_dotlock does not yet support values other than -1 and 0.  */
-  if (make_dotlock (*lock, -1))
+  if (dotlock_take (*lock, -1))
     return gpg_error_from_syserror ();
 
   return 0;
@@ -270,23 +327,23 @@ lock_agent_spawning (lock_agent_t *lock, const char *homedir)
 
 /* Unlock the spawning process.  */
 static void
-unlock_agent_spawning (lock_agent_t *lock)
+unlock_spawning (lock_spawn_t *lock, const char *name)
 {
   if (*lock)
     {
 #ifdef HAVE_W32_SYSTEM
       if (!ReleaseMutex (*lock))
-        log_error ("failed to release the spawn_agent mutex: %s\n",
-                   w32_strerror (-1));
+        log_error ("failed to release the spawn_%s mutex: %s\n",
+                   name, w32_strerror (-1));
       CloseHandle (*lock);
 #else /*!HAVE_W32_SYSTEM*/
-      destroy_dotlock (*lock);
+      (void)name;
+      dotlock_destroy (*lock);
 #endif /*!HAVE_W32_SYSTEM*/
       *lock = NULL;
     }
 }
 
-
 /* Try to connect to the agent via socket or fork it off and work by
    pipes.  Handle the server's initial greeting.  Returns a new assuan
    context at R_CTX or an error code. */
@@ -309,6 +366,7 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
   gpg_error_t err = 0;
   char *infostr, *p;
   assuan_context_t ctx;
+  int did_success_msg = 0;
 
   *r_ctx = NULL;
 
@@ -320,54 +378,76 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
     }
 
  restart:
-  infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
+  infostr = force_pipe_server? NULL : getenv (GPG_AGENT_INFO_NAME);
   if (!infostr || !*infostr)
     {
       char *sockname;
-      const char *argv[3];
+      const char *argv[5];
       pid_t pid;
       int excode;
 
       /* First check whether we can connect at the standard
          socket.  */
-      sockname = make_filename (homedir, "S.gpg-agent", NULL);
+      sockname = make_absfilename (homedir, GPG_AGENT_SOCK_NAME, NULL);
       err = assuan_socket_connect (ctx, sockname, 0, 0);
 
       if (err)
         {
+          char *abs_homedir;
+
           /* With no success start a new server.  */
+          if (!agent_program || !*agent_program)
+            agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
+
           if (verbose)
-            log_info (_("no running gpg-agent - starting one\n"));
-          
+            log_info (_("no running gpg-agent - starting '%s'\n"),
+                      agent_program);
+
           if (status_cb)
-            status_cb (status_cb_arg, STATUS_PROGRESS, 
+            status_cb (status_cb_arg, STATUS_PROGRESS,
                        "starting_agent ? 0 0", NULL);
-          
+
+          /* We better pass an absolute home directory to the agent
+             just in casee gpg-agent does not convert the passed name
+             to an absolute one (which it should do).  */
+          abs_homedir = make_absfilename_try (homedir, NULL);
+          if (!abs_homedir)
+            {
+              gpg_error_t tmperr = gpg_err_make (errsource,
+                                                 gpg_err_code_from_syserror ());
+              log_error ("error building filename: %s\n",gpg_strerror (tmperr));
+              xfree (sockname);
+             assuan_release (ctx);
+              return tmperr;
+            }
+
           if (fflush (NULL))
             {
-              gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
+              gpg_error_t tmperr = gpg_err_make (errsource,
+                                                 gpg_err_code_from_syserror ());
               log_error ("error flushing pending output: %s\n",
                          strerror (errno));
               xfree (sockname);
              assuan_release (ctx);
+              xfree (abs_homedir);
               return tmperr;
             }
-          
-          if (!agent_program || !*agent_program)
-            agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
 
-          argv[0] = "--use-standard-socket-p"; 
-          argv[1] = NULL;  
+          argv[0] = "--homedir";
+          argv[1] = abs_homedir;
+          argv[2] = "--use-standard-socket-p";
+          argv[3] = NULL;
           err = gnupg_spawn_process_fd (agent_program, argv, -1, -1, -1, &pid);
           if (err)
-            log_debug ("starting `%s' for testing failed: %s\n",
+            log_debug ("starting '%s' for testing failed: %s\n",
                        agent_program, gpg_strerror (err));
-          else if ((err = gnupg_wait_process (agent_program, pid, &excode)))
+          else if ((err = gnupg_wait_process (agent_program, pid, 1, &excode)))
             {
               if (excode == -1)
-                log_debug ("running `%s' for testing failed: %s\n",
+                log_debug ("running '%s' for testing failed (wait): %s\n",
                            agent_program, gpg_strerror (err));
-            }          
+            }
+          gnupg_release_process (pid);
 
           if (!err && !excode)
             {
@@ -375,37 +455,48 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
                  standard socket, an environment variable is not
                  required and thus we we can savely start the agent
                  here.  */
-              lock_agent_t lock;
+              lock_spawn_t lock;
 
-              argv[0] = "--daemon";
-              argv[1] = "--use-standard-socket"; 
-              argv[2] = NULL;  
+              argv[0] = "--homedir";
+              argv[1] = abs_homedir;
+              argv[2] = "--use-standard-socket";
+              argv[3] = "--daemon";
+              argv[4] = NULL;
 
-              if (!(err = lock_agent_spawning (&lock, homedir))
+              if (!(err = lock_spawning (&lock, homedir, "agent", verbose))
                   && assuan_socket_connect (ctx, sockname, 0, 0))
                 {
                   err = gnupg_spawn_process_detached (agent_program, argv,NULL);
                   if (err)
-                    log_error ("failed to start agent `%s': %s\n",
+                    log_error ("failed to start agent '%s': %s\n",
                                agent_program, gpg_strerror (err));
                   else
                     {
                       int i;
 
-                      if (verbose)
-                        log_info (_("waiting %d seconds for the agent "
-                                    "to come up\n"), 5);
-                      for (i=0; i < 5; i++)
+                      for (i=0; i < SECS_TO_WAIT_FOR_AGENT; i++)
                         {
+                          if (verbose)
+                            log_info (_("waiting for the agent "
+                                        "to come up ... (%ds)\n"),
+                                      SECS_TO_WAIT_FOR_AGENT - i);
                           gnupg_sleep (1);
                           err = assuan_socket_connect (ctx, sockname, 0, 0);
                           if (!err)
-                            break;
+                            {
+                              if (verbose)
+                                {
+                                  log_info (_("connection to agent "
+                                              "established\n"));
+                                  did_success_msg = 1;
+                                }
+                              break;
+                            }
                         }
                     }
                 }
 
-              unlock_agent_spawning (&lock);
+              unlock_spawning (&lock, "agent");
             }
           else
             {
@@ -414,28 +505,31 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
                  of the required features except for passphrase
                  caching etc.  */
               const char *pgmname;
-              int no_close_list[3];
+              assuan_fd_t no_close_list[3];
               int i;
-              
+
               if ( !(pgmname = strrchr (agent_program, '/')))
                 pgmname = agent_program;
               else
                 pgmname++;
-              
-              argv[0] = pgmname;
-              argv[1] = "--server";
-              argv[2] = NULL;
-              
+
+              argv[0] = pgmname;   /* (Assuan expects a standard argv.)  */
+              argv[1] = "--homedir";
+              argv[2] = abs_homedir;
+              argv[3] = "--server";
+              argv[4] = NULL;
+
               i=0;
               if (log_get_fd () != -1)
                 no_close_list[i++] = assuan_fd_from_posix_fd (log_get_fd ());
               no_close_list[i++] = assuan_fd_from_posix_fd (fileno (stderr));
-              no_close_list[i] = -1;
-              
+              no_close_list[i] = ASSUAN_INVALID_FD;
+
               /* Connect to the agent and perform initial handshaking. */
               err = assuan_pipe_connect (ctx, agent_program, argv,
                                          no_close_list, NULL, NULL, 0);
             }
+          xfree (abs_homedir);
         }
       xfree (sockname);
     }
@@ -447,7 +541,8 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
       infostr = xstrdup (infostr);
       if ( !(p = strchr (infostr, PATHSEP_C)) || p == infostr)
         {
-          log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
+          log_error (_("malformed %s environment variable\n"),
+                     GPG_AGENT_INFO_NAME);
           xfree (infostr);
           force_pipe_server = 1;
           goto restart;
@@ -480,11 +575,11 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
     {
       log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
       assuan_release (ctx);
-      return gpg_error (GPG_ERR_NO_AGENT);
+      return gpg_err_make (errsource, GPG_ERR_NO_AGENT);
     }
 
-  if (debug)
-    log_debug ("connection to agent established\n");
+  if (debug && !did_success_msg)
+    log_debug (_("connection to agent established\n"));
 
   err = assuan_transact (ctx, "RESET",
                         NULL, NULL, NULL, NULL, NULL, NULL);
@@ -502,3 +597,170 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
   return 0;
 }
 
+
+/* Try to connect to the dirmngr via a socket.  On platforms
+   supporting it, start it up if needed.  Returns a new assuan context
+   at R_CTX or an error code. */
+gpg_error_t
+start_new_dirmngr (assuan_context_t *r_ctx,
+                   gpg_err_source_t errsource,
+                   const char *homedir,
+                   const char *dirmngr_program,
+                   int verbose, int debug,
+                   gpg_error_t (*status_cb)(ctrl_t, int, ...),
+                   ctrl_t status_cb_arg)
+{
+  gpg_error_t err;
+  assuan_context_t ctx;
+  const char *sockname;
+  int did_success_msg = 0;
+
+  *r_ctx = NULL;
+
+  err = assuan_new (&ctx);
+  if (err)
+    {
+      log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
+      return err;
+    }
+
+  sockname = dirmngr_user_socket_name ();
+  if (sockname)
+    {
+      /* First try the local socket name and only if that fails try
+         the system socket.  */
+      err = assuan_socket_connect (ctx, sockname, 0, 0);
+      if (err)
+        sockname = dirmngr_sys_socket_name ();
+    }
+  else
+    sockname = dirmngr_sys_socket_name ();
+
+  err = assuan_socket_connect (ctx, sockname, 0, 0);
+
+#ifdef USE_DIRMNGR_AUTO_START
+  if (err)
+    {
+      lock_spawn_t lock;
+      const char *argv[4];
+      int try_system_daemon = 0;
+      char *abs_homedir;
+
+      /* No connection: Try start a new Dirmngr.  On Windows this will
+         fail because the Dirmngr is expected to be a system service.
+         However on WinCE we don't distinguish users and thus we can
+         start it.  */
+
+      /* We prefer to start it as a user daemon.  */
+      sockname = dirmngr_user_socket_name ();
+      if (!sockname)
+        {
+          sockname = dirmngr_sys_socket_name ();
+          try_system_daemon = 1;
+        }
+
+      if (!dirmngr_program || !*dirmngr_program)
+        dirmngr_program = gnupg_module_name (GNUPG_MODULE_NAME_DIRMNGR);
+
+      if (verbose)
+        log_info (_("no running Dirmngr - starting '%s'\n"),
+                  dirmngr_program);
+
+      if (status_cb)
+        status_cb (status_cb_arg, STATUS_PROGRESS,
+                   "starting_dirmngr ? 0 0", NULL);
+
+      abs_homedir = make_absfilename (homedir, NULL);
+      if (!abs_homedir)
+        {
+          gpg_error_t tmperr = gpg_err_make (errsource,
+                                             gpg_err_code_from_syserror ());
+          log_error ("error building filename: %s\n",gpg_strerror (tmperr));
+          assuan_release (ctx);
+          return tmperr;
+        }
+
+      if (fflush (NULL))
+        {
+          gpg_error_t tmperr = gpg_err_make (errsource,
+                                             gpg_err_code_from_syserror ());
+          log_error ("error flushing pending output: %s\n",
+                     strerror (errno));
+          assuan_release (ctx);
+          return tmperr;
+        }
+
+      argv[0] = "--daemon";
+      if (try_system_daemon)
+        argv[1] = NULL;
+      else
+        { /* Try starting as user daemon - dirmngr does this if the
+             home directory is given on the command line.  */
+          argv[1] = "--homedir";
+          argv[2] = abs_homedir;
+          argv[3] = NULL;
+        }
+
+      /* On the use of HOMEDIR for locking: Under Windows HOMEDIR is
+         not used thus it does not matter.  Under Unix we should
+         TRY_SYSTEM_DAEMON should never be true because
+         dirmngr_user_socket_name() won't return NULL.  */
+
+      if (!(err = lock_spawning (&lock, homedir, "dirmngr", verbose))
+          && assuan_socket_connect (ctx, sockname, 0, 0))
+        {
+          err = gnupg_spawn_process_detached (dirmngr_program, argv, NULL);
+          if (err)
+            log_error ("failed to start the dirmngr '%s': %s\n",
+                       dirmngr_program, gpg_strerror (err));
+          else
+            {
+              int i;
+
+              for (i=0; i < SECS_TO_WAIT_FOR_DIRMNGR; i++)
+                {
+                  if (verbose)
+                    log_info (_("waiting for the dirmngr "
+                                "to come up ... (%ds)\n"),
+                              SECS_TO_WAIT_FOR_DIRMNGR - i);
+                  gnupg_sleep (1);
+                  err = assuan_socket_connect (ctx, sockname, 0, 0);
+                  if (!err)
+                    {
+                      if (verbose)
+                        {
+                          log_info (_("connection to the dirmngr"
+                                      " established\n"));
+                          did_success_msg = 1;
+                        }
+                      break;
+                    }
+                }
+            }
+        }
+
+      unlock_spawning (&lock, "dirmngr");
+      xfree (abs_homedir);
+    }
+#else
+  (void)homedir;
+  (void)dirmngr_program;
+  (void)verbose;
+  (void)status_cb;
+  (void)status_cb_arg;
+#endif /*USE_DIRMNGR_AUTO_START*/
+
+  if (err)
+    {
+      log_error ("connecting dirmngr at '%s' failed: %s\n",
+                 sockname, gpg_strerror (err));
+      assuan_release (ctx);
+      return gpg_err_make (errsource, GPG_ERR_NO_DIRMNGR);
+    }
+
+  if (debug && !did_success_msg)
+    log_debug (_("connection to the dirmngr established\n"));
+
+  *r_ctx = ctx;
+  return 0;
+}