Skip to content

Add a draft security threat model and discoverability files (AGENTS.md, SECURITY.md)#2248

Open
potiuk wants to merge 1 commit into
apache:masterfrom
potiuk:threat-model-and-discoverability
Open

Add a draft security threat model and discoverability files (AGENTS.md, SECURITY.md)#2248
potiuk wants to merge 1 commit into
apache:masterfrom
potiuk:threat-model-and-discoverability

Conversation

@potiuk

@potiuk potiuk commented Jun 13, 2026

Copy link
Copy Markdown
Member

This is a proposal for the PMC to review, own, and merge — please correct, reject, or discuss as needed. Nothing here is a requirement, and the threat model is explicitly a v0 draft for you to react to.

This PR adds three files to apache/mynewt-nimble (the BLE host + controller stack):

  • THREAT_MODEL.md — a v0 security threat model, drafted by the ASF Security team from the repository's public artefacts against a standard rubric (Michael Scovetta's). Every claim is provenance-tagged (documented / maintainer / inferred); since no maintainer has reviewed it yet, most claims are inferred, and each is routed to a numbered question in §14 "Open questions for the maintainers". Please treat it as a starting point, not a finished document.
  • SECURITY.md — a standard security-reporting policy (report privately to security@apache.org) that links to the threat model.
  • AGENTS.md — a small pointer file so automated tooling can mechanically discover the model via the conventional AGENTS.md → SECURITY.md → THREAT_MODEL.md chain.

Context: the ASF Security team is preparing this repository for an automated agentic security scan we're piloting. Such scans look for the model along that discoverability chain and run far less noisily when a model stating what is and isn't a security concern is present. The Security team has reached out separately on the PMC's private list with the program details.

The single most useful thing you can do with this PR is to work through the §14 questions — those are where we inferred a position and would value your confirmation or correction. Wording, scope, and structure are all open; merge, request changes, or take it over as you see fit.

Adds a v0 THREAT_MODEL.md (for the PMC to review, own, and merge)
plus AGENTS.md and SECURITY.md providing the conventional
AGENTS.md -> SECURITY.md -> THREAT_MODEL.md discoverability chain.
All three files are new and carry the ASF license header.

Generated-by: Claude Opus 4.8 (1M context)
@potiuk potiuk force-pushed the threat-model-and-discoverability branch from 4b772e7 to 907bce0 Compare June 17, 2026 02:38
@potiuk

potiuk commented Jun 17, 2026

Copy link
Copy Markdown
Member Author

Update: added the ASF license header to the three added files and tidied the commit message — Licensing and "Check commit messages" now pass and the rest of CI is green. Ready for review whenever convenient.

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.

1 participant