Skip to content

simple-git@4.1.0

Latest

Choose a tag to compare

@github-actions github-actions released this 16 Nov 18:23
cee17ab

Minor Changes

  • df13aeb: Add the allowConfig and strict options. Configuration keys outside the built-in list of known-safe keys
    (SAFE_CONFIG_KEYS) and the keys named in allowConfig now emit a one-off SIMPLE_GIT_UNLISTED_CONFIG warning,
    or are rejected when strict: true is set. Known-unsafe keys can now be permitted individually through
    allowConfig, and environment variables through allowEnvironment, deprecating the unsafe.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 binary option or git.customBinary()) may now contain spaces
    when it looks like a path to a file, for example C:\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.cmd for 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 the remoteUrl() and refName() 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: true or strict: true), HOME and XDG_CONFIG_HOME
    supplied through .env() with a value other than the one in process.env require allowUnsafeConfigPaths
    (or naming them in allowEnvironment), as git reads the global configuration from $HOME/.gitconfig and
    $XDG_CONFIG_HOME/git/config in the same way as GIT_CONFIG_GLOBAL. Passing the inherited value through is unaffected,
    and neither is removed from the inherited environment.

    parseEnv accepts the inherited environment as an optional second argument, used to compare HOME and
    XDG_CONFIG_HOME against.

    isGuardedEnvKey is now exported from @simple-git/argv-parser, identifying the environment variables
    (GIT_* and the others git reads, such as EDITOR and PAGER) that simple-git removes from an inherited
    environment.

  • 86fadaa: Settle on the use of strict to refer to the simpleGit configuration setting to enable strict controls,
    applying to both Git impacting environment variables and writing to the Git config.

    Use of the strict mode also implies the use of unsafe.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 .cmd or command under the catch-all
      allowUnsafeCommandBinaries setting (only enforced with the new unsafe.recommended option, or
      strict), and blocking gpg.ssh.defaultKeyCommand under allowUnsafeGpgProgram.
    • allowUnsafePager will now catch setting a custom binary in git grep --open-files-in-pager.
    • allowUnsafePager now also covers interactive.diffFilter, the shell command that git add -p and the other --patch commands pipe their diff through.
    • new (deprecated on arrival, prefer allowConfig) allowUnsafeSendEmailConfig option covering the sendemail.* keys that git send-email runs as commands, reads as files or uses to turn off certificate verification (sendmailCmd, toCmd, ccCmd, headerCmd, smtpServer, smtpServerOption, smtpSSLCertPath, smtpSSLClientCert, smtpSSLClientKey, aliasesFile and mailmap.file, including their per-identity sendemail.<identity>.* variants), and the imap.tunnel, imap.host and imap.sslVerify keys used by git imap-send.
    • new (deprecated on arrival, prefer allowConfig) allowUnsafeWebServerConfig option covering the instaweb.httpd, instaweb.modulePath and instaweb.gitwebDir keys used by git instaweb.
    • new (deprecated on arrival, prefer allowConfig) allowUnsafeBrowser option covering the browser.<tool>.path, browser.<tool>.cmd, man.<tool>.path and man.<tool>.cmd keys used by git help and git instaweb to open a browser or man page viewer. browser.<tool>.cmd and man.<tool>.cmd were previously covered by allowUnsafeCommandBinaries.
    • new (deprecated on arrival, prefer allowConfig) allowUnsafeSignatureTrust option covering gpg.ssh.allowedSignersFile, gpg.ssh.revocationFile and gpg.minTrustLevel, which decide which signatures pass verification.
    • allowUnsafePack now blocks --exec for every command other than rebase, as it names the remote program for push, send-pack, fetch-pack, archive --remote and ls-remote (previously only push).
    • new allowUnsafeConfigRename option blocking git 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).
    • allowUnsafeExec now also covers the git filter-branch options that run a shell command: --setup, --env-filter, --tree-filter, --index-filter, --parent-filter, --msg-filter, --commit-filter and --tag-name-filter.
    • allowUnsafeDiffExternal now also covers difftool.<tool>.path, matching mergetool.<tool>.path under allowUnsafeMergeDriver.
  • ddb5b6b: Add the unsafe.recommended option, enabling the checks that use broader catch-all rules (such as any configuration
    key ending in .cmd or command under allowUnsafeCommandBinaries). Defaults to false, and is implied by
    strict: true. It will default to true in the next major version.

    Each Vulnerability reported by @simple-git/argv-parser now carries a level of default for explicitly
    identified risks, or recommended for those caught by a catch-all rule. The VulnerabilityLevel type is exported.

Patch Changes

  • df13aeb: Add a security policy describing which inputs are safe for untrusted data.
  • Updated dependencies [df13aeb]
  • Updated dependencies [a996f0f]
  • Updated dependencies [df13aeb]
  • Updated dependencies [c8ee6bb]
  • Updated dependencies [df13aeb]
  • Updated dependencies [ddb5b6b]
    • @simple-git/argv-parser@3.0.0