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