Skip to content

Commit 5c8c397

Browse files
Add cComprehensive security policy and vulnerability reporting process (#9747)
Signed-off-by: Joe Isaacs <[email protected]>
1 parent 85b70cf commit 5c8c397

3 files changed

Lines changed: 112 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,9 @@ Please **do** read [CONTRIBUTING.md](CONTRIBUTING.md) before you contribute.
207207

208208
### Reporting Vulnerabilities
209209

210-
If you discover a security vulnerability, please email <[email protected]>.
210+
If you discover a security vulnerability, please email <[email protected]>. See
211+
[SECURITY.md](SECURITY.md) for our full security policy, including emergency reporting and CRA
212+
stewardship.
211213

212214
### Trademarks
213215

‎REUSE.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ SPDX-License-Identifier = "CC-BY-4.0"
2828
# Utility code.
2929

3030
[[annotations]]
31-
path = ["**/README.md", "AGENTS.md", "**/AGENTS.md", "CLAUDE.md", "CONTRIBUTING.md", "STYLE.md", "tsc/**.md"]
31+
path = ["**/README.md", "AGENTS.md", "**/AGENTS.md", "CLAUDE.md", "CONTRIBUTING.md", "SECURITY.md", "STYLE.md", "tsc/**.md"]
3232
SPDX-FileCopyrightText = "Copyright the Vortex contributors"
3333
SPDX-License-Identifier = "CC-BY-4.0"
3434

‎SECURITY.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in Vortex, please email <[email protected]>.
6+
Please do not report security vulnerabilities through public GitHub issues, discussions, or pull
7+
requests.
8+
9+
To help us triage quickly, include where possible:
10+
11+
- the affected crate, binding, or component and the version or commit you tested against;
12+
- a description of the issue and its impact;
13+
- steps to reproduce, a proof of concept, or a minimal failing input (for example, a crafted
14+
Vortex file);
15+
- whether the issue is publicly known or being actively exploited.
16+
17+
If you believe the vulnerability is being actively exploited, or you are reporting a severe
18+
incident, follow the [emergency process](#emergency-process) below instead.
19+
20+
## Response Targets
21+
22+
These are targets the maintainers work to, not contractual commitments. Vortex is maintained by
23+
a community of volunteers and employees of several companies.
24+
25+
| Report type | Acknowledgement | Escalation to the CRA steward |
26+
| ----------- | --------------- | ----------------------------- |
27+
| Regular vulnerability report | Within 3 business days | Not required |
28+
| Emergency (`URGENT`) report | Within 24 hours | Immediately, and no later than 24 hours after the maintainers become aware |
29+
30+
## Regular Process
31+
32+
This process applies to vulnerabilities that are not known to be actively exploited.
33+
34+
1. **Report.** The reporter emails <[email protected]> with the details listed above.
35+
2. **Acknowledge.** A maintainer replies to confirm receipt, usually within 3 business days.
36+
3. **Triage.** The maintainers reproduce the issue, assess its severity and affected
37+
versions, and decide whether it is a security vulnerability. If it is not, we explain why and
38+
may ask the reporter to open a public issue instead.
39+
4. **Fix.** The maintainers develop a fix privately, using a
40+
[GitHub security advisory](https://github.com/vortex-data/vortex/security/advisories) and its
41+
temporary private fork where appropriate. We keep the reporter informed of progress and may
42+
ask them to validate the fix.
43+
5. **Release.** The fix ships in the next Vortex release. For high-severity issues we cut a
44+
release as soon as the fix is ready rather than waiting for the regular cadence.
45+
6. **Disclose.** Once the fixed release is available we publish the advisory, request a CVE
46+
through GitHub, and credit the reporter unless they ask to remain anonymous. We ask
47+
reporters to hold public disclosure until the fix is released, and we aim to release a fix
48+
within 90 days of the report.
49+
50+
## Emergency Process
51+
52+
This process applies to:
53+
54+
- a vulnerability in Vortex that is being actively exploited; or
55+
- a severe security incident affecting the project, for example a compromise of the release or
56+
build process, a published crate, wheel, or binary, project signing keys, or maintainer
57+
credentials.
58+
59+
Steps for reporters:
60+
61+
1. Email <[email protected]> immediately with `URGENT` at the start of the subject line.
62+
2. Include everything you know about the exploitation or compromise, including how you became
63+
aware of it. Do not wait to prepare a full write-up.
64+
65+
Steps for maintainers, in order:
66+
67+
1. **Acknowledge** the report within 24 hours and confirm whether it meets the emergency
68+
criteria above.
69+
2. **Notify the CRA steward.** Notify the project's CRA steward contact at the Linux
70+
Foundation immediately, and in any case within 24 hours of becoming aware. The steward has
71+
its own regulatory deadlines starting from that moment. Do this in parallel with fixing the
72+
problem, never instead of fixing it.
73+
3. **Inform the TSC.** Notify the Vortex Technical Steering Committee so that more than one
74+
maintainer is coordinating the response.
75+
4. **Contain.** Limit further harm before working on a full fix, for example by yanking a
76+
compromised crate or wheel, revoking exposed credentials or tokens, and pausing release
77+
workflows.
78+
5. **Fix and release.** Develop and release a fix or mitigation as quickly as possible. Follow
79+
the regular process for the fix itself, compressed to whatever timeline the situation
80+
demands.
81+
6. **Disclose.** Publish an advisory as soon as a fix or mitigation is available, including
82+
guidance for users who cannot upgrade immediately.
83+
7. **Keep the steward updated.** Send the steward any further information it needs for its
84+
follow-up notifications and final report, including confirmation of when the fix was
85+
released.
86+
87+
## Supported Versions
88+
89+
Vortex is under active development and has not yet reached a 1.0 release. Security fixes are
90+
released in the next release from the `develop` branch and are not backported to earlier
91+
releases. Please keep your dependency on Vortex up to date.
92+
93+
## Intended Use
94+
95+
Vortex is published as general-purpose open-source software. It is intended for, and is used
96+
in, commercial products and services as well as non-commercial use.
97+
98+
## CRA Stewardship
99+
100+
Vortex is a project of the LF AI & Data Foundation, hosted as Vortex a Series of LF Projects, LLC.
101+
LF AI & Data is supported under the Linux Foundation CRA stewardship framework. The LF AI & Data
102+
Foundation's CRA steward is The Linux Foundation and its policy is available at
103+
<https://www.linuxfoundation.org/security>.
104+
105+
Under the EU Cyber Resilience Act (CRA), The Linux Foundation, as open-source software steward,
106+
is responsible for regulatory reporting of actively exploited vulnerabilities and severe security
107+
incidents to ENISA. The Vortex project does not operate its own CRA reporting function; it
108+
reports to its steward through the emergency process described above.

0 commit comments

Comments
 (0)