Add option --no-ask for GET_PASSPHRASE.
[gnupg.git] / agent / command.c
index 9be8148..b2903f6 100644 (file)
@@ -1,6 +1,6 @@
 /* command.c - gpg-agent command handler
  * Copyright (C) 2001, 2002, 2003, 2004, 2005,
 /* command.c - gpg-agent command handler
  * Copyright (C) 2001, 2002, 2003, 2004, 2005,
- *               2006  Free Software Foundation, Inc.
+ *               2006, 2008  Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
  *
  * This file is part of GnuPG.
  *
@@ -60,6 +60,8 @@ struct server_local_s
   int stopme;    /* If set to true the agent will be terminated after
                     the end of this session.  */
 #endif
   int stopme;    /* If set to true the agent will be terminated after
                     the end of this session.  */
 #endif
+  int allow_pinentry_notify; /* Set if pinentry notifications should
+                                be done. */
 };
 
 
 };
 
 
@@ -78,7 +80,7 @@ static struct putval_item_s *putval_list;
 
 
 \f
 
 
 \f
-/* To help polling clients, we keep tarck of the number of certain
+/* To help polling clients, we keep track of the number of certain
    events.  This structure keeps those counters.  The counters are
    integers and there should be no problem if they are overflowing as
    callers need to check only whether a counter changed.  The actual
    events.  This structure keeps those counters.  The counters are
    integers and there should be no problem if they are overflowing as
    callers need to check only whether a counter changed.  The actual
@@ -269,7 +271,6 @@ parse_keygrip (assuan_context_t ctx, const char *string, unsigned char *buf)
 {
   int rc;
   size_t n;
 {
   int rc;
   size_t n;
-  const unsigned char *p;
 
   rc = parse_hexstring (ctx, string, &n);
   if (rc)
 
   rc = parse_hexstring (ctx, string, &n);
   if (rc)
@@ -278,8 +279,8 @@ parse_keygrip (assuan_context_t ctx, const char *string, unsigned char *buf)
   if (n != 20)
     return set_error (GPG_ERR_ASS_PARAMETER, "invalid length of keygrip");
 
   if (n != 20)
     return set_error (GPG_ERR_ASS_PARAMETER, "invalid length of keygrip");
 
-  for (p=(const unsigned char*)string, n=0; n < 20; p += 2, n++)
-    buf[n] = xtoi_2 (p);
+  if (hex2bin (string, buf, 20) < 0)
+    return set_error (GPG_ERR_BUG, "hex2bin");
 
   return 0;
 }
 
   return 0;
 }
@@ -318,6 +319,22 @@ agent_write_status (ctrl_t ctrl, const char *keyword, ...)
 }
 
 
 }
 
 
+/* Helper to notify the client about a launched Pinentry.  Because
+   that might disturb some older clients, this is only done if enabled
+   via an option.  Returns an gpg error code. */
+gpg_error_t
+agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid)
+{
+  char line[100];
+
+  if (!ctrl || !ctrl->server_local 
+      || !ctrl->server_local->allow_pinentry_notify)
+    return 0;
+  snprintf (line, DIM(line)-1, "PINENTRY_LAUNCHED %lu", pid);
+  return assuan_inquire (ctrl->server_local->assuan_ctx, line, NULL, NULL, 0);
+}
+
+
 \f
 /* GETEVENTCOUNTER
 
 \f
 /* GETEVENTCOUNTER
 
@@ -340,6 +357,8 @@ cmd_geteventcounter (assuan_context_t ctx, char *line)
   char key_counter[25];
   char card_counter[25];
 
   char key_counter[25];
   char card_counter[25];
 
+  (void)line;
+
   snprintf (any_counter, sizeof any_counter, "%u", eventcounter.any);
   snprintf (key_counter, sizeof key_counter, "%u", eventcounter.key);
   snprintf (card_counter, sizeof card_counter, "%u", eventcounter.card);
   snprintf (any_counter, sizeof any_counter, "%u", eventcounter.any);
   snprintf (key_counter, sizeof key_counter, "%u", eventcounter.key);
   snprintf (card_counter, sizeof card_counter, "%u", eventcounter.card);
@@ -353,7 +372,7 @@ cmd_geteventcounter (assuan_context_t ctx, char *line)
 
 
 /* This function should be called once for all key removals or
 
 
 /* This function should be called once for all key removals or
-   additions.  Thus function is assured not to do any context
+   additions.  This function is assured not to do any context
    switches. */
 void
 bump_key_eventcounter (void)
    switches. */
 void
 bump_key_eventcounter (void)
