Updated estream.
[gnupg.git] / agent / protect-tool.c
index 286adde..b12b380 100644 (file)
@@ -1,11 +1,11 @@
 /* protect-tool.c - A tool to test the secret key protection
- *     Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
+ * Copyright (C) 2002, 2003, 2004, 2006 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,
@@ -14,8 +14,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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <config.h>
 #ifdef HAVE_LANGINFO_CODESET
 #include <langinfo.h>
 #endif
+#ifdef HAVE_DOSISH_SYSTEM
+#include <fcntl.h> /* for setmode() */
+#endif
 
 #define JNLIB_NEED_LOG_LOGV
 #include "agent.h"
 #include "minip12.h"
 #include "simple-pwquery.h"
 #include "i18n.h"
+#include "sysutils.h"
+
 
 enum cmd_and_opt_values 
 { aNull = 0,
@@ -55,9 +59,11 @@ enum cmd_and_opt_values
   oShadow,
   oShowShadowInfo,
   oShowKeygrip,
+  oCanonical,
 
   oP12Import,
   oP12Export,
+  oP12Charset,
   oStore,
   oForce,
   oHaveCert,
@@ -79,8 +85,9 @@ struct rsa_secret_key_s
   };
 
 
-static char *opt_homedir;
+static const char *opt_homedir;
 static int opt_armor;
+static int opt_canonical;
 static int opt_store;
 static int opt_force;
 static int opt_no_fail_on_exist;
@@ -88,8 +95,9 @@ static int opt_have_cert;
 static const char *opt_passphrase;
 static char *opt_prompt;
 static int opt_status_msg;
+static const char *opt_p12_charset;
 
