Skip to content

Commit ae333ca

Browse files
committed
add INCIDENT_RESPONSE.md
1 parent 580598d commit ae333ca

2 files changed

Lines changed: 42 additions & 1 deletion

File tree

INCIDENT_RESPONSE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Incident Response Plan
2+
3+
This document describes how Sniffnet handles security incidents. <br>
4+
For how to *report* a vulnerability, see [`SECURITY.md`](https://github.com/GyulyVGC/sniffnet/blob/main/SECURITY.md).
5+
6+
## Scope
7+
8+
An incident is anything that compromises, or could compromise, the integrity
9+
or safety of Sniffnet or its users:
10+
11+
- a vulnerability in Sniffnet or one of its dependencies
12+
- a tampered release artifact or compromised signing key
13+
- unauthorized commits, tags, or releases
14+
- a compromised maintainer account or the [sniffnet.net](https://sniffnet.net) website
15+
16+
## Roles
17+
18+
- **Incident Lead**: the project maintainer
19+
([@GyulyVGC](https://github.com/GyulyVGC)). Owns the response and all
20+
external communication.
21+
- **Reporter**: credited in the final advisory unless they prefer otherwise.
22+
- **Trusted contributors**: may be invited into the private advisory to help
23+
fix or review.
24+
25+
## Process
26+
27+
1. **Triage.** Open a private
28+
[GitHub Security Advisory](https://github.com/GyulyVGC/sniffnet/security/advisories)
29+
to track the issue. Confirm it reproduces and assess impact.
30+
2. **Contain.** If needed, withdraw affected releases, revoke exposed secrets
31+
or keys, or revert unauthorized changes.
32+
3. **Fix.** Develop and review the patch privately. Add a regression test
33+
where possible. Rotate anything that might have been exposed.
34+
4. **Release.** Ship a patched version through the usual channels.
35+
5. **Disclose.** Publish the advisory (request a CVE if applicable) and note
36+
the fix in [`CHANGELOG.md`](https://github.com/GyulyVGC/sniffnet/blob/main/CHANGELOG.md).
37+
6. **Review.** Write a short post-mortem and file follow-up issues for any
38+
gaps it exposes.
39+
40+
Nothing about an unfixed issue is discussed in public issues, PRs, or commit
41+
messages until disclosure.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Please do the following:
2020

2121
What we promise:
2222

23-
- We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date
23+
- We will respond to your report with our evaluation and an expected resolution date
2424
- If you have followed the instructions above, we will not take any legal action against you in regard to the report
2525
- We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission
2626
- We will keep you informed of the progress towards resolving the problem

0 commit comments

Comments
 (0)