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

Re: [PATCH] doc: propose hooks managed by the config

From
Emily Shaffer <emilyshaffer@google.com>
Date
May 6, 2020, 21:33 UTC
Message-ID
<20200506213354.GG77802@google.com>
In-Reply-To
<20200425205727.GB6421@camp.crustytoothpaste.net>
On Sat, Apr 25, 2020 at 08:57:27PM +0000, brian m. carlson wrote:
Show 18 quoted lines
> 
> On 2020-04-20 at 23:53:10, Emily Shaffer wrote:
> > +=== Config schema
> > +
> > +Hooks can be introduced by editing the configuration manually. There are two new
> > +sections added, `hook` and `hookcmd`.
> > +
> > +==== `hook`
> > +
> > +Primarily contains subsections for each hook event. These subsections define
> > +hook command execution order; hook commands can be specified by passing the
> > +command directly if no additional configuration is needed, or by passing the
> > +name of a `hookcmd`. If Git does not find a `hookcmd` whose subsection matches
> > +the value of the given command string, Git will try to execute the string
> > +directly. Hook event subsections can also contain per-hook-event settings.
> 
> Can we say explicitly that the commands are invoked by the shell?  Or is
> the plan to try to parse them without passing to the shell?
Sure. If I didn't make it clear it was by mistake, not by intent.
Show 63 quoted lines
> 
> > +Also contains top-level hook execution settings, for example,
> > +`hook.warnHookDir`, `hook.runHookDir`, or `hook.disableAll`.
> > +
> > +----
> > +[hook "pre-commit"]
> > +  command = perl-linter
> > +  command = /usr/bin/git-secrets --pre-commit
> > +
> > +[hook "pre-applypatch"]
> > +  command = perl-linter
> > +  error = ignore
> > +
> > +[hook]
> > +  warnHookDir = true
> > +  runHookDir = prompt
> > +----
> > +
> > +==== `hookcmd`
> > +
> > +Defines a hook command and its attributes, which will be used when a hook event
> > +occurs. Unqualified attributes are assumed to apply to this hook during all hook
> > +events, but event-specific attributes can also be supplied. The example runs
> > +`/usr/bin/lint-it --language=perl <args passed by Git>`, but for repos which
> > +include this config, the hook command will be skipped for all events to which
> > +it's normally subscribed _except_ `pre-commit`.
> > +
> > +----
> > +[hookcmd "perl-linter"]
> > +  command = /usr/bin/lint-it --language=perl
> > +  skip = true
> > +  pre-commit-skip = false
> > +----
> 
> This seems fine to me.  I like this design and it seems sane.
> 
> > +== Implementation
> > +
> > +=== Library
> > +
> > +`hook.c` and `hook.h` are responsible for interacting with the config files. In
> > +the case when the code generating a hook event doesn't have special concerns
> > +about how to run the hooks, the hook library will provide a basic API to call
> > +all hooks in config order with an `argv_array` provided by the code which
> > +generates the hook event:
> > +
> > +*`int run_hooks(const char *hookname, struct argv_array *args)`*
> > +
> > +This call includes the hook command provided by `run-command.h:find_hook()`;
> > +eventually, this legacy hook will be gated by a config `hook.runHookDir`. The
> > +config is checked against a number of cases:
> > +
> > +- "no": the legacy hook will not be run
> > +- "interactive": Git will prompt the user before running the legacy hook
> > +- "warn": Git will print a warning to stderr before running the legacy hook
> > +- "yes" (default): Git will silently run the legacy hook
> > +
> > +If `hook.runHookDir` is provided more than once, Git will use the most
> > +restrictive setting provided, for security reasons.
> 
> I don't think this is consistent with the way the rest of our options
> work.  What if someone generally wants to disable legacy hooks but then
> works with a program in a repository that requires them?

Unfortunately this is something I think my end will want to hold firm on. In general we disagree with your statement later about not wanting to make the .git/config secure. I see your use case, and I anticipate two possible workarounds I'd present:

1) If working in that repo for the short term, run `git -c
hook.runHookDir=yes <command> <arg...>` (and therefore allow the config
from command line scope, which I'm happy with in general). Maybe
someone would want to use an alias, hookgit or hg? Just kidding.. ;P
2) If you're stuck with that repo for the long term, add
`hook.<hookname>.command = /path/.git/hooks/<hookname>` lines to the local
config.

