security-and-privacy/gnupg
security-and-privacy/gnupg
1
0
Fork 0
mirror of git://git.gnupg.org/gnupg.git synced 2024-12-22 10:19:57 +01:00
Code Activity

gpgconf: Change layout of the gpgconf -X output.

Browse Source 
* tools/gpgconf.c (list_dirs): Change the config mode output.
(my_copy_file): Adjust output for org-mode style.
(show_configs_one_file): Ditto.
(show_other_registry_entries): Ditto.
(show_registry_entries_from_file): Ditto.
(show_configs): Ditto.
This commit is contained in:
Werner Koch 2024-04-04 15:09:12 +02:00
parent 759adb2493
commit 98e287ba6d
No known key found for this signature in database
GPG Key ID: E3FDFF218E45B72B
1 changed files with 71 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
tools/gpgconf.c
View File

@ -288,6 +288,8 @@ list_dirs (estream_t fp, char **names, int show_config_mode)
const char *s; const char *s;
gpg_error_t err; gpg_error_t err;
if (show_config_mode)
es_fprintf (fp, "#+begin_example\n");
for (idx = 0; idx < DIM (list); idx++) for (idx = 0; idx < DIM (list); idx++)
{ {
s = list[idx].fnc (); s = list[idx].fnc ();
@ -302,12 +304,15 @@ list_dirs (estream_t fp, char **names, int show_config_mode)
if (!list[idx].name) if (!list[idx].name)
; ;
else if (!names) else if (!names)
es_fprintf (fp, "%s:%s\n", list[idx].name, gc_percent_escape (s)); es_fprintf (fp, "%s%s:%s\n", show_config_mode? " ":"",
list[idx].name, gc_percent_escape (s));
else else
{ {
for (j=0; names[j]; j++) for (j=0; names[j]; j++)
if (!strcmp (names[j], list[idx].name)) if (!strcmp (names[j], list[idx].name))
{ {
if (show_config_mode)
es_fputs (" ", fp);
es_fputs (s, fp); es_fputs (s, fp);
es_putc (opt.null? '\0':'\n', fp); es_putc (opt.null? '\0':'\n', fp);
} }
@ -326,12 +331,14 @@ list_dirs (estream_t fp, char **names, int show_config_mode)
; /* No such file/ No such device or address - this is okay. */ ; /* No such file/ No such device or address - this is okay. */
else else
es_fprintf (fp, es_fprintf (fp,
"### Warning: error reading existing file '%s': %s\n", "# Warning: error reading existing file '%s': %s\n",
s, gpg_strerror (err)); s, gpg_strerror (err));
} }
xfree (tmp); xfree (tmp);
} }
if (show_config_mode)
es_fprintf (fp, "#+end_example\n");
#ifdef HAVE_W32_SYSTEM #ifdef HAVE_W32_SYSTEM
@ -362,7 +369,7 @@ list_dirs (estream_t fp, char **names, int show_config_mode)
es_fflush (fp); es_fflush (fp);
if (show_config_mode) if (show_config_mode)
es_fprintf (fp, "\n" es_fprintf (fp, "\n"
"### Note: homedir taken from registry key %s%s\\%s:%s\n" "Note: homedir taken from registry key %s%s\\%s:%s\n"
"\n", "\n",
hkcu?"HKCU":"", hklm?"HKLM":"", hkcu?"HKCU":"", hklm?"HKLM":"",
GNUPG_REGISTRY_DIR, "HomeDir"); GNUPG_REGISTRY_DIR, "HomeDir");
@ -380,7 +387,7 @@ list_dirs (estream_t fp, char **names, int show_config_mode)
es_fflush (fp); es_fflush (fp);
if (show_config_mode) if (show_config_mode)
es_fprintf (fp, "\n" es_fprintf (fp, "\n"
"### Note: registry %s without value in HKCU or HKLM\n" "Note: registry %s without value in HKCU or HKLM\n"
"\n", GNUPG_REGISTRY_DIR); "\n", GNUPG_REGISTRY_DIR);
else else
log_info ("Warning: registry key (%s) without value in HKCU or HKLM\n", log_info ("Warning: registry key (%s) without value in HKCU or HKLM\n",
@ -1185,14 +1192,14 @@ show_version_gnupg (estream_t fp, const char *prefix)
gpgrt_strusage (13), BUILD_REVISION, prefix, gpgrt_strusage (17)); gpgrt_strusage (13), BUILD_REVISION, prefix, gpgrt_strusage (17));
/* Show the GnuPG VS-Desktop version in --show-configs mode */ /* Show the GnuPG VS-Desktop version in --show-configs mode */
if (prefix && *prefix == '#') if (prefix && *prefix)
{ {
fname = make_filename (gnupg_bindir (), NULL); fname = make_filename (gnupg_bindir (), NULL);
n = strlen (fname); n = strlen (fname);
if (n > 10 && (!ascii_strcasecmp (fname + n - 10, "/GnuPG/bin") if (n > 10 && (!ascii_strcasecmp (fname + n - 10, "/GnuPG/bin")
|| !ascii_strcasecmp (fname + n - 10, "\\GnuPG\\bin"))) || !ascii_strcasecmp (fname + n - 10, "\\GnuPG\\bin")))
{ {
/* Append VERSION to the ../../ direcory. Note that VERSION /* Append VERSION to the ../../ directory. Note that VERSION
* is only 7 bytes and thus fits. */ * is only 7 bytes and thus fits. */
strcpy (fname + n - 9, "VERSION"); strcpy (fname + n - 9, "VERSION");
verfp = es_fopen (fname, "r"); verfp = es_fopen (fname, "r");
@ -1376,7 +1383,14 @@ my_copy_file (estream_t src, estream_t dst, strlist_t *listp)
while ((length = es_read_line (src, &line, &line_len, NULL)) > 0) while ((length = es_read_line (src, &line, &line_len, NULL)) > 0)
{ {
/* Strip newline and carriage return, if present. */ /* Prefix each line with two spaces but use a comma if the line
* starts with a special org-mode character. */
if (*line == '*' || (*line == '#' && line[1] == '+'))
es_fputc (',', dst);
else
es_fputc (' ', dst);
es_fputc (' ', dst);
written = gpgrt_fwrite (line, 1, length, dst); written = gpgrt_fwrite (line, 1, length, dst);
if (written != length) if (written != length)
return gpg_error_from_syserror (); return gpg_error_from_syserror ();
@ -1444,21 +1458,19 @@ show_configs_one_file (const char *fname, int global, estream_t outfp,
if (!fp) if (!fp)
{ {
err = gpg_error_from_syserror (); err = gpg_error_from_syserror ();
es_fprintf (outfp, "###\n### %s config \"%s\": %s\n###\n", if (gpg_err_code (err) != GPG_ERR_ENOENT)
global? "global":"local", fname, es_fprintf (outfp, "** %s config \"%s\": %s\n",
(gpg_err_code (err) == GPG_ERR_ENOENT)? global? "global":"local", fname, gpg_strerror (err));
"not installed" : gpg_strerror (err));
} }
else else
{ {
es_fprintf (outfp, "###\n### %s config \"%s\"\n###\n", es_fprintf (outfp, "** %s config \"%s\"\n#+begin_src\n",
global? "global":"local", fname); global? "global":"local", fname);
es_fprintf (outfp, CUTLINE_FMT, "start");
err = my_copy_file (fp, outfp, listp); err = my_copy_file (fp, outfp, listp);
es_fprintf (outfp, "\n#+end_src\n");
if (err) if (err)
log_error ("error copying file \"%s\": %s\n", log_error ("Error copying file \"%s\": %s\n",
fname, gpg_strerror (err)); fname, gpg_strerror (err));
es_fprintf (outfp, CUTLINE_FMT, "end--");
es_fclose (fp); es_fclose (fp);
} }
} }
@ -1533,7 +1545,7 @@ show_other_registry_entries (estream_t outfp)
if (names[idx].group != group) if (names[idx].group != group)
{ {
group = names[idx].group; group = names[idx].group;
es_fprintf (outfp, "###\n### %s related:\n", es_fprintf (outfp, "\n%s related:\n",
group == 1 ? "GnuPG Desktop" : group == 1 ? "GnuPG Desktop" :
group == 2 ? "Outlook" : group == 2 ? "Outlook" :
group == 3 ? "\\Software\\GNU\\GpgOL" group == 3 ? "\\Software\\GNU\\GpgOL"
@ -1541,16 +1553,15 @@ show_other_registry_entries (estream_t outfp)
} }
if (group == 3) if (group == 3)
es_fprintf (outfp, "### %s=%s%s\n", names[idx].name, value, es_fprintf (outfp, " %s=%s%s\n", names[idx].name, value,
from_hklm? " [hklm]":""); from_hklm? " [hklm]":"");
else else
es_fprintf (outfp, "### %s\n### ->%s<-%s\n", name, value, es_fprintf (outfp, " %s\n ->%s<-%s\n", name, value,
from_hklm? " [hklm]":""); from_hklm? " [hklm]":"");
xfree (value); xfree (value);
} }
es_fprintf (outfp, "###\n");
xfree (namebuf); xfree (namebuf);
} }
@ -1601,10 +1612,10 @@ show_registry_entries_from_file (estream_t outfp)
if (!any) if (!any)
{ {
any = 1; any = 1;
es_fprintf (outfp, "### Taken from gpgconf.rnames:\n"); es_fprintf (outfp, "Taken from gpgconf.rnames:\n");
} }
es_fprintf (outfp, "### %s\n### ->%s<-%s\n", line, value, es_fprintf (outfp, " %s\n ->%s<-%s\n", line, value,
from_hklm? " [hklm]":""); from_hklm? " [hklm]":"");
} }
@ -1615,8 +1626,6 @@ show_registry_entries_from_file (estream_t outfp)
} }
leave: leave:
if (any)
es_fprintf (outfp, "###\n");
xfree (value); xfree (value);
xfree (line); xfree (line);
es_fclose (fp); es_fclose (fp);
@ -1643,18 +1652,21 @@ show_configs (estream_t outfp)
gnupg_dir_t dir; gnupg_dir_t dir;
gnupg_dirent_t dir_entry; gnupg_dirent_t dir_entry;
size_t n; size_t n;
int any; int any, anywarn;
strlist_t list = NULL; strlist_t list = NULL;
strlist_t sl; strlist_t sl;
const char *s; const char *s;
int got_gpgconfconf = 0; int got_gpgconfconf = 0;
es_fprintf (outfp, "### Dump of all standard config files\n"); es_fprintf (outfp, "# gpgconf -X invoked %s%*s-*- org -*-\n\n",
show_version_gnupg (outfp, "### "); isotimestamp (time (NULL)), 28, "");
es_fprintf (outfp, "### Libgcrypt %s\n", gcry_check_version (NULL)); es_fprintf (outfp, "* General information\n");
es_fprintf (outfp, "### GpgRT %s\n", gpg_error_check_version (NULL)); es_fprintf (outfp, "** Versions\n");
show_version_gnupg (outfp, " ");
es_fprintf (outfp, " Libgcrypt %s\n", gcry_check_version (NULL));
es_fprintf (outfp, " GpgRT %s\n", gpg_error_check_version (NULL));
#ifdef HAVE_W32_SYSTEM #ifdef HAVE_W32_SYSTEM
es_fprintf (outfp, "### Codepages:"); es_fprintf (outfp, " Codepages:");
if (GetConsoleCP () != GetConsoleOutputCP ()) if (GetConsoleCP () != GetConsoleOutputCP ())
es_fprintf (outfp, " %u/%u", GetConsoleCP (), GetConsoleOutputCP ()); es_fprintf (outfp, " %u/%u", GetConsoleCP (), GetConsoleOutputCP ());
else else
@ -1662,16 +1674,19 @@ show_configs (estream_t outfp)
es_fprintf (outfp, " %u", GetACP ()); es_fprintf (outfp, " %u", GetACP ());
es_fprintf (outfp, " %u\n", GetOEMCP ()); es_fprintf (outfp, " %u\n", GetOEMCP ());
#endif #endif
es_fprintf (outfp, "###\n\n"); es_fprintf (outfp, "\n\n");
es_fprintf (outfp, "** Directories\n");
list_dirs (outfp, NULL, 1); list_dirs (outfp, NULL, 1);
es_fprintf (outfp, "\n"); es_fprintf (outfp, "\n");
es_fprintf (outfp, "** Environment\n#+begin_example\n");
for (idx=0; idx < DIM(envvars); idx++) for (idx=0; idx < DIM(envvars); idx++)
if ((s = getenv (envvars[idx]))) if ((s = getenv (envvars[idx])))
es_fprintf (outfp, "%s=%s\n", envvars[idx], s); es_fprintf (outfp, "%s=%s\n", envvars[idx], s);
es_fprintf (outfp, "\n"); es_fprintf (outfp, "#+end_example\n");
es_fprintf (outfp, "* Config files\n");
fname = make_filename (gnupg_sysconfdir (), "gpgconf.conf", NULL); fname = make_filename (gnupg_sysconfdir (), "gpgconf.conf", NULL);
if (!gnupg_access (fname, F_OK)) if (!gnupg_access (fname, F_OK))
{ {
@ -1693,6 +1708,7 @@ show_configs (estream_t outfp)
} }
/* Print the encountered registry values and envvars. */ /* Print the encountered registry values and envvars. */
es_fprintf (outfp, "* Other info\n");
if (list) if (list)
{ {
any = 0; any = 0;
@ -1703,20 +1719,21 @@ show_configs (estream_t outfp)
{ {
any = 1; any = 1;
es_fprintf (outfp, es_fprintf (outfp,
"###\n" "** List of encountered environment variables\n"
"### List of encountered environment variables:\n"); "#+begin_example\n");
} }
if ((s = getenv (sl->d))) if ((s = getenv (sl->d)))
es_fprintf (outfp, "### %-12s ->%s<-\n", sl->d, s); es_fprintf (outfp, " %-12s ->%s<-\n", sl->d, s);
else else
es_fprintf (outfp, "### %-12s [not set]\n", sl->d); es_fprintf (outfp, " %-12s [not set]\n", sl->d);
} }
if (any) if (any)
es_fprintf (outfp, "###\n"); es_fprintf (outfp, "#+end_example\n");
} }
#ifdef HAVE_W32_SYSTEM #ifdef HAVE_W32_SYSTEM
es_fprintf (outfp, "###\n### Registry entries:\n"); es_fprintf (outfp, "** Registry entries\n");
es_fprintf (outfp, "#+begin_example\n");
any = 0; any = 0;
if (list) if (list)
{ {
@ -1729,33 +1746,31 @@ show_configs (estream_t outfp)
if (!any) if (!any)
{ {
any = 1; any = 1;
es_fprintf (outfp, "###\n### Encountered in config files:\n"); es_fprintf (outfp, "Encountered in config files:\n");
} }
if ((p = read_w32_reg_string (sl->d, &from_hklm))) if ((p = read_w32_reg_string (sl->d, &from_hklm)))
es_fprintf (outfp, "### %s ->%s<-%s\n", sl->d, p, es_fprintf (outfp, " %s ->%s<-%s\n", sl->d, p,
from_hklm? " [hklm]":""); from_hklm? " [hklm]":"");
else else
es_fprintf (outfp, "### %s [not set]\n", sl->d); es_fprintf (outfp, " %s [not set]\n", sl->d);
xfree (p); xfree (p);
} }
} }
if (!any)
es_fprintf (outfp, "###\n");
show_other_registry_entries (outfp); show_other_registry_entries (outfp);
show_registry_entries_from_file (outfp); show_registry_entries_from_file (outfp);
es_fprintf (outfp, "#+end_example\n");
#endif /*HAVE_W32_SYSTEM*/ #endif /*HAVE_W32_SYSTEM*/
free_strlist (list); free_strlist (list);
any = 0;
/* Additional warning. */ /* Additional warning. */
anywarn = 0;
if (got_gpgconfconf) if (got_gpgconfconf)
{ {
anywarn = 1;
es_fprintf (outfp, "* Warnings\n");
es_fprintf (outfp, es_fprintf (outfp,
"###\n" "- Legacy config file \"gpgconf.conf\" found\n");
"### Warning: legacy config file \"gpgconf.conf\" found\n");
any = 1;
} }
/* Check for uncommon files in the home directory. */ /* Check for uncommon files in the home directory. */
@ -1768,6 +1783,7 @@ show_configs (estream_t outfp)
return; return;
} }
any = 0;
while ((dir_entry = gnupg_readdir (dir))) while ((dir_entry = gnupg_readdir (dir)))
{ {
for (idx = 0; idx < DIM (names); idx++) for (idx = 0; idx < DIM (names); idx++)
@ -1777,19 +1793,22 @@ show_configs (estream_t outfp)
&& dir_entry->d_name[n] == '-' && dir_entry->d_name[n] == '-'
&& ascii_strncasecmp (dir_entry->d_name, "gpg.conf-1", 10)) && ascii_strncasecmp (dir_entry->d_name, "gpg.conf-1", 10))
{ {
if (!anywarn)
{
anywarn = 1;
es_fprintf (outfp, "* Warnings\n");
}
if (!any) if (!any)
{ {
any = 1; any = 1;
es_fprintf (outfp, es_fprintf (outfp,
"###\n" "- Suspicious files in \"%s\":\n",
"### Warning: suspicious files in \"%s\":\n",
gnupg_homedir ()); gnupg_homedir ());
} }
es_fprintf (outfp, "### %s\n", dir_entry->d_name); es_fprintf (outfp, " - %s\n", dir_entry->d_name);
} }
} }
} }
if (any)
es_fprintf (outfp, "###\n");
gnupg_closedir (dir); gnupg_closedir (dir);
es_fprintf (outfp, "# eof #\n");
} }