-static char *get_passphrase (int promptno);
+static char *get_passphrase (int promptno, int opt_check);
 static char *get_new_passphrase (int promptno);
 static void release_passphrase (char *pw);
 static int store_private_key (const unsigned char *grip,
@@ -102,15 +110,18 @@ static ARGPARSE_OPTS opts[] = {
 
   { oVerbose, "verbose",   0, "verbose" },
   { oArmor,   "armor",     0, "write output in advanced format" },
+  { oCanonical, "canonical", 0, "write output in canonical format" },
   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
   { oProtect, "protect",     256, "protect a private key"},
   { oUnprotect, "unprotect", 256, "unprotect a private key"},
-  { oShadow,  "shadow", 256, "create a shadow entry for a priblic key"},
+  { oShadow,  "shadow", 256, "create a shadow entry for a public key"},
   { oShowShadowInfo,  "show-shadow-info", 256, "return the shadow info"},
   { oShowKeygrip, "show-keygrip", 256, "show the \"keygrip\""},
 
-  { oP12Import, "p12-import", 256, "import a PKCS-12 encoded private key"},
-  { oP12Export, "p12-export", 256, "export a private key PKCS-12 encoded"},
+  { oP12Import, "p12-import", 256, "import a pkcs#12 encoded private key"},
+  { oP12Export, "p12-export", 256, "export a private key pkcs#12 encoded"},
+  { oP12Charset,"p12-charset", 2,
+    "|NAME|set charset for a new PKCS#12 passphrase to NAME" },
   { oHaveCert, "have-cert", 0,  "certificate to export provided on STDIN"},
   { oStore,     "store", 0, "store the created key in the appropriate place"},
   { oForce,     "force", 0, "force overwriting"},
@@ -118,6 +129,7 @@ static ARGPARSE_OPTS opts[] = {
   { oHomedir, "homedir", 2, "@" }, 
   { oPrompt,  "prompt", 2, "|ESCSTRING|use ESCSTRING as prompt in pinentry"}, 
   { oStatusMsg, "enable-status-msg", 0, "@"},
+
   {0}
 };
 
@@ -136,7 +148,7 @@ my_strusage (int level)
     case 1:
     case 40: p =  _("Usage: gpg-protect-tool [options] (-h for help)\n");
       break;
-    case 41: p =  _("Syntax: gpg-protect-tool [options] [args]]\n"
+    case 41: p =  _("Syntax: gpg-protect-tool [options] [args]\n"
                     "Secret key maintenance tool\n");
     break;
     
@@ -146,41 +158,8 @@ my_strusage (int level)
 }
 
 
-
-static void
-i18n_init (void)
-{
-#ifdef USE_SIMPLE_GETTEXT
-    set_gettext_file( PACKAGE_GT );
-#else
-#ifdef ENABLE_NLS
-    setlocale (LC_ALL, "");
-    bindtextdomain (PACKAGE_GT, LOCALEDIR);
-    textdomain (PACKAGE_GT);
-#endif
-#endif
-}
-
-
-
-/* Used by gcry for logging */
-static void
-my_gcry_logger (void *dummy, int level, const char *fmt, va_list arg_ptr)
-{
-  /* translate the log levels */
-  switch (level)
-    {
-    case GCRY_LOG_CONT: level = JNLIB_LOG_CONT; break;
-    case GCRY_LOG_INFO: level = JNLIB_LOG_INFO; break;
-    case GCRY_LOG_WARN: level = JNLIB_LOG_WARN; break;
-    case GCRY_LOG_ERROR:level = JNLIB_LOG_ERROR; break;
-    case GCRY_LOG_FATAL:level = JNLIB_LOG_FATAL; break;
-    case GCRY_LOG_BUG:  level = JNLIB_LOG_BUG; break;
-    case GCRY_LOG_DEBUG:level = JNLIB_LOG_DEBUG; break;
-    default:            level = JNLIB_LOG_ERROR; break;      }
-  log_logv (level, fmt, arg_ptr);
-}
-
+/* Include the implementation of map_spwq_error.  */
+MAP_SPWQ_ERROR_IMPL
 
 /*  static void */
 /*  print_mpi (const char *text, gcry_mpi_t a) */
@@ -231,9 +210,9 @@ make_advanced (const unsigned char *buf, size_t buflen)
   int rc;
   size_t erroff, len;
   gcry_sexp_t sexp;
-  unsigned char *result;
+  char *result;
 
-  rc = gcry_sexp_sscan (&sexp, &erroff, buf, buflen);
+  rc = gcry_sexp_sscan (&sexp, &erroff, (const char*)buf, buflen);
   if (rc)
     {
       log_error ("invalid canonical S-Expression (off=%u): %s\n",
@@ -262,6 +241,9 @@ read_file (const char *fname, size_t *r_length)
       size_t nread, bufsize = 0;
 
       fp = stdin;
+#ifdef HAVE_DOSISH_SYSTEM
+      setmode ( fileno(fp) , O_BINARY );
+#endif
       buf = NULL;
       buflen = 0;
 #define NCHUNK 8192
@@ -351,7 +333,7 @@ read_and_protect (const char *fname)
   if (!key)
     return;
 
-  pw = get_passphrase (1);
+  pw = get_passphrase (1, 0);
   rc = agent_protect (key, pw, &result, &resultlen);
   release_passphrase (pw);
   xfree (key);
@@ -367,7 +349,7 @@ read_and_protect (const char *fname)
       xfree (result);
       if (!p)
         return;
-      result = p;
+      result = (unsigned char*)p;
       resultlen = strlen (p);
     }
 
@@ -389,7 +371,7 @@ read_and_unprotect (const char *fname)
   if (!key)
     return;
 
-  rc = agent_unprotect (key, (pw=get_passphrase (1)), &result, &resultlen);
+  rc = agent_unprotect (key, (pw=get_passphrase (1, 0)), &result, &resultlen);
   release_passphrase (pw);
   xfree (key);
   if (rc)
@@ -406,7 +388,7 @@ read_and_unprotect (const char *fname)
       xfree (result);
       if (!p)
         return;
-      result = p;
+      result = (unsigned char*)p;
       resultlen = strlen (p);
     }
 
@@ -423,12 +405,13 @@ read_and_shadow (const char *fname)
   unsigned char *key;
   unsigned char *result;
   size_t resultlen;
+  unsigned char dummy_info[] = "(8:313233342:43)";
   
   key = read_key (fname);
   if (!key)
     return;
 
-  rc = agent_shadow_key (key, "(8:313233342:43)", &result);
+  rc = agent_shadow_key (key, dummy_info, &result);
   xfree (key);
   if (rc)
     {
@@ -444,7 +427,7 @@ read_and_shadow (const char *fname)
       xfree (result);
       if (!p)
         return;
-      result = p;
+      result = (unsigned char*)p;
       resultlen = strlen (p);
     }
 
@@ -500,14 +483,21 @@ show_file (const char *fname)
 
   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
   assert (keylen);
-
-  p = make_advanced (key, keylen);
-  xfree (key);
-  if (p)
+  
+  if (opt_canonical)
     {
-      fwrite (p, strlen (p), 1, stdout);
-      xfree (p);
+      fwrite (key, keylen, 1, stdout);
+    }
+  else
+    {
+      p = make_advanced (key, keylen);
+      if (p)
+        {
+          fwrite (p, strlen (p), 1, stdout);
+          xfree (p);
+        }
     }
+  xfree (key);
 }
 
 static void
@@ -648,7 +638,7 @@ import_p12_file (const char *fname)
 {
   char *buf;
   unsigned char *result;
-  size_t buflen, resultlen;
+  size_t buflen, resultlen, buf_off;
   int i;
   int rc;
   gcry_mpi_t *kparms;
@@ -664,7 +654,22 @@ import_p12_file (const char *fname)
   if (!buf)
     return;
 
-  kparms = p12_parse (buf, buflen, (pw=get_passphrase (2)),
+  /* GnuPG 2.0.4 accidently created binary P12 files with the string
+     "The passphrase is %s encoded.\n\n" prepended to the ASN.1 data.
+     We fix that here.  */
+  if (buflen > 29 && !memcmp (buf, "The passphrase is ", 18))
+    {
+      for (buf_off=18; buf_off < buflen && buf[buf_off] != '\n'; buf_off++)
+        ;
+      buf_off++;
+      if (buf_off < buflen && buf[buf_off] == '\n')
+        buf_off++;
+    }
+  else
+    buf_off = 0;
+
+  kparms = p12_parse ((unsigned char*)buf+buf_off, buflen-buf_off,
+                      (pw=get_passphrase (2, 0)),
                       import_p12_cert_cb, NULL);
   release_passphrase (pw);
   xfree (buf);
@@ -755,7 +760,7 @@ import_p12_file (const char *fname)
       xfree (result);
       if (!p)
         return;
-      result = p;
+      result = (unsigned char*)p;
       resultlen = strlen (p);
     }
 
@@ -878,7 +883,7 @@ export_p12_file (const char *fname)
       unsigned char *tmpkey;
       size_t tmplen;
 
-      rc = agent_unprotect (key, (pw=get_passphrase (1)), &tmpkey, &tmplen);
+      rc = agent_unprotect (key, (pw=get_passphrase (1, 0)), &tmpkey, &tmplen);
       release_passphrase (pw);
       if (rc)
         {
@@ -914,7 +919,7 @@ export_p12_file (const char *fname)
 
   if (opt_have_cert)
     {
-      cert = read_file ("-", &certlen);
+      cert = (unsigned char*)read_file ("-", &certlen);
       if (!cert)
         {
           wipememory (key, keylen_for_wipe);
@@ -967,7 +972,7 @@ export_p12_file (const char *fname)
   kparms[8] = NULL;
 
   key = p12_build (kparms, cert, certlen,
-                   (pw=get_new_passphrase (3)), &keylen);
+                   (pw=get_new_passphrase (3)), opt_p12_charset, &keylen);
   release_passphrase (pw);
   xfree (cert);
   for (i=0; i < 8; i++)
@@ -975,6 +980,9 @@ export_p12_file (const char *fname)
   if (!key)
     return;
   
+#ifdef HAVE_DOSISH_SYSTEM
+  setmode ( fileno (stdout) , O_BINARY );
+#endif
   fwrite (key, keylen, 1, stdout);
   xfree (key);
 }
@@ -1019,7 +1027,7 @@ percent_plus_unescape (unsigned char *string)
 static char *
 percent_plus_unescape_string (char *string) 
 {
-  unsigned char *p = string;
+  unsigned char *p = (unsigned char*)string;
   size_t n;
 
   n = percent_plus_unescape (p);
@@ -1040,30 +1048,22 @@ main (int argc, char **argv )
   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
   log_set_prefix ("gpg-protect-tool", 1); 
 
-  /* Try to auto set the character set.  */
-  set_native_charset (NULL); 
+  /* Make sure that our subsystems are ready.  */
+  init_common_subsystems ();
 
   i18n_init ();
 
   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
     {
-      log_fatal( _("libgcrypt is too old (need %s, have %s)\n"),
+      log_fatal( _("%s is too old (need %s, have %s)\n"), "libgcrypt",
                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
     }
 
-  gcry_set_log_handler (my_gcry_logger, NULL);
-  
+  setup_libgcrypt_logging ();
   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
 
 
-#ifdef __MINGW32__
-  opt_homedir = read_w32_registry_string ( NULL,
-                                           "Software\\GNU\\GnuPG", "HomeDir" );
-#else
-  opt_homedir = getenv ("GNUPGHOME");
-#endif
-  if (!opt_homedir || !*opt_homedir)
-    opt_homedir = GNUPG_DEFAULT_HOMEDIR;
+  opt_homedir = default_homedir ();
 
 
   pargs.argc = &argc;
@@ -1075,6 +1075,7 @@ main (int argc, char **argv )
         {
         case oVerbose: opt.verbose++; break;
         case oArmor:   opt_armor=1; break;
+        case oCanonical: opt_canonical=1; break;
         case oHomedir: opt_homedir = pargs.r.ret_str; break;
 
         case oProtect: cmd = oProtect; break;
@@ -1084,6 +1085,7 @@ main (int argc, char **argv )
         case oShowKeygrip: cmd = oShowKeygrip; break;
         case oP12Import: cmd = oP12Import; break;
         case oP12Export: cmd = oP12Export; break;
+        case oP12Charset: opt_p12_charset = pargs.r.ret_str; break;
 
         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
         case oStore: opt_store = 1; break;
@@ -1105,6 +1107,13 @@ main (int argc, char **argv )
   else if (argc > 1)
     usage (1);
 
+  /* Tell simple-pwquery about the the standard socket name.  */
+  {
+    char *tmp = make_filename (opt_homedir, "S.gpg-agent", NULL);
+    simple_pw_set_socket (tmp);
+    xfree (tmp);
+  }
+
   if (opt_prompt)
     opt_prompt = percent_plus_unescape_string (xstrdup (opt_prompt));
 
@@ -1145,15 +1154,18 @@ agent_exit (int rc)
      3 = for protecting a new pkcs#12 object
      4 = for protecting an imported pkcs#12 in our system
      5 = reenter the passphrase
-   When adding 100 to the values, a "does not match - try again" errro message is shown.
+   When adding 100 to the values, a "does not match - try again" error
+   message is shown.
 */
 static char *
-get_passphrase (int promptno)
+get_passphrase (int promptno, int opt_check)
 {
   char *pw;
   int err;
   const char *desc;
+#ifdef ENABLE_NLS
   char *orig_codeset = NULL;
+#endif
   int error_msgno;
   
 
@@ -1177,7 +1189,10 @@ get_passphrase (int promptno)
       /* We only switch when we are able to restore the codeset later. */
       orig_codeset = xstrdup (orig_codeset);
       if (!bind_textdomain_codeset (PACKAGE_GT, "utf-8"))
-        orig_codeset = NULL; 
+        {
+         xfree (orig_codeset);
+         orig_codeset = NULL; 
+       }
     }
 #endif
 
@@ -1200,7 +1215,8 @@ get_passphrase (int promptno)
 
   pw = simple_pwquery (NULL,
                        error_msgno == 1? _("does not match - try again"):NULL,
-                       _("Passphrase:"), desc, &err);
+                       _("Passphrase:"), desc, opt_check, &err);
+  err = map_spwq_error (err);
 
 #ifdef ENABLE_NLS
   if (orig_codeset)
@@ -1213,9 +1229,10 @@ get_passphrase (int promptno)
   if (!pw)
     {
       if (err)
-        log_error ("error while asking for the passphrase\n");
+        log_error (_("error while asking for the passphrase: %s\n"),
+                   gpg_strerror (err));
       else
-        log_info ("cancelled\n");
+        log_info (_("cancelled\n"));
       agent_exit (0);
     }
 
@@ -1231,16 +1248,16 @@ get_new_passphrase (int promptno)
   char *pw;
   int i, secondpromptno;
   
-  pw = get_passphrase (promptno);
+  pw = get_passphrase (promptno, 1);
   if (!pw)
     return NULL; /* Canceled. */
   if (!*pw)
-    return pw; /* Empty passphrase - no need to as for repeating it. */
+    return pw;   /* Empty passphrase - no need to ask for repeating it. */
 
   secondpromptno = 5;
   for (i=0; i < 3; i++)
     {
-      char *pw2 = get_passphrase (secondpromptno);
+      char *pw2 = get_passphrase (secondpromptno, 0);
       if (!pw2)
         {
           xfree (pw);