Skip to content

Commit debc3d9

Browse files
committed
Add IRP
1 parent e5fdbde commit debc3d9

4 files changed

Lines changed: 113 additions & 106 deletions

File tree

SECURITY.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
# Security Policy
22

33
If you have discovered a security vulnerability in this project, please report it
4-
privately. **Do not disclose it as a public issue.** This gives us time to work with you
5-
to fix the issue before public exposure, reducing the chance that the exploit will be
6-
used before a patch is released.
4+
privately. **Do not disclose it as a public issue.** This gives us time to work with you to fix the issue before public exposure, reducing the chance that the exploit will be used before a patch is released.
75

8-
You may submit the report in the following ways:
6+
**You may submit the report in the following ways:**
97

10-
- Github users can privately report security advisories directly here: https://github.com/jonobr1/two.js/security/advisories/new
8+
- Github users can privately report security advisories directly [here](https://github.com/jonobr1/two.js/security/advisories/new)
119

12-
- Send an email to inquiries+two.js@jono.fyi.
10+
- Send an email to [inquiries+two.js@jono.fyi](mailto:inquiries+two.js@jono.fyi).
1311

14-
Please provide the following information in your report:
12+
**Please provide the following information in your report:**
1513

1614
- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
1715
- Full paths of source file(s) related to the manifestation of the issue
@@ -21,5 +19,12 @@ Please provide the following information in your report:
2119
- Proof-of-concept or exploit code (if possible)
2220
- Impact of the issue, including how an attacker might exploit the issue
2321

24-
This project is maintained by volunteers on a reasonable-effort basis. As such,
25-
we ask that you give us 90 days to work on a fix before public exposure.
22+
This project is maintained by volunteers on a reasonable-effort basis. As such, we ask that you give us 90 days to work on a fix before public exposure.
23+
24+
<br />
25+
26+
---
27+
28+
<br />
29+
30+
_Two.js conforms to this [Incident Response Plan](https://two.js.org/incident-response-plan) in moments of security risks._

feature-request.md

Lines changed: 0 additions & 97 deletions
This file was deleted.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
pageClass: fine-print
3+
title: Two.js Incident Response Plan
4+
lang: en-US
5+
---
6+
7+
# Incident Response Plan
8+
9+
### Principles:
10+
11+
- **Transparency:** All incidents and fixes are documented here for the community.
12+
- **Stewardship:** Take responsibility for protecting users and the project.
13+
- **Protection:** Act to minimize harm and provide guidance.
14+
15+
# How Two.js Handles Incidents
16+
17+
### 1. Detection & Triage
18+
19+
- We monitor security reports sent via [security](/security) outreach, GitHub advisories, issues, and npm notifications.
20+
- If we spot a bug or report that looks like a security risk, we treat it as an incident.
21+
22+
### 2. Assessment
23+
- Check the severity:
24+
- **Critical:** npm package or repo compromised, malicious code, supply chain attack.
25+
- **High:** Vulnerabilities that allow code execution, XSS, or leak secrets.
26+
- **Medium:** Denial of service, memory leaks, or integrity issues.
27+
- **Low:** Docs defacement, minor regressions.
28+
29+
### 3. Response
30+
- Acknowledge the report (privately if sensitive, publicly if not).
31+
- For critical/high issues:
32+
- Rotate any exposed secrets/tokens.
33+
- Patch the bug or vulnerability.
34+
- Deprecate or yank affected npm versions if needed.
35+
- Rebuild and redeploy docs/site from a clean commit.
36+
- For medium/low issues:
37+
- Patch and document the fix.
38+
39+
### 4. Communication
40+
- Update this wiki page with a summary of the incident and the fix.
41+
- For major issues, we post a GitHub Release note and a pinned Issue.
42+
- Provide upgrade or mitigation steps for users.
43+
44+
### 5. Recovery & Hardening
45+
- After fixing, review what happened and update this process if needed.
46+
- Add tests or automation to prevent similar issues.
47+
- Rotate credentials and check repo/npm security settings.
48+
49+
<br />
50+
51+
---
52+
53+
# Recent Incidents & Fixes
54+
55+
<br />
56+
57+
- None at this time
58+
59+
<br />
60+
61+
---
62+
63+
**If you spot a security issue, please report it via [security](/security) outreach. We’ll respond as quickly as possible.**

wiki/security/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
pageClass: fine-print
3+
title: Two.js Security Policy
4+
lang: en-US
5+
---
6+
7+
# Security Policy
8+
9+
If you have discovered a security vulnerability in this project, please report it
10+
privately. **Do not disclose it as a public issue.** This gives us time to work with you to fix the issue before public exposure, reducing the chance that the exploit will be used before a patch is released.
11+
12+
**You may submit the report in the following ways:**
13+
14+
- Github users can privately report security advisories directly [here](https://github.com/jonobr1/two.js/security/advisories/new)
15+
16+
- Send an email to [inquiries+two.js@jono.fyi](mailto:inquiries+two.js@jono.fyi).
17+
18+
**Please provide the following information in your report:**
19+
20+
- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
21+
- Full paths of source file(s) related to the manifestation of the issue
22+
- The location of the affected source code (tag/branch/commit or direct URL)
23+
- Any special configuration required to reproduce the issue
24+
- Step-by-step instructions to reproduce the issue
25+
- Proof-of-concept or exploit code (if possible)
26+
- Impact of the issue, including how an attacker might exploit the issue
27+
28+
This project is maintained by volunteers on a reasonable-effort basis. As such, we ask that you give us 90 days to work on a fix before public exposure.
29+
30+
<br />
31+
32+
---
33+
34+
<br />
35+
36+
_Two.js conforms to this [Incident Response Plan](https://two.js.org/incident-response-plan) in moments of security risks._

0 commit comments

Comments
 (0)