agent: Create the extra sockets in the standard socket dir.
[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     { "socketdir",          gnupg_socketdir,  NULL },
167     { "dirmngr-socket",     dirmngr_socket_name, NULL,},
168     { "agent-ssh-socket",   gnupg_socketdir,  GPG_AGENT_SSH_SOCK_NAME },
169     { "agent-extra-socket", gnupg_socketdir,  GPG_AGENT_EXTRA_SOCK_NAME },
170     { "agent-browser-socket",gnupg_socketdir, GPG_AGENT_BROWSER_SOCK_NAME },
171     { "agent-socket",       gnupg_socketdir,  GPG_AGENT_SOCK_NAME },
172     { "homedir",            gnupg_homedir,    NULL }
173   };
174   int idx, j;
175   char *tmp;
176   const char *s;
177
178
179   for (idx = 0; idx < DIM (list); idx++)
180     {
181       s = list[idx].fnc ();
182       if (list[idx].extra)
183         {
184           tmp = make_filename (s, list[idx].extra, NULL);
185           s = tmp;
186         }
187       else
188         tmp = NULL;
189       if (!names)
190         es_fprintf (fp, "%s:%s\n", list[idx].name, gc_percent_escape (s));
191       else
192         {
193           for (j=0; names[j]; j++)
194             if (!strcmp (names[j], list[idx].name))
195               {
196                 es_fputs (s, fp);
197                 es_putc (opt.null? '\0':'\n', fp);
198               }
199         }
200
201       xfree (tmp);
202     }
203 }
204
205
206 /* gpgconf main. */
207 int
208 main (int argc, char **argv)
209 {
210   ARGPARSE_ARGS pargs;
211   const char *fname;
212   int no_more_options = 0;
213   enum cmd_and_opt_values cmd = 0;
214   estream_t outfp = NULL;
215
216   early_system_init ();
217   gnupg_reopen_std (GPGCONF_NAME);
218   set_strusage (my_strusage);
219   log_set_prefix (GPGCONF_NAME, GPGRT_LOG_WITH_PREFIX);
220
221   /* Make sure that our subsystems are ready.  */
222   i18n_init();
223   init_common_subsystems (&argc, &argv);
224
225   /* Parse the command line. */
226   pargs.argc  = &argc;
227   pargs.argv  = &argv;
228   pargs.flags =  1;  /* Do not remove the args.  */
229   while (!no_more_options && optfile_parse (NULL, NULL, NULL, &pargs, opts))
230     {
231       switch (pargs.r_opt)
232         {
233         case oOutput:    opt.outfile = pargs.r.ret_str; break;
234         case oQuiet:     opt.quiet = 1; break;
235         case oDryRun:    opt.dry_run = 1; break;
236         case oRuntime:
237           opt.runtime = 1;
238           break;
239         case oVerbose:   opt.verbose++; break;
240         case oNoVerbose: opt.verbose = 0; break;
241         case oHomedir:   gnupg_set_homedir (pargs.r.ret_str); break;
242         case oNull:      opt.null = 1; break;
243
244         case aListDirs:
245         case aListComponents:
246         case aCheckPrograms:
247         case aListOptions:
248         case aChangeOptions:
249         case aCheckOptions:
250         case aApplyDefaults:
251         case aListConfig:
252         case aCheckConfig:
253         case aReload:
254         case aLaunch:
255         case aKill:
256         case aCreateSocketDir:
257         case aRemoveSocketDir:
258           cmd = pargs.r_opt;
259           break;
260
261         default: pargs.err = 2; break;
262         }
263     }
264
265   if (log_get_errorcount (0))
266     exit (2);
267
268   /* Print a warning if an argument looks like an option.  */
269   if (!opt.quiet && !(pargs.flags & ARGPARSE_FLAG_STOP_SEEN))
270     {
271       int i;
272
273       for (i=0; i < argc; i++)
274         if (argv[i][0] == '-' && argv[i][1] == '-')
275           log_info (_("Note: '%s' is not considered an option\n"), argv[i]);
276     }
277
278   fname = argc ? *argv : NULL;
279
280   switch (cmd)
281     {
282     case aListComponents:
283     default:
284       /* List all components. */
285       gc_component_list_components (get_outfp (&outfp));
286       break;
287
288     case aCheckPrograms:
289       /* Check all programs. */
290       gc_check_programs (get_outfp (&outfp));
291       break;
292
293     case aListOptions:
294     case aChangeOptions:
295     case aCheckOptions:
296       if (!fname)
297         {
298           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
299           es_putc ('\n', es_stderr);
300           es_fputs (_("Need one component argument"), es_stderr);
301           es_putc ('\n', es_stderr);
302           exit (2);
303         }
304       else
305         {
306           int idx = gc_component_find (fname);
307           if (idx < 0)
308             {
309               es_fputs (_("Component not found"), es_stderr);
310               es_putc ('\n', es_stderr);
311               exit (1);
312             }
313           if (cmd == aCheckOptions)
314             gc_component_check_options (idx, get_outfp (&outfp), NULL);
315           else
316             {
317               gc_component_retrieve_options (idx);
318               if (gc_process_gpgconf_conf (NULL, 1, 0, NULL))
319                 exit (1);
320               if (cmd == aListOptions)
321                 gc_component_list_options (idx, get_outfp (&outfp));
322               else if (cmd == aChangeOptions)
323                 gc_component_change_options (idx, es_stdin, get_outfp (&outfp));
324             }
325         }
326       break;
327
328     case aLaunch:
329     case aKill:
330       if (!fname)
331         {
332           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
333           es_putc ('\n', es_stderr);
334           es_fputs (_("Need one component argument"), es_stderr);
335           es_putc ('\n', es_stderr);
336           exit (2);
337         }
338       else
339         {
340           /* Launch/Kill a given component.  */
341           int idx;
342
343           idx = gc_component_find (fname);
344           if (idx < 0)
345             {
346               es_fputs (_("Component not found"), es_stderr);
347               es_putc ('\n', es_stderr);
348               exit (1);
349             }
350           else if (cmd == aLaunch)
351             {
352               if (gc_component_launch (idx))
353                 exit (1);
354             }
355           else
356             {
357               /* We don't error out if the kill failed because this
358                  command should do nothing if the component is not
359                  running.  */
360               gc_component_kill (idx);
361             }
362         }
363       break;
364
365     case aReload:
366       if (!fname)
367         {
368           /* Reload all.  */
369           gc_component_reload (-1);
370         }
371       else
372         {
373           /* Reload given component.  */
374           int idx;
375
376           idx = gc_component_find (fname);
377           if (idx < 0)
378             {
379               es_fputs (_("Component not found"), es_stderr);
380               es_putc ('\n', es_stderr);
381               exit (1);
382             }
383           else
384             {
385               gc_component_reload (idx);
386             }
387         }
388       break;
389
390     case aListConfig:
391       if (gc_process_gpgconf_conf (fname, 0, 0, get_outfp (&outfp)))
392         exit (1);
393       break;
394
395     case aCheckConfig:
396       if (gc_process_gpgconf_conf (fname, 0, 0, NULL))
397         exit (1);
398       break;
399
400     case aApplyDefaults:
401       if (fname)
402         {
403           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
404           es_putc ('\n', es_stderr);
405           es_fputs (_("No argument allowed"), es_stderr);
406           es_putc ('\n', es_stderr);
407           exit (2);
408         }
409       gc_component_retrieve_options (-1);
410       if (gc_process_gpgconf_conf (NULL, 1, 1, NULL))
411         exit (1);
412       break;
413
414     case aListDirs:
415       /* Show the system configuration directories for gpgconf.  */
416       get_outfp (&outfp);
417       list_dirs (outfp, argc? argv : NULL);
418       break;
419
420     case aCreateSocketDir:
421       {
422         char *socketdir;
423         unsigned int flags;
424
425         /* Make sure that the top /run/user/UID/gnupg dir has been
426          * created.  */
427         gnupg_socketdir ();
428
429         /* Check the /var/run dir.  */
430         socketdir = _gnupg_socketdir_internal (1, &flags);
431         if ((flags & 64) && !opt.dry_run)
432           {
433             /* No sub dir - create it. */
434             if (gnupg_mkdir (socketdir, "-rwx"))
435               gc_error (1, errno, "error creating '%s'", socketdir);
436             /* Try again.  */
437             socketdir = _gnupg_socketdir_internal (1, &flags);
438           }
439
440         /* Give some info.  */
441         if ( (flags & ~32) || opt.verbose || opt.dry_run)
442           {
443             log_info ("socketdir is '%s'\n", socketdir);
444             if ((flags &   1)) log_info ("\tgeneral error\n");
445             if ((flags &   2)) log_info ("\tno /run/user dir\n");
446             if ((flags &   4)) log_info ("\tbad permissions\n");
447             if ((flags &   8)) log_info ("\tbad permissions (subdir)\n");
448             if ((flags &  16)) log_info ("\tmkdir failed\n");
449             if ((flags &  32)) log_info ("\tnon-default homedir\n");
450             if ((flags &  64)) log_info ("\tno such subdir\n");
451             if ((flags & 128)) log_info ("\tusing homedir as fallback\n");
452           }
453
454         if ((flags & ~32) && !opt.dry_run)
455           gc_error (1, 0, "error creating socket directory");
456
457         xfree (socketdir);
458       }
459       break;
460
461     case aRemoveSocketDir:
462       {
463         char *socketdir;
464         unsigned int flags;
465
466         /* Check the /var/run dir.  */
467         socketdir = _gnupg_socketdir_internal (1, &flags);
468         if ((flags & 128))
469           log_info ("ignoring request to remove non /run/user socket dir\n");
470         else if (opt.dry_run)
471           ;
472         else if (rmdir (socketdir))
473           gc_error (1, errno, "error removing '%s'", socketdir);
474
475         xfree (socketdir);
476       }
477       break;
478
479     }
480
481   if (outfp != es_stdout)
482     if (es_fclose (outfp))
483       gc_error (1, errno, "error closing '%s'", opt.outfile);
484
485   return 0;
486 }