New command --check-programs for gpgconf.
[gnupg.git] / sm / export.c
1 /* export.c - Export certificates and private keys.
2  * Copyright (C) 2002, 2003, 2004, 2007 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 alrady 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 certictates: 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, we switch to
196      ephemeral mode so that _all_ currently available and matching
197      certificates are exported. 
198
199      fixme: we should in this case keep a list of certificates to
200      avoid accidential export of duplicate certificates. */
201   if (names && ndesc)
202     {
203       for (i=0; (i < ndesc
204                  && (desc[i].mode == KEYDB_SEARCH_MODE_FPR
205                      || desc[i].mode == KEYDB_SEARCH_MODE_FPR20
206                      || desc[i].mode == KEYDB_SEARCH_MODE_FPR16)); i++)
207         ;
208       if (i == ndesc)
209         keydb_set_ephemeral (hd, 1);
210     }
211       
212   while (!(rc = keydb_search (hd, desc, ndesc)))
213     {
214       unsigned char fpr[20];
215       int exists;
216
217       if (!names) 
218         desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
219
220       rc = keydb_get_cert (hd, &cert);
221       if (rc) 
222         {
223           log_error ("keydb_get_cert failed: %s\n", gpg_strerror (rc));
224           goto leave;
225         }
226
227       gpgsm_get_fingerprint (cert, 0, fpr, NULL);
228       rc = insert_duptable (dtable, fpr, &exists);
229       if (rc)
230         {
231           log_error ("inserting into duplicates table fauiled: %s\n",
232                      gpg_strerror (rc));
233           goto leave;
234         }
235
236       if (!exists && count && !ctrl->create_pem)
237         {
238           log_info ("exporting more than one certificate "
239                     "is not possible in binary mode\n");
240           log_info ("ignoring other certificates\n");
241           break;
242         }
243
244       if (!exists)
245         {
246           const unsigned char *image;
247           size_t imagelen;
248
249           image = ksba_cert_get_image (cert, &imagelen);
250           if (!image)
251             {
252               log_error ("ksba_cert_get_image failed\n");
253               goto leave;
254             }
255
256
257           if (ctrl->create_pem)
258             {
259               if (count)
260                 {
261                   if (stream)
262                     es_putc ('\n', stream);
263                   else
264                     putc ('\n', fp);
265                 }
266               print_short_info (cert, fp, stream);
267               if (stream)
268                 es_putc ('\n', stream);
269               else
270                 putc ('\n', fp);
271             }
272           count++;
273
274           if (!b64writer)
275             {
276               ctrl->pem_name = "CERTIFICATE";
277               rc = gpgsm_create_writer (&b64writer, ctrl, fp, stream, &writer);
278               if (rc)
279                 {
280                   log_error ("can't create writer: %s\n", gpg_strerror (rc));
281                   goto leave;
282                 }
283             }
284
285           rc = ksba_writer_write (writer, image, imagelen);
286           if (rc)
287             {
288               log_error ("write error: %s\n", gpg_strerror (rc));
289               goto leave;
290             }
291
292           if (ctrl->create_pem)
293             {
294               /* We want one certificate per PEM block */
295               rc = gpgsm_finish_writer (b64writer);
296               if (rc) 
297                 {
298                   log_error ("write failed: %s\n", gpg_strerror (rc));
299                   goto leave;
300                 }
301               gpgsm_destroy_writer (b64writer);
302               b64writer = NULL;
303             }
304         }
305
306       ksba_cert_release (cert); 
307       cert = NULL;
308     }
309   if (rc && rc != -1)
310     log_error ("keydb_search failed: %s\n", gpg_strerror (rc));
311   else if (b64writer)
312     {
313       rc = gpgsm_finish_writer (b64writer);
314       if (rc) 
315         {
316           log_error ("write failed: %s\n", gpg_strerror (rc));
317           goto leave;
318         }
319     }
320   
321  leave:
322   gpgsm_destroy_writer (b64writer);
323   ksba_cert_release (cert);
324   xfree (desc);
325   keydb_release (hd);
326   destroy_duptable (dtable);
327 }
328
329
330 /* Export a certificates and its private key. */
331 void
332 gpgsm_p12_export (ctrl_t ctrl, const char *name, FILE *fp)
333 {
334   KEYDB_HANDLE hd;
335   KEYDB_SEARCH_DESC *desc = NULL;
336   Base64Context b64writer = NULL;
337   ksba_writer_t writer;
338   ksba_cert_t cert = NULL;
339   int rc=0;
340   const unsigned char *image;
341   size_t imagelen;
342   char *keygrip = NULL;
343   char *prompt;
344   char buffer[1024];
345   int  nread;
346   FILE *datafp = NULL;
347
348
349   hd = keydb_new (0);
350   if (!hd)
351     {
352       log_error ("keydb_new failed\n");
353       goto leave;
354     }
355
356   desc = xtrycalloc (1, sizeof *desc);
357   if (!desc)
358     {
359       log_error ("allocating memory for export failed: %s\n",
360                  gpg_strerror (out_of_core ()));
361       goto leave;
362     }
363
364   rc = keydb_classify_name (name, desc);
365   if (rc)
366     {
367       log_error ("key `%s' not found: %s\n",
368                  name, gpg_strerror (rc));
369       goto leave;
370     }
371
372   /* Lookup the certificate an make sure that it is unique. */
373   rc = keydb_search (hd, desc, 1);
374   if (!rc)
375     {
376       rc = keydb_get_cert (hd, &cert);
377       if (rc) 
378         {
379           log_error ("keydb_get_cert failed: %s\n", gpg_strerror (rc));
380           goto leave;
381         }
382
383     next_ambiguous:      
384       rc = keydb_search (hd, desc, 1);
385       if (!rc)
386         {
387           ksba_cert_t cert2 = NULL;
388
389           if (!keydb_get_cert (hd, &cert2))
390             {
391               if (gpgsm_certs_identical_p (cert, cert2))
392                 {
393                   ksba_cert_release (cert2);
394                   goto next_ambiguous;
395                 }
396               ksba_cert_release (cert2);
397             }
398           rc = gpg_error (GPG_ERR_AMBIGUOUS_NAME);
399         }
400       else if (rc == -1 || gpg_err_code (rc) == GPG_ERR_EOF)
401         rc = 0;
402       if (rc)
403         {
404           log_error ("key `%s' not found: %s\n",
405                      name, gpg_strerror (rc));
406           goto leave;
407         }
408     }
409       
410   keygrip = gpgsm_get_keygrip_hexstring (cert);
411   if (!keygrip || gpgsm_agent_havekey (ctrl, keygrip))
412     {
413       /* Note, that the !keygrip case indicates a bad certificate. */
414       rc = gpg_error (GPG_ERR_NO_SECKEY);
415       log_error ("can't export key `%s': %s\n", name, gpg_strerror (rc));
416       goto leave;
417     }
418   
419   image = ksba_cert_get_image (cert, &imagelen);
420   if (!image)
421     {
422       log_error ("ksba_cert_get_image failed\n");
423       goto leave;
424     }
425
426   if (ctrl->create_pem)
427     {
428       print_short_info (cert, fp, NULL);
429       putc ('\n', fp);
430     }
431
432   if (opt.p12_charset && ctrl->create_pem)
433     {
434       fprintf (fp, "The passphrase is %s encoded.\n\n",
435                opt.p12_charset);
436     }
437
438   ctrl->pem_name = "PKCS12";
439   rc = gpgsm_create_writer (&b64writer, ctrl, fp, NULL, &writer);
440   if (rc)
441     {
442       log_error ("can't create writer: %s\n", gpg_strerror (rc));
443       goto leave;
444     }
445
446
447   prompt = gpgsm_format_keydesc (cert);
448   rc = export_p12 (ctrl, image, imagelen, prompt, keygrip, &datafp);
449   xfree (prompt);
450   if (rc)
451     goto leave;
452   rewind (datafp);
453   while ( (nread = fread (buffer, 1, sizeof buffer, datafp)) > 0 )
454     if ((rc = ksba_writer_write (writer, buffer, nread)))
455       {
456         log_error ("write failed: %s\n", gpg_strerror (rc));
457         goto leave;
458       }
459   if (ferror (datafp))
460     {
461       rc = gpg_error_from_errno (rc);
462       log_error ("error reading temporary file: %s\n", gpg_strerror (rc));
463       goto leave;
464     }
465
466   if (ctrl->create_pem)
467     {
468       /* We want one certificate per PEM block */
469       rc = gpgsm_finish_writer (b64writer);
470       if (rc) 
471         {
472           log_error ("write failed: %s\n", gpg_strerror (rc));
473           goto leave;
474         }
475       gpgsm_destroy_writer (b64writer);
476       b64writer = NULL;
477     }
478   
479   ksba_cert_release (cert); 
480   cert = NULL;
481
482  leave:
483   if (datafp)
484     fclose (datafp);
485   gpgsm_destroy_writer (b64writer);
486   ksba_cert_release (cert);
487   xfree (desc);
488   keydb_release (hd);
489 }
490
491
492 /* Call either es_putc or the plain putc.  */
493 static void
494 do_putc (int value, FILE *fp, estream_t stream)
495 {
496   if (stream)
497     es_putc (value, stream);
498   else
499     putc (value, fp);
500 }
501
502 /* Call either es_fputs or the plain fputs.  */
503 static void
504 do_fputs (const char *string, FILE *fp, estream_t stream)
505 {
506   if (stream)
507     es_fputs (string, stream);
508   else
509     fputs (string, fp);
510 }
511
512
513 /* Print some info about the certifciate CERT to FP or STREAM */
514 static void
515 print_short_info (ksba_cert_t cert, FILE *fp, estream_t stream)
516 {
517   char *p;
518   ksba_sexp_t sexp;
519   int idx;
520
521   for (idx=0; (p = ksba_cert_get_issuer (cert, idx)); idx++)
522     {
523       do_fputs ((!idx
524                  ?   "Issuer ...: "
525                  : "\n   aka ...: "), fp, stream); 
526       if (stream)
527         gpgsm_es_print_name (stream, p);
528       else
529         gpgsm_print_name (fp, p);
530       xfree (p);
531     }
532   do_putc ('\n', fp, stream);
533
534   do_fputs ("Serial ...: ", fp, stream); 
535   sexp = ksba_cert_get_serial (cert);
536   if (sexp)
537     {
538       int len;
539       const unsigned char *s = sexp;
540       
541       if (*s == '(')
542         {
543           s++;
544           for (len=0; *s && *s != ':' && digitp (s); s++)
545             len = len*10 + atoi_1 (s);
546           if (*s == ':')
547             {
548               if (stream)
549                 es_write_hexstring (stream, s+1, len, 0, NULL);
550               else
551                 print_hexstring (fp, s+1, len, 0);
552             }
553         }
554       xfree (sexp);
555     }
556   do_putc ('\n', fp, stream);
557
558   for (idx=0; (p = ksba_cert_get_subject (cert, idx)); idx++)
559     {
560       do_fputs ((!idx
561                  ?   "Subject ..: "
562                  : "\n    aka ..: "), fp, stream); 
563       if (stream)
564         gpgsm_es_print_name (stream, p);
565       else
566         gpgsm_print_name (fp, p);
567       xfree (p);
568     }
569   do_putc ('\n', fp, stream);
570 }
571
572
573 static gpg_error_t
574 popen_protect_tool (const char *pgmname,
575                     FILE *infile, FILE *outfile, FILE **statusfile, 
576                     const char *prompt, const char *keygrip,
577                     pid_t *pid)
578 {
579   const char *argv[20];
580   int i=0;
581
582   argv[i++] = "--homedir";
583   argv[i++] = opt.homedir;
584   argv[i++] = "--p12-export";
585   argv[i++] = "--have-cert";
586   argv[i++] = "--prompt";
587   argv[i++] = prompt?prompt:"";
588   argv[i++] = "--enable-status-msg";
589   if (opt.p12_charset)
590     {
591       argv[i++] = "--p12-charset";
592       argv[i++] = opt.p12_charset;
593     }
594   argv[i++] = "--",
595   argv[i++] = keygrip,
596   argv[i] = NULL;
597   assert (i < sizeof argv);
598
599   return gnupg_spawn_process (pgmname, argv, infile, outfile,
600                               setup_pinentry_env,
601                               statusfile, pid);
602 }
603
604
605 static gpg_error_t
606 export_p12 (ctrl_t ctrl, const unsigned char *certimg, size_t certimglen,
607             const char *prompt, const char *keygrip,
608             FILE **retfp)
609 {
610   const char *pgmname;
611   gpg_error_t err = 0, child_err = 0;
612   int c, cont_line;
613   unsigned int pos;
614   FILE *infp = NULL, *outfp = NULL, *fp = NULL;
615   char buffer[1024];
616   pid_t pid = -1;
617   int bad_pass = 0;
618
619   if (!opt.protect_tool_program || !*opt.protect_tool_program)
620     pgmname = gnupg_module_name (GNUPG_MODULE_NAME_PROTECT_TOOL);
621   else
622     pgmname = opt.protect_tool_program;
623
624   infp = gnupg_tmpfile ();
625   if (!infp)
626     {
627       err = gpg_error_from_syserror ();
628       log_error (_("error creating temporary file: %s\n"), strerror (errno));
629       goto cleanup;
630     }
631
632   if (fwrite (certimg, certimglen, 1, infp) != 1)
633     {
634       err = gpg_error_from_syserror ();
635       log_error (_("error writing to temporary file: %s\n"),
636                  strerror (errno));
637       goto cleanup;
638     }
639
640   outfp = gnupg_tmpfile ();
641   if (!outfp)
642     {
643       err = gpg_error_from_syserror ();
644       log_error (_("error creating temporary file: %s\n"), strerror (errno));
645       goto cleanup;
646     }
647
648   err = popen_protect_tool (pgmname, infp, outfp, &fp, prompt, keygrip, &pid);
649   if (err)
650     {
651       pid = -1;
652       goto cleanup;
653     }
654   fclose (infp);
655   infp = NULL;
656
657   /* Read stderr of the protect tool. */
658   pos = 0;
659   cont_line = 0;
660   while ((c=getc (fp)) != EOF)
661     {
662       /* fixme: We could here grep for status information of the
663          protect tool to figure out better error codes for
664          CHILD_ERR. */
665       buffer[pos++] = c;
666       if (pos >= sizeof buffer - 5 || c == '\n')
667         {
668           buffer[pos - (c == '\n')] = 0;
669           if (cont_line)
670             log_printf ("%s", buffer);
671           else
672             {
673               if (!strncmp (buffer, "gpg-protect-tool: [PROTECT-TOOL:] ",34))
674                 {
675                   char *p, *pend;
676
677                   p = buffer + 34;
678                   pend = strchr (p, ' ');
679                   if (pend)
680                     *pend = 0;
681                   if ( !strcmp (p, "bad-passphrase"))
682                     bad_pass++;
683                 }
684               else 
685                 log_info ("%s", buffer);
686             }
687           pos = 0;
688           cont_line = (c != '\n');
689         }
690     }
691
692   if (pos)
693     {
694       buffer[pos] = 0;
695       if (cont_line)
696         log_printf ("%s\n", buffer);
697       else
698         log_info ("%s\n", buffer);
699     }
700   else if (cont_line)
701     log_printf ("\n");
702
703   /* If we found no error in the output of the child, setup a suitable
704      error code, which will later be reset if the exit status of the
705      child is 0. */
706   if (!child_err)
707     child_err = gpg_error (GPG_ERR_DECRYPT_FAILED);
708
709  cleanup:
710   if (infp)
711     fclose (infp);
712   if (fp)
713     fclose (fp);
714   if (pid != -1)
715     {
716       if (!gnupg_wait_process (pgmname, pid, NULL))
717         child_err = 0;
718     }
719   if (!err)
720     err = child_err;
721   if (err)
722     {
723       if (outfp)
724         fclose (outfp);
725     }
726   else
727     *retfp = outfp;
728   if (bad_pass)
729     {
730       /* During export this is the passphrase used to unprotect the
731          key and not the pkcs#12 thing as in export.  Therefore we can
732          issue the regular passphrase status.  FIXME: replace the all
733          zero keyid by a regular one. */
734       gpgsm_status (ctrl, STATUS_BAD_PASSPHRASE, "0000000000000000");
735     }
736   return err;
737 }
738