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