Files
git/Documentation/config/sideband.adoc
Johannes Schindelin 818fbfd208 sideband: delay sanitizing by default to Git v3.0
The sideband sanitization patches allow ANSI color sequences through
by default, preserving compatibility with pre-receive hooks that
provide colored output during `git push`.

Even so, there is concern that changing any default behavior in a
minor release may have unforeseen consequences. To accommodate this,
defer the secure-by-default behavior to Git v3.0, where breaking
changes are expected.

This gives users and tooling time to prepare, while committing to
address CVE-2024-52005 in Git v3.0.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
[jc: adjusted for the removal of 'default' value]
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-03-06 13:54:05 -08:00

36 lines
1.3 KiB
Plaintext

sideband.allowControlCharacters::
ifdef::with-breaking-changes[]
By default, control characters that are delivered via the sideband
are masked, except ANSI color sequences. This prevents potentially
unwanted ANSI escape sequences from being sent to the terminal.
endif::with-breaking-changes[]
ifndef::with-breaking-changes[]
By default, no control characters delivered via the sideband
are masked. This is unsafe and will change in Git v3.* to only
allow ANSI color sequences by default, preventing potentially
unwanted ANSI escape sequences from being sent to the terminal.
endif::with-breaking-changes[]
Use this config setting to override this behavior (the value can be
a comma-separated list of the following keywords):
+
--
`color`::
Allow ANSI color sequences, line feeds and horizontal tabs,
but mask all other control characters. This is the default.
`cursor:`:
Allow control sequences that move the cursor. This is
disabled by default.
`erase`::
Allow control sequences that erase charactrs. This is
disabled by default.
`false`::
Mask all control characters other than line feeds and
horizontal tabs.
`true`::
Allow all control characters to be sent to the terminal.
--
sideband.<url>.*::
Apply the `sideband.*` option selectively to specific URLs. The
same URL matching logic applies as for `http.<url>.*` settings.