@@ -363,7 +382,7 @@ bump_key_eventcounter (void)
 }
 
 /* This function should be called for all card reader status
 }
 
 /* This function should be called for all card reader status
-   changes. Thus function is assured not to do any context
+   changes.  This function is assured not to do any context
    switches. */
 void
 bump_card_eventcounter (void)
    switches. */
 void
 bump_card_eventcounter (void)
@@ -419,7 +438,11 @@ cmd_istrusted (assuan_context_t ctx, char *line)
 static int
 cmd_listtrusted (assuan_context_t ctx, char *line)
 {
 static int
 cmd_listtrusted (assuan_context_t ctx, char *line)
 {
-  int rc = agent_listtrusted (ctx);
+  int rc;
+  
+  (void)line;
+
+  rc = agent_listtrusted (ctx);
   if (rc)
     log_error ("command listtrusted failed: %s\n", gpg_strerror (rc));
   return rc;
   if (rc)
     log_error ("command listtrusted failed: %s\n", gpg_strerror (rc));
   return rc;
@@ -580,7 +603,7 @@ cmd_sethash (assuan_context_t ctx, char *line)
       else if (has_option (line, "--hash=md5"))
         algo = GCRY_MD_MD5;
       else if (has_option (line, "--hash=tls-md5sha1"))
       else if (has_option (line, "--hash=md5"))
         algo = GCRY_MD_MD5;
       else if (has_option (line, "--hash=tls-md5sha1"))
-        algo = GCRY_MD_USER_TLS_MD5SHA1;
+        algo = MD_USER_TLS_MD5SHA1;
       else
         return set_error (GPG_ERR_ASS_PARAMETER, "invalid hash algorithm");
     }
       else
         return set_error (GPG_ERR_ASS_PARAMETER, "invalid hash algorithm");
     }
@@ -605,7 +628,7 @@ cmd_sethash (assuan_context_t ctx, char *line)
   if (rc)
     return rc;
   n /= 2;
   if (rc)
     return rc;
   n /= 2;
-  if (algo == GCRY_MD_USER_TLS_MD5SHA1 && n == 36)
+  if (algo == MD_USER_TLS_MD5SHA1 && n == 36)
     ;
   else if (n != 16 && n != 20 && n != 24 && n != 32)
     return set_error (GPG_ERR_ASS_PARAMETER, "unsupported length of hash");
     ;
   else if (n != 16 && n != 20 && n != 24 && n != 32)
     return set_error (GPG_ERR_ASS_PARAMETER, "unsupported length of hash");
@@ -635,6 +658,8 @@ cmd_pksign (assuan_context_t ctx, char *line)
   ctrl_t ctrl = assuan_get_pointer (ctx);
   membuf_t outbuf;
   
   ctrl_t ctrl = assuan_get_pointer (ctx);
   membuf_t outbuf;
   
+  (void)line;
+  
   if (opt.ignore_cache_for_signing)
     cache_mode = CACHE_MODE_IGNORE;
   else if (!ctrl->server_local->use_cache_for_signing)
   if (opt.ignore_cache_for_signing)
     cache_mode = CACHE_MODE_IGNORE;
   else if (!ctrl->server_local->use_cache_for_signing)
@@ -668,6 +693,8 @@ cmd_pkdecrypt (assuan_context_t ctx, char *line)
   size_t valuelen;
   membuf_t outbuf;
 
   size_t valuelen;
   membuf_t outbuf;
 
+  (void)line;
+
   /* First inquire the data to decrypt */
   rc = assuan_inquire (ctx, "CIPHERTEXT",
                        &value, &valuelen, MAXLEN_CIPHERTEXT);
   /* First inquire the data to decrypt */
   rc = assuan_inquire (ctx, "CIPHERTEXT",
                        &value, &valuelen, MAXLEN_CIPHERTEXT);
@@ -697,7 +724,7 @@ cmd_pkdecrypt (assuan_context_t ctx, char *line)
    part.  Here is an example transaction:
 
    C: GENKEY
    part.  Here is an example transaction:
 
    C: GENKEY
