chore(security): add draft threat model and SECURITY.md for security-model discoverability#3509
Conversation
…ecurity-model discoverability Adds a draft (v0) project threat model plus a SECURITY.md, and links both from AGENTS.md so an automated scan agent can mechanically discover the model via AGENTS.md -> SECURITY.md -> THREAT_MODEL.md. The threat model is a proposal for the PMC to review; most claims are (inferred) and route to open questions in its section 14. Generated-by: Claude Code (Claude Opus 4.8)
Generated-by: Claude Code
|
Thanks @PragmaTwice — pushed a revision folding your answers in: replica-cluster peers are trusted (out of model); strict per-namespace keyspace confinement with admin-only metadata; Lua confined to the namespace (no host access); no per-namespace encryption claimed; |
|
Thanks @PragmaTwice — all your answers are folded in, and every §14 question is now resolved /
I've replied on and resolved the open threads. The model is the PMC's to merge whenever — thanks for the thorough review. |
This is a draft proposal for the Kvrocks PMC to review — please correct, reject, or discuss as needed. Nothing here is a requirement; the maintainers are the decision-makers, and this document describes Kvrocks as the PMC says it is.
This PR adds
THREAT_MODEL.md+SECURITY.mdand a Security section inAGENTS.md, so an automated scan agent can mechanically find the model viaAGENTS.md → SECURITY.md → THREAT_MODEL.md.It is draft-first and mostly inferred (~16 documented / 0 maintainer / ~50 inferred). Every
*(inferred)*claim routes to a numbered question in §14 Open questions — the fastest review is to walk §14 (three short waves) and answer in-thread; we then promote the tags to*(maintainer)*.The wave-1 rulings are load-bearing:
requirepass(the default) a supported posture relying onbind/network controls, or must operators set it before exposing the port — i.e. is an unauthenticated-access reportBY-DESIGNorVALID?apache/kvrocks-controlleris in scope for the scan too; per §14 q10 it will get its own model (its trust surface — the cluster control plane — differs), which we'll open as a separate PR.Context: the ASF Security team is preparing the project for an automated agentic security scan we're piloting; a complete, discoverable threat model keeps that scan's output signal-rich. We drafted this via the threat-model-producer rubric. If you'd rather author it yourselves, close this PR and we'll regroup.