gpg: Do not print a the short keyid if the high word is zero.
[gnupg.git] / common / asshelp.c
index 96d9a24..5c32c6e 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 <locale.h>
 #endif
 
-#define JNLIB_NEED_LOG_LOGV
 #include "i18n.h"
 #include "util.h"
 #include "exechelp.h"
 #include "sysutils.h"
 #include "status.h"
+#include "membuf.h"
 #include "asshelp.h"
 
 /* The type we use for lock_agent_spawning.  */
@@ -76,7 +86,7 @@ my_libassuan_log_handler (assuan_context_t ctx, void *hook,
     return 0; /* Assuan debugging is not enabled.  */
 
   if (msg)
-    log_string (JNLIB_LOG_DEBUG, msg);
+    log_string (GPGRT_LOG_DEBUG, msg);
 
   return 1;
 }
@@ -97,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
@@ -242,9 +265,9 @@ lock_spawning (lock_spawn_t *lock, const char *homedir, const char *name,
 
   *lock = CreateMutexW
     (NULL, FALSE,
-     !strcmp (name, "agent")?   L"GnuPG_spawn_agent_sentinel":
-     !strcmp (name, "dirmngr")? L"GnuPG_spawn_dirmngr_sentinel":
-     /*                    */   L"GnuPG_spawn_unknown_sentinel");
+     !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_%s mutex: %s\n",
@@ -278,7 +301,7 @@ lock_spawning (lock_spawn_t *lock, const char *homedir, const char *name,
 
   *lock = NULL;
 
-  fname = make_filename
+  fname = make_absfilename_try
     (homedir,
      !strcmp (name, "agent")?   "gnupg_spawn_agent_sentinel":
      !strcmp (name, "dirmngr")? "gnupg_spawn_dirmngr_sentinel":
@@ -287,7 +310,7 @@ lock_spawning (lock_spawn_t *lock, const char *homedir, const char *name,
   if (!fname)
     return gpg_error_from_syserror ();
 
-  *lock = dotlock_create (fname);
+  *lock = dotlock_create (fname, 0);
   xfree (fname);
   if (!*lock)
     return gpg_error_from_syserror ();
@@ -321,29 +344,26 @@ unlock_spawning (lock_spawn_t *lock, const char *name)
     }
 }
 
-/* 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. */
+/* Try to connect to the agent via socket or start it if it is not
+   running and AUTOSTART is set.  Handle the server's initial
+   greeting.  Returns a new assuan context at R_CTX or an error
+   code. */
 gpg_error_t
 start_new_gpg_agent (assuan_context_t *r_ctx,
                      gpg_err_source_t errsource,
-                     const char *homedir,
                      const char *agent_program,
                      const char *opt_lc_ctype,
                      const char *opt_lc_messages,
                      session_env_t session_env,
-                     int verbose, int debug,
+                     int autostart, int verbose, int debug,
                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
                      ctrl_t status_cb_arg)
 {
-  /* If we ever failed to connect via a socket we will force the use
-     of the pipe based server for the lifetime of the process.  */
-  static int force_pipe_server = 0;
-
-  gpg_error_t err = 0;
-  char *infostr, *p;
+  gpg_error_t err;
   assuan_context_t ctx;
   int did_success_msg = 0;
+  char *sockname;
+  const char *argv[6];
 
   *r_ctx = NULL;
 
@@ -354,191 +374,159 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
       return err;
     }
 
- restart:
-  infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
-  if (!infostr || !*infostr)
+  sockname = make_filename_try (gnupg_socketdir (), GPG_AGENT_SOCK_NAME, NULL);
+  if (!sockname)
     {
-      char *sockname;
-      const char *argv[3];
-      pid_t pid;
-      int excode;
-
-      /* First check whether we can connect at the standard
-         socket.  */
-      sockname = make_filename (homedir, "S.gpg-agent", NULL);
-      err = assuan_socket_connect (ctx, sockname, 0, 0);
+      err = gpg_err_make (errsource, gpg_err_code_from_syserror ());
+      assuan_release (ctx);
+      return err;
+    }
 
-      if (err)
+  err = assuan_socket_connect (ctx, sockname, 0, 0);
+  if (err && autostart)
+    {
+      char *abs_homedir;
+      lock_spawn_t lock;
+      char *program = NULL;
+      const char *program_arg = NULL;
+      char *p;
+      const char *s;
+      int i;
+
+      /* With no success start a new server.  */
+      if (!agent_program || !*agent_program)
+        agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
+      else if ((s=strchr (agent_program, '|')) && s[1] == '-' && s[2]=='-')
         {
-          /* 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 `%s'\n"),
-                      agent_program);
-
-          if (status_cb)
-            status_cb (status_cb_arg, STATUS_PROGRESS,
-                       "starting_agent ? 0 0", NULL);
-
-          if (fflush (NULL))
+          /* Hack to insert an additional option on the command line.  */
+          program = xtrystrdup (agent_program);
+          if (!program)
             {
               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);
+              assuan_release (ctx);
               return tmperr;
             }
+          p = strchr (program, '|');
+          *p++ = 0;
+          program_arg = p;
+        }
+
+      if (verbose)
+        log_info (_("no running gpg-agent - starting '%s'\n"),
+                  agent_program);
 
-          argv[0] = "--use-standard-socket-p";
-          argv[1] = NULL;
-          err = gnupg_spawn_process_fd (agent_program, argv, -1, -1, -1, &pid);
+      if (status_cb)
+        status_cb (status_cb_arg, STATUS_PROGRESS,
+                   "starting_agent ? 0 0", NULL);
+
+      /* We better pass an absolute home directory to the agent just
+         in case gpg-agent does not convert the passed name to an
+         absolute one (which it should do).  */
+      abs_homedir = make_absfilename_try (gnupg_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);
+          xfree (program);
+          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));
+          xfree (sockname);
+          assuan_release (ctx);
+          xfree (abs_homedir);
+          xfree (program);
+          return tmperr;
+        }
+
+      /* If the agent has been configured for use with a standard
+         socket, an environment variable is not required and thus
+         we we can savely start the agent here.  */
+      i = 0;
+      argv[i++] = "--homedir";
+      argv[i++] = abs_homedir;
+      argv[i++] = "--use-standard-socket";
+      if (program_arg)
+        argv[i++] = program_arg;
+      argv[i++] = "--daemon";
+      argv[i++] = NULL;
+
+      if (!(err = lock_spawning (&lock, gnupg_homedir (), "agent", verbose))
+          && assuan_socket_connect (ctx, sockname, 0, 0))
+        {
+          err = gnupg_spawn_process_detached (program? program : agent_program,
+                                              argv, NULL);
           if (err)
-            log_debug ("starting `%s' for testing failed: %s\n",
+            log_error ("failed to start agent '%s': %s\n",
                        agent_program, gpg_strerror (err));
-          else if ((err = gnupg_wait_process (agent_program, pid, 1, &excode)))
-            {
-              if (excode == -1)
-                log_debug ("running `%s' for testing failed (wait): %s\n",
-                           agent_program, gpg_strerror (err));
-            }
-          gnupg_release_process (pid);
-
-          if (!err && !excode)
+          else
             {
-              /* If the agent has been configured for use with a
-                 standard socket, an environment variable is not
-                 required and thus we we can savely start the agent
-                 here.  */
-              lock_spawn_t lock;
-
-              argv[0] = "--daemon";
-              argv[1] = "--use-standard-socket";
-              argv[2] = NULL;
-
-              if (!(err = lock_spawning (&lock, homedir, "agent", verbose))
-                  && assuan_socket_connect (ctx, sockname, 0, 0))
+              for (i=0; i < SECS_TO_WAIT_FOR_AGENT; i++)
                 {
-                  err = gnupg_spawn_process_detached (agent_program, argv,NULL);
-                  if (err)
-                    log_error ("failed to start agent `%s': %s\n",
-                               agent_program, gpg_strerror (err));
-                  else
+                  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)
                     {
-                      int i;
-
-                      for (i=0; i < SECS_TO_WAIT_FOR_AGENT; i++)
+                      if (verbose)
                         {
-                          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)
-                            {
-                              if (verbose)
-                                {
-                                  log_info (_("connection to agent "
-                                              "established\n"));
-                                  did_success_msg = 1;
-                                }
-                              break;
-                            }
+                          log_info (_("connection to agent established\n"));
+                          did_success_msg = 1;
                         }
+                      break;
                     }
                 }
-
-              unlock_spawning (&lock, "agent");
-            }
-          else
-            {
-              /* If using the standard socket is not the default we
-                 start the agent as a pipe server which gives us most
-                 of the required features except for passphrase
-                 caching etc.  */
-              const char *pgmname;
-              int 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;
-
-              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;
-
-              /* Connect to the agent and perform initial handshaking. */
-              err = assuan_pipe_connect (ctx, agent_program, argv,
-                                         no_close_list, NULL, NULL, 0);
             }
         }
