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