-   S: INQUIRE KEYPARM
+   S: INQUIRE KEYPARAM
    C: D (genkey (rsa (nbits  1024)))
    C: END
    S: D (public-key
    C: D (genkey (rsa (nbits  1024)))
    C: END
    S: D (public-key
@@ -714,6 +741,8 @@ cmd_genkey (assuan_context_t ctx, char *line)
   size_t valuelen;
   membuf_t outbuf;
 
   size_t valuelen;
   membuf_t outbuf;
 
+  (void)line;
+
   /* First inquire the parameters */
   rc = assuan_inquire (ctx, "KEYPARAM", &value, &valuelen, MAXLEN_KEYPARAM);
   if (rc)
   /* First inquire the parameters */
   rc = assuan_inquire (ctx, "KEYPARAM", &value, &valuelen, MAXLEN_KEYPARAM);
   if (rc)
@@ -807,7 +836,7 @@ send_back_passphrase (assuan_context_t ctx, int via_data, const char *pw)
 }
 
 
 }
 
 
-/* GET_PASSPHRASE [--data] [--check] <cache_id>
+/* GET_PASSPHRASE [--data] [--check] [--no-ask] <cache_id>
                   [<error_message> <prompt> <description>]
 
    This function is usually used to ask for a passphrase to be used
                   [<error_message> <prompt> <description>]
 
    This function is usually used to ask for a passphrase to be used
@@ -824,6 +853,10 @@ send_back_passphrase (assuan_context_t ctx, int via_data, const char *pw)
    If the option "--check" is used the passphrase constraints checks as
    implemented by gpg-agent are applied.  A check is not done if the
    passphrase has been found in the cache.
    If the option "--check" is used the passphrase constraints checks as
    implemented by gpg-agent are applied.  A check is not done if the
    passphrase has been found in the cache.
+
+   If the option "--no-ask" is used and the passphrase is not in the
+   cache the user will not be asked to enter a passphrase but the error
+   code GPG_ERR_NO_DATA is returned.  
 */
 
 static int
 */
 
 static int
@@ -836,10 +869,11 @@ cmd_get_passphrase (assuan_context_t ctx, char *line)
   char *cacheid = NULL, *desc = NULL, *prompt = NULL, *errtext = NULL;
   char *p;
   void *cache_marker;
   char *cacheid = NULL, *desc = NULL, *prompt = NULL, *errtext = NULL;
   char *p;
   void *cache_marker;
-  int opt_data, opt_check;
+  int opt_data, opt_check, opt_no_ask;
 
   opt_data = has_option (line, "--data");
   opt_check = has_option (line, "--check");
 
   opt_data = has_option (line, "--data");
   opt_check = has_option (line, "--check");
+  opt_no_ask = has_option (line, "--no-ask");
   line = skip_options (line);
 
   cacheid = line;
   line = skip_options (line);
 
   cacheid = line;
@@ -891,6 +925,8 @@ cmd_get_passphrase (assuan_context_t ctx, char *line)
       rc = send_back_passphrase (ctx, opt_data, pw);
       agent_unlock_cache_entry (&cache_marker);
     }
       rc = send_back_passphrase (ctx, opt_data, pw);
       agent_unlock_cache_entry (&cache_marker);
     }
+  else if (opt_no_ask)
+    rc = gpg_error (GPG_ERR_NO_DATA);
   else
     {
       /* Note, that we only need to replace the + characters and
   else
     {
       /* Note, that we only need to replace the + characters and
@@ -1064,7 +1100,7 @@ cmd_passwd (assuan_context_t ctx, char *line)
   return rc;
 }
 
   return rc;
 }
 
-/* PRESET_PASSPHRASE <hexstring_with_keygrip> <timeout> <hexstring>
+/* PRESET_PASSPHRASE <string_or_keygrip> <timeout> <hexstring>
   
    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
   
    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
@@ -1075,20 +1111,14 @@ static int
 cmd_preset_passphrase (assuan_context_t ctx, char *line)
 {
   int rc;
 cmd_preset_passphrase (assuan_context_t ctx, char *line)
 {
   int rc;
-  unsigned char grip[20];
   char *grip_clear = NULL;
   char *passphrase = NULL;
   int ttl;
   size_t len;
 
   if (!opt.allow_preset_passphrase)
   char *grip_clear = NULL;
   char *passphrase = NULL;
   int ttl;
   size_t len;
 
   if (!opt.allow_preset_passphrase)
-    return gpg_error (GPG_ERR_NOT_SUPPORTED);
-
-  rc = parse_keygrip (ctx, line, grip);
-  if (rc)
-    return rc;
+    return set_error (GPG_ERR_NOT_SUPPORTED, "no --allow-preset-passphrase");
 
 
-  /* FIXME: parse_keygrip should return a tail pointer.  */
   grip_clear = line;
   while (*line && (*line != ' ' && *line != '\t'))
     line++;
   grip_clear = line;
   while (*line && (*line != ' ' && *line != '\t'))
     line++;
@@ -1117,14 +1147,20 @@ cmd_preset_passphrase (assuan_context_t ctx, char *line)
   /* If there is a passphrase, use it.  Currently, a passphrase is
      required.  */
   if (*line)
   /* If there is a passphrase, use it.  Currently, a passphrase is
      required.  */
   if (*line)
-    passphrase = line;
+    {
+      /* Do in-place conversion.  */
+      passphrase = line;
+      if (!hex2str (passphrase, passphrase, strlen (passphrase)+1, NULL))
+        rc = set_error (GPG_ERR_ASS_PARAMETER, "invalid hexstring");
+    }
   else
   else
-    return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
+    rc = set_error (GPG_ERR_NOT_IMPLEMENTED, "passphrase is required");
 
 
-  rc = agent_put_cache (grip_clear, CACHE_MODE_ANY, passphrase, ttl);
+  if (!rc)
+    rc = agent_put_cache (grip_clear, CACHE_MODE_ANY, passphrase, ttl);
 
   if (rc)
 
   if (rc)
-    log_error ("command preset_passwd failed: %s\n", gpg_strerror (rc));
+    log_error ("command preset_passphrase failed: %s\n", gpg_strerror (rc));
 
   return rc;
 }
 
   return rc;
 }
