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

Re: [PATCH v3 4/9] bugreport: add config values from whitelist

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Dec 15, 2019, 17:30 UTC
Message-ID
<nycvar.QRO.7.76.6.1912151826380.46@tvgsbejvaqbjf.bet>
In-Reply-To
<20191211204811.GC107889@google.com>
Hi Emily,
On Wed, 11 Dec 2019, Emily Shaffer wrote:
Show 20 quoted lines
> On Mon, Oct 28, 2019 at 03:14:35PM +0100, Johannes Schindelin wrote:
>
> >
> > On Thu, 24 Oct 2019, Emily Shaffer wrote:
> >
> > > Teach bugreport to gather the values of config options which are
> > > present in 'git-bugreport-config-whitelist'.
> > >
> > > 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.
> >
> > Should we still have the `// bugreport-exclude` comments, then?
>
> They were optional (useless) before too. I can remove them if you want;
> I suppose I like the idea of having precedent if someone wants to build
> their own internal version with opt-out configs rather than opt-in. I
> can remove them if we want; it doesn't matter very much to me either
> way.

How are you guaranteeing that this information does not become stale, like, immediately?

If you _still_ insist on keeping those comments even after answering this question, at least please turn them into C-style comments: we have no C++-style comments in Git and want to keep it this way.

Show 28 quoted lines
> > > diff --git a/bugreport.c b/bugreport.c
> > > [...]
> > > +	}
> > > +
> > > +	return 0;
> > > +}
> > > +
> > > +void get_whitelisted_config(struct strbuf *config_info)
> > > +{
> > > +	struct strbuf path = STRBUF_INIT;
> > > +
> > > +	strbuf_addstr(&path, git_exec_path());
> > > +	strbuf_addstr(&path, "/git-bugreport-config-whitelist");
> >
> > Hmm. I would have expected this patch to come directly after the patch
> > 2/9 that generates that white-list, and I would also have expected that
> > to be pre-sorted, and compiled in.
> >
> > Do you want users to _edit_ the file in the exec path? In general, that
> > path will be write-protected, though. A better alternative would
> > probably be to compile in a hard-coded list, and to allow including more
> > values e.g. by offering command-line options to specify config setting
> > patterns. But if we allow patterns, we might actually want to have those
> > exclusions to prevent sensitive data from being included.
>
> Hm, interesting. Do we have precedent for compiling in a header
> generated during the build process? I think I saw one when I was adding
> this script - I'll take a look.

Yes, we do. The entire `command-list.h` is generated during the build. Look for `GENERATED_H` in the `Makefile`.

Ciao, Dscho

Previous: Emily ShafferNext: Josh Steadmon
Message 45 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.