Yes, those are both somewhat user-unfriendly, and I think we can do better... I'll have to think more and see what I can come up with. Suggestions welcome.

Show 19 quoted lines
> 
> > +== Caveats
> > +
> > +=== Security and repo config
> > +
> > +Part of the motivation behind this refactor is to mitigate hooks as an attack
> > +vector;footnote:[https://lore.kernel.org/git/20171002234517.GV19555@aiede.mtv.corp.google.com/]
> > +however, as the design stands, users can still provide hooks in the repo-level
> > +config, which is included when a repo is zipped and sent elsewhere.  The
> > +security of the repo-level config is still under discussion; this design
> > +generally assumes the repo-level config is secure, which is not true yet. The
> > +goal is to avoid an overcomplicated design to work around a problem which has
> > +ceased to exist.
> 
> I want to be clear that I'm very much opposed to trying to "secure" the
> config as a whole.  I believe that it's going to ultimately lead to a
> variety of new and interesting attack vectors and will lead to Git
> becoming a CVE factory.  Vim has this problem with modelines, for
> example.

I'm really interested to hear more - it seems like security and config efforts will end up on my plate before the end of the year, so I'd like to know what is on your mind.

> 
> I think we should maintain the status quo that the only safe things you
> can do with an untrusted repository are clone and fetch because it sets
> a clear security boundary.

I wish there was a way to make that more apparent. The trouble is that while you and I and the sysadmin know the dangers, the high schooler making a website might not. Talking about how to warn users is definitely out-of-scope for this conversation, but it's on my mind.

> 
> Having said that, I'm otherwise pretty happy with this design and I'm
> looking forward to seeing it implemented.
Thanks very much for the feedback and for reading it through! :)
 - Emily
