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