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