-
Notifications
You must be signed in to change notification settings - Fork 1.2k
security: drop symlinks from Hosting deploy upload list #10478
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
Open
wecbaiyk-blip
wants to merge
2
commits into
firebase:main
Choose a base branch
from
wecbaiyk-blip:security/hosting-no-follow-symlinks
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,58 @@ | ||
| import { lstatSync } from "fs"; | ||
| import { join } from "path"; | ||
| import { sync } from "glob"; | ||
|
|
||
| import { logger } from "./logger"; | ||
|
|
||
| /** | ||
| * Recursively list deployable files under `cwd`. | ||
| * | ||
| * **Security: symlinks are excluded by default.** | ||
| * | ||
| * Hosting deploys take this list, read each entry with `fs.readFile*` | ||
| * (which follows symlinks at the OS layer), and uploads the bytes to a | ||
| * Firebase Hosting site. If the source tree contains a symlink such as | ||
| * `public/leak -> /proc/self/environ` or | ||
| * `public/leak -> ~/.config/gcloud/application_default_credentials.json`, | ||
| * the target's contents would otherwise end up published on a | ||
| * Firebase-hosted public URL. | ||
| * | ||
| * The largest exposure is CI workflows that extract attacker-supplied | ||
| * tarballs into the public directory before invoking `firebase deploy` | ||
| * (e.g. PR-preview deploy actions). Both `glob({ follow: true })` and | ||
| * `glob({ follow: false })` would return symlink-to-file entries in | ||
| * the result (`follow` only controls whether symlinked *directories* | ||
| * are descended into); the explicit `lstatSync` filter below drops | ||
| * symlinks of either kind. | ||
| */ | ||
| export function listFiles(cwd: string, ignore: string[] = []): string[] { | ||
| return sync("**/*", { | ||
| const matched = sync("**/*", { | ||
| cwd, | ||
| dot: true, | ||
| follow: true, | ||
| follow: false, | ||
| ignore: ["**/firebase-debug.log", "**/firebase-debug.*.log", ".firebase/*"].concat(ignore), | ||
| nodir: true, | ||
| posix: true, | ||
| }); | ||
| const out: string[] = []; | ||
| for (const rel of matched) { | ||
| let stats; | ||
| try { | ||
| // `lstat` does NOT follow symlinks, so we can detect them and skip. | ||
| stats = lstatSync(join(cwd, rel)); | ||
| } catch { | ||
| // Stat error: skip the entry rather than risk uploading something | ||
| // we can't classify. | ||
| continue; | ||
| } | ||
| if (stats.isSymbolicLink()) { | ||
| logger.debug( | ||
| `[hosting] dropping symlink \`${rel}\` from upload list ` + | ||
| `(security: prevents symlink-following from exposing files outside the source tree)`, | ||
| ); | ||
| continue; | ||
| } | ||
| out.push(rel); | ||
| } | ||
| return out; | ||
| } |
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
afterhook should safely handle cases wheretmpRootoroutsideTargetmight be empty strings (e.g., if thebeforehook fails before they are assigned). CallingrmSync("")can throw an error, which might obscure the actual failure in the test report. Adding truthy checks makes the cleanup more robust.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.
Done — the
afterhook now guards both paths (if (tmpRoot)/if (outsideTarget)) before callingfs.rmSync, so a failure inbeforecan't turn cleanup into a confusingrmSync("")error.