Repository navigation
Minor Changes
-
df13aeb: Add the
allowConfigandstrictoptions. Configuration keys outside the built-in list of known-safe keys
(SAFE_CONFIG_KEYS) and the keys named inallowConfignow emit a one-offSIMPLE_GIT_UNLISTED_CONFIGwarning,
or are rejected whenstrict: trueis set. Known-unsafe keys can now be permitted individually through
allowConfig, and environment variables throughallowEnvironment, deprecating theunsafe.allowUnsafe*options
that only covered configuration keys or environment variables (they continue to work as before). -
4137780: The custom binary (the first string of the
binaryoption orgit.customBinary()) may now contain spaces
when it looks like a path to a file, for exampleC:\Program Files\Git\bin\git.exe. The value must include
a path separator and no part of the path may start or end with a space. The prefix (the optional second string)
remains limited to the existing restricted character set, as it is passed to the binary as its first argument. -
df13aeb: Add
git.cmdfor running commands written as tagged template literals, where every interpolated value is
treated as untrusted data that can't add options, set configuration keys or select a remote helper transport.
Add theremoteUrl()andrefName()value wrappers for stricter validation of interpolated values. -
a996f0f: Thanks to @manus-pi and @eliteaja11-dev for submitting CVE proposals that contributed to these changes.
When the recommended checks are enabled (with
unsafe.recommended: trueorstrict: true),HOMEandXDG_CONFIG_HOME
supplied through.env()with a value other than the one inprocess.envrequireallowUnsafeConfigPaths
(or naming them inallowEnvironment), asgitreads the global configuration from$HOME/.gitconfigand
$XDG_CONFIG_HOME/git/configin the same way asGIT_CONFIG_GLOBAL. Passing the inherited value through is unaffected,
and neither is removed from the inherited environment.parseEnvaccepts the inherited environment as an optional second argument, used to compareHOMEand
XDG_CONFIG_HOMEagainst.isGuardedEnvKeyis now exported from@simple-git/argv-parser, identifying the environment variables
(GIT_*and the othersgitreads, such asEDITORandPAGER) thatsimple-gitremoves from an inherited
environment. -
86fadaa: Settle on the use of
strictto refer to thesimpleGitconfiguration setting to enable strict controls,
applying to both Git impacting environment variables and writing to the Git config.Use of the
strictmode also implies the use ofunsafe.recommended -
c8ee6bb: Vulnerability reports:
With thanks to @manus-pi, @manus-use, @ba-am, @mspiq, @hoseinenddev, @freyesperales, @dalberrt,
@zer0d4y5, @gamster01, @humaneBicycle, @Hama1cco, @eliteaja11-dev, @Cone-Tester, @Figo5, @MalwareEZ,
@zachariah-mithani, @shaswata56, @Akokonunes for submitting CVE proposals that contributed to these changes.- closing the loop on any configuration setting ending with
.cmdorcommandunder the catch-all
allowUnsafeCommandBinariessetting (only enforced with the newunsafe.recommendedoption, or
strict), and blockinggpg.ssh.defaultKeyCommandunderallowUnsafeGpgProgram. allowUnsafePagerwill now catch setting a custom binary ingit grep --open-files-in-pager.allowUnsafePagernow also coversinteractive.diffFilter, the shell command thatgit add -pand the other--patchcommands pipe their diff through.- new (deprecated on arrival, prefer
allowConfig)allowUnsafeSendEmailConfigoption covering thesendemail.*keys thatgit send-emailruns as commands, reads as files or uses to turn off certificate verification (sendmailCmd,toCmd,ccCmd,headerCmd,smtpServer,smtpServerOption,smtpSSLCertPath,smtpSSLClientCert,smtpSSLClientKey,aliasesFileandmailmap.file, including their per-identitysendemail.<identity>.*variants), and theimap.tunnel,imap.hostandimap.sslVerifykeys used bygit imap-send. - new (deprecated on arrival, prefer
allowConfig)allowUnsafeWebServerConfigoption covering theinstaweb.httpd,instaweb.modulePathandinstaweb.gitwebDirkeys used bygit instaweb. - new (deprecated on arrival, prefer
allowConfig)allowUnsafeBrowseroption covering thebrowser.<tool>.path,browser.<tool>.cmd,man.<tool>.pathandman.<tool>.cmdkeys used bygit helpandgit instawebto open a browser or man page viewer.browser.<tool>.cmdandman.<tool>.cmdwere previously covered byallowUnsafeCommandBinaries. - new (deprecated on arrival, prefer
allowConfig)allowUnsafeSignatureTrustoption coveringgpg.ssh.allowedSignersFile,gpg.ssh.revocationFileandgpg.minTrustLevel, which decide which signatures pass verification. allowUnsafePacknow blocks--execfor every command other thanrebase, as it names the remote program forpush,send-pack,fetch-pack,archive --remoteandls-remote(previously onlypush).- new
allowUnsafeConfigRenameoption blockinggit config --rename-section/git config rename-section, which could move keys written under a harmless section name (eg:foo.fsmonitor) into one that runs commands (core.fsmonitor). allowUnsafeExecnow also covers thegit filter-branchoptions that run a shell command:--setup,--env-filter,--tree-filter,--index-filter,--parent-filter,--msg-filter,--commit-filterand--tag-name-filter.allowUnsafeDiffExternalnow also coversdifftool.<tool>.path, matchingmergetool.<tool>.pathunderallowUnsafeMergeDriver.
- closing the loop on any configuration setting ending with
-
ddb5b6b: Add the
unsafe.recommendedoption, enabling the checks that use broader catch-all rules (such as any configuration
key ending in.cmdorcommandunderallowUnsafeCommandBinaries). Defaults tofalse, and is implied by
strict: true. It will default totruein the next major version.Each
Vulnerabilityreported by@simple-git/argv-parsernow carries alevelofdefaultfor explicitly
identified risks, orrecommendedfor those caught by a catch-all rule. TheVulnerabilityLeveltype is exported.