* protect-tool.c: New option --canonical.
[gnupg.git] / agent / protect-tool.c
1 /* protect-tool.c - A tool to test the secret key protection
2  *      Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stddef.h>
26 #include <stdarg.h>
27 #include <string.h>
28 #include <errno.h>
29 #include <assert.h>
30 #include <sys/stat.h>
31 #include <unistd.h>
32 #ifdef HAVE_LOCALE_H
33 #include <locale.h>
34 #endif
35 #ifdef HAVE_LANGINFO_CODESET
36 #include <langinfo.h>
37 #endif
38 #ifdef HAVE_DOSISH_SYSTEM
39 #include <fcntl.h> /* for setmode() */
40 #endif
41
42 #define JNLIB_NEED_LOG_LOGV
43 #include "agent.h"
44 #include "minip12.h"
45 #include "simple-pwquery.h"
46 #include "i18n.h"
47 #include "sysutils.h"
48
49
50 enum cmd_and_opt_values 
51 { aNull = 0,
52   oVerbose        = 'v',
53   oArmor          = 'a',
54   oPassphrase     = 'P',
55
56   oProtect        = 'p',
57   oUnprotect      = 'u',
58   
59   oNoVerbose = 500,
60   oShadow,
61   oShowShadowInfo,
62   oShowKeygrip,
63   oCanonical,
64
65   oP12Import,
66   oP12Export,
67   oStore,
68   oForce,
69   oHaveCert,
70   oNoFailOnExist,
71   oHomedir,
72   oPrompt,
73   oStatusMsg, 
74
75 aTest };
76
77 struct rsa_secret_key_s 
78   {
79     gcry_mpi_t n;           /* public modulus */
80     gcry_mpi_t e;           /* public exponent */
81     gcry_mpi_t d;           /* exponent */
82     gcry_mpi_t p;           /* prime  p. */
83     gcry_mpi_t q;           /* prime  q. */
84     gcry_mpi_t u;           /* inverse of p mod q. */
85   };
86
87
88 static const char *opt_homedir;
89 static int opt_armor;
90 static int opt_canonical;
91 static int opt_store;
92 static int opt_force;
93 static int opt_no_fail_on_exist;
94 static int opt_have_cert;
95 static const char *opt_passphrase;
96 static char *opt_prompt;
97 static int opt_status_msg;
98
99 static char *get_passphrase (int promptno);
100 static char *get_new_passphrase (int promptno);
101 static void release_passphrase (char *pw);
102 static int store_private_key (const unsigned char *grip,
103                               const void *buffer, size_t length, int force);
104
105
106 static ARGPARSE_OPTS opts[] = {
107   
108   { 301, NULL, 0, N_("@Options:\n ") },
109
110   { oVerbose, "verbose",   0, "verbose" },
111   { oArmor,   "armor",     0, "write output in advanced format" },
112   { oCanonical, "canonical", 0, "write output in canonical format" },
113   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
114   { oProtect, "protect",     256, "protect a private key"},
115   { oUnprotect, "unprotect", 256, "unprotect a private key"},
116   { oShadow,  "shadow", 256, "create a shadow entry for a public key"},
117   { oShowShadowInfo,  "show-shadow-info", 256, "return the shadow info"},
118   { oShowKeygrip, "show-keygrip", 256, "show the \"keygrip\""},
119
120   { oP12Import, "p12-import", 256, "import a PKCS-12 encoded private key"},
121   { oP12Export, "p12-export", 256, "export a private key PKCS-12 encoded"},
122   { oHaveCert, "have-cert", 0,  "certificate to export provided on STDIN"},
123   { oStore,     "store", 0, "store the created key in the appropriate place"},
124   { oForce,     "force", 0, "force overwriting"},
125   { oNoFailOnExist, "no-fail-on-exist", 0, "@" },
126   { oHomedir, "homedir", 2, "@" }, 
127   { oPrompt,  "prompt", 2, "|ESCSTRING|use ESCSTRING as prompt in pinentry"}, 
128   { oStatusMsg, "enable-status-msg", 0, "@"},
129   {0}
130 };
131
132 static const char *
133 my_strusage (int level)
134 {
135   const char *p;
136   switch (level)
137     {
138     case 11: p = "gpg-protect-tool (GnuPG)";
139       break;
140     case 13: p = VERSION; break;
141     case 17: p = PRINTABLE_OS_NAME; break;
142     case 19: p = _("Please report bugs to <" PACKAGE_BUGREPORT ">.\n");
143       break;
144     case 1:
145     case 40: p =  _("Usage: gpg-protect-tool [options] (-h for help)\n");
146       break;
147     case 41: p =  _("Syntax: gpg-protect-tool [options] [args]]\n"
148                     "Secret key maintenance tool\n");
149     break;
150     
151     default: p = NULL;
152     }
153   return p;
154 }
155
156
157
158 static void
159 i18n_init (void)
160 {
161 #ifdef USE_SIMPLE_GETTEXT
162     set_gettext_file( PACKAGE_GT );
163 #else
164 #ifdef ENABLE_NLS
165     setlocale (LC_ALL, "");
166     bindtextdomain (PACKAGE_GT, LOCALEDIR);
167     textdomain (PACKAGE_GT);
168 #endif
169 #endif
170 }
171
172
173
174 /* Used by gcry for logging */
175 static void
176 my_gcry_logger (void *dummy, int level, const char *fmt, va_list arg_ptr)
177 {
178   /* translate the log levels */
179   switch (level)
180     {
181     case GCRY_LOG_CONT: level = JNLIB_LOG_CONT; break;
182     case GCRY_LOG_INFO: level = JNLIB_LOG_INFO; break;
183     case GCRY_LOG_WARN: level = JNLIB_LOG_WARN; break;
184     case GCRY_LOG_ERROR:level = JNLIB_LOG_ERROR; break;
185     case GCRY_LOG_FATAL:level = JNLIB_LOG_FATAL; break;
186     case GCRY_LOG_BUG:  level = JNLIB_LOG_BUG; break;
187     case GCRY_LOG_DEBUG:level = JNLIB_LOG_DEBUG; break;
188     default:            level = JNLIB_LOG_ERROR; break;      }
189   log_logv (level, fmt, arg_ptr);
190 }
191
192
193 /*  static void */
194 /*  print_mpi (const char *text, gcry_mpi_t a) */
195 /*  { */
196 /*    char *buf; */
197 /*    void *bufaddr = &buf; */
198 /*    int rc; */
199
200 /*    rc = gcry_mpi_aprint (GCRYMPI_FMT_HEX, bufaddr, NULL, a); */
201 /*    if (rc) */
202 /*      log_info ("%s: [error printing number: %s]\n", text, gpg_strerror (rc)); */
203 /*    else */
204 /*      { */
205 /*        log_info ("%s: %s\n", text, buf); */
206 /*        gcry_free (buf); */
207 /*      } */
208 /*  } */
209
210
211 \f
212 static unsigned char *
213 make_canonical (const char *fname, const char *buf, size_t buflen)
214 {
215   int rc;
216   size_t erroff, len;
217   gcry_sexp_t sexp;
218   unsigned char *result;
219
220   rc = gcry_sexp_sscan (&sexp, &erroff, buf, buflen);
221   if (rc)
222     {
223       log_error ("invalid S-Expression in `%s' (off=%u): %s\n",
224                  fname, (unsigned int)erroff, gpg_strerror (rc));
225       return NULL;
226     }
227   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_CANON, NULL, 0);
228   assert (len);
229   result = xmalloc (len);
230   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_CANON, result, len);
231   assert (len);
232   gcry_sexp_release (sexp);
233   return result;
234 }
235
236 static char *
237 make_advanced (const unsigned char *buf, size_t buflen)
238 {
239   int rc;
240   size_t erroff, len;
241   gcry_sexp_t sexp;
242   unsigned char *result;
243
244   rc = gcry_sexp_sscan (&sexp, &erroff, buf, buflen);
245   if (rc)
246     {
247       log_error ("invalid canonical S-Expression (off=%u): %s\n",
248                  (unsigned int)erroff, gpg_strerror (rc));
249       return NULL;
250     }
251   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_ADVANCED, NULL, 0);
252   assert (len);
253   result = xmalloc (len);
254   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_ADVANCED, result, len);
255   assert (len);
256   gcry_sexp_release (sexp);
257   return result;
258 }
259
260
261 static char *
262 read_file (const char *fname, size_t *r_length)
263 {
264   FILE *fp;
265   char *buf;
266   size_t buflen;
267   
268   if (!strcmp (fname, "-"))
269     {
270       size_t nread, bufsize = 0;
271
272       fp = stdin;
273 #ifdef HAVE_DOSISH_SYSTEM
274       setmode ( fileno(fp) , O_BINARY );
275 #endif
276       buf = NULL;
277       buflen = 0;
278 #define NCHUNK 8192
279       do 
280         {
281           bufsize += NCHUNK;
282           if (!buf)
283             buf = xmalloc (bufsize);
284           else
285             buf = xrealloc (buf, bufsize);
286
287           nread = fread (buf+buflen, 1, NCHUNK, fp);
288           if (nread < NCHUNK && ferror (fp))
289             {
290               log_error ("error reading `[stdin]': %s\n", strerror (errno));
291               xfree (buf);
292               return NULL;
293             }
294           buflen += nread;
295         }
296       while (nread == NCHUNK);
297 #undef NCHUNK
298
299     }
300   else
301     {
302       struct stat st;
303
304       fp = fopen (fname, "rb");
305       if (!fp)
306         {
307           log_error ("can't open `%s': %s\n", fname, strerror (errno));
308           return NULL;
309         }
310   
311       if (fstat (fileno(fp), &st))
312         {
313           log_error ("can't stat `%s': %s\n", fname, strerror (errno));
314           fclose (fp);
315           return NULL;
316         }
317       
318       buflen = st.st_size;
319       buf = xmalloc (buflen+1);
320       if (fread (buf, buflen, 1, fp) != 1)
321         {
322           log_error ("error reading `%s': %s\n", fname, strerror (errno));
323           fclose (fp);
324           xfree (buf);
325           return NULL;
326         }
327       fclose (fp);
328     }
329
330   *r_length = buflen;
331   return buf;
332 }
333
334
335 static unsigned char *
336 read_key (const char *fname)
337 {
338   char *buf;
339   size_t buflen;
340   unsigned char *key;
341   
342   buf = read_file (fname, &buflen);
343   if (!buf)
344     return NULL;
345   key = make_canonical (fname, buf, buflen);
346   xfree (buf);
347   return key;
348 }
349
350
351 \f
352 static void
353 read_and_protect (const char *fname)
354 {
355   int  rc;
356   unsigned char *key;
357   unsigned char *result;
358   size_t resultlen;
359   char *pw;
360   
361   key = read_key (fname);
362   if (!key)
363     return;
364
365   pw = get_passphrase (1);
366   rc = agent_protect (key, pw, &result, &resultlen);
367   release_passphrase (pw);
368   xfree (key);
369   if (rc)
370     {
371       log_error ("protecting the key failed: %s\n", gpg_strerror (rc));
372       return;
373     }
374   
375   if (opt_armor)
376     {
377       char *p = make_advanced (result, resultlen);
378       xfree (result);
379       if (!p)
380         return;
381       result = p;
382       resultlen = strlen (p);
383     }
384
385   fwrite (result, resultlen, 1, stdout);
386   xfree (result);
387 }
388
389
390 static void
391 read_and_unprotect (const char *fname)
392 {
393   int  rc;
394   unsigned char *key;
395   unsigned char *result;
396   size_t resultlen;
397   char *pw;
398   
399   key = read_key (fname);
400   if (!key)
401     return;
402
403   rc = agent_unprotect (key, (pw=get_passphrase (1)), &result, &resultlen);
404   release_passphrase (pw);
405   xfree (key);
406   if (rc)
407     {
408       if (opt_status_msg)
409         log_info ("[PROTECT-TOOL:] bad-passphrase\n");
410       log_error ("unprotecting the key failed: %s\n", gpg_strerror (rc));
411       return;
412     }
413   
414   if (opt_armor)
415     {
416       char *p = make_advanced (result, resultlen);
417       xfree (result);
418       if (!p)
419         return;
420       result = p;
421       resultlen = strlen (p);
422     }
423
424   fwrite (result, resultlen, 1, stdout);
425   xfree (result);
426 }
427
428
429 \f
430 static void
431 read_and_shadow (const char *fname)
432 {
433   int  rc;
434   unsigned char *key;
435   unsigned char *result;
436   size_t resultlen;
437   
438   key = read_key (fname);
439   if (!key)
440     return;
441
442   rc = agent_shadow_key (key, "(8:313233342:43)", &result);
443   xfree (key);
444   if (rc)
445     {
446       log_error ("shadowing the key failed: %s\n", gpg_strerror (rc));
447       return;
448     }
449   resultlen = gcry_sexp_canon_len (result, 0, NULL,NULL);
450   assert (resultlen);
451   
452   if (opt_armor)
453     {
454       char *p = make_advanced (result, resultlen);
455       xfree (result);
456       if (!p)
457         return;
458       result = p;
459       resultlen = strlen (p);
460     }
461
462   fwrite (result, resultlen, 1, stdout);
463   xfree (result);
464 }
465
466 static void
467 show_shadow_info (const char *fname)
468 {
469   int  rc;
470   unsigned char *key;
471   const unsigned char *info;
472   size_t infolen;
473   
474   key = read_key (fname);
475   if (!key)
476     return;
477
478   rc = agent_get_shadow_info (key, &info);
479   xfree (key);
480   if (rc)
481     {
482       log_error ("get_shadow_info failed: %s\n", gpg_strerror (rc));
483       return;
484     }
485   infolen = gcry_sexp_canon_len (info, 0, NULL,NULL);
486   assert (infolen);
487   
488   if (opt_armor)
489     {
490       char *p = make_advanced (info, infolen);
491       if (!p)
492         return;
493       fwrite (p, strlen (p), 1, stdout);
494       xfree (p);
495     }
496   else
497     fwrite (info, infolen, 1, stdout);
498 }
499
500
501 static void
502 show_file (const char *fname)
503 {
504   unsigned char *key;
505   size_t keylen;
506   char *p;
507   
508   key = read_key (fname);
509   if (!key)
510     return;
511
512   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
513   assert (keylen);
514   
515   if (opt_canonical)
516     {
517       fwrite (key, keylen, 1, stdout);
518     }
519   else
520     {
521       p = make_advanced (key, keylen);
522       if (p)
523         {
524           fwrite (p, strlen (p), 1, stdout);
525           xfree (p);
526         }
527     }
528   xfree (key);
529 }
530
531 static void
532 show_keygrip (const char *fname)
533 {
534   unsigned char *key;
535   gcry_sexp_t private;
536   unsigned char grip[20];
537   int i;
538   
539   key = read_key (fname);
540   if (!key)
541     return;
542
543   if (gcry_sexp_new (&private, key, 0, 0))
544     {
545       log_error ("gcry_sexp_new failed\n");
546       return;
547     } 
548   xfree (key);
549
550   if (!gcry_pk_get_keygrip (private, grip))
551     {
552       log_error ("can't calculate keygrip\n");
553       return;
554     }
555   gcry_sexp_release (private);
556
557   for (i=0; i < 20; i++)
558     printf ("%02X", grip[i]);
559   putchar ('\n');
560 }
561
562 \f
563 static int
564 rsa_key_check (struct rsa_secret_key_s *skey)
565 {
566   int err = 0;
567   gcry_mpi_t t = gcry_mpi_snew (0);
568   gcry_mpi_t t1 = gcry_mpi_snew (0);
569   gcry_mpi_t t2 = gcry_mpi_snew (0);
570   gcry_mpi_t phi = gcry_mpi_snew (0);
571
572   /* check that n == p * q */
573   gcry_mpi_mul (t, skey->p, skey->q);
574   if (gcry_mpi_cmp( t, skey->n) )
575     {
576       log_error ("RSA oops: n != p * q\n");
577       err++;
578     }
579
580   /* check that p is less than q */
581   if (gcry_mpi_cmp (skey->p, skey->q) > 0)
582     {
583       gcry_mpi_t tmp;
584
585       log_info ("swapping secret primes\n");
586       tmp = gcry_mpi_copy (skey->p);
587       gcry_mpi_set (skey->p, skey->q);
588       gcry_mpi_set (skey->q, tmp);
589       gcry_mpi_release (tmp);
590       /* and must recompute u of course */
591       gcry_mpi_invm (skey->u, skey->p, skey->q);
592     }
593
594   /* check that e divides neither p-1 nor q-1 */
595   gcry_mpi_sub_ui (t, skey->p, 1 );
596   gcry_mpi_div (NULL, t, t, skey->e, 0);
597   if (!gcry_mpi_cmp_ui( t, 0) )
598     {
599       log_error ("RSA oops: e divides p-1\n");
600       err++;
601     }
602   gcry_mpi_sub_ui (t, skey->q, 1);
603   gcry_mpi_div (NULL, t, t, skey->e, 0);
604   if (!gcry_mpi_cmp_ui( t, 0))
605     {
606       log_info ( "RSA oops: e divides q-1\n" );
607       err++;
608     }
609
610   /* check that d is correct. */
611   gcry_mpi_sub_ui (t1, skey->p, 1);
612   gcry_mpi_sub_ui (t2, skey->q, 1);
613   gcry_mpi_mul (phi, t1, t2);
614   gcry_mpi_invm (t, skey->e, phi);
615   if (gcry_mpi_cmp (t, skey->d))
616     { /* no: try universal exponent. */
617       gcry_mpi_gcd (t, t1, t2);
618       gcry_mpi_div (t, NULL, phi, t, 0);
619       gcry_mpi_invm (t, skey->e, t);
620       if (gcry_mpi_cmp (t, skey->d))
621         {
622           log_error ("RSA oops: bad secret exponent\n");
623           err++;
624         }
625     }
626
627   /* check for correctness of u */
628   gcry_mpi_invm (t, skey->p, skey->q);
629   if (gcry_mpi_cmp (t, skey->u))
630     {
631       log_info ( "RSA oops: bad u parameter\n");
632       err++;
633     }
634
635   if (err)
636     log_info ("RSA secret key check failed\n");
637
638   gcry_mpi_release (t);
639   gcry_mpi_release (t1);
640   gcry_mpi_release (t2);
641   gcry_mpi_release (phi);
642
643   return err? -1:0;
644 }
645
646
647 /* A callback used by p12_parse to return a certificate.  */
648 static void
649 import_p12_cert_cb (void *opaque, const unsigned char *cert, size_t certlen)
650 {
651   struct b64state state;
652   gpg_error_t err, err2;
653
654   err = b64enc_start (&state, stdout, "CERTIFICATE");
655   if (!err)
656     err = b64enc_write (&state, cert, certlen);
657   err2 = b64enc_finish (&state);
658   if (!err)
659     err = err2;
660   if (err)
661     log_error ("error writing armored certificate: %s\n", gpg_strerror (err));
662 }
663
664 static void
665 import_p12_file (const char *fname)
666 {
667   char *buf;
668   unsigned char *result;
669   size_t buflen, resultlen;
670   int i;
671   int rc;
672   gcry_mpi_t *kparms;
673   struct rsa_secret_key_s sk;
674   gcry_sexp_t s_key;
675   unsigned char *key;
676   unsigned char grip[20];
677   char *pw;
678
679   /* fixme: we should release some stuff on error */
680   
681   buf = read_file (fname, &buflen);
682   if (!buf)
683     return;
684
685   kparms = p12_parse (buf, buflen, (pw=get_passphrase (2)),
686                       import_p12_cert_cb, NULL);
687   release_passphrase (pw);
688   xfree (buf);
689   if (!kparms)
690     {
691       log_error ("error parsing or decrypting the PKCS-12 file\n");
692       return;
693     }
694   for (i=0; kparms[i]; i++)
695     ;
696   if (i != 8)
697     {
698       log_error ("invalid structure of private key\n");
699       return;
700     }
701
702
703 /*    print_mpi ("   n", kparms[0]); */
704 /*    print_mpi ("   e", kparms[1]); */
705 /*    print_mpi ("   d", kparms[2]); */
706 /*    print_mpi ("   p", kparms[3]); */
707 /*    print_mpi ("   q", kparms[4]); */
708 /*    print_mpi ("dmp1", kparms[5]); */
709 /*    print_mpi ("dmq1", kparms[6]); */
710 /*    print_mpi ("   u", kparms[7]); */
711
712   sk.n = kparms[0];
713   sk.e = kparms[1];
714   sk.d = kparms[2];
715   sk.q = kparms[3];
716   sk.p = kparms[4];
717   sk.u = kparms[7];
718   if (rsa_key_check (&sk))
719     return;
720 /*    print_mpi ("   n", sk.n); */
721 /*    print_mpi ("   e", sk.e); */
722 /*    print_mpi ("   d", sk.d); */
723 /*    print_mpi ("   p", sk.p); */
724 /*    print_mpi ("   q", sk.q); */
725 /*    print_mpi ("   u", sk.u); */
726
727   /* Create an S-expresion from the parameters. */
728   rc = gcry_sexp_build (&s_key, NULL,
729                         "(private-key(rsa(n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))",
730                         sk.n, sk.e, sk.d, sk.p, sk.q, sk.u, NULL);
731   for (i=0; i < 8; i++)
732     gcry_mpi_release (kparms[i]);
733   gcry_free (kparms);
734   if (rc)
735     {
736       log_error ("failed to created S-expression from key: %s\n",
737                  gpg_strerror (rc));
738       return;
739     }
740
741   /* Compute the keygrip. */
742   if (!gcry_pk_get_keygrip (s_key, grip))
743     {
744       log_error ("can't calculate keygrip\n");
745       return;
746     }
747   log_info ("keygrip: ");
748   for (i=0; i < 20; i++)
749     log_printf ("%02X", grip[i]);
750   log_printf ("\n");
751
752   /* Convert to canonical encoding. */
753   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, NULL, 0);
754   assert (buflen);
755   key = gcry_xmalloc_secure (buflen);
756   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, key, buflen);
757   assert (buflen);
758   gcry_sexp_release (s_key);
759
760
761   rc = agent_protect (key, (pw=get_new_passphrase (4)), &result, &resultlen);
762   release_passphrase (pw);
763   xfree (key);
764   if (rc)
765     {
766       log_error ("protecting the key failed: %s\n", gpg_strerror (rc));
767       return;
768     }
769   
770   if (opt_armor)
771     {
772       char *p = make_advanced (result, resultlen);
773       xfree (result);
774       if (!p)
775         return;
776       result = p;
777       resultlen = strlen (p);
778     }
779
780   if (opt_store)
781     store_private_key (grip, result, resultlen, opt_force);
782   else
783     fwrite (result, resultlen, 1, stdout);
784
785   xfree (result);
786 }
787
788 \f
789
790 static gcry_mpi_t *
791 sexp_to_kparms (gcry_sexp_t sexp)
792 {
793   gcry_sexp_t list, l2;
794   const char *name;
795   const char *s;
796   size_t n;
797   int i, idx;
798   const char *elems;
799   gcry_mpi_t *array;
800
801   list = gcry_sexp_find_token (sexp, "private-key", 0 );
802   if(!list)
803     return NULL; 
804   l2 = gcry_sexp_cadr (list);
805   gcry_sexp_release (list);
806   list = l2;
807   name = gcry_sexp_nth_data (list, 0, &n);
808   if(!name || n != 3 || memcmp (name, "rsa", 3))
809     {
810       gcry_sexp_release (list);
811       return NULL;
812     }
813
814   /* Parameter names used with RSA. */
815   elems = "nedpqu";
816   array = xcalloc (strlen(elems) + 1, sizeof *array);
817   for (idx=0, s=elems; *s; s++, idx++ ) 
818     {
819       l2 = gcry_sexp_find_token (list, s, 1);
820       if (!l2)
821         {
822           for (i=0; i<idx; i++)
823             gcry_mpi_release (array[i]);
824           xfree (array);
825           gcry_sexp_release (list);
826           return NULL; /* required parameter not found */
827         }
828       array[idx] = gcry_sexp_nth_mpi (l2, 1, GCRYMPI_FMT_USG);
829       gcry_sexp_release (l2);
830       if (!array[idx])
831         {
832           for (i=0; i<idx; i++)
833             gcry_mpi_release (array[i]);
834           xfree (array);
835           gcry_sexp_release (list);
836           return NULL; /* required parameter is invalid */
837         }
838     }
839   
840   gcry_sexp_release (list);
841   return array;
842 }
843
844
845 /* Check whether STRING is a KEYGRIP, i.e has the correct length and
846    does only consist of uppercase hex characters. */
847 static int
848 is_keygrip (const char *string)
849 {
850   int i;
851
852   for(i=0; string[i] && i < 41; i++) 
853     if (!strchr("01234567890ABCDEF", string[i]))
854       return 0; 
855   return i == 40;
856 }
857
858
859 static void
860 export_p12_file (const char *fname)
861 {
862   int rc;
863   gcry_mpi_t kparms[9], *kp;
864   unsigned char *key;
865   size_t keylen;
866   gcry_sexp_t private;
867   struct rsa_secret_key_s sk;
868   int i;
869   unsigned char *cert = NULL;
870   size_t certlen = 0;
871   int keytype;
872   size_t keylen_for_wipe = 0;
873   char *pw;
874
875   if ( is_keygrip (fname) )
876     {
877       char hexgrip[40+4+1];
878       char *p;
879   
880       assert (strlen(fname) == 40);
881       strcpy (stpcpy (hexgrip, fname), ".key");
882
883       p = make_filename (opt_homedir, GNUPG_PRIVATE_KEYS_DIR, hexgrip, NULL);
884       key = read_key (p);
885       xfree (p);
886     }
887   else
888     key = read_key (fname);
889
890   if (!key)
891     return;
892
893   keytype = agent_private_key_type (key);
894   if (keytype == PRIVATE_KEY_PROTECTED)
895     {
896       unsigned char *tmpkey;
897       size_t tmplen;
898
899       rc = agent_unprotect (key, (pw=get_passphrase (1)), &tmpkey, &tmplen);
900       release_passphrase (pw);
901       if (rc)
902         {
903           if (opt_status_msg && gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE )
904             log_info ("[PROTECT-TOOL:] bad-passphrase\n");
905           log_error ("unprotecting key `%s' failed: %s\n",
906                      fname, gpg_strerror (rc));
907           xfree (key);
908           return;
909         }
910       xfree (key);
911       key = tmpkey;
912       keylen_for_wipe = tmplen;
913
914       keytype = agent_private_key_type (key);
915     }
916
917   if (keytype == PRIVATE_KEY_SHADOWED)
918     {
919       log_error ("`%s' is a shadowed private key - can't export it\n", fname);
920       wipememory (key, keylen_for_wipe);
921       xfree (key);
922       return;
923     }
924   else if (keytype != PRIVATE_KEY_CLEAR)
925     {
926       log_error ("\%s' is not a private key\n", fname);
927       wipememory (key, keylen_for_wipe);
928       xfree (key);
929       return;
930     }
931
932
933   if (opt_have_cert)
934     {
935       cert = read_file ("-", &certlen);
936       if (!cert)
937         {
938           wipememory (key, keylen_for_wipe);
939           xfree (key);
940           return;
941         }
942     }
943
944
945   if (gcry_sexp_new (&private, key, 0, 0))
946     {
947       log_error ("gcry_sexp_new failed\n");
948       wipememory (key, keylen_for_wipe);
949       xfree (key);
950       xfree (cert);
951       return;
952     } 
953   wipememory (key, keylen_for_wipe);
954   xfree (key);
955
956   kp = sexp_to_kparms (private);
957   gcry_sexp_release (private);
958   if (!kp)
959     {
960       log_error ("error converting key parameters\n");
961       xfree (cert);
962       return;
963     } 
964   sk.n = kp[0];
965   sk.e = kp[1];
966   sk.d = kp[2];
967   sk.p = kp[3];
968   sk.q = kp[4];
969   sk.u = kp[5];
970   xfree (kp);
971
972  
973   kparms[0] = sk.n;
974   kparms[1] = sk.e;
975   kparms[2] = sk.d;
976   kparms[3] = sk.q;
977   kparms[4] = sk.p;
978   kparms[5] = gcry_mpi_snew (0);  /* compute d mod (p-1) */
979   gcry_mpi_sub_ui (kparms[5], kparms[3], 1);
980   gcry_mpi_mod (kparms[5], sk.d, kparms[5]);   
981   kparms[6] = gcry_mpi_snew (0);  /* compute d mod (q-1) */
982   gcry_mpi_sub_ui (kparms[6], kparms[4], 1);
983   gcry_mpi_mod (kparms[6], sk.d, kparms[6]);   
984   kparms[7] = sk.u;
985   kparms[8] = NULL;
986
987   key = p12_build (kparms, cert, certlen,
988                    (pw=get_new_passphrase (3)), &keylen);
989   release_passphrase (pw);
990   xfree (cert);
991   for (i=0; i < 8; i++)
992     gcry_mpi_release (kparms[i]);
993   if (!key)
994     return;
995   
996 #ifdef HAVE_DOSISH_SYSTEM
997   setmode ( fileno (stdout) , O_BINARY );
998 #endif
999   fwrite (key, keylen, 1, stdout);
1000   xfree (key);
1001 }
1002
1003
1004
1005 /* Do the percent and plus/space unescaping in place and return the
1006    length of the valid buffer. */
1007 static size_t
1008 percent_plus_unescape (unsigned char *string)
1009 {
1010   unsigned char *p = string;
1011   size_t n = 0;
1012
1013   while (*string)
1014     {
1015       if (*string == '%' && string[1] && string[2])
1016         { 
1017           string++;
1018           *p++ = xtoi_2 (string);
1019           n++;
1020           string+= 2;
1021         }
1022       else if (*string == '+')
1023         {
1024           *p++ = ' ';
1025           n++;
1026           string++;
1027         }
1028       else
1029         {
1030           *p++ = *string++;
1031           n++;
1032         }
1033     }
1034
1035   return n;
1036 }
1037
1038 /* Remove percent and plus escaping and make sure that the reuslt is a
1039    string.  This is done in place. Returns STRING. */
1040 static char *
1041 percent_plus_unescape_string (char *string) 
1042 {
1043   unsigned char *p = string;
1044   size_t n;
1045
1046   n = percent_plus_unescape (p);
1047   p[n] = 0;
1048
1049   return string;
1050 }
1051
1052 \f
1053 int
1054 main (int argc, char **argv )
1055 {
1056   ARGPARSE_ARGS pargs;
1057   int cmd = 0;
1058   const char *fname;
1059
1060   set_strusage (my_strusage);
1061   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
1062   log_set_prefix ("gpg-protect-tool", 1); 
1063
1064   /* Try to auto set the character set.  */
1065   set_native_charset (NULL); 
1066
1067   i18n_init ();
1068
1069   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
1070     {
1071       log_fatal( _("libgcrypt is too old (need %s, have %s)\n"),
1072                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
1073     }
1074
1075   gcry_set_log_handler (my_gcry_logger, NULL);
1076   
1077   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
1078
1079
1080   opt_homedir = default_homedir ();
1081
1082
1083   pargs.argc = &argc;
1084   pargs.argv = &argv;
1085   pargs.flags=  1;  /* (do not remove the args) */
1086   while (arg_parse (&pargs, opts) )
1087     {
1088       switch (pargs.r_opt)
1089         {
1090         case oVerbose: opt.verbose++; break;
1091         case oArmor:   opt_armor=1; break;
1092         case oCanonical: opt_canonical=1; break;
1093         case oHomedir: opt_homedir = pargs.r.ret_str; break;
1094
1095         case oProtect: cmd = oProtect; break;
1096         case oUnprotect: cmd = oUnprotect; break;
1097         case oShadow: cmd = oShadow; break;
1098         case oShowShadowInfo: cmd = oShowShadowInfo; break;
1099         case oShowKeygrip: cmd = oShowKeygrip; break;
1100         case oP12Import: cmd = oP12Import; break;
1101         case oP12Export: cmd = oP12Export; break;
1102
1103         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
1104         case oStore: opt_store = 1; break;
1105         case oForce: opt_force = 1; break;
1106         case oNoFailOnExist: opt_no_fail_on_exist = 1; break;
1107         case oHaveCert: opt_have_cert = 1; break;
1108         case oPrompt: opt_prompt = pargs.r.ret_str; break;
1109         case oStatusMsg: opt_status_msg = 1; break;
1110           
1111         default : pargs.err = 2; break;
1112         }
1113     }
1114   if (log_get_errorcount(0))
1115     exit(2);
1116
1117   fname = "-";
1118   if (argc == 1)
1119     fname = *argv;
1120   else if (argc > 1)
1121     usage (1);
1122
1123   if (opt_prompt)
1124     opt_prompt = percent_plus_unescape_string (xstrdup (opt_prompt));
1125
1126   if (cmd == oProtect)
1127     read_and_protect (fname);
1128   else if (cmd == oUnprotect)
1129     read_and_unprotect (fname);
1130   else if (cmd == oShadow)
1131     read_and_shadow (fname);
1132   else if (cmd == oShowShadowInfo)
1133     show_shadow_info (fname);
1134   else if (cmd == oShowKeygrip)
1135     show_keygrip (fname);
1136   else if (cmd == oP12Import)
1137     import_p12_file (fname);
1138   else if (cmd == oP12Export)
1139     export_p12_file (fname);
1140   else
1141     show_file (fname);
1142
1143   agent_exit (0);
1144   return 8; /*NOTREACHED*/
1145 }
1146
1147 void
1148 agent_exit (int rc)
1149 {
1150   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
1151   exit (rc);
1152 }
1153
1154
1155 /* Return the passphrase string and ask the agent if it has not been
1156    set from the command line  PROMPTNO select the prompt to display:
1157      0 = default
1158      1 = taken from the option --prompt
1159      2 = for unprotecting a pkcs#12 object
1160      3 = for protecting a new pkcs#12 object
1161      4 = for protecting an imported pkcs#12 in our system
1162      5 = reenter the passphrase
1163    When adding 100 to the values, a "does not match - try again" errro message is shown.
1164 */
1165 static char *
1166 get_passphrase (int promptno)
1167 {
1168   char *pw;
1169   int err;
1170   const char *desc;
1171 #ifdef HAVE_LANGINFO_CODESET
1172   char *orig_codeset = NULL;
1173 #endif
1174   int error_msgno;
1175   
1176
1177   if (opt_passphrase)
1178     return xstrdup (opt_passphrase);
1179
1180   error_msgno = promptno / 100;
1181   promptno %= 100;
1182
1183 #ifdef ENABLE_NLS
1184   /* The Assuan agent protocol requires us to transmit utf-8 strings */
1185   orig_codeset = bind_textdomain_codeset (PACKAGE_GT, NULL);
1186 #ifdef HAVE_LANGINFO_CODESET
1187   if (!orig_codeset)
1188     orig_codeset = nl_langinfo (CODESET);
1189 #endif
1190   if (orig_codeset && !strcmp (orig_codeset, "UTF-8"))
1191     orig_codeset = NULL;
1192   if (orig_codeset)
1193     {
1194       /* We only switch when we are able to restore the codeset later. */
1195       orig_codeset = xstrdup (orig_codeset);
1196       if (!bind_textdomain_codeset (PACKAGE_GT, "utf-8"))
1197         orig_codeset = NULL; 
1198     }
1199 #endif
1200
1201   if (promptno == 1 && opt_prompt)
1202     desc = opt_prompt;
1203   else if (promptno == 2)
1204     desc = _("Please enter the passphrase to unprotect the "
1205              "PKCS#12 object.");
1206   else if (promptno == 3)
1207     desc = _("Please enter the passphrase to protect the "
1208              "new PKCS#12 object.");
1209   else if (promptno == 4)
1210     desc = _("Please enter the passphrase to protect the "
1211              "imported object within the GnuPG system.");
1212   else if (promptno == 5)
1213     desc = _("Please re-enter this passphrase");
1214   else
1215     desc = _("Please enter the passphrase or the PIN\n"
1216              "needed to complete this operation.");
1217
1218   pw = simple_pwquery (NULL,
1219                        error_msgno == 1? _("does not match - try again"):NULL,
1220                        _("Passphrase:"), desc, &err);
1221
1222 #ifdef ENABLE_NLS
1223   if (orig_codeset)
1224     {
1225       bind_textdomain_codeset (PACKAGE_GT, orig_codeset);
1226       xfree (orig_codeset);
1227     }
1228 #endif
1229
1230   if (!pw)
1231     {
1232       if (err)
1233         log_error (_("error while asking for the passphrase: %s\n"),
1234                    gpg_strerror (err));
1235       else
1236         log_info (_("cancelled\n"));
1237       agent_exit (0);
1238     }
1239
1240   return pw;
1241 }
1242
1243
1244 /* Same as get_passphrase but requests it a second time and compares
1245    it to the one entered the first time. */
1246 static char *
1247 get_new_passphrase (int promptno)
1248 {
1249   char *pw;
1250   int i, secondpromptno;
1251   
1252   pw = get_passphrase (promptno);
1253   if (!pw)
1254     return NULL; /* Canceled. */
1255   if (!*pw)
1256     return pw; /* Empty passphrase - no need to as for repeating it. */
1257
1258   secondpromptno = 5;
1259   for (i=0; i < 3; i++)
1260     {
1261       char *pw2 = get_passphrase (secondpromptno);
1262       if (!pw2)
1263         {
1264           xfree (pw);
1265           return NULL; /* Canceled.  */
1266         }
1267       if (!strcmp (pw, pw2))
1268         {
1269           xfree (pw2);
1270           return pw; /* Okay. */
1271         }
1272       secondpromptno = 105;
1273       xfree (pw2);
1274     }
1275   xfree (pw);
1276   return NULL; /* 3 times repeated wrong - cancel.  */
1277 }
1278
1279
1280
1281 static void
1282 release_passphrase (char *pw)
1283 {
1284   if (pw)
1285     {
1286       wipememory (pw, strlen (pw));
1287       xfree (pw);
1288     }
1289 }
1290
1291 static int
1292 store_private_key (const unsigned char *grip,
1293                    const void *buffer, size_t length, int force)
1294 {
1295   int i;
1296   char *fname;
1297   FILE *fp;
1298   char hexgrip[40+4+1];
1299   
1300   for (i=0; i < 20; i++)
1301     sprintf (hexgrip+2*i, "%02X", grip[i]);
1302   strcpy (hexgrip+40, ".key");
1303
1304   fname = make_filename (opt_homedir, GNUPG_PRIVATE_KEYS_DIR, hexgrip, NULL);
1305   if (force)
1306     fp = fopen (fname, "wb");
1307   else
1308     {
1309       if (!access (fname, F_OK))
1310       {
1311         if (opt_status_msg)
1312           log_info ("[PROTECT-TOOL:] secretkey-exists\n");
1313         if (opt_no_fail_on_exist)
1314           log_info ("secret key file `%s' already exists\n", fname);
1315         else
1316           log_error ("secret key file `%s' already exists\n", fname);
1317         xfree (fname);
1318         return opt_no_fail_on_exist? 0 : -1;
1319       }
1320       fp = fopen (fname, "wbx");  /* FIXME: the x is a GNU extension - let
1321                                      configure check whether this actually
1322                                      works */
1323     }
1324
1325   if (!fp) 
1326     { 
1327       log_error ("can't create `%s': %s\n", fname, strerror (errno));
1328       xfree (fname);
1329       return -1;
1330     }
1331
1332   if (fwrite (buffer, length, 1, fp) != 1)
1333     {
1334       log_error ("error writing `%s': %s\n", fname, strerror (errno));
1335       fclose (fp);
1336       remove (fname);
1337       xfree (fname);
1338       return -1;
1339     }
1340   if ( fclose (fp) )
1341     {
1342       log_error ("error closing `%s': %s\n", fname, strerror (errno));
1343       remove (fname);
1344       xfree (fname);
1345       return -1;
1346     }
1347   log_info ("secret key stored as `%s'\n", fname);
1348
1349   if (opt_status_msg)
1350     log_info ("[PROTECT-TOOL:] secretkey-stored\n");
1351
1352   xfree (fname);
1353   return 0;
1354 }