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