Preparing a release candidate.
[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   gnupg_isotime_t protected_at;
370
371   key = read_key (fname);
372   if (!key)
373     return;
374
375   rc = agent_unprotect (key, (pw=get_passphrase (1, 0)), 
376                         protected_at, &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   if (opt.verbose)
387     log_info ("key protection done at %.4s-%.2s-%.2s %.2s:%.2s:%s\n",
388               protected_at, protected_at+4, protected_at+6,
389               protected_at+9, protected_at+11, protected_at+13);
390
391
392   if (opt_armor)
393     {
394       char *p = make_advanced (result, resultlen);
395       xfree (result);
396       if (!p)
397         return;
398       result = (unsigned char*)p;
399       resultlen = strlen (p);
400     }
401
402   fwrite (result, resultlen, 1, stdout);
403   xfree (result);
404 }
405
406
407 \f
408 static void
409 read_and_shadow (const char *fname)
410 {
411   int  rc;
412   unsigned char *key;
413   unsigned char *result;
414   size_t resultlen;
415   unsigned char dummy_info[] = "(8:313233342:43)";
416   
417   key = read_key (fname);
418   if (!key)
419     return;
420
421   rc = agent_shadow_key (key, dummy_info, &result);
422   xfree (key);
423   if (rc)
424     {
425       log_error ("shadowing the key failed: %s\n", gpg_strerror (rc));
426       return;
427     }
428   resultlen = gcry_sexp_canon_len (result, 0, NULL,NULL);
429   assert (resultlen);
430   
431   if (opt_armor)
432     {
433       char *p = make_advanced (result, resultlen);
434       xfree (result);
435       if (!p)
436         return;
437       result = (unsigned char*)p;
438       resultlen = strlen (p);
439     }
440
441   fwrite (result, resultlen, 1, stdout);
442   xfree (result);
443 }
444
445 static void
446 show_shadow_info (const char *fname)
447 {
448   int  rc;
449   unsigned char *key;
450   const unsigned char *info;
451   size_t infolen;
452   
453   key = read_key (fname);
454   if (!key)
455     return;
456
457   rc = agent_get_shadow_info (key, &info);
458   xfree (key);
459   if (rc)
460     {
461       log_error ("get_shadow_info failed: %s\n", gpg_strerror (rc));
462       return;
463     }
464   infolen = gcry_sexp_canon_len (info, 0, NULL,NULL);
465   assert (infolen);
466   
467   if (opt_armor)
468     {
469       char *p = make_advanced (info, infolen);
470       if (!p)
471         return;
472       fwrite (p, strlen (p), 1, stdout);
473       xfree (p);
474     }
475   else
476     fwrite (info, infolen, 1, stdout);
477 }
478
479
480 static void
481 show_file (const char *fname)
482 {
483   unsigned char *key;
484   size_t keylen;
485   char *p;
486   
487   key = read_key (fname);
488   if (!key)
489     return;
490
491   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
492   assert (keylen);
493   
494   if (opt_canonical)
495     {
496       fwrite (key, keylen, 1, stdout);
497     }
498   else
499     {
500       p = make_advanced (key, keylen);
501       if (p)
502         {
503           fwrite (p, strlen (p), 1, stdout);
504           xfree (p);
505         }
506     }
507   xfree (key);
508 }
509
510 static void
511 show_keygrip (const char *fname)
512 {
513   unsigned char *key;
514   gcry_sexp_t private;
515   unsigned char grip[20];
516   int i;
517   
518   key = read_key (fname);
519   if (!key)
520     return;
521
522   if (gcry_sexp_new (&private, key, 0, 0))
523     {
524       log_error ("gcry_sexp_new failed\n");
525       return;
526     } 
527   xfree (key);
528
529   if (!gcry_pk_get_keygrip (private, grip))
530     {
531       log_error ("can't calculate keygrip\n");
532       return;
533     }
534   gcry_sexp_release (private);
535
536   for (i=0; i < 20; i++)
537     printf ("%02X", grip[i]);
538   putchar ('\n');
539 }
540
541 \f
542 static int
543 rsa_key_check (struct rsa_secret_key_s *skey)
544 {
545   int err = 0;
546   gcry_mpi_t t = gcry_mpi_snew (0);
547   gcry_mpi_t t1 = gcry_mpi_snew (0);
548   gcry_mpi_t t2 = gcry_mpi_snew (0);
549   gcry_mpi_t phi = gcry_mpi_snew (0);
550
551   /* check that n == p * q */
552   gcry_mpi_mul (t, skey->p, skey->q);
553   if (gcry_mpi_cmp( t, skey->n) )
554     {
555       log_error ("RSA oops: n != p * q\n");
556       err++;
557     }
558
559   /* check that p is less than q */
560   if (gcry_mpi_cmp (skey->p, skey->q) > 0)
561     {
562       gcry_mpi_t tmp;
563
564       log_info ("swapping secret primes\n");
565       tmp = gcry_mpi_copy (skey->p);
566       gcry_mpi_set (skey->p, skey->q);
567       gcry_mpi_set (skey->q, tmp);
568       gcry_mpi_release (tmp);
569       /* and must recompute u of course */
570       gcry_mpi_invm (skey->u, skey->p, skey->q);
571     }
572
573   /* check that e divides neither p-1 nor q-1 */
574   gcry_mpi_sub_ui (t, skey->p, 1 );
575   gcry_mpi_div (NULL, t, t, skey->e, 0);
576   if (!gcry_mpi_cmp_ui( t, 0) )
577     {
578       log_error ("RSA oops: e divides p-1\n");
579       err++;
580     }
581   gcry_mpi_sub_ui (t, skey->q, 1);
582   gcry_mpi_div (NULL, t, t, skey->e, 0);
583   if (!gcry_mpi_cmp_ui( t, 0))
584     {
585       log_info ( "RSA oops: e divides q-1\n" );
586       err++;
587     }
588
589   /* check that d is correct. */
590   gcry_mpi_sub_ui (t1, skey->p, 1);
591   gcry_mpi_sub_ui (t2, skey->q, 1);
592   gcry_mpi_mul (phi, t1, t2);
593   gcry_mpi_invm (t, skey->e, phi);
594   if (gcry_mpi_cmp (t, skey->d))
595     { /* no: try universal exponent. */
596       gcry_mpi_gcd (t, t1, t2);
597       gcry_mpi_div (t, NULL, phi, t, 0);
598       gcry_mpi_invm (t, skey->e, t);
599       if (gcry_mpi_cmp (t, skey->d))
600         {
601           log_error ("RSA oops: bad secret exponent\n");
602           err++;
603         }
604     }
605
606   /* check for correctness of u */
607   gcry_mpi_invm (t, skey->p, skey->q);
608   if (gcry_mpi_cmp (t, skey->u))
609     {
610       log_info ( "RSA oops: bad u parameter\n");
611       err++;
612     }
613
614   if (err)
615     log_info ("RSA secret key check failed\n");
616
617   gcry_mpi_release (t);
618   gcry_mpi_release (t1);
619   gcry_mpi_release (t2);
620   gcry_mpi_release (phi);
621
622   return err? -1:0;
623 }
624
625
626 /* A callback used by p12_parse to return a certificate.  */
627 static void
628 import_p12_cert_cb (void *opaque, const unsigned char *cert, size_t certlen)
629 {
630   struct b64state state;
631   gpg_error_t err, err2;
632
633   (void)opaque;
634
635   err = b64enc_start (&state, stdout, "CERTIFICATE");
636   if (!err)
637     err = b64enc_write (&state, cert, certlen);
638   err2 = b64enc_finish (&state);
639   if (!err)
640     err = err2;
641   if (err)
642     log_error ("error writing armored certificate: %s\n", gpg_strerror (err));
643 }
644
645 static void
646 import_p12_file (const char *fname)
647 {
648   char *buf;
649   unsigned char *result;
650   size_t buflen, resultlen, buf_off;
651   int i;
652   int rc;
653   gcry_mpi_t *kparms;
654   struct rsa_secret_key_s sk;
655   gcry_sexp_t s_key;
656   unsigned char *key;
657   unsigned char grip[20];
658   char *pw;
659
660   /* fixme: we should release some stuff on error */
661   
662   buf = read_file (fname, &buflen);
663   if (!buf)
664     return;
665
666   /* GnuPG 2.0.4 accidently created binary P12 files with the string
667      "The passphrase is %s encoded.\n\n" prepended to the ASN.1 data.
668      We fix that here.  */
669   if (buflen > 29 && !memcmp (buf, "The passphrase is ", 18))
670     {
671       for (buf_off=18; buf_off < buflen && buf[buf_off] != '\n'; buf_off++)
672         ;
673       buf_off++;
674       if (buf_off < buflen && buf[buf_off] == '\n')
675         buf_off++;
676     }
677   else
678     buf_off = 0;
679
680   kparms = p12_parse ((unsigned char*)buf+buf_off, buflen-buf_off,
681                       (pw=get_passphrase (2, 0)),
682                       import_p12_cert_cb, NULL);
683   release_passphrase (pw);
684   xfree (buf);
685   if (!kparms)
686     {
687       log_error ("error parsing or decrypting the PKCS-12 file\n");
688       return;
689     }
690   for (i=0; kparms[i]; i++)
691     ;
692   if (i != 8)
693     {
694       log_error ("invalid structure of private key\n");
695       return;
696     }
697
698
699 /*    print_mpi ("   n", kparms[0]); */
700 /*    print_mpi ("   e", kparms[1]); */
701 /*    print_mpi ("   d", kparms[2]); */
702 /*    print_mpi ("   p", kparms[3]); */
703 /*    print_mpi ("   q", kparms[4]); */
704 /*    print_mpi ("dmp1", kparms[5]); */
705 /*    print_mpi ("dmq1", kparms[6]); */
706 /*    print_mpi ("   u", kparms[7]); */
707
708   sk.n = kparms[0];
709   sk.e = kparms[1];
710   sk.d = kparms[2];
711   sk.q = kparms[3];
712   sk.p = kparms[4];
713   sk.u = kparms[7];
714   if (rsa_key_check (&sk))
715     return;
716 /*    print_mpi ("   n", sk.n); */
717 /*    print_mpi ("   e", sk.e); */
718 /*    print_mpi ("   d", sk.d); */
719 /*    print_mpi ("   p", sk.p); */
720 /*    print_mpi ("   q", sk.q); */
721 /*    print_mpi ("   u", sk.u); */
722
723   /* Create an S-expresion from the parameters. */
724   rc = gcry_sexp_build (&s_key, NULL,
725                         "(private-key(rsa(n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))",
726                         sk.n, sk.e, sk.d, sk.p, sk.q, sk.u, NULL);
727   for (i=0; i < 8; i++)
728     gcry_mpi_release (kparms[i]);
729   gcry_free (kparms);
730   if (rc)
731     {
732       log_error ("failed to created S-expression from key: %s\n",
733                  gpg_strerror (rc));
734       return;
735     }
736
737   /* Compute the keygrip. */
738   if (!gcry_pk_get_keygrip (s_key, grip))
739     {
740       log_error ("can't calculate keygrip\n");
741       return;
742     }
743   log_info ("keygrip: ");
744   for (i=0; i < 20; i++)
745     log_printf ("%02X", grip[i]);
746   log_printf ("\n");
747
748   /* Convert to canonical encoding. */
749   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, NULL, 0);
750   assert (buflen);
751   key = gcry_xmalloc_secure (buflen);
752   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, key, buflen);
753   assert (buflen);
754   gcry_sexp_release (s_key);
755
756
757   rc = agent_protect (key, (pw=get_new_passphrase (4)), &result, &resultlen);
758   release_passphrase (pw);
759   xfree (key);
760   if (rc)
761     {
762       log_error ("protecting the key failed: %s\n", gpg_strerror (rc));
763       return;
764     }
765   
766   if (opt_armor)
767     {
768       char *p = make_advanced (result, resultlen);
769       xfree (result);
770       if (!p)
771         return;
772       result = (unsigned char*)p;
773       resultlen = strlen (p);
774     }
775
776   if (opt_store)
777     store_private_key (grip, result, resultlen, opt_force);
778   else
779     fwrite (result, resultlen, 1, stdout);
780
781   xfree (result);
782 }
783
784 \f
785
786 static gcry_mpi_t *
787 sexp_to_kparms (gcry_sexp_t sexp)
788 {
789   gcry_sexp_t list, l2;
790   const char *name;
791   const char *s;
792   size_t n;
793   int i, idx;
794   const char *elems;
795   gcry_mpi_t *array;
796
797   list = gcry_sexp_find_token (sexp, "private-key", 0 );
798   if(!list)
799     return NULL; 
800   l2 = gcry_sexp_cadr (list);
801   gcry_sexp_release (list);
802   list = l2;
803   name = gcry_sexp_nth_data (list, 0, &n);
804   if(!name || n != 3 || memcmp (name, "rsa", 3))
805     {
806       gcry_sexp_release (list);
807       return NULL;
808     }
809
810   /* Parameter names used with RSA. */
811   elems = "nedpqu";
812   array = xcalloc (strlen(elems) + 1, sizeof *array);
813   for (idx=0, s=elems; *s; s++, idx++ ) 
814     {
815       l2 = gcry_sexp_find_token (list, s, 1);
816       if (!l2)
817         {
818           for (i=0; i<idx; i++)
819             gcry_mpi_release (array[i]);
820           xfree (array);
821           gcry_sexp_release (list);
822           return NULL; /* required parameter not found */
823         }
824       array[idx] = gcry_sexp_nth_mpi (l2, 1, GCRYMPI_FMT_USG);
825       gcry_sexp_release (l2);
826       if (!array[idx])
827         {
828           for (i=0; i<idx; i++)
829             gcry_mpi_release (array[i]);
830           xfree (array);
831           gcry_sexp_release (list);
832           return NULL; /* required parameter is invalid */
833         }
834     }
835   
836   gcry_sexp_release (list);
837   return array;
838 }
839
840
841 /* Check whether STRING is a KEYGRIP, i.e has the correct length and
842    does only consist of uppercase hex characters. */
843 static int
844 is_keygrip (const char *string)
845 {
846   int i;
847
848   for(i=0; string[i] && i < 41; i++) 
849     if (!strchr("01234567890ABCDEF", string[i]))
850       return 0; 
851   return i == 40;
852 }
853
854
855 static void
856 export_p12_file (const char *fname)
857 {
858   int rc;
859   gcry_mpi_t kparms[9], *kp;
860   unsigned char *key;
861   size_t keylen;
862   gcry_sexp_t private;
863   struct rsa_secret_key_s sk;
864   int i;
865   unsigned char *cert = NULL;
866   size_t certlen = 0;
867   int keytype;
868   size_t keylen_for_wipe = 0;
869   char *pw;
870
871   if ( is_keygrip (fname) )
872     {
873       char hexgrip[40+4+1];
874       char *p;
875   
876       assert (strlen(fname) == 40);
877       strcpy (stpcpy (hexgrip, fname), ".key");
878
879       p = make_filename (opt_homedir, GNUPG_PRIVATE_KEYS_DIR, hexgrip, NULL);
880       key = read_key (p);
881       xfree (p);
882     }
883   else
884     key = read_key (fname);
885
886   if (!key)
887     return;
888
889   keytype = agent_private_key_type (key);
890   if (keytype == PRIVATE_KEY_PROTECTED)
891     {
892       unsigned char *tmpkey;
893       size_t tmplen;
894
895       rc = agent_unprotect (key, (pw=get_passphrase (1, 0)),
896                             NULL, &tmpkey, &tmplen);
897       release_passphrase (pw);
898       if (rc)
899         {
900           if (opt_status_msg && gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE )
901             log_info ("[PROTECT-TOOL:] bad-passphrase\n");
902           log_error ("unprotecting key `%s' failed: %s\n",
903                      fname, gpg_strerror (rc));
904           xfree (key);
905           return;
906         }
907       xfree (key);
908       key = tmpkey;
909       keylen_for_wipe = tmplen;
910
911       keytype = agent_private_key_type (key);
912     }
913
914   if (keytype == PRIVATE_KEY_SHADOWED)
915     {
916       log_error ("`%s' is a shadowed private key - can't export it\n", fname);
917       wipememory (key, keylen_for_wipe);
918       xfree (key);
919       return;
920     }
921   else if (keytype != PRIVATE_KEY_CLEAR)
922     {
923       log_error ("\%s' is not a private key\n", fname);
924       wipememory (key, keylen_for_wipe);
925       xfree (key);
926       return;
927     }
928
929
930   if (opt_have_cert)
931     {
932       cert = (unsigned char*)read_file ("-", &certlen);
933       if (!cert)
934         {
935           wipememory (key, keylen_for_wipe);
936           xfree (key);
937           return;
938         }
939     }
940
941
942   if (gcry_sexp_new (&private, key, 0, 0))
943     {
944       log_error ("gcry_sexp_new failed\n");
945       wipememory (key, keylen_for_wipe);
946       xfree (key);
947       xfree (cert);
948       return;
949     } 
950   wipememory (key, keylen_for_wipe);
951   xfree (key);
952
953   kp = sexp_to_kparms (private);
954   gcry_sexp_release (private);
955   if (!kp)
956     {
957       log_error ("error converting key parameters\n");
958       xfree (cert);
959       return;
960     } 
961   sk.n = kp[0];
962   sk.e = kp[1];
963   sk.d = kp[2];
964   sk.p = kp[3];
965   sk.q = kp[4];
966   sk.u = kp[5];
967   xfree (kp);
968
969  
970   kparms[0] = sk.n;
971   kparms[1] = sk.e;
972   kparms[2] = sk.d;
973   kparms[3] = sk.q;
974   kparms[4] = sk.p;
975   kparms[5] = gcry_mpi_snew (0);  /* compute d mod (p-1) */
976   gcry_mpi_sub_ui (kparms[5], kparms[3], 1);
977   gcry_mpi_mod (kparms[5], sk.d, kparms[5]);   
978   kparms[6] = gcry_mpi_snew (0);  /* compute d mod (q-1) */
979   gcry_mpi_sub_ui (kparms[6], kparms[4], 1);
980   gcry_mpi_mod (kparms[6], sk.d, kparms[6]);   
981   kparms[7] = sk.u;
982   kparms[8] = NULL;
983
984   key = p12_build (kparms, cert, certlen,
985                    (pw=get_new_passphrase (3)), opt_p12_charset, &keylen);
986   release_passphrase (pw);
987   xfree (cert);
988   for (i=0; i < 8; i++)
989     gcry_mpi_release (kparms[i]);
990   if (!key)
991     return;
992   
993 #ifdef HAVE_DOSISH_SYSTEM
994   setmode ( fileno (stdout) , O_BINARY );
995 #endif
996   fwrite (key, keylen, 1, stdout);
997   xfree (key);
998 }
999
1000
1001
1002 /* Do the percent and plus/space unescaping in place and return the
1003    length of the valid buffer. */
1004 static size_t
1005 percent_plus_unescape (unsigned char *string)
1006 {
1007   unsigned char *p = string;
1008   size_t n = 0;
1009
1010   while (*string)
1011     {
1012       if (*string == '%' && string[1] && string[2])
1013         { 
1014           string++;
1015           *p++ = xtoi_2 (string);
1016           n++;
1017           string+= 2;
1018         }
1019       else if (*string == '+')
1020         {
1021           *p++ = ' ';
1022           n++;
1023           string++;
1024         }
1025       else
1026         {
1027           *p++ = *string++;
1028           n++;
1029         }
1030     }
1031
1032   return n;
1033 }
1034
1035 /* Remove percent and plus escaping and make sure that the reuslt is a
1036    string.  This is done in place. Returns STRING. */
1037 static char *
1038 percent_plus_unescape_string (char *string) 
1039 {
1040   unsigned char *p = (unsigned char*)string;
1041   size_t n;
1042
1043   n = percent_plus_unescape (p);
1044   p[n] = 0;
1045
1046   return string;
1047 }
1048
1049 \f
1050 int
1051 main (int argc, char **argv )
1052 {
1053   ARGPARSE_ARGS pargs;
1054   int cmd = 0;
1055   const char *fname;
1056
1057   set_strusage (my_strusage);
1058   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
1059   log_set_prefix ("gpg-protect-tool", 1); 
1060
1061   /* Make sure that our subsystems are ready.  */
1062   i18n_init ();
1063   init_common_subsystems ();
1064
1065   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
1066     {
1067       log_fatal( _("%s is too old (need %s, have %s)\n"), "libgcrypt",
1068                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
1069     }
1070
1071   setup_libgcrypt_logging ();
1072   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
1073
1074
1075   opt_homedir = default_homedir ();
1076
1077
1078   pargs.argc = &argc;
1079   pargs.argv = &argv;
1080   pargs.flags=  1;  /* (do not remove the args) */
1081   while (arg_parse (&pargs, opts) )
1082     {
1083       switch (pargs.r_opt)
1084         {
1085         case oVerbose: opt.verbose++; break;
1086         case oArmor:   opt_armor=1; break;
1087         case oCanonical: opt_canonical=1; break;
1088         case oHomedir: opt_homedir = pargs.r.ret_str; break;
1089
1090         case oProtect: cmd = oProtect; break;
1091         case oUnprotect: cmd = oUnprotect; break;
1092         case oShadow: cmd = oShadow; break;
1093         case oShowShadowInfo: cmd = oShowShadowInfo; break;
1094         case oShowKeygrip: cmd = oShowKeygrip; break;
1095         case oP12Import: cmd = oP12Import; break;
1096         case oP12Export: cmd = oP12Export; break;
1097         case oP12Charset: opt_p12_charset = pargs.r.ret_str; break;
1098
1099         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
1100         case oStore: opt_store = 1; break;
1101         case oForce: opt_force = 1; break;
1102         case oNoFailOnExist: opt_no_fail_on_exist = 1; break;
1103         case oHaveCert: opt_have_cert = 1; break;
1104         case oPrompt: opt_prompt = pargs.r.ret_str; break;
1105         case oStatusMsg: opt_status_msg = 1; break;
1106           
1107         default : pargs.err = 2; break;
1108         }
1109     }
1110   if (log_get_errorcount(0))
1111     exit(2);
1112
1113   fname = "-";
1114   if (argc == 1)
1115     fname = *argv;
1116   else if (argc > 1)
1117     usage (1);
1118
1119   /* Tell simple-pwquery about the the standard socket name.  */
1120   {
1121     char *tmp = make_filename (opt_homedir, "S.gpg-agent", NULL);
1122     simple_pw_set_socket (tmp);
1123     xfree (tmp);
1124   }
1125
1126   if (opt_prompt)
1127     opt_prompt = percent_plus_unescape_string (xstrdup (opt_prompt));
1128
1129   if (cmd == oProtect)
1130     read_and_protect (fname);
1131   else if (cmd == oUnprotect)
1132     read_and_unprotect (fname);
1133   else if (cmd == oShadow)
1134     read_and_shadow (fname);
1135   else if (cmd == oShowShadowInfo)
1136     show_shadow_info (fname);
1137   else if (cmd == oShowKeygrip)
1138     show_keygrip (fname);
1139   else if (cmd == oP12Import)
1140     import_p12_file (fname);
1141   else if (cmd == oP12Export)
1142     export_p12_file (fname);
1143   else
1144     show_file (fname);
1145
1146   agent_exit (0);
1147   return 8; /*NOTREACHED*/
1148 }
1149
1150 void
1151 agent_exit (int rc)
1152 {
1153   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
1154   exit (rc);
1155 }
1156
1157
1158 /* Return the passphrase string and ask the agent if it has not been
1159    set from the command line  PROMPTNO select the prompt to display:
1160      0 = default
1161      1 = taken from the option --prompt
1162      2 = for unprotecting a pkcs#12 object
1163      3 = for protecting a new pkcs#12 object
1164      4 = for protecting an imported pkcs#12 in our system
1165      5 = reenter the passphrase
1166    When adding 100 to the values, a "does not match - try again" error
1167    message is shown.
1168 */
1169 static char *
1170 get_passphrase (int promptno, int opt_check)
1171 {
1172   char *pw;
1173   int err;
1174   const char *desc;
1175   char *orig_codeset;
1176   int error_msgno;
1177   
1178   if (opt_passphrase)
1179     return xstrdup (opt_passphrase);
1180
1181   error_msgno = promptno / 100;
1182   promptno %= 100;
1183
1184   orig_codeset = i18n_switchto_utf8 ();
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   i18n_switchback (orig_codeset);
1209
1210   if (!pw)
1211     {
1212       if (err)
1213         log_error (_("error while asking for the passphrase: %s\n"),
1214                    gpg_strerror (err));
1215       else
1216         log_info (_("cancelled\n"));
1217       agent_exit (0);
1218     }
1219
1220   return pw;
1221 }
1222
1223
1224 /* Same as get_passphrase but requests it a second time and compares
1225    it to the one entered the first time. */
1226 static char *
1227 get_new_passphrase (int promptno)
1228 {
1229   char *pw;
1230   int i, secondpromptno;
1231   
1232   pw = get_passphrase (promptno, 1);
1233   if (!pw)
1234     return NULL; /* Canceled. */
1235   if (!*pw)
1236     return pw;   /* Empty passphrase - no need to ask for repeating it. */
1237
1238   secondpromptno = 5;
1239   for (i=0; i < 3; i++)
1240     {
1241       char *pw2 = get_passphrase (secondpromptno, 0);
1242       if (!pw2)
1243         {
1244           xfree (pw);
1245           return NULL; /* Canceled.  */
1246         }
1247       if (!strcmp (pw, pw2))
1248         {
1249           xfree (pw2);
1250           return pw; /* Okay. */
1251         }
1252       secondpromptno = 105;
1253       xfree (pw2);
1254     }
1255   xfree (pw);
1256   return NULL; /* 3 times repeated wrong - cancel.  */
1257 }
1258
1259
1260
1261 static void
1262 release_passphrase (char *pw)
1263 {
1264   if (pw)
1265     {
1266       wipememory (pw, strlen (pw));
1267       xfree (pw);
1268     }
1269 }
1270
1271 static int
1272 store_private_key (const unsigned char *grip,
1273                    const void *buffer, size_t length, int force)
1274 {
1275   int i;
1276   char *fname;
1277   FILE *fp;
1278   char hexgrip[40+4+1];
1279   
1280   for (i=0; i < 20; i++)
1281     sprintf (hexgrip+2*i, "%02X", grip[i]);
1282   strcpy (hexgrip+40, ".key");
1283
1284   fname = make_filename (opt_homedir, GNUPG_PRIVATE_KEYS_DIR, hexgrip, NULL);
1285   if (force)
1286     fp = fopen (fname, "wb");
1287   else
1288     {
1289       if (!access (fname, F_OK))
1290       {
1291         if (opt_status_msg)
1292           log_info ("[PROTECT-TOOL:] secretkey-exists\n");
1293         if (opt_no_fail_on_exist)
1294           log_info ("secret key file `%s' already exists\n", fname);
1295         else
1296           log_error ("secret key file `%s' already exists\n", fname);
1297         xfree (fname);
1298         return opt_no_fail_on_exist? 0 : -1;
1299       }
1300       fp = fopen (fname, "wbx");  /* FIXME: the x is a GNU extension - let
1301                                      configure check whether this actually
1302                                      works */
1303     }
1304
1305   if (!fp) 
1306     { 
1307       log_error ("can't create `%s': %s\n", fname, strerror (errno));
1308       xfree (fname);
1309       return -1;
1310     }
1311
1312   if (fwrite (buffer, length, 1, fp) != 1)
1313     {
1314       log_error ("error writing `%s': %s\n", fname, strerror (errno));
1315       fclose (fp);
1316       remove (fname);
1317       xfree (fname);
1318       return -1;
1319     }
1320   if ( fclose (fp) )
1321     {
1322       log_error ("error closing `%s': %s\n", fname, strerror (errno));
1323       remove (fname);
1324       xfree (fname);
1325       return -1;
1326     }
1327   log_info ("secret key stored as `%s'\n", fname);
1328
1329   if (opt_status_msg)
1330     log_info ("[PROTECT-TOOL:] secretkey-stored\n");
1331
1332   xfree (fname);
1333   return 0;
1334 }