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

Re: [PATCH v2 4/4] sideband: add options to allow more control sequences to be passed through

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Jan 22, 2026, 12:29 UTC
Message-ID
<a51f9433-e82f-bc2c-5fc4-f8ae95a859f8@gmx.de>
In-Reply-To
<xmqqa4y81ag8.fsf@gitster.g>
Hi Junio,

I disagree with making sideband sanitization opt-in or weakening it based on a "trusted remote" heuristic. In this context, emitting untrusted bytes to a terminal without proper sanitization is a security-relevant bug; safe-by-default should be the baseline.

On Tue, 20 Jan 2026, Junio C Hamano wrote:
> [...] forcing this filtering on everybody [...]  unless it is enabled by
> default. [...]

If the goal is to mitigate terminal escape injection from remote-controlled output, then shipping it disabled by default does not mitigate the default case. Most users will not discover or enable a hardening knob until after an incident.

> Two levels of defaults [...]  trusted daily remotes vs new remotes.
> [...]

I don't think we can safely infer "trusted enough to write to my terminal" from "I fetch from there often". A previously-trusted remote can be compromised, after all. Which means that a trust-based default is a foot-gun: it creates a path where users believe they're protected while the program is intentionally passing through attacker-controlled escape sequences.

Besides, allowing "colorful output from their hooks" _is already allowed by default_ in the proposed patch series. The config variable `sideband.allowControlCharacters` isn't an "all or nothing" setting, after all.

> [...] you shouldn't have to manually configure "I accept colors from
> them". [...]

Color is already a narrowly-scoped exception. Cursor movement / erase sequences are in a different category because they can rewrite prior output and hide what actually happened. If we want to allow them, it should remain explicit opt-in on the client, not something we enable automatically based on repository state.

If the argument is "setting `sideband.allowControlCharacters` to `color` by default breaks common workflows on established remotes", can you point to a concrete repro (hook snippet + terminal + escape sequences relied on) or a public example? Without that, I don't think we should bias the default toward pass-through of higher-risk sequences.

Absent such evidence, the best way to proceed is to keep sanitization enabled by default for sideband output (modulo color), with the clearly documented escape hatch for users who knowingly want additional sequences. If there is a strong need for per-remote behavior, there is `sideband.<url>.allowControlCharacters`, as per v3), i.e. users _do_ have that option _after_ stating that they trust that particular remote not to wreak havoc with their terminal.

Also keep in mind that this patch series' scope is the sideband channel; The fact that SSH-based transports patch through `stderr` (completely side-stepping sideband) is out of scope.

Ciao, Johannes

P.S.: Junio: if we continue to discuss "opt-in"/"opt-out", I think we need to be more explicit about which behavior we mean. We now have multiple levels in `sideband.allowControlCharacters` (default allows color; `cursor`, `erase`, `false` and `true` allow more fine-grained levels).

If the proposal is "full pass-through of all control characters is opt-in", or "full sanitizing of all control characters is opt-in", I whole-heartedly agree: That is already opt-in via setting `sideband.allowControlCharacters` to `false` or `true`, respectively.

If the proposal is "keep the historical behavior (verbatim sideband payload, no sanitization) as the default, and make sanitization opt-in", I am firmly opposed: This makes the sideband payload remote-controlled; A security hardening that is off by default will not protect the default user population.

Can you confirm which of these two meanings you intend when you say "opt-in" here? Once that's clarified, we can discuss whether the default should remain at "color-only" (today's default) with explicit opt-in for riskier sequences, or whether you're arguing for no filtering at all by default.

