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