Import/export of pkcs#12 now uses the gpg-agent directly.
[gnupg.git] / sm / export.c
1 /* export.c - Export certificates and private keys.
2  * Copyright (C) 2002, 2003, 2004, 2007, 2009 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 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <time.h>
26 #include <assert.h>
27
28 #include "gpgsm.h"
29 #include <gcrypt.h>
30 #include <ksba.h>
31
32 #include "keydb.h"
33 #include "exechelp.h"
34 #include "i18n.h"
35 #include "sysutils.h"
36
37
38
39 /* A table to store a fingerprint as used in a duplicates table.  We
40    don't need to hash here because a fingerprint is already a perfect
41    hash value.  This we use the most significant bits to index the
42    table and then use a linked list for the overflow.  Possible
43    enhancement for very large number of certificates:  Add a second
44    level table and then resort to a linked list.  */
45 struct duptable_s
46 {
47   struct duptable_s *next;
48
49   /* Note that we only need to store 19 bytes because the first byte
50      is implictly given by the table index (we require at least 8
51      bits). */
52   unsigned char fpr[19];
53 };
54 typedef struct duptable_s *duptable_t;
55 #define DUPTABLE_BITS 12
56 #define DUPTABLE_SIZE (1 << DUPTABLE_BITS)
57
58
59 static void print_short_info (ksba_cert_t cert, FILE *fp, estream_t stream);
60 static gpg_error_t export_p12 (ctrl_t ctrl,
61                                const unsigned char *certimg, size_t certimglen,
62                                const char *prompt, const char *keygrip,
63                                FILE **retfp);
64
65
66 /* Create a table used to indetify duplicated certificates. */
67 static duptable_t *
68 create_duptable (void)
69 {
70   return xtrycalloc (DUPTABLE_SIZE, sizeof (duptable_t));
71 }
72
73 static void
74 destroy_duptable (duptable_t *table)
75 {
76   int idx;
77   duptable_t t, t2;
78
79   if (table)
80     {
81       for (idx=0; idx < DUPTABLE_SIZE; idx++) 
82         for (t = table[idx]; t; t = t2)
83           {
84             t2 = t->next;
85             xfree (t);
86           }
87       xfree (table);
88     }
89 }
90
91 /* Insert the 20 byte fingerprint FPR into TABLE.  Sets EXITS to true
92    if the fingerprint already exists in the table. */
93 static gpg_error_t
94 insert_duptable (duptable_t *table, unsigned char *fpr, int *exists)
95 {
96   size_t idx;
97   duptable_t t;
98   
99   *exists = 0;
100   idx = fpr[0];
101 #if DUPTABLE_BITS > 16 || DUPTABLE_BITS < 8
102 #error cannot handle a table larger than 16 bits or smaller than 8 bits
103 #elif DUPTABLE_BITS > 8
104   idx <<= (DUPTABLE_BITS - 8);  
105   idx |= (fpr[1] & ~(~0 << 4)); 
106 #endif  
107
108   for (t = table[idx]; t; t = t->next)
109     if (!memcmp (t->fpr, fpr+1, 19))
110       break;
111   if (t)
112     {
113       *exists = 1;
114       return 0;
115     }
116   /* Insert that fingerprint. */
117   t = xtrymalloc (sizeof *t);
118   if (!t)
119     return gpg_error_from_syserror ();
120   memcpy (t->fpr, fpr+1, 19);
121   t->next = table[idx];
122   table[idx] = t;
123   return 0;
124 }
125
126
127
128
129 /* Export all certificates or just those given in NAMES. If STREAM is
130    not NULL the output is send to this extended stream. */
131 void
132 gpgsm_export (ctrl_t ctrl, strlist_t names, FILE *fp, estream_t stream)
133 {
134   KEYDB_HANDLE hd = NULL;
135   KEYDB_SEARCH_DESC *desc = NULL;
136   int ndesc;
137   Base64Context b64writer = NULL;
138   ksba_writer_t writer;
139   strlist_t sl;
140   ksba_cert_t cert = NULL;
141   int rc=0;
142   int count = 0;
143   int i;
144   duptable_t *dtable;
145
146   
147   dtable = create_duptable ();
148   if (!dtable)
149     {
150       log_error ("creating duplicates table failed: %s\n", strerror (errno));
151       goto leave;
152     }
153
154   hd = keydb_new (0);
155   if (!hd)
156     {
157       log_error ("keydb_new failed\n");
158       goto leave;
159     }
160
161   if (!names)
162     ndesc = 1;
163   else
164     {
165       for (sl=names, ndesc=0; sl; sl = sl->next, ndesc++) 
166         ;
167     }
168
169   desc = xtrycalloc (ndesc, sizeof *desc);
170   if (!ndesc)
171     {
172       log_error ("allocating memory for export failed: %s\n",
173                  gpg_strerror (out_of_core ()));
174       goto leave;
175     }
176
177   if (!names)
178     desc[0].mode = KEYDB_SEARCH_MODE_FIRST;
179   else 
180     {
181       for (ndesc=0, sl=names; sl; sl = sl->next) 
182         {
183           rc = keydb_classify_name (sl->d, desc+ndesc);
184           if (rc)
185             {
186               log_error ("key `%s' not found: %s\n",
187                          sl->d, gpg_strerror (rc));
188               rc = 0;
189             }
190           else
191             ndesc++;
192         }
193     }
194
195   /* If all specifications are done by fingerprint or keygrip, we
196      switch to ephemeral mode so that _all_ currently available and
197      matching certificates are exported.  */
198   if (names && ndesc)
199     {
200       for (i=0; (i < ndesc
201                  && (desc[i].mode == KEYDB_SEARCH_MODE_FPR
202                      || desc[i].mode == KEYDB_SEARCH_MODE_FPR20
203                      || desc[i].mode == KEYDB_SEARCH_MODE_FPR16
204                      || desc[i].mode == KEYDB_SEARCH_MODE_KEYGRIP)); i++)
205         ;
206       if (i == ndesc)
207         keydb_set_ephemeral (hd, 1);
208     }
209       
210   while (!(rc = keydb_search (hd, desc, ndesc)))
211     {
212       unsigned char fpr[20];
213       int exists;
214
215       if (!names) 
216         desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
217
218       rc = keydb_get_cert (hd, &cert);
219       if (rc) 
220         {
221           log_error ("keydb_get_cert failed: %s\n", gpg_strerror (rc));
222           goto leave;
223         }
224
225       gpgsm_get_fingerprint (cert, 0, fpr, NULL);
226       rc = insert_duptable (dtable, fpr, &exists);
227       if (rc)
228         {
229           log_error ("inserting into duplicates table failed: %s\n",
230                      gpg_strerror (rc));
231           goto leave;
232         }
233
234       if (!exists && count && !ctrl->create_pem)
235         {
236           log_info ("exporting more than one certificate "
237                     "is not possible in binary mode\n");
238           log_info ("ignoring other certificates\n");
239           break;
240         }
241
242       if (!exists)
243         {
244           const unsigned char *image;
245           size_t imagelen;
246
247           image = ksba_cert_get_image (cert, &imagelen);
248           if (!image)
249             {
250               log_error ("ksba_cert_get_image failed\n");
251               goto leave;
252             }
253
254
255           if (ctrl->create_pem)
256             {
257               if (count)
258                 {
259                   if (stream)
260                     es_putc ('\n', stream);
261                   else
262                     putc ('\n', fp);
263                 }
264               print_short_info (cert, fp, stream);
265               if (stream)
266                 es_putc ('\n', stream);
267               else
268                 putc ('\n', fp);
269             }
270           count++;
271
272           if (!b64writer)
273             {
274               ctrl->pem_name = "CERTIFICATE";
275               rc = gpgsm_create_writer (&b64writer, ctrl, fp, stream, &writer);
276               if (rc)
277                 {
278                   log_error ("can't create writer: %s\n", gpg_strerror (rc));
279                   goto leave;
280                 }
281             }
282
283           rc = ksba_writer_write (writer, image, imagelen);
284           if (rc)
285             {
286               log_error ("write error: %s\n", gpg_strerror (rc));
287               goto leave;
288             }
289
290           if (ctrl->create_pem)
291             {
292               /* We want one certificate per PEM block */
293               rc = gpgsm_finish_writer (b64writer);
294               if (rc) 
295                 {
296                   log_error ("write failed: %s\n", gpg_strerror (rc));
297                   goto leave;
298                 }
299               gpgsm_destroy_writer (b64writer);
300               b64writer = NULL;
301             }
302         }
303
304       ksba_cert_release (cert); 
305       cert = NULL;
306     }
307   if (rc && rc != -1)
308     log_error ("keydb_search failed: %s\n", gpg_strerror (rc));
309   else if (b64writer)
310     {
311       rc = gpgsm_finish_writer (b64writer);
312       if (rc) 
313         {
314           log_error ("write failed: %s\n", gpg_strerror (rc));
315           goto leave;
316         }
317     }
318   
319  leave:
320   gpgsm_destroy_writer (b64writer);
321   ksba_cert_release (cert);
322   xfree (desc);
323   keydb_release (hd);
324   destroy_duptable (dtable);
325 }
326
327
328 /* Export a certificates and its private key. */
329 void
330 gpgsm_p12_export (ctrl_t ctrl, const char *name, FILE *fp)
331 {
332   KEYDB_HANDLE hd;
333   KEYDB_SEARCH_DESC *desc = NULL;
334   Base64Context b64writer = NULL;
335   ksba_writer_t writer;
336   ksba_cert_t cert = NULL;
337   int rc=0;
338   const unsigned char *image;
339   size_t imagelen;
340   char *keygrip = NULL;
341   char *prompt;
342   char buffer[1024];
343   int  nread;
344   FILE *datafp = NULL;
345
346
347   hd = keydb_new (0);
348   if (!hd)
349     {
350       log_error ("keydb_new failed\n");
351       goto leave;
352     }
353
354   desc = xtrycalloc (1, sizeof *desc);
355   if (!desc)
356     {
357       log_error ("allocating memory for export failed: %s\n",
358                  gpg_strerror (out_of_core ()));
359       goto leave;
360     }
361
362   rc = keydb_classify_name (name, desc);
363   if (rc)
364     {
365       log_error ("key `%s' not found: %s\n",
366                  name, gpg_strerror (rc));
367       goto leave;
368     }
369
370   /* Lookup the certificate and make sure that it is unique. */
371   rc = keydb_search (hd, desc, 1);
372   if (!rc)
373     {
374       rc = keydb_get_cert (hd, &cert);
375       if (rc) 
376         {
377           log_error ("keydb_get_cert failed: %s\n", gpg_strerror (rc));
378           goto leave;
379         }
380
381     next_ambiguous:      
382       rc = keydb_search (hd, desc, 1);
383       if (!rc)
384         {
385           ksba_cert_t cert2 = NULL;
386
387           if (!keydb_get_cert (hd, &cert2))
388             {
389               if (gpgsm_certs_identical_p (cert, cert2))
390                 {
391                   ksba_cert_release (cert2);
392                   goto next_ambiguous;
393                 }
394               ksba_cert_release (cert2);
395             }
396           rc = gpg_error (GPG_ERR_AMBIGUOUS_NAME);
397         }
398       else if (rc == -1 || gpg_err_code (rc) == GPG_ERR_EOF)
399         rc = 0;
400       if (rc)
401         {
402           log_error ("key `%s' not found: %s\n",
403                      name, gpg_strerror (rc));
404           goto leave;
405         }
406     }
407       
408   keygrip = gpgsm_get_keygrip_hexstring (cert);
409   if (!keygrip || gpgsm_agent_havekey (ctrl, keygrip))
410     {
411       /* Note, that the !keygrip case indicates a bad certificate. */
412       rc = gpg_error (GPG_ERR_NO_SECKEY);
413       log_error ("can't export key `%s': %s\n", name, gpg_strerror (rc));
414       goto leave;
415     }
416   
417   image = ksba_cert_get_image (cert, &imagelen);
418   if (!image)
419     {
420       log_error ("ksba_cert_get_image failed\n");
421       goto leave;
422     }
423
424   if (ctrl->create_pem)
425     {
426       print_short_info (cert, fp, NULL);
427       putc ('\n', fp);
428     }
429
430   if (opt.p12_charset && ctrl->create_pem)
431     {
432       fprintf (fp, "The passphrase is %s encoded.\n\n",
433                opt.p12_charset);
434     }
435
436   ctrl->pem_name = "PKCS12";
437   rc = gpgsm_create_writer (&b64writer, ctrl, fp, NULL, &writer);
438   if (rc)
439     {
440       log_error ("can't create writer: %s\n", gpg_strerror (rc));
441       goto leave;
442     }
443
444
445   prompt = gpgsm_format_keydesc (cert);
446   rc = export_p12 (ctrl, image, imagelen, prompt, keygrip, &datafp);
447   xfree (prompt);
448   if (rc)
449     goto leave;
450   rewind (datafp);
451   while ( (nread = fread (buffer, 1, sizeof buffer, datafp)) > 0 )
452     if ((rc = ksba_writer_write (writer, buffer, nread)))
453       {
454         log_error ("write failed: %s\n", gpg_strerror (rc));
455         goto leave;
456       }
457   if (ferror (datafp))
458     {
459       rc = gpg_error_from_errno (rc);
460       log_error ("error reading temporary file: %s\n", gpg_strerror (rc));
461       goto leave;
462     }
463
464   if (ctrl->create_pem)
465     {
466       /* We want one certificate per PEM block */
467       rc = gpgsm_finish_writer (b64writer);
468       if (rc) 
469         {
470           log_error ("write failed: %s\n", gpg_strerror (rc));
471           goto leave;
472         }
473       gpgsm_destroy_writer (b64writer);
474       b64writer = NULL;
475     }
476   
477   ksba_cert_release (cert); 
478   cert = NULL;
479
480  leave:
481   if (datafp)
482     fclose (datafp);
483   gpgsm_destroy_writer (b64writer);
484   ksba_cert_release (cert);
485   xfree (desc);
486   keydb_release (hd);
487 }
488
489
490 /* Call either es_putc or the plain putc.  */
491 static void
492 do_putc (int value, FILE *fp, estream_t stream)
493 {
494   if (stream)
495     es_putc (value, stream);
496   else
497     putc (value, fp);
498 }
499
500 /* Call either es_fputs or the plain fputs.  */
501 static void
502 do_fputs (const char *string, FILE *fp, estream_t stream)
503 {
504   if (stream)
505     es_fputs (string, stream);
506   else
507     fputs (string, fp);
508 }
509
510
511 /* Print some info about the certifciate CERT to FP or STREAM */
512 static void
513 print_short_info (ksba_cert_t cert, FILE *fp, estream_t stream)
514 {
515   char *p;
516   ksba_sexp_t sexp;
517   int idx;
518
519   for (idx=0; (p = ksba_cert_get_issuer (cert, idx)); idx++)
520     {
521       do_fputs ((!idx
522                  ?   "Issuer ...: "
523                  : "\n   aka ...: "), fp, stream); 
524       if (stream)
525         gpgsm_es_print_name (stream, p);
526       else
527         gpgsm_print_name (fp, p);
528       xfree (p);
529     }
530   do_putc ('\n', fp, stream);
531
532   do_fputs ("Serial ...: ", fp, stream); 
533   sexp = ksba_cert_get_serial (cert);
534   if (sexp)
535     {
536       int len;
537       const unsigned char *s = sexp;
538       
539       if (*s == '(')
540         {
541           s++;
542           for (len=0; *s && *s != ':' && digitp (s); s++)
543             len = len*10 + atoi_1 (s);
544           if (*s == ':')
545             {
546               if (stream)
547                 es_write_hexstring (stream, s+1, len, 0, NULL);
548               else
549                 print_hexstring (fp, s+1, len, 0);
550             }
551         }
552       xfree (sexp);
553     }
554   do_putc ('\n', fp, stream);
555
556   for (idx=0; (p = ksba_cert_get_subject (cert, idx)); idx++)
557     {
558       do_fputs ((!idx
559                  ?   "Subject ..: "
560                  : "\n    aka ..: "), fp, stream); 
561       if (stream)
562         gpgsm_es_print_name (stream, p);
563       else
564         gpgsm_print_name (fp, p);
565       xfree (p);
566     }
567   do_putc ('\n', fp, stream);
568 }
569
570
571 static gpg_error_t
572 popen_protect_tool (ctrl_t ctrl, const char *pgmname,
573                     FILE *infile, FILE *outfile, FILE **statusfile, 
574                     const char *prompt, const char *keygrip,
575                     pid_t *pid)
576 {
577   const char *argv[22];
578   int i=0;
579
580   /* Make sure that the agent is running so that the protect tool is
581      able to ask for a passphrase.  This has only an effect under W32
582      where the agent is started on demand; sending a NOP does not harm
583      on other platforms.  This is not really necessary anymore because
584      the protect tool does this now by itself; it does not harm either.*/
585   gpgsm_agent_send_nop (ctrl);
586
587   argv[i++] = "--homedir";
588   argv[i++] = opt.homedir;
589   argv[i++] = "--p12-export";
590   argv[i++] = "--have-cert";
591   argv[i++] = "--prompt";
592   argv[i++] = prompt?prompt:"";
593   argv[i++] = "--enable-status-msg";
594   if (opt.p12_charset)
595     {
596       argv[i++] = "--p12-charset";
597       argv[i++] = opt.p12_charset;
598     }
599   if (opt.agent_program)
600     {
601       argv[i++] = "--agent-program";
602       argv[i++] = opt.agent_program;
603     }
604   argv[i++] = "--",
605   argv[i++] = keygrip,
606   argv[i] = NULL;
607   assert (i < sizeof argv);
608
609   return gnupg_spawn_process (pgmname, argv, infile, outfile,
610                               setup_pinentry_env, (128|64),
611                               statusfile, pid);
612 }
613
614
615 static gpg_error_t
616 export_p12 (ctrl_t ctrl, const unsigned char *certimg, size_t certimglen,
617             const char *prompt, const char *keygrip,
618             FILE **retfp)
619 {
620   const char *pgmname;
621   gpg_error_t err = 0, child_err = 0;
622   int c, cont_line;
623   unsigned int pos;
624   FILE *infp = NULL, *outfp = NULL, *fp = NULL;
625   char buffer[1024];
626   pid_t pid = -1;
627   int bad_pass = 0;
628
629   if (!opt.protect_tool_program || !*opt.protect_tool_program)
630     pgmname = gnupg_module_name (GNUPG_MODULE_NAME_PROTECT_TOOL);
631   else
632     pgmname = opt.protect_tool_program;
633
634   infp = gnupg_tmpfile ();
635   if (!infp)
636     {
637       err = gpg_error_from_syserror ();
638       log_error (_("error creating temporary file: %s\n"), strerror (errno));
639       goto cleanup;
640     }
641
642   if (fwrite (certimg, certimglen, 1, infp) != 1)
643     {
644       err = gpg_error_from_syserror ();
645       log_error (_("error writing to temporary file: %s\n"),
646                  strerror (errno));
647       goto cleanup;
648     }
649
650   outfp = gnupg_tmpfile ();
651   if (!outfp)
652     {
653       err = gpg_error_from_syserror ();
654       log_error (_("error creating temporary file: %s\n"), strerror (errno));
655       goto cleanup;
656     }
657
658   err = popen_protect_tool (ctrl, 
659                             pgmname, infp, outfp, &fp, prompt, keygrip, &pid);
660   if (err)
661     {
662       pid = -1;
663       goto cleanup;
664     }
665   fclose (infp);
666   infp = NULL;
667
668   /* Read stderr of the protect tool. */
669   pos = 0;
670   cont_line = 0;
671   while ((c=getc (fp)) != EOF)
672     {
673       /* fixme: We could here grep for status information of the
674          protect tool to figure out better error codes for
675          CHILD_ERR. */
676       buffer[pos++] = c;
677       if (pos >= sizeof buffer - 5 || c == '\n')
678         {
679           buffer[pos - (c == '\n')] = 0;
680           if (cont_line)
681             log_printf ("%s", buffer);
682           else
683             {
684               if (!strncmp (buffer, "gpg-protect-tool: [PROTECT-TOOL:] ",34))
685                 {
686                   char *p, *pend;
687
688                   p = buffer + 34;
689                   pend = strchr (p, ' ');
690                   if (pend)
691                     *pend = 0;
692                   if ( !strcmp (p, "bad-passphrase"))
693                     bad_pass++;
694                 }
695               else 
696                 log_info ("%s", buffer);
697             }
698           pos = 0;
699           cont_line = (c != '\n');
700         }
701     }
702
703   if (pos)
704     {
705       buffer[pos] = 0;
706       if (cont_line)
707         log_printf ("%s\n", buffer);
708       else
709         log_info ("%s\n", buffer);
710     }
711   else if (cont_line)
712     log_printf ("\n");
713
714   /* If we found no error in the output of the child, setup a suitable
715      error code, which will later be reset if the exit status of the
716      child is 0. */
717   if (!child_err)
718     child_err = gpg_error (GPG_ERR_DECRYPT_FAILED);
719
720  cleanup:
721   if (infp)
722     fclose (infp);
723   if (fp)
724     fclose (fp);
725   if (pid != -1)
726     {
727       if (!gnupg_wait_process (pgmname, pid, NULL))
728         child_err = 0;
729     }
730   if (!err)
731     err = child_err;
732   if (err)
733     {
734       if (outfp)
735         fclose (outfp);
736     }
737   else
738     *retfp = outfp;
739   if (bad_pass)
740     {
741       /* During export this is the passphrase used to unprotect the
742          key and not the pkcs#12 thing as in export.  Therefore we can
743          issue the regular passphrase status.  FIXME: replace the all
744          zero keyid by a regular one. */
745       gpgsm_status (ctrl, STATUS_BAD_PASSPHRASE, "0000000000000000");
746     }
747   return err;
748 }
749