-      xfree (sockname);
-    }
-  else
-    {
-      int prot;
-      int pid;
 
-      infostr = xstrdup (infostr);
-      if ( !(p = strchr (infostr, PATHSEP_C)) || p == infostr)
-        {
-          log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
-          xfree (infostr);
-          force_pipe_server = 1;
-          goto restart;
-        }
-      *p++ = 0;
-      pid = atoi (p);
-      while (*p && *p != PATHSEP_C)
-        p++;
-      prot = *p? atoi (p+1) : 0;
-      if (prot != 1)
-        {
-          log_error (_("gpg-agent protocol version %d is not supported\n"),
-                     prot);
-          xfree (infostr);
-          force_pipe_server = 1;
-          goto restart;
-        }
-
-      err = assuan_socket_connect (ctx, infostr, pid, 0);
-      xfree (infostr);
-      if (gpg_err_code (err) == GPG_ERR_ASS_CONNECT_FAILED)
-        {
-          log_info (_("can't connect to the agent - trying fall back\n"));
-          force_pipe_server = 1;
-          goto restart;
-        }
+      unlock_spawning (&lock, "agent");
+      xfree (abs_homedir);
+      xfree (program);
     }
-
+  xfree (sockname);
   if (err)
     {
-      log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
+      if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
+        log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
       assuan_release (ctx);
       return gpg_err_make (errsource, GPG_ERR_NO_AGENT);
     }
 
   if (debug && !did_success_msg)
