git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v3 2/9] bugreport: generate config whitelist based on docs

From
Emily Shaffer <emilyshaffer@google.com>
Date
Oct 25, 2019, 02:51 UTC
Message-ID
<20191025025129.250049-3-emilyshaffer@google.com>
In-Reply-To
<20191025025129.250049-1-emilyshaffer@google.com>

Add a new step to the build to generate a whitelist of git-config variables which are appropriate to include in the output of git-bugreport. New variables can be added to the whitelist by annotating their documentation in Documentation/config with the line "// bugreport-include".

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 blacklisting of configuration keys is imperfect and prone to false negatives; given the nature of the information which can be leaked, a whitelist is more reliable.

In order to prevent staleness of the whitelist, add a mechanism to generate the whitelist from annotations in the config documentation, where contributors are already used to documenting their new config keys.

Additionally, add annotations to the sendemail config documentation in order to demonstrate a proof of concept.

Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
---
 .gitignore                             |  1 +
 Documentation/config/sendemail.txt     | 68 +++++++++++++-------------
 Makefile                               |  9 +++-
 bugreport-generate-config-whitelist.sh |  4 ++
 4 files changed, 47 insertions(+), 35 deletions(-)
 create mode 100755 bugreport-generate-config-whitelist.sh
diff --git a/.gitignore b/.gitignore
index 89b3b79c1a..055a84c4a8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,6 +25,7 @@
 /git-bisect--helper
 /git-blame
 /git-branch
+/git-bugreport
 /git-bundle
 /git-cat-file
 /git-check-attr
diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt
index 0006faf800..69f3e4f219 100644
--- a/Documentation/config/sendemail.txt
+++ b/Documentation/config/sendemail.txt
@@ -1,63 +1,63 @@
-sendemail.identity::
+sendemail.identity:: // bugreport-exclude
 	A configuration identity. When given, causes values in the
 	'sendemail.<identity>' subsection to take precedence over
 	values in the 'sendemail' section. The default identity is
 	the value of `sendemail.identity`.
 
-sendemail.smtpEncryption::
+sendemail.smtpEncryption:: // bugreport-include
 	See linkgit:git-send-email[1] for description.  Note that this
 	setting is not subject to the 'identity' mechanism.
 
-sendemail.smtpssl (deprecated)::
+sendemail.smtpssl (deprecated):: // bugreport-exclude
 	Deprecated alias for 'sendemail.smtpEncryption = ssl'.
 
-sendemail.smtpsslcertpath::
+sendemail.smtpsslcertpath:: // bugreport-exclude
 	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>.*:: // bugreport-exclude
 	Identity-specific versions of the 'sendemail.*' parameters
 	found below, taking precedence over those when this
 	identity is selected, through either the command-line or
 	`sendemail.identity`.
 
-sendemail.aliasesFile::
-sendemail.aliasFileType::
-sendemail.annotate::
-sendemail.bcc::
-sendemail.cc::
-sendemail.ccCmd::
-sendemail.chainReplyTo::
-sendemail.confirm::
-sendemail.envelopeSender::
-sendemail.from::
-sendemail.multiEdit::
-sendemail.signedoffbycc::
-sendemail.smtpPass::
-sendemail.suppresscc::
-sendemail.suppressFrom::
-sendemail.to::
-sendemail.tocmd::
-sendemail.smtpDomain::
-sendemail.smtpServer::
-sendemail.smtpServerPort::
-sendemail.smtpServerOption::
-sendemail.smtpUser::
-sendemail.thread::
-sendemail.transferEncoding::
-sendemail.validate::
-sendemail.xmailer::
+sendemail.aliasesFile:: // bugreport-exclude
+sendemail.aliasFileType:: // bugreport-exclude
+sendemail.annotate:: // bugreport-include
+sendemail.bcc:: // bugreport-include
+sendemail.cc:: // bugreport-include
+sendemail.ccCmd:: // bugreport-include
+sendemail.chainReplyTo:: // bugreport-include
+sendemail.confirm:: // bugreport-include
+sendemail.envelopeSender:: // bugreport-include
+sendemail.from:: // bugreport-include
+sendemail.multiEdit:: // bugreport-include
+sendemail.signedoffbycc:: // bugreport-include
+sendemail.smtpPass:: // bugreport-exclude
+sendemail.suppresscc:: // bugreport-include
+sendemail.suppressFrom:: // bugreport-include
+sendemail.to:: // bugreport-include
+sendemail.tocmd:: // bugreport-include
+sendemail.smtpDomain:: // bugreport-include
+sendemail.smtpServer:: // bugreport-include
+sendemail.smtpServerPort:: // bugreport-include
+sendemail.smtpServerOption:: // bugreport-include
+sendemail.smtpUser:: // bugreport-exclude
+sendemail.thread:: // bugreport-include
+sendemail.transferEncoding:: // bugreport-include
+sendemail.validate:: // bugreport-include
+sendemail.xmailer:: // bugreport-include
 	See linkgit:git-send-email[1] for description.
 
