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