* findkey.c (agent_public_key_from_file): Fixed array assignment.
[gnupg.git] / agent / command.c
index a3e1c51..c39bcc6 100644 (file)
@@ -1,5 +1,5 @@
 /* command.c - gpg-agent command handler
- *     Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
+ * Copyright (C) 2001, 2002, 2003, 2004, 2005  Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
    some buffering in secure mempory to protect session keys etc. */
 
 #include <config.h>
+
 #include <errno.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
 #include <unistd.h>
+#include <assert.h>
 
 #include <assuan.h>
 
@@ -50,20 +52,60 @@ struct server_local_s {
   ASSUAN_CONTEXT assuan_ctx;
   int message_fd;
   int use_cache_for_signing;
+  char *keydesc;  /* Allocated description for the next key
+                     operation. */
 };
 
 
 
 
 \f
+/* Release the memory buffer MB but first wipe out the used memory. */
+static void
+clear_outbuf (membuf_t *mb)
+{
+  void *p;
+  size_t n;
+
+  p = get_membuf (mb, &n);
+  if (p)
+    {
+      memset (p, 0, n);
+      xfree (p);
+    }
+}
+
+
+/* Write the content of memory buffer MB as assuan data to CTX and
+   wipe the buffer out afterwards. */
+static gpg_error_t
+write_and_clear_outbuf (assuan_context_t ctx, membuf_t *mb)
+{
+  assuan_error_t ae;
+  void *p;
+  size_t n;
+
+  p = get_membuf (mb, &n);
+  if (!p)
+    return gpg_error (GPG_ERR_ENOMEM);
+  ae = assuan_send_data (ctx, p, n);
+  memset (p, 0, n);
+  xfree (p);
+  return map_assuan_err (ae);
+}
+
+
 static void
 reset_notify (ASSUAN_CONTEXT ctx)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
 
   memset (ctrl->keygrip, 0, 20);
   ctrl->have_keygrip = 0;
   ctrl->digest.valuelen = 0;
+
+  xfree (ctrl->server_local->keydesc);
+  ctrl->server_local->keydesc = NULL;
 }
 
 
@@ -78,6 +120,18 @@ has_option (const char *line, const char *name)
   return (s && (s == line || spacep (s-1)) && (!s[n] || spacep (s+n)));
 }
 
+/* Replace all '+' by a blank. */
+static void
+plus_to_blank (char *s)
+{
+  for (; *s; s++)
+    {
+      if (*s == '+')
+        *s = ' ';
+    }
+}
+
+
 /* Parse a hex string.  Return an Assuan error code or 0 on success and the
    length of the parsed string in LEN. */
 static int
@@ -89,7 +143,7 @@ parse_hexstring (ASSUAN_CONTEXT ctx, const char *string, size_t *len)
   /* parse the hash value */
   for (p=string, n=0; hexdigitp (p); p++, n++)
     ;
-  if (*p)
+  if (*p != ' ' && *p != '\t' && *p)
     return set_error (Parameter_Error, "invalid hexstring");
   if ((n&1))
     return set_error (Parameter_Error, "odd number of digits");
@@ -114,7 +168,7 @@ parse_keygrip (ASSUAN_CONTEXT ctx, const char *string, unsigned char *buf)
   if (n != 20)
     return set_error (Parameter_Error, "invalid length of keygrip");
 
-  for (p=string, n=0; n < 20; p += 2, n++)
+  for (p=(const unsigned char*)string, n=0; n < 20; p += 2, n++)
     buf[n] = xtoi_2 (p);
 
   return 0;
@@ -179,7 +233,7 @@ cmd_listtrusted (ASSUAN_CONTEXT ctx, char *line)
 static int
 cmd_marktrusted (ASSUAN_CONTEXT ctx, char *line)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc, n, i;
   char *p;
   char fpr[41];
@@ -245,7 +299,7 @@ static int
 cmd_sigkey (ASSUAN_CONTEXT ctx, char *line)
 {
   int rc;
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
 
   rc = parse_keygrip (ctx, line, ctrl->keygrip);
   if (rc)
@@ -255,6 +309,50 @@ cmd_sigkey (ASSUAN_CONTEXT ctx, char *line)
 }
 
 