-sendemail.signedoffcc (deprecated)::
+sendemail.signedoffcc (deprecated):: // bugreport-exclude
 	Deprecated alias for `sendemail.signedoffbycc`.
 
-sendemail.smtpBatchSize::
+sendemail.smtpBatchSize:: // bugreport-include
 	Number of messages to be sent per connection, after that a relogin
 	will happen.  If the value is 0 or undefined, send all messages in
 	one connection.
 	See also the `--batch-size` option of linkgit:git-send-email[1].
 
-sendemail.smtpReloginDelay::
+sendemail.smtpReloginDelay:: // bugreport-include
 	Seconds wait before reconnecting to smtp server.
 	See also the `--relogin-delay` option of linkgit:git-send-email[1].
diff --git a/Makefile b/Makefile
index 132e2a52da..78767ecdde 100644
--- a/Makefile
+++ b/Makefile
@@ -634,6 +634,10 @@ SCRIPT_PYTHON += git-p4.py
 SCRIPT_SH_GEN = $(patsubst %.sh,%,$(SCRIPT_SH))
 SCRIPT_PERL_GEN = $(patsubst %.perl,%,$(SCRIPT_PERL))
 SCRIPT_PYTHON_GEN = $(patsubst %.py,%,$(SCRIPT_PYTHON))
