Skip to content

docs: add security considerations to the root option #296

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.

Sign up for GitHub

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
UlisesGascon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add security considerations to the root option #296

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,14 @@ This can also be a string accepted by the

Serve files relative to `path`.

**Important:** The `root` option restricts the served path through string-level
normalization only. It does not resolve symbolic links. If the served
directory contains symlinks, they may resolve to files outside the root.

Do not serve directories where untrusted users can create files or symlinks.
If your application accepts file uploads or operates in a shared/multi-tenant
environment, ensure the served directory is not writable by untrusted parties.

##### start

Byte offset at which the stream starts, defaults to 0. The start is inclusive,
Expand Down