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