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