Skip to content

Commit e8edab5

Browse files
docs: Add a security policy (#6692)
* docs: Add a security policy The repository has no SECURITY.md in any location, including the org-level .github repo, and neither the README nor the contributing guide mentions vulnerability reporting. Private vulnerability reporting is enabled and in active use, but with no policy file GitHub only surfaces it on the Security tab, so a reporter has to already know to look there. Issue #3684 shows the cost: a researcher asked how to disclose privately in July 2023, was pointed at Slack, and waited seven months for a contact address which then bounced. Disclosure completed only via a maintainer's personal email, and the gap itself was never closed. Adds a policy routing to the advisory form, states plainly that vulnerabilities must not go in issues, PRs, or Slack, and points the contributing guide's getting-started step at it, since that step currently sends everything to an issue or draft PR. Claims no response-time commitment and lists no email address: the maintainers can add those if they want them. Signed-off-by: Larry Singleton <166439969+larrysingleton007@users.noreply.github.com> * docs: Add report quality requirements to the security policy Adds the three points ntkathole asked for in review: a duplicate check against published advisories before reporting, explicit report requirements (affected version, proof of concept or reproduction steps, actual impact), and a statement that unverified bulk, automated or AI-generated submissions may be closed without further response. Folded into the existing reporting section rather than appended as new sections, since the previous text already asked for reproduction detail and the advisories link already existed at the bottom. Also notes why raw scanner output alone is not enough: it does not establish that the issue is reachable in Feast. Signed-off-by: Larry Singleton <166439969+larrysingleton007@users.noreply.github.com> --------- Signed-off-by: Larry Singleton <166439969+larrysingleton007@users.noreply.github.com>
1 parent 4efb86c commit e8edab5

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Security Policy
2+
3+
The Feast community takes security bugs seriously, and we appreciate the effort it takes to find and report them. We follow [GitHub's coordinated disclosure process](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities) so that a fix can be prepared before details become public.
4+
5+
## Reporting a vulnerability
6+
7+
Report vulnerabilities privately through GitHub, using **[Report a vulnerability](https://github.com/feast-dev/feast/security/advisories/new)** on this repository's Security tab. Only the maintainers can see the report, and you will be credited on the published advisory if you would like to be.
8+
9+
Before reporting, please check the [published advisories](https://github.com/feast-dev/feast/security/advisories) to confirm the issue has not already been addressed.
10+
11+
A report needs to show a clear, reproducible security impact. Please include:
12+
13+
- the affected version or commit, and the configuration involved
14+
- a proof of concept, or steps that reproduce the issue
15+
- the actual impact, rather than a theoretical concern
16+
17+
Raw scanner or dependency-audit output does not meet that bar on its own, since it does not establish that the issue is reachable in Feast. Reports that have not been manually verified against Feast, including bulk, automated, or AI-generated submissions, may be closed without further response.
18+
19+
> [!WARNING]
20+
> Do not open a public GitHub issue, pull request, or Slack message for a security vulnerability. Those are visible to everyone and disclose the problem before a fix exists.
21+
22+
For anything that is not a vulnerability, including hardening suggestions and questions about how Feast's authentication and authorization work, a normal [GitHub issue](https://github.com/feast-dev/feast/issues) is the right place.
23+
24+
## Supported versions
25+
26+
Security fixes are applied to the latest release. Feast releases roughly monthly and offers best-effort community support, as described in the [versioning policy](docs/project/versioning-policy.md); there is no long-term support branch, so upgrading to the current release is the supported way to receive a fix.
27+
28+
## Published advisories
29+
30+
Past advisories for this project are listed under [Security advisories](https://github.com/feast-dev/feast/security/advisories).

docs/project/contributing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ After familiarizing yourself with the documentation, the simplest way to get sta
55
1. Setup your developer environment by following [development guide](development-guide.md).
66
2. Either create a [GitHub issue](https://github.com/feast-dev/feast/issues) or make a draft PR (following [development guide](development-guide.md)) to get the ball rolling!
77

8+
> **Reporting a security vulnerability?** Do not open an issue or PR. Report it privately through [GitHub's advisory form](https://github.com/feast-dev/feast/security/advisories/new); see the [security policy](https://github.com/feast-dev/feast/blob/master/SECURITY.md).
9+
810
## Decision making process
911
*See [governance](../../community/governance.md) for more details here*
1012

0 commit comments

Comments
 (0)