Skip to content

docs(security): document filesystem capability model#79075

Open
dev111-actor wants to merge 1 commit intoopenclaw:mainfrom
dev111-actor:docs/agent-filesystem-capabilities
Open

docs(security): document filesystem capability model#79075
dev111-actor wants to merge 1 commit intoopenclaw:mainfrom
dev111-actor:docs/agent-filesystem-capabilities

Conversation

@dev111-actor
Copy link
Copy Markdown

@dev111-actor dev111-actor commented May 7, 2026

Summary

  • Problem: Explore per-agent worker isolation, VFS scratch storage, and host filesystem capabilities #78096 tracks a long-term architecture question across per-agent runtime isolation, scratch storage, and safe real-host filesystem mutation.
  • Why it matters: those layers solve different security and product problems, and blending them risks treating Node permissions or VFS scratch storage as replacements for fs-safe host mutation.
  • What changed: added a dedicated filesystem capability model doc, linked it from secure file operations, sandboxing, and security docs, and added it to Mintlify navigation.
  • What did NOT change (scope boundary): no runtime behavior, dependency, sandbox backend, or plugin API changes.

Change Type (select all)

  • Bug fix
  • Feature
  • Refactor required for the fix
  • Docs
  • Security hardening
  • Chore/infra

Scope (select all touched areas)

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

Real behavior proof (required for external PRs)

  • Behavior or issue addressed: converts the architecture tracking note into durable docs and navigation.
  • Real environment tested: local docs checkout on Linux with Node 24.15.0 and pnpm 10.33.2.
  • Exact steps or command run after this patch: pnpm exec oxfmt --check --threads=1 docs/gateway/security/filesystem-capability-model.md docs/gateway/security/secure-file-operations.md docs/gateway/sandboxing.md docs/gateway/security/index.md CHANGELOG.md docs/docs.json; node scripts/check-docs-mdx.mjs docs.
  • Evidence after fix (screenshot, recording, terminal capture, console output, redacted runtime log, linked artifact, or copied live output): copied terminal output: Docs MDX check passed (620 files, 13827ms). All matched files use the correct format. Finished in 11760ms on 5 files using 1 threads.
  • Observed result after fix: the new page passes docs validation and is present in docs/docs.json navigation under Security and sandboxing.
  • What was not tested: live Mintlify deployment.
  • Before evidence (optional but encouraged): Explore per-agent worker isolation, VFS scratch storage, and host filesystem capabilities #78096 existed only as an issue note with no docs page.

Root Cause (if applicable)

For bug fixes or regressions, explain why this happened, not just what changed. Otherwise write N/A. If the cause is unclear, write Unknown.

  • Root cause: N/A.
  • Missing detection / guardrail: N/A.
  • Contributing context (if known): N/A.

Regression Test Plan (if applicable)

For bug fixes or regressions, name the smallest reliable test coverage that should catch this. Otherwise write N/A.

  • Coverage level that should have caught this:
    • Unit test
    • Seam / integration test
    • End-to-end test
    • Existing coverage already sufficient
  • Target test or file: scripts/check-docs-mdx.mjs, oxfmt.
  • Scenario the test should lock in: docs front matter, links, MDX syntax, docs navigation JSON, and formatting stay valid.
  • Why this is the smallest reliable guardrail: this is docs-only with no runtime behavior.
  • Existing test that already covers this (if any): docs MDX check and formatter.
  • If no new test is added, why not: docs-only architecture guidance does not need runtime test coverage.

User-visible / Behavior Changes

Adds a new docs page: https://docs.openclaw.ai/gateway/security/filesystem-capability-model.

Diagram (if applicable)

Before:
[issue note] -> [no durable docs page]

After:
[issue note] -> [filesystem capability model docs] -> [linked from security/sandboxing navigation]

Security Impact (required)

  • New permissions/capabilities? (Yes/No) No
  • Secrets/tokens handling changed? (Yes/No) No
  • New/changed network calls? (Yes/No) No
  • Command/tool execution surface changed? (Yes/No) No
  • Data access scope changed? (Yes/No) No
  • If any Yes, explain risk + mitigation: N/A

Repro + Verification

Environment

  • OS: Linux
  • Runtime/container: Node 24.15.0, pnpm 10.33.2
  • Model/provider: N/A
  • Integration/channel (if any): N/A
  • Relevant config (redacted): N/A

Steps

  1. Open docs/gateway/security/filesystem-capability-model.md.
  2. Confirm docs/docs.json includes gateway/security/filesystem-capability-model under Security and sandboxing.
  3. Run the docs formatter and MDX checks.

Expected

  • Docs page exists, links resolve, navigation includes the page, and checks pass.

Actual

  • Formatter passed and docs MDX check passed for 620 files.

Evidence

Attach at least one:

  • Failing test/log before + passing after
  • Trace/log snippets
  • Screenshot/recording
  • Perf numbers (if relevant)

Human Verification (required)

