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