* protect-tool.c (rsa_key_check): New.
[gnupg.git] / agent / protect-tool.c
1 /* protect-tool.c - A tool to test the secret key protection
2  *      Copyright (C) 2002 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stddef.h>
26 #include <stdarg.h>
27 #include <string.h>
28 #include <errno.h>
29 #include <assert.h>
30 #include <sys/stat.h>
31 #include <unistd.h>
32
33 #include <gcrypt.h>
34
35 #define JNLIB_NEED_LOG_LOGV
36 #include "agent.h"
37 #include "minip12.h"
38
39 #define N_(a) a
40 #define _(a) a
41
42
43 enum cmd_and_opt_values 
44 { aNull = 0,
45   oVerbose        = 'v',
46   oArmor          = 'a',
47   oPassphrase     = 'P',
48
49   oProtect        = 'p',
50   oUnprotect      = 'u',
51   
52   oNoVerbose = 500,
53   oShadow,
54   oShowShadowInfo,
55   oShowKeygrip,
56
57   oP12Import,
58
59 aTest };
60
61 struct rsa_secret_key_s 
62   {
63     MPI n;          /* public modulus */
64     MPI e;          /* public exponent */
65     MPI d;          /* exponent */
66     MPI p;          /* prime  p. */
67     MPI q;          /* prime  q. */
68     MPI u;          /* inverse of p mod q. */
69   };
70
71
72 static int opt_armor;
73 static const char *passphrase = "abc";
74
75 static ARGPARSE_OPTS opts[] = {
76   
77   { 301, NULL, 0, N_("@Options:\n ") },
78
79   { oVerbose, "verbose",   0, "verbose" },
80   { oArmor,   "armor",     0, "write output in advanced format" },
81   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
82   { oProtect, "protect",     256, "protect a private key"},
83   { oUnprotect, "unprotect", 256, "unprotect a private key"},
84   { oShadow,  "shadow", 256, "create a shadow entry for a priblic key"},
85   { oShowShadowInfo,  "show-shadow-info", 256, "return the shadow info"},
86   { oShowKeygrip, "show-keygrip", 256, "show the \"keygrip\""},
87
88   { oP12Import, "p12-import", 256, "import a PKCS-12 encoded private key"},
89   {0}
90 };
91
92 static const char *
93 my_strusage (int level)
94 {
95   const char *p;
96   switch (level)
97     {
98     case 11: p = "protect-tool (GnuPG)";
99       break;
100     case 13: p = VERSION; break;
101     case 17: p = PRINTABLE_OS_NAME; break;
102     case 19: p = _("Please report bugs to <" PACKAGE_BUGREPORT ">.\n");
103       break;
104     case 1:
105     case 40: p =  _("Usage: protect-tool [options] (-h for help)\n");
106       break;
107     case 41: p =  _("Syntax: protect-tool [options] [args]]\n"
108                     "INTERNAL USE ONLY!\n");
109     break;
110     
111     default: p = NULL;
112     }
113   return p;
114 }
115
116
117
118 static void
119 i18n_init (void)
120 {
121 #ifdef USE_SIMPLE_GETTEXT
122     set_gettext_file( PACKAGE );
123 #else
124 #ifdef ENABLE_NLS
125     /* gtk_set_locale (); HMMM: We have not yet called gtk_init */
126     bindtextdomain( PACKAGE, GNUPG_LOCALEDIR );
127     textdomain( PACKAGE );
128 #endif
129 #endif
130 }
131
132
133
134 /* Used by gcry for logging */
135 static void
136 my_gcry_logger (void *dummy, int level, const char *fmt, va_list arg_ptr)
137 {
138   /* translate the log levels */
139   switch (level)
140     {
141     case GCRY_LOG_CONT: level = JNLIB_LOG_CONT; break;
142     case GCRY_LOG_INFO: level = JNLIB_LOG_INFO; break;
143     case GCRY_LOG_WARN: level = JNLIB_LOG_WARN; break;
144     case GCRY_LOG_ERROR:level = JNLIB_LOG_ERROR; break;
145     case GCRY_LOG_FATAL:level = JNLIB_LOG_FATAL; break;
146     case GCRY_LOG_BUG:  level = JNLIB_LOG_BUG; break;
147     case GCRY_LOG_DEBUG:level = JNLIB_LOG_DEBUG; break;
148     default:            level = JNLIB_LOG_ERROR; break;      }
149   log_logv (level, fmt, arg_ptr);
150 }
151
152
153 /*  static void */
154 /*  print_mpi (const char *text, GcryMPI a) */
155 /*  { */
156 /*    char *buf; */
157 /*    void *bufaddr = &buf; */
158 /*    int rc; */
159
160 /*    rc = gcry_mpi_aprint (GCRYMPI_FMT_HEX, bufaddr, NULL, a); */
161 /*    if (rc) */
162 /*      log_info ("%s: [error printing number: %s]\n", text, gcry_strerror (rc)); */
163 /*    else */
164 /*      { */
165 /*        log_info ("%s: %s\n", text, buf); */
166 /*        gcry_free (buf); */
167 /*      } */
168 /*  } */
169
170
171 \f
172 static unsigned char *
173 make_canonical (const char *fname, const char *buf, size_t buflen)
174 {
175   int rc;
176   size_t erroff, len;
177   GCRY_SEXP sexp;
178   unsigned char *result;
179
180   rc = gcry_sexp_sscan (&sexp, &erroff, buf, buflen);
181   if (rc)
182     {
183       log_error ("invalid S-Expression in `%s' (off=%u): %s\n",
184                  fname, (unsigned int)erroff, gcry_strerror (rc));
185       return NULL;
186     }
187   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_CANON, NULL, 0);
188   assert (len);
189   result = xmalloc (len);
190   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_CANON, result, len);
191   assert (len);
192   gcry_sexp_release (sexp);
193   return result;
194 }
195
196 static char *
197 make_advanced (const unsigned char *buf, size_t buflen)
198 {
199   int rc;
200   size_t erroff, len;
201   GCRY_SEXP sexp;
202   unsigned char *result;
203
204   rc = gcry_sexp_sscan (&sexp, &erroff, buf, buflen);
205   if (rc)
206     {
207       log_error ("invalid canonical S-Expression (off=%u): %s\n",
208                  (unsigned int)erroff, gcry_strerror (rc));
209       return NULL;
210     }
211   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_ADVANCED, NULL, 0);
212   assert (len);
213   result = xmalloc (len);
214   len = gcry_sexp_sprint (sexp, GCRYSEXP_FMT_ADVANCED, result, len);
215   assert (len);
216   gcry_sexp_release (sexp);
217   return result;
218 }
219
220
221 static char *
222 read_file (const char *fname, size_t *r_length)
223 {
224   FILE *fp;
225   struct stat st;
226   char *buf;
227   size_t buflen;
228   
229   fp = fopen (fname, "rb");
230   if (!fp)
231     {
232       log_error ("can't open `%s': %s\n", fname, strerror (errno));
233       return NULL;
234     }
235   
236   if (fstat (fileno(fp), &st))
237     {
238       log_error ("can't stat `%s': %s\n", fname, strerror (errno));
239       fclose (fp);
240       return NULL;
241     }
242
243   buflen = st.st_size;
244   buf = xmalloc (buflen+1);
245   if (fread (buf, buflen, 1, fp) != 1)
246     {
247       log_error ("error reading `%s': %s\n", fname, strerror (errno));
248       fclose (fp);
249       xfree (buf);
250       return NULL;
251     }
252   fclose (fp);
253
254   *r_length = buflen;
255   return buf;
256 }
257
258
259 static unsigned char *
260 read_key (const char *fname)
261 {
262   char *buf;
263   size_t buflen;
264   unsigned char *key;
265   
266   buf = read_file (fname, &buflen);
267   key = make_canonical (fname, buf, buflen);
268   xfree (buf);
269   return key;
270 }
271
272
273 \f
274 static void
275 read_and_protect (const char *fname)
276 {
277   int  rc;
278   unsigned char *key;
279   unsigned char *result;
280   size_t resultlen;
281   
282   key = read_key (fname);
283   if (!key)
284     return;
285
286   rc = agent_protect (key, passphrase, &result, &resultlen);
287   xfree (key);
288   if (rc)
289     {
290       log_error ("protecting the key failed: %s\n", gnupg_strerror (rc));
291       return;
292     }
293   
294   if (opt_armor)
295     {
296       char *p = make_advanced (result, resultlen);
297       xfree (result);
298       if (!p)
299         return;
300       result = p;
301       resultlen = strlen (p);
302     }
303
304   fwrite (result, resultlen, 1, stdout);
305   xfree (result);
306 }
307
308
309 static void
310 read_and_unprotect (const char *fname)
311 {
312   int  rc;
313   unsigned char *key;
314   unsigned char *result;
315   size_t resultlen;
316   
317   key = read_key (fname);
318   if (!key)
319     return;
320
321   rc = agent_unprotect (key, passphrase, &result, &resultlen);
322   xfree (key);
323   if (rc)
324     {
325       log_error ("unprotecting the key failed: %s\n", gnupg_strerror (rc));
326       return;
327     }
328   
329   if (opt_armor)
330     {
331       char *p = make_advanced (result, resultlen);
332       xfree (result);
333       if (!p)
334         return;
335       result = p;
336       resultlen = strlen (p);
337     }
338
339   fwrite (result, resultlen, 1, stdout);
340   xfree (result);
341 }
342
343
344 \f
345 static void
346 read_and_shadow (const char *fname)
347 {
348   int  rc;
349   unsigned char *key;
350   unsigned char *result;
351   size_t resultlen;
352   
353   key = read_key (fname);
354   if (!key)
355     return;
356
357   rc = agent_shadow_key (key, "(8:313233342:43)", &result);
358   xfree (key);
359   if (rc)
360     {
361       log_error ("shadowing the key failed: %s\n", gnupg_strerror (rc));
362       return;
363     }
364   resultlen = gcry_sexp_canon_len (result, 0, NULL,NULL);
365   assert (resultlen);
366   
367   if (opt_armor)
368     {
369       char *p = make_advanced (result, resultlen);
370       xfree (result);
371       if (!p)
372         return;
373       result = p;
374       resultlen = strlen (p);
375     }
376
377   fwrite (result, resultlen, 1, stdout);
378   xfree (result);
379 }
380
381 static void
382 show_shadow_info (const char *fname)
383 {
384   int  rc;
385   unsigned char *key;
386   const unsigned char *info;
387   size_t infolen;
388   
389   key = read_key (fname);
390   if (!key)
391     return;
392
393   rc = agent_get_shadow_info (key, &info);
394   xfree (key);
395   if (rc)
396     {
397       log_error ("get_shadow_info failed: %s\n", gnupg_strerror (rc));
398       return;
399     }
400   infolen = gcry_sexp_canon_len (info, 0, NULL,NULL);
401   assert (infolen);
402   
403   if (opt_armor)
404     {
405       char *p = make_advanced (info, infolen);
406       if (!p)
407         return;
408       fwrite (p, strlen (p), 1, stdout);
409       xfree (p);
410     }
411   else
412     fwrite (info, infolen, 1, stdout);
413 }
414
415
416 static void
417 show_file (const char *fname)
418 {
419   unsigned char *key;
420   size_t keylen;
421   char *p;
422   
423   key = read_key (fname);
424   if (!key)
425     return;
426
427   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
428   assert (keylen);
429
430   p = make_advanced (key, keylen);
431   xfree (key);
432   if (p)
433     {
434       fwrite (p, strlen (p), 1, stdout);
435       xfree (p);
436     }
437 }
438
439 static void
440 show_keygrip (const char *fname)
441 {
442   unsigned char *key;
443   GcrySexp private;
444   unsigned char grip[20];
445   int i;
446   
447   key = read_key (fname);
448   if (!key)
449     return;
450
451   if (gcry_sexp_new (&private, key, 0, 0))
452     {
453       log_error ("gcry_sexp_new failed\n");
454       return;
455     } 
456   xfree (key);
457
458   if (!gcry_pk_get_keygrip (private, grip))
459     {
460       log_error ("can't calculate keygrip\n");
461       return;
462     }
463   gcry_sexp_release (private);
464
465   for (i=0; i < 20; i++)
466     printf ("%02X", grip[i]);
467   putchar ('\n');
468 }
469
470 \f
471 static int
472 rsa_key_check (struct rsa_secret_key_s *skey)
473 {
474   int err = 0;
475   MPI t = gcry_mpi_snew (0);
476   MPI t1 = gcry_mpi_snew (0);
477   MPI t2 = gcry_mpi_snew (0);
478   MPI phi = gcry_mpi_snew (0);
479
480   /* check that n == p * q */
481   gcry_mpi_mul (t, skey->p, skey->q);
482   if (gcry_mpi_cmp( t, skey->n) )
483     {
484       log_error ("RSA oops: n != p * q\n");
485       err++;
486     }
487
488   /* check that p is less than q */
489   if (gcry_mpi_cmp (skey->p, skey->q) > 0)
490     {
491       GcryMPI tmp;
492
493       log_info ("swapping secret primes\n");
494       tmp = gcry_mpi_copy (skey->p);
495       gcry_mpi_set (skey->p, skey->q);
496       gcry_mpi_set (skey->q, tmp);
497       gcry_mpi_release (tmp);
498       /* and must recompute u of course */
499       gcry_mpi_invm (skey->u, skey->p, skey->q);
500     }
501
502   /* check that e divides neither p-1 nor q-1 */
503   gcry_mpi_sub_ui (t, skey->p, 1 );
504   gcry_mpi_div (NULL, t, t, skey->e, 0);
505   if (!gcry_mpi_cmp_ui( t, 0) )
506     {
507       log_error ("RSA oops: e divides p-1\n");
508       err++;
509     }
510   gcry_mpi_sub_ui (t, skey->q, 1);
511   gcry_mpi_div (NULL, t, t, skey->e, 0);
512   if (!gcry_mpi_cmp_ui( t, 0))
513     {
514       log_info ( "RSA oops: e divides q-1\n" );
515       err++;
516     }
517
518   /* check that d is correct. */
519   gcry_mpi_sub_ui (t1, skey->p, 1);
520   gcry_mpi_sub_ui (t2, skey->q, 1);
521   gcry_mpi_mul (phi, t1, t2);
522   gcry_mpi_invm (t, skey->e, phi);
523   if (gcry_mpi_cmp (t, skey->d))
524     { /* no: try universal exponent. */
525       gcry_mpi_gcd (t, t1, t2);
526       gcry_mpi_div (t, NULL, phi, t, 0);
527       gcry_mpi_invm (t, skey->e, t);
528       if (gcry_mpi_cmp (t, skey->d))
529         {
530           log_error ("RSA oops: bad secret exponent\n");
531           err++;
532         }
533     }
534
535   /* check for correctness of u */
536   gcry_mpi_invm (t, skey->p, skey->q);
537   if (gcry_mpi_cmp (t, skey->u))
538     {
539       log_info ( "RSA oops: bad u parameter\n");
540       err++;
541     }
542
543   if (err)
544     log_info ("RSA secret key check failed\n");
545
546   gcry_mpi_release (t);
547   gcry_mpi_release (t1);
548   gcry_mpi_release (t2);
549   gcry_mpi_release (phi);
550
551   return err? -1:0;
552 }
553
554
555 static void
556 import_p12_file (const char *fname)
557 {
558   char *buf;
559   unsigned char *result;
560   size_t buflen, resultlen;
561   int i;
562   int rc;
563   GcryMPI *kparms;
564   struct rsa_secret_key_s sk;
565   GcrySexp s_key;
566   unsigned char *key;
567
568   /* fixme: we should release some stuff on error */
569   
570   buf = read_file (fname, &buflen);
571   if (!buf)
572     return;
573
574   kparms = p12_parse (buf, buflen, passphrase);
575   xfree (buf);
576   if (!kparms)
577     {
578       log_error ("error parsing or decrypting the PKCS-1 file\n");
579       return;
580     }
581   for (i=0; kparms[i]; i++)
582     ;
583   if (i != 8)
584     {
585       log_error ("invalid structure of private key\n");
586       return;
587     }
588
589
590 /*    print_mpi ("   n", kparms[0]); */
591 /*    print_mpi ("   e", kparms[1]); */
592 /*    print_mpi ("   d", kparms[2]); */
593 /*    print_mpi ("   p", kparms[3]); */
594 /*    print_mpi ("   q", kparms[4]); */
595 /*    print_mpi ("dmp1", kparms[5]); */
596 /*    print_mpi ("dmq1", kparms[6]); */
597 /*    print_mpi ("   u", kparms[7]); */
598
599   sk.n = kparms[0];
600   sk.e = kparms[1];
601   sk.d = kparms[2];
602   sk.q = kparms[3];
603   sk.p = kparms[4];
604   sk.u = kparms[7];
605   if (rsa_key_check (&sk))
606     return;
607 /*    print_mpi ("   n", sk.n); */
608 /*    print_mpi ("   e", sk.e); */
609 /*    print_mpi ("   d", sk.d); */
610 /*    print_mpi ("   p", sk.p); */
611 /*    print_mpi ("   q", sk.q); */
612 /*    print_mpi ("   u", sk.u); */
613
614   /* Create an S-expresion from the parameters. */
615   rc = gcry_sexp_build (&s_key, NULL,
616                         "(private-key(rsa(n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))",
617                         sk.n, sk.e, sk.d, sk.p, sk.q, sk.u, NULL);
618   for (i=0; i < 8; i++)
619     gcry_mpi_release (kparms[i]);
620   gcry_free (kparms);
621   if (rc)
622     {
623       log_error ("failed to created S-expression from key: %s\n",
624                  gcry_strerror (rc));
625       return;
626     }
627
628   /* Compute the keygrip. */
629   {
630     unsigned char grip[20];
631     if (!gcry_pk_get_keygrip (s_key, grip))
632       {
633         log_error ("can't calculate keygrip\n");
634         return;
635       }
636     log_info ("keygrip: ");
637     for (i=0; i < 20; i++)
638       log_printf ("%02X", grip[i]);
639     log_printf ("\n");
640   }
641
642   /* convert to canonical encoding */
643   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, NULL, 0);
644   assert (buflen);
645   key = gcry_xmalloc_secure (buflen);
646   buflen = gcry_sexp_sprint (s_key, GCRYSEXP_FMT_CANON, key, buflen);
647   assert (buflen);
648   gcry_sexp_release (s_key);
649
650
651   rc = agent_protect (key, passphrase, &result, &resultlen);
652   xfree (key);
653   if (rc)
654     {
655       log_error ("protecting the key failed: %s\n", gnupg_strerror (rc));
656       return;
657     }
658   
659   if (opt_armor)
660     {
661       char *p = make_advanced (result, resultlen);
662       xfree (result);
663       if (!p)
664         return;
665       result = p;
666       resultlen = strlen (p);
667     }
668
669   fwrite (result, resultlen, 1, stdout);
670   xfree (result);
671 }
672
673
674 \f
675 int
676 main (int argc, char **argv )
677 {
678   ARGPARSE_ARGS pargs;
679   int cmd = 0;
680
681   set_strusage (my_strusage);
682   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
683   log_set_prefix ("protect-tool", 1); 
684   i18n_init ();
685
686   if (!gcry_check_version ( "1.1.5" ) )
687     {
688       log_fatal( _("libgcrypt is too old (need %s, have %s)\n"),
689                  "1.1.5", gcry_check_version (NULL) );
690     }
691
692   gcry_set_log_handler (my_gcry_logger, NULL);
693   
694   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
695
696   pargs.argc = &argc;
697   pargs.argv = &argv;
698   pargs.flags=  1;  /* do not remove the args */
699   while (arg_parse (&pargs, opts) )
700     {
701       switch (pargs.r_opt)
702         {
703         case oVerbose: opt.verbose++; break;
704         case oArmor:   opt_armor=1; break;
705
706         case oProtect: cmd = oProtect; break;
707         case oUnprotect: cmd = oUnprotect; break;
708         case oShadow: cmd = oShadow; break;
709         case oShowShadowInfo: cmd = oShowShadowInfo; break;
710         case oShowKeygrip: cmd = oShowKeygrip; break;
711         case oP12Import: cmd = oP12Import; break;
712
713         case oPassphrase: passphrase = pargs.r.ret_str; break;
714
715         default : pargs.err = 2; break;
716         }
717     }
718   if (log_get_errorcount(0))
719     exit(2);
720
721   if (argc != 1)
722     usage (1);
723
724   if (cmd == oProtect)
725     read_and_protect (*argv);
726   else if (cmd == oUnprotect)
727     read_and_unprotect (*argv);
728   else if (cmd == oShadow)
729     read_and_shadow (*argv);
730   else if (cmd == oShowShadowInfo)
731     show_shadow_info (*argv);
732   else if (cmd == oShowKeygrip)
733     show_keygrip (*argv);
734   else if (cmd == oP12Import)
735     import_p12_file (*argv);
736   else
737     show_file (*argv);
738
739   return 0;
740 }
741
742 void
743 agent_exit (int rc)
744 {
745   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
746   exit (rc);
747 }