5f59d5e066b525d0139b588d021bc423871be07a
[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   char *result;
243
244   rc = gcry_sexp_sscan (&sexp, &erroff, (const char*)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 = (unsigned char*)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 = (unsigned char*)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   unsigned char dummy_info[] = "(8:313233342:43)";
438   
439   key = read_key (fname);
440   if (!key)
441     return;
442
443   rc = agent_shadow_key (key, dummy_info, &result);
444   xfree (key);
445   if (rc)
446     {
447       log_error ("shadowing the key failed: %s\n", gpg_strerror (rc));
448       return;
449     }
450   resultlen = gcry_sexp_canon_len (result, 0, NULL,NULL);
451   assert (resultlen);
452   
453   if (opt_armor)
454     {
455       char *p = make_advanced (result, resultlen);
456       xfree (result);
457       if (!p)
458         return;
459       result = (unsigned char*)p;
460       resultlen = strlen (p);
461     }
462
463   fwrite (result, resultlen, 1, stdout);
464   xfree (result);
465 }
466
467 static void
468 show_shadow_info (const char *fname)
469 {
470   int  rc;
471   unsigned char *key;
472   const unsigned char *info;
473   size_t infolen;
474   
475   key = read_key (fname);
476   if (!key)
477     return;
478
479   rc = agent_get_shadow_info (key, &info);
480   xfree (key);
481   if (rc)
482     {
483       log_error ("get_shadow_info failed: %s\n", gpg_strerror (rc));
484       return;
485     }
486   infolen = gcry_sexp_canon_len (info, 0, NULL,NULL);
487   assert (infolen);
488   
489   if (opt_armor)
490     {
491       char *p = make_advanced (info, infolen);
492       if (!p)
493         return;
494       fwrite (p, strlen (p), 1, stdout);
495       xfree (p);
496     }
497   else
498     fwrite (info, infolen, 1, stdout);
499 }
500
501
502 static void
503 show_file (const char *fname)
504 {
505   unsigned char *key;
506   size_t keylen;
507   char *p;
508   
509   key = read_key (fname);
510   if (!key)
511     return;
512
513   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
514   assert (keylen);
515   
516   if (opt_canonical)
517     {
518       fwrite (key, keylen, 1, stdout);
519     }
520   else
521     {
522       p = make_advanced (key, keylen);
523       if (p)
524         {
525           fwrite (p, strlen (p), 1, stdout);
526           xfree (p);
527         }
528     }
529   xfree (key);
530 }
531
532 static void
533 show_keygrip (const char *fname)
534 {
535   unsigned char *key;
536   gcry_sexp_t private;
537   unsigned char grip[20];
538   int i;
539   
540   key = read_key (fname);
541   if (!key)
542     return;
543
544   if (gcry_sexp_new (&private, key, 0, 0))
545     {
546       log_error ("gcry_sexp_new failed\n");
547       return;
548     } 
549   xfree (key);
550
551   if (!gcry_pk_get_keygrip (private, grip))
552     {
553       log_error ("can't calculate keygrip\n");
554       return;
555     }
556   gcry_sexp_release (private);
557
558   for (i=0; i < 20; i++)
559     printf ("%02X", grip[i]);
560   putchar ('\n');
561 }
562
563 \f
564 static int
565 rsa_key_check (struct rsa_secret_key_s *skey)
566 {
567   int err = 0;
568   gcry_mpi_t t = gcry_mpi_snew (0);
569   gcry_mpi_t t1 = gcry_mpi_snew (0);
570   gcry_mpi_t t2 = gcry_mpi_snew (0);
571   gcry_mpi_t phi = gcry_mpi_snew (0);
572
573   /* check that n == p * q */
574   gcry_mpi_mul (t, skey->p, skey->q);
575   if (gcry_mpi_cmp( t, skey->n) )
576     {
577       log_error ("RSA oops: n != p * q\n");
578       err++;
579     }
580
581   /* check that p is less than q */
582   if (gcry_mpi_cmp (skey->p, skey->q) > 0)
583     {
584       gcry_mpi_t tmp;
585
586       log_info ("swapping secret primes\n");
587       tmp = gcry_mpi_copy (skey->p);
588       gcry_mpi_set (skey->p, skey->q);
589       gcry_mpi_set (skey->q, tmp);
590       gcry_mpi_release (tmp);
591       /* and must recompute u of course */
592       gcry_mpi_invm (skey->u, skey->p, skey->q);
593     }
594
595   /* check that e divides neither p-1 nor q-1 */
596   gcry_mpi_sub_ui (t, skey->p, 1 );
597   gcry_mpi_div (NULL, t, t, skey->e, 0);
598   if (!gcry_mpi_cmp_ui( t, 0) )
599     {
600       log_error ("RSA oops: e divides p-1\n");
601       err++;
602     }
603   gcry_mpi_sub_ui (t, skey->q, 1);
604   gcry_mpi_div (NULL, t, t, skey->e, 0);
605   if (!gcry_mpi_cmp_ui( t, 0))
606     {
607       log_info ( "RSA oops: e divides q-1\n" );
608       err++;
609     }
610
611   /* check that d is correct. */
612   gcry_mpi_sub_ui (t1, skey->p, 1);
613   gcry_mpi_sub_ui (t2, skey->q, 1);
614   gcry_mpi_mul (phi, t1, t2);
615   gcry_mpi_invm (t, skey->e, phi);
616   if (gcry_mpi_cmp (t, skey->d))
617     { /* no: try universal exponent. */
618       gcry_mpi_gcd (t, t1, t2);
619       gcry_mpi_div (t, NULL, phi, t, 0);
620       gcry_mpi_invm (t, skey->e, t);
621       if (gcry_mpi_cmp (t, skey->d))
622         {
623           log_error ("RSA oops: bad secret exponent\n");
624           err++;
625         }
626     }
627
628   /* check for correctness of u */
629   gcry_mpi_invm (t, skey->p, skey->q);
630   if (gcry_mpi_cmp (t, skey->u))
631     {
632       log_info ( "RSA oops: bad u parameter\n");
633       err++;
634     }
635
636   if (err)
637     log_info ("RSA secret key check failed\n");
638
639   gcry_mpi_release (t);
640   gcry_mpi_release (t1);
641   gcry_mpi_release (t2);
642   gcry_mpi_release (phi);
643
644   return err? -1:0;
645 }
646
647
648 /* A callback used by p12_parse to return a certificate.  */
649 static void
650 import_p12_cert_cb (void *opaque, const unsigned char *cert, size_t certlen)
651 {
652   struct b64state state;
653   gpg_error_t err, err2;
654
655   err = b64enc_start (&state, stdout, "CERTIFICATE");
656   if (!err)
657     err = b64enc_write (&state, cert, certlen);
658   err2 = b64enc_finish (&state);
659   if (!err)
660     err = err2;
661   if (err)
662     log_error ("error writing armored certificate: %s\n", gpg_strerror (err));
663 }
664
665 static void
666 import_p12_file (const char *fname)
667 {
668   char *buf;
669   unsigned char *result;
670   size_t buflen, resultlen;
671   int i;
672   int rc;
673   gcry_mpi_t *kparms;
674   struct rsa_secret_key_s sk;
675   gcry_sexp_t s_key;
676   unsigned char *key;
677   unsigned char grip[20];
678   char *pw;
679
680   /* fixme: we should release some stuff on error */
681   
682   buf = read_file (fname, &buflen);
683   if (!buf)
684     return;
685
686   kparms = p12_parse ((unsigned char*)buf, buflen, (pw=get_passphrase (2)),
687                       import_p12_cert_cb, NULL);
688   release_passphrase (pw);
689   xfree (buf);
690   if (!kparms)
691     {
692       log_error ("error parsing or decrypting the PKCS-12 file\n");
693       return;
694     }
695   for (i=0; kparms[i]; i++)
696     ;
697   if (i != 8)
698     {
699       log_error ("invalid structure of private key\n");
700       return;
701     }
702
703
704 /*    print_mpi ("   n", kparms[0]); */
705 /*    print_mpi ("   e", kparms[1]); */
706 /*    print_mpi ("   d", kparms[2]); */
707 /*    print_mpi ("   p", kparms[3]); */
708 /*    print_mpi ("   q", kparms[4]); */
709 /*    print_mpi ("dmp1", kparms[5]); */
710 /*    print_mpi ("dmq1", kparms[6]); */
711 /*    print_mpi ("   u", kparms[7]); */
712
713   sk.n = kparms[0];
714   sk.e = kparms[1];
715   sk.d = kparms[2];
716   sk.q = kparms[3];
717   sk.p = kparms[4];
718   sk.u = kparms[7];
719   if (rsa_key_check (&sk))
720     return;
721 /*    print_mpi ("   n", sk.n); */
722 /*    print_mpi ("   e", sk.e); */
723 /*    print_mpi ("   d", sk.d); */
724 /*    print_mpi ("   p", sk.p); */
725 /*    print_mpi ("   q", sk.q); */
726 /*    print_mpi ("   u", sk.u); */
727
728   /* Create an S-expresion from the parameters. */
729   rc = gcry_sexp_build (&s_key, NULL,
730                         "(private-key(rsa(n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))",
731                         sk.n, sk.e, sk.d, sk.p, sk.q, sk.u, NULL);
732   for (i=0; i < 8; i++)
733     gcry_mpi_release (kparms[i]);
734   gcry_free (kparms);
735   if (rc)
736     {
737       log_error ("failed to created S-expression from key: %s\n",
738                  gpg_strerror (rc));
739       return;
740     }
741
742   /* Compute the keygrip. */
743   if (!gcry_pk_get_keygrip (s_key, grip))
744     {
745       log_error ("can't calculate keygrip\n");
746       return;
747     }
748   log_info ("keygrip: ");
749   for (i=0; i < 20; i++)
750     log_printf ("%02X", grip[i]);
751   log_printf ("\n");
752
753   /* Convert to canonical encoding. */
754   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, NULL, 0);
755   assert (buflen);
756   key = gcry_xmalloc_secure (buflen);
757   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, key, buflen);
758   assert (buflen);
759   gcry_sexp_release (s_key);
760
761
762   rc = agent_protect (key, (pw=get_new_passphrase (4)), &result, &resultlen);
763   release_passphrase (pw);
764   xfree (key);
765   if (rc)
766     {
767       log_error ("protecting the key failed: %s\n", gpg_strerror (rc));
768       return;
769     }
770   
771   if (opt_armor)
772     {
773       char *p = make_advanced (result, resultlen);
774       xfree (result);
775       if (!p)
776         return;
777       result = (unsigned char*)p;
778       resultlen = strlen (p);
779     }
780
781   if (opt_store)
782     store_private_key (grip, result, resultlen, opt_force);
783   else
784     fwrite (result, resultlen, 1, stdout);
785
786   xfree (result);
787 }
788
789 \f
790
791 static gcry_mpi_t *
792 sexp_to_kparms (gcry_sexp_t sexp)
793 {
794   gcry_sexp_t list, l2;
795   const char *name;
796   const char *s;
797   size_t n;
798   int i, idx;
799   const char *elems;
800   gcry_mpi_t *array;
801
802   list = gcry_sexp_find_token (sexp, "private-key", 0 );
803   if(!list)
804     return NULL; 
805   l2 = gcry_sexp_cadr (list);
806   gcry_sexp_release (list);
807   list = l2;
808   name = gcry_sexp_nth_data (list, 0, &n);
809   if(!name || n != 3 || memcmp (name, "rsa", 3))
810     {
811       gcry_sexp_release (list);
812       return NULL;
813     }
814
815   /* Parameter names used with RSA. */
816   elems = "nedpqu";
817   array = xcalloc (strlen(elems) + 1, sizeof *array);
818   for (idx=0, s=elems; *s; s++, idx++ ) 
819     {
820       l2 = gcry_sexp_find_token (list, s, 1);
821       if (!l2)
822         {
823           for (i=0; i<idx; i++)
824             gcry_mpi_release (array[i]);
825           xfree (array);
826           gcry_sexp_release (list);
827           return NULL; /* required parameter not found */
828         }
829       array[idx] = gcry_sexp_nth_mpi (l2, 1, GCRYMPI_FMT_USG);
830       gcry_sexp_release (l2);
831       if (!array[idx])
832         {
833           for (i=0; i<idx; i++)
834             gcry_mpi_release (array[i]);
835           xfree (array);
836           gcry_sexp_release (list);
837           return NULL; /* required parameter is invalid */
838         }
839     }
840   
841   gcry_sexp_release (list);
842   return array;
843 }
844
845
846 /* Check whether STRING is a KEYGRIP, i.e has the correct length and
847    does only consist of uppercase hex characters. */
848 static int
849 is_keygrip (const char *string)
850 {
851   int i;
852
853   for(i=0; string[i] && i < 41; i++) 
854     if (!strchr("01234567890ABCDEF", string[i]))
855       return 0; 
856   return i == 40;
857 }
858
859
860 static void
861 export_p12_file (const char *fname)
862 {
863   int rc;
864   gcry_mpi_t kparms[9], *kp;
865   unsigned char *key;
866   size_t keylen;
867   gcry_sexp_t private;
868   struct rsa_secret_key_s sk;
869   int i;
870   unsigned char *cert = NULL;
871   size_t certlen = 0;
872   int keytype;
873   size_t keylen_for_wipe = 0;
874   char *pw;
875
876   if ( is_keygrip (fname) )
877     {
878       char hexgrip[40+4+1];
879       char *p;
880   
881       assert (strlen(fname) == 40);
882       strcpy (stpcpy (hexgrip, fname), ".key");
883
884       p = make_filename (opt_homedir, GNUPG_PRIVATE_KEYS_DIR, hexgrip, NULL);
885       key = read_key (p);
886       xfree (p);
887     }
888   else
889     key = read_key (fname);
890
891   if (!key)
892     return;
893
894   keytype = agent_private_key_type (key);
895   if (keytype == PRIVATE_KEY_PROTECTED)
896     {
897       unsigned char *tmpkey;
898       size_t tmplen;
899
900       rc = agent_unprotect (key, (pw=get_passphrase (1)), &tmpkey, &tmplen);
901       release_passphrase (pw);
902       if (rc)
903         {
904           if (opt_status_msg && gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE )
905             log_info ("[PROTECT-TOOL:] bad-passphrase\n");
906           log_error ("unprotecting key `%s' failed: %s\n",
907                      fname, gpg_strerror (rc));
908           xfree (key);
909           return;
910         }
911       xfree (key);
912       key = tmpkey;
913       keylen_for_wipe = tmplen;
914
915       keytype = agent_private_key_type (key);
916     }
917
918   if (keytype == PRIVATE_KEY_SHADOWED)
919     {
920       log_error ("`%s' is a shadowed private key - can't export it\n", fname);
921       wipememory (key, keylen_for_wipe);
922       xfree (key);
923       return;
924     }
925   else if (keytype != PRIVATE_KEY_CLEAR)
926     {
927       log_error ("\%s' is not a private key\n", fname);
928       wipememory (key, keylen_for_wipe);
929       xfree (key);
930       return;
931     }
932
933
934   if (opt_have_cert)
935     {
936       cert = (unsigned char*)read_file ("-", &certlen);
937       if (!cert)
938         {
939           wipememory (key, keylen_for_wipe);
940           xfree (key);
941           return;
942         }
943     }
944
945
946   if (gcry_sexp_new (&private, key, 0, 0))
947     {
948       log_error ("gcry_sexp_new failed\n");
949       wipememory (key, keylen_for_wipe);
950       xfree (key);
951       xfree (cert);
952       return;
953     } 
954   wipememory (key, keylen_for_wipe);
955   xfree (key);
956
957   kp = sexp_to_kparms (private);
958   gcry_sexp_release (private);
959   if (!kp)
960     {
961       log_error ("error converting key parameters\n");
962       xfree (cert);
963       return;
964     } 
965   sk.n = kp[0];
966   sk.e = kp[1];
967   sk.d = kp[2];
968   sk.p = kp[3];
969   sk.q = kp[4];
970   sk.u = kp[5];
971   xfree (kp);
972
973  
974   kparms[0] = sk.n;
975   kparms[1] = sk.e;
976   kparms[2] = sk.d;
977   kparms[3] = sk.q;
978   kparms[4] = sk.p;
979   kparms[5] = gcry_mpi_snew (0);  /* compute d mod (p-1) */
980   gcry_mpi_sub_ui (kparms[5], kparms[3], 1);
981   gcry_mpi_mod (kparms[5], sk.d, kparms[5]);   
982   kparms[6] = gcry_mpi_snew (0);  /* compute d mod (q-1) */
983   gcry_mpi_sub_ui (kparms[6], kparms[4], 1);
984   gcry_mpi_mod (kparms[6], sk.d, kparms[6]);   
985   kparms[7] = sk.u;
986   kparms[8] = NULL;
987
988   key = p12_build (kparms, cert, certlen,
989                    (pw=get_new_passphrase (3)), &keylen);
990   release_passphrase (pw);
991   xfree (cert);
992   for (i=0; i < 8; i++)
993     gcry_mpi_release (kparms[i]);
994   if (!key)
995     return;
996   
997 #ifdef HAVE_DOSISH_SYSTEM
998   setmode ( fileno (stdout) , O_BINARY );
999 #endif
1000   fwrite (key, keylen, 1, stdout);
1001   xfree (key);
1002 }
1003
1004
1005
1006 /* Do the percent and plus/space unescaping in place and return the
1007    length of the valid buffer. */
1008 static size_t
1009 percent_plus_unescape (unsigned char *string)
1010 {
1011   unsigned char *p = string;
1012   size_t n = 0;
1013
1014   while (*string)
1015     {
1016       if (*string == '%' && string[1] && string[2])
1017         { 
1018           string++;
1019           *p++ = xtoi_2 (string);
1020           n++;
1021           string+= 2;
1022         }
1023       else if (*string == '+')
1024         {
1025           *p++ = ' ';
1026           n++;
1027           string++;
1028         }
1029       else
1030         {
1031           *p++ = *string++;
1032           n++;
1033         }
1034     }
1035
1036   return n;
1037 }
1038
1039 /* Remove percent and plus escaping and make sure that the reuslt is a
1040    string.  This is done in place. Returns STRING. */
1041 static char *
1042 percent_plus_unescape_string (char *string) 
1043 {
1044   unsigned char *p = (unsigned char*)string;
1045   size_t n;
1046
1047   n = percent_plus_unescape (p);
1048   p[n] = 0;
1049
1050   return string;
1051 }
1052
1053 \f
1054 int
1055 main (int argc, char **argv )
1056 {
1057   ARGPARSE_ARGS pargs;
1058   int cmd = 0;
1059   const char *fname;
1060
1061   set_strusage (my_strusage);
1062   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
1063   log_set_prefix ("gpg-protect-tool", 1); 
1064
1065   /* Try to auto set the character set.  */
1066   set_native_charset (NULL); 
1067
1068   i18n_init ();
1069
1070   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
1071     {
1072       log_fatal( _("libgcrypt is too old (need %s, have %s)\n"),
1073                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
1074     }
1075
1076   gcry_set_log_handler (my_gcry_logger, NULL);
1077   
1078   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
1079
1080
1081   opt_homedir = default_homedir ();
1082
1083
1084   pargs.argc = &argc;
1085   pargs.argv = &argv;
1086   pargs.flags=  1;  /* (do not remove the args) */
1087   while (arg_parse (&pargs, opts) )
1088     {
1089       switch (pargs.r_opt)
1090         {
1091         case oVerbose: opt.verbose++; break;
1092         case oArmor:   opt_armor=1; break;
1093         case oCanonical: opt_canonical=1; break;
1094         case oHomedir: opt_homedir = pargs.r.ret_str; break;
1095
1096         case oProtect: cmd = oProtect; break;
1097         case oUnprotect: cmd = oUnprotect; break;
1098         case oShadow: cmd = oShadow; break;
1099         case oShowShadowInfo: cmd = oShowShadowInfo; break;
1100         case oShowKeygrip: cmd = oShowKeygrip; break;
1101         case oP12Import: cmd = oP12Import; break;
1102         case oP12Export: cmd = oP12Export; break;
1103
1104         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
1105         case oStore: opt_store = 1; break;
1106         case oForce: opt_force = 1; break;
1107         case oNoFailOnExist: opt_no_fail_on_exist = 1; break;
1108         case oHaveCert: opt_have_cert = 1; break;
1109         case oPrompt: opt_prompt = pargs.r.ret_str; break;
1110         case oStatusMsg: opt_status_msg = 1; break;
1111           
1112         default : pargs.err = 2; break;
1113         }
1114     }
1115   if (log_get_errorcount(0))
1116     exit(2);
1117
1118   fname = "-";
1119   if (argc == 1)
1120     fname = *argv;
1121   else if (argc > 1)
1122     usage (1);
1123
1124   if (opt_prompt)
1125     opt_prompt = percent_plus_unescape_string (xstrdup (opt_prompt));
1126
1127   if (cmd == oProtect)
1128     read_and_protect (fname);
1129   else if (cmd == oUnprotect)
1130     read_and_unprotect (fname);
1131   else if (cmd == oShadow)
1132     read_and_shadow (fname);
1133   else if (cmd == oShowShadowInfo)
1134     show_shadow_info (fname);
1135   else if (cmd == oShowKeygrip)
1136     show_keygrip (fname);
1137   else if (cmd == oP12Import)
1138     import_p12_file (fname);
1139   else if (cmd == oP12Export)
1140     export_p12_file (fname);
1141   else
1142     show_file (fname);
1143
1144   agent_exit (0);
1145   return 8; /*NOTREACHED*/
1146 }
1147
1148 void
1149 agent_exit (int rc)
1150 {
1151   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
1152   exit (rc);
1153 }
1154
1155
1156 /* Return the passphrase string and ask the agent if it has not been
1157    set from the command line  PROMPTNO select the prompt to display:
1158      0 = default
1159      1 = taken from the option --prompt
1160      2 = for unprotecting a pkcs#12 object
1161      3 = for protecting a new pkcs#12 object
1162      4 = for protecting an imported pkcs#12 in our system
1163      5 = reenter the passphrase
1164    When adding 100 to the values, a "does not match - try again" errro message is shown.
1165 */
1166 static char *
1167 get_passphrase (int promptno)
1168 {
1169   char *pw;
1170   int err;
1171   const char *desc;
1172 #ifdef HAVE_LANGINFO_CODESET
1173   char *orig_codeset = NULL;
1174 #endif
1175   int error_msgno;
1176   
1177
1178   if (opt_passphrase)
1179     return xstrdup (opt_passphrase);
1180
1181   error_msgno = promptno / 100;
1182   promptno %= 100;
1183
1184 #ifdef ENABLE_NLS
1185   /* The Assuan agent protocol requires us to transmit utf-8 strings */
1186   orig_codeset = bind_textdomain_codeset (PACKAGE_GT, NULL);
1187 #ifdef HAVE_LANGINFO_CODESET
1188   if (!orig_codeset)
1189     orig_codeset = nl_langinfo (CODESET);
1190 #endif
1191   if (orig_codeset && !strcmp (orig_codeset, "UTF-8"))
1192     orig_codeset = NULL;
1193   if (orig_codeset)
1194     {
1195       /* We only switch when we are able to restore the codeset later. */
1196       orig_codeset = xstrdup (orig_codeset);
1197       if (!bind_textdomain_codeset (PACKAGE_GT, "utf-8"))
1198         orig_codeset = NULL; 
1199     }
1200 #endif
1201
1202   if (promptno == 1 && opt_prompt)
1203     desc = opt_prompt;
1204   else if (promptno == 2)
1205     desc = _("Please enter the passphrase to unprotect the "
1206              "PKCS#12 object.");
1207   else if (promptno == 3)
1208     desc = _("Please enter the passphrase to protect the "
1209              "new PKCS#12 object.");
1210   else if (promptno == 4)
1211     desc = _("Please enter the passphrase to protect the "
1212              "imported object within the GnuPG system.");
1213   else if (promptno == 5)
1214     desc = _("Please re-enter this passphrase");
1215   else
1216     desc = _("Please enter the passphrase or the PIN\n"
1217              "needed to complete this operation.");
1218
1219   pw = simple_pwquery (NULL,
1220                        error_msgno == 1? _("does not match - try again"):NULL,
1221                        _("Passphrase:"), desc, &err);
1222
1223 #ifdef ENABLE_NLS
1224   if (orig_codeset)
1225     {
1226       bind_textdomain_codeset (PACKAGE_GT, orig_codeset);
1227       xfree (orig_codeset);
1228     }
1229 #endif
1230
1231   if (!pw)
1232     {
1233       if (err)
1234         log_error (_("error while asking for the passphrase: %s\n"),
1235                    gpg_strerror (err));
1236       else
1237         log_info (_("cancelled\n"));
1238       agent_exit (0);
1239     }
1240
1241   return pw;
1242 }
1243
1244
1245 /* Same as get_passphrase but requests it a second time and compares
1246    it to the one entered the first time. */
1247 static char *
1248 get_new_passphrase (int promptno)
1249 {
1250   char *pw;
1251   int i, secondpromptno;
1252   
1253   pw = get_passphrase (promptno);
1254   if (!pw)
1255     return NULL; /* Canceled. */
1256   if (!*pw)
1257     return pw; /* Empty passphrase - no need to as for repeating it. */
1258
1259   secondpromptno = 5;
1260   for (i=0; i < 3; i++)
1261     {
1262       char *pw2 = get_passphrase (secondpromptno);
1263       if (!pw2)
1264         {
1265           xfree (pw);
1266           return NULL; /* Canceled.  */
1267         }
1268       if (!strcmp (pw, pw2))
1269         {
1270           xfree (pw2);
1271           return pw; /* Okay. */
1272         }
1273       secondpromptno = 105;
1274       xfree (pw2);
1275     }
1276   xfree (pw);
1277   return NULL; /* 3 times repeated wrong - cancel.  */
1278 }
1279
1280
1281
1282 static void
1283 release_passphrase (char *pw)
1284 {
1285   if (pw)
1286     {
1287       wipememory (pw, strlen (pw));
1288       xfree (pw);
1289     }
1290 }
1291
1292 static int
1293 store_private_key (const unsigned char *grip,
1294                    const void *buffer, size_t length, int force)
1295 {
1296   int i;
1297   char *fname;
1298   FILE *fp;
1299   char hexgrip[40+4+1];
1300   
1301   for (i=0; i < 20; i++)
1302     sprintf (hexgrip+2*i, "%02X", grip[i]);
1303   strcpy (hexgrip+40, ".key");
1304
1305   fname = make_filename (opt_homedir, GNUPG_PRIVATE_KEYS_DIR, hexgrip, NULL);
1306   if (force)
1307     fp = fopen (fname, "wb");
1308   else
1309     {
1310       if (!access (fname, F_OK))
1311       {
1312         if (opt_status_msg)
1313           log_info ("[PROTECT-TOOL:] secretkey-exists\n");
1314         if (opt_no_fail_on_exist)
1315           log_info ("secret key file `%s' already exists\n", fname);
1316         else
1317           log_error ("secret key file `%s' already exists\n", fname);
1318         xfree (fname);
1319         return opt_no_fail_on_exist? 0 : -1;
1320       }
1321       fp = fopen (fname, "wbx");  /* FIXME: the x is a GNU extension - let
1322                                      configure check whether this actually
1323                                      works */
1324     }
1325
1326   if (!fp) 
1327     { 
1328       log_error ("can't create `%s': %s\n", fname, strerror (errno));
1329       xfree (fname);
1330       return -1;
1331     }
1332
1333   if (fwrite (buffer, length, 1, fp) != 1)
1334     {
1335       log_error ("error writing `%s': %s\n", fname, strerror (errno));
1336       fclose (fp);
1337       remove (fname);
1338       xfree (fname);
1339       return -1;
1340     }
1341   if ( fclose (fp) )
1342     {
1343       log_error ("error closing `%s': %s\n", fname, strerror (errno));
1344       remove (fname);
1345       xfree (fname);
1346       return -1;
1347     }
1348   log_info ("secret key stored as `%s'\n", fname);
1349
1350   if (opt_status_msg)
1351     log_info ("[PROTECT-TOOL:] secretkey-stored\n");
1352
1353   xfree (fname);
1354   return 0;
1355 }