bugreport: report configs from safelist
Subsystems (2)
cover bugreport: report configs from safelist
Some configs are useful to know when trying to diagnose or reproduce an issue. However, other configs are sensitive and should not be shared with others. Finally, many tools which wrap or augment Git also use Git's config system, and so may store sensitive information which Git is not aware of. Therefore, it makes sense for git-bugreport to gather configs which Git developers have decided are safe and useful - a safelist - but no other configs which the user may have. This list of safe configs can be expanded over time and is generated from documentation.
This series is based on 'master' but was cherry-picked from quite some time ago, so it's possible there's some anachronism I missed reviewing it myself :)
- Emily
Emily Shaffer (2):
bugreport: generate config safelist based on docs
bugreport: add config values from safelist
.gitignore | 1 + Documentation/asciidoc.conf | 9 ++++ Documentation/asciidoctor-extensions.rb | 7 ++++ Documentation/config/sendemail.txt | 56 ++++++++++++------------- Documentation/git-bugreport.txt | 1 + Makefile | 9 ++++ bugreport.c | 28 +++++++++++++ generate-bugreport-config-safelist.sh | 18 ++++++++ 8 files changed, 101 insertions(+), 28 deletions(-) create mode 100755 generate-bugreport-config-safelist.sh
Signature · 1 line
2.27.0.111.gc72c7da667-goog
PATCH 1/2 bugreport: generate config safelist based on docs
Add a new step to the build to generate a safelist of git-config variables which are appropriate to include in the output of git-bugreport. New variables can be added to the safelist by annotating their documentation in Documentation/config with the "annotate" macro, which is a no-op in AsciiDoc and AsciiDoctor.
Some configs are private in nature, and can contain remote URLs, passwords, or other sensitive information. In the event that a user doesn't notice their information while reviewing a bugreport, that user may leak their credentials to other individuals, mailing lists, or bug tracking tools inadvertently. Heuristic blocklisting of configuration keys is imperfect and prone to false negatives; given the nature of the information which can be leaked, a safelist is more reliable.
However, it's possible that in some situations, an organization may be less concerned with privacy of things like remote URLs and branch names, and more concerned with ease of diagnosis for their support staff. In those cases, it may make more sense for that organization to modify the code to use a blocklist. To that end, we should try to mark configs which are definitely safe, and configs which are definitely unsafe, and leave blank configs which are somewhere in between. To mark a config as safe, add "annotate:bugreport[include]" to the corresponding line in the config documentation; to mark it as unsafe, add "annotate:bugreport[exclude]" instead.
Generating bugreport-config-safelist.h at build time by grepping the documentation for this new macro helps us prevent staleness. The macro itself is a no-op and should not alter the appearance of the documentation in either AsciiDoc or AsciiDoctor, confirmable by running:
cd Documentation ./doc-diff --asciidoctor HEAD^ HEAD ./doc-diff --asciidoc HEAD^ HEAD
Diffing the rendered HTML shows that only inline comments were added, which shouldn't be a problem.
Additionally, add annotations to the sendemail config documentation in order to demonstrate a proof of concept.
--- .gitignore | 1 + Documentation/asciidoc.conf | 9 ++++ Documentation/asciidoctor-extensions.rb | 7 ++++ Documentation/config/sendemail.txt | 56 ++++++++++++------------- Makefile | 7 ++++ generate-bugreport-config-safelist.sh | 18 ++++++++ 6 files changed, 70 insertions(+), 28 deletions(-) create mode 100755 generate-bugreport-config-safelist.sh
.gitignore +1 -0
@@ -191,6 +191,7 @@ /gitweb/static/gitweb.min.* /config-list.h /command-list.h +/bugreport-config-safelist.h *.tar.gz *.dsc *.deb
Documentation/asciidoc.conf +9 -0
@@ -6,9 +6,14 @@ # # Show Git link as: <command>(<section>); if section is defined, else just show # the command. +# +# The annotate macro does nothing as far as rendering is +# concerned -- we just grep for it in the sources to populate +# things like the bugreport safelist. [macros] (?su)[\\]?(?P<name>linkgit):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= +(?su)[\\]?(?P<name>annotate):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= [attributes] asterisk=*
@@ -28,6 +33,8 @@ ifdef::backend-docbook[] {0#<citerefentry>} {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} {0#</citerefentry>} +[annotate-inlinemacro] +{0#} endif::backend-docbook[] ifdef::backend-docbook[]
@@ -75,4 +82,6 @@ ifdef::backend-xhtml11[] git-relative-html-prefix= [linkgit-inlinemacro] <a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a> +[annotate-inlinemacro] +<!-- --> endif::backend-xhtml11[]
Documentation/asciidoctor-extensions.rb +7 -0
@@ -39,10 +39,17 @@ module Git output end end + + class AnnotateProcessor < Asciidoctor::Extensions::InlineMacroProcessor + def process(parent, target, attrs) + "" + end + end end end Asciidoctor::Extensions.register do inline_macro Git::Documentation::LinkGitProcessor, :linkgit postprocessor Git::Documentation::DocumentPostProcessor + inline_macro Git::Documentation::AnnotateProcessor, :annotate end
Documentation/config/sendemail.txt +28 -28
83 lines not on this page · raw message
Makefile +7 -0
@@ -810,6 +810,7 @@ VCSSVN_LIB = vcs-svn/lib.a GENERATED_H += config-list.h GENERATED_H += command-list.h +GENERATED_H += bugreport-config-safelist.h LIB_H := $(sort $(patsubst ./%,%,$(shell git ls-files '*.h' ':!t/' ':!Documentation/' 2>/dev/null || \ $(FIND) . \
@@ -2164,6 +2165,12 @@ command-list.h: $(wildcard Documentation/git*.txt) Documentation/*config.txt Doc $(patsubst %,--exclude-program %,$(EXCLUDED_PROGRAMS)) \ command-list.txt >$@+ && mv $@+ $@ +bugreport-config-safelist.h: generate-bugreport-config-safelist.sh + +bugreport-config-safelist.h: Documentation/config/*.txt + $(QUIET_GEN)$(SHELL_PATH) ./generate-bugreport-config-safelist.sh \ + >$@+ && mv $@+ $@ + SCRIPT_DEFINES = $(SHELL_PATH_SQ):$(DIFF_SQ):$(GIT_VERSION):\ $(localedir_SQ):$(NO_CURL):$(USE_GETTEXT_SCHEME):$(SANE_TOOL_PATH_SQ):\ $(gitwebdir_SQ):$(PERL_PATH_SQ):$(SANE_TEXT_GREP):$(PAGER_ENV):\
generate-bugreport-config-safelist.sh new file +18 -0
@@ -0,0 +1,18 @@ +#!/bin/sh + +cat <<"EOF" +/* Automatically generated by bugreport-generate-config-safelist.sh */ + + +static const char *bugreport_config_safelist[] = { +EOF + +# cat all regular files in Documentation/config +find Documentation/config -type f -exec cat {} \; | +# print the command name which matches the annotate-bugreport macro +sed -n 's/^\([^ ]*\) *annotate:bugreport\[include\].* ::$/ "\1",/p' | + sort + +cat <<"EOF" +}; +EOF
Signature · 1 line
2.27.0.111.gc72c7da667-goog
Re: [PATCH 1/2] bugreport: generate config safelist based on docs
Quoted 4 lines · Emily Shaffer
... To mark a config as safe,
add "annotate:bugreport[include]" to the corresponding line in the config documentation; to mark it as unsafe, add "annotate:bugreport[exclude]" instead.
Hmph,...
Documentation/config/sendemail.txt sendemail.smtpsslcertpath:: · line 18
Quoted 11 lines
Documentation/config/sendemail.txt +2
-2-sendemail.smtpEncryption:: +sendemail.smtpEncryption annotate:bugreport[include] :: See linkgit:git-send-email[1] for description. Note that this setting is not subject to the 'identity' mechanism.@@ -15,7 +15,7 @@ sendemail.smtpsslcertpath:: Path to ca-certificates (either a directory or a single file). Set it to an empty string to disable certificate verification. -sendemail.<identity>.*:: +sendemail.<identity>.* annotate:bugreport[exclude] ::
So "sendemail.git-devel.cc" is not included due to [exclude] here, but ...
Documentation/config/sendemail.txt sendemail.<identity>.*:: · line 28
Quoted 3 lines
Documentation/config/sendemail.txt +3
-0+sendemail.annotate annotate:bugreport[include] :: +sendemail.bcc annotate:bugreport[include] :: +sendemail.cc annotate:bugreport[include] ::
... "sendemail.cc" that is a fallback value for other "sendemail.*.cc" is included?
Quoted 6 lines
generate-bugreport-config-safelist.sh new file +5
-0+++ b/generate-bugreport-config-safelist.sh@@ -0,0 +1,18 @@ +#!/bin/sh + +cat <<"EOF" +/* Automatically generated by bugreport-generate-config-safelist.sh */
generate-bugreport-config-safelist.sh line 14
Quoted 10 lines
generate-bugreport-config-safelist.sh new file +10
-0+ + +static const char *bugreport_config_safelist[] = { +EOF + +# cat all regular files in Documentation/config +find Documentation/config -type f -exec cat {} \; | +# print the command name which matches the annotate-bugreport macro +sed -n 's/^\([^ ]*\) *annotate:bugreport\[include\].* ::$/ "\1",/p' | + sort
We just care about "include" entries, so it does not matter whether we mark entries with [exclude] or not anyway?
Puzzled...
Re: [PATCH 1/2] bugreport: generate config safelist based on docs
Quoted 19 lines · Junio C Hamano
Quoted 4 lines · Emily Shaffer
... To mark a config as safe,
add "annotate:bugreport[include]" to the corresponding line in the config documentation; to mark it as unsafe, add "annotate:bugreport[exclude]" instead.Hmph,...
Quoted 9 lines
Documentation/config/sendemail.txt +1
-1-sendemail.smtpEncryption:: +sendemail.smtpEncryption annotate:bugreport[include] :: See linkgit:git-send-email[1] for description. Note that this setting is not subject to the 'identity' mechanism.@@ -15,7 +15,7 @@ sendemail.smtpsslcertpath:: Path to ca-certificates (either a directory or a single file). Set it to an empty string to disable certificate verification.
Quoted 5 lines
Documentation/config/sendemail.txt sendemail.smtpsslcertpath:: · line 18
Quoted 2 lines
Documentation/config/sendemail.txt +1
-1-sendemail.<identity>.*:: +sendemail.<identity>.* annotate:bugreport[exclude] ::So "sendemail.git-devel.cc" is not included due to [exclude] here, but ...
Hm, I can change this for the example, but I think it may still not be included correctly because of the wildcard. We had talked about whether to include wildcarded options like this in the past too - I think that's part of why I removed these couple patches from the initial bugreport series.
If this line becomes included, then what we're really searching for is anything matching "sendemail.*.*"; is this syntax regular enough to count on in the generator script? Could the generator script do some magic to turn <foo> and * into valid regex in the generated header and then use that regex during the config parse?
Maybe using regex is overkill and I should just check for "*" during the parse. Or maybe there's already a library to use. I'll dig into this some today. Thanks for pointing it out.
Quoted 28 lines
Documentation/config/sendemail.txt sendemail.<identity>.*:: · line 28
Quoted 4 lines
Documentation/config/sendemail.txt +3
-0+sendemail.annotate annotate:bugreport[include] :: +sendemail.bcc annotate:bugreport[include] :: +sendemail.cc annotate:bugreport[include] ::... "sendemail.cc" that is a fallback value for other "sendemail.*.cc" is included?
Quoted 6 lines
generate-bugreport-config-safelist.sh new file +5
-0+++ b/generate-bugreport-config-safelist.sh@@ -0,0 +1,18 @@ +#!/bin/sh + +cat <<"EOF" +/* Automatically generated by bugreport-generate-config-safelist.sh */generate-bugreport-config-safelist.sh line 14
Quoted 10 lines
generate-bugreport-config-safelist.sh new file +10
-0+ + +static const char *bugreport_config_safelist[] = { +EOF + +# cat all regular files in Documentation/config +find Documentation/config -type f -exec cat {} \; | +# print the command name which matches the annotate-bugreport macro +sed -n 's/^\([^ ]*\) *annotate:bugreport\[include\].* ::$/ "\1",/p' | + sortWe just care about "include" entries, so it does not matter whether we mark entries with [exclude] or not anyway?
Quoted 1 line
Puzzled...
I wonder where I forgot to include the context for encouraging "exclude". My thinking was that some organizations might have a lower expectation of employee privacy, and therefore opt to use a blocklist rather than a safelist for bug reports included internally. I suppose I was thinking then that organization only needs to carry a patch to invert the generator script, and not have to comb through all the configs they care or don't care about themselves.
But as I'm revisiting this, it seems like that means a user who works for Big Brother Corp but is told to "file that bug upstream" could then leak their confidential info by accident, not realizing their git-bugreport is using a wider net than upstream wants.
What do others think?
- Emily
PATCH 2/2 bugreport: add config values from safelist
In reply to Emily ShafferTeach bugreport to gather the values of config options which are present in 'bugreport-config-safelist.h', and show their origin scope.
Many config options are sensitive, and many Git add-ons use config options which git-core does not know about; it is better only to gather config options which we know to be safe, rather than excluding options which we know to be unsafe.
Rather than including the path to someone's config, which can reveal filesystem layout and project names, just name the scope (e.g. system, global, local) of the config source.
--- Documentation/git-bugreport.txt | 1 + Makefile | 2 ++ bugreport.c | 28 ++++++++++++++++++++++++++++ 3 files changed, 31 insertions(+)
Documentation/git-bugreport.txt +1 -0
@@ -30,6 +30,7 @@ The following information is captured automatically: - Compiler-specific info string - A list of enabled hooks - $SHELL + - Selected config values This tool is invoked via the typical Git setup process, which means that in some cases, it might not be able to launch - for example, if a relevant config file
Makefile +2 -0
@@ -2132,6 +2132,8 @@ git$X: git.o GIT-LDFLAGS $(BUILTIN_OBJS) $(GITLIBS) help.sp help.s help.o: command-list.h +bugreport.sp bugreport.s bugreport.o: bugreport-config-safelist.h + builtin/help.sp builtin/help.s builtin/help.o: config-list.h GIT-PREFIX builtin/help.sp builtin/help.s builtin/help.o: EXTRA_CPPFLAGS = \ '-DGIT_HTML_PATH="$(htmldir_relative_SQ)"' \
bugreport.c +28 -0
@@ -4,6 +4,8 @@#include "help.h" #include "compat/compiler.h" #include "run-command.h" +#include "config.h" +#include "bugreport-config-safelist.h" static void get_system_info (struct strbuf *sys_info)
@@ -86,6 +88,29 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)strbuf_addf (hook_info,"%s\n" , hook[i]); } +static void get_safelisted_config (struct strbuf *config_info) +{ +size_t idx; +struct string_list_item *it =NULL ; +struct key_value_info *kv_info =NULL ; + +for (idx =0 ; idx <ARRAY_SIZE (bugreport_config_safelist); idx++) { +const struct string_list *list = +git_config_get_value_multi (bugreport_config_safelist[idx]); + +if (!list) +continue ; + +strbuf_addf (config_info,"%s:\n" , bugreport_config_safelist[idx]); +for_each_string_list_item (it, list) { + kv_info = it->util; +strbuf_addf (config_info," %s (%s)\n" , it->string, + kv_info ?config_scope_name (kv_info->scope) + :_ ("source unknown" )); + } + } +} +static const char *const bugreport_usage[] = {N_ ("git bugreport [-o|--output-directory <file>] [-s|--suffix <format>]" ),NULL
@@ -172,6 +197,9 @@ int cmd_main(int argc, const char **argv)get_header (&buffer,_ ("Enabled Hooks" ));get_populated_hooks (&buffer, nongit_ok); +get_header (&buffer,_ ("Safelisted Config Info" )); +get_safelisted_config (&buffer); +/* fopen doesn't offer us an O_EXCL alternative, except with glibc. */ report =open (report_path.buf,O_CREAT |O_EXCL |O_WRONLY ,0666 );
Signature · 1 line
2.27.0.111.gc72c7da667-goog