-
Notifications
You must be signed in to change notification settings - Fork 9.7k
Prevent writing outside of the workspace roots #6178
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
Conversation
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.
Summary of Changes
Hello @scidomino, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a security vulnerability that allowed the agent to write files outside of its designated workspace roots by exploiting symbolic links, particularly with non-existent paths. It enhances path validation to ensure that even if a target path does not yet exist, its fully resolved and canonical location is checked against the workspace boundaries, preventing malicious writes.
Highlights
- Enhanced Security for File Writes: Patches a security vulnerability where an agent could use symlinks to write files outside the defined workspace, specifically targeting scenarios where the destination path did not yet exist.
- Robust Path Resolution: Introduces a new private utility method,
fullyResolvedPath, which correctly resolves symbolic links and determines the canonical path, even for non-existent file paths, by catching and interpretingENOENTerrors fromfs.realpathSync. - Improved Workspace Path Validation: Updates the
isPathWithinWorkspacemethod to leverage the newfullyResolvedPathutility, ensuring that all path checks, regardless of whether the file exists, accurately verify if the path falls within the allowed workspace directories.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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.
Code Review
This pull request aims to fix a security vulnerability that allows writing outside the workspace via symlinks. The approach is to fully resolve paths, including for non-existent files, before checking if they are within the workspace.
However, the current implementation of fullyResolvedPath is based on an incorrect assumption about the error object from fs.realpathSync, which leaves the vulnerability unfixed. I've provided a critical review comment with a corrected, recursive implementation that properly resolves paths even when they don't exist. This change is essential for the security fix to be effective.
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
|
Can you add tests? |
jacob314
left a comment
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.
Please also add a test to for this case.
f96bc0f to
1c554f7
Compare
|
You were right to suggest adding tests. In doing so I realized there was another corner case we weren't covering. Working on that now. |
1c554f7 to
461367c
Compare
d881781 to
ca6a849
Compare
ca6a849 to
1e4d4a5
Compare
|
Ok! This is ready to review now. Sorry for the delay. |
jacob314
left a comment
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.
Co-authored-by: Jacob Richman <[email protected]>
Co-authored-by: Jacob Richman <[email protected]>
Co-authored-by: Jacob Richman <[email protected]>
Co-authored-by: Jacob Richman <[email protected]>
Co-authored-by: Jacob Richman <[email protected]>

TLDR
Closes a security hole that allowed the agent to use symlinks to write outside the workspace.
Dive Deeper
#4605 prevented reading outside the workspace but didn't fully resolve non-existent paths allowing the agent to write.
Reviewer Test Plan
Ask GCLI to create a symlink to an outside dir and then ask it to write a file to it.
Testing Matrix
Linked issues / bugs
Fixes #1121