g10: Unattended key generation "Key-Grip" and "Subkey-Grip".
[gnupg.git] / g10 / passphrase.c
index c1cdf12..a498f62 100644 (file)
@@ -1,12 +1,12 @@
 /* passphrase.c -  Get a passphrase
  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
- *               2005 Free Software Foundation, Inc.
+ *               2005, 2006, 2007, 2009, 2011 Free Software Foundation, Inc.
  *
  * 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 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * GnuPG is distributed in the hope that it will be useful,
@@ -15,9 +15,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
- * USA.
+ * along with this program; if not, see <https://www.gnu.org/licenses/>.
  */
 
 #include <config.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
-#include <assert.h>
-#if !defined(HAVE_DOSISH_SYSTEM) && !defined(__riscos__)
-#include <sys/socket.h>
-#include <sys/un.h>
-#endif
-#if defined (_WIN32)
-#include <windows.h>
-#endif
 #include <errno.h>
 #ifdef HAVE_LOCALE_H
 #include <locale.h>
 #endif
 
 #include "gpg.h"
-#include "util.h"
+#include "../common/util.h"
 #include "options.h"
-#include "ttyio.h"
-#include "cipher.h"
+#include "../common/ttyio.h"
 #include "keydb.h"
 #include "main.h"
-#include "i18n.h"
-#include "status.h"
-#ifdef ENABLE_AGENT_SUPPORT
-#include "assuan.h"
-#endif /*ENABLE_AGENT_SUPPORT*/
+#include "../common/i18n.h"
+#include "../common/status.h"
+#include "call-agent.h"
+#include "../common/shareddefs.h"
 
 static char *fd_passwd = NULL;
 static char *next_pw = NULL;
 static char *last_pw = NULL;
 
-static void hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create );
+
+
+/* Pack an s2k iteration count into the form specified in 2440.  If
+   we're in between valid values, round up.  With value 0 return the
+   old default.  */
+unsigned char
+encode_s2k_iterations (int iterations)
+{
+  gpg_error_t err;
+  unsigned char c=0;
+  unsigned char result;
+  unsigned int count;
+
+  if (!iterations)
+    {
+      unsigned long mycnt;
+
+      /* Ask the gpg-agent for a useful iteration count.  */
+      err = agent_get_s2k_count (&mycnt);
+      if (err || mycnt < 65536)
+        {
+          /* Don't print an error if an older agent is used.  */
+          if (err && gpg_err_code (err) != GPG_ERR_ASS_PARAMETER)
+            log_error (_("problem with the agent: %s\n"), gpg_strerror (err));
+          /* Default to 65536 which we used up to 2.0.13.  */
+          return 96;
+        }
+      else if (mycnt >= 65011712)
+        return 255; /* Largest possible value.  */
+      else
+        return encode_s2k_iterations ((int)mycnt);
+    }
+
+  if (iterations <= 1024)
+    return 0;  /* Command line arg compatibility.  */
+
+  if (iterations >= 65011712)
+    return 255;
+
+  /* Need count to be in the range 16-31 */
+  for (count=iterations>>6; count>=32; count>>=1)
+    c++;
+
+  result = (c<<4)|(count-16);
+
+  if (S2K_DECODE_COUNT(result) < iterations)
+    result++;
+
+  return result;
+}
+
 
 int
 have_static_passphrase()
 {
-    if ( opt.use_agent )
-        return 0;
-    return !!fd_passwd;
+  return (!!fd_passwd
+          && (opt.batch || opt.pinentry_mode == PINENTRY_MODE_LOOPBACK));
 }
 
+/* Return a static passphrase.  The returned value is only valid as
+   long as no other passphrase related function is called.  NULL may
+   be returned if no passphrase has been set; better use
+   have_static_passphrase first.  */
+const char *
+get_static_passphrase (void)
+{
+  return fd_passwd;
+}
+
+
 /****************
  * Set the passphrase to be used for the next query and only for the next
  * one.
@@ -76,11 +124,12 @@ have_static_passphrase()
 void
 set_next_passphrase( const char *s )
 {
-    xfree(next_pw);
-    next_pw = NULL;
-    if( s ) {
-       next_pw = xmalloc_secure( strlen(s)+1 );
-       strcpy(next_pw, s );
+  xfree(next_pw);
+  next_pw = NULL;
+  if ( s )
+    {
+      next_pw = xmalloc_secure( strlen(s)+1 );
+      strcpy (next_pw, s );
     }
 }
 
@@ -92,20 +141,9 @@ set_next_passphrase( const char *s )
 char *
 get_last_passphrase()
 {
-    char *p = last_pw;
-    last_pw = NULL;
-    return p;
-}
-
-/* As if we had used the passphrase - make it the last_pw. */
-void
-next_to_last_passphrase(void)
-{
-  if(next_pw)
-    {
-      last_pw=next_pw;
-      next_pw=NULL;
-    }
+  char *p = last_pw;
+  last_pw = NULL;
+  return p;
 }
 
 /* Here's an interesting question: since this passphrase was passed in
@@ -116,9 +154,9 @@ next_to_last_passphrase(void)
 void
 set_passphrase_from_string(const char *pass)
 {
-  xfree( fd_passwd );
+  xfree (fd_passwd);
   fd_passwd = xmalloc_secure(strlen(pass)+1);
-  strcpy(fd_passwd,pass);
+  strcpy (fd_passwd, pass);
 }
 
 
@@ -127,8 +165,11 @@ read_passphrase_from_fd( int fd )
 {
   int i, len;
   char *pw;
-  
-  if ( opt.use_agent ) 
+
+  if (! gnupg_fd_valid (fd))
+    log_fatal ("passphrase-fd is invalid: %s\n", strerror (errno));
+
+  if ( !opt.batch && opt.pinentry_mode != PINENTRY_MODE_LOOPBACK)
     { /* Not used but we have to do a dummy read, so that it won't end
          up at the begin of the message if the quite usual trick to
          prepend the passphtrase to the message is used. */
