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