Skip to content

[SPARK-56998]Add SECURITY.md + AGENTS.md Security section for scan-agent discoverability#55933

Open
potiuk wants to merge 3 commits into
apache:masterfrom
potiuk:asf-security/discoverability-2026-05-18
Open

[SPARK-56998]Add SECURITY.md + AGENTS.md Security section for scan-agent discoverability#55933
potiuk wants to merge 3 commits into
apache:masterfrom
potiuk:asf-security/discoverability-2026-05-18

Conversation

@potiuk
Copy link
Copy Markdown
Member

@potiuk potiuk commented May 17, 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 adds a SECURITY.md to the repo root and a Security section to the existing AGENTS.md so an automated scan agent can mechanically discover the project's security model via the conventional AGENTS.md → SECURITY.md → model URL chain. The chain terminates at the existing https://spark.apache.org/docs/latest/security.html page — nothing about the model content itself changes.

Context: the ASF Security team is preparing the project for an automated agentic security scan we're piloting. Such scans refuse to run if the model isn't discoverable by that path (refusing upfront beats wasting PMC reviewer cycles on a noise-heavy run against an unknown model). 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.

The Security team uses threat-model-producer as the rubric for what a complete model looks like — but this PR is just the link; the existing security.html content is accepted as the model.

After this lands on master, the same two files would need to be on branch-3.5 for the second scan target — happy to open a cherry-pick PR for that, or leave it to the PMC.

Questions / pushback welcome. Happy to adjust the wording or move the section if the project has a house style.

potiuk and others added 2 commits May 18, 2026 00:48
…bility

Adds a SECURITY.md to the repo root and a Security section at the end of
the existing AGENTS.md so an automated scan agent can mechanically
discover the project's security model via the conventional
AGENTS.md -> SECURITY.md -> model URL chain. The chain terminates at the
existing https://spark.apache.org/docs/latest/security.html document.

Generated-by: Claude Code (Claude Opus 4.7)
@HyukjinKwon
Copy link
Copy Markdown
Member

I think we should probably file a JIRA though.

@gatorsmile gatorsmile changed the title Add SECURITY.md + AGENTS.md Security section for scan-agent discoverability [SPARK-56998]Add SECURITY.md + AGENTS.md Security section for scan-agent discoverability May 21, 2026
@gatorsmile
Copy link
Copy Markdown
Member

Added a JIRA

Comment thread AGENTS.md Outdated

Agents that scan this repository should consult `SECURITY.md`
for the project's threat model, in-scope / out-of-scope
declarations, and known non-findings before reporting issues.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

super nit: the existing style in this file is to not add line breakers manually. A long line still renders well in modern markdown editors and github web.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done in 0998f04 — unwrapped to a single line.

Comment thread SECURITY.md Outdated

## Reporting a vulnerability

To report a security vulnerability in Apache Spark, follow the
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ditto for this file

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done in 0998f04 — all three paragraphs unwrapped to single lines.

Per the existing style in AGENTS.md (paragraphs are single
long lines; markdown renderers handle wrap), unwrap the added
Security section in AGENTS.md and the body paragraphs in
SECURITY.md.

Generated-by: Claude Code (Claude Opus 4.7)
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.

4 participants