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