What you personally verified (not just CI), and how:

  • Verified scenarios: docs page content, security/sandboxing links, docs navigation entry, changelog entry, formatter, MDX docs check.
  • Edge cases checked: Node permission wording checked against official Node permissions docs; scope states this is not a runtime implementation.
  • What you did not verify: live docs deployment.

Review Conversations

  • I replied to or resolved every bot review conversation I addressed in this PR.
  • I left unresolved only the conversations that still need reviewer or maintainer judgment.

If a bot review conversation is addressed by this PR, resolve that conversation yourself. Do not leave bot review conversation cleanup for maintainers.

Compatibility / Migration

  • Backward compatible? (Yes/No) Yes
  • Config/env changes? (Yes/No) No
  • Migration needed? (Yes/No) No
  • If yes, exact upgrade steps: N/A

Risks and Mitigations

  • Risk: readers mistake the model page for implemented VFS or worker isolation.
    • Mitigation: the page explicitly labels those as future experiments and says no runtime behavior changed.

@dev111-actor dev111-actor requested a review from a team as a code owner May 7, 2026 20:03
@openclaw-barnacle openclaw-barnacle Bot added docs Improvements or additions to documentation gateway Gateway runtime docker Docker and sandbox tooling size: XS triage: needs-real-behavior-proof Candidate: external PR needs after-fix proof from a real setup. labels May 7, 2026
@clawsweeper
Copy link
Copy Markdown
Contributor

clawsweeper Bot commented May 7, 2026

Codex review: needs maintainer review before merge.

Summary
The PR adds a filesystem capability model docs page, links it from gateway security and sandboxing docs, adds it to docs navigation, and records the docs change in the changelog.

Reproducibility: not applicable. this is a docs-only PR, not a reproducible runtime bug. Source inspection verifies current main lacks the new page and the PR adds the page, links, navigation entry, and changelog line.

Real behavior proof
Sufficient (terminal): The PR body includes copied terminal output from local docs formatting and MDX validation plus a human-verified navigation/page check, which is sufficient real behavior proof for a docs-only change.

Next step before merge
This needs maintainer/secops judgment because the docs-only PR would close a protected security architecture tracker.

Security
Needs attention: The diff is docs-only and adds no runtime or supply-chain surface, but the PR currently tries to close a protected security architecture tracker.

Review details

Best possible solution:

Keep the architecture tracker open unless secops/maintainers explicitly decide the docs page is the terminal outcome; otherwise merge the docs as partial guidance after removing the auto-close behavior.

Do we have a high-confidence way to reproduce the issue?

Not applicable: this is a docs-only PR, not a reproducible runtime bug. Source inspection verifies current main lacks the new page and the PR adds the page, links, navigation entry, and changelog line.

Is this the best way to solve the issue?

No as written: the docs addition is a reasonable partial step, but it should not automatically close the broader protected security architecture tracker. The safer path is maintainer/secops review and either remove the closing syntax or explicitly accept the docs as terminal scope.

Security concerns:

  • [medium] Do not auto-close the security design tracker
    The linked tracker still covers future worker/process isolation, VFS scratch storage, plugin/API capability boundaries, and fs-safe hardening. A docs-only PR should not close that security-sensitive maintainer item without explicit maintainer/secops approval.
    Confidence: 0.88

Acceptance criteria:

  • pnpm exec oxfmt --check --threads=1 docs/gateway/security/filesystem-capability-model.md docs/gateway/security/secure-file-operations.md docs/gateway/sandboxing.md docs/gateway/security/index.md CHANGELOG.md docs/docs.json
  • node scripts/check-docs-mdx.mjs docs

What I checked:

Likely related people:

  • steipete: The related architecture issue is assigned to steipete, and current blame for the central fs-safe and sandbox docs points to Peter Steinberger's recent security/filesystem work. (role: recent maintainer and design owner; confidence: high; commits: 2f69c40a6202; files: docs/gateway/security/secure-file-operations.md, docs/gateway/sandboxing.md, src/infra/fs-safe.ts)
  • openclaw/openclaw-secops: CODEOWNERS explicitly routes security-sensitive gateway docs and sandboxing docs to this team. (role: CODEOWNERS security reviewer; confidence: high; files: .github/CODEOWNERS, docs/gateway/security/, docs/gateway/sandboxing.md)

Remaining risk / open question:

Codex review notes: model gpt-5.5, reasoning high; reviewed against 2597723dfcc9.

@openclaw-barnacle openclaw-barnacle Bot added proof: supplied External PR includes structured after-fix real behavior proof. and removed triage: needs-real-behavior-proof Candidate: external PR needs after-fix proof from a real setup. labels May 7, 2026
@clawsweeper clawsweeper Bot added the proof: sufficient ClawSweeper judged the real behavior proof convincing. label May 7, 2026
@dev111-actor
Copy link
Copy Markdown
Author

Hi @steipete
Could you please review my PR?
Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docker Docker and sandbox tooling docs Improvements or additions to documentation gateway Gateway runtime proof: sufficient ClawSweeper judged the real behavior proof convincing. proof: supplied External PR includes structured after-fix real behavior proof. size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore per-agent worker isolation, VFS scratch storage, and host filesystem capabilities

1 participant