Skip to content

Fix leading slash in path which creates a problem for S3 when URL path has double slashes #1494

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix leading slash in path which creates a problem for S3 when URL path has double slashes #1494

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
3a3d7d8
Remove leading slash during clean_name to fix S3 access denied issue
mbocevski Mar 3, 2025
8f364bc
Add tests for leading slashes in path
mbocevski Mar 3, 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: 5 additions & 0 deletions storages/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ def clean_name(name):
if clean_name == ".":
clean_name = ""

# If name starts with a leading slash, s3 will throw an access denied error
# so we remove the leading slash
if name.startswith("/"):
clean_name = name[1:]

return clean_name


Expand Down
2 changes: 2 additions & 0 deletions tests/test_s3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,14 @@ def test_storage_url_slashes(self):
self.storage.custom_domain = "example.com"

# We expect no leading slashes in the path,
# However if we encounter a leading slash we clean and remove it
# and trailing slashes should be preserved.
self.assertEqual(self.storage.url(""), "https://example.com/")
self.assertEqual(self.storage.url("path"), "https://example.com/path")
self.assertEqual(self.storage.url("path/"), "https://example.com/path/")
self.assertEqual(self.storage.url("path/1"), "https://example.com/path/1")
self.assertEqual(self.storage.url("path/1/"), "https://example.com/path/1/")
self.assertEqual(self.storage.url("/path/1"), "https://example.com/path/1")

def test_storage_save(self):
"""
Expand Down
11 changes: 8 additions & 3 deletions tests/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ def test_clean_name_trailing_slash(self):
path = utils.clean_name("path/to/somewhere/")
self.assertEqual(path, "path/to/somewhere/")

def test_clean_name_leading_slash(self):
"""Test the clean_name when the path has a leading slash."""
path = utils.clean_name("/path/to/somewhere")
self.assertEqual(path, "path/to/somewhere")

def test_clean_name_windows(self):
"""Test the clean_name when the path has a trailing slash."""
path = utils.clean_name("path\\to\\somewhere")
Expand Down Expand Up @@ -189,15 +194,15 @@ def test_with_string_file(self):
# bytes when encoding with utf-8 vs windows-1252 vs utf-16

def test_with_string_file_specified_encoding(self):
content = "\u2122\u20AC\u2030"
content = "\u2122\u20ac\u2030"
file = io.StringIO(content)
file_wrapped = utils.ReadBytesWrapper(file, encoding="utf-16")

# test read() returns specified encoding
self.assertEqual(file_wrapped.read(), content.encode("utf-16"))

def test_with_string_file_detect_encoding(self):
content = "\u2122\u20AC\u2030"
content = "\u2122\u20ac\u2030"
with open(
file=os.path.join(
os.path.dirname(__file__), "test_files", "windows-1252-encoded.txt"
Expand All @@ -214,7 +219,7 @@ def test_with_string_file_detect_encoding(self):
self.assertEqual(file_wrapped.read(), content.encode("windows-1252"))

def test_with_string_file_fallback_encoding(self):
content = "\u2122\u20AC\u2030"
content = "\u2122\u20ac\u2030"
file = io.StringIO(content)
file_wrapped = utils.ReadBytesWrapper(file)

Expand Down