agent/
[gnupg.git] / agent / protect-tool.c
1 /* protect-tool.c - A tool to test the secret key protection
2  * Copyright (C) 2002, 2003, 2004, 2006 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   oP12Charset,
69   oStore,
70   oForce,
71   oHaveCert,
72   oNoFailOnExist,
73   oHomedir,
74   oPrompt,
75   oStatusMsg, 
76
77 aTest };
78
79 struct rsa_secret_key_s 
80   {
81     gcry_mpi_t n;           /* public modulus */
82     gcry_mpi_t e;           /* public exponent */
83     gcry_mpi_t d;           /* exponent */
84     gcry_mpi_t p;           /* prime  p. */
85     gcry_mpi_t q;           /* prime  q. */
86     gcry_mpi_t u;           /* inverse of p mod q. */
87   };
88
89
90 static const char *opt_homedir;
91 static int opt_armor;
92 static int opt_canonical;
93 static int opt_store;
94 static int opt_force;
95 static int opt_no_fail_on_exist;
96 static int opt_have_cert;
97 static const char *opt_passphrase;
98 static char *opt_prompt;
99 static int opt_status_msg;
100 static const char *opt_p12_charset;
101
102 static char *get_passphrase (int promptno, int opt_check);
103 static char *get_new_passphrase (int promptno);
104 static void release_passphrase (char *pw);
105 static int store_private_key (const unsigned char *grip,
106                               const void *buffer, size_t length, int force);
107
108
109 static ARGPARSE_OPTS opts[] = {
110   
111   { 301, NULL, 0, N_("@Options:\n ") },
112
113   { oVerbose, "verbose",   0, "verbose" },
114   { oArmor,   "armor",     0, "write output in advanced format" },
115   { oCanonical, "canonical", 0, "write output in canonical format" },
116   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
117   { oProtect, "protect",     256, "protect a private key"},
118   { oUnprotect, "unprotect", 256, "unprotect a private key"},
119   { oShadow,  "shadow", 256, "create a shadow entry for a public key"},
120   { oShowShadowInfo,  "show-shadow-info", 256, "return the shadow info"},
121   { oShowKeygrip, "show-keygrip", 256, "show the \"keygrip\""},
122
123   { oP12Import, "p12-import", 256, "import a pkcs#12 encoded private key"},
124   { oP12Export, "p12-export", 256, "export a private key pkcs#12 encoded"},
125   { oP12Charset,"p12-charset", 2,
126     "|NAME|set charset for a new PKCS#12 passphrase to NAME" },
127   { oHaveCert, "have-cert", 0,  "certificate to export provided on STDIN"},
128   { oStore,     "store", 0, "store the created key in the appropriate place"},
129   { oForce,     "force", 0, "force overwriting"},
130   { oNoFailOnExist, "no-fail-on-exist", 0, "@" },
131   { oHomedir, "homedir", 2, "@" }, 
132   { oPrompt,  "prompt", 2, "|ESCSTRING|use ESCSTRING as prompt in pinentry"}, 
133   { oStatusMsg, "enable-status-msg", 0, "@"},
134
135   {0}
136 };
137
138 static const char *
139 my_strusage (int level)
140 {
141   const char *p;
142   switch (level)
143     {
144     case 11: p = "gpg-protect-tool (GnuPG)";
145       break;
146     case 13: p = VERSION; break;
147     case 17: p = PRINTABLE_OS_NAME; break;
148     case 19: p = _("Please report bugs to <" PACKAGE_BUGREPORT ">.\n");
149       break;
150     case 1:
151     case 40: p =  _("Usage: gpg-protect-tool [options] (-h for help)\n");
152       break;
153     case 41: p =  _("Syntax: gpg-protect-tool [options] [args]\n"
154                     "Secret key maintenance tool\n");
155     break;
156     
157     default: p = NULL;
158     }
159   return p;
160 }
161
162
163
164 static void
165 i18n_init (void)
166 {
167 #ifdef USE_SIMPLE_GETTEXT
168     set_gettext_file( PACKAGE_GT );
169 #else
170 #ifdef ENABLE_NLS
171     setlocale (LC_ALL, "");
172     bindtextdomain (PACKAGE_GT, LOCALEDIR);
173     textdomain (PACKAGE_GT);
174 #endif
175 #endif
176 }
177
178
179
180 /*  static void */
181 /*  print_mpi (const char *text, gcry_mpi_t a) */
182 /*  { */
183 /*    char *buf; */
184 /*    void *bufaddr = &buf; */
185 /*    int rc; */
186
187 /*    rc = gcry_mpi_aprint (GCRYMPI_FMT_HEX, bufaddr, NULL, a); */
188 /*    if (rc) */
189 /*      log_info ("%s: [error printing number: %s]\n", text, gpg_strerror (rc)); */
190 /*    else */
191 /*      { */
192 /*        log_info ("%s: %s\n", text, buf); */
193 /*        gcry_free (buf); */
194 /*      } */
195 /*  } */
196
197
198 \f
199 static unsigned char *
200 make_canonical (const char *fname, const char *buf, size_t buflen)
201 {
202   int rc;
203   size_t erroff, len;
204   gcry_sexp_t sexp;
205   unsigned char *result;
206
207   rc = gcry_sexp_sscan (&sexp, &erroff, buf, buflen);
208   if (rc)
209     {
210       log_error ("invalid S-Expression in `%s' (off=%u): %s\n",
211                  fname, (unsigned int)erroff, gpg_strerror (rc));
212       return NULL;
213     }
214   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_CANON, NULL, 0);
215   assert (len);
216   result = xmalloc (len);
217   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_CANON, result, len);
218   assert (len);
219   gcry_sexp_release (sexp);
220   return result;
221 }
222
223 static char *
224 make_advanced (const unsigned char *buf, size_t buflen)
225 {
226   int rc;
227   size_t erroff, len;
228   gcry_sexp_t sexp;
229   char *result;
230
231   rc = gcry_sexp_sscan (&sexp, &erroff, (const char*)buf, buflen);
232   if (rc)
233     {
234       log_error ("invalid canonical S-Expression (off=%u): %s\n",
235                  (unsigned int)erroff, gpg_strerror (rc));
236       return NULL;
237     }
238   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_ADVANCED, NULL, 0);
239   assert (len);
240   result = xmalloc (len);
241   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_ADVANCED, result, len);
242   assert (len);
243   gcry_sexp_release (sexp);
244   return result;
245 }
246
247
248 static char *
249 read_file (const char *fname, size_t *r_length)
250 {
251   FILE *fp;
252   char *buf;
253   size_t buflen;
254   
255   if (!strcmp (fname, "-"))
256     {
257       size_t nread, bufsize = 0;
258
259       fp = stdin;
260 #ifdef HAVE_DOSISH_SYSTEM
261       setmode ( fileno(fp) , O_BINARY );
262 #endif
263       buf = NULL;
264       buflen = 0;
265 #define NCHUNK 8192
266       do 
267         {
268           bufsize += NCHUNK;
269           if (!buf)
270             buf = xmalloc (bufsize);
271           else
272             buf = xrealloc (buf, bufsize);
273
274           nread = fread (buf+buflen, 1, NCHUNK, fp);
275           if (nread < NCHUNK && ferror (fp))
276             {
277               log_error ("error reading `[stdin]': %s\n", strerror (errno));
278               xfree (buf);
279               return NULL;
280             }
281           buflen += nread;
282         }
283       while (nread == NCHUNK);
284 #undef NCHUNK
285
286     }
287   else
288     {
289       struct stat st;
290
291       fp = fopen (fname, "rb");
292       if (!fp)
293         {
294           log_error ("can't open `%s': %s\n", fname, strerror (errno));
295           return NULL;
296         }
297   
298       if (fstat (fileno(fp), &st))
299         {
300           log_error ("can't stat `%s': %s\n", fname, strerror (errno));
301           fclose (fp);
302           return NULL;
303         }
304       
305       buflen = st.st_size;
306       buf = xmalloc (buflen+1);
307       if (fread (buf, buflen, 1, fp) != 1)
308         {
309           log_error ("error reading `%s': %s\n", fname, strerror (errno));
310           fclose (fp);
311           xfree (buf);
312           return NULL;
313         }
314       fclose (fp);
315     }
316
317   *r_length = buflen;
318   return buf;
319 }
320
321
322 static unsigned char *
323 read_key (const char *fname)
324 {
325   char *buf;
326   size_t buflen;
327   unsigned char *key;
328   
329   buf = read_file (fname, &buflen);
330   if (!buf)
331     return NULL;
332   key = make_canonical (fname, buf, buflen);
333   xfree (buf);
334   return key;
335 }
336
337
338 \f
339 static void
340 read_and_protect (const char *fname)
341 {
342   int  rc;
343   unsigned char *key;
344   unsigned char *result;
345   size_t resultlen;
346   char *pw;
347   
348   key = read_key (fname);
349   if (!key)
350     return;
351
352   pw = get_passphrase (1, 0);
353   rc = agent_protect (key, pw, &result, &resultlen);
354   release_passphrase (pw);
355   xfree (key);
356   if (rc)
357     {
358       log_error ("protecting the key failed: %s\n", gpg_strerror (rc));
359       return;
360     }
361   
362   if (opt_armor)
363     {
364       char *p = make_advanced (result, resultlen);
365       xfree (result);
366       if (!p)
367         return;
368       result = (unsigned char*)p;
369       resultlen = strlen (p);
370     }
371
372   fwrite (result, resultlen, 1, stdout);
373   xfree (result);
374 }
375
376
377 static void
378 read_and_unprotect (const char *fname)
379 {
380   int  rc;
381   unsigned char *key;
382   unsigned char *result;
383   size_t resultlen;
384   char *pw;
385   
386   key = read_key (fname);
387   if (!key)
388     return;
389
390   rc = agent_unprotect (key, (pw=get_passphrase (1, 0)), &result, &resultlen);
391   release_passphrase (pw);
392   xfree (key);
393   if (rc)
394     {
395       if (opt_status_msg)
396         log_info ("[PROTECT-TOOL:] bad-passphrase\n");
397       log_error ("unprotecting the key failed: %s\n", gpg_strerror (rc));
398       return;
399     }
400   
401   if (opt_armor)
402     {
403       char *p = make_advanced (result, resultlen);
404       xfree (result);
405       if (!p)
406         return;
407       result = (unsigned char*)p;
408       resultlen = strlen (p);
409     }
410
411   fwrite (result, resultlen, 1, stdout);
412   xfree (result);
413 }
414
415
416 \f
417 static void
418 read_and_shadow (const char *fname)
419 {
420   int  rc;
421   unsigned char *key;
422   unsigned char *result;
423   size_t resultlen;
424   unsigned char dummy_info[] = "(8:313233342:43)";
425   
426   key = read_key (fname);
427   if (!key)
428     return;
429
430   rc = agent_shadow_key (key, dummy_info, &result);
431   xfree (key);
432   if (rc)
433     {
434       log_error ("shadowing the key failed: %s\n", gpg_strerror (rc));
435       return;
436     }
437   resultlen = gcry_sexp_canon_len (result, 0, NULL,NULL);
438   assert (resultlen);
439   
440   if (opt_armor)
441     {
442       char *p = make_advanced (result, resultlen);
443       xfree (result);
444       if (!p)
445         return;
446       result = (unsigned char*)p;
447       resultlen = strlen (p);
448     }
449
450   fwrite (result, resultlen, 1, stdout);
451   xfree (result);
452 }
453
454 static void
455 show_shadow_info (const char *fname)
456 {
457   int  rc;
458   unsigned char *key;
459   const unsigned char *info;
460   size_t infolen;
461   
462   key = read_key (fname);
463   if (!key)
464     return;
465
466   rc = agent_get_shadow_info (key, &info);
467   xfree (key);
468   if (rc)
469     {
470       log_error ("get_shadow_info failed: %s\n", gpg_strerror (rc));
471       return;
472     }
473   infolen = gcry_sexp_canon_len (info, 0, NULL,NULL);
474   assert (infolen);
475   
476   if (opt_armor)
477     {
478       char *p = make_advanced (info, infolen);
479       if (!p)
480         return;
481       fwrite (p, strlen (p), 1, stdout);
482       xfree (p);
483     }
484   else
485     fwrite (info, infolen, 1, stdout);
486 }
487
488
489 static void
490 show_file (const char *fname)
491 {
492   unsigned char *key;
493   size_t keylen;
494   char *p;
495   
496   key = read_key (fname);
497   if (!key)
498     return;
499
500   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
501   assert (keylen);
502   
503   if (opt_canonical)
504     {
505       fwrite (key, keylen, 1, stdout);
506     }
507   else
508     {
509       p = make_advanced (key, keylen);
510       if (p)
511         {
512           fwrite (p, strlen (p), 1, stdout);
513           xfree (p);
514         }
515     }
516   xfree (key);
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 ((unsigned char*)buf, buflen, (pw=get_passphrase (2, 0)),
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 = (unsigned char*)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, 0)), &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 = (unsigned char*)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)), opt_p12_charset, &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 = (unsigned char*)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( _("%s is too old (need %s, have %s)\n"), "libgcrypt",
1060                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
1061     }
1062
1063   setup_libgcrypt_logging ();
1064   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
1065
1066
1067   opt_homedir = default_homedir ();
1068
1069
1070   pargs.argc = &argc;
1071   pargs.argv = &argv;
1072   pargs.flags=  1;  /* (do not remove the args) */
1073   while (arg_parse (&pargs, opts) )
1074     {
1075       switch (pargs.r_opt)
1076         {
1077         case oVerbose: opt.verbose++; break;
1078         case oArmor:   opt_armor=1; break;
1079         case oCanonical: opt_canonical=1; break;
1080         case oHomedir: opt_homedir = pargs.r.ret_str; break;
1081
1082         case oProtect: cmd = oProtect; break;
1083         case oUnprotect: cmd = oUnprotect; break;
1084         case oShadow: cmd = oShadow; break;
1085         case oShowShadowInfo: cmd = oShowShadowInfo; break;
1086         case oShowKeygrip: cmd = oShowKeygrip; break;
1087         case oP12Import: cmd = oP12Import; break;
1088         case oP12Export: cmd = oP12Export; break;
1089         case oP12Charset: opt_p12_charset = pargs.r.ret_str; break;
1090
1091         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
1092         case oStore: opt_store = 1; break;
1093         case oForce: opt_force = 1; break;
1094         case oNoFailOnExist: opt_no_fail_on_exist = 1; break;
1095         case oHaveCert: opt_have_cert = 1; break;
1096         case oPrompt: opt_prompt = pargs.r.ret_str; break;
1097         case oStatusMsg: opt_status_msg = 1; break;
1098           
1099         default : pargs.err = 2; break;
1100         }
1101     }
1102   if (log_get_errorcount(0))
1103     exit(2);
1104
1105   fname = "-";
1106   if (argc == 1)
1107     fname = *argv;
1108   else if (argc > 1)
1109     usage (1);
1110
1111   if (opt_prompt)
1112     opt_prompt = percent_plus_unescape_string (xstrdup (opt_prompt));
1113
1114   if (cmd == oProtect)
1115     read_and_protect (fname);
1116   else if (cmd == oUnprotect)
1117     read_and_unprotect (fname);
1118   else if (cmd == oShadow)
1119     read_and_shadow (fname);
1120   else if (cmd == oShowShadowInfo)
1121     show_shadow_info (fname);
1122   else if (cmd == oShowKeygrip)
1123     show_keygrip (fname);
1124   else if (cmd == oP12Import)
1125     import_p12_file (fname);
1126   else if (cmd == oP12Export)
1127     export_p12_file (fname);
1128   else
1129     show_file (fname);
1130
1131   agent_exit (0);
1132   return 8; /*NOTREACHED*/
1133 }
1134
1135 void
1136 agent_exit (int rc)
1137 {
1138   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
1139   exit (rc);
1140 }
1141
1142
1143 /* Return the passphrase string and ask the agent if it has not been
1144    set from the command line  PROMPTNO select the prompt to display:
1145      0 = default
1146      1 = taken from the option --prompt
1147      2 = for unprotecting a pkcs#12 object
1148      3 = for protecting a new pkcs#12 object
1149      4 = for protecting an imported pkcs#12 in our system
1150      5 = reenter the passphrase
1151    When adding 100 to the values, a "does not match - try again" error
1152    message is shown.
1153 */
1154 static char *
1155 get_passphrase (int promptno, int opt_check)
1156 {
1157   char *pw;
1158   int err;
1159   const char *desc;
1160 #ifdef ENABLE_NLS
1161   char *orig_codeset = NULL;
1162 #endif
1163   int error_msgno;
1164   
1165
1166   if (opt_passphrase)
1167     return xstrdup (opt_passphrase);
1168
1169   error_msgno = promptno / 100;
1170   promptno %= 100;
1171
1172 #ifdef ENABLE_NLS
1173   /* The Assuan agent protocol requires us to transmit utf-8 strings */
1174   orig_codeset = bind_textdomain_codeset (PACKAGE_GT, NULL);
1175 #ifdef HAVE_LANGINFO_CODESET
1176   if (!orig_codeset)
1177     orig_codeset = nl_langinfo (CODESET);
1178 #endif
1179   if (orig_codeset && !strcmp (orig_codeset, "UTF-8"))
1180     orig_codeset = NULL;
1181   if (orig_codeset)
1182     {
1183       /* We only switch when we are able to restore the codeset later. */
1184       orig_codeset = xstrdup (orig_codeset);
1185       if (!bind_textdomain_codeset (PACKAGE_GT, "utf-8"))
1186         {
1187           xfree (orig_codeset);
1188           orig_codeset = NULL; 
1189         }
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, opt_check, &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, 1);
1245   if (!pw)
1246     return NULL; /* Canceled. */
1247   if (!*pw)
1248     return pw;   /* Empty passphrase - no need to ask for repeating it. */
1249
1250   secondpromptno = 5;
1251   for (i=0; i < 3; i++)
1252     {
1253       char *pw2 = get_passphrase (secondpromptno, 0);
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 }