+/* SETKEYDESC plus_percent_escaped_string:
+
+   Set a description to be used for the next PKSIGN or PKDECRYPT
+   operation if this operation requires the entry of a passphrase.  If
+   this command is not used a default text will be used.  Note, that
+   this description implictly selects the label used for the entry
+   box; if the string contains the string PIN (which in general will
+   not be translated), "PIN" is used, other wiese the translation of
+   'passphrase" is used.  The description string should not contain
+   blanks unless they are percent or '+' escaped.
+
+   The descrition is only valid for the next PKSIGN or PKDECRYPT
+   operation.
+*/
+static int
+cmd_setkeydesc (assuan_context_t ctx, char *line)
+{
+  ctrl_t ctrl = assuan_get_pointer (ctx);
+  char *desc, *p;
+
+  for (p=line; *p == ' '; p++)
+    ;
+  desc = p;
+  p = strchr (desc, ' ');
+  if (p)
+    *p = 0; /* We ignore any garbage; we might late use it for other args. */
+
+  if (!desc || !*desc)
+    return set_error (Parameter_Error, "no description given");
+
+  /* Note, that we only need to replace the + characters and should
+     leave the other escaping in place because the escaped string is
+     send verbatim to the pinentry which does the unescaping (but not
+     the + replacing) */
+  plus_to_blank (desc);
+
+  xfree (ctrl->server_local->keydesc);
+  ctrl->server_local->keydesc = xtrystrdup (desc);
+  if (!ctrl->server_local->keydesc)
+    return map_to_assuan_status (gpg_error_from_errno (errno));
+  return 0;
+}
+
+
 /* SETHASH <algonumber> <hexstring> 
 
   The client can use this command to tell the server about the data
@@ -265,7 +363,7 @@ cmd_sethash (ASSUAN_CONTEXT ctx, char *line)
   int rc;
   size_t n;
   char *p;
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   unsigned char *buf;
   char *endp;
   int algo;
@@ -306,17 +404,27 @@ static int
 cmd_pksign (ASSUAN_CONTEXT ctx, char *line)
 {
   int rc;
-  int ignore_cache = 0;
-  CTRL ctrl = assuan_get_pointer (ctx);
-
+  cache_mode_t cache_mode = CACHE_MODE_NORMAL;
+  ctrl_t ctrl = assuan_get_pointer (ctx);
+  membuf_t outbuf;
+  
   if (opt.ignore_cache_for_signing)
-    ignore_cache = 1;
+    cache_mode = CACHE_MODE_IGNORE;
   else if (!ctrl->server_local->use_cache_for_signing)
-    ignore_cache = 1;
+    cache_mode = CACHE_MODE_IGNORE;
+
+  init_membuf (&outbuf, 512);
 
-  rc = agent_pksign (ctrl, assuan_get_data_fp (ctx), ignore_cache);
+  rc = agent_pksign (ctrl, ctrl->server_local->keydesc,
+                     &outbuf, cache_mode);
+  if (rc)
+    clear_outbuf (&outbuf);
+  else
+    rc = write_and_clear_outbuf (ctx, &outbuf);
   if (rc)
     log_error ("command pksign failed: %s\n", gpg_strerror (rc));
+  xfree (ctrl->server_local->keydesc);
+  ctrl->server_local->keydesc = NULL;
   return map_to_assuan_status (rc);
 }
 
@@ -328,9 +436,10 @@ static int
 cmd_pkdecrypt (ASSUAN_CONTEXT ctx, char *line)
 {
   int rc;
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   unsigned char *value;
   size_t valuelen;
+  membuf_t outbuf;
 
   /* First inquire the data to decrypt */
   rc = assuan_inquire (ctx, "CIPHERTEXT",
@@ -338,10 +447,19 @@ cmd_pkdecrypt (ASSUAN_CONTEXT ctx, char *line)
   if (rc)
     return rc;
 
-  rc = agent_pkdecrypt (ctrl, value, valuelen, assuan_get_data_fp (ctx));
+  init_membuf (&outbuf, 512);
+
+  rc = agent_pkdecrypt (ctrl, ctrl->server_local->keydesc,
+                        value, valuelen, &outbuf);
   xfree (value);
   if (rc)
+    clear_outbuf (&outbuf);
+  else
+    rc = write_and_clear_outbuf (ctx, &outbuf);
+  if (rc)
     log_error ("command pkdecrypt failed: %s\n", gpg_strerror (rc));
+  xfree (ctrl->server_local->keydesc);
+  ctrl->server_local->keydesc = NULL;
   return map_to_assuan_status (rc);
 }
 
@@ -363,34 +481,80 @@ cmd_pkdecrypt (ASSUAN_CONTEXT ctx, char *line)
 static int
 cmd_genkey (ASSUAN_CONTEXT ctx, char *line)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc;
   unsigned char *value;
   size_t valuelen;
+  membuf_t outbuf;
 
   /* First inquire the parameters */
   rc = assuan_inquire (ctx, "KEYPARAM", &value, &valuelen, MAXLEN_KEYPARAM);
   if (rc)
     return rc;
 
