[g13] Add RECIPEINT and CREATE command.
[gnupg.git] / g13 / g13.c
1 /* g13.c - Disk Key management with GnuPG
2  * Copyright (C) 2009 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <ctype.h>
26 #include <unistd.h>
27 #include <fcntl.h>
28 #include <pth.h>
29
30 #include "g13.h"
31
32 #include <gcrypt.h>
33 #include <assuan.h>
34
35 #include "i18n.h"
36 #include "sysutils.h"
37 #include "gc-opt-flags.h"
38 #include "keyblob.h"
39 #include "server.h"
40 #include "runner.h"
41 #include "create.h"
42 #include "mount.h"
43 #include "mountinfo.h"
44
45
46 enum cmd_and_opt_values {
47   aNull = 0,
48   oQuiet        = 'q',
49   oVerbose      = 'v',
50   oRecipient    = 'r',
51
52   aGPGConfList  = 500,
53   aGPGConfTest,
54   aCreate,
55   aMount,
56   aUmount,
57   aServer,
58
59   oOptions,
60   oDebug,
61   oDebugLevel,
62   oDebugAll,
63   oDebugNone,
64   oDebugWait,
65   oDebugAllowCoreDump,
66   oLogFile,
67   oNoLogFile,
68   oAuditLog,
69
70   oOutput,
71
72   oAgentProgram,
73   oGpgProgram,
74
75   oDisplay,
76   oTTYname,
77   oTTYtype,
78   oLCctype,
79   oLCmessages,
80   oXauthority,
81
82   oStatusFD,
83   oLoggerFD,
84
85   oNoVerbose,
86   oNoSecmemWarn,
87   oNoGreeting,
88   oNoTTY,
89   oNoOptions,
90   oHomedir,
91   oWithColons,
92   oDryRun,
93   oNoDetach,
94
95   oNoRandomSeedFile,
96   oFakedSystemTime
97  };
98
99
100 static ARGPARSE_OPTS opts[] = {
101
102   ARGPARSE_group (300, N_("@Commands:\n ")),
103
104   ARGPARSE_c (aCreate, "create", N_("Create a new file system container")),
105   ARGPARSE_c (aMount,  "mount",  N_("Mount a file system container") ),
106   ARGPARSE_c (aUmount, "umount", N_("Unmount a file system container") ),
107   ARGPARSE_c (aServer, "server", N_("Run in server mode")),
108
109   ARGPARSE_c (aGPGConfList, "gpgconf-list", "@"),
110   ARGPARSE_c (aGPGConfTest, "gpgconf-test", "@"),
111
112   ARGPARSE_group (301, N_("@\nOptions:\n ")),
113
114   ARGPARSE_s_s (oRecipient, "recipient", N_("|USER-ID|encrypt for USER-ID")),
115
116   ARGPARSE_s_s (oOutput, "output", N_("|FILE|write output to FILE")),
117   ARGPARSE_s_n (oVerbose, "verbose", N_("verbose")),
118   ARGPARSE_s_n (oQuiet, "quiet",  N_("be somewhat more quiet")),
119   ARGPARSE_s_n (oNoTTY, "no-tty", N_("don't use the terminal at all")),
120   ARGPARSE_s_n (oNoDetach, "no-detach", N_("do not detach from the console")),
121   ARGPARSE_s_s (oLogFile, "log-file",  N_("|FILE|write log output to FILE")),
122   ARGPARSE_s_n (oNoLogFile, "no-log-file", "@"),
123   ARGPARSE_s_i (oLoggerFD, "logger-fd", "@"),
124
125   ARGPARSE_s_n (oDryRun, "dry-run", N_("do not make any changes")),
126
127   ARGPARSE_s_s (oOptions, "options", N_("|FILE|read options from FILE")),
128
129   ARGPARSE_p_u (oDebug, "debug", "@"),
130   ARGPARSE_s_s (oDebugLevel, "debug-level",
131                 N_("|LEVEL|set the debugging level to LEVEL")),
132   ARGPARSE_s_n (oDebugAll, "debug-all", "@"),
133   ARGPARSE_s_n (oDebugNone, "debug-none", "@"),
134   ARGPARSE_s_i (oDebugWait, "debug-wait", "@"),
135   ARGPARSE_s_n (oDebugAllowCoreDump, "debug-allow-core-dump", "@"),
136
137   ARGPARSE_s_i (oStatusFD, "status-fd",
138                 N_("|FD|write status info to this FD")),
139
140   ARGPARSE_group (302, N_(
141   "@\n(See the man page for a complete listing of all commands and options)\n"
142   )),
143
144   ARGPARSE_group (303, N_("@\nExamples:\n\n"
145     " blurb\n"
146                           " blurb\n")),
147
148   /* Hidden options. */
149   ARGPARSE_s_n (oNoVerbose, "no-verbose", "@"),
150   ARGPARSE_s_n (oNoSecmemWarn, "no-secmem-warning", "@"), 
151   ARGPARSE_s_n (oNoGreeting, "no-greeting", "@"),
152   ARGPARSE_s_n (oNoOptions, "no-options", "@"),
153   ARGPARSE_s_s (oHomedir, "homedir", "@"),   
154   ARGPARSE_s_s (oAgentProgram, "agent-program", "@"),
155   ARGPARSE_s_s (oGpgProgram, "gpg-program", "@"),
156   ARGPARSE_s_s (oDisplay,    "display", "@"),
157   ARGPARSE_s_s (oTTYname,    "ttyname", "@"),
158   ARGPARSE_s_s (oTTYtype,    "ttytype", "@"),
159   ARGPARSE_s_s (oLCctype,    "lc-ctype", "@"),
160   ARGPARSE_s_s (oLCmessages, "lc-messages", "@"),
161   ARGPARSE_s_s (oXauthority, "xauthority", "@"),
162   ARGPARSE_s_s (oFakedSystemTime, "faked-system-time", "@"),
163   ARGPARSE_s_n (oWithColons, "with-colons", "@"),
164   ARGPARSE_s_n (oNoRandomSeedFile,  "no-random-seed-file", "@"),
165
166   /* Command aliases.  */
167
168   ARGPARSE_end ()
169 };
170
171
172 /* The timer tick interval used by the idle task.  */
173 #define TIMERTICK_INTERVAL_SEC     (1)
174
175
176 /* Global variable to keep an error count. */
177 int g13_errors_seen = 0;
178
179 /* It is possible that we are currently running under setuid permissions.  */
180 static int maybe_setuid = 1;
181
182 /* Helper to implement --debug-level and --debug.  */
183 static const char *debug_level;
184 static unsigned int debug_value;
185
186 /* Flag to indicate that a shutdown was requested.  */
187 static int shutdown_pending;
188
189 /* The thread id of the idle task.  */
190 static pth_t idle_task_tid;
191
192
193 \f
194 static void set_cmd (enum cmd_and_opt_values *ret_cmd,
195                      enum cmd_and_opt_values new_cmd );
196
197 static void emergency_cleanup (void);
198 static void start_idle_task (void);
199 static void join_idle_task (void);
200
201
202 \f
203 /* Begin Pth wrapper functions. */
204 ASSUAN_SYSTEM_PTH_IMPL;
205
206 GCRY_THREAD_OPTION_PTH_IMPL;
207 static int fixed_gcry_pth_init (void)
208 {
209   return pth_self ()? 0 : (pth_init () == FALSE) ? errno : 0;
210 }
211 /* End Pth wrapper functions. */
212
213
214 static const char *
215 my_strusage( int level )
216 {
217   const char *p;
218
219   switch (level)
220     {
221     case 11: p = "g13 (GnuPG)";
222       break;
223     case 13: p = VERSION; break;
224     case 17: p = PRINTABLE_OS_NAME; break;
225     case 19: p = _("Please report bugs to <" PACKAGE_BUGREPORT ">.\n");
226       break;
227     case 1:
228     case 40: p = _("Usage: g13 [options] [files] (-h for help)");
229       break;
230     case 41:
231       p = _("Syntax: g13 [options] [files]\n"
232             "Create, mount or unmount an encrypted file system container\n");
233       break;
234
235     case 31: p = "\nHome: "; break;
236     case 32: p = opt.homedir; break;
237      
238     default: p = NULL; break;
239     }
240   return p;
241 }
242
243
244 static void
245 wrong_args (const char *text)
246 {
247   fputs (_("usage: g13 [options] "), stderr);
248   fputs (text, stderr);
249   putc ('\n', stderr);
250   g13_exit (2);
251 }
252
253
254 /* Setup the debugging.  With a DEBUG_LEVEL of NULL only the active
255    debug flags are propagated to the subsystems.  With DEBUG_LEVEL
256    set, a specific set of debug flags is set; and individual debugging
257    flags will be added on top.  */
258 static void
259 set_debug (void)
260 {
261   if (!debug_level)
262     ;
263   else if (!strcmp (debug_level, "none"))
264     opt.debug = 0;
265   else if (!strcmp (debug_level, "basic"))
266     opt.debug = DBG_ASSUAN_VALUE|DBG_MOUNT_VALUE;
267   else if (!strcmp (debug_level, "advanced"))
268     opt.debug = DBG_ASSUAN_VALUE|DBG_MOUNT_VALUE;
269   else if (!strcmp (debug_level, "expert"))
270     opt.debug = (DBG_ASSUAN_VALUE|DBG_MOUNT_VALUE|DBG_CRYPTO_VALUE);
271   else if (!strcmp (debug_level, "guru"))
272     opt.debug = ~0;
273   else
274     {
275       log_error (_("invalid debug-level `%s' given\n"), debug_level);
276       g13_exit(2);
277     }
278
279   opt.debug |= debug_value;
280
281   if (opt.debug && !opt.verbose)
282     opt.verbose = 1;
283   if (opt.debug)
284     opt.quiet = 0;
285
286   if (opt.debug & DBG_CRYPTO_VALUE )
287     gcry_control (GCRYCTL_SET_DEBUG_FLAGS, 1);
288   gcry_control (GCRYCTL_SET_VERBOSITY, (int)opt.verbose);
289 }
290  
291
292
293 static void
294 set_cmd (enum cmd_and_opt_values *ret_cmd, enum cmd_and_opt_values new_cmd)
295 {
296   enum cmd_and_opt_values cmd = *ret_cmd;
297
298   if (!cmd || cmd == new_cmd)
299     cmd = new_cmd;
300   else 
301     {
302       log_error (_("conflicting commands\n"));
303       g13_exit (2);
304     }
305
306   *ret_cmd = cmd;
307 }
308
309
310 int
311 main ( int argc, char **argv)
312 {
313   ARGPARSE_ARGS pargs;
314   int orig_argc;
315   char **orig_argv;
316   gpg_error_t err;
317   const char *fname;
318   int may_coredump;
319   FILE *configfp = NULL;
320   char *configname = NULL;
321   unsigned configlineno;
322   int parse_debug = 0;
323   int no_more_options = 0;
324   int default_config =1;
325   char *logfile = NULL;
326   int greeting = 0;
327   int nogreeting = 0;
328   int debug_wait = 0;
329   int use_random_seed = 1;
330   int nodetach = 0;
331   int nokeysetup = 0;
332   enum cmd_and_opt_values cmd = 0;
333   struct server_control_s ctrl;
334   strlist_t recipients = NULL;
335
336   /*mtrace();*/
337
338   gnupg_reopen_std ("g13");
339   set_strusage (my_strusage);
340   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
341
342   log_set_prefix ("g13", 1);
343
344   /* Make sure that our subsystems are ready.  */
345   i18n_init ();
346   init_common_subsystems ();
347
348   /* Libgcrypt requires us to register the threading model first.
349      Note that this will also do the pth_init. */
350   gcry_threads_pth.init = fixed_gcry_pth_init;
351   err = gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pth);
352   if (err)
353     {
354       log_fatal ("can't register GNU Pth with Libgcrypt: %s\n",
355                  gpg_strerror (err));
356     }
357
358   /* Check that the Libgcrypt is suitable.  */
359   if (!gcry_check_version (NEED_LIBGCRYPT_VERSION) )
360     log_fatal (_("%s is too old (need %s, have %s)\n"), "libgcrypt", 
361                NEED_LIBGCRYPT_VERSION, gcry_check_version (NULL) );
362
363   /* Take extra care of the random pool.  */
364   gcry_control (GCRYCTL_USE_SECURE_RNDPOOL);
365
366   may_coredump = disable_core_dumps ();
367   
368   gnupg_init_signals (0, emergency_cleanup);
369   
370   create_dotlock (NULL); /* Register locking cleanup.  */
371
372   opt.homedir = default_homedir ();
373
374   /* First check whether we have a config file on the commandline.  */
375   orig_argc = argc;
376   orig_argv = argv;
377   pargs.argc = &argc;
378   pargs.argv = &argv;
379   pargs.flags= 1|(1<<6);  /* Do not remove the args, ignore version.  */
380   while (arg_parse( &pargs, opts))
381     {
382       if (pargs.r_opt == oDebug || pargs.r_opt == oDebugAll)
383         parse_debug++;
384       else if (pargs.r_opt == oOptions)
385         { /* Yes, there is one, so we do not try the default one but
386              read the config file when it is encountered at the
387              commandline.  */
388           default_config = 0;
389         }
390       else if (pargs.r_opt == oNoOptions)
391         default_config = 0; /* --no-options */
392       else if (pargs.r_opt == oHomedir)
393         opt.homedir = pargs.r.ret_str;
394     }
395
396   /* Initialize the secure memory. */
397   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
398   maybe_setuid = 0;
399
400   /* 
401      Now we are now working under our real uid 
402   */
403
404   /* Setup malloc hooks. */
405   {
406     struct assuan_malloc_hooks malloc_hooks;
407
408     malloc_hooks.malloc = gcry_malloc;
409     malloc_hooks.realloc = gcry_realloc;
410     malloc_hooks.free = gcry_free;
411     assuan_set_malloc_hooks (&malloc_hooks);
412   }
413   
414   /* Prepare libassuan.  */
415   assuan_set_assuan_log_prefix (log_get_prefix (NULL));
416   assuan_set_gpg_err_source (GPG_ERR_SOURCE_DEFAULT);
417   assuan_set_system_hooks (ASSUAN_SYSTEM_PTH);
418
419
420   /* Setup a default control structure for command line mode.  */
421   memset (&ctrl, 0, sizeof ctrl);
422   g13_init_default_ctrl (&ctrl);
423
424   /* Set the default option file */
425   if (default_config )
426     configname = make_filename (opt.homedir, "g13.conf", NULL);
427   
428   argc        = orig_argc;
429   argv        = orig_argv;
430   pargs.argc  = &argc;
431   pargs.argv  = &argv;
432   pargs.flags =  1;  /* Do not remove the args.  */
433
434  next_pass:
435   if (configname)
436     {
437       configlineno = 0;
438       configfp = fopen (configname, "r");
439       if (!configfp)
440         {
441           if (default_config)
442             {
443               if (parse_debug)
444                 log_info (_("NOTE: no default option file `%s'\n"), configname);
445             }
446           else 
447             {
448               log_error (_("option file `%s': %s\n"), 
449                          configname, strerror(errno));
450               g13_exit(2);
451             }
452           xfree (configname);
453           configname = NULL;
454         }
455       if (parse_debug && configname)
456         log_info (_("reading options from `%s'\n"), configname);
457       default_config = 0;
458     }
459   
460   while (!no_more_options 
461          && optfile_parse (configfp, configname, &configlineno, &pargs, opts))
462     {
463       switch (pargs.r_opt)
464         {
465         case aGPGConfList: 
466         case aGPGConfTest: 
467           set_cmd (&cmd, pargs.r_opt);
468           nogreeting = 1;
469           nokeysetup = 1;
470           break;
471
472         case aServer:
473         case aMount:
474         case aUmount:
475           nokeysetup = 1;
476         case aCreate:
477           set_cmd (&cmd, pargs.r_opt);
478           break;
479
480         case oOutput: opt.outfile = pargs.r.ret_str; break;
481
482         case oQuiet: opt.quiet = 1; break;
483         case oNoGreeting: nogreeting = 1; break;
484         case oNoTTY:  break;
485
486         case oDryRun: opt.dry_run = 1; break;
487
488         case oVerbose:
489           opt.verbose++;
490           gcry_control (GCRYCTL_SET_VERBOSITY, (int)opt.verbose);
491           break;
492         case oNoVerbose:
493           opt.verbose = 0;
494           gcry_control (GCRYCTL_SET_VERBOSITY, (int)opt.verbose);
495           break;
496
497         case oLogFile: logfile = pargs.r.ret_str; break;
498         case oNoLogFile: logfile = NULL; break;          
499
500         case oNoDetach: nodetach = 1; break;
501
502         case oDebug: debug_value |= pargs.r.ret_ulong; break;
503         case oDebugAll: debug_value = ~0; break;
504         case oDebugNone: debug_value = 0; break;
505         case oDebugLevel: debug_level = pargs.r.ret_str; break;
506         case oDebugWait: debug_wait = pargs.r.ret_int; break;
507         case oDebugAllowCoreDump:
508           may_coredump = enable_core_dumps ();
509           break;
510
511         case oStatusFD: ctrl.status_fd = pargs.r.ret_int; break;
512         case oLoggerFD: log_set_fd (pargs.r.ret_int ); break;
513
514         case oNoOptions: break; /* no-options */
515         case oOptions:
516           /* Config files may not be nested (silently ignore them).  */
517           if (!configfp)
518             {
519               xfree(configname);
520               configname = xstrdup (pargs.r.ret_str);
521               goto next_pass;
522             }
523           break;
524
525         case oHomedir: opt.homedir = pargs.r.ret_str; break;
526
527         case oAgentProgram: opt.agent_program = pargs.r.ret_str;  break;
528         case oGpgProgram: opt.gpg_program = pargs.r.ret_str;  break;
529         case oDisplay: opt.display = xstrdup (pargs.r.ret_str); break;
530         case oTTYname: opt.ttyname = xstrdup (pargs.r.ret_str); break;
531         case oTTYtype: opt.ttytype = xstrdup (pargs.r.ret_str); break;
532         case oLCctype: opt.lc_ctype = xstrdup (pargs.r.ret_str); break;
533         case oLCmessages: opt.lc_messages = xstrdup (pargs.r.ret_str); break;
534         case oXauthority: opt.xauthority = xstrdup (pargs.r.ret_str); break;
535           
536         case oFakedSystemTime:
537           {
538             time_t faked_time = isotime2epoch (pargs.r.ret_str); 
539             if (faked_time == (time_t)(-1))
540               faked_time = (time_t)strtoul (pargs.r.ret_str, NULL, 10);
541             gnupg_set_time (faked_time, 0);
542           }
543           break;
544
545         case oNoSecmemWarn: gcry_control (GCRYCTL_DISABLE_SECMEM_WARN); break;
546
547         case oNoRandomSeedFile: use_random_seed = 0; break;
548
549         case oRecipient: /* Store the encryption key.  */
550           add_to_strlist (&recipients, pargs.r.ret_str);
551           break;
552
553
554         default: 
555           pargs.err = configfp? ARGPARSE_PRINT_WARNING:ARGPARSE_PRINT_ERROR; 
556           break;
557         }
558     }
559
560   if (configfp)
561     {
562       fclose (configfp);
563       configfp = NULL;
564       /* Keep a copy of the config filename. */
565       opt.config_filename = configname;
566       configname = NULL;
567       goto next_pass;
568     }
569   xfree (configname);
570   configname = NULL;
571
572   if (!opt.config_filename)
573     opt.config_filename = make_filename (opt.homedir, "g13.conf", NULL);
574
575   if (log_get_errorcount(0))
576     g13_exit(2);
577
578   /* Now that we have the options parsed we need to update the default
579      control structure.  */
580   g13_init_default_ctrl (&ctrl);
581
582   if (nogreeting)
583     greeting = 0;
584   
585   if (greeting)
586     {
587       fprintf (stderr, "%s %s; %s\n",
588                strusage(11), strusage(13), strusage(14) );
589       fprintf (stderr, "%s\n", strusage(15) );
590     }
591
592   if (may_coredump && !opt.quiet)
593     log_info (_("WARNING: program may create a core file!\n"));
594
595   if (logfile)
596     {
597       log_set_file (logfile);
598       log_set_prefix (NULL, 1|2|4);
599     }
600
601   if (gnupg_faked_time_p ())
602     {
603       gnupg_isotime_t tbuf;
604
605       log_info (_("WARNING: running with faked system time: "));
606       gnupg_get_isotime (tbuf);
607       dump_isotime (tbuf);
608       log_printf ("\n");
609     }
610
611   /* Print any pending secure memory warnings.  */
612   gcry_control (GCRYCTL_RESUME_SECMEM_WARN);
613
614   /* Setup the debug flags for all subsystems.  */
615   set_debug ();
616
617   /* Install a regular exit handler to make real sure that the secure
618      memory gets wiped out.  */
619   if (atexit (emergency_cleanup))
620     {
621       log_error ("atexit failed\n");
622       g13_exit (2);
623     }
624
625   /* Terminate if we found any error until now.  */
626   if (log_get_errorcount(0))
627     g13_exit (2);
628   
629   /* Set the standard GnuPG random seed file.  */
630   if (use_random_seed) 
631     {
632       char *p = make_filename (opt.homedir, "random_seed", NULL);
633       gcry_control (GCRYCTL_SET_RANDOM_SEED_FILE, p);
634       xfree(p);
635     }
636   
637   /* Store given filename into FNAME. */
638   fname = argc? *argv : NULL;
639
640   /* Parse all given encryption keys.  This does a lookup of the keys
641      and stops if any of the given keys was not found. */
642 #if 0 /* Currently not implemented.  */  
643   if (!nokeysetup)
644     {
645       strlist_t sl;
646       int failed = 0;
647       
648       for (sl = recipients; sl; sl = sl->next)
649         if (check_encryption_key ())
650           failed = 1;
651       if (failed)
652         g13_exit (1);
653     }
654 #endif /*0*/ 
655  
656   /* Dispatch command.  */
657   switch (cmd)
658     {
659     case aGPGConfList: 
660       { /* List options and default values in the GPG Conf format.  */
661         char *config_filename_esc = percent_escape (opt.config_filename, NULL);
662
663         printf ("gpgconf-g13.conf:%lu:\"%s\n",
664                 GC_OPT_FLAG_DEFAULT, config_filename_esc);
665         xfree (config_filename_esc);
666
667         printf ("verbose:%lu:\n", GC_OPT_FLAG_NONE);
668         printf ("quiet:%lu:\n", GC_OPT_FLAG_NONE);
669         printf ("debug-level:%lu:\"none:\n", GC_OPT_FLAG_DEFAULT);
670         printf ("log-file:%lu:\n", GC_OPT_FLAG_NONE);
671       }
672       break;
673     case aGPGConfTest:
674       /* This is merely a dummy command to test whether the
675          configuration file is valid.  */
676       break;
677
678     case aServer:
679       {
680         start_idle_task ();
681         err = g13_server (&ctrl);
682         if (err)
683           log_error ("server exited with error: %s <%s>\n",
684                      gpg_strerror (err), gpg_strsource (err));
685         else
686           shutdown_pending++;
687       }
688       break;
689
690     case aCreate: /* Create a new container. */
691       {
692         if (argc != 1) 
693           wrong_args ("--create filename");
694         start_idle_task ();
695         err = g13_create_container (&ctrl, argv[0], recipients);
696         if (err)
697           log_error ("error creating a new container: %s <%s>\n",
698                      gpg_strerror (err), gpg_strsource (err));
699         else
700           shutdown_pending++;
701       }
702       break;
703
704     case aMount: /* Mount a container. */
705       {
706         if (argc != 1 && argc != 2 ) 
707           wrong_args ("--mount filename [mountpoint]");
708         start_idle_task ();
709         err = g13_mount_container (&ctrl, argv[0], argc == 2?argv[1]:NULL);
710         if (err)
711           log_error ("error mounting container `%s': %s <%s>\n",
712                      *argv, gpg_strerror (err), gpg_strsource (err));
713       }
714       break;
715
716     default:
717       log_error (_("invalid command (there is no implicit command)\n"));
718       break;
719     }
720
721   if (!err)
722     join_idle_task ();
723
724   /* Cleanup.  */
725   g13_exit (0);
726   return 8; /*NOTREACHED*/
727 }
728
729
730 /* Note: This function is used by signal handlers!. */
731 static void
732 emergency_cleanup (void)
733 {
734   gcry_control (GCRYCTL_TERM_SECMEM );
735 }
736
737
738 void
739 g13_exit (int rc)
740 {
741   gcry_control (GCRYCTL_UPDATE_RANDOM_SEED_FILE);
742   if (opt.debug & DBG_MEMSTAT_VALUE)
743     {
744       gcry_control( GCRYCTL_DUMP_MEMORY_STATS );
745       gcry_control( GCRYCTL_DUMP_RANDOM_STATS );
746     }
747   if (opt.debug)
748     gcry_control (GCRYCTL_DUMP_SECMEM_STATS );
749   emergency_cleanup ();
750   rc = rc? rc : log_get_errorcount(0)? 2 : g13_errors_seen? 1 : 0;
751   exit (rc);
752 }
753
754
755 /* Store defaults into the per-connection CTRL object.  */
756 void
757 g13_init_default_ctrl (struct server_control_s *ctrl)
758 {
759   ctrl->conttype = CONTTYPE_ENCFS;
760 }
761
762
763 /* This function is called for each signal we catch.  It is run in the
764    main context or the one of a Pth thread and thus it is not
765    restricted in what it may do.  */
766 static void
767 handle_signal (int signo)
768 {
769   switch (signo)
770     {
771 #ifndef HAVE_W32_SYSTEM
772     case SIGHUP:
773       log_info ("SIGHUP received - re-reading configuration\n");
774       /* Fixme:  Not yet implemented.  */
775       break;
776       
777     case SIGUSR1:
778       log_info ("SIGUSR1 received - printing internal information:\n");
779       pth_ctrl (PTH_CTRL_DUMPSTATE, log_get_stream ());
780       mountinfo_dump_all ();
781       break;
782
783     case SIGUSR2:
784       log_info ("SIGUSR2 received - no action defined\n");
785       break;
786
787     case SIGTERM:
788       if (!shutdown_pending)
789         log_info ("SIGTERM received - shutting down ...\n");
790       else
791         log_info ("SIGTERM received - still %u runners active\n",
792                   runner_get_threads ());
793       shutdown_pending++;
794       if (shutdown_pending > 2)
795         {
796           log_info ("shutdown forced\n");
797           log_info ("%s %s stopped\n", strusage(11), strusage(13) );
798           g13_exit (0);
799         }
800       break;
801       
802     case SIGINT:
803       log_info ("SIGINT received - immediate shutdown\n");
804       log_info( "%s %s stopped\n", strusage(11), strusage(13));
805       g13_exit (0);
806       break;
807 #endif /*!HAVE_W32_SYSTEM*/
808       
809     default:
810       log_info ("signal %d received - no action defined\n", signo);
811     }
812 }
813
814
815 /* This ticker function is called about every TIMERTICK_INTERVAL_SEC
816    seconds. */
817 static void
818 handle_tick (void)
819 {
820   /* log_debug ("TICK\n"); */
821 }
822
823
824 /* The idle task.  We use a separate thread to do idle stuff and to
825    catch signals.  */
826 static void *
827 idle_task (void *dummy_arg)
828 {
829   sigset_t sigs;       /* The set of signals we want to catch.  */
830   pth_event_t ev;      /* The main event to catch signals.  */
831   pth_event_t time_ev; /* The time event.  */
832   int signo;           /* The number of a raised signal is stored here.  */
833
834   (void)dummy_arg;
835
836   /* Create the event to catch the signals. */
837 #ifndef HAVE_W32_SYSTEM
838   sigemptyset (&sigs );
839   sigaddset (&sigs, SIGHUP);
840   sigaddset (&sigs, SIGUSR1);
841   sigaddset (&sigs, SIGUSR2);
842   sigaddset (&sigs, SIGINT);
843   sigaddset (&sigs, SIGTERM);
844   pth_sigmask (SIG_UNBLOCK, &sigs, NULL);
845 #else
846   sigs = 0;
847 #endif
848   ev = pth_event (PTH_EVENT_SIGS, &sigs, &signo);
849
850   /* The time event neds to computed n tghe fly.  */
851   time_ev = NULL;
852
853   for (;;)
854     {
855       /* The shutdown flag allows us to terminate the idle task.  */
856       if (shutdown_pending)
857         {
858           runner_cancel_all ();
859
860           if (!runner_get_threads ())
861             break; /* ready */
862         }
863
864       /* Create a timeout event if needed.  To help with power saving
865          we syncronize the ticks to the next full second.  */
866       if (!time_ev)
867         {
868           pth_time_t nexttick;
869
870           nexttick = pth_timeout (TIMERTICK_INTERVAL_SEC, 0);
871           if (nexttick.tv_usec > 10)  /* Use a 10 usec threshhold.  */
872             {
873               nexttick.tv_sec++;
874               nexttick.tv_usec = 0;
875             }
876           time_ev = pth_event (PTH_EVENT_TIME, nexttick);
877         }
878
879       pth_event_concat (ev, time_ev, NULL);
880       pth_wait (ev);
881       pth_event_isolate (time_ev);
882
883       if (pth_event_occurred (ev))
884         {
885           handle_signal (signo);
886         }
887
888       if (time_ev && pth_event_occurred (time_ev))
889         {
890           pth_event_free (time_ev, PTH_FREE_ALL);
891           time_ev = NULL;
892           handle_tick ();
893         }
894     }
895
896   pth_event_free (ev, PTH_FREE_ALL);
897   if (time_ev)
898     pth_event_free (time_ev, PTH_FREE_ALL);
899   log_info (_("%s %s stopped\n"), strusage(11), strusage(13));
900   return NULL;
901 }
902
903
904 /* Start the idle task.   */
905 static void
906 start_idle_task (void)
907 {
908   pth_attr_t tattr;
909   pth_t tid;
910   
911   tattr = pth_attr_new ();
912   pth_attr_set (tattr, PTH_ATTR_JOINABLE, 1);
913   pth_attr_set (tattr, PTH_ATTR_STACK_SIZE, 64*1024);
914   pth_attr_set (tattr, PTH_ATTR_NAME, "idle-task");
915   
916   tid = pth_spawn (tattr, idle_task, NULL);
917   if (!tid)
918     {
919       log_fatal ("error starting idle task: %s\n", 
920                  gpg_strerror (gpg_error_from_syserror ()));
921       return; /*NOTREACHED*/
922     }
923   idle_task_tid = tid;
924   pth_attr_destroy (tattr);
925 }
926
927
928 /* Wait for the idle task to finish.  */
929 static void
930 join_idle_task (void)
931 {
932   if (idle_task_tid)
933     {
934       if (!pth_join (idle_task_tid, NULL))
935         log_error ("waiting for idle task thread failed: %s\n",
936                    gpg_strerror (gpg_error_from_syserror ()));
937     }
938 }
939