Skip to content

Turn directory into string on lookup_path on commonpath comparison #2851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kludex merged 2 commits into from
Jan 24, 2025
Merged

Turn directory into string on lookup_path on commonpath comparison #2851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fba538c
Turn directory into string on `lookup_path` on commonpath comparison
Kludex Jan 24, 2025
4a06feb
remove str cast complication
Kludex Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions starlette/staticfiles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,8 @@ def lookup_path(self, path: str) -> tuple[str, os.stat_result | None]:
else:
full_path = os.path.realpath(joined_path)
directory = os.path.realpath(directory)
if os.path.commonpath([full_path, directory]) != directory:
# Don't allow misbehaving clients to break out of the static files
# directory.
if os.path.commonpath([full_path, directory]) != str(directory):
# Don't allow misbehaving clients to break out of the static files directory.
continue
try:
return full_path, os.stat(full_path)
Expand Down
15 changes: 7 additions & 8 deletions tests/test_staticfiles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,16 +576,15 @@ def test_staticfiles_avoids_path_traversal(tmp_path: Path) -> None:
assert exc_info.value.detail == "Not Found"


def test_staticfiles_self_symlinks(tmpdir: Path, test_client_factory: TestClientFactory) -> None:
statics_path = os.path.join(tmpdir, "statics")
os.mkdir(statics_path)
def test_staticfiles_self_symlinks(tmp_path: Path, test_client_factory: TestClientFactory) -> None:
statics_path = tmp_path / "statics"
statics_path.mkdir()

source_file_path = os.path.join(statics_path, "index.html")
with open(source_file_path, "w") as file:
file.write("<h1>Hello</h1>")
source_file_path = statics_path / "index.html"
source_file_path.write_text("<h1>Hello</h1>", encoding="utf-8")

statics_symlink_path = os.path.join(tmpdir, "statics_symlink")
os.symlink(statics_path, statics_symlink_path)
statics_symlink_path = tmp_path / "statics_symlink"
statics_symlink_path.symlink_to(statics_path)

app = StaticFiles(directory=statics_symlink_path, follow_symlink=True)
client = test_client_factory(app)
Expand Down