-  rc = agent_genkey (ctrl, value, valuelen, assuan_get_data_fp (ctx));
+  init_membuf (&outbuf, 512);
+
+  rc = agent_genkey (ctrl, (char*)value, valuelen, &outbuf);
   xfree (value);
   if (rc)
+    clear_outbuf (&outbuf);
+  else
+    rc = write_and_clear_outbuf (ctx, &outbuf);
+  if (rc)
     log_error ("command genkey failed: %s\n", gpg_strerror (rc));
   return map_to_assuan_status (rc);
 }
 
 
-static void
-plus_to_blank (char *s)
+
+\f
+/* READKEY <hexstring_with_keygrip>
+  
+   Return the public key for the given keygrip.  */
+static int
+cmd_readkey (assuan_context_t ctx, char *line)
 {
-  for (; *s; s++)
+  ctrl_t ctrl = assuan_get_pointer (ctx);
+  int rc;
+  unsigned char grip[20];
+  gcry_sexp_t s_pkey = NULL;
+
+  rc = parse_keygrip (ctx, line, grip);
+  if (rc)
+    return rc; /* Return immediately as this is already an Assuan error code.*/
+
+  rc = agent_public_key_from_file (ctrl, grip, &s_pkey);
+  if (!rc)
     {
-      if (*s == '+')
-        *s = ' ';
+      size_t len;
+      unsigned char *buf;
+
+      len = gcry_sexp_sprint (s_pkey, GCRYSEXP_FMT_CANON, NULL, 0);
+      assert (len);
+      buf = xtrymalloc (len);
+      if (!buf)
+        rc = gpg_error_from_errno (errno);
+      else
+        {
+          len = gcry_sexp_sprint (s_pkey, GCRYSEXP_FMT_CANON, buf, len);
+          assert (len);
+          rc = assuan_send_data (ctx, buf, len);
+          rc = map_assuan_err (rc);
+          xfree (buf);
+        }
+      gcry_sexp_release (s_pkey);
     }
+
+  if (rc)
+    log_error ("command readkey failed: %s\n", gpg_strerror (rc));
+  return map_to_assuan_status (rc);
 }
 
+
+
+
+
+\f
 /* GET_PASSPHRASE <cache_id> [<error_message> <prompt> <description>]
 
    This function is usually used to ask for a passphrase to be used
@@ -405,7 +569,7 @@ plus_to_blank (char *s)
 static int
 cmd_get_passphrase (ASSUAN_CONTEXT ctx, char *line)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc;
   const char *pw;
   char *response;
@@ -459,7 +623,8 @@ cmd_get_passphrase (ASSUAN_CONTEXT ctx, char *line)
     desc = NULL;
 
   /* Note: we store the hexified versions in the cache. */