-    log_debug (_("connection to agent established\n"));
+    log_debug ("connection to agent established\n");
 
   err = assuan_transact (ctx, "RESET",
-                        NULL, NULL, NULL, NULL, NULL, NULL);
+                         NULL, NULL, NULL, NULL, NULL, NULL);
   if (!err)
-    err = send_pinentry_environment (ctx, errsource,
-                                    opt_lc_ctype, opt_lc_messages,
-                                    session_env);
+    {
+      err = send_pinentry_environment (ctx, errsource,
+                                       opt_lc_ctype, opt_lc_messages,
+                                       session_env);
+      if (gpg_err_code (err) == GPG_ERR_FORBIDDEN
+          && gpg_err_source (err) == GPG_ERR_SOURCE_GPGAGENT)
+        {
+          /* Check whether we are in restricted mode.  */
+          if (!assuan_transact (ctx, "GETINFO restricted",
+                                NULL, NULL, NULL, NULL, NULL, NULL))
+            {
+              if (verbose)
+                log_info (_("connection to agent is in restricted mode\n"));
+              err = 0;
+            }
+        }
+    }
   if (err)
     {
       assuan_release (ctx);
@@ -551,13 +539,13 @@ start_new_gpg_agent (assuan_context_t *r_ctx,
 
 
 /* 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. */
+   supporting it, start it up if needed and if AUTOSTART is true.
+   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 autostart,
                    int verbose, int debug,
                    gpg_error_t (*status_cb)(ctrl_t, int, ...),
                    ctrl_t status_cb_arg)
@@ -576,30 +564,62 @@ start_new_dirmngr (assuan_context_t *r_ctx,
       return err;
     }
 
-  sockname = dirmngr_socket_name ();
+  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)
+  if (err && autostart)
     {
       lock_spawn_t lock;
-      const char *argv[2];
+      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;
+        }
 