Previous: Patrick SteinhardtNext: Junio C Hamano
Message 49 of 86 in “Sanitize sideband channel messages”
  1. 0/3 Sanitize sideband channel messagesJohannes Schindelin via GitGitGadget, Jan 14, 2025
  2. 1/3 sideband: mask control charactersJohannes Schindelin via GitGitGadget, Jan 14, 2025
  3. Phillip WoodJan 15, 2025
  4. Johannes SchindelinDec 2, 2025
  5. Andreas SchwabJan 15, 2025
  6. Junio C HamanoJan 15, 2025
  7. 2/3 sideband: introduce an "escape hatch" to allow control charactersJohannes Schindelin via GitGitGadget, Jan 14, 2025
  8. 3/3 sideband: do allow ANSI color sequences by defaultJohannes Schindelin via GitGitGadget, Jan 14, 2025
  9. brian m. carlsonJan 14, 2025
  10. Junio C HamanoJan 16, 2025
  11. Ondrej PohorelskyJan 28, 2025
  12. Junio C HamanoJan 31, 2025
  13. Johannes SchindelinDec 2, 2025
  14. brian m. carlsonDec 3, 2025
  15. Johannes SchindelinDec 3, 2025
  16. Phillip WoodJan 15, 2025
  17. Johannes SchindelinDec 2, 2025
  18. 0/4 Sanitize sideband channel messagesJohannes Schindelin via GitGitGadget, Dec 17, 2025
  19. 1/4 sideband: mask control charactersJohannes Schindelin via GitGitGadget, Dec 17, 2025
  20. Patrick SteinhardtJan 9, 2026
  21. Johannes SchindelinJan 16, 2026
  22. 2/4 sideband: introduce an "escape hatch" to allow control charactersJohannes Schindelin via GitGitGadget, Dec 17, 2025
  23. Junio C HamanoDec 18, 2025
  24. Johannes SchindelinDec 18, 2025
  25. Junio C HamanoDec 19, 2025
  26. Johannes SchindelinJan 16, 2026
  27. Patrick SteinhardtJan 9, 2026
  28. 3/4 sideband: do allow ANSI color sequences by defaultJohannes Schindelin via GitGitGadget, Dec 17, 2025
  29. Patrick SteinhardtJan 9, 2026
  30. Johannes SchindelinJan 16, 2026
  31. 4/4 sideband: add options to allow more control sequences to be passed throughJohannes Schindelin via GitGitGadget, Dec 17, 2025
  32. Patrick SteinhardtJan 9, 2026
  33. brian m. carlsonJan 10, 2026
  34. Jeff KingJan 15, 2026
  35. Junio C HamanoJan 15, 2026
  36. Johannes SchindelinJan 15, 2026
  37. Patrick SteinhardtJan 16, 2026
  38. Ondrej PohorelskyJan 16, 2026
  39. Junio C HamanoJan 16, 2026
  40. Johannes SchindelinJan 16, 2026
  41. Junio C HamanoJan 16, 2026
  42. Patrick SteinhardtJan 19, 2026
  43. brian m. carlsonJan 19, 2026
  44. D. Ben KnobleJan 20, 2026
  45. Junio C HamanoJan 20, 2026
  46. Jeff KingJan 20, 2026
  47. Junio C HamanoJan 20, 2026
  48. Patrick SteinhardtJan 21, 2026
  49. Johannes SchindelinJan 22, 2026
  50. Junio C HamanoJan 22, 2026
  51. brian m. carlsonJan 15, 2026
  52. Junio C HamanoFeb 3, 2026
  53. Johannes SchindelinFeb 3, 2026
  54. Junio C HamanoFeb 3, 2026
  55. Junio C HamanoFeb 4, 2026
  56. Johannes SchindelinJan 16, 2026
  57. 0/5 Sanitize sideband channel messagesJohannes Schindelin via GitGitGadget, Jan 16, 2026
  58. 1/5 sideband: mask control charactersJohannes Schindelin via GitGitGadget, Jan 16, 2026
  59. 2/5 sideband: introduce an "escape hatch" to allow control charactersJohannes Schindelin via GitGitGadget, Jan 16, 2026
  60. 3/5 sideband: do allow ANSI color sequences by defaultJohannes Schindelin via GitGitGadget, Jan 16, 2026
  61. 4/5 sideband: add options to allow more control sequences to be passed throughJohannes Schindelin via GitGitGadget, Jan 16, 2026
  62. 5/5 sideband: offer to configure sanitizing on a per-URL basisJohannes Schindelin via GitGitGadget, Jan 16, 2026
  63. Johannes SchindelinJan 16, 2026
  64. 0/6 Sanitize sideband channel messagesJohannes Schindelin via GitGitGadget, Feb 3, 2026
  65. 1/6 sideband: mask control charactersJohannes Schindelin via GitGitGadget, Feb 3, 2026
  66. 2/6 sideband: introduce an "escape hatch" to allow control charactersJohannes Schindelin via GitGitGadget, Feb 3, 2026
  67. 3/6 sideband: do allow ANSI color sequences by defaultJohannes Schindelin via GitGitGadget, Feb 3, 2026
  68. 4/6 sideband: add options to allow more control sequences to be passed throughJohannes Schindelin via GitGitGadget, Feb 3, 2026
  69. 5/6 sideband: offer to configure sanitizing on a per-URL basisJohannes Schindelin via GitGitGadget, Feb 3, 2026
  70. 6/6 sideband: delay sanitizing by default to Git v3.0Johannes Schindelin via GitGitGadget, Feb 3, 2026
  71. Junio C HamanoFeb 4, 2026
  72. Junio C HamanoFeb 5, 2026
  73. Junio C HamanoFeb 13, 2026
  74. 0/3 Sanitizing sideband outputJunio C Hamano, Mar 2, 2026
  75. 1/3 sideband: drop 'default' configurationJunio C Hamano, Mar 2, 2026
  76. 2/3 sideband: delay sanitizing by default to Git v3.0Junio C Hamano, Mar 2, 2026
  77. 3/3 sideband: conditional documentation fixJunio C Hamano, Mar 2, 2026
  78. 0/7 Sanitizing sideband outputJunio C Hamano, Mar 5, 2026
  79. 1/7 sideband: mask control charactersJunio C Hamano, Mar 5, 2026
  80. 2/7 sideband: introduce an "escape hatch" to allow control charactersJunio C Hamano, Mar 5, 2026
  81. 3/7 sideband: do allow ANSI color sequences by defaultJunio C Hamano, Mar 5, 2026
  82. 4/7 sideband: add options to allow more control sequences to be passed throughJunio C Hamano, Mar 5, 2026
  83. 5/7 sideband: offer to configure sanitizing on a per-URL basisJunio C Hamano, Mar 5, 2026
  84. 6/7 sideband: drop 'default' configurationJunio C Hamano, Mar 5, 2026
  85. 7/7 sideband: delay sanitizing by default to Git v3.0Junio C Hamano, Mar 5, 2026
  86. Shipping 2.55 with stricter "neuter sideband" topicJunio C Hamano, Jun 11, 2026

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.