-
Notifications
You must be signed in to change notification settings - Fork 307
Standardize path validation across file operations to prevent path traversal #14883
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.
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
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3617914
Initial plan
Copilot e9991c3
Add fileutil package with path validation and refactor CLI files
Copilot a371ed8
Document path validation pattern and fix linting issues
Copilot 5d9d3fd
Fix test using deprecated timeout_minutes field (#14889)
Copilot 7cebdb2
Remove integration build constraint from pkg/fileutil (#14892)
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Package fileutil provides utility functions for working with file paths and file operations. | ||
| package fileutil | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "path/filepath" | ||
| ) | ||
|
|
||
| // ValidateAbsolutePath validates that a file path is absolute and safe to use. | ||
| // It performs the following security checks: | ||
| // - Cleans the path using filepath.Clean to normalize . and .. components | ||
| // - Verifies the path is absolute to prevent relative path traversal attacks | ||
| // | ||
| // Returns the cleaned absolute path if validation succeeds, or an error if: | ||
| // - The path is empty | ||
| // - The path is relative (not absolute) | ||
| // | ||
| // This function should be used before any file operations (read, write, stat, etc.) | ||
| // to ensure defense-in-depth security against path traversal vulnerabilities. | ||
| // | ||
| // Example: | ||
| // | ||
| // cleanPath, err := fileutil.ValidateAbsolutePath(userInputPath) | ||
| // | ||
| // if err != nil { | ||
| // return fmt.Errorf("invalid path: %w", err) | ||
| // } | ||
| // | ||
| // content, err := os.ReadFile(cleanPath) | ||
| func ValidateAbsolutePath(path string) (string, error) { | ||
| // Check for empty path | ||
| if path == "" { | ||
| return "", fmt.Errorf("path cannot be empty") | ||
| } | ||
|
|
||
| // Sanitize the filepath to prevent path traversal attacks | ||
| cleanPath := filepath.Clean(path) | ||
|
|
||
| // Verify the path is absolute to prevent relative path traversal | ||
| if !filepath.IsAbs(cleanPath) { | ||
| return "", fmt.Errorf("path must be absolute, got: %s", path) | ||
| } | ||
|
|
||
| return cleanPath, nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The error text includes the unquoted raw
pathvalue. Using%q(or otherwise sanitizing) makes logs/error strings unambiguous and avoids confusing output if the path contains spaces/newlines.