core: Do not pass const char* to functions taking a char*.
[gpgme.git] / src / engine-gpg.c
1 /* engine-gpg.c - Gpg Engine.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4                  2009, 2010, 2012, 2013 g10 Code GmbH
5
6    This file is part of GPGME.
7
8    GPGME is free software; you can redistribute it and/or modify it
9    under the terms of the GNU Lesser General Public License as
10    published by the Free Software Foundation; either version 2.1 of
11    the License, or (at your option) any later version.
12
13    GPGME is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    Lesser General Public License for more details.
17
18    You should have received a copy of the GNU Lesser General Public
19    License along with this program; if not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #if HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <assert.h>
29 #include <errno.h>
30 #ifdef HAVE_UNISTD_H
31 # include <unistd.h>
32 #endif
33 #ifdef HAVE_LOCALE_H
34 #include <locale.h>
35 #endif
36
37 #include "gpgme.h"
38 #include "util.h"
39 #include "ops.h"
40 #include "wait.h"
41 #include "context.h"  /*temp hack until we have GpmeData methods to do I/O */
42 #include "priv-io.h"
43 #include "sema.h"
44 #include "debug.h"
45 #include "data.h"
46
47 #include "engine-backend.h"
48
49
50 /* This type is used to build a list of gpg arguments and data
51    sources/sinks.  */
52 struct arg_and_data_s
53 {
54   struct arg_and_data_s *next;
55   gpgme_data_t data;  /* If this is not NULL, use arg below.  */
56   int inbound;     /* True if this is used for reading from gpg.  */
57   int dup_to;
58   int print_fd;    /* Print the fd number and not the special form of it.  */
59   int *arg_locp;   /* Write back the argv idx of this argument when
60                       building command line to this location.  */
61   char arg[1];     /* Used if data above is not used.  */
62 };
63
64
65 struct fd_data_map_s
66 {
67   gpgme_data_t data;
68   int inbound;  /* true if this is used for reading from gpg */
69   int dup_to;
70   int fd;       /* the fd to use */
71   int peer_fd;  /* the other side of the pipe */
72   int arg_loc;  /* The index into the argv for translation purposes.  */
73   void *tag;
74 };
75
76
77 typedef gpgme_error_t (*colon_preprocessor_t) (char *line, char **rline);
78
79 struct engine_gpg
80 {
81   char *file_name;
82   char *version;
83
84   char *lc_messages;
85   char *lc_ctype;
86
87   struct arg_and_data_s *arglist;
88   struct arg_and_data_s **argtail;
89
90   struct
91   {
92     int fd[2];
93     int arg_loc;
94     size_t bufsize;
95     char *buffer;
96     size_t readpos;
97     int eof;
98     engine_status_handler_t fnc;
99     void *fnc_value;
100     gpgme_status_cb_t mon_cb;
101     void *mon_cb_value;
102     void *tag;
103   } status;
104
105   /* This is a kludge - see the comment at colon_line_handler.  */
106   struct
107   {
108     int fd[2];
109     int arg_loc;
110     size_t bufsize;
111     char *buffer;
112     size_t readpos;
113     int eof;
114     engine_colon_line_handler_t fnc;  /* this indicate use of this structrue */
115     void *fnc_value;
116     void *tag;
117     colon_preprocessor_t preprocess_fnc;
118   } colon;
119
120   char **argv;
121   struct fd_data_map_s *fd_data_map;
122
123   /* stuff needed for interactive (command) mode */
124   struct
125   {
126     int used;
127     int fd;
128     void *cb_data;
129     int idx;            /* Index in fd_data_map */
130     gpgme_status_code_t code;  /* last code */
131     char *keyword;       /* what has been requested (malloced) */
132     engine_command_handler_t fnc;
133     void *fnc_value;
134     /* The kludges never end.  This is used to couple command handlers
135        with output data in edit key mode.  */
136     gpgme_data_t linked_data;
137     int linked_idx;
138   } cmd;
139
140   struct gpgme_io_cbs io_cbs;
141   gpgme_pinentry_mode_t pinentry_mode;
142 };
143
144 typedef struct engine_gpg *engine_gpg_t;
145
146 \f
147 static void
148 gpg_io_event (void *engine, gpgme_event_io_t type, void *type_data)
149 {
150   engine_gpg_t gpg = engine;
151
152   TRACE3 (DEBUG_ENGINE, "gpgme:gpg_io_event", gpg,
153           "event %p, type %d, type_data %p",
154           gpg->io_cbs.event, type, type_data);
155   if (gpg->io_cbs.event)
156     (*gpg->io_cbs.event) (gpg->io_cbs.event_priv, type, type_data);
157 }
158
159
160 static void
161 close_notify_handler (int fd, void *opaque)
162 {
163   engine_gpg_t gpg = opaque;
164   assert (fd != -1);
165
166   if (gpg->status.fd[0] == fd)
167     {
168       if (gpg->status.tag)
169         (*gpg->io_cbs.remove) (gpg->status.tag);
170       gpg->status.fd[0] = -1;
171     }
172   else if (gpg->status.fd[1] == fd)
173     gpg->status.fd[1] = -1;
174   else if (gpg->colon.fd[0] == fd)
175     {
176       if (gpg->colon.tag)
177         (*gpg->io_cbs.remove) (gpg->colon.tag);
178       gpg->colon.fd[0] = -1;
179     }
180   else if (gpg->colon.fd[1] == fd)
181     gpg->colon.fd[1] = -1;
182   else if (gpg->cmd.fd == fd)
183     gpg->cmd.fd = -1;
184   else if (gpg->fd_data_map)
185     {
186       int i;
187
188       for (i = 0; gpg->fd_data_map[i].data; i++)
189         {
190           if (gpg->fd_data_map[i].fd == fd)
191             {
192               if (gpg->fd_data_map[i].tag)
193                 (*gpg->io_cbs.remove) (gpg->fd_data_map[i].tag);
194               gpg->fd_data_map[i].fd = -1;
195               break;
196             }
197           if (gpg->fd_data_map[i].peer_fd == fd)
198             {
199               gpg->fd_data_map[i].peer_fd = -1;
200               break;
201             }
202         }
203     }
204 }
205
206 /* If FRONT is true, push at the front of the list.  Use this for
207    options added late in the process.  */
208 static gpgme_error_t
209 _add_arg (engine_gpg_t gpg, const char *arg, int front, int *arg_locp)
210 {
211   struct arg_and_data_s *a;
212
213   assert (gpg);
214   assert (arg);
215
216   a = malloc (sizeof *a + strlen (arg));
217   if (!a)
218     return gpg_error_from_syserror ();
219
220   a->data = NULL;
221   a->dup_to = -1;
222   a->arg_locp = arg_locp;
223
224   strcpy (a->arg, arg);
225   if (front)
226     {
227       a->next = gpg->arglist;
228       if (!gpg->arglist)
229         {
230           /* If this is the first argument, we need to update the tail
231              pointer.  */
232           gpg->argtail = &a->next;
233         }
234       gpg->arglist = a;
235     }
236   else
237     {
238       a->next = NULL;
239       *gpg->argtail = a;
240       gpg->argtail = &a->next;
241     }
242
243   return 0;
244 }
245
246 static gpgme_error_t
247 add_arg_ext (engine_gpg_t gpg, const char *arg, int front)
248 {
249   return _add_arg (gpg, arg, front, NULL);
250 }
251
252
253 static gpgme_error_t
254 add_arg_with_locp (engine_gpg_t gpg, const char *arg, int *locp)
255 {
256   return _add_arg (gpg, arg, 0, locp);
257 }
258
259
260 static gpgme_error_t
261 add_arg (engine_gpg_t gpg, const char *arg)
262 {
263   return add_arg_ext (gpg, arg, 0);
264 }
265
266
267 static gpgme_error_t
268 add_data (engine_gpg_t gpg, gpgme_data_t data, int dup_to, int inbound)
269 {
270   struct arg_and_data_s *a;
271
272   assert (gpg);
273   assert (data);
274
275   a = malloc (sizeof *a - 1);
276   if (!a)
277     return gpg_error_from_syserror ();
278   a->next = NULL;
279   a->data = data;
280   a->inbound = inbound;
281   a->arg_locp = NULL;
282
283   if (dup_to == -2)
284     {
285       a->print_fd = 1;
286       a->dup_to = -1;
287     }
288   else
289     {
290       a->print_fd = 0;
291       a->dup_to = dup_to;
292     }
293   *gpg->argtail = a;
294   gpg->argtail = &a->next;
295   return 0;
296 }
297
298
299 /* Return true if the engine's version is at least VERSION.  */
300 static int
301 have_gpg_version (engine_gpg_t gpg, const char *version)
302 {
303   return _gpgme_compare_versions (gpg->version, version);
304 }
305
306
307 \f
308 static char *
309 gpg_get_version (const char *file_name)
310 {
311   return _gpgme_get_program_version (file_name ? file_name
312                                      : _gpgme_get_default_gpg_name ());
313 }
314
315
316 static const char *
317 gpg_get_req_version (void)
318 {
319   return "1.4.0";
320 }
321
322
323 static void
324 free_argv (char **argv)
325 {
326   int i;
327
328   for (i = 0; argv[i]; i++)
329     free (argv[i]);
330   free (argv);
331 }
332
333
334 static void
335 free_fd_data_map (struct fd_data_map_s *fd_data_map)
336 {
337   int i;
338
339   if (!fd_data_map)
340     return;
341
342   for (i = 0; fd_data_map[i].data; i++)
343     {
344       if (fd_data_map[i].fd != -1)
345         _gpgme_io_close (fd_data_map[i].fd);
346       if (fd_data_map[i].peer_fd != -1)
347         _gpgme_io_close (fd_data_map[i].peer_fd);
348       /* Don't release data because this is only a reference.  */
349     }
350   free (fd_data_map);
351 }
352
353
354 static gpgme_error_t
355 gpg_cancel (void *engine)
356 {
357   engine_gpg_t gpg = engine;
358
359   if (!gpg)
360     return gpg_error (GPG_ERR_INV_VALUE);
361
362   /* If gpg may be waiting for a cmd, close the cmd fd first.  On
363      Windows, close operations block on the reader/writer thread.  */
364   if (gpg->cmd.used)
365     {
366       if (gpg->cmd.fd != -1)
367         _gpgme_io_close (gpg->cmd.fd);
368       else if (gpg->fd_data_map
369                && gpg->fd_data_map[gpg->cmd.idx].fd != -1)
370         _gpgme_io_close (gpg->fd_data_map[gpg->cmd.idx].fd);
371     }
372
373   if (gpg->status.fd[0] != -1)
374     _gpgme_io_close (gpg->status.fd[0]);
375   if (gpg->status.fd[1] != -1)
376     _gpgme_io_close (gpg->status.fd[1]);
377   if (gpg->colon.fd[0] != -1)
378     _gpgme_io_close (gpg->colon.fd[0]);
379   if (gpg->colon.fd[1] != -1)
380     _gpgme_io_close (gpg->colon.fd[1]);
381   if (gpg->fd_data_map)
382     {
383       free_fd_data_map (gpg->fd_data_map);
384       gpg->fd_data_map = NULL;
385     }
386
387   return 0;
388 }
389
390 static void
391 gpg_release (void *engine)
392 {
393   engine_gpg_t gpg = engine;
394
395   if (!gpg)
396     return;
397
398   gpg_cancel (engine);
399
400   if (gpg->file_name)
401     free (gpg->file_name);
402   if (gpg->version)
403     free (gpg->version);
404
405   if (gpg->lc_messages)
406     free (gpg->lc_messages);
407   if (gpg->lc_ctype)
408     free (gpg->lc_ctype);
409
410   while (gpg->arglist)
411     {
412       struct arg_and_data_s *next = gpg->arglist->next;
413
414       free (gpg->arglist);
415       gpg->arglist = next;
416     }
417
418   if (gpg->status.buffer)
419     free (gpg->status.buffer);
420   if (gpg->colon.buffer)
421     free (gpg->colon.buffer);
422   if (gpg->argv)
423     free_argv (gpg->argv);
424   if (gpg->cmd.keyword)
425     free (gpg->cmd.keyword);
426
427   free (gpg);
428 }
429
430
431 static gpgme_error_t
432 gpg_new (void **engine, const char *file_name, const char *home_dir,
433          const char *version)
434 {
435   engine_gpg_t gpg;
436   gpgme_error_t rc = 0;
437   char *dft_display = NULL;
438   char dft_ttyname[64];
439   char *dft_ttytype = NULL;
440
441   gpg = calloc (1, sizeof *gpg);
442   if (!gpg)
443     return gpg_error_from_syserror ();
444
445   if (file_name)
446     {
447       gpg->file_name = strdup (file_name);
448       if (!gpg->file_name)
449         {
450           rc = gpg_error_from_syserror ();
451           goto leave;
452         }
453     }
454
455   if (version)
456     {
457       gpg->version = strdup (version);
458       if (!gpg->version)
459         {
460           rc = gpg_error_from_syserror ();
461           goto leave;
462         }
463     }
464
465   gpg->argtail = &gpg->arglist;
466   gpg->status.fd[0] = -1;
467   gpg->status.fd[1] = -1;
468   gpg->colon.fd[0] = -1;
469   gpg->colon.fd[1] = -1;
470   gpg->cmd.fd = -1;
471   gpg->cmd.idx = -1;
472   gpg->cmd.linked_data = NULL;
473   gpg->cmd.linked_idx = -1;
474
475   /* Allocate the read buffer for the status pipe.  */
476   gpg->status.bufsize = 1024;
477   gpg->status.readpos = 0;
478   gpg->status.buffer = malloc (gpg->status.bufsize);
479   if (!gpg->status.buffer)
480     {
481       rc = gpg_error_from_syserror ();
482       goto leave;
483     }
484   /* In any case we need a status pipe - create it right here and
485      don't handle it with our generic gpgme_data_t mechanism.  */
486   if (_gpgme_io_pipe (gpg->status.fd, 1) == -1)
487     {
488       rc = gpg_error_from_syserror ();
489       goto leave;
490     }
491   if (_gpgme_io_set_close_notify (gpg->status.fd[0],
492                                   close_notify_handler, gpg)
493       || _gpgme_io_set_close_notify (gpg->status.fd[1],
494                                      close_notify_handler, gpg))
495     {
496       rc = gpg_error (GPG_ERR_GENERAL);
497       goto leave;
498     }
499   gpg->status.eof = 0;
500
501   if (home_dir)
502     {
503       rc = add_arg (gpg, "--homedir");
504       if (!rc)
505         rc = add_arg (gpg, home_dir);
506       if (rc)
507         goto leave;
508     }
509
510   rc = add_arg (gpg, "--status-fd");
511   if (rc)
512     goto leave;
513
514   {
515     char buf[25];
516     _gpgme_io_fd2str (buf, sizeof (buf), gpg->status.fd[1]);
517     rc = add_arg_with_locp (gpg, buf, &gpg->status.arg_loc);
518     if (rc)
519       goto leave;
520   }
521
522   rc = add_arg (gpg, "--no-tty");
523   if (!rc)
524     rc = add_arg (gpg, "--charset");
525   if (!rc)
526     rc = add_arg (gpg, "utf8");
527   if (!rc)
528     rc = add_arg (gpg, "--enable-progress-filter");
529   if (rc)
530     goto leave;
531
532   rc = _gpgme_getenv ("DISPLAY", &dft_display);
533   if (rc)
534     goto leave;
535   if (dft_display)
536     {
537       rc = add_arg (gpg, "--display");
538       if (!rc)
539         rc = add_arg (gpg, dft_display);
540
541       free (dft_display);
542       if (rc)
543         goto leave;
544     }
545
546   if (isatty (1))
547     {
548       int err;
549
550       err = ttyname_r (1, dft_ttyname, sizeof (dft_ttyname));
551
552       /* Even though isatty() returns 1, ttyname_r() may fail in many
553          ways, e.g., when /dev/pts is not accessible under chroot.  */
554       if (!err)
555         {
556           if (*dft_ttyname)
557             {
558               rc = add_arg (gpg, "--ttyname");
559               if (!rc)
560                 rc = add_arg (gpg, dft_ttyname);
561             }
562           else
563             rc = 0;
564           if (!rc)
565             {
566               rc = _gpgme_getenv ("TERM", &dft_ttytype);
567               if (rc)
568                 goto leave;
569
570               if (dft_ttytype)
571                 {
572                   rc = add_arg (gpg, "--ttytype");
573                   if (!rc)
574                     rc = add_arg (gpg, dft_ttytype);
575                 }
576
577               free (dft_ttytype);
578             }
579           if (rc)
580             goto leave;
581         }
582     }
583
584  leave:
585   if (rc)
586     gpg_release (gpg);
587   else
588     *engine = gpg;
589   return rc;
590 }
591
592
593 static gpgme_error_t
594 gpg_set_locale (void *engine, int category, const char *value)
595 {
596   engine_gpg_t gpg = engine;
597
598   if (0)
599     ;
600 #ifdef LC_CTYPE
601   else if (category == LC_CTYPE)
602     {
603       if (gpg->lc_ctype)
604         {
605           free (gpg->lc_ctype);
606           gpg->lc_ctype = NULL;
607         }
608       if (value)
609         {
610           gpg->lc_ctype = strdup (value);
611           if (!gpg->lc_ctype)
612             return gpg_error_from_syserror ();
613         }
614     }
615 #endif
616 #ifdef LC_MESSAGES
617   else if (category == LC_MESSAGES)
618     {
619       if (gpg->lc_messages)
620         {
621           free (gpg->lc_messages);
622           gpg->lc_messages = NULL;
623         }
624       if (value)
625         {
626           gpg->lc_messages = strdup (value);
627           if (!gpg->lc_messages)
628             return gpg_error_from_syserror ();
629         }
630     }
631 #endif /* LC_MESSAGES */
632   else
633     return gpg_error (GPG_ERR_INV_VALUE);
634
635   return 0;
636 }
637
638 /* This sets a status callback for monitoring status lines before they
639  * are passed to a caller set handler.  */
640 static void
641 gpg_set_status_cb (void *engine, gpgme_status_cb_t cb, void *cb_value)
642 {
643   engine_gpg_t gpg = engine;
644
645   gpg->status.mon_cb = cb;
646   gpg->status.mon_cb_value = cb_value;
647 }
648
649
650 /* Note, that the status_handler is allowed to modifiy the args
651    value.  */
652 static void
653 gpg_set_status_handler (void *engine, engine_status_handler_t fnc,
654                         void *fnc_value)
655 {
656   engine_gpg_t gpg = engine;
657
658   gpg->status.fnc = fnc;
659   gpg->status.fnc_value = fnc_value;
660 }
661
662 /* Kludge to process --with-colon output.  */
663 static gpgme_error_t
664 gpg_set_colon_line_handler (void *engine, engine_colon_line_handler_t fnc,
665                             void *fnc_value)
666 {
667   engine_gpg_t gpg = engine;
668
669   gpg->colon.bufsize = 1024;
670   gpg->colon.readpos = 0;
671   gpg->colon.buffer = malloc (gpg->colon.bufsize);
672   if (!gpg->colon.buffer)
673     return gpg_error_from_syserror ();
674
675   if (_gpgme_io_pipe (gpg->colon.fd, 1) == -1)
676     {
677       int saved_err = gpg_error_from_syserror ();
678       free (gpg->colon.buffer);
679       gpg->colon.buffer = NULL;
680       return saved_err;
681     }
682   if (_gpgme_io_set_close_notify (gpg->colon.fd[0], close_notify_handler, gpg)
683       || _gpgme_io_set_close_notify (gpg->colon.fd[1],
684                                      close_notify_handler, gpg))
685     return gpg_error (GPG_ERR_GENERAL);
686   gpg->colon.eof = 0;
687   gpg->colon.fnc = fnc;
688   gpg->colon.fnc_value = fnc_value;
689   return 0;
690 }
691
692
693 static gpgme_error_t
694 command_handler (void *opaque, int fd)
695 {
696   struct io_cb_data *data = (struct io_cb_data *) opaque;
697   engine_gpg_t gpg = (engine_gpg_t) data->handler_value;
698   gpgme_error_t err;
699   int processed = 0;
700   assert (gpg->cmd.used);
701   assert (gpg->cmd.code);
702   assert (gpg->cmd.fnc);
703
704   err = gpg->cmd.fnc (gpg->cmd.fnc_value, gpg->cmd.code, gpg->cmd.keyword, fd,
705                       &processed);
706
707   gpg->cmd.code = 0;
708   /* And sleep again until read_status will wake us up again.  */
709   /* XXX We must check if there are any more fds active after removing
710      this one.  */
711   (*gpg->io_cbs.remove) (gpg->fd_data_map[gpg->cmd.idx].tag);
712   gpg->cmd.fd = gpg->fd_data_map[gpg->cmd.idx].fd;
713   gpg->fd_data_map[gpg->cmd.idx].fd = -1;
714
715   if (err)
716     return err;
717
718   /* We always need to send at least a newline character.  */
719   if (!processed)
720     _gpgme_io_write (fd, "\n", 1);
721
722   return 0;
723 }
724
725
726
727 /* The Fnc will be called to get a value for one of the commands with
728    a key KEY.  If the Code passed to FNC is 0, the function may release
729    resources associated with the returned value from another call.  To
730    match such a second call to a first call, the returned value from
731    the first call is passed as keyword.  */
732 static gpgme_error_t
733 gpg_set_command_handler (void *engine, engine_command_handler_t fnc,
734                          void *fnc_value, gpgme_data_t linked_data)
735 {
736   engine_gpg_t gpg = engine;
737   gpgme_error_t rc;
738
739   rc = add_arg (gpg, "--command-fd");
740   if (rc)
741     return rc;
742
743   /* This is a hack.  We don't have a real data object.  The only
744      thing that matters is that we use something unique, so we use the
745      address of the cmd structure in the gpg object.  */
746   rc = add_data (gpg, (void *) &gpg->cmd, -2, 0);
747   if (rc)
748     return rc;
749
750   gpg->cmd.fnc = fnc;
751   gpg->cmd.cb_data = (void *) &gpg->cmd;
752   gpg->cmd.fnc_value = fnc_value;
753   gpg->cmd.linked_data = linked_data;
754   gpg->cmd.used = 1;
755   return 0;
756 }
757
758
759 static gpgme_error_t
760 build_argv (engine_gpg_t gpg, const char *pgmname)
761 {
762   gpgme_error_t err;
763   struct arg_and_data_s *a;
764   struct fd_data_map_s *fd_data_map;
765   size_t datac=0, argc=0;
766   char **argv;
767   int need_special = 0;
768   int use_agent = 0;
769   char *p;
770
771   if (_gpgme_in_gpg_one_mode ())
772     {
773       /* In GnuPG-1 mode we don't want to use the agent with a
774          malformed environment variable.  This is only a very basic
775          test but sufficient to make our life in the regression tests
776          easier.  With GnuPG-2 the agent is anyway required and on
777          modern installations GPG_AGENT_INFO is optional.  */
778       err = _gpgme_getenv ("GPG_AGENT_INFO", &p);
779       if (err)
780         return err;
781       use_agent = (p && strchr (p, ':'));
782       if (p)
783         free (p);
784     }
785
786   if (gpg->argv)
787     {
788       free_argv (gpg->argv);
789       gpg->argv = NULL;
790     }
791   if (gpg->fd_data_map)
792     {
793       free_fd_data_map (gpg->fd_data_map);
794       gpg->fd_data_map = NULL;
795     }
796
797   argc++;       /* For argv[0].  */
798   for (a = gpg->arglist; a; a = a->next)
799     {
800       argc++;
801       if (a->data)
802         {
803           /*fprintf (stderr, "build_argv: data\n" );*/
804           datac++;
805           if (a->dup_to == -1 && !a->print_fd)
806             need_special = 1;
807         }
808       else
809         {
810           /*   fprintf (stderr, "build_argv: arg=`%s'\n", a->arg );*/
811         }
812     }
813   if (need_special)
814     argc++;
815   if (use_agent)
816     argc++;
817   if (gpg->pinentry_mode)
818     argc++;
819   if (!gpg->cmd.used)
820     argc++;     /* --batch */
821   argc += 1;    /* --no-sk-comments */
822
823   argv = calloc (argc + 1, sizeof *argv);
824   if (!argv)
825     return gpg_error_from_syserror ();
826   fd_data_map = calloc (datac + 1, sizeof *fd_data_map);
827   if (!fd_data_map)
828     {
829       int saved_err = gpg_error_from_syserror ();
830       free_argv (argv);
831       return saved_err;
832     }
833
834   argc = datac = 0;
835   argv[argc] = strdup (_gpgme_get_basename (pgmname)); /* argv[0] */
836   if (!argv[argc])
837     {
838       int saved_err = gpg_error_from_syserror ();
839       free (fd_data_map);
840       free_argv (argv);
841       return saved_err;
842     }
843   argc++;
844   if (need_special)
845     {
846       argv[argc] = strdup ("--enable-special-filenames");
847       if (!argv[argc])
848         {
849           int saved_err = gpg_error_from_syserror ();
850           free (fd_data_map);
851           free_argv (argv);
852           return saved_err;
853         }
854       argc++;
855     }
856   if (use_agent)
857     {
858       argv[argc] = strdup ("--use-agent");
859       if (!argv[argc])
860         {
861           int saved_err = gpg_error_from_syserror ();
862           free (fd_data_map);
863           free_argv (argv);
864           return saved_err;
865         }
866       argc++;
867     }
868
869   if (gpg->pinentry_mode && have_gpg_version (gpg, "2.1.0"))
870     {
871       const char *s = NULL;
872       switch (gpg->pinentry_mode)
873         {
874         case GPGME_PINENTRY_MODE_DEFAULT: break;
875         case GPGME_PINENTRY_MODE_ASK:     s = "--pinentry-mode=ask"; break;
876         case GPGME_PINENTRY_MODE_CANCEL:  s = "--pinentry-mode=cancel"; break;
877         case GPGME_PINENTRY_MODE_ERROR:   s = "--pinentry-mode=error"; break;
878         case GPGME_PINENTRY_MODE_LOOPBACK:s = "--pinentry-mode=loopback"; break;
879         }
880       if (s)
881         {
882           argv[argc] = strdup (s);
883           if (!argv[argc])
884             {
885               int saved_err = gpg_error_from_syserror ();
886               free (fd_data_map);
887               free_argv (argv);
888               return saved_err;
889             }
890           argc++;
891         }
892     }
893
894   if (!gpg->cmd.used)
895     {
896       argv[argc] = strdup ("--batch");
897       if (!argv[argc])
898         {
899           int saved_err = gpg_error_from_syserror ();
900           free (fd_data_map);
901           free_argv (argv);
902           return saved_err;
903         }
904       argc++;
905     }
906   argv[argc] = strdup ("--no-sk-comments");
907   if (!argv[argc])
908     {
909       int saved_err = gpg_error_from_syserror ();
910       free (fd_data_map);
911       free_argv (argv);
912       return saved_err;
913     }
914   argc++;
915   for (a = gpg->arglist; a; a = a->next)
916     {
917       if (a->arg_locp)
918         *(a->arg_locp) = argc;
919
920       if (a->data)
921         {
922           /* Create a pipe to pass it down to gpg.  */
923           fd_data_map[datac].inbound = a->inbound;
924
925           /* Create a pipe.  */
926           {
927             int fds[2];
928
929             if (_gpgme_io_pipe (fds, fd_data_map[datac].inbound ? 1 : 0)
930                 == -1)
931               {
932                 int saved_errno = errno;
933                 free (fd_data_map);
934                 free_argv (argv);
935                 return gpg_error (saved_errno);
936               }
937             if (_gpgme_io_set_close_notify (fds[0],
938                                             close_notify_handler, gpg)
939                 || _gpgme_io_set_close_notify (fds[1],
940                                                close_notify_handler,
941                                                gpg))
942               {
943                 /* We leak fd_data_map and the fds.  This is not easy
944                    to avoid and given that we reach this here only
945                    after a malloc failure for a small object, it is
946                    probably better not to do anything.  */
947                 return gpg_error (GPG_ERR_GENERAL);
948               }
949             /* If the data_type is FD, we have to do a dup2 here.  */
950             if (fd_data_map[datac].inbound)
951               {
952                 fd_data_map[datac].fd       = fds[0];
953                 fd_data_map[datac].peer_fd  = fds[1];
954               }
955             else
956               {
957                 fd_data_map[datac].fd       = fds[1];
958                 fd_data_map[datac].peer_fd  = fds[0];
959               }
960           }
961
962           /* Hack to get hands on the fd later.  */
963           if (gpg->cmd.used)
964             {
965               if (gpg->cmd.cb_data == a->data)
966                 {
967                   assert (gpg->cmd.idx == -1);
968                   gpg->cmd.idx = datac;
969                 }
970               else if (gpg->cmd.linked_data == a->data)
971                 {
972                   assert (gpg->cmd.linked_idx == -1);
973                   gpg->cmd.linked_idx = datac;
974                 }
975             }
976
977           fd_data_map[datac].data = a->data;
978           fd_data_map[datac].dup_to = a->dup_to;
979
980           if (a->dup_to == -1)
981             {
982               char *ptr;
983               int buflen = 25;
984
985               argv[argc] = malloc (buflen);
986               if (!argv[argc])
987                 {
988                   int saved_err = gpg_error_from_syserror ();
989                   free (fd_data_map);
990                   free_argv (argv);
991                   return saved_err;
992                 }
993
994               ptr = argv[argc];
995               if (!a->print_fd)
996                 {
997                   *(ptr++) = '-';
998                   *(ptr++) = '&';
999                   buflen -= 2;
1000                 }
1001
1002               _gpgme_io_fd2str (ptr, buflen, fd_data_map[datac].peer_fd);
1003               fd_data_map[datac].arg_loc = argc;
1004               argc++;
1005             }
1006           datac++;
1007         }
1008       else
1009         {
1010           argv[argc] = strdup (a->arg);
1011           if (!argv[argc])
1012             {
1013               int saved_err = gpg_error_from_syserror ();
1014               free (fd_data_map);
1015               free_argv (argv);
1016               return saved_err;
1017             }
1018             argc++;
1019         }
1020     }
1021
1022   gpg->argv = argv;
1023   gpg->fd_data_map = fd_data_map;
1024   return 0;
1025 }
1026
1027
1028 static gpgme_error_t
1029 add_io_cb (engine_gpg_t gpg, int fd, int dir, gpgme_io_cb_t handler, void *data,
1030            void **tag)
1031 {
1032   gpgme_error_t err;
1033
1034   err = (*gpg->io_cbs.add) (gpg->io_cbs.add_priv, fd, dir, handler, data, tag);
1035   if (err)
1036     return err;
1037   if (!dir)
1038     /* FIXME Kludge around poll() problem.  */
1039     err = _gpgme_io_set_nonblocking (fd);
1040   return err;
1041 }
1042
1043
1044 /* Handle the status output of GnuPG.  This function does read entire
1045    lines and passes them as C strings to the callback function (we can
1046    use C Strings because the status output is always UTF-8 encoded).
1047    Of course we have to buffer the lines to cope with long lines
1048    e.g. with a large user ID.  Note: We can optimize this to only cope
1049    with status line code we know about and skip all other stuff
1050    without buffering (i.e. without extending the buffer).  */
1051 static gpgme_error_t
1052 read_status (engine_gpg_t gpg)
1053 {
1054   char *p;
1055   int nread;
1056   size_t bufsize = gpg->status.bufsize;
1057   char *buffer = gpg->status.buffer;
1058   size_t readpos = gpg->status.readpos;
1059   gpgme_error_t err;
1060
1061   assert (buffer);
1062   if (bufsize - readpos < 256)
1063     {
1064       /* Need more room for the read.  */
1065       bufsize += 1024;
1066       buffer = realloc (buffer, bufsize);
1067       if (!buffer)
1068         return gpg_error_from_syserror ();
1069     }
1070
1071   nread = _gpgme_io_read (gpg->status.fd[0],
1072                           buffer + readpos, bufsize-readpos);
1073   if (nread == -1)
1074     return gpg_error_from_syserror ();
1075
1076   if (!nread)
1077     {
1078       err = 0;
1079       gpg->status.eof = 1;
1080       if (gpg->status.mon_cb)
1081         err = gpg->status.mon_cb (gpg->status.mon_cb_value,
1082                                   GPGME_STATUS_EOF, "");
1083       if (gpg->status.fnc)
1084         {
1085           char emptystring[1] = {0};
1086           err = gpg->status.fnc (gpg->status.fnc_value,
1087                                  GPGME_STATUS_EOF, emptystring);
1088         }
1089
1090       return err;
1091     }
1092
1093   while (nread > 0)
1094     {
1095       for (p = buffer + readpos; nread; nread--, p++)
1096         {
1097           if (*p == '\n')
1098             {
1099               /* (we require that the last line is terminated by a LF) */
1100               if (p > buffer && p[-1] == '\r')
1101                 p[-1] = 0;
1102               *p = 0;
1103               if (!strncmp (buffer, "[GNUPG:] ", 9)
1104                   && buffer[9] >= 'A' && buffer[9] <= 'Z')
1105                 {
1106                   char *rest;
1107                   gpgme_status_code_t r;
1108
1109                   rest = strchr (buffer + 9, ' ');
1110                   if (!rest)
1111                     rest = p; /* Set to an empty string.  */
1112                   else
1113                     *rest++ = 0;
1114
1115                   r = _gpgme_parse_status (buffer + 9);
1116                   if (gpg->status.mon_cb && r != GPGME_STATUS_PROGRESS)
1117                     {
1118                       /* Note that we call the monitor even if we do
1119                        * not know the status code (r < 0).  */
1120                       err = gpg->status.mon_cb (gpg->status.mon_cb_value,
1121                                                 buffer + 9, rest);
1122                       if (err)
1123                         return err;
1124                     }
1125                   if (r >= 0)
1126                     {
1127                       if (gpg->cmd.used
1128                           && (r == GPGME_STATUS_GET_BOOL
1129                               || r == GPGME_STATUS_GET_LINE
1130                               || r == GPGME_STATUS_GET_HIDDEN))
1131                         {
1132                           gpg->cmd.code = r;
1133                           if (gpg->cmd.keyword)
1134                             free (gpg->cmd.keyword);
1135                           gpg->cmd.keyword = strdup (rest);
1136                           if (!gpg->cmd.keyword)
1137                             return gpg_error_from_syserror ();
1138                           /* This should be the last thing we have
1139                              received and the next thing will be that
1140                              the command handler does its action.  */
1141                           if (nread > 1)
1142                             TRACE0 (DEBUG_CTX, "gpgme:read_status", 0,
1143                                     "error: unexpected data");
1144
1145                           add_io_cb (gpg, gpg->cmd.fd, 0,
1146                                      command_handler, gpg,
1147                                      &gpg->fd_data_map[gpg->cmd.idx].tag);
1148                           gpg->fd_data_map[gpg->cmd.idx].fd = gpg->cmd.fd;
1149                           gpg->cmd.fd = -1;
1150                         }
1151                       else if (gpg->status.fnc)
1152                         {
1153                           err = gpg->status.fnc (gpg->status.fnc_value,
1154                                                  r, rest);
1155                           if (err)
1156                             return err;
1157                         }
1158
1159                       if (r == GPGME_STATUS_END_STREAM)
1160                         {
1161                           if (gpg->cmd.used)
1162                             {
1163                               /* Before we can actually add the
1164                                  command fd, we might have to flush
1165                                  the linked output data pipe.  */
1166                               if (gpg->cmd.linked_idx != -1
1167                                   && gpg->fd_data_map[gpg->cmd.linked_idx].fd
1168                                   != -1)
1169                                 {
1170                                   struct io_select_fd_s fds;
1171                                   fds.fd =
1172                                     gpg->fd_data_map[gpg->cmd.linked_idx].fd;
1173                                   fds.for_read = 1;
1174                                   fds.for_write = 0;
1175                                   fds.opaque = NULL;
1176                                   do
1177                                     {
1178                                       fds.signaled = 0;
1179                                       _gpgme_io_select (&fds, 1, 1);
1180                                       if (fds.signaled)
1181                                         _gpgme_data_inbound_handler
1182                                           (gpg->cmd.linked_data, fds.fd);
1183                                     }
1184                                   while (fds.signaled);
1185                                 }
1186
1187                               /* XXX We must check if there are any
1188                                  more fds active after removing this
1189                                  one.  */
1190                               (*gpg->io_cbs.remove)
1191                                 (gpg->fd_data_map[gpg->cmd.idx].tag);
1192                               gpg->cmd.fd = gpg->fd_data_map[gpg->cmd.idx].fd;
1193                               gpg->fd_data_map[gpg->cmd.idx].fd = -1;
1194                             }
1195                         }
1196                     }
1197                 }
1198               /* To reuse the buffer for the next line we have to
1199                  shift the remaining data to the buffer start and
1200                  restart the loop Hmmm: We can optimize this function
1201                  by looking forward in the buffer to see whether a
1202                  second complete line is available and in this case
1203                  avoid the memmove for this line.  */
1204               nread--; p++;
1205               if (nread)
1206                 memmove (buffer, p, nread);
1207               readpos = 0;
1208               break; /* the for loop */
1209             }
1210           else
1211             readpos++;
1212         }
1213     }
1214
1215   /* Update the gpg object.  */
1216   gpg->status.bufsize = bufsize;
1217   gpg->status.buffer = buffer;
1218   gpg->status.readpos = readpos;
1219   return 0;
1220 }
1221
1222
1223 static gpgme_error_t
1224 status_handler (void *opaque, int fd)
1225 {
1226   struct io_cb_data *data = (struct io_cb_data *) opaque;
1227   engine_gpg_t gpg = (engine_gpg_t) data->handler_value;
1228   int err;
1229
1230   assert (fd == gpg->status.fd[0]);
1231   err = read_status (gpg);
1232   if (err)
1233     return err;
1234   if (gpg->status.eof)
1235     _gpgme_io_close (fd);
1236   return 0;
1237 }
1238
1239
1240 static gpgme_error_t
1241 read_colon_line (engine_gpg_t gpg)
1242 {
1243   char *p;
1244   int nread;
1245   size_t bufsize = gpg->colon.bufsize;
1246   char *buffer = gpg->colon.buffer;
1247   size_t readpos = gpg->colon.readpos;
1248
1249   assert (buffer);
1250   if (bufsize - readpos < 256)
1251     {
1252       /* Need more room for the read.  */
1253       bufsize += 1024;
1254       buffer = realloc (buffer, bufsize);
1255       if (!buffer)
1256         return gpg_error_from_syserror ();
1257     }
1258
1259   nread = _gpgme_io_read (gpg->colon.fd[0], buffer+readpos, bufsize-readpos);
1260   if (nread == -1)
1261     return gpg_error_from_syserror ();
1262
1263   if (!nread)
1264     {
1265       gpg->colon.eof = 1;
1266       assert (gpg->colon.fnc);
1267       gpg->colon.fnc (gpg->colon.fnc_value, NULL);
1268       return 0;
1269     }
1270
1271   while (nread > 0)
1272     {
1273       for (p = buffer + readpos; nread; nread--, p++)
1274         {
1275           if ( *p == '\n' )
1276             {
1277               /* (we require that the last line is terminated by a LF)
1278                  and we skip empty lines.  Note: we use UTF8 encoding
1279                  and escaping of special characters.  We require at
1280                  least one colon to cope with some other printed
1281                  information.  */
1282               *p = 0;
1283               if (*buffer && strchr (buffer, ':'))
1284                 {
1285                   char *line = NULL;
1286
1287                   if (gpg->colon.preprocess_fnc)
1288                     {
1289                       gpgme_error_t err;
1290
1291                       err = gpg->colon.preprocess_fnc (buffer, &line);
1292                       if (err)
1293                         return err;
1294                     }
1295
1296                   assert (gpg->colon.fnc);
1297                   if (line)
1298                     {
1299                       char *linep = line;
1300                       char *endp;
1301
1302                       do
1303                         {
1304                           endp = strchr (linep, '\n');
1305                           if (endp)
1306                             *endp++ = 0;
1307                           gpg->colon.fnc (gpg->colon.fnc_value, linep);
1308                           linep = endp;
1309                         }
1310                       while (linep && *linep);
1311
1312                       free (line);
1313                     }
1314                   else
1315                     gpg->colon.fnc (gpg->colon.fnc_value, buffer);
1316                 }
1317
1318               /* To reuse the buffer for the next line we have to
1319                  shift the remaining data to the buffer start and
1320                  restart the loop Hmmm: We can optimize this function
1321                  by looking forward in the buffer to see whether a
1322                  second complete line is available and in this case
1323                  avoid the memmove for this line.  */
1324               nread--; p++;
1325               if (nread)
1326                 memmove (buffer, p, nread);
1327               readpos = 0;
1328               break; /* The for loop.  */
1329             }
1330           else
1331             readpos++;
1332         }
1333     }
1334
1335   /* Update the gpg object.  */
1336   gpg->colon.bufsize = bufsize;
1337   gpg->colon.buffer  = buffer;
1338   gpg->colon.readpos = readpos;
1339   return 0;
1340 }
1341
1342
1343 /* This colonline handler thing is not the clean way to do it.  It
1344    might be better to enhance the gpgme_data_t object to act as a wrapper
1345    for a callback.  Same goes for the status thing.  For now we use
1346    this thing here because it is easier to implement.  */
1347 static gpgme_error_t
1348 colon_line_handler (void *opaque, int fd)
1349 {
1350   struct io_cb_data *data = (struct io_cb_data *) opaque;
1351   engine_gpg_t gpg = (engine_gpg_t) data->handler_value;
1352   gpgme_error_t rc = 0;
1353
1354   assert (fd == gpg->colon.fd[0]);
1355   rc = read_colon_line (gpg);
1356   if (rc)
1357     return rc;
1358   if (gpg->colon.eof)
1359     _gpgme_io_close (fd);
1360   return 0;
1361 }
1362
1363
1364 static gpgme_error_t
1365 start (engine_gpg_t gpg)
1366 {
1367   gpgme_error_t rc;
1368   int i, n;
1369   int status;
1370   struct spawn_fd_item_s *fd_list;
1371   pid_t pid;
1372   const char *pgmname;
1373
1374   if (!gpg)
1375     return gpg_error (GPG_ERR_INV_VALUE);
1376
1377   if (!gpg->file_name && !_gpgme_get_default_gpg_name ())
1378     return trace_gpg_error (GPG_ERR_INV_ENGINE);
1379
1380   if (gpg->lc_ctype)
1381     {
1382       rc = add_arg_ext (gpg, gpg->lc_ctype, 1);
1383       if (!rc)
1384         rc = add_arg_ext (gpg, "--lc-ctype", 1);
1385       if (rc)
1386         return rc;
1387     }
1388
1389   if (gpg->lc_messages)
1390     {
1391       rc = add_arg_ext (gpg, gpg->lc_messages, 1);
1392       if (!rc)
1393         rc = add_arg_ext (gpg, "--lc-messages", 1);
1394       if (rc)
1395         return rc;
1396     }
1397
1398   pgmname = gpg->file_name ? gpg->file_name : _gpgme_get_default_gpg_name ();
1399   rc = build_argv (gpg, pgmname);
1400   if (rc)
1401     return rc;
1402
1403   /* status_fd, colon_fd and end of list.  */
1404   n = 3;
1405   for (i = 0; gpg->fd_data_map[i].data; i++)
1406     n++;
1407   fd_list = calloc (n, sizeof *fd_list);
1408   if (! fd_list)
1409     return gpg_error_from_syserror ();
1410
1411   /* Build the fd list for the child.  */
1412   n = 0;
1413   fd_list[n].fd = gpg->status.fd[1];
1414   fd_list[n].dup_to = -1;
1415   fd_list[n].arg_loc = gpg->status.arg_loc;
1416   n++;
1417   if (gpg->colon.fnc)
1418     {
1419       fd_list[n].fd = gpg->colon.fd[1];
1420       fd_list[n].dup_to = 1;
1421       n++;
1422     }
1423   for (i = 0; gpg->fd_data_map[i].data; i++)
1424     {
1425       fd_list[n].fd = gpg->fd_data_map[i].peer_fd;
1426       fd_list[n].dup_to = gpg->fd_data_map[i].dup_to;
1427       fd_list[n].arg_loc = gpg->fd_data_map[i].arg_loc;
1428       n++;
1429     }
1430   fd_list[n].fd = -1;
1431   fd_list[n].dup_to = -1;
1432
1433   status = _gpgme_io_spawn (pgmname, gpg->argv,
1434                             (IOSPAWN_FLAG_DETACHED |IOSPAWN_FLAG_ALLOW_SET_FG),
1435                             fd_list, NULL, NULL, &pid);
1436   {
1437     int saved_err = gpg_error_from_syserror ();
1438     free (fd_list);
1439     if (status == -1)
1440       return saved_err;
1441   }
1442
1443   /*_gpgme_register_term_handler ( closure, closure_value, pid );*/
1444
1445   rc = add_io_cb (gpg, gpg->status.fd[0], 1, status_handler, gpg,
1446                   &gpg->status.tag);
1447   if (rc)
1448     /* FIXME: kill the child */
1449     return rc;
1450
1451   if (gpg->colon.fnc)
1452     {
1453       assert (gpg->colon.fd[0] != -1);
1454       rc = add_io_cb (gpg, gpg->colon.fd[0], 1, colon_line_handler, gpg,
1455                       &gpg->colon.tag);
1456       if (rc)
1457         /* FIXME: kill the child */
1458         return rc;
1459     }
1460
1461   for (i = 0; gpg->fd_data_map[i].data; i++)
1462     {
1463       if (gpg->cmd.used && i == gpg->cmd.idx)
1464         {
1465           /* Park the cmd fd.  */
1466           gpg->cmd.fd = gpg->fd_data_map[i].fd;
1467           gpg->fd_data_map[i].fd = -1;
1468         }
1469       else
1470         {
1471           rc = add_io_cb (gpg, gpg->fd_data_map[i].fd,
1472                           gpg->fd_data_map[i].inbound,
1473                           gpg->fd_data_map[i].inbound
1474                           ? _gpgme_data_inbound_handler
1475                           : _gpgme_data_outbound_handler,
1476                           gpg->fd_data_map[i].data, &gpg->fd_data_map[i].tag);
1477
1478           if (rc)
1479             /* FIXME: kill the child */
1480             return rc;
1481         }
1482     }
1483
1484   gpg_io_event (gpg, GPGME_EVENT_START, NULL);
1485
1486   /* fixme: check what data we can release here */
1487   return 0;
1488 }
1489
1490
1491 /* Add the --input-size-hint option if requested.  */
1492 static gpgme_error_t
1493 add_input_size_hint (engine_gpg_t gpg, gpgme_data_t data)
1494 {
1495   gpgme_error_t err;
1496   gpgme_off_t value = _gpgme_data_get_size_hint (data);
1497   char numbuf[50];  /* Large enough for even 2^128 in base-10.  */
1498   char *p;
1499
1500   if (!value || !have_gpg_version (gpg, "2.1.15"))
1501     return 0;
1502
1503   err = add_arg (gpg, "--input-size-hint");
1504   if (!err)
1505     {
1506       p = numbuf + sizeof numbuf;
1507       *--p = 0;
1508       do
1509         {
1510           *--p = '0' + (value % 10);
1511           value /= 10;
1512         }
1513       while (value);
1514       err = add_arg (gpg, p);
1515     }
1516   return err;
1517 }
1518
1519
1520 static gpgme_error_t
1521 gpg_decrypt (void *engine, gpgme_data_t ciph, gpgme_data_t plain)
1522 {
1523   engine_gpg_t gpg = engine;
1524   gpgme_error_t err;
1525
1526   err = add_arg (gpg, "--decrypt");
1527
1528   /* Tell the gpg object about the data.  */
1529   if (!err)
1530     err = add_arg (gpg, "--output");
1531   if (!err)
1532     err = add_arg (gpg, "-");
1533   if (!err)
1534     err = add_data (gpg, plain, 1, 1);
1535   if (!err)
1536     err = add_input_size_hint (gpg, ciph);
1537   if (!err)
1538     err = add_arg (gpg, "--");
1539   if (!err)
1540     err = add_data (gpg, ciph, -1, 0);
1541
1542   if (!err)
1543     err = start (gpg);
1544   return err;
1545 }
1546
1547 static gpgme_error_t
1548 gpg_delete (void *engine, gpgme_key_t key, int allow_secret)
1549 {
1550   engine_gpg_t gpg = engine;
1551   gpgme_error_t err;
1552
1553   err = add_arg (gpg, allow_secret ? "--delete-secret-and-public-key"
1554                  : "--delete-key");
1555   if (!err)
1556     err = add_arg (gpg, "--");
1557   if (!err)
1558     {
1559       if (!key->subkeys || !key->subkeys->fpr)
1560         return gpg_error (GPG_ERR_INV_VALUE);
1561       else
1562         err = add_arg (gpg, key->subkeys->fpr);
1563     }
1564
1565   if (!err)
1566     err = start (gpg);
1567   return err;
1568 }
1569
1570
1571 static gpgme_error_t
1572 gpg_passwd (void *engine, gpgme_key_t key, unsigned int flags)
1573 {
1574   engine_gpg_t gpg = engine;
1575   gpgme_error_t err;
1576
1577   if (!key || !key->subkeys || !key->subkeys->fpr)
1578     return gpg_error (GPG_ERR_INV_CERT_OBJ);
1579
1580   err = add_arg (gpg, "--passwd");
1581   if (!err)
1582     err = add_arg (gpg, key->subkeys->fpr);
1583   if (!err)
1584     err = start (gpg);
1585   return err;
1586 }
1587
1588
1589 static gpgme_error_t
1590 append_args_from_signers (engine_gpg_t gpg, gpgme_ctx_t ctx /* FIXME */)
1591 {
1592   gpgme_error_t err = 0;
1593   int i;
1594   gpgme_key_t key;
1595
1596   for (i = 0; (key = gpgme_signers_enum (ctx, i)); i++)
1597     {
1598       const char *s = key->subkeys ? key->subkeys->keyid : NULL;
1599       if (s)
1600         {
1601           if (!err)
1602             err = add_arg (gpg, "-u");
1603           if (!err)
1604             err = add_arg (gpg, s);
1605         }
1606       gpgme_key_unref (key);
1607       if (err) break;
1608     }
1609   return err;
1610 }
1611
1612
1613 static gpgme_error_t
1614 append_args_from_sig_notations (engine_gpg_t gpg, gpgme_ctx_t ctx /* FIXME */)
1615 {
1616   gpgme_error_t err = 0;
1617   gpgme_sig_notation_t notation;
1618
1619   notation = gpgme_sig_notation_get (ctx);
1620
1621   while (!err && notation)
1622     {
1623       if (notation->name
1624           && !(notation->flags & GPGME_SIG_NOTATION_HUMAN_READABLE))
1625         err = gpg_error (GPG_ERR_INV_VALUE);
1626       else if (notation->name)
1627         {
1628           char *arg;
1629
1630           /* Maximum space needed is one byte for the "critical" flag,
1631              the name, one byte for '=', the value, and a terminating
1632              '\0'.  */
1633
1634           arg = malloc (1 + notation->name_len + 1 + notation->value_len + 1);
1635           if (!arg)
1636             err = gpg_error_from_syserror ();
1637
1638           if (!err)
1639             {
1640               char *argp = arg;
1641
1642               if (notation->critical)
1643                 *(argp++) = '!';
1644
1645               memcpy (argp, notation->name, notation->name_len);
1646               argp += notation->name_len;
1647
1648               *(argp++) = '=';
1649
1650               /* We know that notation->name is '\0' terminated.  */
1651               strcpy (argp, notation->value);
1652             }
1653
1654           if (!err)
1655             err = add_arg (gpg, "--sig-notation");
1656           if (!err)
1657             err = add_arg (gpg, arg);
1658
1659           if (arg)
1660             free (arg);
1661         }
1662       else
1663         {
1664           /* This is a policy URL.  */
1665
1666           char *value;
1667
1668           if (notation->critical)
1669             {
1670               value = malloc (1 + notation->value_len + 1);
1671               if (!value)
1672                 err = gpg_error_from_syserror ();
1673               else
1674                 {
1675                   value[0] = '!';
1676                   /* We know that notation->value is '\0' terminated.  */
1677                   strcpy (&value[1], notation->value);
1678                 }
1679             }
1680           else
1681             value = notation->value;
1682
1683           if (!err)
1684             err = add_arg (gpg, "--sig-policy-url");
1685           if (!err)
1686             err = add_arg (gpg, value);
1687
1688           if (value != notation->value)
1689             free (value);
1690         }
1691
1692       notation = notation->next;
1693     }
1694   return err;
1695 }
1696
1697
1698 static gpgme_error_t
1699 gpg_edit (void *engine, int type, gpgme_key_t key, gpgme_data_t out,
1700           gpgme_ctx_t ctx /* FIXME */)
1701 {
1702   engine_gpg_t gpg = engine;
1703   gpgme_error_t err;
1704
1705   err = add_arg (gpg, "--with-colons");
1706   if (!err)
1707     err = append_args_from_signers (gpg, ctx);
1708   if (!err)
1709   err = add_arg (gpg, type == 0 ? "--edit-key" : "--card-edit");
1710   if (!err)
1711     err = add_data (gpg, out, 1, 1);
1712   if (!err)
1713     err = add_arg (gpg, "--");
1714   if (!err && type == 0)
1715     {
1716       const char *s = key->subkeys ? key->subkeys->fpr : NULL;
1717       if (!s)
1718         err = gpg_error (GPG_ERR_INV_VALUE);
1719       else
1720         err = add_arg (gpg, s);
1721     }
1722   if (!err)
1723     err = start (gpg);
1724
1725   return err;
1726 }
1727
1728
1729 static gpgme_error_t
1730 append_args_from_recipients (engine_gpg_t gpg, gpgme_key_t recp[])
1731 {
1732   gpgme_error_t err = 0;
1733   int i = 0;
1734
1735   while (recp[i])
1736     {
1737       if (!recp[i]->subkeys || !recp[i]->subkeys->fpr)
1738         err = gpg_error (GPG_ERR_INV_VALUE);
1739       if (!err)
1740         err = add_arg (gpg, "-r");
1741       if (!err)
1742         err = add_arg (gpg, recp[i]->subkeys->fpr);
1743       if (err)
1744         break;
1745       i++;
1746     }
1747   return err;
1748 }
1749
1750
1751 static gpgme_error_t
1752 gpg_encrypt (void *engine, gpgme_key_t recp[], gpgme_encrypt_flags_t flags,
1753              gpgme_data_t plain, gpgme_data_t ciph, int use_armor)
1754 {
1755   engine_gpg_t gpg = engine;
1756   gpgme_error_t err = 0;
1757
1758   if (recp)
1759     err = add_arg (gpg, "--encrypt");
1760
1761   if (!err && ((flags & GPGME_ENCRYPT_SYMMETRIC) || !recp))
1762     err = add_arg (gpg, "--symmetric");
1763
1764   if (!err && use_armor)
1765     err = add_arg (gpg, "--armor");
1766
1767   if (!err && (flags & GPGME_ENCRYPT_NO_COMPRESS))
1768     err = add_arg (gpg, "--compress-algo=none");
1769
1770   if (gpgme_data_get_encoding (plain) == GPGME_DATA_ENCODING_MIME
1771       && have_gpg_version (gpg, "2.1.14"))
1772     err = add_arg (gpg, "--mimemode");
1773
1774   if (recp)
1775     {
1776       /* If we know that all recipients are valid (full or ultimate trust)
1777          we can suppress further checks.  */
1778       if (!err && (flags & GPGME_ENCRYPT_ALWAYS_TRUST))
1779         err = add_arg (gpg, "--always-trust");
1780
1781       if (!err && (flags & GPGME_ENCRYPT_NO_ENCRYPT_TO))
1782         err = add_arg (gpg, "--no-encrypt-to");
1783
1784       if (!err)
1785         err = append_args_from_recipients (gpg, recp);
1786     }
1787
1788   /* Tell the gpg object about the data.  */
1789   if (!err)
1790     err = add_arg (gpg, "--output");
1791   if (!err)
1792     err = add_arg (gpg, "-");
1793   if (!err)
1794     err = add_data (gpg, ciph, 1, 1);
1795   if (gpgme_data_get_file_name (plain))
1796     {
1797       if (!err)
1798         err = add_arg (gpg, "--set-filename");
1799       if (!err)
1800         err = add_arg (gpg, gpgme_data_get_file_name (plain));
1801     }
1802   if (!err)
1803     err = add_input_size_hint (gpg, plain);
1804   if (!err)
1805     err = add_arg (gpg, "--");
1806   if (!err)
1807     err = add_data (gpg, plain, -1, 0);
1808
1809   if (!err)
1810     err = start (gpg);
1811
1812   return err;
1813 }
1814
1815
1816 static gpgme_error_t
1817 gpg_encrypt_sign (void *engine, gpgme_key_t recp[],
1818                   gpgme_encrypt_flags_t flags, gpgme_data_t plain,
1819                   gpgme_data_t ciph, int use_armor,
1820                   gpgme_ctx_t ctx /* FIXME */)
1821 {
1822   engine_gpg_t gpg = engine;
1823   gpgme_error_t err = 0;
1824
1825   if (recp)
1826     err = add_arg (gpg, "--encrypt");
1827
1828   if (!err && ((flags & GPGME_ENCRYPT_SYMMETRIC) || !recp))
1829     err = add_arg (gpg, "--symmetric");
1830
1831   if (!err)
1832     err = add_arg (gpg, "--sign");
1833   if (!err && use_armor)
1834     err = add_arg (gpg, "--armor");
1835
1836   if (!err && (flags & GPGME_ENCRYPT_NO_COMPRESS))
1837     err = add_arg (gpg, "--compress-algo=none");
1838
1839   if (gpgme_data_get_encoding (plain) == GPGME_DATA_ENCODING_MIME
1840       && have_gpg_version (gpg, "2.1.14"))
1841     err = add_arg (gpg, "--mimemode");
1842
1843   if (recp)
1844     {
1845       /* If we know that all recipients are valid (full or ultimate trust)
1846          we can suppress further checks.  */
1847       if (!err && (flags & GPGME_ENCRYPT_ALWAYS_TRUST))
1848         err = add_arg (gpg, "--always-trust");
1849
1850       if (!err && (flags & GPGME_ENCRYPT_NO_ENCRYPT_TO))
1851         err = add_arg (gpg, "--no-encrypt-to");
1852
1853       if (!err)
1854         err = append_args_from_recipients (gpg, recp);
1855     }
1856
1857   if (!err)
1858     err = append_args_from_signers (gpg, ctx);
1859
1860   if (!err)
1861     err = append_args_from_sig_notations (gpg, ctx);
1862
1863   /* Tell the gpg object about the data.  */
1864   if (!err)
1865     err = add_arg (gpg, "--output");
1866   if (!err)
1867     err = add_arg (gpg, "-");
1868   if (!err)
1869     err = add_data (gpg, ciph, 1, 1);
1870   if (gpgme_data_get_file_name (plain))
1871     {
1872       if (!err)
1873         err = add_arg (gpg, "--set-filename");
1874       if (!err)
1875         err = add_arg (gpg, gpgme_data_get_file_name (plain));
1876     }
1877   if (!err)
1878     err = add_input_size_hint (gpg, plain);
1879   if (!err)
1880     err = add_arg (gpg, "--");
1881   if (!err)
1882     err = add_data (gpg, plain, -1, 0);
1883
1884   if (!err)
1885     err = start (gpg);
1886
1887   return err;
1888 }
1889
1890
1891 static gpgme_error_t
1892 export_common (engine_gpg_t gpg, gpgme_export_mode_t mode,
1893                gpgme_data_t keydata, int use_armor)
1894 {
1895   gpgme_error_t err = 0;
1896
1897   if ((mode & ~(GPGME_EXPORT_MODE_EXTERN
1898                 |GPGME_EXPORT_MODE_MINIMAL
1899                 |GPGME_EXPORT_MODE_SECRET)))
1900     return gpg_error (GPG_ERR_NOT_SUPPORTED);
1901
1902   if ((mode & GPGME_EXPORT_MODE_MINIMAL))
1903     err = add_arg (gpg, "--export-options=export-minimal");
1904
1905   if (err)
1906     ;
1907   else if ((mode & GPGME_EXPORT_MODE_EXTERN))
1908     {
1909       err = add_arg (gpg, "--send-keys");
1910     }
1911   else
1912     {
1913       if ((mode & GPGME_EXPORT_MODE_SECRET))
1914         err = add_arg (gpg, "--export-secret-keys");
1915       else
1916         err = add_arg (gpg, "--export");
1917       if (!err && use_armor)
1918         err = add_arg (gpg, "--armor");
1919       if (!err)
1920         err = add_data (gpg, keydata, 1, 1);
1921     }
1922   if (!err)
1923     err = add_arg (gpg, "--");
1924
1925   return err;
1926 }
1927
1928
1929 static gpgme_error_t
1930 gpg_export (void *engine, const char *pattern, gpgme_export_mode_t mode,
1931             gpgme_data_t keydata, int use_armor)
1932 {
1933   engine_gpg_t gpg = engine;
1934   gpgme_error_t err;
1935
1936   err = export_common (gpg, mode, keydata, use_armor);
1937
1938   if (!err && pattern && *pattern)
1939     err = add_arg (gpg, pattern);
1940
1941   if (!err)
1942     err = start (gpg);
1943
1944   return err;
1945 }
1946
1947
1948 static gpgme_error_t
1949 gpg_export_ext (void *engine, const char *pattern[], gpgme_export_mode_t mode,
1950                 gpgme_data_t keydata, int use_armor)
1951 {
1952   engine_gpg_t gpg = engine;
1953   gpgme_error_t err;
1954
1955   err = export_common (gpg, mode, keydata, use_armor);
1956
1957   if (pattern)
1958     {
1959       while (!err && *pattern && **pattern)
1960         err = add_arg (gpg, *(pattern++));
1961     }
1962
1963   if (!err)
1964     err = start (gpg);
1965
1966   return err;
1967 }
1968
1969
1970 static gpgme_error_t
1971 gpg_createkey_from_param (engine_gpg_t gpg,
1972                           gpgme_data_t help_data, int use_armor)
1973 {
1974   gpgme_error_t err;
1975
1976   err = add_arg (gpg, "--gen-key");
1977   if (!err && use_armor)
1978     err = add_arg (gpg, "--armor");
1979   if (!err)
1980     err = add_arg (gpg, "--");
1981   if (!err)
1982     err = add_data (gpg, help_data, -1, 0);
1983   if (!err)
1984     err = start (gpg);
1985   return err;
1986 }
1987
1988
1989 /* This is used for gpg versions which do not support the quick-genkey
1990  * command to emulate the gpgme_op_createkey API.  */
1991 static gpgme_error_t
1992 gpg_createkey_legacy (engine_gpg_t gpg,
1993                const char *userid, const char *algo,
1994                unsigned long expires,
1995                unsigned int flags,
1996                int use_armor)
1997 {
1998   return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
1999 }
2000
2001
2002 static gpgme_error_t
2003 gpg_createkey (engine_gpg_t gpg,
2004                const char *userid, const char *algo,
2005                unsigned long expires,
2006                unsigned int flags,
2007                int use_armor)
2008 {
2009   gpgme_error_t err;
2010
2011   err = add_arg (gpg, "--quick-gen-key");
2012   if (!err && use_armor)
2013     err = add_arg (gpg, "--armor");
2014   if (!err && (flags & GPGME_CREATE_NOPASSWD))
2015     {
2016       err = add_arg (gpg, "--passphrase");
2017       if (!err)
2018         err = add_arg (gpg, "");
2019     }
2020   if (!err && (flags & GPGME_CREATE_FORCE))
2021     err = add_arg (gpg, "--yes");
2022   if (!err)
2023     err = add_arg (gpg, "--");
2024   if (!err)
2025     err = add_arg (gpg, userid);
2026
2027   /* This condition is only required to allow the use of gpg < 2.1.16 */
2028   if (algo
2029       || (flags & (GPGME_CREATE_SIGN | GPGME_CREATE_ENCR
2030                    | GPGME_CREATE_CERT | GPGME_CREATE_AUTH))
2031       || expires)
2032     {
2033
2034       if (!err)
2035         err = add_arg (gpg, algo? algo : "default");
2036       if (!err)
2037         {
2038           char tmpbuf[5*4+1];
2039           snprintf (tmpbuf, sizeof tmpbuf, "%s%s%s%s",
2040                     (flags & GPGME_CREATE_SIGN)? " sign":"",
2041                     (flags & GPGME_CREATE_ENCR)? " encr":"",
2042                     (flags & GPGME_CREATE_CERT)? " cert":"",
2043                     (flags & GPGME_CREATE_AUTH)? " auth":"");
2044           err = add_arg (gpg, *tmpbuf? tmpbuf : "default");
2045         }
2046       if (!err && expires)
2047         {
2048           char tmpbuf[8+20];
2049           snprintf (tmpbuf, sizeof tmpbuf, "seconds=%lu", expires);
2050           err = add_arg (gpg, tmpbuf);
2051         }
2052     }
2053
2054   if (!err)
2055     err = start (gpg);
2056   return err;
2057 }
2058
2059
2060 static gpgme_error_t
2061 gpg_addkey (engine_gpg_t gpg,
2062             const char *algo,
2063             unsigned long expires,
2064             gpgme_key_t key,
2065             unsigned int flags,
2066             int use_armor)
2067 {
2068   return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
2069 }
2070
2071
2072 static gpgme_error_t
2073 gpg_adduid (engine_gpg_t gpg,
2074             const char *userid,
2075             unsigned int flags,
2076             int use_armor)
2077 {
2078   return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
2079 }
2080
2081
2082 static gpgme_error_t
2083 gpg_genkey (void *engine,
2084             const char *userid, const char *algo,
2085             unsigned long reserved, unsigned long expires,
2086             gpgme_key_t key, unsigned int flags,
2087             gpgme_data_t help_data, int use_armor,
2088             gpgme_data_t pubkey, gpgme_data_t seckey)
2089 {
2090   engine_gpg_t gpg = engine;
2091   gpgme_error_t err;
2092
2093   (void)reserved;
2094
2095   if (!gpg)
2096     return gpg_error (GPG_ERR_INV_VALUE);
2097
2098   /* If HELP_DATA is given the use of the old interface
2099    * (gpgme_op_genkey) has been requested.  The other modes are:
2100    *
2101    *  USERID && !KEY          - Create a new keyblock.
2102    * !USERID &&  KEY          - Add a new subkey to KEY (gpg >= 2.1.14)
2103    *  USERID &&  KEY && !ALGO - Add a new user id to KEY (gpg >= 2.1.14).
2104    *
2105    */
2106   if (help_data)
2107     {
2108       /* We need a special mechanism to get the fd of a pipe here, so
2109          that we can use this for the %pubring and %secring
2110          parameters.  We don't have this yet, so we implement only the
2111          adding to the standard keyrings.  */
2112       if (pubkey || seckey)
2113         err = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
2114       else
2115         err = gpg_createkey_from_param (gpg, help_data, use_armor);
2116     }
2117   else if (userid && !key)
2118     {
2119       if (!have_gpg_version (gpg, "2.1.13"))
2120         err = gpg_createkey_legacy (gpg, userid, algo, expires, flags,
2121                                     use_armor);
2122       else
2123         err = gpg_createkey (gpg, userid, algo, expires, flags, use_armor);
2124     }
2125   else if (!have_gpg_version (gpg, "2.1.13"))
2126     err = gpg_error (GPG_ERR_NOT_SUPPORTED);
2127   else if (!userid && key)
2128     err = gpg_addkey (gpg, algo, expires, key, flags, use_armor);
2129   else if (userid && key && !algo)
2130     err = gpg_adduid (gpg, userid, flags, use_armor);
2131   else
2132     err = gpg_error (GPG_ERR_INV_VALUE);
2133
2134   return err;
2135 }
2136
2137 /* Return the next DELIM delimited string from DATA as a C-string.
2138    The caller needs to provide the address of a pointer variable which
2139    he has to set to NULL before the first call.  After the last call
2140    to this function, this function needs to be called once more with
2141    DATA set to NULL so that the function can release its internal
2142    state.  After that the pointer variable is free for use again.
2143    Note that we use a delimiter and thus a trailing delimiter is not
2144    required.  DELIM may not be changed after the first call. */
2145 static const char *
2146 string_from_data (gpgme_data_t data, int delim,
2147                   void **helpptr, gpgme_error_t *r_err)
2148 {
2149 #define MYBUFLEN 2000 /* Fixme: We don't support URLs longer than that.  */
2150   struct {
2151     int  eof_seen;
2152     int  nbytes;      /* Length of the last returned string including
2153                          the delimiter. */
2154     int  buflen;      /* Valid length of BUF.  */
2155     char buf[MYBUFLEN+1];  /* Buffer with one byte extra space.  */
2156   } *self;
2157   char *p;
2158   int nread;
2159
2160   *r_err = 0;
2161   if (!data)
2162     {
2163       if (*helpptr)
2164         {
2165           free (*helpptr);
2166           *helpptr = NULL;
2167         }
2168       return NULL;
2169     }
2170
2171   if (*helpptr)
2172     self = *helpptr;
2173   else
2174     {
2175       self = malloc (sizeof *self);
2176       if (!self)
2177         {
2178           *r_err = gpg_error_from_syserror ();
2179           return NULL;
2180         }
2181       *helpptr = self;
2182       self->eof_seen = 0;
2183       self->nbytes = 0;
2184       self->buflen = 0;
2185     }
2186
2187   if (self->eof_seen)
2188     return NULL;
2189
2190   assert (self->nbytes <= self->buflen);
2191   memmove (self->buf, self->buf + self->nbytes, self->buflen - self->nbytes);
2192   self->buflen -= self->nbytes;
2193   self->nbytes = 0;
2194
2195   do
2196     {
2197       /* Fixme: This is fairly infective scanning because we may scan
2198          the buffer several times.  */
2199       p = memchr (self->buf, delim, self->buflen);
2200       if (p)
2201         {
2202           *p = 0;
2203           self->nbytes = p - self->buf + 1;
2204           return self->buf;
2205         }
2206
2207       if ( !(MYBUFLEN - self->buflen) )
2208         {
2209           /* Not enough space - URL too long.  */
2210           *r_err = gpg_error (GPG_ERR_TOO_LARGE);
2211           return NULL;
2212         }
2213
2214       nread = gpgme_data_read (data, self->buf + self->buflen,
2215                                MYBUFLEN - self->buflen);
2216       if (nread < 0)
2217         {
2218           *r_err = gpg_error_from_syserror ();
2219           return NULL;
2220         }
2221       self->buflen += nread;
2222     }
2223   while (nread);
2224
2225   /* EOF reached.  If we have anything in the buffer, append a Nul and
2226      return it. */
2227   self->eof_seen = 1;
2228   if (self->buflen)
2229     {
2230       self->buf[self->buflen] = 0;  /* (we allocated one extra byte)  */
2231       return self->buf;
2232     }
2233   return NULL;
2234 #undef MYBUFLEN
2235 }
2236
2237
2238
2239 static gpgme_error_t
2240 gpg_import (void *engine, gpgme_data_t keydata, gpgme_key_t *keyarray)
2241 {
2242   engine_gpg_t gpg = engine;
2243   gpgme_error_t err;
2244   int idx;
2245   gpgme_data_encoding_t dataenc;
2246
2247   if (keydata && keyarray)
2248     return gpg_error (GPG_ERR_INV_VALUE); /* Only one is allowed.  */
2249
2250   dataenc = gpgme_data_get_encoding (keydata);
2251
2252   if (keyarray)
2253     {
2254       err = add_arg (gpg, "--recv-keys");
2255       if (!err)
2256         err = add_arg (gpg, "--");
2257       for (idx=0; !err && keyarray[idx]; idx++)
2258         {
2259           if (keyarray[idx]->protocol != GPGME_PROTOCOL_OpenPGP)
2260             ;
2261           else if (!keyarray[idx]->subkeys)
2262             ;
2263           else if (keyarray[idx]->subkeys->fpr && *keyarray[idx]->subkeys->fpr)
2264             err = add_arg (gpg, keyarray[idx]->subkeys->fpr);
2265           else if (*keyarray[idx]->subkeys->keyid)
2266             err = add_arg (gpg, keyarray[idx]->subkeys->keyid);
2267         }
2268     }
2269   else if (dataenc == GPGME_DATA_ENCODING_URL
2270            || dataenc == GPGME_DATA_ENCODING_URL0)
2271     {
2272       void *helpptr;
2273       const char *string;
2274       gpgme_error_t xerr;
2275       int delim = (dataenc == GPGME_DATA_ENCODING_URL)? '\n': 0;
2276
2277       /* FIXME: --fetch-keys is probably not correct because it can't
2278          grok all kinds of URLs.  On Unix it should just work but on
2279          Windows we will build the command line and that may fail for
2280          some embedded control characters.  It is anyway limited to
2281          the maximum size of the command line.  We need another
2282          command which can take its input from a file.  Maybe we
2283          should use an option to gpg to modify such commands (ala
2284          --multifile).  */
2285       err = add_arg (gpg, "--fetch-keys");
2286       if (!err)
2287         err = add_arg (gpg, "--");
2288       helpptr = NULL;
2289       while (!err
2290              && (string = string_from_data (keydata, delim, &helpptr, &xerr)))
2291         err = add_arg (gpg, string);
2292       if (!err)
2293         err = xerr;
2294       string_from_data (NULL, delim, &helpptr, &xerr);
2295     }
2296   else if (dataenc == GPGME_DATA_ENCODING_URLESC)
2297     {
2298       /* Already escaped URLs are not yet supported.  */
2299       err = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
2300     }
2301   else
2302     {
2303       err = add_arg (gpg, "--import");
2304       if (!err)
2305         err = add_arg (gpg, "--");
2306       if (!err)
2307         err = add_data (gpg, keydata, -1, 0);
2308     }
2309
2310   if (!err)
2311     err = start (gpg);
2312
2313   return err;
2314 }
2315
2316
2317 /* The output for external keylistings in GnuPG is different from all
2318    the other key listings.  We catch this here with a special
2319    preprocessor that reformats the colon handler lines.  */
2320 static gpgme_error_t
2321 gpg_keylist_preprocess (char *line, char **r_line)
2322 {
2323   enum
2324     {
2325       RT_NONE, RT_INFO, RT_PUB, RT_UID
2326     }
2327   rectype = RT_NONE;
2328 #define NR_FIELDS 16
2329   char *field[NR_FIELDS];
2330   int fields = 0;
2331   size_t n;
2332
2333   *r_line = NULL;
2334
2335   while (line && fields < NR_FIELDS)
2336     {
2337       field[fields++] = line;
2338       line = strchr (line, ':');
2339       if (line)
2340         *(line++) = '\0';
2341     }
2342
2343   if (!strcmp (field[0], "info"))
2344     rectype = RT_INFO;
2345   else if (!strcmp (field[0], "pub"))
2346     rectype = RT_PUB;
2347   else if (!strcmp (field[0], "uid"))
2348     rectype = RT_UID;
2349   else
2350     rectype = RT_NONE;
2351
2352   switch (rectype)
2353     {
2354     case RT_INFO:
2355       /* FIXME: Eventually, check the version number at least.  */
2356       return 0;
2357
2358     case RT_PUB:
2359       if (fields < 7)
2360         return 0;
2361
2362       /* The format is:
2363
2364          pub:<keyid>:<algo>:<keylen>:<creationdate>:<expirationdate>:<flags>
2365
2366          as defined in 5.2. Machine Readable Indexes of the OpenPGP
2367          HTTP Keyserver Protocol (draft).  Modern versions of the SKS
2368          keyserver return the fingerprint instead of the keyid.  We
2369          detect this here and use the v4 fingerprint format to convert
2370          it to a key id.
2371
2372          We want:
2373          pub:o<flags>:<keylen>:<algo>:<keyid>:<creatdate>:<expdate>::::::::
2374       */
2375
2376       n = strlen (field[1]);
2377       if (n > 16)
2378         {
2379           if (asprintf (r_line,
2380                         "pub:o%s:%s:%s:%s:%s:%s::::::::\n"
2381                         "fpr:::::::::%s:",
2382                         field[6], field[3], field[2], field[1] + n - 16,
2383                         field[4], field[5], field[1]) < 0)
2384             return gpg_error_from_syserror ();
2385         }
2386       else
2387         {
2388           if (asprintf (r_line,
2389                         "pub:o%s:%s:%s:%s:%s:%s::::::::",
2390                         field[6], field[3], field[2], field[1],
2391                         field[4], field[5]) < 0)
2392             return gpg_error_from_syserror ();
2393         }
2394
2395       return 0;
2396
2397     case RT_UID:
2398       /* The format is:
2399
2400          uid:<escaped uid string>:<creationdate>:<expirationdate>:<flags>
2401
2402          as defined in 5.2. Machine Readable Indexes of the OpenPGP
2403          HTTP Keyserver Protocol (draft).
2404
2405          We want:
2406          uid:o<flags>::::<creatdate>:<expdate>:::<c-coded uid>:
2407       */
2408
2409       {
2410         /* The user ID is percent escaped, but we want c-coded.
2411            Because we have to replace each '%HL' by '\xHL', we need at
2412            most 4/3 th the number of bytes.  But because we also need
2413            to escape the backslashes we allocate twice as much.  */
2414         char *uid = malloc (2 * strlen (field[1]) + 1);
2415         char *src;
2416         char *dst;
2417
2418         if (! uid)
2419           return gpg_error_from_syserror ();
2420         src = field[1];
2421         dst = uid;
2422         while (*src)
2423           {
2424             if (*src == '%')
2425               {
2426                 *(dst++) = '\\';
2427                 *(dst++) = 'x';
2428                 src++;
2429                 /* Copy the next two bytes unconditionally.  */
2430                 if (*src)
2431                   *(dst++) = *(src++);
2432                 if (*src)
2433                   *(dst++) = *(src++);
2434               }
2435             else if (*src == '\\')
2436               {
2437                 *dst++ = '\\';
2438                 *dst++ = '\\';
2439                 src++;
2440               }
2441             else
2442               *(dst++) = *(src++);
2443           }
2444         *dst = '\0';
2445
2446         if (asprintf (r_line, "uid:o%s::::%s:%s:::%s:",
2447                       field[4], field[2], field[3], uid) < 0)
2448           return gpg_error_from_syserror ();
2449       }
2450       return 0;
2451
2452     case RT_NONE:
2453       /* Unknown record.  */
2454       break;
2455     }
2456   return 0;
2457
2458 }
2459
2460
2461 static gpg_error_t
2462 gpg_keylist_build_options (engine_gpg_t gpg, int secret_only,
2463                            gpgme_keylist_mode_t mode)
2464 {
2465   gpg_error_t err;
2466
2467   err = add_arg (gpg, "--with-colons");
2468
2469   /* Since gpg 2.1.15 fingerprints are always printed, thus there is
2470    * no more need to explictly request them.  */
2471   if (!have_gpg_version (gpg, "2.1.15"))
2472     {
2473       if (!err)
2474         err = add_arg (gpg, "--fixed-list-mode");
2475       if (!err)
2476         err = add_arg (gpg, "--with-fingerprint");
2477       if (!err)
2478         err = add_arg (gpg, "--with-fingerprint");
2479     }
2480
2481   if (!err && (mode & GPGME_KEYLIST_MODE_WITH_TOFU)
2482       && have_gpg_version (gpg, "2.1.16"))
2483     err = add_arg (gpg, "--with-tofu-info");
2484
2485   if (!err && (mode & GPGME_KEYLIST_MODE_WITH_SECRET))
2486     err = add_arg (gpg, "--with-secret");
2487
2488   if (!err
2489       && (mode & GPGME_KEYLIST_MODE_SIGS)
2490       && (mode & GPGME_KEYLIST_MODE_SIG_NOTATIONS))
2491     {
2492       err = add_arg (gpg, "--list-options");
2493       if (!err)
2494         err = add_arg (gpg, "show-sig-subpackets=\"20,26\"");
2495     }
2496
2497   if (!err)
2498     {
2499       if ( (mode & GPGME_KEYLIST_MODE_EXTERN) )
2500         {
2501           if (secret_only)
2502             err = gpg_error (GPG_ERR_NOT_SUPPORTED);
2503           else if ( (mode & GPGME_KEYLIST_MODE_LOCAL))
2504             {
2505               /* The local+extern mode is special.  It works only with
2506                  gpg >= 2.0.10.  FIXME: We should check that we have
2507                  such a version to that we can return a proper error
2508                  code.  The problem is that we don't know the context
2509                  here and thus can't access the cached version number
2510                  for the engine info structure.  */
2511               err = add_arg (gpg, "--locate-keys");
2512               if ((mode & GPGME_KEYLIST_MODE_SIGS))
2513                 err = add_arg (gpg, "--with-sig-check");
2514             }
2515           else
2516             {
2517               err = add_arg (gpg, "--search-keys");
2518               gpg->colon.preprocess_fnc = gpg_keylist_preprocess;
2519             }
2520         }
2521       else
2522         {
2523           err = add_arg (gpg, secret_only ? "--list-secret-keys"
2524                          : ((mode & GPGME_KEYLIST_MODE_SIGS)
2525                             ? "--check-sigs" : "--list-keys"));
2526         }
2527     }
2528
2529   if (!err)
2530     err = add_arg (gpg, "--");
2531
2532   return err;
2533 }
2534
2535
2536 static gpgme_error_t
2537 gpg_keylist (void *engine, const char *pattern, int secret_only,
2538              gpgme_keylist_mode_t mode, int engine_flags)
2539 {
2540   engine_gpg_t gpg = engine;
2541   gpgme_error_t err;
2542
2543   err = gpg_keylist_build_options (gpg, secret_only, mode);
2544
2545   if (!err && pattern && *pattern)
2546     err = add_arg (gpg, pattern);
2547
2548   if (!err)
2549     err = start (gpg);
2550
2551   return err;
2552 }
2553
2554
2555 static gpgme_error_t
2556 gpg_keylist_ext (void *engine, const char *pattern[], int secret_only,
2557                  int reserved, gpgme_keylist_mode_t mode, int engine_flags)
2558 {
2559   engine_gpg_t gpg = engine;
2560   gpgme_error_t err;
2561
2562   if (reserved)
2563     return gpg_error (GPG_ERR_INV_VALUE);
2564
2565   err = gpg_keylist_build_options (gpg, secret_only, mode);
2566
2567   if (pattern)
2568     {
2569       while (!err && *pattern && **pattern)
2570         err = add_arg (gpg, *(pattern++));
2571     }
2572
2573   if (!err)
2574     err = start (gpg);
2575
2576   return err;
2577 }
2578
2579
2580 static gpgme_error_t
2581 gpg_sign (void *engine, gpgme_data_t in, gpgme_data_t out,
2582           gpgme_sig_mode_t mode, int use_armor, int use_textmode,
2583           int include_certs, gpgme_ctx_t ctx /* FIXME */)
2584 {
2585   engine_gpg_t gpg = engine;
2586   gpgme_error_t err;
2587
2588   if (mode == GPGME_SIG_MODE_CLEAR)
2589     err = add_arg (gpg, "--clearsign");
2590   else
2591     {
2592       err = add_arg (gpg, "--sign");
2593       if (!err && mode == GPGME_SIG_MODE_DETACH)
2594         err = add_arg (gpg, "--detach");
2595       if (!err && use_armor)
2596         err = add_arg (gpg, "--armor");
2597       if (!err)
2598         {
2599           if (gpgme_data_get_encoding (in) == GPGME_DATA_ENCODING_MIME
2600               && have_gpg_version (gpg, "2.1.14"))
2601             err = add_arg (gpg, "--mimemode");
2602           else if (use_textmode)
2603             err = add_arg (gpg, "--textmode");
2604         }
2605     }
2606
2607   if (!err)
2608     err = append_args_from_signers (gpg, ctx);
2609   if (!err)
2610     err = append_args_from_sig_notations (gpg, ctx);
2611
2612   if (gpgme_data_get_file_name (in))
2613     {
2614       if (!err)
2615         err = add_arg (gpg, "--set-filename");
2616       if (!err)
2617         err = add_arg (gpg, gpgme_data_get_file_name (in));
2618     }
2619
2620   /* Tell the gpg object about the data.  */
2621   if (!err)
2622     err = add_input_size_hint (gpg, in);
2623   if (!err)
2624     err = add_arg (gpg, "--");
2625   if (!err)
2626     err = add_data (gpg, in, -1, 0);
2627   if (!err)
2628     err = add_data (gpg, out, 1, 1);
2629
2630   if (!err)
2631     err = start (gpg);
2632
2633   return err;
2634 }
2635
2636 static gpgme_error_t
2637 gpg_trustlist (void *engine, const char *pattern)
2638 {
2639   engine_gpg_t gpg = engine;
2640   gpgme_error_t err;
2641
2642   err = add_arg (gpg, "--with-colons");
2643   if (!err)
2644     err = add_arg (gpg, "--list-trust-path");
2645
2646   /* Tell the gpg object about the data.  */
2647   if (!err)
2648     err = add_arg (gpg, "--");
2649   if (!err)
2650     err = add_arg (gpg, pattern);
2651
2652   if (!err)
2653     err = start (gpg);
2654
2655   return err;
2656 }
2657
2658
2659 static gpgme_error_t
2660 gpg_verify (void *engine, gpgme_data_t sig, gpgme_data_t signed_text,
2661             gpgme_data_t plaintext)
2662 {
2663   engine_gpg_t gpg = engine;
2664   gpgme_error_t err = 0;
2665
2666   if (plaintext)
2667     {
2668       /* Normal or cleartext signature.  */
2669       err = add_arg (gpg, "--output");
2670       if (!err)
2671         err = add_arg (gpg, "-");
2672       if (!err)
2673         err = add_input_size_hint (gpg, sig);
2674       if (!err)
2675         err = add_arg (gpg, "--");
2676       if (!err)
2677         err = add_data (gpg, sig, -1, 0);
2678       if (!err)
2679         err = add_data (gpg, plaintext, 1, 1);
2680     }
2681   else
2682     {
2683       err = add_arg (gpg, "--verify");
2684       if (!err)
2685         err = add_input_size_hint (gpg, signed_text);
2686       if (!err)
2687         err = add_arg (gpg, "--");
2688       if (!err)
2689         err = add_data (gpg, sig, -1, 0);
2690       if (!err && signed_text)
2691         err = add_data (gpg, signed_text, -1, 0);
2692     }
2693
2694   if (!err)
2695     err = start (gpg);
2696
2697   return err;
2698 }
2699
2700
2701 static void
2702 gpg_set_io_cbs (void *engine, gpgme_io_cbs_t io_cbs)
2703 {
2704   engine_gpg_t gpg = engine;
2705
2706   gpg->io_cbs = *io_cbs;
2707 }
2708
2709
2710 static gpgme_error_t
2711 gpg_set_pinentry_mode (void *engine, gpgme_pinentry_mode_t mode)
2712 {
2713   engine_gpg_t gpg = engine;
2714
2715   gpg->pinentry_mode = mode;
2716   return 0;
2717 }
2718
2719
2720 \f
2721 struct engine_ops _gpgme_engine_ops_gpg =
2722   {
2723     /* Static functions.  */
2724     _gpgme_get_default_gpg_name,
2725     NULL,
2726     gpg_get_version,
2727     gpg_get_req_version,
2728     gpg_new,
2729
2730     /* Member functions.  */
2731     gpg_release,
2732     NULL,                               /* reset */
2733     gpg_set_status_cb,
2734     gpg_set_status_handler,
2735     gpg_set_command_handler,
2736     gpg_set_colon_line_handler,
2737     gpg_set_locale,
2738     NULL,                               /* set_protocol */
2739     gpg_decrypt,
2740     gpg_decrypt,                        /* decrypt_verify */
2741     gpg_delete,
2742     gpg_edit,
2743     gpg_encrypt,
2744     gpg_encrypt_sign,
2745     gpg_export,
2746     gpg_export_ext,
2747     gpg_genkey,
2748     gpg_import,
2749     gpg_keylist,
2750     gpg_keylist_ext,
2751     gpg_sign,
2752     gpg_trustlist,
2753     gpg_verify,
2754     NULL,               /* getauditlog */
2755     NULL,               /* opassuan_transact */
2756     NULL,               /* conf_load */
2757     NULL,               /* conf_save */
2758     gpg_set_io_cbs,
2759     gpg_io_event,
2760     gpg_cancel,
2761     NULL,               /* cancel_op */
2762     gpg_passwd,
2763     gpg_set_pinentry_mode,
2764     NULL                /* opspawn */
2765   };