gpgconf: Add command --query-swdb.
[gnupg.git] / tools / gpgconf.c
1 /* gpgconf.c - Configuration utility for GnuPG
2  * Copyright (C) 2003, 2007, 2009, 2011 Free Software Foundation, Inc.
3  * Copyright (C) 2016 g10 Code GmbH.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27
28 #include "gpgconf.h"
29 #include "i18n.h"
30 #include "sysutils.h"
31 #include "../common/init.h"
32
33
34 /* Constants to identify the commands and options. */
35 enum cmd_and_opt_values
36   {
37     aNull = 0,
38     oDryRun     = 'n',
39     oOutput     = 'o',
40     oQuiet      = 'q',
41     oVerbose    = 'v',
42     oRuntime    = 'r',
43     oComponent  = 'c',
44     oNull       = '0',
45     oNoVerbose  = 500,
46     oHomedir,
47
48     aListComponents,
49     aCheckPrograms,
50     aListOptions,
51     aChangeOptions,
52     aCheckOptions,
53     aApplyDefaults,
54     aListConfig,
55     aCheckConfig,
56     aQuerySWDB,
57     aListDirs,
58     aLaunch,
59     aKill,
60     aCreateSocketDir,
61     aRemoveSocketDir,
62     aReload
63   };
64
65
66 /* The list of commands and options. */
67 static ARGPARSE_OPTS opts[] =
68   {
69     { 300, NULL, 0, N_("@Commands:\n ") },
70
71     { aListComponents, "list-components", 256, N_("list all components") },
72     { aCheckPrograms, "check-programs", 256, N_("check all programs") },
73     { aListOptions, "list-options", 256, N_("|COMPONENT|list options") },
74     { aChangeOptions, "change-options", 256, N_("|COMPONENT|change options") },
75     { aCheckOptions, "check-options", 256, N_("|COMPONENT|check options") },
76     { aApplyDefaults, "apply-defaults", 256,
77       N_("apply global default values") },
78     { aListDirs, "list-dirs", 256,
79       N_("get the configuration directories for @GPGCONF@") },
80     { aListConfig,   "list-config", 256,
81       N_("list global configuration file") },
82     { aCheckConfig,   "check-config", 256,
83       N_("check global configuration file") },
84     { aQuerySWDB,     "query-swdb", 256,
85       N_("query the software version database") },
86     { aReload,        "reload", 256, N_("reload all or a given component")},
87     { aLaunch,        "launch", 256, N_("launch a given component")},
88     { aKill,          "kill", 256,   N_("kill a given component")},
89     { aCreateSocketDir, "create-socketdir", 256, "@"},
90     { aRemoveSocketDir, "remove-socketdir", 256, "@"},
91
92     { 301, NULL, 0, N_("@\nOptions:\n ") },
93
94     { oOutput, "output",    2, N_("use as output file") },
95     { oVerbose, "verbose",  0, N_("verbose") },
96     { oQuiet, "quiet",      0, N_("quiet") },
97     { oDryRun, "dry-run",   0, N_("do not make any changes") },
98     { oRuntime, "runtime",  0, N_("activate changes at runtime, if possible") },
99     /* hidden options */
100     { oHomedir, "homedir", 2, "@" },
101     { oNull, "null", 0, "@" },
102     { oNoVerbose, "no-verbose",  0, "@"},
103     {0}
104   };
105
106
107 /* Print usage information and and provide strings for help. */
108 static const char *
109 my_strusage( int level )
110 {
111   const char *p;
112
113   switch (level)
114     {
115     case 11: p = "@GPGCONF@ (@GNUPG@)";
116       break;
117     case 13: p = VERSION; break;
118     case 17: p = PRINTABLE_OS_NAME; break;
119     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
120
121     case 1:
122     case 40: p = _("Usage: @GPGCONF@ [options] (-h for help)");
123       break;
124     case 41:
125       p = _("Syntax: @GPGCONF@ [options]\n"
126             "Manage configuration options for tools of the @GNUPG@ system\n");
127       break;
128
129     default: p = NULL; break;
130     }
131   return p;
132 }
133
134
135 /* Return the fp for the output.  This is usually stdout unless
136    --output has been used.  In the latter case this function opens
137    that file.  */
138 static estream_t
139 get_outfp (estream_t *fp)
140 {
141   if (!*fp)
142     {
143       if (opt.outfile)
144         {
145           *fp = es_fopen (opt.outfile, "w");
146           if (!*fp)
147             gc_error (1, errno, "can not open '%s'", opt.outfile);
148         }
149       else
150         *fp = es_stdout;
151     }
152   return *fp;
153 }
154
155
156 static void
157 list_dirs (estream_t fp, char **names)
158 {
159   static struct {
160     const char *name;
161     const char *(*fnc)(void);
162     const char *extra;
163   } list[] = {
164     { "sysconfdir",         gnupg_sysconfdir, NULL },
165     { "bindir",             gnupg_bindir,     NULL },
166     { "libexecdir",         gnupg_libexecdir, NULL },
167     { "libdir",             gnupg_libdir,     NULL },
168     { "datadir",            gnupg_datadir,    NULL },
169     { "localedir",          gnupg_localedir,  NULL },
170     { "socketdir",          gnupg_socketdir,  NULL },
171     { "dirmngr-socket",     dirmngr_socket_name, NULL,},
172     { "agent-ssh-socket",   gnupg_socketdir,  GPG_AGENT_SSH_SOCK_NAME },
173     { "agent-extra-socket", gnupg_socketdir,  GPG_AGENT_EXTRA_SOCK_NAME },
174     { "agent-browser-socket",gnupg_socketdir, GPG_AGENT_BROWSER_SOCK_NAME },
175     { "agent-socket",       gnupg_socketdir,  GPG_AGENT_SOCK_NAME },
176     { "homedir",            gnupg_homedir,    NULL }
177   };
178   int idx, j;
179   char *tmp;
180   const char *s;
181
182
183   for (idx = 0; idx < DIM (list); idx++)
184     {
185       s = list[idx].fnc ();
186       if (list[idx].extra)
187         {
188           tmp = make_filename (s, list[idx].extra, NULL);
189           s = tmp;
190         }
191       else
192         tmp = NULL;
193       if (!names)
194         es_fprintf (fp, "%s:%s\n", list[idx].name, gc_percent_escape (s));
195       else
196         {
197           for (j=0; names[j]; j++)
198             if (!strcmp (names[j], list[idx].name))
199               {
200                 es_fputs (s, fp);
201                 es_putc (opt.null? '\0':'\n', fp);
202               }
203         }
204
205       xfree (tmp);
206     }
207 }
208
209
210
211 /* Check whether NAME is valid argument for query_swdb().  Valid names
212  * start with a letter and contain only alphanumeric characters or an
213  * underscore.  */
214 static int
215 valid_swdb_name_p (const char *name)
216 {
217   if (!name || !*name || !alphap (name))
218     return 0;
219
220   for (name++; *name; name++)
221     if (!alnump (name) && *name != '_')
222       return 0;
223
224   return 1;
225 }
226
227
228 /* Query the SWDB file.  If necessary and possible this functions asks
229  * the dirmngr to load an updated version of that file.  The caller
230  * needs to provide the NAME to query (e.g. "gnupg", "libgcrypt") and
231  * optional the currently installed version in CURRENT_VERSION.  The
232  * output written to OUT is a colon delimited line with these fields:
233  *
234  * name   :: The name of the package
235  * status :: This value tells the status of the software package
236  *           '-' :: No information available
237  *                  (error or CURRENT_VERSION not given)
238  *           '?' :: Unknown NAME
239  *           'u' :: Update available
240  *           'c' :: The version is Current
241  *           'n' :: The current version is already Newer than the
242  *                  available one.
243  * urgency :: If the value is greater than zero an urgent update is required.
244  * error   :: 0 on success or an gpg_err_code_t
245  *            Common codes seen:
246  *            GPG_ERR_TOO_OLD :: The SWDB file is to old to be used.
247  *            GPG_ERR_ENOENT  :: The SWDB file is not available.
248  *            GPG_ERR_BAD_SIGNATURE :: Currupted SWDB file.
249  * filedate:: Date of the swdb file (yyyymmddThhmmss)
250  * verified:: Date we checked the validity of the file (yyyyymmddThhmmss)
251  * version :: The version string from the swdb.
252  * reldate :: Release date of that version (yyyymmddThhmmss)
253  * size    :: Size of the package in bytes.
254  * hash    :: SHA-2 hash of the package.
255  *
256  */
257 static void
258 query_swdb (estream_t out, const char *name, const char *current_version)
259 {
260   gpg_error_t err;
261   const char *search_name;
262   char *fname = NULL;
263   estream_t fp = NULL;
264   char *line = NULL;
265   char *self_version = NULL;
266   size_t length_of_line = 0;
267   size_t  maxlen;
268   ssize_t len;
269   char *fields[2];
270   char *p;
271   gnupg_isotime_t filedate = {0};
272   gnupg_isotime_t verified = {0};
273   char *value_ver = NULL;
274   gnupg_isotime_t value_date = {0};
275   char *value_size = NULL;
276   char *value_sha2 = NULL;
277   unsigned long value_size_ul;
278   int status, i;
279
280
281   if (!valid_swdb_name_p (name))
282     {
283       log_error ("error in package name '%s': %s\n",
284                  name, gpg_strerror (GPG_ERR_INV_NAME));
285       goto leave;
286     }
287   if (!strcmp (name, "gnupg"))
288     search_name = "gnupg21";
289   else if (!strcmp (name, "gnupg1"))
290     search_name = "gnupg1";
291   else
292     search_name = name;
293
294   if (!current_version && !strcmp (name, "gnupg"))
295     {
296       /* Use our own version but string a possible beta string.  */
297       self_version = xstrdup (PACKAGE_VERSION);
298       p = strchr (self_version, '-');
299       if (p)
300         *p = 0;
301       current_version = self_version;
302     }
303
304   if (current_version && compare_version_strings (current_version, NULL))
305     {
306       log_error ("error in version string '%s': %s\n",
307                  current_version, gpg_strerror (GPG_ERR_INV_ARG));
308       goto leave;
309     }
310
311   fname = make_filename (gnupg_homedir (), "swdb.lst", NULL);
312   fp = es_fopen (fname, "r");
313   if (!fp)
314     {
315       err = gpg_error_from_syserror ();
316       es_fprintf (out, "%s:-::%u:::::::\n", name, gpg_err_code (err));
317       if (gpg_err_code (err) != GPG_ERR_ENOENT)
318         log_error (_("error opening '%s': %s\n"), fname, gpg_strerror (err));
319       goto leave;
320     }
321
322   /* Note that the parser uses the first occurance of a matching
323    * values and ignores possible duplicated values.  */
324
325   maxlen = 2048; /* Set limit.  */
326   while ((len = es_read_line (fp, &line, &length_of_line, &maxlen)) > 0)
327     {
328       if (!maxlen)
329         {
330           err = gpg_error (GPG_ERR_LINE_TOO_LONG);
331           log_error (_("error reading '%s': %s\n"), fname, gpg_strerror (err));
332           goto leave;
333         }
334       /* Strip newline and carriage return, if present.  */
335       while (len > 0 && (line[len - 1] == '\n' || line[len - 1] == '\r'))
336         line[--len] = '\0';
337
338       if (split_fields (line, fields, DIM (fields)) < DIM(fields))
339         continue; /* Skip empty lines and names w/o a value.  */
340       if (*fields[0] == '#')
341         continue; /* Skip comments.  */
342
343       /* Record the meta data.  */
344       if (!*filedate && !strcmp (fields[0], ".filedate"))
345         {
346           string2isotime (filedate, fields[1]);
347           continue;
348         }
349       if (!*verified && !strcmp (fields[0], ".verified"))
350         {
351           string2isotime (verified, fields[1]);
352           continue;
353         }
354
355       /* Tokenize the name.  */
356       p = strrchr (fields[0], '_');
357       if (!p)
358         continue; /* Name w/o an underscore.  */
359       *p++ = 0;
360
361       /* Wait for the requested name.  */
362       if (!strcmp (fields[0], search_name))
363         {
364           if (!strcmp (p, "ver") && !value_ver)
365             value_ver = xstrdup (fields[1]);
366           else if (!strcmp (p, "date") && !*value_date)
367             string2isotime (value_date, fields[1]);
368           else if (!strcmp (p, "size") && !value_size)
369             value_size = xstrdup (fields[1]);
370           else if (!strcmp (p, "sha2") && !value_sha2)
371             value_sha2 = xstrdup (fields[1]);
372         }
373     }
374   if (len < 0 || es_ferror (fp))
375     {
376       err = gpg_error_from_syserror ();
377       log_error (_("error reading '%s': %s\n"), fname, gpg_strerror (err));
378       goto leave;
379     }
380
381   if (!*filedate || !*verified)
382     {
383       err = gpg_error (GPG_ERR_INV_TIME);
384       es_fprintf (out, "%s:-::%u:::::::\n", name, gpg_err_code (err));
385       goto leave;
386     }
387
388   if (!value_ver)
389     {
390       es_fprintf (out, "%s:?:::::::::\n", name);
391       goto leave;
392     }
393
394   if (value_size)
395     {
396       gpg_err_set_errno (0);
397       value_size_ul = strtoul (value_size, &p, 10);
398       if (errno)
399         value_size_ul = 0;
400       else if (*p == 'k')
401         value_size_ul *= 1024;
402     }
403
404   err = 0;
405   status = '-';
406   if (compare_version_strings (value_ver, NULL))
407     err = gpg_error (GPG_ERR_INV_VALUE);
408   else if (!current_version)
409     ;
410   else if (!(i = compare_version_strings (value_ver, current_version)))
411     status = 'c';
412   else if (i > 0)
413     status = 'u';
414   else
415     status = 'n';
416
417   es_fprintf (out, "%s:%c::%d:%s:%s:%s:%s:%lu:%s:\n",
418               name,
419               status,
420               err,
421               filedate,
422               verified,
423               value_ver,
424               value_date,
425               value_size_ul,
426               value_sha2? value_sha2 : "");
427
428  leave:
429   xfree (value_ver);
430   xfree (value_size);
431   xfree (value_sha2);
432   xfree (line);
433   es_fclose (fp);
434   xfree (fname);
435   xfree (self_version);
436 }
437
438
439 /* gpgconf main. */
440 int
441 main (int argc, char **argv)
442 {
443   ARGPARSE_ARGS pargs;
444   const char *fname;
445   int no_more_options = 0;
446   enum cmd_and_opt_values cmd = 0;
447   estream_t outfp = NULL;
448
449   early_system_init ();
450   gnupg_reopen_std (GPGCONF_NAME);
451   set_strusage (my_strusage);
452   log_set_prefix (GPGCONF_NAME, GPGRT_LOG_WITH_PREFIX);
453
454   /* Make sure that our subsystems are ready.  */
455   i18n_init();
456   init_common_subsystems (&argc, &argv);
457
458   /* Parse the command line. */
459   pargs.argc  = &argc;
460   pargs.argv  = &argv;
461   pargs.flags =  1;  /* Do not remove the args.  */
462   while (!no_more_options && optfile_parse (NULL, NULL, NULL, &pargs, opts))
463     {
464       switch (pargs.r_opt)
465         {
466         case oOutput:    opt.outfile = pargs.r.ret_str; break;
467         case oQuiet:     opt.quiet = 1; break;
468         case oDryRun:    opt.dry_run = 1; break;
469         case oRuntime:
470           opt.runtime = 1;
471           break;
472         case oVerbose:   opt.verbose++; break;
473         case oNoVerbose: opt.verbose = 0; break;
474         case oHomedir:   gnupg_set_homedir (pargs.r.ret_str); break;
475         case oNull:      opt.null = 1; break;
476
477         case aListDirs:
478         case aListComponents:
479         case aCheckPrograms:
480         case aListOptions:
481         case aChangeOptions:
482         case aCheckOptions:
483         case aApplyDefaults:
484         case aListConfig:
485         case aCheckConfig:
486         case aQuerySWDB:
487         case aReload:
488         case aLaunch:
489         case aKill:
490         case aCreateSocketDir:
491         case aRemoveSocketDir:
492           cmd = pargs.r_opt;
493           break;
494
495         default: pargs.err = 2; break;
496         }
497     }
498
499   if (log_get_errorcount (0))
500     exit (2);
501
502   /* Print a warning if an argument looks like an option.  */
503   if (!opt.quiet && !(pargs.flags & ARGPARSE_FLAG_STOP_SEEN))
504     {
505       int i;
506
507       for (i=0; i < argc; i++)
508         if (argv[i][0] == '-' && argv[i][1] == '-')
509           log_info (_("Note: '%s' is not considered an option\n"), argv[i]);
510     }
511
512   fname = argc ? *argv : NULL;
513
514   switch (cmd)
515     {
516     case aListComponents:
517     default:
518       /* List all components. */
519       gc_component_list_components (get_outfp (&outfp));
520       break;
521
522     case aCheckPrograms:
523       /* Check all programs. */
524       gc_check_programs (get_outfp (&outfp));
525       break;
526
527     case aListOptions:
528     case aChangeOptions:
529     case aCheckOptions:
530       if (!fname)
531         {
532           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
533           es_putc ('\n', es_stderr);
534           es_fputs (_("Need one component argument"), es_stderr);
535           es_putc ('\n', es_stderr);
536           exit (2);
537         }
538       else
539         {
540           int idx = gc_component_find (fname);
541           if (idx < 0)
542             {
543               es_fputs (_("Component not found"), es_stderr);
544               es_putc ('\n', es_stderr);
545               exit (1);
546             }
547           if (cmd == aCheckOptions)
548             gc_component_check_options (idx, get_outfp (&outfp), NULL);
549           else
550             {
551               gc_component_retrieve_options (idx);
552               if (gc_process_gpgconf_conf (NULL, 1, 0, NULL))
553                 exit (1);
554               if (cmd == aListOptions)
555                 gc_component_list_options (idx, get_outfp (&outfp));
556               else if (cmd == aChangeOptions)
557                 gc_component_change_options (idx, es_stdin, get_outfp (&outfp));
558             }
559         }
560       break;
561
562     case aLaunch:
563     case aKill:
564       if (!fname)
565         {
566           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
567           es_putc ('\n', es_stderr);
568           es_fputs (_("Need one component argument"), es_stderr);
569           es_putc ('\n', es_stderr);
570           exit (2);
571         }
572       else
573         {
574           /* Launch/Kill a given component.  */
575           int idx;
576
577           idx = gc_component_find (fname);
578           if (idx < 0)
579             {
580               es_fputs (_("Component not found"), es_stderr);
581               es_putc ('\n', es_stderr);
582               exit (1);
583             }
584           else if (cmd == aLaunch)
585             {
586               if (gc_component_launch (idx))
587                 exit (1);
588             }
589           else
590             {
591               /* We don't error out if the kill failed because this
592                  command should do nothing if the component is not
593                  running.  */
594               gc_component_kill (idx);
595             }
596         }
597       break;
598
599     case aReload:
600       if (!fname)
601         {
602           /* Reload all.  */
603           gc_component_reload (-1);
604         }
605       else
606         {
607           /* Reload given component.  */
608           int idx;
609
610           idx = gc_component_find (fname);
611           if (idx < 0)
612             {
613               es_fputs (_("Component not found"), es_stderr);
614               es_putc ('\n', es_stderr);
615               exit (1);
616             }
617           else
618             {
619               gc_component_reload (idx);
620             }
621         }
622       break;
623
624     case aListConfig:
625       if (gc_process_gpgconf_conf (fname, 0, 0, get_outfp (&outfp)))
626         exit (1);
627       break;
628
629     case aCheckConfig:
630       if (gc_process_gpgconf_conf (fname, 0, 0, NULL))
631         exit (1);
632       break;
633
634     case aApplyDefaults:
635       if (fname)
636         {
637           es_fprintf (es_stderr, _("usage: %s [options] "), GPGCONF_NAME);
638           es_putc ('\n', es_stderr);
639           es_fputs (_("No argument allowed"), es_stderr);
640           es_putc ('\n', es_stderr);
641           exit (2);
642         }
643       gc_component_retrieve_options (-1);
644       if (gc_process_gpgconf_conf (NULL, 1, 1, NULL))
645         exit (1);
646       break;
647
648     case aListDirs:
649       /* Show the system configuration directories for gpgconf.  */
650       get_outfp (&outfp);
651       list_dirs (outfp, argc? argv : NULL);
652       break;
653
654     case aQuerySWDB:
655       /* Query the software version database.  */
656       if (!fname || argc > 2)
657         {
658           es_fprintf (es_stderr, "usage: %s --query-swdb NAME [VERSION]\n",
659                       GPGCONF_NAME);
660           exit (2);
661         }
662       get_outfp (&outfp);
663       query_swdb (outfp, fname, argc > 1? argv[1] : NULL);
664       break;
665
666     case aCreateSocketDir:
667       {
668         char *socketdir;
669         unsigned int flags;
670
671         /* Make sure that the top /run/user/UID/gnupg dir has been
672          * created.  */
673         gnupg_socketdir ();
674
675         /* Check the /var/run dir.  */
676         socketdir = _gnupg_socketdir_internal (1, &flags);
677         if ((flags & 64) && !opt.dry_run)
678           {
679             /* No sub dir - create it. */
680             if (gnupg_mkdir (socketdir, "-rwx"))
681               gc_error (1, errno, "error creating '%s'", socketdir);
682             /* Try again.  */
683             socketdir = _gnupg_socketdir_internal (1, &flags);
684           }
685
686         /* Give some info.  */
687         if ( (flags & ~32) || opt.verbose || opt.dry_run)
688           {
689             log_info ("socketdir is '%s'\n", socketdir);
690             if ((flags &   1)) log_info ("\tgeneral error\n");
691             if ((flags &   2)) log_info ("\tno /run/user dir\n");
692             if ((flags &   4)) log_info ("\tbad permissions\n");
693             if ((flags &   8)) log_info ("\tbad permissions (subdir)\n");
694             if ((flags &  16)) log_info ("\tmkdir failed\n");
695             if ((flags &  32)) log_info ("\tnon-default homedir\n");
696             if ((flags &  64)) log_info ("\tno such subdir\n");
697             if ((flags & 128)) log_info ("\tusing homedir as fallback\n");
698           }
699
700         if ((flags & ~32) && !opt.dry_run)
701           gc_error (1, 0, "error creating socket directory");
702
703         xfree (socketdir);
704       }
705       break;
706
707     case aRemoveSocketDir:
708       {
709         char *socketdir;
710         unsigned int flags;
711
712         /* Check the /var/run dir.  */
713         socketdir = _gnupg_socketdir_internal (1, &flags);
714         if ((flags & 128))
715           log_info ("ignoring request to remove non /run/user socket dir\n");
716         else if (opt.dry_run)
717           ;
718         else if (rmdir (socketdir))
719           gc_error (1, errno, "error removing '%s'", socketdir);
720
721         xfree (socketdir);
722       }
723       break;
724
725     }
726
727   if (outfp != es_stdout)
728     if (es_fclose (outfp))
729       gc_error (1, errno, "error closing '%s'", opt.outfile);
730
731   return 0;
732 }