-  pw = cacheid ? agent_get_cache (cacheid, &cache_marker) : NULL;
+  pw = cacheid ? agent_get_cache (cacheid, CACHE_MODE_NORMAL, &cache_marker)
+               : NULL;
   if (pw)
     {
       assuan_begin_confidential (ctx);
@@ -483,7 +648,7 @@ cmd_get_passphrase (ASSUAN_CONTEXT ctx, char *line)
       if (!rc)
         {
           if (cacheid)
-            agent_put_cache (cacheid, response, 0);
+            agent_put_cache (cacheid, CACHE_MODE_USER, response, 0);
           assuan_begin_confidential (ctx);
           rc = assuan_set_okay_line (ctx, response);
           xfree (response);
@@ -518,7 +683,7 @@ cmd_clear_passphrase (ASSUAN_CONTEXT ctx, char *line)
   if (!cacheid || !*cacheid || strlen (cacheid) > 50)
     return set_error (Parameter_Error, "invalid length of cacheID");
 
-  agent_put_cache (cacheid, NULL, 0);
+  agent_put_cache (cacheid, CACHE_MODE_USER, NULL, 0);
   return 0;
 }
 
@@ -530,15 +695,15 @@ cmd_clear_passphrase (ASSUAN_CONTEXT ctx, char *line)
    command uses a syntax which helps clients to use the agent with
    minimum effort.  The agent either returns with an error or with a
    OK.  Note, that the length of DESCRIPTION is implicitly limited by
-   the maximum length of a command. DESCRIPTION should not conmtain
-   ant spaces, those must be encoded either percent escaped or simply
+   the maximum length of a command. DESCRIPTION should not contain
+   any spaces, those must be encoded either percent escaped or simply
    as '+'.
 */
 
 static int
 cmd_get_confirmation (ASSUAN_CONTEXT ctx, char *line)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc;
   char *desc = NULL;
   char *p;
@@ -579,9 +744,10 @@ cmd_get_confirmation (ASSUAN_CONTEXT ctx, char *line)
 static int
 cmd_learn (ASSUAN_CONTEXT ctx, char *line)
 {
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc;
 
-  rc = agent_handle_learn (has_option (line, "--send")? ctx : NULL);
+  rc = agent_handle_learn (ctrl, has_option (line, "--send")? ctx : NULL);
   if (rc)
     log_error ("command learn failed: %s\n", gpg_strerror (rc));
   return map_to_assuan_status (rc);
@@ -595,7 +761,7 @@ cmd_learn (ASSUAN_CONTEXT ctx, char *line)
 static int
 cmd_passwd (ASSUAN_CONTEXT ctx, char *line)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc;
   unsigned char grip[20];
   gcry_sexp_t s_skey = NULL;
@@ -606,9 +772,10 @@ cmd_passwd (ASSUAN_CONTEXT ctx, char *line)
     return rc; /* we can't jump to leave because this is already an
                   Assuan error code. */
 
-  s_skey = agent_key_from_file (ctrl, grip, &shadow_info, 1);
-  if (!s_skey && !shadow_info)
-    rc = gpg_error (GPG_ERR_NO_SECKEY);
+  rc = agent_key_from_file (ctrl, ctrl->server_local->keydesc,
+                            grip, &shadow_info, CACHE_MODE_IGNORE, &s_skey);
+  if (rc)
+    ;
   else if (!s_skey)
     {
       log_error ("changing a smartcard PIN is not yet supported\n");
@@ -617,6 +784,8 @@ cmd_passwd (ASSUAN_CONTEXT ctx, char *line)
   else
     rc = agent_protect_and_store (ctrl, s_skey);
 
+  xfree (ctrl->server_local->keydesc);
+  ctrl->server_local->keydesc = NULL;
   gcry_sexp_release (s_skey);
   xfree (shadow_info);
   if (rc)
@@ -624,6 +793,64 @@ cmd_passwd (ASSUAN_CONTEXT ctx, char *line)
   return map_to_assuan_status (rc);
 }
 
+/* PRESET_PASSPHRASE <hexstring_with_keygrip> <timeout> <passwd>
+  
+   Set the cached passphrase/PIN for the key identified by the keygrip
+   to passwd for the given time, where -1 means infinite and 0 means
+   the default (currently only a timeout of -1 is allowed, which means
+   to never expire it).  If passwd is not provided, ask for it via the
+   pinentry module.  */
+static int
+cmd_preset_passphrase (ASSUAN_CONTEXT ctx, char *line)
+{
+  int rc;
+  unsigned char grip[20];
+  char *grip_clear = NULL;
+  char *passphrase = NULL;
+  int ttl;
+
+  if (!opt.allow_preset_passphrase)
+    return gpg_error (GPG_ERR_NOT_SUPPORTED);
+
+  rc = parse_keygrip (ctx, line, grip);
+  if (rc)
+    return rc;
+
+  /* FIXME: parse_keygrip should return a tail pointer.  */
+  grip_clear = line;
+  while (*line && (*line != ' ' && *line != '\t'))
+    line++;
+  if (!*line)
+    return map_to_assuan_status (gpg_error (GPG_ERR_MISSING_VALUE));
+  *line = '\0';
+  line++;
+  while (*line && (*line == ' ' || *line == '\t'))
+    line++;
+  
+  /* Currently, only infinite timeouts are allowed.  */
+  ttl = -1;
+  if (line[0] != '-' || line[1] != '1')
+    return map_to_assuan_status (gpg_error (GPG_ERR_NOT_IMPLEMENTED));
+  line++;
+  line++;
+  while (!(*line != ' ' && *line != '\t'))
+    line++;
+
+  /* If there is a passphrase, use it.  Currently, a passphrase is
+     required.  */
+  if (*line)
+    passphrase = line;
+  else
+    return map_to_assuan_status (gpg_error (GPG_ERR_NOT_IMPLEMENTED));
+
+  rc = agent_put_cache (grip_clear, CACHE_MODE_ANY, passphrase, ttl);
+
+  if (rc)
+    log_error ("command preset_passwd failed: %s\n", gpg_strerror (rc));
+
+  return map_to_assuan_status (rc);
+}
+
 \f
 /* SCD <commands to pass to the scdaemon>
   
@@ -632,7 +859,7 @@ cmd_passwd (ASSUAN_CONTEXT ctx, char *line)
 static int
 cmd_scd (ASSUAN_CONTEXT ctx, char *line)
 {
-  CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
   int rc;
 
   rc = divert_generic_cmd (ctrl, line, ctx);
@@ -642,10 +869,43 @@ cmd_scd (ASSUAN_CONTEXT ctx, char *line)
 
 
 \f
+/* UPDATESTARTUPTTY 
+  
+  Set startup TTY and X DISPLAY variables to the values of this
+  session.  This command is useful to pull future pinentries to
+  another screen.  It is only required because there is no way in the
+  ssh-agent protocol to convey this information.  */
+static int
+cmd_updatestartuptty (assuan_context_t ctx, char *line)
+{
+  ctrl_t ctrl = assuan_get_pointer (ctx);
+
+  xfree (opt.startup_display); opt.startup_display = NULL;
+  xfree (opt.startup_ttyname); opt.startup_ttyname = NULL;
+  xfree (opt.startup_ttytype); opt.startup_ttytype = NULL;
+  xfree (opt.startup_lc_ctype); opt.startup_lc_ctype = NULL;
+  xfree (opt.startup_lc_messages); opt.startup_lc_messages = NULL;
+
+  if (ctrl->display)
+    opt.startup_display = xtrystrdup (ctrl->display);
+  if (ctrl->ttyname)
+    opt.startup_ttyname = xtrystrdup (ctrl->ttyname);
+  if (ctrl->ttytype)
+    opt.startup_ttytype = xtrystrdup (ctrl->ttytype);
+  if (ctrl->lc_ctype) 
+    opt.startup_lc_ctype = xtrystrdup (ctrl->lc_ctype);
+  if (ctrl->lc_messages)
+    opt.startup_lc_messages = xtrystrdup (ctrl->lc_messages);
+
+  return 0;
+}
+
+
+\f
 static int
 option_handler (ASSUAN_CONTEXT ctx, const char *key, const char *value)
 {
-   CTRL ctrl = assuan_get_pointer (ctx);
+  ctrl_t ctrl = assuan_get_pointer (ctx);
 
   if (!strcmp (key, "display"))
     {
@@ -714,11 +974,14 @@ register_commands (ASSUAN_CONTEXT ctx)
     { "HAVEKEY",        cmd_havekey },
     { "SIGKEY",         cmd_sigkey },
     { "SETKEY",         cmd_sigkey },
+    { "SETKEYDESC",     cmd_setkeydesc },
     { "SETHASH",        cmd_sethash },
     { "PKSIGN",         cmd_pksign },
     { "PKDECRYPT",      cmd_pkdecrypt },
     { "GENKEY",         cmd_genkey },
+    { "READKEY",        cmd_readkey },
     { "GET_PASSPHRASE", cmd_get_passphrase },
+    { "PRESET_PASSPHRASE", cmd_preset_passphrase },
     { "CLEAR_PASSPHRASE", cmd_clear_passphrase },
     { "GET_CONFIRMATION", cmd_get_confirmation },
     { "LISTTRUSTED",    cmd_listtrusted },
@@ -728,6 +991,7 @@ register_commands (ASSUAN_CONTEXT ctx)
     { "INPUT",          NULL }, 
     { "OUTPUT",         NULL }, 
     { "SCD",            cmd_scd },
+    { "UPDATESTARTUPTTY",  cmd_updatestartuptty },
     { NULL }
   };
   int i, rc;
@@ -771,6 +1035,7 @@ start_command_handler (int listen_fd, int fd)
   else 
     {
       rc = assuan_init_connected_socket_server (&ctx, fd);
+      ctrl.connection_fd = fd;
     }
   if (rc)
     {
@@ -791,6 +1056,7 @@ start_command_handler (int listen_fd, int fd)
   ctrl.server_local->assuan_ctx = ctx;
   ctrl.server_local->message_fd = -1;
   ctrl.server_local->use_cache_for_signing = 1;
+  ctrl.digest.raw_value = 0;
 
   if (DBG_ASSUAN)
     assuan_set_log_stream (ctx, log_get_stream ());
@@ -816,6 +1082,8 @@ start_command_handler (int listen_fd, int fd)
         }
     }
 
+  /* Reset the SCD if needed. */
+  agent_reset_scd (&ctrl);
 
   assuan_deinit_server (ctx);
   if (ctrl.display)
@@ -828,5 +1096,6 @@ start_command_handler (int listen_fd, int fd)
     free (ctrl.lc_ctype);
   if (ctrl.lc_messages)
     free (ctrl.lc_messages);
+  xfree (ctrl.server_local);
 }