@@ -1289,11 +1325,14 @@ cmd_updatestartuptty (assuan_context_t ctx, char *line)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
 
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
 
+  (void)line;
+
   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;
   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;
+  xfree (opt.startup_xauthority); opt.startup_xauthority = NULL;
 
   if (ctrl->display)
     opt.startup_display = xtrystrdup (ctrl->display);
 
   if (ctrl->display)
     opt.startup_display = xtrystrdup (ctrl->display);
@@ -1305,6 +1344,10 @@ cmd_updatestartuptty (assuan_context_t ctx, char *line)
     opt.startup_lc_ctype = xtrystrdup (ctrl->lc_ctype);
   if (ctrl->lc_messages)
     opt.startup_lc_messages = xtrystrdup (ctrl->lc_messages);
     opt.startup_lc_ctype = xtrystrdup (ctrl->lc_ctype);
   if (ctrl->lc_messages)
     opt.startup_lc_messages = xtrystrdup (ctrl->lc_messages);
+  if (ctrl->xauthority)
+    opt.startup_xauthority = xtrystrdup (ctrl->xauthority);
+  if (ctrl->pinentry_user_data)
+    opt.startup_pinentry_user_data = xtrystrdup (ctrl->pinentry_user_data);
 
   return 0;
 }
 
   return 0;
 }
@@ -1320,8 +1363,11 @@ static int
 cmd_killagent (assuan_context_t ctx, char *line)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
 cmd_killagent (assuan_context_t ctx, char *line)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
+
+  (void)line;
+
   ctrl->server_local->stopme = 1;
   ctrl->server_local->stopme = 1;
