fix: prevent backward relative paths in readme - #2354
Open
SHAI-nikhil-chaudhary wants to merge 1 commit into
Open
fix: prevent backward relative paths in readme#2354SHAI-nikhil-chaudhary wants to merge 1 commit into
SHAI-nikhil-chaudhary wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2353
What this PR does
This PR prevents a directory traversal risk and downstream extraction failures caused by backward relative paths in the
readmefield ofpyproject.toml.Previously, if a user specified
readme = "../README.md", Hatchling would silently package the sdist with../README.mdin the archive's file list. When users attempted to extract this sdist, modern versions of Python'starfilemodule would raise a security exception (e.g.,tarfile.OutsideDestinationError), or older versions would risk overwriting files outside the extraction directory.How it was fixed
Added security checks in
backend/src/hatchling/metadata/core.pyto validate that the resolvedreadmepath resides within the project root.readme = "...") and the dictionary definition (readme = {file = "..."}).os.path.isabs()andos.path.relpath().startswith("..")to detect invalid paths.ValueErrorat build time if a violation is detected.Manual Testing
Tested locally using
--no-isolationon a mock project withreadme = "../README.md". The build now correctly fails fast before packaging: