Skip to content

docs(security): add public docs folder with security overview#644

Merged
chaliy merged 1 commit intomainfrom
claude/add-docs-security-rsPqt
Mar 16, 2026
Merged

docs(security): add public docs folder with security overview#644
chaliy merged 1 commit intomainfrom
claude/add-docs-security-rsPqt

Conversation

@chaliy
Copy link
Contributor

@chaliy chaliy commented Mar 16, 2026

What

Adds a top-level docs/ folder for public-facing documentation, starting with a security overview article.

Why

Bashkit has extensive internal security documentation (specs, threat model, rustdoc guides) but no user-facing summary. This gives users a single entry point to understand the security model.

How

  • docs/security.md: High-level security article covering:
    • Core security boundaries (VFS, no process execution, network allowlist, resource limits)
    • Threat model overview with all TM-* categories
    • Link to the published rustdoc threat model
    • POSIX deviations made for security
    • Security testing layers (threat model tests, fail-point injection, network/error/logging tests, fuzzing, differential tests)
    • Panic safety
    • How to report vulnerabilities (security@everruns.com)
  • AGENTS.md: Updated Documentation section to distinguish docs/ (public) from crates/bashkit/docs/ (rustdoc)

Tests

Docs-only change. All 2000+ existing tests pass. fmt and clippy clean.

@chaliy chaliy merged commit 07bcdf8 into main Mar 16, 2026
11 checks passed
@chaliy chaliy deleted the claude/add-docs-security-rsPqt branch March 16, 2026 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant