docs: warn that static file serving follows symlinks under web_root#1305
Merged
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f3f04d0ea6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Operators control web_root contents, so a symlink there is a trusted deployment artifact. Clarify that SQLPage follows such symlinks during static file serving, meaning a symlink under web_root pointing to reserved/private files (sqlpage/ config, dotfiles) or to files outside web_root would make those targets publicly reachable. Note added to SECURITY.md (Out of Scope), cross-referenced from the web_root row in configuration.md and an Unreleased CHANGELOG entry.
f3f04d0 to
f908858
Compare
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.
SQLPage's static file serving follows symlinks under
web_rootand does not reject the resolved target. The threat model already treatsweb_rootcontents as a trusted deployment artifact (anything that can write there controls the app), so a symlink there is operator-controlled. The hazard worth spelling out: a symlink underweb_rootpointing at reserved/private files (thesqlpage/config dir, dotfiles) or at files outsideweb_rootmakes those targets publicly reachable over HTTP, bypassing the untrusted-path guard that blocks direct requests for those names.This is an operator hazard, not a remote vulnerability, so it belongs in the docs next to the existing deployment-artifact guidance.
Changes (docs only, no code change, no CHANGELOG entry):
SECURITY.mdOut of Scope: one bullet stating SQLPage follows symlinks during static serving and operators must not point them at private files or outsideweb_root.configuration.mdweb_rootrow: one-line cross-reference.