2002-02-08 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / engine.c
1 /* engine.c 
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *      Copyright (C) 2001 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GPGME is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 #include <time.h>
26 #include <sys/types.h>
27 #include <string.h>
28 #include <assert.h>
29
30 #include "gpgme.h"
31 #include "util.h"
32 #include "sema.h"
33 #include "io.h"
34
35 #include "engine.h"
36 #include "rungpg.h"
37 #include "engine-gpgsm.h"
38
39 struct engine_object_s
40   {
41     GpgmeProtocol protocol;
42
43     const char *path;
44     const char *version;
45
46     union
47       {
48         GpgObject gpg;
49         GpgsmObject gpgsm;
50       } engine;
51 };
52
53 struct reap_s
54 {
55   struct reap_s *next;
56   int pid;
57   time_t entered;
58   int term_send;
59 };
60
61 static struct reap_s *reap_list;
62 DEFINE_STATIC_LOCK (reap_list_lock);
63
64 /* Get the path of the engine for PROTOCOL.  */
65 const char *
66 _gpgme_engine_get_path (GpgmeProtocol proto)
67 {
68   switch (proto)
69     {
70     case GPGME_PROTOCOL_OpenPGP:
71       return _gpgme_get_gpg_path ();
72     case GPGME_PROTOCOL_CMS:
73       return _gpgme_get_gpgsm_path ();
74     default:
75       return NULL;
76     }
77 }
78
79 /* Get the version number of the engine for PROTOCOL.  */
80 const char *
81 _gpgme_engine_get_version (GpgmeProtocol proto)
82 {
83   switch (proto)
84     {
85     case GPGME_PROTOCOL_OpenPGP:
86       return _gpgme_gpg_get_version ();
87     case GPGME_PROTOCOL_CMS:
88       return _gpgme_gpgsm_get_version ();
89     default:
90       return NULL;
91     }
92 }
93
94 GpgmeError
95 gpgme_engine_check_version (GpgmeProtocol proto)
96 {
97   switch (proto)
98     {
99     case GPGME_PROTOCOL_OpenPGP:
100       return _gpgme_gpg_check_version ();
101     case GPGME_PROTOCOL_CMS:
102       return _gpgme_gpgsm_check_version ();
103     default:
104       return mk_error (Invalid_Value);
105     }
106 }
107
108 const char *
109 _gpgme_engine_get_info (GpgmeProtocol proto)
110 {
111   static const char fmt[] = " <engine>\n"
112     "  <protocol>%s</protocol>\n"
113     "  <version>%s</version>\n"
114     "  <path>%s</path>\n"
115     " </engine>\n";
116   static const char *const strproto[3] = { "OpenPGP", "CMS", NULL };
117   static const char *engine_info[3];  /* FIXME: MAX_PROTO + 1*/
118   const char *path;
119   const char *version;
120   char *info;
121
122   if (proto > 2 /* FIXME MAX_PROTO */ || !strproto[proto])
123     return NULL;
124
125   /* FIXME: Make sure that only one instance does run.  */
126   if (engine_info[proto])
127     return engine_info[proto];
128
129   path = _gpgme_engine_get_path (proto);
130   version = _gpgme_engine_get_version (proto);
131
132   if (!path || !version)
133     return NULL;
134
135   info = xtrymalloc (strlen(fmt) + strlen(strproto[proto]) + strlen(path)
136                      + strlen (version) + 1);
137   if (!info)
138     info = " <engine>\n"
139       "  <error>Out of core</error>\n"
140       " </engine>";
141   else
142     sprintf (info, fmt, strproto[proto], version, path);
143   engine_info[proto] = info;
144
145   return engine_info[proto];
146 }
147
148 GpgmeError
149 _gpgme_engine_new (GpgmeProtocol proto, EngineObject *r_engine)
150 {
151   EngineObject engine;
152   GpgmeError err = 0;
153
154   engine = xtrycalloc (1, sizeof *engine);
155   if (!engine)
156     {
157       err = mk_error (Out_Of_Core);
158       goto leave;
159     }
160
161   engine->protocol = proto;
162   switch (proto)
163     {
164     case GPGME_PROTOCOL_OpenPGP:
165       err =_gpgme_gpg_new (&engine->engine.gpg);
166       break;
167     case GPGME_PROTOCOL_CMS:
168       err = _gpgme_gpgsm_new (&engine->engine.gpgsm);
169       if (err)
170         goto leave;
171       break;
172     default:
173       err = mk_error (Invalid_Value);
174     }
175   if (err)
176     goto leave;
177
178   engine->path = _gpgme_engine_get_path (proto);
179   engine->version = _gpgme_engine_get_version (proto);
180
181   if (!engine->path || !engine->version)
182     {
183       err = mk_error (Invalid_Engine);
184       goto leave;
185     }
186
187  leave:
188   if (err)
189     _gpgme_engine_release (engine);
190   else
191     *r_engine = engine;
192   
193   return err;
194 }
195
196 void
197 _gpgme_engine_release (EngineObject engine)
198 {
199   if (!engine)
200     return;
201
202   switch (engine->protocol)
203     {
204     case GPGME_PROTOCOL_OpenPGP:
205       _gpgme_gpg_release (engine->engine.gpg);
206       break;
207     case GPGME_PROTOCOL_CMS:
208       _gpgme_gpgsm_release (engine->engine.gpgsm);
209       break;
210     default:
211       break;
212     }
213   xfree (engine);
214 }
215
216
217 void
218 _gpgme_engine_set_verbosity (EngineObject engine, int verbosity)
219 {
220   if (!engine)
221     return;
222
223   switch (engine->protocol)
224     {
225     case GPGME_PROTOCOL_OpenPGP:
226       while (verbosity-- > 0)
227         _gpgme_gpg_add_arg (engine->engine.gpg, "--verbose");
228       break;
229     case GPGME_PROTOCOL_CMS:
230       /* FIXME */
231       break;
232     default:
233       break;
234     }
235 }
236
237 void
238 _gpgme_engine_set_status_handler (EngineObject engine,
239                                   GpgStatusHandler fnc, void *fnc_value)
240 {
241   if (!engine)
242     return;
243
244   switch (engine->protocol)
245     {
246     case GPGME_PROTOCOL_OpenPGP:
247       _gpgme_gpg_set_status_handler (engine->engine.gpg, fnc, fnc_value);
248       break;
249     case GPGME_PROTOCOL_CMS:
250       _gpgme_gpgsm_set_status_handler (engine->engine.gpgsm, fnc, fnc_value);
251       break;
252     default:
253       break;
254     }
255 }
256
257 GpgmeError
258 _gpgme_engine_set_command_handler (EngineObject engine,
259                                   GpgCommandHandler fnc, void *fnc_value)
260 {
261   if (!engine)
262     return mk_error (Invalid_Value);
263
264   switch (engine->protocol)
265     {
266     case GPGME_PROTOCOL_OpenPGP:
267       return _gpgme_gpg_set_command_handler (engine->engine.gpg, fnc, fnc_value);
268     case GPGME_PROTOCOL_CMS:
269       /* FIXME */
270       break;
271     default:
272       break;
273     }
274   return 0;
275 }
276
277 GpgmeError _gpgme_engine_set_colon_line_handler (EngineObject engine,
278                                                  GpgColonLineHandler fnc,
279                                                  void *fnc_value)
280 {
281   if (!engine)
282     return mk_error (Invalid_Value);
283
284   switch (engine->protocol)
285     {
286     case GPGME_PROTOCOL_OpenPGP:
287       return _gpgme_gpg_set_colon_line_handler (engine->engine.gpg, 
288                                                 fnc, fnc_value);
289     case GPGME_PROTOCOL_CMS:
290       _gpgme_gpgsm_set_colon_line_handler (engine->engine.gpgsm,
291                                            fnc, fnc_value);
292       break;
293
294     default:
295       break;
296     }
297   return 0;
298 }
299
300 GpgmeError
301 _gpgme_engine_op_decrypt (EngineObject engine, GpgmeData ciph, GpgmeData plain)
302 {
303   if (!engine)
304     return mk_error (Invalid_Value);
305
306   switch (engine->protocol)
307     {
308     case GPGME_PROTOCOL_OpenPGP:
309       return _gpgme_gpg_op_decrypt (engine->engine.gpg, ciph, plain);
310     case GPGME_PROTOCOL_CMS:
311       return _gpgme_gpgsm_op_decrypt (engine->engine.gpgsm, ciph, plain);
312     default:
313       break;
314     }
315   return 0;
316 }
317
318 GpgmeError
319 _gpgme_engine_op_delete (EngineObject engine, GpgmeKey key, int allow_secret)
320 {
321   if (!engine)
322     return mk_error (Invalid_Value);
323
324   switch (engine->protocol)
325     {
326     case GPGME_PROTOCOL_OpenPGP:
327       return _gpgme_gpg_op_delete (engine->engine.gpg, key, allow_secret);
328     case GPGME_PROTOCOL_CMS:
329       return _gpgme_gpgsm_op_delete (engine->engine.gpgsm, key, allow_secret);
330     default:
331       break;
332     }
333   return 0;
334 }
335
336 GpgmeError
337 _gpgme_engine_op_encrypt (EngineObject engine, GpgmeRecipients recp,
338                           GpgmeData plain, GpgmeData ciph, int use_armor)
339 {
340   if (!engine)
341     return mk_error (Invalid_Value);
342
343   switch (engine->protocol)
344     {
345     case GPGME_PROTOCOL_OpenPGP:
346       return _gpgme_gpg_op_encrypt (engine->engine.gpg, recp, plain, ciph,
347                                     use_armor);
348     case GPGME_PROTOCOL_CMS:
349       return _gpgme_gpgsm_op_encrypt (engine->engine.gpgsm, recp, plain, ciph,
350                                       use_armor);
351     default:
352       break;
353     }
354   return 0;
355 }
356
357 GpgmeError
358 _gpgme_engine_op_export (EngineObject engine, GpgmeRecipients recp,
359                          GpgmeData keydata, int use_armor)
360 {
361   if (!engine)
362     return mk_error (Invalid_Value);
363
364   switch (engine->protocol)
365     {
366     case GPGME_PROTOCOL_OpenPGP:
367       return _gpgme_gpg_op_export (engine->engine.gpg, recp, keydata,
368                                    use_armor);
369     case GPGME_PROTOCOL_CMS:
370       return _gpgme_gpgsm_op_export (engine->engine.gpgsm, recp, keydata,
371                                      use_armor);
372     default:
373       break;
374     }
375   return 0;
376 }
377
378 GpgmeError
379 _gpgme_engine_op_genkey (EngineObject engine, GpgmeData help_data,
380                          int use_armor, GpgmeData pubkey, GpgmeData seckey)
381 {
382   if (!engine)
383     return mk_error (Invalid_Value);
384
385   switch (engine->protocol)
386     {
387     case GPGME_PROTOCOL_OpenPGP:
388       return _gpgme_gpg_op_genkey (engine->engine.gpg, help_data, use_armor,
389                                    pubkey, seckey);
390     case GPGME_PROTOCOL_CMS:
391       return _gpgme_gpgsm_op_genkey (engine->engine.gpgsm, help_data, use_armor,
392                                      pubkey, seckey);
393     default:
394       break;
395     }
396   return 0;
397 }
398
399 GpgmeError
400 _gpgme_engine_op_import (EngineObject engine, GpgmeData keydata)
401 {
402   if (!engine)
403     return mk_error (Invalid_Value);
404
405   switch (engine->protocol)
406     {
407     case GPGME_PROTOCOL_OpenPGP:
408       return _gpgme_gpg_op_import (engine->engine.gpg, keydata);
409     case GPGME_PROTOCOL_CMS:
410       return _gpgme_gpgsm_op_import (engine->engine.gpgsm, keydata);
411     default:
412       break;
413     }
414   return 0;
415 }
416
417 GpgmeError
418 _gpgme_engine_op_keylist (EngineObject engine, const char *pattern, int secret_only,
419                           int keylist_mode)
420 {
421   if (!engine)
422     return mk_error (Invalid_Value);
423
424   switch (engine->protocol)
425     {
426     case GPGME_PROTOCOL_OpenPGP:
427       return _gpgme_gpg_op_keylist (engine->engine.gpg, pattern, secret_only,
428                                     keylist_mode);
429     case GPGME_PROTOCOL_CMS:
430       return _gpgme_gpgsm_op_keylist (engine->engine.gpgsm, pattern, secret_only,
431                                       keylist_mode);
432     default:
433       break;
434     }
435   return 0;
436 }
437
438 GpgmeError
439 _gpgme_engine_op_sign (EngineObject engine, GpgmeData in, GpgmeData out,
440                     GpgmeSigMode mode, int use_armor,
441                     int use_textmode, GpgmeCtx ctx /* FIXME */)
442 {
443   if (!engine)
444     return mk_error (Invalid_Value);
445
446   switch (engine->protocol)
447     {
448     case GPGME_PROTOCOL_OpenPGP:
449       return _gpgme_gpg_op_sign (engine->engine.gpg, in, out, mode, use_armor,
450                                  use_textmode, ctx);
451     case GPGME_PROTOCOL_CMS:
452       return _gpgme_gpgsm_op_sign (engine->engine.gpgsm, in, out, mode,
453                                    use_armor, use_textmode, ctx);
454       break;
455     default:
456       break;
457     }
458   return 0;
459 }
460
461 GpgmeError
462 _gpgme_engine_op_trustlist (EngineObject engine, const char *pattern)
463 {
464   if (!engine)
465     return mk_error (Invalid_Value);
466
467   switch (engine->protocol)
468     {
469     case GPGME_PROTOCOL_OpenPGP:
470       return _gpgme_gpg_op_trustlist (engine->engine.gpg, pattern);
471     case GPGME_PROTOCOL_CMS:
472       return _gpgme_gpgsm_op_trustlist (engine->engine.gpgsm, pattern);
473     default:
474       break;
475     }
476   return 0;
477 }
478
479 GpgmeError
480 _gpgme_engine_op_verify (EngineObject engine, GpgmeData sig, GpgmeData text)
481 {
482   if (!engine)
483     return mk_error (Invalid_Value);
484
485   switch (engine->protocol)
486     {
487     case GPGME_PROTOCOL_OpenPGP:
488       return _gpgme_gpg_op_verify (engine->engine.gpg, sig, text);
489     case GPGME_PROTOCOL_CMS:
490       return _gpgme_gpgsm_op_verify (engine->engine.gpgsm, sig, text);
491     default:
492       break;
493     }
494   return 0;
495 }
496
497 GpgmeError
498 _gpgme_engine_start (EngineObject engine, void *opaque)
499 {
500   if (!engine)
501     return mk_error (Invalid_Value);
502
503   switch (engine->protocol)
504     {
505     case GPGME_PROTOCOL_OpenPGP:
506       return _gpgme_gpg_spawn (engine->engine.gpg, opaque);
507     case GPGME_PROTOCOL_CMS:
508       return _gpgme_gpgsm_start (engine->engine.gpgsm, opaque);
509     default:
510       break;
511     }
512   return 0;
513 }
514
515 void
516 _gpgme_engine_add_child_to_reap_list (void *buf, int buflen, pid_t pid)
517 {
518   /* Reuse the memory, so that we don't need to allocate another
519      memory block and to handle errors.  */
520   struct reap_s *child = buf;
521
522   assert (buflen >= sizeof *child);
523   memset (child, 0, sizeof *child);
524   child->pid = pid;
525   child->entered = time (NULL);
526   LOCK(reap_list_lock);
527   child->next = reap_list;
528   reap_list = child;
529   UNLOCK(reap_list_lock);
530 }
531
532 static void
533 do_reaping (void)
534 {
535   struct reap_s *r, *rlast;
536   static time_t last_check;
537   time_t cur_time = time (NULL);
538
539   /* A race does not matter here.  */
540   if (!last_check)
541     last_check = time (NULL);
542
543   if (last_check >= cur_time)
544     return;  /* We check only every second.  */
545
546   /* Fixme: it would be nice if to have a TRYLOCK here.  */
547   LOCK (reap_list_lock);
548   for (r = reap_list, rlast = NULL; r; rlast = r, r = r ? r->next : NULL)
549     {
550       int dummy1, dummy2;
551
552       if (_gpgme_io_waitpid (r->pid, 0, &dummy1, &dummy2))
553         {
554           /* The process has terminated - remove it from the queue.  */
555           void *p = r;
556           if (!rlast)
557             {
558               reap_list = r->next;
559               r = reap_list;
560             }
561           else
562             {
563               rlast->next = r->next;
564               r = rlast;
565             }
566           xfree (p);
567         }
568       else if (!r->term_send)
569         {
570           if (r->entered + 1 >= cur_time)
571             {
572               _gpgme_io_kill (r->pid, 0);
573               r->term_send = 1;
574               r->entered = cur_time;
575             }
576         }
577       else
578         {
579           /* Give it 5 second before we are going to send the killer.  */
580           if (r->entered + 5 >= cur_time)
581             {
582               _gpgme_io_kill (r->pid, 1);
583               r->entered = cur_time; /* Just in case we have to repeat it.  */
584             }
585         }
586     }
587   UNLOCK (reap_list_lock);  
588 }
589
590 void
591 _gpgme_engine_housecleaning (void)
592 {
593   do_reaping ();
594 }