Add draft threat model + SECURITY.md + AGENTS.md for security-model discoverability#497
Open
potiuk wants to merge 2 commits into
Open
Add draft threat model + SECURITY.md + AGENTS.md for security-model discoverability#497potiuk wants to merge 2 commits into
potiuk wants to merge 2 commits into
Conversation
…l discoverability Adds a draft (v0) project threat model plus the SECURITY.md and AGENTS.md scaffold 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 Opus 4.8 (1M context)
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds security-related repository documentation to guide vulnerability reporting and to define an explicit threat model for triage/scoping.
Changes:
- Introduces a comprehensive threat model document for Apache JSPWiki.
- Adds a
SECURITY.mdsecurity policy with reporting instructions and a link to the threat model. - Adds an
AGENTS.mdguide to point automated tools/agents to the project’s security references.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| THREAT_MODEL.md | New threat model document defining scope, properties, and triage dispositions. |
| SECURITY.md | New security policy with private reporting guidance and threat model reference. |
| AGENTS.md | New agent-facing guide pointing scanners/AI to SECURITY.md and the threat model. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+69
to
+74
| **Component-family table:** | ||
|
|
||
| | Family | Representative entry point | Touches outside process | In model? | | ||
| | --- | --- | --- | --- | | ||
| | Wiki engine core (page CRUD, references) | `Edit.jsp` / `WikiEngine`, `jspwiki-main` | filesystem (pages) | **Yes** | | ||
| | Markup render → HTML | `jspwiki-main` render, `jspwiki-markdown` | no (CPU) | **Yes** | |
| standard Java/Jakarta EE components (servlet container), with page content | ||
| authored in JSPWiki markup (or Markdown), server-side plugins and filters, file | ||
| attachments, and JAAS-based authentication plus per-page access control lists. | ||
| - **Modelled against:** `apache/jspwiki` `master` (HEAD at time of writing, 2026-05-31). |
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.
This is a draft proposal for the JSPWiki 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 JSPWiki as the PMC says it is, not as anyone thinks it should be.
This PR adds three files:
THREAT_MODEL.md— a v0 threat model: what JSPWiki treats as in/out of scope, the trust boundaries and adversary model, the security properties it claims and disclaims (stored-XSS sanitization, ACL enforcement, attachment containment, …), the well-known wiki-engine attack classes left to the operator, and a closed set of triage dispositions.SECURITY.md— a security policy pointing at the ASF reporting process and linking the threat model.AGENTS.md— so an automated scan agent can mechanically find the model via the conventionalAGENTS.md → SECURITY.md → THREAT_MODEL.mdchain.It is draft-first and mostly inferred. Confidence is roughly 14 documented / 0 maintainer / 58 inferred — every
*(inferred)*claim is the agent's hypothesis from the code structure and wiki-engine domain norms, and each routes to a numbered question in §14 Open questions. The fastest way to review is to walk §14 (three short waves) and answer in-thread; we then promote the*(inferred)*tags to*(maintainer)*and the model firms up.The highest-leverage answers are the wave-1 ones (default anonymous-edit posture, default markup engine + raw-HTML handling, whether the asserted cookie is ever used for a security decision) — they reshape several later sections.
Context: the ASF Security team is preparing the project for an automated agentic security scan we're piloting; a complete, discoverable threat model is what keeps that scan's output signal-rich instead of noise. We drafted this via the threat-model-producer rubric. If you'd rather author the model yourselves, close this PR and we'll regroup — the offer is just to save you the blank page.