-      /* With no success try start a new Dirmngr.  On most systems
-         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.  A future extension might be to use the
-         userv system to start the Dirmngr as a system service.  */
       if (!dirmngr_program || !*dirmngr_program)
         dirmngr_program = gnupg_module_name (GNUPG_MODULE_NAME_DIRMNGR);
 
       if (verbose)
-        log_info (_("no running Dirmngr - starting `%s'\n"),
+        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 (gnupg_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,
@@ -611,14 +631,27 @@ start_new_dirmngr (assuan_context_t *r_ctx,
         }
 
       argv[0] = "--daemon";
-      argv[1] = NULL;
+      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))
+      if (!(err = lock_spawning (&lock, gnupg_homedir (), "dirmngr", verbose))
           && assuan_socket_connect (ctx, sockname, 0, 0))
         {
-          err = gnupg_spawn_process_detached (dirmngr_program, argv,NULL);
+          err = gnupg_spawn_process_detached (dirmngr_program, argv, NULL);
           if (err)
-            log_error ("failed to start the dirmngr `%s': %s\n",
+            log_error ("failed to start the dirmngr '%s': %s\n",
                        dirmngr_program, gpg_strerror (err));
           else
             {
@@ -647,9 +680,9 @@ start_new_dirmngr (assuan_context_t *r_ctx,
         }
 
       unlock_spawning (&lock, "dirmngr");
+      xfree (abs_homedir);
     }
 #else
-  (void)homedir;
   (void)dirmngr_program;
   (void)verbose;
   (void)status_cb;
@@ -658,15 +691,53 @@ start_new_dirmngr (assuan_context_t *r_ctx,
 
   if (err)
     {
-      log_error ("connecting dirmngr at `%s' failed: %s\n",
-                 sockname, gpg_strerror (err));
+      if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
+        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"));
+    log_debug ("connection to the dirmngr established\n");
 
   *r_ctx = ctx;
   return 0;
 }
+
+
+/* Return the version of a server using "GETINFO version".  On success
+   0 is returned and R_VERSION receives a malloced string with the
+   version which must be freed by the caller.  On error NULL is stored
+   at R_VERSION and an error code returned.  Mode is in general 0 but
+   certian values may be used to modify the used version command:
+
+      MODE == 0 = Use "GETINFO version"
+      MODE == 2 - Use "SCD GETINFO version"
+ */
+gpg_error_t
+get_assuan_server_version (assuan_context_t ctx, int mode, char **r_version)
+{
+  gpg_error_t err;
+  membuf_t data;
+
+  init_membuf (&data, 64);
+  err = assuan_transact (ctx,
+                         mode == 2? "SCD GETINFO version"
+                         /**/     : "GETINFO version",
+                         put_membuf_cb, &data,
+                         NULL, NULL, NULL, NULL);
+  if (err)
+    {
+      xfree (get_membuf (&data, NULL));
+      *r_version = NULL;
+    }
+  else
+    {
+      put_membuf (&data, "", 1);
+      *r_version = get_membuf (&data, NULL);
+      if (!*r_version)
+        err = gpg_error_from_syserror ();
+    }
+  return err;
+}