fix(path): enforce filepath.Clean sanitization on cache paths and invocation directories#555
Open
HarshalPatel1972 wants to merge 1 commit into
Open
Conversation
…ocation directories
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.
Description
This PR introduces explicit
filepath.Clean()sanitization fences around user-supplied execution directory flags and runtime environment cache parameters. This prevents trailing slashes or redundant separators from propagating anomalies downstream into file operations.Technical Context
When an execution invocation sets a working directory or reads the
MAGEFILE_CACHEenvironment variables, the raw strings can infiltrate the pipeline with malformed layouts (e.g.,/tmp/mage//binor trailing delimiters).While
filepath.Joinhandles cleaning internally under specific criteria, direct usage of raw path references during isolated file lookups or short-circuit evaluations bypasses this safety net, causing native file system operations to error out with crypticno such file or directorydiagnostics.Resolution Strategy
mg/runtime.go:CacheDir()to guarantee a sanitized, consistent path configuration across all cache lookups.filepath.Clean()wrapper on the incominginv.Dirstate during early-stage flag processing inmage/main.go, cleaning up execution directory formats before child modules evaluate targets.