docs: add draft threat model + SECURITY.md/AGENTS.md discoverability#3734
Open
potiuk wants to merge 2 commits into
Open
docs: add draft threat model + SECURITY.md/AGENTS.md discoverability#3734potiuk wants to merge 2 commits into
potiuk wants to merge 2 commits into
Conversation
Generated-by: Claude Code
Generated-by: Claude Code
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
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.
What this is
A draft threat model for Apache Fory, proposed by the ASF Security team for the Fory PMC to review, correct, or reject. It is a starting point for discussion, not a finished document.
This PR:
THREAT_MODEL.md— the draft model, following the ASF Security threat-model rubric;SECURITY.md— a short security policy that links the threat model;## Securitysection toAGENTS.md, so the chainAGENTS.md → SECURITY.md → THREAT_MODEL.mdis mechanically discoverable by automated security scanners.How to read it
Every claim is provenance-tagged: (documented) (from Fory's own docs/repo), (inferred) (reasoned from the architecture, not yet confirmed), (maintainer) (confirmed by the PMC). This v0 is ~20 documented / ~26 inferred. The §14 Open questions section collects every inferred claim into waves for the PMC to confirm or correct — that is where review time is best spent. The highest-impact ones:
requireClassRegistration(true), only registered types are instantiated from untrusted bytes" is a committed property, and whether findings that requirerequireClassRegistration(false)are out-of-model / non-default (wave 1);maxDepth(waves 2).Nothing here is a requirement — the model is for the PMC to own. Comment inline, edit the branch, or reply on the email thread.
AI Usage Disclosure
THREAT_MODEL.mdwas drafted by the ASF Security team's threat-model tooling (Claude) from Apache Fory's public documentation and repository, following the Scovetta rubric.SECURITY.mdand theAGENTS.mdSecurity section are templated scaffolding.