-  return 0;
+  return gpg_error (GPG_ERR_EOF);
 }
 
 /* RELOADAGENT
 }
 
 /* RELOADAGENT
@@ -1331,6 +1377,9 @@ cmd_killagent (assuan_context_t ctx, char *line)
 static int
 cmd_reloadagent (assuan_context_t ctx, char *line)
 {
 static int
 cmd_reloadagent (assuan_context_t ctx, char *line)
 {
+  (void)ctx;
+  (void)line;
+
   agent_sighup_action ();
   return 0;
 }
   agent_sighup_action ();
   return 0;
 }
@@ -1399,8 +1448,8 @@ option_handler (assuan_context_t ctx, const char *key, const char *value)
   if (!strcmp (key, "display"))
     {
       if (ctrl->display)
   if (!strcmp (key, "display"))
     {
       if (ctrl->display)
-        free (ctrl->display);
-      ctrl->display = strdup (value);
+        xfree (ctrl->display);
+      ctrl->display = xtrystrdup (value);
       if (!ctrl->display)
         return out_of_core ();
     }
       if (!ctrl->display)
         return out_of_core ();
     }
@@ -1409,8 +1458,8 @@ option_handler (assuan_context_t ctx, const char *key, const char *value)
       if (!opt.keep_tty)
         {
           if (ctrl->ttyname)
       if (!opt.keep_tty)
         {
           if (ctrl->ttyname)
-            free (ctrl->ttyname);
-          ctrl->ttyname = strdup (value);
+            xfree (ctrl->ttyname);
+          ctrl->ttyname = xtrystrdup (value);
           if (!ctrl->ttyname)
             return out_of_core ();
         }
           if (!ctrl->ttyname)
             return out_of_core ();
         }
@@ -1420,8 +1469,8 @@ option_handler (assuan_context_t ctx, const char *key, const char *value)
       if (!opt.keep_tty)
         {
           if (ctrl->ttytype)
       if (!opt.keep_tty)
         {
           if (ctrl->ttytype)
-            free (ctrl->ttytype);
-          ctrl->ttytype = strdup (value);
+            xfree (ctrl->ttytype);
+          ctrl->ttytype = xtrystrdup (value);
           if (!ctrl->ttytype)
             return out_of_core ();
         }
           if (!ctrl->ttytype)
             return out_of_core ();
         }
@@ -1429,21 +1478,39 @@ option_handler (assuan_context_t ctx, const char *key, const char *value)
   else if (!strcmp (key, "lc-ctype"))
     {
       if (ctrl->lc_ctype)
   else if (!strcmp (key, "lc-ctype"))
     {
       if (ctrl->lc_ctype)
-        free (ctrl->lc_ctype);
-      ctrl->lc_ctype = strdup (value);
+        xfree (ctrl->lc_ctype);
+      ctrl->lc_ctype = xtrystrdup (value);
       if (!ctrl->lc_ctype)
         return out_of_core ();
     }
   else if (!strcmp (key, "lc-messages"))
     {
       if (ctrl->lc_messages)
       if (!ctrl->lc_ctype)
         return out_of_core ();
     }
   else if (!strcmp (key, "lc-messages"))
     {
       if (ctrl->lc_messages)
-        free (ctrl->lc_messages);
-      ctrl->lc_messages = strdup (value);
+        xfree (ctrl->lc_messages);
+      ctrl->lc_messages = xtrystrdup (value);
       if (!ctrl->lc_messages)
         return out_of_core ();
     }
       if (!ctrl->lc_messages)
         return out_of_core ();
     }
+  else if (!strcmp (key, "xauthority"))
+    {
+      if (ctrl->xauthority)
+        xfree (ctrl->xauthority);
+      ctrl->xauthority = xtrystrdup (value);
+      if (!ctrl->xauthority)
+        return out_of_core ();
+    }
+  else if (!strcmp (key, "pinentry-user-data"))
+    {
+      if (ctrl->pinentry_user_data)
+        xfree (ctrl->pinentry_user_data);
+      ctrl->pinentry_user_data = xtrystrdup (value);
+      if (!ctrl->pinentry_user_data)
+        return out_of_core ();
+    }
   else if (!strcmp (key, "use-cache-for-signing"))
     ctrl->server_local->use_cache_for_signing = *value? atoi (value) : 0;
   else if (!strcmp (key, "use-cache-for-signing"))
     ctrl->server_local->use_cache_for_signing = *value? atoi (value) : 0;
+  else if (!strcmp (key, "allow-pinentry-notify"))
+    ctrl->server_local->allow_pinentry_notify = 1;
   else
     return gpg_error (GPG_ERR_UNKNOWN_OPTION);
 
   else
     return gpg_error (GPG_ERR_UNKNOWN_OPTION);
 
@@ -1459,6 +1526,8 @@ static void
 post_cmd_notify (assuan_context_t ctx, int err)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
 post_cmd_notify (assuan_context_t ctx, int err)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
+  
+  (void)err;
 
   /* Switch off any I/O monitor controlled logging pausing. */
   ctrl->server_local->pause_io_logging = 0;
 
   /* Switch off any I/O monitor controlled logging pausing. */
   ctrl->server_local->pause_io_logging = 0;
@@ -1474,7 +1543,7 @@ io_monitor (assuan_context_t ctx, int direction,
             const char *line, size_t linelen)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
             const char *line, size_t linelen)
 {
   ctrl_t ctrl = assuan_get_pointer (ctx);
-
+  
   /* Note that we only check for the uppercase name.  This allows to
      see the logging for debugging if using a non-upercase command
      name. */
   /* Note that we only check for the uppercase name.  This allows to
      see the logging for debugging if using a non-upercase command
      name. */
@@ -1604,7 +1673,7 @@ start_command_handler (ctrl_t ctrl, gnupg_fd_t listen_fd, gnupg_fd_t fd)
   for (;;)
     {
       rc = assuan_accept (ctx);
   for (;;)
     {
       rc = assuan_accept (ctx);
-      if (rc == -1)
+      if (gpg_err_code (rc) == GPG_ERR_EOF || rc == -1)
         {
           break;
         }
         {
           break;
         }