security: restrict upload_attachment file access to upload root#113
Merged
paradoxbound merged 3 commits intomainfrom Mar 26, 2026
Merged
security: restrict upload_attachment file access to upload root#113paradoxbound merged 3 commits intomainfrom
paradoxbound merged 3 commits intomainfrom
Conversation
Prevent arbitrary filesystem reads via upload_attachment by validating file paths against a configurable root directory (BOOKSTACK_UPLOAD_ROOT env var, defaults to cwd). Uses path.resolve() to block traversal attacks via .. segments. Signed-off-by: Jim <paradoxbound@users.noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Jim <paradoxbound@users.noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The upload_attachment functional test writes to os.tmpdir(), which is outside cwd. Set uploadRoot to os.tmpdir() in the test config so the path validation allows it. Signed-off-by: Jim <paradoxbound@users.noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
stealthycat88
approved these changes
Mar 26, 2026
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
2 participants
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.
Summary
upload_attachmentpreviously accepted any filesystem path with no restriction, allowing arbitrary file reads when write mode was enabledBOOKSTACK_UPLOAD_ROOTenv var, defaults tocwd)..segments usingpath.resolve()Security
upload_attachmentBOOKSTACK_UPLOAD_ROOTChanges
packages/core/src/types.ts— adduploadRoottoBookStackConfigpackages/core/src/bookstack-client.ts— validate file path against upload root before readingpackages/stdio/src/index.ts— readBOOKSTACK_UPLOAD_ROOTenv var, log it at startuppackages/core/tests/api-methods.test.ts— 2 new tests for path restriction + traversalTest plan
npm run build— compiles without errorsnpm test— 111 tests pass (2 new security tests)npm audit— 0 vulnerabilities🤖 Generated with Claude Code