@@ -137,14 +178,12 @@ read_passphrase_from_fd( int fd )
       while (!(read (fd, buf, 1) != 1 || *buf == '\n' ))
         ;
       *buf = 0;
-      return; 
+      return;
     }
 
-  if (!opt.batch )
-       tty_printf("Reading passphrase from file descriptor %d ...", fd );
-  for (pw = NULL, i = len = 100; ; i++ ) 
+  for (pw = NULL, i = len = 100; ; i++ )
     {
-      if (i >= len-1 ) 
+      if (i >= len-1 )
         {
           char *pw2 = pw;
           len += 100;
@@ -161,913 +200,352 @@ read_passphrase_from_fd( int fd )
         break;
     }
   pw[i] = 0;
-  if (!opt.batch)
+  if (!opt.batch && opt.pinentry_mode != PINENTRY_MODE_LOOPBACK)
     tty_printf("\b\b\b   \n" );
 
-  xfree( fd_passwd );
+  xfree ( fd_passwd );
   fd_passwd = pw;
 }
 
 
-
-#ifdef ENABLE_AGENT_SUPPORT
-/* Send one option to the gpg-agent.  */
-static int
-agent_send_option (assuan_context_t ctx, const char *name, const char *value)
-{
-  char *line;
-  int rc; 
-  
-  if (!value || !*value)
-    return 0; /* Avoid sending empty option values. */
-
-  line = xmalloc (7 + strlen (name) + 1 + strlen (value) + 1);
-  strcpy (stpcpy (stpcpy (stpcpy (line, "OPTION "), name), "="), value);
-  rc = assuan_transact (ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
-  xfree (line);
-  return rc? -1 : 0;
-}
-
-/* Send all required options to the gpg-agent.  */
-static int 
-agent_send_all_options (assuan_context_t ctx)
+/*
+ * Ask the GPG Agent for the passphrase.
+ * If NOCACHE is set the symmetric passpharse caching will not be used.
+ *
+ * Note that TRYAGAIN_TEXT must not be translated.  If CANCELED is not
+ * NULL, the function does set it to 1 if the user canceled the
+ * operation.  If CACHEID is not NULL, it will be used as the cacheID
+ * for the gpg-agent; if is NULL and a key fingerprint can be
+ * computed, this will be used as the cacheid.
+ */
+static char *
+passphrase_get (int nocache, const char *cacheid, int repeat,
+                const char *tryagain_text, int *canceled)
 {
-  char *dft_display = NULL;
-  const char *dft_ttyname = NULL;
-  char *dft_ttytype = NULL;
-  char *old_lc = NULL;
-  char *dft_lc = NULL;
-  int rc = 0;
-
-  dft_display = getenv ("DISPLAY");
-  if (opt.display || dft_display)
-    {
-      if (agent_send_option (ctx, "display",
-                             opt.display ? opt.display : dft_display))
-        return -1;
-    }
+  int rc;
+  char *pw = NULL;
+  char *orig_codeset;
+  const char *my_cacheid;
 
-  if (!opt.ttyname)
-    {
-      const char *tmp;
+  if (canceled)
+    *canceled = 0;
 
-      dft_ttyname = getenv ("GPG_TTY");
-      if ((!dft_ttyname || !*dft_ttyname) && (tmp=ttyname (0)))
-        dft_ttyname = tmp;
-      if ((!dft_ttyname || !*dft_ttyname) && (tmp=tty_get_ttyname ()))
-        dft_ttyname = tmp;
-    }
-  if (opt.ttyname || dft_ttyname)
-    {
-      if (agent_send_option (ctx, "ttyname",
-                             opt.ttyname ? opt.ttyname : dft_ttyname))
-        return -1;
-    }
+  orig_codeset = i18n_switchto_utf8 ();
 
-  dft_ttytype = getenv ("TERM");
-  if (opt.ttytype || (dft_ttyname && dft_ttytype))
-    {
-      if (agent_send_option (ctx, "ttytype",
-                             opt.ttyname ? opt.ttytype : dft_ttytype))
-        return -1;
-    }
+  if (!nocache && cacheid)
+    my_cacheid = cacheid;
+  else
+    my_cacheid = NULL;
 
-#if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
-  old_lc = setlocale (LC_CTYPE, NULL);
-  if (old_lc)
-    old_lc = xstrdup (old_lc);
-  dft_lc = setlocale (LC_CTYPE, "");
-#endif
-  if (opt.lc_ctype || (dft_ttyname && dft_lc))
-    {
-      rc = agent_send_option (ctx, "lc-ctype",
-                              opt.lc_ctype ? opt.lc_ctype : dft_lc);
-    }
-#if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
-  if (old_lc)
-    {
-      setlocale (LC_CTYPE, old_lc);
-      xfree (old_lc);
-    }
-#endif
-  if (rc)
-    return rc;
+  if (tryagain_text)
+    tryagain_text = _(tryagain_text);
 
-#if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
-  old_lc = setlocale (LC_MESSAGES, NULL);
-  if (old_lc)
-    old_lc = xstrdup (old_lc);
-  dft_lc = setlocale (LC_MESSAGES, "");
-#endif
-  if (opt.lc_messages || (dft_ttyname && dft_lc))
-    {
-      rc = agent_send_option (ctx, "lc-messages",
-                              opt.lc_messages ? opt.lc_messages : dft_lc);
-    }
-#if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
-  if (old_lc)
-    {
-      setlocale (LC_MESSAGES, old_lc);
-      xfree (old_lc);
-    }
-#endif
-  return rc;
-}
-#endif /*ENABLE_AGENT_SUPPORT*/
+  rc = agent_get_passphrase (my_cacheid, tryagain_text, NULL,
+                             _("Enter passphrase\n"),
+                             repeat, nocache, &pw);
 
+  i18n_switchback (orig_codeset);
 
-/*
- * Open a connection to the agent and initializes the connection.
- * Returns: -1 on error; on success an Assuan context for that
- * connection is returned.  With TRY set to true, no error messages
- * are printed and the use of the agent won't get disabled on failure.
- * If ORIG_CODESET is not NULL, the function will swithc the codeset
- * back to that one before printing error messages.
- */
-#ifdef ENABLE_AGENT_SUPPORT
-assuan_context_t
-agent_open (int try, const char *orig_codeset)
-{
-  int rc;
-  assuan_context_t ctx;
-  char *infostr, *p;
-  int prot;
-  int pid;
 
-  if (opt.gpg_agent_info)
-    infostr = xstrdup (opt.gpg_agent_info);
-  else
+  if (!rc)
+    ;
+  else if (gpg_err_code (rc) == GPG_ERR_CANCELED
+            || gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
     {
-      infostr = getenv ( "GPG_AGENT_INFO" );
-      if (!infostr || !*infostr) 
-        {
-          if (!try)
-            {
-#ifdef ENABLE_NLS
-              if (orig_codeset)
-                bind_textdomain_codeset (PACKAGE, orig_codeset);
-#endif /*ENABLE_NLS*/
-              log_info (_("gpg-agent is not available in this session\n"));
-              opt.use_agent = 0;
-            }
-          return NULL;
-        }
-      infostr = xstrdup ( infostr );
+      log_info (_("cancelled by user\n") );
+      if (canceled)
+        *canceled = 1;
     }
-  
-  if ( !(p = strchr (infostr, PATHSEP_C)) || p == infostr)
-    {
-      if (!try)
-        {
-#ifdef ENABLE_NLS
-          if (orig_codeset)
-            bind_textdomain_codeset (PACKAGE, orig_codeset);
-#endif /*ENABLE_NLS*/
-          log_error ( _("malformed GPG_AGENT_INFO environment variable\n"));
-          opt.use_agent = 0;
-        }
-      xfree (infostr);
-      return NULL;
-    }
-  *p++ = 0;
-  pid = atoi (p);
-  while (*p && *p != PATHSEP_C)
-    p++;
-  prot = *p? atoi (p+1) : 0;
-  if (prot != 1)
-    {
-      if (!try)
-        {
-#ifdef ENABLE_NLS
-          if (orig_codeset)
-            bind_textdomain_codeset (PACKAGE, orig_codeset);
-#endif /*ENABLE_NLS*/
-          log_error (_("gpg-agent protocol version %d is not supported\n"),
-                     prot);
-          opt.use_agent = 0;
-        }
-      xfree (infostr);
-      return NULL;
-    }
-     
-  rc = assuan_socket_connect (&ctx, infostr, pid);
-  if (rc)
+  else
     {
-      if (!try)
-        {
-#ifdef ENABLE_NLS
-          if (orig_codeset)
-            bind_textdomain_codeset (PACKAGE, orig_codeset);
-#endif /*ENABLE_NLS*/
-          log_error ( _("can't connect to `%s': %s\n"), 
-                      infostr, assuan_strerror (rc));
-          opt.use_agent = 0;
-        }
-      xfree (infostr );
-      return NULL;
+      log_error (_("problem with the agent: %s\n"), gpg_strerror (rc));
+      /* Due to limitations in the API of the upper layers they
+         consider an error as no passphrase entered.  This works in
+         most cases but not during key creation where this should
+         definitely not happen and let it continue without requiring a
+         passphrase.  Given that now all the upper layers handle a
+         cancel correctly, we simply set the cancel flag now for all
+         errors from the agent.  */
+      if (canceled)
+        *canceled = 1;
+
+      write_status_errcode ("get_passphrase", rc);
     }
-  xfree (infostr);
 
-  if (agent_send_all_options (ctx))
+  if (rc)
     {
-      if (!try)
-        {
-#ifdef ENABLE_NLS
-          if (orig_codeset)
-            bind_textdomain_codeset (PACKAGE, orig_codeset);
-#endif /*ENABLE_NLS*/
-          log_error (_("problem with the agent - disabling agent use\n"));
-          opt.use_agent = 0;
-        }
-      assuan_disconnect (ctx);
-      return NULL;
+      xfree (pw);
+      pw = NULL;
     }
-
-  return ctx;
+  return pw;
 }
-#endif/*ENABLE_AGENT_SUPPORT*/
 
 
-#ifdef ENABLE_AGENT_SUPPORT
+/*
+ * Clear the cached passphrase with CACHEID.
+ */
 void
-agent_close (assuan_context_t ctx)
+passphrase_clear_cache (const char *cacheid)
 {
-  assuan_disconnect (ctx);
-}
-#endif /*ENABLE_AGENT_SUPPORT*/
-
-
-/* Copy the text ATEXT into the buffer P and do plus '+' and percent
-   escaping.  Note that the provided buffer needs to be 3 times the
-   size of ATEXT plus 1.  Returns a pointer to the leading Nul in P. */
-#ifdef ENABLE_AGENT_SUPPORT
-static char *
-percent_plus_escape (char *p, const char *atext)
-{
-  const unsigned char *s;
-
-  for (s=atext; *s; s++)
-    {
-      if (*s < ' ' || *s == '+')
-        {
-          sprintf (p, "%%%02X", *s);
-          p += 3;
-        }
-      else if (*s == ' ')
-        *p++ = '+';
-      else
-        *p++ = *s;
-    }
-  *p = 0;
-  return p;
-}
-#endif /*ENABLE_AGENT_SUPPORT*/
-
-
-#ifdef ENABLE_AGENT_SUPPORT
+  int rc;
 
-/* Object for the agent_okay_cb function.  */
-struct agent_okay_cb_s {
-  char *pw;
-};
-
-/* A callback used to get the passphrase from the okay line.  See
-   agent-get_passphrase for details.  LINE is the rest of the OK
-   status line without leading white spaces. */
-static assuan_error_t
-agent_okay_cb (void *opaque, const char *line)
-{ 
-  struct agent_okay_cb_s *parm = opaque;
-  int i;
-
-  /* Note: If the malloc below fails we won't be able to wipe the
-     memory at LINE given the current implementation of the Assuan
-     code. There is no easy ay around this w/o adding a lot of more
-     memory function code to allow wiping arbitrary stuff on memory
-     failure. */
-  parm->pw = xmalloc_secure (strlen (line)/2+2);
-  
-  for (i=0; hexdigitp (line) && hexdigitp (line+1); line += 2)
-    parm->pw[i++] = xtoi_2 (line);
-  parm->pw[i] = 0; 
-  return 0;
+  rc = agent_clear_passphrase (cacheid);
+  if (rc)
+    log_error (_("problem with the agent: %s\n"), gpg_strerror (rc));
 }
-#endif /*ENABLE_AGENT_SUPPORT*/
-
 
 
-/*
- * Ask the GPG Agent for the passphrase.
- * Mode 0:  Allow cached passphrase
- *      1:  No cached passphrase FIXME: Not really implemented
- *      2:  Ditto, but change the text to "repeat entry"
+/* Return a new DEK object using the string-to-key specifier S2K.
+ * Returns NULL if the user canceled the passphrase entry and if
+ * CANCELED is not NULL, sets it to true.
  *
- * Note that TRYAGAIN_TEXT must not be translated.  If canceled is not
- * NULL, the function does set it to 1 if the user canceled the
- * operation.  If CACHEID is not NULL, it will be used as the cacheID
- * for the gpg-agent; if is NULL and a key fingerprint can be
- * computed, this will be used as the cacheid.
- */
-static char *
-agent_get_passphrase ( u32 *keyid, int mode, const char *cacheid,
-                       const char *tryagain_text,
-                       const char *custom_description,
-                       const char *custom_prompt, int *canceled)
+ * If CREATE is true a new passphrase sll be created.  If NOCACHE is
+ * true the symmetric key caching will not be used.  */
+DEK *
+passphrase_to_dek (int cipher_algo, STRING2KEY *s2k,
+                   int create, int nocache,
+                   const char *tryagain_text, int *canceled)
 {
-#ifdef ENABLE_AGENT_SUPPORT
-  char *atext = NULL;
-  assuan_context_t ctx = NULL;
   char *pw = NULL;
-  PKT_public_key *pk = xmalloc_clear( sizeof *pk );
-  byte fpr[MAX_FINGERPRINT_LEN];
-  int have_fpr = 0;
-  char *orig_codeset = NULL;
-
-  if (canceled)
-    *canceled = 0;
+  DEK *dek;
+  STRING2KEY help_s2k;
+  int dummy_canceled;
+  char s2k_cacheidbuf[1+16+1];
+  char *s2k_cacheid = NULL;
 
-#if MAX_FINGERPRINT_LEN < 20
-#error agent needs a 20 byte fingerprint
-#endif
+  if (!canceled)
+    canceled = &dummy_canceled;
+  *canceled = 0;
 
-  memset (fpr, 0, MAX_FINGERPRINT_LEN );
-  if( keyid && get_pubkey( pk, keyid ) )
+  if ( !s2k )
     {
-      if (pk)
-        free_public_key( pk );      
-      pk = NULL; /* oops: no key for some reason */
+      log_assert (create && !nocache);
+      /* This is used for the old rfc1991 mode
+       * Note: This must match the code in encode.c with opt.rfc1991 set */
+      memset (&help_s2k, 0, sizeof (help_s2k));
+      s2k = &help_s2k;
+      s2k->hash_algo = S2K_DIGEST_ALGO;
     }
-  
-#ifdef ENABLE_NLS
-  /* The Assuan agent protocol requires us to transmit utf-8 strings */
-  orig_codeset = bind_textdomain_codeset (PACKAGE, NULL);
-#ifdef HAVE_LANGINFO_CODESET
-  if (!orig_codeset)
-    orig_codeset = nl_langinfo (CODESET);
-#endif
-  if (orig_codeset)
-    { /* We only switch when we are able to restore the codeset later. */
-      orig_codeset = xstrdup (orig_codeset);
-      if (!bind_textdomain_codeset (PACKAGE, "utf-8"))
-        orig_codeset = NULL; 
-    }
-#endif
 
-  if ( !(ctx = agent_open (0, orig_codeset)) ) 
-    goto failure;
-
-  if (custom_description)
-    atext = native_to_utf8 (custom_description);
-  else if ( !mode && pk && keyid )
-    { 
-      char *uid;
-      size_t uidlen;
-      const char *algo_name = pubkey_algo_to_string ( pk->pubkey_algo );
-      const char *timestr;
-      char *maink;
-      
-      if ( !algo_name )
-        algo_name = "?";
-
-#define KEYIDSTRING _(" (main key ID %s)")
-
-      maink = xmalloc ( strlen (KEYIDSTRING) + keystrlen() + 20 );
-      if( keyid[2] && keyid[3] && keyid[0] != keyid[2] 
-          && keyid[1] != keyid[3] )
-        sprintf( maink, KEYIDSTRING, keystr(&keyid[2]) );
-      else
-        *maink = 0;
-      
-      uid = get_user_id ( keyid, &uidlen ); 
-      timestr = strtimestamp (pk->timestamp);
-
-#undef KEYIDSTRING
-
-#define PROMPTSTRING _("You need a passphrase to unlock the secret" \
-                      " key for user:\n" \
-                      "\"%.*s\"\n" \
-                      "%u-bit %s key, ID %s, created %s%s\n" )
-
-      atext = xmalloc ( 100 + strlen (PROMPTSTRING)  
-                        + uidlen + 15 + strlen(algo_name) + keystrlen()
-                        + strlen (timestr) + strlen (maink) );
-      sprintf (atext, PROMPTSTRING,
-               (int)uidlen, uid,
-               nbits_from_pk (pk), algo_name, keystr(&keyid[0]), timestr,
-               maink  );
-      xfree (uid);
-      xfree (maink);
-
-#undef PROMPTSTRING
-
-      { 
-        size_t dummy;
-        fingerprint_from_pk( pk, fpr, &dummy );
-        have_fpr = 1;
-      }
-      
-    }
-  else if (mode == 2 ) 
-    atext = xstrdup ( _("Repeat passphrase\n") );
-  else
-    atext = xstrdup ( _("Enter passphrase\n") );
-                
-  { 
-      char *line, *p;
-      int i, rc; 
-      struct agent_okay_cb_s okay_cb_parm;
-
-      if (!tryagain_text)
-        tryagain_text = "X";
-      else
-        tryagain_text = _(tryagain_text);
-
-      /* We allocate 23 times the needed space for thye texts so that
-         there is enough space for escaping. */
-      line = xmalloc (15 + 46 
-                      + 3*strlen (atext)
-                      + 3*strlen (custom_prompt? custom_prompt:"")
-                      + (cacheid? (3*strlen (cacheid)): 0)
-                      + 3*strlen (tryagain_text)
-                      + 1);
-      strcpy (line, "GET_PASSPHRASE ");
-      p = line+15;
-      if (!mode && cacheid)
-        {
-          p = percent_plus_escape (p, cacheid);
-        }
-      else if (!mode && have_fpr)
-        {
-          for (i=0; i < 20; i++, p +=2 )
-            sprintf (p, "%02X", fpr[i]);
-        }
-      else
-        *p++ = 'X'; /* No caching. */
-      *p++ = ' ';
-
-      p = percent_plus_escape (p, tryagain_text);
-      *p++ = ' ';
-
-      /* The prompt.  */
-      if (custom_prompt)
+  /* Create a new salt or what else to be filled into the s2k for a
+     new key.  */
+  if (create && (s2k->mode == 1 || s2k->mode == 3))
+    {
+      gcry_randomize (s2k->salt, 8, GCRY_STRONG_RANDOM);
+      if ( s2k->mode == 3 )
         {
-          char *tmp = native_to_utf8 (custom_prompt);
-          p = percent_plus_escape (p, tmp);
-          xfree (tmp);
+          /* We delay the encoding until it is really needed.  This is
+             if we are going to dynamically calibrate it, we need to
+             call out to gpg-agent and that should not be done during
+             option processing in main().  */
+          if (!opt.s2k_count)
+            opt.s2k_count = encode_s2k_iterations (0);
+          s2k->count = opt.s2k_count;
         }
-      else
-        *p++ = 'X'; /* Use the standard prompt. */
-      *p++ = ' ';
+    }
 
-      /* Copy description. */
-      percent_plus_escape (p, atext);
+  /* If we do not have a passphrase available in NEXT_PW and status
+     information are request, we print them now. */
+  if ( !next_pw && is_status_enabled() )
+    {
+      char buf[50];
 
-      /* Call gpg-agent.  */
-      memset (&okay_cb_parm, 0, sizeof okay_cb_parm);
-      rc = assuan_transact2 (ctx, line, NULL, NULL, NULL, NULL, NULL, NULL,
-                             agent_okay_cb, &okay_cb_parm);
+      snprintf (buf, sizeof buf, "%d %d %d",
+                cipher_algo, s2k->mode, s2k->hash_algo );
+      write_status_text ( STATUS_NEED_PASSPHRASE_SYM, buf );
+    }
 
-      xfree (line);
-      xfree (atext); atext = NULL;
-      if (!rc)
-        {
-          assert (okay_cb_parm.pw);
-          pw = okay_cb_parm.pw;
-          agent_close (ctx);
-          if (pk)
-            free_public_key( pk );
-#ifdef ENABLE_NLS
-          if (orig_codeset)
-            bind_textdomain_codeset (PACKAGE, orig_codeset);
-#endif
-          xfree (orig_codeset);
-          return pw;
-        }
-      else if (rc && (rc & 0xffff) == 99)
-       {
-         /* 99 is GPG_ERR_CANCELED. */
-          log_info (_("cancelled by user\n") );
-          if (canceled)
-            *canceled = 1;
-        }
-      else 
-        {
-          log_error (_("problem with the agent - disabling agent use\n"));
-          opt.use_agent = 0;
-        }
-  }
-      
-        
- failure:
-#ifdef ENABLE_NLS
-  if (orig_codeset)
+  if ( next_pw )
     {
-      bind_textdomain_codeset (PACKAGE, orig_codeset);
-      xfree (orig_codeset);
+      /* Simply return the passphrase we already have in NEXT_PW. */
+      pw = next_pw;
+      next_pw = NULL;
     }
-#endif
-  xfree (atext);
-  agent_close (ctx);
-  xfree (pw );
-  if (pk)
-    free_public_key( pk );
-
-#endif /*ENABLE_AGENT_SUPPORT*/
-
-  return NULL;
-}
-
-
-/*
- * Clear the cached passphrase.  If CACHEID is not NULL, it will be
- * used instead of a cache ID derived from KEYID.
- */
-void
-passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo )
-{
-#ifdef ENABLE_AGENT_SUPPORT
-  assuan_context_t ctx = NULL;
-  PKT_public_key *pk;
-  byte fpr[MAX_FINGERPRINT_LEN];
-  
-#if MAX_FINGERPRINT_LEN < 20
-#error agent needs a 20 byte fingerprint
-#endif
-    
-  if (!opt.use_agent)
-    return;
-  
-  if (!cacheid)
+  else if ( have_static_passphrase () )
     {
-      pk = xcalloc (1, sizeof *pk);
-      memset (fpr, 0, MAX_FINGERPRINT_LEN );
-      if( !keyid || get_pubkey( pk, keyid ) )
-        {
-          goto failure; /* oops: no key for some reason */
-        }
-  
-      {
-        size_t dummy;
-        fingerprint_from_pk( pk, fpr, &dummy );
-      }
+      /* Return the passphrase we have stored in FD_PASSWD. */
+      pw = xmalloc_secure ( strlen(fd_passwd)+1 );
+      strcpy ( pw, fd_passwd );
     }
   else
-    pk = NULL;
-    
-  if ( !(ctx = agent_open (0, NULL)) ) 
-    goto failure;
-
-  { 
-      char *line, *p;
-      int i, rc; 
+    {
+      if (!nocache && (s2k->mode == 1 || s2k->mode == 3))
+       {
+         memset (s2k_cacheidbuf, 0, sizeof s2k_cacheidbuf);
+         *s2k_cacheidbuf = 'S';
+         bin2hex (s2k->salt, 8, s2k_cacheidbuf + 1);
+         s2k_cacheid = s2k_cacheidbuf;
+       }
 
-      if (cacheid)
+      if (opt.pinentry_mode == PINENTRY_MODE_LOOPBACK)
         {
-          line = xmalloc (17 + 3*strlen (cacheid) + 2);
-          strcpy (line, "CLEAR_PASSPHRASE ");
-          p = line+17;
-          p = percent_plus_escape (p, cacheid);
-        }
-      else
-        {
-          line = xmalloc (17 + 40 + 2);
-          strcpy (line, "CLEAR_PASSPHRASE ");
-          p = line+17;
-          for (i=0; i < 20; i++, p +=2 )
-            sprintf (p, "%02X", fpr[i]);
+          char buf[32];
+
+          snprintf (buf, sizeof (buf), "%u", 100);
+          write_status_text (STATUS_INQUIRE_MAXLEN, buf);
         }
-      *p = 0;
 
-      rc = assuan_transact (ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
-      xfree (line);
-      if (rc)
+      /* Divert to the gpg-agent. */
+      pw = passphrase_get (create && nocache, s2k_cacheid,
+                           create? opt.passphrase_repeat : 0,
+                           tryagain_text, canceled);
+      if (*canceled)
         {
-          log_error (_("problem with the agent - disabling agent use\n"));
-          opt.use_agent = 0;
+          xfree (pw);
+         write_status( STATUS_MISSING_PASSPHRASE );
+          return NULL;
         }
     }
-        
- failure:
-  agent_close (ctx);
-  if (pk)
-    free_public_key( pk );
-#endif /*ENABLE_AGENT_SUPPORT*/
-}
-
 
-/****************
- * Ask for a passphrase and return that string.
- */
-char *
-ask_passphrase (const char *description,
-                const char *tryagain_text,
-                const char *promptid,
-                const char *prompt,
-                const char *cacheid, int *canceled)
-{
-  char *pw = NULL;
-  
-  if (canceled)
-    *canceled = 0;
+  if ( !pw || !*pw )
+    write_status( STATUS_MISSING_PASSPHRASE );
 
-  if (!opt.batch && description)
-    {
-      if (strchr (description, '%'))
-        {
-          char *tmp = unescape_percent_string (description);
-          tty_printf ("\n%s\n", tmp);
-          xfree (tmp);
-        }
-      else
-        tty_printf ("\n%s\n",description);
-    }
-               
- agent_died:
-  if ( opt.use_agent ) 
+  /* Hash the passphrase and store it in a newly allocated DEK object.
+     Keep a copy of the passphrase in LAST_PW for use by
+     get_last_passphrase(). */
+  dek = xmalloc_secure_clear ( sizeof *dek );
+  dek->algo = cipher_algo;
+  if ( (!pw || !*pw) && create)
+    dek->keylen = 0;
+  else
     {
-      pw = agent_get_passphrase (NULL, 0, cacheid,
-                                 tryagain_text, description, prompt,
-                                 canceled );
-      if (!pw)
+      gpg_error_t err;
+
+      dek->keylen = openpgp_cipher_get_algo_keylen (dek->algo);
+      if (!(dek->keylen > 0 && dek->keylen <= DIM(dek->key)))
+        BUG ();
+      err = gcry_kdf_derive (pw, strlen (pw),
+                             s2k->mode == 3? GCRY_KDF_ITERSALTED_S2K :
+                             s2k->mode == 1? GCRY_KDF_SALTED_S2K :
+                             /* */           GCRY_KDF_SIMPLE_S2K,
+                             s2k->hash_algo, s2k->salt, 8,
+                             S2K_DECODE_COUNT(s2k->count),
+                             dek->keylen, dek->key);
+      if (err)
         {
-          if (!opt.use_agent)
-            goto agent_died;
-          pw = NULL;
+          log_error ("gcry_kdf_derive failed: %s", gpg_strerror (err));
+          xfree (pw);
+          xfree (dek);
+         write_status( STATUS_MISSING_PASSPHRASE );
+          return NULL;
         }
     }
-  else if (fd_passwd) 
-    {
-      pw = xmalloc_secure (strlen(fd_passwd)+1);
-      strcpy (pw, fd_passwd);
-    }
-  else if (opt.batch)
-    {
-      log_error(_("can't query passphrase in batch mode\n"));
-      pw = NULL;
-    }
-  else {
-    if (tryagain_text)
-      tty_printf(_("%s.\n"), tryagain_text);
-    pw = cpr_get_hidden(promptid? promptid : "passphrase.ask",
-                        prompt?prompt : _("Enter passphrase: ") );
-    tty_kill_prompt();
-  }
-
-  if (!pw || !*pw)
-    write_status( STATUS_MISSING_PASSPHRASE );
-
-  return pw;
+  if (s2k_cacheid)
+    memcpy (dek->s2k_cacheid, s2k_cacheid, sizeof dek->s2k_cacheid);
+  xfree(last_pw);
+  last_pw = pw;
+  return dek;
 }
 
 
-/* Return a new DEK object Using the string-to-key sepcifier S2K.  Use
- * KEYID and PUBKEY_ALGO to prompt the user.
-
-   MODE 0:  Allow cached passphrase
-        1:  Ignore cached passphrase 
-        2:  Ditto, but change the text to "repeat entry"
-*/
-DEK *
-passphrase_to_dek( u32 *keyid, int pubkey_algo,
-                  int cipher_algo, STRING2KEY *s2k, int mode,
-                   const char *tryagain_text, int *canceled)
+/* Emit the USERID_HINT and the NEED_PASSPHRASE status messages.
+   MAINKEYID may be NULL. */
+void
+emit_status_need_passphrase (ctrl_t ctrl,
+                             u32 *keyid, u32 *mainkeyid, int pubkey_algo)
 {
-    char *pw = NULL;
-    DEK *dek;
-    STRING2KEY help_s2k;
-
-    if (canceled)
-      *canceled = 0;
-
-    if( !s2k ) {
-        /* This is used for the old rfc1991 mode 
-         * Note: This must match the code in encode.c with opt.rfc1991 set */
-       s2k = &help_s2k;
-       s2k->mode = 0;
-       s2k->hash_algo = S2K_DIGEST_ALGO;
-    }
-
-    /* If we do not have a passphrase available in NEXT_PW and status
-       information are request, we print them now. */
-    if( !next_pw && is_status_enabled() ) {
-       char buf[50];
-       if( keyid ) {
-            u32 used_kid[2];
-            char *us;
-
-           if( keyid[2] && keyid[3] ) {
-                used_kid[0] = keyid[2];
-                used_kid[1] = keyid[3];
-            }
-            else {
-                used_kid[0] = keyid[0];
-                used_kid[1] = keyid[1];
-            }
-
-            us = get_long_user_id_string( keyid );
-            write_status_text( STATUS_USERID_HINT, us );
-            xfree(us);
-
-           sprintf( buf, "%08lX%08lX %08lX%08lX %d 0",
-                     (ulong)keyid[0], (ulong)keyid[1],
-                     (ulong)used_kid[0], (ulong)used_kid[1],
-                     pubkey_algo );
-                     
-           write_status_text( STATUS_NEED_PASSPHRASE, buf );
-       }
-       else {
-           sprintf( buf, "%d %d %d", cipher_algo, s2k->mode, s2k->hash_algo );
-           write_status_text( STATUS_NEED_PASSPHRASE_SYM, buf );
-       }
-    }
+  char buf[50];
+  char *us;
 
-    /* If we do have a keyID, we do not have a passphrase available in
-       NEXT_PW, we are not running in batch mode and we do not want to
-       ignore the passphrase cache (mode!=1), print a prompt with
-       information on that key. */
-    if( keyid && !opt.batch && !next_pw && mode!=1 ) {
-       PKT_public_key *pk = xmalloc_clear( sizeof *pk );
-       char *p;
-
-       p=get_user_id_native(keyid);
-       tty_printf("\n");
-       tty_printf(_("You need a passphrase to unlock the secret key for\n"
-                    "user: \"%s\"\n"),p);
-       xfree(p);
-
-       if( !get_pubkey( pk, keyid ) ) {
-           const char *s = gcry_pk_algo_name ( pk->pubkey_algo );
-           tty_printf( _("%u-bit %s key, ID %s, created %s"),
-                      nbits_from_pk( pk ), s?s:"?", keystr(keyid),
-                      strtimestamp(pk->timestamp) );
-           if( keyid[2] && keyid[3] && keyid[0] != keyid[2]
-                                    && keyid[1] != keyid[3] )
-             {
-               if(keystrlen()>10)
-                 {
-                   tty_printf("\n");
-                   tty_printf(_("         (subkey on main key ID %s)"),
-                              keystr(&keyid[2]) );
-                 }
-               else
-                 tty_printf( _(" (main key ID %s)"), keystr(&keyid[2]) );
-             }
-           tty_printf("\n");
-       }
+  us = get_long_user_id_string (ctrl, keyid);
+  write_status_text (STATUS_USERID_HINT, us);
+  xfree (us);
 
-       tty_printf("\n");
-        if (pk)
-          free_public_key( pk );
-    }
+  snprintf (buf, sizeof buf, "%08lX%08lX %08lX%08lX %d 0",
+            (ulong)keyid[0],
+            (ulong)keyid[1],
+            (ulong)(mainkeyid? mainkeyid[0]:keyid[0]),
+            (ulong)(mainkeyid? mainkeyid[1]:keyid[1]),
+            pubkey_algo);
 
- agent_died:
-    if( next_pw ) {
-        /* Simply return the passphrase we already have in NEXT_PW. */
-       pw = next_pw;
-       next_pw = NULL;
-    }
-    else if ( opt.use_agent ) {
-      /* Divert to the gpg-agent. */
-        pw = agent_get_passphrase ( keyid, mode == 2? 1: 0, NULL,
-                                    tryagain_text, NULL, NULL, canceled );
-        if (!pw)
-          {
-            if (!opt.use_agent)
-              goto agent_died;
-            pw = xstrdup ("");
-          }
-        if( *pw && mode == 2 ) {
-            char *pw2 = agent_get_passphrase ( keyid, 2, NULL, NULL, NULL,
-                                               NULL, canceled );
-            if (!pw2)
-              {
-                if (!opt.use_agent)
-                  {
-                    xfree (pw);
-                    pw = NULL;
-                    goto agent_died;
-                  }
-                pw2 = xstrdup ("");
-              }
-           if( strcmp(pw, pw2) ) {
-               xfree(pw2);
-               xfree(pw);
-               return NULL;
-           }
-           xfree(pw2);
-       }
-    }
-    else if( fd_passwd ) {
-        /* Return the passphrase we have store in FD_PASSWD. */
-       pw = xmalloc_secure( strlen(fd_passwd)+1 );
-       strcpy( pw, fd_passwd );
-    }
-    else if( opt.batch )
-      {
-       log_error(_("can't query passphrase in batch mode\n"));
-       pw = xstrdup( "" ); /* return an empty passphrase */
-      }
-    else {
-        /* Read the passphrase from the tty or the command-fd. */
-       pw = cpr_get_hidden("passphrase.enter", _("Enter passphrase: ") );
-       tty_kill_prompt();
-       if( mode == 2 && !cpr_enabled() ) {
-           char *pw2 = cpr_get_hidden("passphrase.repeat",
-                                      _("Repeat passphrase: ") );
-           tty_kill_prompt();
-           if( strcmp(pw, pw2) ) {
-               xfree(pw2);
-               xfree(pw);
-               return NULL;
-           }
-           xfree(pw2);
-       }
-    }
-
-    if( !pw || !*pw )
-       write_status( STATUS_MISSING_PASSPHRASE );
-
-    /* Hash the passphrase and store it in a newly allocated DEK
-       object.  Keep a copy of the passphrase in LAST_PW for use by
-       get_last_passphrase(). */
-    dek = xmalloc_secure_clear ( sizeof *dek );
-    dek->algo = cipher_algo;
-    if( !*pw && mode == 2 )
-       dek->keylen = 0;
-    else
-       hash_passphrase( dek, pw, s2k, mode==2 );
-    xfree(last_pw);
-    last_pw = pw;
-    return dek;
+  write_status_text (STATUS_NEED_PASSPHRASE, buf);
 }
 
 
-/****************
- * Hash a passphrase using the supplied s2k. If create is true, create
- * a new salt or what else must be filled into the s2k for a new key.
- * always needs: dek->algo, s2k->mode, s2k->hash_algo.
- */
-static void
-hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create )
+/* Return an allocated utf-8 string describing the key PK.  If ESCAPED
+   is true spaces and control characters are percent or plus escaped.
+   MODE describes the use of the key description; use one of the
+   FORMAT_KEYDESC_ macros. */
+char *
+gpg_format_keydesc (ctrl_t ctrl, PKT_public_key *pk, int mode, int escaped)
 {
-    gcry_md_hd_t md;
-    int pass, i;
-    int used = 0;
-    int pwlen = strlen(pw);
-
-    assert( s2k->hash_algo );
-    dek->keylen = gcry_cipher_algo_get_keylen (dek->algo );
-    if( !(dek->keylen > 0 && dek->keylen <= DIM(dek->key)) )
-       BUG();
-
-    if (gcry_md_open (&md, s2k->hash_algo, 1))
-      BUG ();
-    for(pass=0; used < dek->keylen ; pass++ ) {
-       if( pass ) {
-            gcry_md_reset (md);
-           for(i=0; i < pass; i++ ) /* preset the hash context */
-               gcry_md_putc (md, 0 );
-       }
+  char *uid;
+  size_t uidlen;
+  const char *algo_name;
+  const char *timestr;
+  char *orig_codeset;
+  char *maink;
+  char *desc;
+  const char *prompt;
+  const char *trailer = "";
+  int is_subkey;
+
+  is_subkey = (pk->main_keyid[0] && pk->main_keyid[1]
+               && pk->keyid[0] != pk->main_keyid[0]
+               && pk->keyid[1] != pk->main_keyid[1]);
+  algo_name = openpgp_pk_algo_name (pk->pubkey_algo);
+  timestr = strtimestamp (pk->timestamp);
+  uid = get_user_id (ctrl, is_subkey? pk->main_keyid:pk->keyid, &uidlen);
+
+  orig_codeset = i18n_switchto_utf8 ();
+
+  if (is_subkey)
+    maink = xtryasprintf (_(" (main key ID %s)"), keystr (pk->main_keyid));
+  else
+    maink = NULL;
 
-       if( s2k->mode == 1 || s2k->mode == 3 ) {
-           int len2 = pwlen + 8;
-           ulong count = len2;
-
-           if( create && !pass ) {
-               gcry_randomize (s2k->salt, 8, GCRY_STRONG_RANDOM);
-               if( s2k->mode == 3 )
-                   s2k->count = 96; /* 65536 iterations */
-           }
-
-           if( s2k->mode == 3 ) {
-               count = (16ul + (s2k->count & 15)) << ((s2k->count >> 4) + 6);
-               if( count < len2 )
-                   count = len2;
-           }
-           /* a little bit complicated because we need a ulong for count */
-           while( count > len2 ) { /* maybe iterated+salted */
-               gcry_md_write ( md, s2k->salt, 8 );
-               gcry_md_write ( md, pw, pwlen );
-               count -= len2;
-           }
-           if( count < 8 )
-               gcry_md_write ( md, s2k->salt, count );
-           else {
-               gcry_md_write ( md, s2k->salt, 8 );
-               count -= 8;
-                gcry_md_write ( md, pw, count );
-           }
-       }
-       else
-           gcry_md_write ( md, pw, pwlen );
-       gcry_md_final( md );
-       i = gcry_md_get_algo_dlen ( s2k->hash_algo );
-       if( i > dek->keylen - used )
-           i = dek->keylen - used;
-       memcpy( dek->key+used, md_read(md, s2k->hash_algo), i );
-       used += i;
+  switch (mode)
+    {
+    case FORMAT_KEYDESC_NORMAL:
+      prompt = _("Please enter the passphrase to unlock the"
+                 " OpenPGP secret key:");
+      break;
+    case FORMAT_KEYDESC_IMPORT:
+      prompt = _("Please enter the passphrase to import the"
+                 " OpenPGP secret key:");
+      break;
+    case FORMAT_KEYDESC_EXPORT:
+      if (is_subkey)
+        prompt = _("Please enter the passphrase to export the"
+                   " OpenPGP secret subkey:");
+      else
+        prompt = _("Please enter the passphrase to export the"
+                   " OpenPGP secret key:");
+      break;
+    case FORMAT_KEYDESC_DELKEY:
+      if (is_subkey)
+        prompt = _("Do you really want to permanently delete the"
+                   " OpenPGP secret subkey key:");
+      else
+        prompt = _("Do you really want to permanently delete the"
+                   " OpenPGP secret key:");
+      trailer = "?";
+      break;
+    default:
+      prompt = "?";
+      break;
+    }
+
+  desc = xtryasprintf (_("%s\n"
+                         "\"%.*s\"\n"
+                         "%u-bit %s key, ID %s,\n"
+                         "created %s%s.\n%s"),
+                       prompt,
+                       (int)uidlen, uid,
+                       nbits_from_pk (pk), algo_name,
+                       keystr (pk->keyid), timestr,
+                       maink?maink:"", trailer);
+  xfree (maink);
+  xfree (uid);
+
+  i18n_switchback (orig_codeset);
+
+  if (escaped)
+    {
+      char *tmp = percent_plus_escape (desc);
+      xfree (desc);
+      desc = tmp;
     }
-    gcry_md_close(md);
-}
 
+  return desc;
+}