esp-idf/tools
Frantisek Hrbata 647c485a76 feat(docker): allow to add paths into git's safe.directory
With 8959555cee7e[1] ("setup_git_directory(): add an owner check for the top..")
git added an ownership check of the git directory and refuses to
run any git commands, even parsing the config file, if the git directory
is not owned by the current user. The "fatal: detected dubious ownership in repository"
is reported.

This fixes CVE-2022-24765[2], which allows to compromise user account. On a
multi-user system or e.g. on a shared file system, one user may create a "rogue"
git repository with e.g. core.fsmonitor set to an arbitrary command. Other user
may unwillingly execute this command by running e.g. git-diff or
git-status within the "rogue" git repository, which may be in one of the parent
directories. If e.g. PS1 is set to display information about a git
repository in CWD, as suggested in Git in Bash[3], the user do not need to run
any git command to trigger this, just entering some subdirectory under
this "rogue" git repository is enough, because the git command will be
started transparently through the script used in PS1. The core.fsmonitor
can be set to arbitrary command. It's purpose is to help git to identify changed files
and speed up the scanning for changed files.

rogue
├── .git     # owned by user1
└── dir1     # owned by user2
    ├── dir2 # owned by user2
    └── .git # owned by user2

user1 sets core.fsmonitor for git repository in rogue directory
$ git config --add core.fsmonitor "bash -c 'rm -rf \$HOME'"

user2 enters dir1 and runs e.g. git diff and triggers the core.fsmonitor command.

The ownership check may cause problems when running git commands in
ESP-IDF Docker container. For example user may run the container as
root, but the mounted project may be owned by a particular user.

In this case git will refuse to execute any git command within the
"/project" directory, because it's not owned by root. To overcome this,
git allows to set safe.directories, for which the ownership check is
skipped. The security check may be completely disabled by setting
safe.directories to "*". This solution was proposed in PR 12636[4], but
it would allow make it possible to exploit this vulnerability again.

This fix allows user to specify git's safe.directory in IDF_GIT_SAFE_DIR
environmental variable, which may be set during container startup.

The IDF_GIT_SAFE_DIR has same format as PATH and multiple directories can be
specified by using a ":" separator. To entirely disable this git security check
within the container, user may set IDF_GIT_SAFE_DIR='*'. This might be
heplfull in CI.

Closes https://github.com/espressif/esp-idf/pull/12636

[1] - 8959555cee
[2] - https://nvd.nist.gov/vuln/detail/cve-2022-24765
[3] - https://git-scm.com/book/en/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Bash
[4] - https://github.com/espressif/esp-idf/pull/12636

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-11-30 12:18:40 +01:00
..
ble feat: add requirements.ttfw.txt 2022-08-01 15:52:21 +08:00
catch Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
ci Merge branch 'test/improve_sdmmc_tests' into 'master' 2023-11-30 10:21:11 +08:00
cmake feat(esp32c5): add esp32c5 target in kconfig and tools 2023-11-28 16:14:17 +08:00
docker feat(docker): allow to add paths into git's safe.directory 2023-11-30 12:18:40 +01:00
esp_app_trace fix: Replace deprecated flushregs alias with full gdb command 2023-07-13 09:26:47 +02:00
esp_prov ci: remove ttfw related files 2023-10-16 10:23:09 +02:00
gen_soc_caps_kconfig docs(soc): improved soc caps generation documentation 2023-11-17 10:43:59 +08:00
idf_py_actions Merge branch 'fix/coredump_port' into 'master' 2023-11-30 18:40:23 +08:00
kconfig_new feat(tools/kconfig): add initial and current versions of IDF to kconfig 2023-07-10 17:01:51 +02:00
ldgen fix(ldgen): duplicate entries in the generated .ld file 2023-09-12 11:20:12 +08:00
mass_mfg docs: Update CN for nvs_flash.rst and flash-encryption.rst 2023-07-14 04:05:53 +00:00
mocks feat(rmt): move the driver to a new component 2023-11-25 00:29:53 +00:00
requirements feat(ci): Merge tool test jobs and produce jUnit reports 2023-11-27 09:11:35 +01:00
templates/sample_component add new command to idf 2020-09-21 23:38:52 +02:00
test_apps Merge branch 'test/improve_sdmmc_tests' into 'master' 2023-11-30 10:21:11 +08:00
test_build_system feat(ci): add test for custom cmake CMAKE_EXECUTABLE_SUFFIX 2023-11-16 08:14:19 +01:00
test_idf_py Merge branch 'feat/all_components' into 'master' 2023-10-16 17:40:12 +08:00
test_idf_tools feat(tools): Add QEMU 8.0.0_20230522 to tools.json 2023-10-10 09:59:38 +07:00
test_mkdfu mkdfu.py: Support setting flash parameters 2022-05-27 15:44:56 +02:00
test_sbom fix(test_submodules.py): don't rely on submodule init 2023-06-29 10:47:24 +02:00
unit-test-app feat(rmt): move the driver to a new component 2023-11-25 00:29:53 +00:00
check_python_dependencies.py bug(tools): dependency check catch exception when package not installed 2023-08-28 16:03:15 +02:00
check_term.py check_term: allow alacritty term 2022-05-19 11:10:59 +08:00
detect_python.fish feat: Drop Python 3.7 support 2023-08-08 08:37:29 +02:00
detect_python.sh feat: Drop Python 3.7 support 2023-08-08 08:37:29 +02:00
eclipse-code-style.xml
format.sh ci: add astyle pre-commit check 2023-09-27 08:43:45 +02:00
gdb_panic_server.py feat(tools): remove gdb_panic_server and use just a wrapper for script 2023-08-24 15:20:29 +02:00
gen_esp_err_to_name.py tool: skip test folder when generating esp_err_t table 2022-11-10 10:37:59 +08:00
generate_debug_prefix_map.py build: create BUILD_DIR/prefix_map_gdbinit when enable reproducible build 2021-10-26 10:55:00 +08:00
idf_monitor.py feat(idf_monitor): move idf_monitor to separate repo 2023-02-03 11:20:15 +01:00
idf_size.py tools: Move out idf_size.py in favour of using the esp-idf-size package 2023-03-27 19:40:33 +02:00
idf_tools.py feat(tools): Added IDF path order check for Windows platform 2023-10-24 15:34:41 +02:00
idf.py feat(tools): Added IDF path order check for Windows platform 2023-10-24 15:34:41 +02:00
install_util.py ci: remove ttfw related files 2023-10-16 10:23:09 +02:00
mkdfu.py tools: remove the dependency on the future package 2022-08-09 16:46:58 +02:00
mkuf2.py feat(tools): move uf2 generation to esptool 2023-10-09 15:38:30 +02:00
python_version_checker.py feat: Drop Python 3.7 support 2023-08-08 08:37:29 +02:00
requirements_schema.json Tools: Make easier the detection of the list of Python features 2022-02-03 19:02:14 +01:00
requirements.json ci: remove ttfw related files 2023-10-16 10:23:09 +02:00
set-submodules-to-github.sh
split_paths_by_spaces.py tools: fixup version references related to paths with spaces 2022-05-02 19:05:47 +02:00
tools_schema.json feat(tools): Option in tools.json to rename toolchanis being downloaded 2023-10-17 12:28:02 +02:00
tools.json feat(esp32c5): add esp32c5 target in kconfig and tools 2023-11-28 16:14:17 +08:00