dc363f2caaf0092ce9a52422c3e0c9a240ba954b
[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 #include "../common/init.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   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_agent_program;
100
101 static char *get_passphrase (int promptno);
102 static void release_passphrase (char *pw);
103
104
105 static ARGPARSE_OPTS opts[] = {
106   ARGPARSE_group (300, N_("@Commands:\n ")),
107
108   ARGPARSE_c (oProtect,   "protect",   "protect a private key"),
109   ARGPARSE_c (oUnprotect, "unprotect", "unprotect a private key"),
110   ARGPARSE_c (oShadow,    "shadow", "create a shadow entry for a public key"),
111   ARGPARSE_c (oShowShadowInfo,  "show-shadow-info", "return the shadow info"),
112   ARGPARSE_c (oShowKeygrip, "show-keygrip", "show the \"keygrip\""),
113   ARGPARSE_c (oS2Kcalibration, "s2k-calibration", "@"),
114
115   ARGPARSE_group (301, N_("@\nOptions:\n ")),
116
117   ARGPARSE_s_n (oVerbose, "verbose", "verbose"),
118   ARGPARSE_s_n (oArmor, "armor", "write output in advanced format"),
119   ARGPARSE_s_n (oCanonical, "canonical", "write output in canonical format"),
120
121   ARGPARSE_s_s (oPassphrase, "passphrase", "|STRING|use passphrase STRING"),
122   ARGPARSE_s_n (oHaveCert, "have-cert",
123                 "certificate to export provided on STDIN"),
124   ARGPARSE_s_n (oStore,    "store",
125                 "store the created key in the appropriate place"),
126   ARGPARSE_s_n (oForce,    "force",
127                 "force overwriting"),
128   ARGPARSE_s_n (oNoFailOnExist, "no-fail-on-exist", "@"),
129   ARGPARSE_s_s (oHomedir, "homedir", "@"),
130   ARGPARSE_s_s (oPrompt,  "prompt",
131                 "|ESCSTRING|use ESCSTRING as prompt in pinentry"),
132   ARGPARSE_s_n (oStatusMsg, "enable-status-msg", "@"),
133
134   ARGPARSE_s_s (oAgentProgram, "agent-program", "@"),
135
136   ARGPARSE_end ()
137 };
138
139 static const char *
140 my_strusage (int level)
141 {
142   const char *p;
143   switch (level)
144     {
145     case 11: p = "gpg-protect-tool (" GNUPG_NAME ")";
146       break;
147     case 13: p = VERSION; break;
148     case 17: p = PRINTABLE_OS_NAME; break;
149     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
150
151     case 1:
152     case 40: p =  _("Usage: gpg-protect-tool [options] (-h for help)\n");
153       break;
154     case 41: p =  _("Syntax: gpg-protect-tool [options] [args]\n"
155                     "Secret key maintenance tool\n");
156     break;
157
158     default: p = NULL;
159     }
160   return p;
161 }
162
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);
337   rc = agent_protect (key, pw, &result, &resultlen, 0);
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   gnupg_isotime_t protected_at;
370
371   key = read_key (fname);
372   if (!key)
373     return;
374
375   rc = agent_unprotect (NULL, key, (pw=get_passphrase (1)),
376                         protected_at, &result, &resultlen);
377   release_passphrase (pw);
378   xfree (key);
379   if (rc)
380     {
381       if (opt_status_msg)
382         log_info ("[PROTECT-TOOL:] bad-passphrase\n");
383       log_error ("unprotecting the key failed: %s\n", gpg_strerror (rc));
384       return;
385     }
386   if (opt.verbose)
387     log_info ("key protection done at %.4s-%.2s-%.2s %.2s:%.2s:%s\n",
388               protected_at, protected_at+4, protected_at+6,
389               protected_at+9, protected_at+11, protected_at+13);
390
391
392   if (opt_armor)
393     {
394       char *p = make_advanced (result, resultlen);
395       xfree (result);
396       if (!p)
397         return;
398       result = (unsigned char*)p;
399       resultlen = strlen (p);
400     }
401
402   fwrite (result, resultlen, 1, stdout);
403   xfree (result);
404 }
405
406
407 \f
408 static void
409 read_and_shadow (const char *fname)
410 {
411   int  rc;
412   unsigned char *key;
413   unsigned char *result;
414   size_t resultlen;
415   unsigned char dummy_info[] = "(8:313233342:43)";
416
417   key = read_key (fname);
418   if (!key)
419     return;
420
421   rc = agent_shadow_key (key, dummy_info, &result);
422   xfree (key);
423   if (rc)
424     {
425       log_error ("shadowing the key failed: %s\n", gpg_strerror (rc));
426       return;
427     }
428   resultlen = gcry_sexp_canon_len (result, 0, NULL,NULL);
429   assert (resultlen);
430
431   if (opt_armor)
432     {
433       char *p = make_advanced (result, resultlen);
434       xfree (result);
435       if (!p)
436         return;
437       result = (unsigned char*)p;
438       resultlen = strlen (p);
439     }
440
441   fwrite (result, resultlen, 1, stdout);
442   xfree (result);
443 }
444
445 static void
446 show_shadow_info (const char *fname)
447 {
448   int  rc;
449   unsigned char *key;
450   const unsigned char *info;
451   size_t infolen;
452
453   key = read_key (fname);
454   if (!key)
455     return;
456
457   rc = agent_get_shadow_info (key, &info);
458   xfree (key);
459   if (rc)
460     {
461       log_error ("get_shadow_info failed: %s\n", gpg_strerror (rc));
462       return;
463     }
464   infolen = gcry_sexp_canon_len (info, 0, NULL,NULL);
465   assert (infolen);
466
467   if (opt_armor)
468     {
469       char *p = make_advanced (info, infolen);
470       if (!p)
471         return;
472       fwrite (p, strlen (p), 1, stdout);
473       xfree (p);
474     }
475   else
476     fwrite (info, infolen, 1, stdout);
477 }
478
479
480 static void
481 show_file (const char *fname)
482 {
483   unsigned char *key;
484   size_t keylen;
485   char *p;
486
487   key = read_key (fname);
488   if (!key)
489     return;
490
491   keylen = gcry_sexp_canon_len (key, 0, NULL,NULL);
492   assert (keylen);
493
494   if (opt_canonical)
495     {
496       fwrite (key, keylen, 1, stdout);
497     }
498   else
499     {
500       p = make_advanced (key, keylen);
501       if (p)
502         {
503           fwrite (p, strlen (p), 1, stdout);
504           xfree (p);
505         }
506     }
507   xfree (key);
508 }
509
510 static void
511 show_keygrip (const char *fname)
512 {
513   unsigned char *key;
514   gcry_sexp_t private;
515   unsigned char grip[20];
516   int i;
517
518   key = read_key (fname);
519   if (!key)
520     return;
521
522   if (gcry_sexp_new (&private, key, 0, 0))
523     {
524       log_error ("gcry_sexp_new failed\n");
525       return;
526     }
527   xfree (key);
528
529   if (!gcry_pk_get_keygrip (private, grip))
530     {
531       log_error ("can't calculate keygrip\n");
532       return;
533     }
534   gcry_sexp_release (private);
535
536   for (i=0; i < 20; i++)
537     printf ("%02X", grip[i]);
538   putchar ('\n');
539 }
540
541 \f
542
543
544 \f
545 int
546 main (int argc, char **argv )
547 {
548   ARGPARSE_ARGS pargs;
549   int cmd = 0;
550   const char *fname;
551
552   early_system_init ();
553   set_strusage (my_strusage);
554   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
555   log_set_prefix ("gpg-protect-tool", 1);
556
557   /* Make sure that our subsystems are ready.  */
558   i18n_init ();
559   init_common_subsystems (&argc, &argv);
560
561   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
562     {
563       log_fatal( _("%s is too old (need %s, have %s)\n"), "libgcrypt",
564                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
565     }
566
567   setup_libgcrypt_logging ();
568   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
569
570
571   opt_homedir = default_homedir ();
572
573
574   pargs.argc = &argc;
575   pargs.argv = &argv;
576   pargs.flags=  1;  /* (do not remove the args) */
577   while (arg_parse (&pargs, opts) )
578     {
579       switch (pargs.r_opt)
580         {
581         case oVerbose: opt.verbose++; break;
582         case oArmor:   opt_armor=1; break;
583         case oCanonical: opt_canonical=1; break;
584         case oHomedir: opt_homedir = pargs.r.ret_str; break;
585
586         case oAgentProgram: opt_agent_program = pargs.r.ret_str; break;
587
588         case oProtect: cmd = oProtect; break;
589         case oUnprotect: cmd = oUnprotect; break;
590         case oShadow: cmd = oShadow; break;
591         case oShowShadowInfo: cmd = oShowShadowInfo; break;
592         case oShowKeygrip: cmd = oShowKeygrip; break;
593         case oS2Kcalibration: cmd = oS2Kcalibration; break;
594
595         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
596         case oStore: opt_store = 1; break;
597         case oForce: opt_force = 1; break;
598         case oNoFailOnExist: opt_no_fail_on_exist = 1; break;
599         case oHaveCert: opt_have_cert = 1; break;
600         case oPrompt: opt_prompt = pargs.r.ret_str; break;
601         case oStatusMsg: opt_status_msg = 1; break;
602
603         default: pargs.err = ARGPARSE_PRINT_ERROR; break;
604         }
605     }
606   if (log_get_errorcount (0))
607     exit (2);
608
609   fname = "-";
610   if (argc == 1)
611     fname = *argv;
612   else if (argc > 1)
613     usage (1);
614
615   /* Set the information which can't be taken from envvars.  */
616   gnupg_prepare_get_passphrase (GPG_ERR_SOURCE_DEFAULT,
617                                 opt.verbose,
618                                 opt_homedir,
619                                 opt_agent_program,
620                                 NULL, NULL, NULL);
621
622   if (opt_prompt)
623     opt_prompt = percent_plus_unescape (opt_prompt, 0);
624
625   if (cmd == oProtect)
626     read_and_protect (fname);
627   else if (cmd == oUnprotect)
628     read_and_unprotect (fname);
629   else if (cmd == oShadow)
630     read_and_shadow (fname);
631   else if (cmd == oShowShadowInfo)
632     show_shadow_info (fname);
633   else if (cmd == oShowKeygrip)
634     show_keygrip (fname);
635   else if (cmd == oS2Kcalibration)
636     {
637       if (!opt.verbose)
638         opt.verbose++; /* We need to see something.  */
639       get_standard_s2k_count ();
640     }
641   else
642     show_file (fname);
643
644   agent_exit (0);
645   return 8; /*NOTREACHED*/
646 }
647
648 void
649 agent_exit (int rc)
650 {
651   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
652   exit (rc);
653 }
654
655
656 /* Return the passphrase string and ask the agent if it has not been
657    set from the command line  PROMPTNO select the prompt to display:
658      0 = default
659      1 = taken from the option --prompt
660      2 = for unprotecting a pkcs#12 object
661      3 = for protecting a new pkcs#12 object
662      4 = for protecting an imported pkcs#12 in our system
663 */
664 static char *
665 get_passphrase (int promptno)
666 {
667   char *pw;
668   int err;
669   const char *desc;
670   char *orig_codeset;
671   int repeat = 0;
672
673   if (opt_passphrase)
674     return xstrdup (opt_passphrase);
675
676   orig_codeset = i18n_switchto_utf8 ();
677
678   if (promptno == 1 && opt_prompt)
679     {
680       desc = opt_prompt;
681     }
682   else if (promptno == 2)
683     {
684       desc = _("Please enter the passphrase to unprotect the "
685                "PKCS#12 object.");
686     }
687   else if (promptno == 3)
688     {
689       desc = _("Please enter the passphrase to protect the "
690                "new PKCS#12 object.");
691       repeat = 1;
692     }
693   else if (promptno == 4)
694     {
695       desc = _("Please enter the passphrase to protect the "
696                "imported object within the GnuPG system.");
697       repeat = 1;
698     }
699   else
700     desc = _("Please enter the passphrase or the PIN\n"
701              "needed to complete this operation.");
702
703   i18n_switchback (orig_codeset);
704
705   err = gnupg_get_passphrase (NULL, NULL, _("Passphrase:"), desc,
706                               repeat, repeat, 1, &pw);
707   if (err)
708     {
709       if (gpg_err_code (err) == GPG_ERR_CANCELED
710           || gpg_err_code (err) == GPG_ERR_FULLY_CANCELED)
711         log_info (_("cancelled\n"));
712       else
713         log_error (_("error while asking for the passphrase: %s\n"),
714                    gpg_strerror (err));
715       agent_exit (0);
716     }
717   assert (pw);
718
719   return pw;
720 }
721
722
723 static void
724 release_passphrase (char *pw)
725 {
726   if (pw)
727     {
728       wipememory (pw, strlen (pw));
729       xfree (pw);
730     }
731 }
732
733
734 /* Stub function.  */
735 gpg_error_t
736 convert_from_openpgp_native (gcry_sexp_t s_pgp, const char *passphrase,
737                              unsigned char **r_key)
738 {
739   (void)s_pgp;
740   (void)passphrase;
741   (void)r_key;
742   return gpg_error (GPG_ERR_BUG);
743 }