Skip to content

Add draft threat model + SECURITY.md + AGENTS.md for security-model discoverability#106

Open
potiuk wants to merge 1 commit into
apache:masterfrom
potiuk:asf-security/threat-model-2026-05-31
Open

Add draft threat model + SECURITY.md + AGENTS.md for security-model discoverability#106
potiuk wants to merge 1 commit into
apache:masterfrom
potiuk:asf-security/threat-model-2026-05-31

Conversation

@potiuk
Copy link
Copy Markdown
Member

@potiuk potiuk commented May 31, 2026

This is a draft proposal for the Synapse PMC to review — please correct, reject, or discuss as needed. Nothing here is a requirement; the maintainers are the decision-makers.

This PR adds THREAT_MODEL.md + SECURITY.md + AGENTS.md, wiring AGENTS.md -> SECURITY.md -> THREAT_MODEL.md.

The model's framing: Synapse is a mediation engine, not a finished app. The integration developer authors the config (sequences, scripts, XSLT/XQuery, endpoints, security); that config is trusted input, while the inbound message from a network client is the untrusted adversary. So properties are conditional, and the integrator-responsibilities section carries weight.

Draft-first, mostly inferred (~12 documented / 0 maintainer / ~48 inferred); every *(inferred)* claim routes to a numbered §14 question. The wave-1 rulings decide VALID-vs-misconfiguration:

  • Do the message builders and XSLT/XQuery mediators disable DTD / external-entity / document() resolution on untrusted inbound messages by default (so an XXE/SSRF-via-transform report against defaults is VALID)?
  • Are there default message-size / depth / streaming limits bounding XML DoS?

Also flagged: dynamic/content-based endpoint resolution as an SSRF surface, and confirming script/XSLT/XQuery bodies are trusted config.

Context: the ASF Security team is preparing the project for an automated agentic security scan we're piloting. Drafted via the threat-model-producer rubric. If you'd rather author it yourselves, close this PR and we'll regroup.

…l discoverability

Adds a draft (v0) threat model plus SECURITY.md and AGENTS.md so an automated
scan agent can discover the model via AGENTS.md -> SECURITY.md -> THREAT_MODEL.md.
The 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)
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