+SCRIPT_DEPENDENCIES = git-bugreport-config-whitelist
+
+$(SCRIPT_DEPENDENCIES): Documentation/config/*.txt
+	sh bugreport-generate-config-whitelist.sh
 
 # Individual rules to allow e.g.
 # "make -C ../.. SCRIPT_PERL=contrib/foo/bar.perl build-perl-script"
@@ -651,17 +655,20 @@ install-perl-script: $(SCRIPT_PERL_GEN)
 install-python-script: $(SCRIPT_PYTHON_GEN)
 	$(INSTALL) $^ '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
 
-.PHONY: clean-perl-script clean-sh-script clean-python-script
+.PHONY: clean-perl-script clean-sh-script clean-python-script clean-script-dependencies
 clean-sh-script:
 	$(RM) $(SCRIPT_SH_GEN)
 clean-perl-script:
 	$(RM) $(SCRIPT_PERL_GEN)
 clean-python-script:
 	$(RM) $(SCRIPT_PYTHON_GEN)
+clean-script-dependencies:
+	$(RM) $(SCRIPT_DEPENDENCIES)
 
 SCRIPTS = $(SCRIPT_SH_GEN) \
 	  $(SCRIPT_PERL_GEN) \
 	  $(SCRIPT_PYTHON_GEN) \
+	  $(SCRIPT_DEPENDENCIES) \
 	  git-instaweb
 
 ETAGS_TARGET = TAGS
diff --git a/bugreport-generate-config-whitelist.sh b/bugreport-generate-config-whitelist.sh
new file mode 100755
index 0000000000..ca6b232024
--- /dev/null
+++ b/bugreport-generate-config-whitelist.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+grep -RhPo ".*(?=:: \/\/ bugreport-include)" Documentation/config \
+  >git-bugreport-config-whitelist

-- 
2.24.0.rc0.303.g954a862665-goog
Previous: Junio C HamanoNext: Johannes Schindelin
Message 34 of 68 in “bugreport: add tool to generate debugging info”
  1. bugreport: add tool to generate debugging infoEmily Shaffer, Aug 15, 2019
  2. Derrick StoleeAug 15, 2019
  3. Junio C HamanoAug 15, 2019
  4. Emily ShafferAug 15, 2019
  5. Junio C HamanoAug 15, 2019
  6. Emily ShafferAug 16, 2019
  7. Junio C HamanoAug 16, 2019
  8. Emily ShafferAug 16, 2019
  9. Johannes SchindelinAug 15, 2019
  10. Emily ShafferAug 15, 2019
  11. Johannes SchindelinAug 16, 2019
  12. Emily ShafferAug 15, 2019
  13. Junio C HamanoAug 15, 2019
  14. Emily ShafferAug 15, 2019
  15. Junio C HamanoAug 15, 2019
  16. Emily ShafferAug 15, 2019
  17. 0/2 add git-bugreport toolEmily Shaffer, Aug 17, 2019
  18. 2/2 bugreport: generate config whitelist based on docsEmily Shaffer, Aug 17, 2019
  19. Martin ÅgrenAug 17, 2019
  20. Emily ShafferAug 21, 2019
  21. 1/2 bugreport: add tool to generate debugging infoEmily Shaffer, Aug 17, 2019
  22. 0/9 add git-bugreport toolEmily Shaffer, Oct 25, 2019
  23. 1/9 bugreport: add tool to generate debugging infoEmily Shaffer, Oct 25, 2019
  24. Josh SteadmonOct 29, 2019
  25. Junio C HamanoNov 16, 2019
  26. Emily ShafferNov 19, 2019
  27. Johannes SchindelinNov 19, 2019
  28. Junio C HamanoNov 20, 2019
  29. Johannes SchindelinNov 20, 2019
  30. Johannes SchindelinNov 19, 2019
  31. Junio C HamanoNov 20, 2019
  32. Emily ShafferNov 20, 2019
  33. Junio C HamanoNov 20, 2019
  34. 2/9 bugreport: generate config whitelist based on docsEmily Shaffer, Oct 25, 2019
  35. Johannes SchindelinOct 28, 2019
  36. 3/9 bugreport: add version and system informationEmily Shaffer, Oct 25, 2019
  37. Johannes SchindelinOct 28, 2019
  38. Emily ShafferNov 8, 2019
  39. Johannes SchindelinNov 11, 2019
  40. Emily ShafferNov 14, 2019
  41. Josh SteadmonOct 29, 2019
  42. 4/9 bugreport: add config values from whitelistEmily Shaffer, Oct 25, 2019
  43. Johannes SchindelinOct 28, 2019
  44. Emily ShafferDec 11, 2019
  45. Johannes SchindelinDec 15, 2019
  46. Josh SteadmonOct 29, 2019
  47. Junio C HamanoOct 30, 2019
  48. Emily ShafferNov 14, 2019
  49. 5/9 bugreport: collect list of populated hooksEmily Shaffer, Oct 25, 2019
  50. Johannes SchindelinOct 28, 2019
  51. Emily ShafferDec 11, 2019
  52. Johannes SchindelinDec 15, 2019
  53. 6/9 bugreport: count loose objectsEmily Shaffer, Oct 25, 2019
  54. Johannes SchindelinOct 28, 2019
  55. Emily ShafferDec 10, 2019
  56. Josh SteadmonOct 29, 2019
  57. 7/9 bugreport: add packed object summaryEmily Shaffer, Oct 25, 2019
  58. Johannes SchindelinOct 28, 2019
  59. Emily ShafferDec 11, 2019
  60. Johannes SchindelinDec 11, 2019
  61. Emily ShafferDec 11, 2019
  62. 8/9 bugreport: list contents of $OBJDIR/infoEmily Shaffer, Oct 25, 2019
  63. Johannes SchindelinOct 28, 2019
  64. 9/9 bugreport: print contents of alternates fileEmily Shaffer, Oct 25, 2019
  65. Johannes SchindelinOct 28, 2019
  66. Emily ShafferNov 19, 2019
  67. Junio C HamanoOct 29, 2019
  68. Johannes SchindelinOct 29, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.