Skip to content

Add AGENTS.md + SECURITY.md linking the project's security model#2702

Open
potiuk wants to merge 2 commits into
apache:mainfrom
potiuk:asf-security/agents-md-security-link-2026-05-14
Open

Add AGENTS.md + SECURITY.md linking the project's security model#2702
potiuk wants to merge 2 commits into
apache:mainfrom
potiuk:asf-security/agents-md-security-link-2026-05-14

Conversation

@potiuk
Copy link
Copy Markdown
Member

@potiuk potiuk commented May 14, 2026

This is a proposal for the PMC to review — please correct,
reject, or discuss as needed.
Nothing here is a requirement;
the maintainer is the decision-maker.

This PR adds two small files at the repo root — AGENTS.md
and SECURITY.md — so an automated agent can mechanically
discover the project's existing security model.

Context: the ASF Security team is preparing Shiro for an
automated agentic security scan we're piloting. The scan
refuses to run if the model isn't discoverable by the
convention AGENTS.md → SECURITY.md → model document.
Refusing upfront beats wasting PMC reviewer cycles on a
noise-heavy run against a model the agent never found.
Discoverability is the one hard gate; everything else is
suggestion. The Security team has reached out separately on
the PMC's private list with the program details; this PR is
the public-facing repo piece.

Apache Shiro already has a good security model at
https://shiro.apache.org/security-model.html. This PR just
makes that page reachable by following the conventional
in-repo chain. Both new files are pointers; nothing about the
substantive content of the model itself changes.

Adjustments welcome on wording, file placement, or section
naming — happy to revise. If the PMC prefers different
phrasing or wants to host the model in-repo instead of on the
website, close this and we'll regroup.

The Security team uses threat-model-producer
as the rubric for what a complete model looks like. A separate
follow-up describes completeness suggestions against that
rubric (also proposals, not requirements).

@lprimak
Copy link
Copy Markdown
Contributor

lprimak commented May 14, 2026

@potiuk
Copy link
Copy Markdown
Member Author

potiuk commented May 14, 2026

ON IT :)

These two small files at the repo root let an automated agent
mechanically discover the project's existing security model
via the conventional AGENTS.md -> SECURITY.md chain. Both new
files are pointers; nothing about the substantive content of
the model at https://shiro.apache.org/security-model.html
changes.

Proposed by the ASF Security team while preparing the project
for an automated agentic security scan we're piloting. The
scan refuses to run if the model is not discoverable by that
path; refusing upfront beats wasting PMC reviewer cycles on a
noise-heavy run against a model the agent never found.
Discoverability is the only hard gate; everything else is
suggestion.

Generated-by: Claude Code (Claude Opus 4.7)
@potiuk potiuk force-pushed the asf-security/agents-md-security-link-2026-05-14 branch from d05ba00 to a890040 Compare May 14, 2026 23:32
@github-actions github-actions Bot added the xml label May 14, 2026
@lprimak
Copy link
Copy Markdown
Contributor

lprimak commented May 14, 2026

@potiuk I made minor changes to SECURITY.md, can you double-check please?

@lprimak lprimak requested review from fpapon and jbonofre May 14, 2026 23:46
@potiuk
Copy link
Copy Markdown
Member Author

potiuk commented May 15, 2026

LGTM :)

Copy link
Copy Markdown
Member

@fpapon fpapon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thanks @potiuk !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants