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