sm: Change default algos to SHA256 (CSR) and AES128 (bulk encryption).
[gnupg.git] / scd / sc-copykeys.c
1 /* sc-copykeys.c - A tool to store keys on a smartcard.
2  *      Copyright (C) 2003 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 <string.h>
25 #include <assert.h>
26 #include <sys/types.h>
27 #include <sys/stat.h>
28 #include <unistd.h>
29
30 #define JNLIB_NEED_LOG_LOGV
31 #include "scdaemon.h"
32 #include <gcrypt.h>
33
34 #include "../common/ttyio.h"
35 #include "../common/simple-pwquery.h"
36 #include "iso7816.h"
37 #include "apdu.h" /* for open_reader */
38 #include "atr.h"
39 #include "app-common.h"
40
41 #define _(a) (a)
42
43
44 enum cmd_and_opt_values
45 { oVerbose        = 'v',
46   oReaderPort     = 500,
47   octapiDriver,
48   oDebug,
49   oDebugAll,
50
51 aTest };
52
53
54 static ARGPARSE_OPTS opts[] = {
55
56   { 301, NULL, 0, "@Options:\n " },
57
58   { oVerbose, "verbose",   0, "verbose" },
59   { oReaderPort, "reader-port", 2, "|N|connect to reader at port N"},
60   { octapiDriver, "ctapi-driver", 2, "NAME|use NAME as ctAPI driver"},
61   { oDebug,     "debug"     ,4|16, "set debugging flags"},
62   { oDebugAll, "debug-all" ,0, "enable full debugging"},
63   {0}
64 };
65
66
67 static void copykeys (APP app, const char *fname);
68
69
70 static const char *
71 my_strusage (int level)
72 {
73   const char *p;
74   switch (level)
75     {
76     case 11: p = "sc-copykeys (GnuPG)";
77       break;
78     case 13: p = VERSION; break;
79     case 17: p = PRINTABLE_OS_NAME; break;
80     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
81
82     case 1:
83     case 40: p =  _("Usage: sc-copykeys [options] (-h for help)\n");
84       break;
85     case 41: p = _("Syntax: sc-copykeys [options] "
86                    "file-with-key\n"
87                     "Copy keys to a smartcards\n");
88     break;
89
90     default: p = NULL;
91     }
92   return p;
93 }
94
95
96 int
97 main (int argc, char **argv )
98 {
99   ARGPARSE_ARGS pargs;
100   int slot, rc;
101   const char *reader_port = NULL;
102   struct app_ctx_s appbuf;
103
104   memset (&appbuf, 0, sizeof appbuf);
105
106   set_strusage (my_strusage);
107   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
108   log_set_prefix ("sc-copykeys", 1);
109
110   /* check that the libraries are suitable.  Do it here because
111      the option parsing may need services of the library */
112   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
113     {
114       log_fatal (_("%s is too old (need %s, have %s)\n"), "libgcrypt",
115                  NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
116     }
117
118   setup_libgcrypt_logging ();
119   gcry_control (GCRYCTL_DISABLE_SECMEM, 0); /* FIXME - we want to use it */
120   /* FIXME? gcry_control (GCRYCTL_USE_SECURE_RNDPOOL);*/
121
122   pargs.argc = &argc;
123   pargs.argv = &argv;
124   pargs.flags=  1;  /* do not remove the args */
125   while (arg_parse (&pargs, opts) )
126     {
127       switch (pargs.r_opt)
128         {
129         case oVerbose: opt.verbose++; break;
130         case oDebug: opt.debug |= pargs.r.ret_ulong; break;
131         case oDebugAll: opt.debug = ~0; break;
132         case oReaderPort: reader_port = pargs.r.ret_str; break;
133         case octapiDriver: opt.ctapi_driver = pargs.r.ret_str; break;
134         default : pargs.err = 2; break;
135         }
136     }
137   if (log_get_errorcount(0))
138     exit(2);
139
140   if (argc != 1)
141     usage (1);
142
143   slot = apdu_open_reader (reader_port);
144   if (slot == -1)
145     exit (1);
146   if (apdu_connect (slot))
147     exit (1);
148
149   /* FIXME: Use select_application. */
150   appbuf.slot = slot;
151   rc = app_select_openpgp (&appbuf);
152   if (rc)
153     {
154       log_error ("selecting openpgp failed: %s\n", gpg_strerror (rc));
155       exit (1);
156     }
157   appbuf.initialized = 1;
158   log_info ("openpgp application selected\n");
159
160   copykeys (&appbuf, *argv);
161
162
163   return 0;
164 }
165
166
167
168 void
169 send_status_info (CTRL ctrl, const char *keyword, ...)
170 {
171   /* DUMMY */
172 }
173
174
175
176 static char *
177 read_file (const char *fname, size_t *r_length)
178 {
179   FILE *fp;
180   struct stat st;
181   char *buf;
182   size_t buflen;
183
184   fp = fname? fopen (fname, "rb") : stdin;
185   if (!fp)
186     {
187       log_error ("can't open '%s': %s\n",
188                  fname? fname: "[stdin]", strerror (errno));
189       return NULL;
190     }
191
192   if (fstat (fileno(fp), &st))
193     {
194       log_error ("can't stat '%s': %s\n",
195                  fname? fname: "[stdin]", strerror (errno));
196       if (fname)
197         fclose (fp);
198       return NULL;
199     }
200
201   buflen = st.st_size;
202   buf = xmalloc (buflen+1);
203   if (fread (buf, buflen, 1, fp) != 1)
204     {
205       log_error ("error reading '%s': %s\n",
206                  fname? fname: "[stdin]", strerror (errno));
207       if (fname)
208         fclose (fp);
209       xfree (buf);
210       return NULL;
211     }
212   if (fname)
213     fclose (fp);
214
215   *r_length = buflen;
216   return buf;
217 }
218
219
220 static gcry_sexp_t
221 read_key (const char *fname)
222 {
223   char *buf;
224   size_t buflen;
225   gcry_sexp_t private;
226   int rc;
227
228   buf = read_file (fname, &buflen);
229   if (!buf)
230     return NULL;
231
232   rc = gcry_sexp_new (&private, buf, buflen, 1);
233   if (rc)
234     {
235       log_error ("gcry_sexp_new failed: %s\n", gpg_strerror (rc));
236       return NULL;
237     }
238   xfree (buf);
239
240   return private;
241 }
242
243
244
245 static gcry_mpi_t *
246 sexp_to_kparms (gcry_sexp_t sexp, unsigned long *created)
247 {
248   gcry_sexp_t list, l2;
249   const char *name;
250   const char *s;
251   size_t n;
252   int i, idx;
253   const char *elems;
254   gcry_mpi_t *array;
255
256   *created = 0;
257   list = gcry_sexp_find_token (sexp, "private-key", 0 );
258   if(!list)
259     return NULL;
260
261   /* quick hack to get the creation time. */
262   l2 = gcry_sexp_find_token (list, "created", 0);
263   if (l2 && (name = gcry_sexp_nth_data (l2, 1, &n)))
264     {
265       char *tmp = xmalloc (n+1);
266       memcpy (tmp, name, n);
267       tmp[n] = 0;
268       *created = strtoul (tmp, NULL, 10);
269       xfree (tmp);
270     }
271   gcry_sexp_release (l2);
272   l2 = gcry_sexp_cadr (list);
273   gcry_sexp_release (list);
274   list = l2;
275   name = gcry_sexp_nth_data (list, 0, &n);
276   if(!name || n != 3 || memcmp (name, "rsa", 3))
277     {
278       gcry_sexp_release (list);
279       return NULL;
280     }
281
282   /* Parameter names used with RSA. */
283   elems = "nedpqu";
284   array = xcalloc (strlen(elems) + 1, sizeof *array);
285   for (idx=0, s=elems; *s; s++, idx++ )
286     {
287       l2 = gcry_sexp_find_token (list, s, 1);
288       if (!l2)
289         {
290           for (i=0; i<idx; i++)
291             gcry_mpi_release (array[i]);
292           xfree (array);
293           gcry_sexp_release (list);
294           return NULL; /* required parameter not found */
295         }
296       array[idx] = gcry_sexp_nth_mpi (l2, 1, GCRYMPI_FMT_USG);
297       gcry_sexp_release (l2);
298       if (!array[idx])
299         {
300           for (i=0; i<idx; i++)
301             gcry_mpi_release (array[i]);
302           xfree (array);
303           gcry_sexp_release (list);
304           return NULL; /* required parameter is invalid */
305         }
306     }
307
308   gcry_sexp_release (list);
309   return array;
310 }
311
312
313 /* Return true if the SHA1 fingerprint FPR consists only of zeroes. */
314 static int
315 fpr_is_zero (const char *fpr)
316 {
317   int i;
318
319   for (i=0; i < 20 && !fpr[i]; i++)
320     ;
321   return (i == 20);
322 }
323
324
325 static void
326 show_sha1_fpr (const unsigned char *fpr)
327 {
328   int i;
329
330   if (fpr)
331     {
332       for (i=0; i < 20 ; i+=2, fpr += 2 )
333         {
334           if (i == 10 )
335             tty_printf (" ");
336           tty_printf (" %02X%02X", *fpr, fpr[1]);
337         }
338     }
339   else
340     tty_printf (" [none]");
341   tty_printf ("\n");
342 }
343
344 /* Query the card, show a list of already stored keys and ask the user
345    where to store the key.  Returns the key number or 0 for cancel
346    operation. */
347 static int
348 query_card (APP app)
349 {
350   int keyno = 0;
351   char *serialno, *disp_name, *pubkey_url;
352   unsigned char *fpr1, *fpr2, *fpr3;
353
354
355   if (app_openpgp_cardinfo (app,
356                             &serialno,
357                             &disp_name,
358                             &pubkey_url,
359                             &fpr1, &fpr2, &fpr3))
360     return 0;
361
362
363   for (;;)
364     {
365       char *answer;
366
367       tty_printf ("\n");
368
369       tty_printf ("Serial number ....: %s\n",
370                   serialno? serialno : "[none]");
371       tty_printf ("Name of cardholder: %s\n",
372                   disp_name && *disp_name? disp_name : "[not set]");
373       tty_printf ("URL of public key : %s\n",
374                   pubkey_url && *pubkey_url? pubkey_url : "[not set]");
375       tty_printf ("Signature key ....:");
376       show_sha1_fpr (fpr1);
377       tty_printf ("Encryption key....:");
378       show_sha1_fpr (fpr2);
379       tty_printf ("Authentication key:");
380       show_sha1_fpr (fpr3);
381
382       tty_printf ("\n"
383                   "1 - store as signature key and reset usage counter\n"
384                   "2 - store as encryption key\n"
385                   "3 - store as authentication key\n"
386                   "Q - quit\n"
387                   "\n");
388
389       answer = tty_get("Your selection? ");
390       tty_kill_prompt();
391       if (strlen (answer) != 1)
392         ;
393       else if ( *answer == '1' )
394         {
395           if ( (fpr1 && !fpr_is_zero (fpr1)) )
396             {
397               tty_printf ("\n");
398               log_error ("WARNING: signature key does already exists!\n");
399               tty_printf ("\n");
400               if ( tty_get_answer_is_yes ("Replace existing key? ") )
401                 {
402                   keyno = 1;
403                   break;
404                 }
405             }
406           else
407             {
408               keyno = 1;
409               break;
410             }
411         }
412       else if ( *answer == '2' )
413         {
414           if ( (fpr2 && !fpr_is_zero (fpr2)) )
415             {
416               tty_printf ("\n");
417               log_error ("WARNING: encryption key does already exists!\n");
418               tty_printf ("\n");
419               if ( tty_get_answer_is_yes ("Replace existing key? ") )
420                 {
421                   keyno = 2;
422                   break;
423                 }
424             }
425           else
426             {
427               keyno = 2;
428               break;
429             }
430         }
431       else if ( *answer == '3' )
432         {
433           if ( (fpr3 && !fpr_is_zero (fpr3)) )
434             {
435               tty_printf ("\n");
436               log_error ("WARNING: authentication key does already exists!\n");
437               tty_printf ("\n");
438               if ( tty_get_answer_is_yes ("Replace existing key? ") )
439                 {
440                   keyno = 3;
441                   break;
442                 }
443             }
444           else
445             {
446               keyno = 3;
447               break;
448             }
449         }
450       else if ( *answer == 'q' || *answer == 'Q')
451         {
452           keyno = 0;
453           break;
454         }
455     }
456
457   xfree (serialno);
458   xfree (disp_name);
459   xfree (pubkey_url);
460   xfree (fpr1);
461   xfree (fpr2);
462   xfree (fpr3);
463
464   return keyno;
465 }
466
467
468 /* Callback function to ask for a PIN. */
469 static gpg_error_t
470 pincb (void *arg, const char *prompt, char **pinvalue)
471 {
472   char *pin = xstrdup ("12345678");
473
474 /*    pin = simple_pwquery (NULL, NULL, prompt, */
475 /*                          "We need the admin's PIN to store the key on the card", */
476 /*                          0, NULL); */
477 /*    if (!pin) */
478 /*      return gpg_error (GPG_ERR_CANCELED); */
479
480
481
482   *pinvalue = pin;
483   return 0;
484 }
485
486
487 /* This function expects a file (or NULL for stdin) with the secret
488    and public key parameters.  This file should consist of an
489    S-expression as used by gpg-agent. Only the unprotected format is
490    supported.  Example:
491
492    (private-key
493     (rsa
494      (n #00e0ce9..[some bytes not shown]..51#)
495      (e #010001#)
496      (d #046129F..[some bytes not shown]..81#)
497      (p #00e861b..[some bytes not shown]..f1#)
498      (q #00f7a7c..[some bytes not shown]..61#)
499      (u #304559a..[some bytes not shown]..9b#))
500     (uri http://foo.bar x-foo:whatever_you_want))
501
502 */
503 static void
504 copykeys (APP app, const char *fname)
505 {
506   int rc;
507   gcry_sexp_t private;
508   gcry_mpi_t *mpis, rsa_n, rsa_e, rsa_p, rsa_q;
509   unsigned int nbits;
510   size_t n;
511   unsigned char *template, *tp;
512   unsigned char m[128], e[4];
513   size_t mlen, elen;
514   unsigned long creation_date;
515   time_t created_at;
516   int keyno;
517
518   if (!strcmp (fname, "-"))
519     fname = NULL;
520
521   private = read_key (fname);
522   if (!private)
523     exit (1);
524
525   mpis = sexp_to_kparms (private, &creation_date);
526   if (!creation_date)
527     {
528       log_info ("no creation date found - assuming current date\n");
529       created_at = time (NULL);
530     }
531   else
532     created_at = creation_date;
533   gcry_sexp_release (private);
534   if (!mpis)
535     {
536       log_error ("invalid structure of key file or not RSA\n");
537       exit (1);
538     }
539   /* MPIS is now an array with the key parameters as defined by OpenPGP. */
540   rsa_n = mpis[0];
541   rsa_e = mpis[1];
542   gcry_mpi_release (mpis[2]);
543   rsa_p = mpis[3];
544   rsa_q = mpis[4];
545   gcry_mpi_release (mpis[5]);
546   xfree (mpis);
547
548   nbits = gcry_mpi_get_nbits (rsa_e);
549   if (nbits < 2 || nbits > 32)
550     {
551       log_error ("public exponent too large (more than 32 bits)\n");
552       goto failure;
553     }
554   nbits = gcry_mpi_get_nbits (rsa_p);
555   if (nbits != 512)
556     {
557       log_error ("length of first RSA prime is not 512\n");
558       goto failure;
559     }
560   nbits = gcry_mpi_get_nbits (rsa_q);
561   if (nbits != 512)
562     {
563       log_error ("length of second RSA prime is not 512\n");
564       goto failure;
565     }
566
567   nbits = gcry_mpi_get_nbits (rsa_n);
568   if (nbits != 1024)
569     {
570       log_error ("length of RSA modulus is not 1024\n");
571       goto failure;
572     }
573
574   keyno = query_card (app);
575   if (!keyno)
576     goto failure;
577
578   /* Build the private key template as described in section 4.3.3.6 of
579      the specs.
580                    0xC0   <length> public exponent
581                    0xC1   <length> prime p
582                    0xC2   <length> prime q  */
583   template = tp = xmalloc (1+2 + 1+1+4 + 1+1+64 + 1+1+64);
584   *tp++ = 0xC0;
585   *tp++ = 4;
586   rc = gcry_mpi_print (GCRYMPI_FMT_USG, tp, 4, &n, rsa_e);
587   if (rc)
588     {
589       log_error ("mpi_print failed: %s\n", gpg_strerror (rc));
590       goto failure;
591     }
592   assert (n <= 4);
593   memcpy (e, tp, n);
594   elen = n;
595   if (n != 4)
596     {
597       memmove (tp+4-n, tp, 4-n);
598       memset (tp, 0, 4-n);
599     }
600   tp += 4;
601
602   *tp++ = 0xC1;
603   *tp++ = 64;
604   rc = gcry_mpi_print (GCRYMPI_FMT_USG, tp, 64, &n, rsa_p);
605   if (rc)
606     {
607       log_error ("mpi_print failed: %s\n", gpg_strerror (rc));
608       goto failure;
609     }
610   assert (n == 64);
611   tp += 64;
612
613   *tp++ = 0xC2;
614   *tp++ = 64;
615   rc = gcry_mpi_print (GCRYMPI_FMT_USG, tp, 64, &n, rsa_q);
616   if (rc)
617     {
618       log_error ("mpi_print failed: %s\n", gpg_strerror (rc));
619       goto failure;
620     }
621   assert (n == 64);
622   tp += 64;
623   assert (tp - template == 138);
624
625   /* (we need the modulus to calculate the fingerprint) */
626   rc = gcry_mpi_print (GCRYMPI_FMT_USG, m, 128, &n, rsa_n);
627   if (rc)
628     {
629       log_error ("mpi_print failed: %s\n", gpg_strerror (rc));
630       goto failure;
631     }
632   assert (n == 128);
633   mlen = 128;
634
635
636   rc = app_openpgp_storekey (app, keyno,
637                              template, tp - template,
638                              created_at,
639                              m, mlen,
640                              e, elen,
641                              pincb, NULL);
642
643   if (rc)
644     {
645       log_error ("error storing key: %s\n", gpg_strerror (rc));
646       goto failure;
647     }
648   log_info ("key successfully stored\n");
649   {
650     unsigned char *mm, *ee;
651     size_t mmlen, eelen;
652     int i;
653
654     rc = app_openpgp_readkey (app, keyno, &mm, &mmlen, &ee, &eelen);
655     if (rc)
656       {
657         log_error ("error reading key back: %s\n", gpg_strerror (rc));
658         goto failure;
659       }
660
661     /* Strip leading zeroes. */
662     for (i=0; i < mmlen && !mm[i]; i++)
663       ;
664     mmlen -= i;
665     memmove (mm, mm+i, mmlen);
666     for (i=0; i < eelen && !ee[i]; i++)
667       ;
668     eelen -= i;
669     memmove (ee, ee+i, eelen);
670
671     if (eelen != elen || mmlen != mlen)
672       {
673         log_error ("key parameter length mismatch (n=%u/%u, e=%u/%u)\n",
674                    (unsigned int)mlen, (unsigned int)mmlen,
675                    (unsigned int)elen, (unsigned int)eelen);
676         xfree (mm);
677         xfree (ee);
678         goto failure;
679       }
680
681     if (memcmp (m, mm, mlen))
682       {
683         log_error ("key parameter n mismatch\n");
684         log_printhex ("original n: ", m, mlen);
685         log_printhex ("  copied n: ", mm, mlen);
686         xfree (mm);
687         xfree (ee);
688         goto failure;
689       }
690     if (memcmp (e, ee, elen))
691       {
692         log_error ("key parameter e mismatch\n");
693         log_printhex ("original e: ", e, elen);
694         log_printhex ("  copied e: ", ee, elen);
695         xfree (mm);
696         xfree (ee);
697         goto failure;
698       }
699     xfree (mm);
700     xfree (ee);
701   }
702
703
704   gcry_mpi_release (rsa_e);
705   gcry_mpi_release (rsa_p);
706   gcry_mpi_release (rsa_q);
707   gcry_mpi_release (rsa_n);
708   return;
709
710  failure:
711   gcry_mpi_release (rsa_e);
712   gcry_mpi_release (rsa_p);
713   gcry_mpi_release (rsa_q);
714   gcry_mpi_release (rsa_n);
715   exit (1);
716 }