Previous: brian m. carlsonNext: brian m. carlson
Message 34 of 106 in “Notes from Git Contributor Summit, Los Angeles (April 5, 2020)”
  1. James RamsayMar 12, 2020
  2. 1/17 ReftableJames Ramsay, Mar 12, 2020
  3. 2/17 Hooks in the futureJames Ramsay, Mar 12, 2020
  4. Emily ShafferMar 12, 2020
  5. Junio C HamanoMar 13, 2020
  6. Emily ShafferApr 7, 2020
  7. Emily ShafferApr 7, 2020
  8. Junio C HamanoApr 8, 2020
  9. Emily ShafferApr 8, 2020
  10. Jeff KingApr 10, 2020
  11. Emily ShafferApr 13, 2020
  12. Jeff KingApr 13, 2020
  13. 0/2 configuration-based hook management (was: [TOPIC 2/17] Hooks in the future)Emily Shaffer, Apr 14, 2020
  14. 1/2 hook: scaffolding for git-hook subcommandEmily Shaffer, Apr 14, 2020
  15. 2/2 hook: add --list modeEmily Shaffer, Apr 14, 2020
  16. Phillip WoodApr 14, 2020
  17. Emily ShafferApr 14, 2020
  18. Jeff KingApr 14, 2020
  19. Phillip WoodApr 15, 2020
  20. Josh SteadmonApr 14, 2020
  21. Phillip WoodApr 15, 2020
  22. Jeff KingApr 14, 2020
  23. Phillip WoodApr 15, 2020
  24. Junio C HamanoApr 15, 2020
  25. Emily ShafferApr 15, 2020
  26. Junio C HamanoApr 15, 2020
  27. Jonathan NiederApr 15, 2020
  28. Emily ShafferApr 15, 2020
  29. doc: propose hooks managed by the configEmily Shaffer, Apr 20, 2020
  30. Emily ShafferApr 21, 2020
  31. Junio C HamanoApr 21, 2020
  32. Emily ShafferApr 24, 2020
  33. brian m. carlsonApr 25, 2020
  34. Emily ShafferMay 6, 2020
  35. brian m. carlsonMay 6, 2020
  36. Emily ShafferMay 19, 2020
  37. Jeff KingApr 15, 2020
  38. Emily ShafferApr 15, 2020
  39. Jeff KingApr 15, 2020
  40. 3/17 ObliterateJames Ramsay, Mar 12, 2020
  41. Konstantin RyabitsevMar 12, 2020
  42. Damien RobertMar 15, 2020
  43. Konstantin TokarevMar 16, 2020
  44. Damien RobertMar 26, 2020
  45. Elijah NewrenMar 16, 2020
  46. Damien RobertMar 26, 2020
  47. Phillip SusiMar 16, 2020
  48. Damien RobertMar 26, 2020
  49. Philip OakleyMar 16, 2020
  50. nbelakovski@gmail.comMay 16, 2020
  51. 4/17 Sparse checkoutJames Ramsay, Mar 12, 2020
  52. 5/17 Partial CloneJames Ramsay, Mar 12, 2020
  53. Allowing only blob filtering was: [TOPIC 5/17] Partial CloneChristian Couder, Mar 17, 2020
  54. 0/2 upload-pack.c: limit allowed filter choicesTaylor Blau, Mar 17, 2020
  55. 1/2 list_objects_filter_options: introduce 'list_object_filter_config_name'Taylor Blau, Mar 17, 2020
  56. Eric SunshineMar 17, 2020
  57. Jeff KingMar 18, 2020
  58. Junio C HamanoMar 18, 2020
  59. Eric SunshineMar 18, 2020
  60. Jeff KingMar 19, 2020
  61. Taylor BlauMar 18, 2020
  62. 2/2 upload-pack.c: allow banning certain object filter(s)Taylor Blau, Mar 17, 2020
  63. Eric SunshineMar 17, 2020
  64. Taylor BlauMar 18, 2020
  65. Philip OakleyMar 18, 2020
  66. Taylor BlauMar 18, 2020
  67. Jeff KingMar 18, 2020
  68. Re*: [RFC PATCH 0/2] upload-pack.c: limit allowed filter choicesJunio C Hamano, Mar 18, 2020
  69. Jeff KingMar 19, 2020
  70. Taylor BlauMar 18, 2020
  71. Junio C HamanoMar 18, 2020
  72. Jeff KingMar 19, 2020
  73. Jeff KingMar 19, 2020
  74. Christian CouderApr 17, 2020
  75. Taylor BlauApr 17, 2020
  76. Jeff KingApr 17, 2020
  77. Christian CouderApr 21, 2020
  78. Taylor BlauApr 22, 2020
  79. Taylor BlauApr 22, 2020
  80. Christian CouderApr 21, 2020
  81. 6/17 GC strategiesJames Ramsay, Mar 12, 2020
  82. 7/17 Background operations/maintenanceJames Ramsay, Mar 12, 2020
  83. 8/17 Push performanceJames Ramsay, Mar 12, 2020
  84. 9/17 Obsolescence markers and evolveJames Ramsay, Mar 12, 2020
  85. Noam SoloveichikMay 9, 2020
  86. Jeff KingMay 15, 2020
  87. 10/17 Expel ‘git shell’?James Ramsay, Mar 12, 2020
  88. 11/17 GPL enforcementJames Ramsay, Mar 12, 2020
  89. 12/17 Test harness improvementsJames Ramsay, Mar 12, 2020
  90. 13/17 Cross implementation test suiteJames Ramsay, Mar 12, 2020
  91. 14/17 Aspects of merge-ort: cool, or crimes against humanity?James Ramsay, Mar 12, 2020
  92. 15/17 Reachability checksJames Ramsay, Mar 12, 2020
  93. 16/17 “I want a reviewer”James Ramsay, Mar 12, 2020
  94. Emily ShafferMar 12, 2020
  95. Konstantin RyabitsevMar 12, 2020
  96. Jonathan NiederMar 12, 2020
  97. Konstantin RyabitsevMar 12, 2020
  98. Philippe BlainMar 17, 2020
  99. Eric WongMar 13, 2020
  100. Jeff KingMar 14, 2020
  101. inbox indexing wishlist [was: [TOPIC 16/17] “I want a reviewer”]Eric Wong, Mar 15, 2020
  102. 17/17 SecurityJames Ramsay, Mar 12, 2020
  103. Derrick StoleeMar 12, 2020
  104. Jeff KingMar 13, 2020
  105. Jakub NarebskiMar 15, 2020
  106. Jeff KingMar 16, 2020

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.