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