221e3e24f2550036f8ea5bbde4ec08efafc5637b
[gnupg.git] / tools / gpgconf.c
1 /* gpgconf.c - Configuration utility for GnuPG
2  * Copyright (C) 2003, 2007, 2009, 2011 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 <errno.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <unistd.h>
26
27 #include "gpgconf.h"
28 #include "i18n.h"
29 #include "sysutils.h"
30 #include "../common/init.h"
31
32
33 /* Constants to identify the commands and options. */
34 enum cmd_and_opt_values
35   {
36     aNull = 0,
37     oDryRun     = 'n',
38     oOutput     = 'o',
39     oQuiet      = 'q',
40     oVerbose    = 'v',
41     oRuntime    = 'r',
42     oComponent  = 'c',
43     oNull       = '0',
44     oNoVerbose  = 500,
45     oHomedir,
46
47     aListComponents,
48     aCheckPrograms,
49     aListOptions,
50     aChangeOptions,
51     aCheckOptions,
52     aApplyDefaults,
53     aListConfig,
54     aCheckConfig,
55     aListDirs,
56     aLaunch,
57     aKill,
58     aCreateSocketDir,
59     aRemoveSocketDir,
60     aReload
61   };
62
63
64 /* The list of commands and options. */
65 static ARGPARSE_OPTS opts[] =
66   {
67     { 300, NULL, 0, N_("@Commands:\n ") },
68
69     { aListComponents, "list-components", 256, N_("list all components") },
70     { aCheckPrograms, "check-programs", 256, N_("check all programs") },
71     { aListOptions, "list-options", 256, N_("|COMPONENT|list options") },
72     { aChangeOptions, "change-options", 256, N_("|COMPONENT|change options") },
73     { aCheckOptions, "check-options", 256, N_("|COMPONENT|check options") },
74     { aApplyDefaults, "apply-defaults", 256,
75       N_("apply global default values") },
76     { aListDirs, "list-dirs", 256,
77       N_("get the configuration directories for @GPGCONF@") },
78     { aListConfig,   "list-config", 256,
79       N_("list global configuration file") },
80     { aCheckConfig,   "check-config", 256,
81       N_("check global configuration file") },
82     { aReload,        "reload", 256, N_("reload all or a given component")},
83     { aLaunch,        "launch", 256, N_("launch a given component")},
84     { aKill,          "kill", 256,   N_("kill a given component")},
85     { aCreateSocketDir, "create-socketdir", 256, "@"},
86     { aRemoveSocketDir, "remove-socketdir", 256, "@"},
87
88     { 301, NULL, 0, N_("@\nOptions:\n ") },
89
90     { oOutput, "output",    2, N_("use as output file") },
91     { oVerbose, "verbose",  0, N_("verbose") },
92     { oQuiet, "quiet",      0, N_("quiet") },
93     { oDryRun, "dry-run",   0, N_("do not make any changes") },
94     { oRuntime, "runtime",  0, N_("activate changes at runtime, if possible") },
95     /* hidden options */
96     { oHomedir, "homedir", 2, "@" },
97     { oNull, "null", 0, "@" },
98     { oNoVerbose, "no-verbose",  0, "@"},
99     {0}
100   };
101
102
103 /* Print usage information and and provide strings for help. */
104 static const char *
105 my_strusage( int level )
106 {
107   const char *p;
108
109   switch (level)
110     {
111     case 11: p = "@GPGCONF@ (@GNUPG@)";
112       break;
113     case 13: p = VERSION; break;
114     case 17: p = PRINTABLE_OS_NAME; break;
115     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
116
117     case 1:
118     case 40: p = _("Usage: @GPGCONF@ [options] (-h for help)");
119       break;
120     case 41:
121       p = _("Syntax: @GPGCONF@ [options]\n"
122             "Manage configuration options for tools of the @GNUPG@ system\n");
123       break;
124
125     default: p = NULL; break;
126     }
127   return p;
128 }
129
130
131 /* Return the fp for the output.  This is usually stdout unless
132    --output has been used.  In the latter case this function opens
133    that file.  */
134 static estream_t
135 get_outfp (estream_t *fp)
136 {
137   if (!*fp)
138     {
139       if (opt.outfile)
140         {
141           *fp = es_fopen (opt.outfile, "w");
142           if (!*fp)
143             gc_error (1, errno, "can not open '%s'", opt.outfile);
144         }
145       else
146         *fp = es_stdout;
147     }
148   return *fp;
149 }
150
151
152 static void
153 list_dirs (estream_t fp, char **names)
154 {
155   static struct {
156     const char *name;
157     const char *(*fnc)(void);
158     const char *extra;
159   } list[] = {
160     { "sysconfdir",         gnupg_sysconfdir, NULL },
161     { "bindir",             gnupg_bindir,     NULL },
162     { "libexecdir",         gnupg_libexecdir, NULL },
163     { "libdir",             gnupg_libdir,     NULL },
164     { "datadir",            gnupg_datadir,    NULL },
165     { "localedir",          gnupg_localedir,  NULL },
166     { "dirmngr-socket",     dirmngr_socket_name, NULL,},
167     { "agent-ssh-socket",   gnupg_socketdir,  GPG_AGENT_SSH_SOCK_NAME },
168     { "agent-socket",       gnupg_socketdir,  GPG_AGENT_SOCK_NAME },
169     { "homedir",            gnupg_homedir,    NULL }
170   };
171   int idx, j;
172   char *tmp;
173   const char *s;
174
175
176   for (idx = 0; idx < DIM (list); idx++)
177     {
178       s = list[idx].fnc ();
179       if (list[idx].extra)
180         {
181           tmp = make_filename (s, list[idx].extra, NULL);
182           s = tmp;
183         }
184       else
185         tmp = NULL;
186       if (!names)
187         es_fprintf (fp, "%s:%s\n", list[idx].name, gc_percent_escape (s));
188       else
189         {
190           for (j=0; names[j]; j++)
191             if (!strcmp (names[j], list[idx].name))
192               {
193                 es_fputs (s, fp);
194                 es_putc (opt.null? '\0':'\n', fp);
195               }
196         }
197
198       xfree (tmp);
199     }
200 }
201
202
203 /* gpgconf main. */
204 int
205 main (int argc, char **argv)
206 {
207   ARGPARSE_ARGS pargs;
208   const char *fname;
209   int no_more_options = 0;
210   enum cmd_and_opt_values cmd = 0;
211   estream_t outfp = NULL;
212
213   early_system_init ();
214   gnupg_reopen_std (GPGCONF_NAME);
215   set_strusage (my_strusage);
216   log_set_prefix (GPGCONF_NAME, GPGRT_LOG_WITH_PREFIX);
217
218   /* Make sure that our subsystems are ready.  */
219   i18n_init();
220   init_common_subsystems (&argc, &argv);
221
222   /* Parse the command line. */
223   pargs.argc  = &argc;
224   pargs.argv  = &argv;
225   pargs.flags =  1;  /* Do not remove the args.  */
226   while (!no_more_options && optfile_parse (NULL, NULL, NULL, &pargs, opts))
227     {
228       switch (pargs.r_opt)
229         {
230         case oOutput:    opt.outfile = pargs.r.ret_str; break;
231         case oQuiet:     opt.quiet = 1; break;
232         case oDryRun:    opt.dry_run = 1; break;
233         case oRuntime:
234           opt.runtime = 1;
235           break;
236         case oVerbose:   opt.verbose++; break;
237         case oNoVerbose: opt.verbose = 0; break;
238         case oHomedir:   gnupg_set_homedir (pargs.r.ret_str); break;
239         case oNull:      opt.null = 1; break;
240
241         case aListDirs:
242         case aListComponents:
243         case aCheckPrograms:
244         case aListOptions:
245         case aChangeOptions:
246         case aCheckOptions:
247         case aApplyDefaults:
248         case aListConfig:
249         case aCheckConfig:
250         case aReload:
251         case aLaunch:
252         case aKill:
253         case aCreateSocketDir:
254         case aRemoveSocketDir:
255           cmd = pargs.r_opt;
256           break;
257
258         default: pargs.err = 2; break;
259         }
260     }
261
262   if (log_get_errorcount (0))
263     exit (2);
264
265   /* Print a warning if an argument looks like an option.  */
266   if (!opt.quiet && !(pargs.flags & ARGPARSE_FLAG_STOP_SEEN))
267     {
268       int i;
269
270       for (i=0; i < argc; i++)
271         if (argv[i][0] == '-' && argv[i][1] == '-')
272           log_info (_("Note: '%s' is not considered an option\n"), argv[i]);
273     }
274
275   fname = argc ? *argv : NULL;
276
277   switch (cmd)
278     {
279     case aListComponents:
280     default:
281       /* List all components. */
282       gc_component_list_components (get_outfp (&outfp));
283       break;
284
285     case aCheckPrograms:
286       /* Check all programs. */
287       gc_check_programs (get_outfp (&outfp));
288       break;
289
290     case aListOptions:
291     case aChangeOptions:
292     case aCheckOptions:
293       if (!fname)
294         {
295           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
296           es_putc ('\n', es_stderr);
297           es_fputs (_("Need one component argument"), es_stderr);
298           es_putc ('\n', es_stderr);
299           exit (2);
300         }
301       else
302         {
303           int idx = gc_component_find (fname);
304           if (idx < 0)
305             {
306               es_fputs (_("Component not found"), es_stderr);
307               es_putc ('\n', es_stderr);
308               exit (1);
309             }
310           if (cmd == aCheckOptions)
311             gc_component_check_options (idx, get_outfp (&outfp), NULL);
312           else
313             {
314               gc_component_retrieve_options (idx);
315               if (gc_process_gpgconf_conf (NULL, 1, 0, NULL))
316                 exit (1);
317               if (cmd == aListOptions)
318                 gc_component_list_options (idx, get_outfp (&outfp));
319               else if (cmd == aChangeOptions)
320                 gc_component_change_options (idx, es_stdin, get_outfp (&outfp));
321             }
322         }
323       break;
324
325     case aLaunch:
326     case aKill:
327       if (!fname)
328         {
329           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
330           es_putc ('\n', es_stderr);
331           es_fputs (_("Need one component argument"), es_stderr);
332           es_putc ('\n', es_stderr);
333           exit (2);
334         }
335       else
336         {
337           /* Launch/Kill a given component.  */
338           int idx;
339
340           idx = gc_component_find (fname);
341           if (idx < 0)
342             {
343               es_fputs (_("Component not found"), es_stderr);
344               es_putc ('\n', es_stderr);
345               exit (1);
346             }
347           else if (cmd == aLaunch)
348             {
349               if (gc_component_launch (idx))
350                 exit (1);
351             }
352           else
353             {
354               /* We don't error out if the kill failed because this
355                  command should do nothing if the component is not
356                  running.  */
357               gc_component_kill (idx);
358             }
359         }
360       break;
361
362     case aReload:
363       if (!fname)
364         {
365           /* Reload all.  */
366           gc_component_reload (-1);
367         }
368       else
369         {
370           /* Reload given component.  */
371           int idx;
372
373           idx = gc_component_find (fname);
374           if (idx < 0)
375             {
376               es_fputs (_("Component not found"), es_stderr);
377               es_putc ('\n', es_stderr);
378               exit (1);
379             }
380           else
381             {
382               gc_component_reload (idx);
383             }
384         }
385       break;
386
387     case aListConfig:
388       if (gc_process_gpgconf_conf (fname, 0, 0, get_outfp (&outfp)))
389         exit (1);
390       break;
391
392     case aCheckConfig:
393       if (gc_process_gpgconf_conf (fname, 0, 0, NULL))
394         exit (1);
395       break;
396
397     case aApplyDefaults:
398       if (fname)
399         {
400           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
401           es_putc ('\n', es_stderr);
402           es_fputs (_("No argument allowed"), es_stderr);
403           es_putc ('\n', es_stderr);
404           exit (2);
405         }
406       gc_component_retrieve_options (-1);
407       if (gc_process_gpgconf_conf (NULL, 1, 1, NULL))
408         exit (1);
409       break;
410
411     case aListDirs:
412       /* Show the system configuration directories for gpgconf.  */
413       get_outfp (&outfp);
414       list_dirs (outfp, argc? argv : NULL);
415       break;
416
417     case aCreateSocketDir:
418       {
419         char *socketdir;
420         unsigned int flags;
421
422         /* Make sure that the top /run/user/UID/gnupg dir has been
423          * created.  */
424         gnupg_socketdir ();
425
426         /* Check the /var/run dir.  */
427         socketdir = _gnupg_socketdir_internal (1, &flags);
428         if ((flags & 64) && !opt.dry_run)
429           {
430             /* No sub dir - create it. */
431             if (gnupg_mkdir (socketdir, "-rwx"))
432               gc_error (1, errno, "error creating '%s'", socketdir);
433             /* Try again.  */
434             socketdir = _gnupg_socketdir_internal (1, &flags);
435           }
436
437         /* Give some info.  */
438         if ( (flags & ~32) || opt.verbose || opt.dry_run)
439           {
440             log_info ("socketdir is '%s'\n", socketdir);
441             if ((flags &   1)) log_info ("\tgeneral error\n");
442             if ((flags &   2)) log_info ("\tno /run/user dir\n");
443             if ((flags &   4)) log_info ("\tbad permissions\n");
444             if ((flags &   8)) log_info ("\tbad permissions (subdir)\n");
445             if ((flags &  16)) log_info ("\tmkdir failed\n");
446             if ((flags &  32)) log_info ("\tnon-default homedir\n");
447             if ((flags &  64)) log_info ("\tno such subdir\n");
448             if ((flags & 128)) log_info ("\tusing homedir as fallback\n");
449           }
450
451         if ((flags & ~32) && !opt.dry_run)
452           gc_error (1, 0, "error creating socket directory");
453
454         xfree (socketdir);
455       }
456       break;
457
458     case aRemoveSocketDir:
459       {
460         char *socketdir;
461         unsigned int flags;
462
463         /* Check the /var/run dir.  */
464         socketdir = _gnupg_socketdir_internal (1, &flags);
465         if ((flags & 128))
466           log_info ("ignoring request to remove non /run/user socket dir\n");
467         else if (opt.dry_run)
468           ;
469         else if (rmdir (socketdir))
470           gc_error (1, errno, "error removing '%s'", socketdir);
471
472         xfree (socketdir);
473       }
474       break;
475
476     }
477
478   if (outfp != es_stdout)
479     if (es_fclose (outfp))
480       gc_error (1, errno, "error closing '%s'", opt.outfile);
481
482   return 0;
483 }