Skip to content

Commit e9cd061

Browse files
authored
Add incident response plan documentation (twbs#41905)
This document outlines the incident response plan for Bootstrap maintainers, detailing procedures for managing security and operational incidents, roles, responsibilities, and communication protocols.
1 parent f29a71b commit e9cd061

File tree

1 file changed

+162
-0
lines changed

1 file changed

+162
-0
lines changed

.github/INCIDENT_RESPONSE.md

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Incident response plan
2+
3+
This document describes how the Bootstrap maintainers respond to and manage security or operational incidents affecting the project, its website, or its distributed releases. This plan is public to promote transparency and community trust. Operational details (e.g., private contacts, credentials, or internal coordination tools) are maintained separately in the maintainers’ private documentation.
4+
5+
---
6+
7+
## 1. Purpose & Scope
8+
9+
This plan defines how Bootstrap maintainers will:
10+
11+
- Identify, triage, and manage security or integrity incidents affecting project code, releases, or infrastructure.
12+
- Communicate with the community and downstream consumers during and after an incident.
13+
- Record lessons learned and update processes to reduce future risk.
14+
15+
It applies to:
16+
17+
- The Bootstrap source code, documentation, and build pipelines.
18+
- Release artifacts (npm, CDN, GitHub releases).
19+
- The main website ([https://getbootstrap.com](https://getbootstrap.com)).
20+
- Any official Bootstrap GitHub organization infrastructure.
21+
22+
It does **not** cover unrelated third-party forks or integrations.
23+
24+
---
25+
26+
## 2. Definitions
27+
28+
- **Incident**: Any event that could compromise the confidentiality, integrity, or availability of Bootstrap code, releases, or users. Examples include:
29+
- A discovered security vulnerability.
30+
- A compromised GitHub account or CI/CD token.
31+
- A malicious dependency or injected code in a release.
32+
- Website defacement or unauthorized modification of documentation.
33+
- Leaked secrets related to the project infrastructure.
34+
35+
- **Incident Commander (IC)**: The maintainer responsible for coordinating the overall response.
36+
37+
---
38+
39+
## 3. Roles & Responsibilities
40+
41+
| Role | Responsibilities |
42+
|------|-------------------|
43+
| **Incident Commander (IC)** | Coordinate the response, assign tasks, ensure timely communication. |
44+
| **Security Maintainers** | Triage reported vulnerabilities, assess impact, create fixes, handle embargoes. |
45+
| **Infrastructure Lead** | Manage CI/CD, website, and release infrastructure. |
46+
| **Communications Lead** | Manage public announcements, blog posts, and social updates. |
47+
| **Contributors & Community** | Promptly report suspected security issues and follow responsible disclosure guidelines. |
48+
49+
In practice, Bootstrap’s core team fulfills these roles collectively, assigning an IC on a per-incident basis.
50+
51+
---
52+
53+
## 4. Incident workflow
54+
55+
### 4.1 Detection & Reporting
56+
57+
- All security issues should be **privately reported** via the contact method in [`SECURITY.md`](../SECURITY.md) or through GitHub’s Security Advisory mechanism.
58+
- Maintainers also monitor:
59+
- Automated dependency scanners (e.g., Dependabot, npm audit).
60+
- GitHub notifications and vulnerability alerts.
61+
- Community channels for suspicious activity.
62+
63+
### 4.2 Initial triage
64+
65+
Upon receiving a report:
66+
67+
1. A maintainer acknowledges receipt within 3 business days (or sooner, when possible).
68+
Bootstrap is maintained by a small volunteer team; response times may vary slightly outside normal working hours.
69+
2. The IC assesses severity and impact:
70+
- **Critical:** immediate compromise of release infrastructure or code integrity.
71+
- **High:** exploitable vulnerability in distributed assets.
72+
- **Medium:** minor vulnerability or low-likelihood attack vector.
73+
- **Low:** informational, no direct risk.
74+
3. If confirmed as an incident, the IC opens a private coordination channel for maintainers and begins containment.
75+
76+
### 4.3 Containment & Eradication
77+
78+
- Revoke or rotate any affected credentials.
79+
- Disable compromised infrastructure or build pipelines if necessary.
80+
- Patch affected branches or dependencies.
81+
- Verify integrity of artifacts and releases.
82+
83+
### 4.4 Communication
84+
85+
- Keep the reporting party informed (when applicable).
86+
- For major incidents, the Communications Lead drafts a public advisory describing:
87+
- What happened
88+
- What was impacted
89+
- How users can verify or mitigate
90+
- What actions were taken
91+
- Communications occur after containment to avoid amplifying risk.
92+
93+
Public disclosures are posted via:
94+
95+
- GitHub Security Advisory if appropriate
96+
- [blog.getbootstrap.com/](https://blog.getbootstrap.com/)
97+
- [Bootstrap GitHub discussions](https://github.com/orgs/twbs/discussions)
98+
- [@getbootstrap](https://x.com/getbootstrap) on X (formerly Twitter) for critical security notices.
99+
100+
### 4.5 Recovery
101+
102+
- Validate all systems and releases are secure.
103+
- Resume normal operations.
104+
- Tag patched releases and notify affected users.
105+
106+
### 4.6 Post-incident review
107+
108+
Within two weeks after resolution:
109+
110+
- Conduct an internal debrief.
111+
- Record:
112+
- Root cause
113+
- What worked / what didn’t
114+
- Remediation steps
115+
- Documentation or automation updates needed
116+
- Summarize lessons learned in the private maintainers’ wiki (with optional public summary if appropriate).
117+
118+
---
119+
120+
## 5. Severity levels & Response targets
121+
122+
| Severity | Example | Target response (volunteer team) |
123+
|-----------|----------|----------------------------------|
124+
| **Critical** | Compromised release, stolen signing keys | Acknowledge ≤ 24h (best effort), containment ≤ 48h, fix ideally ≤ 14d |
125+
| **High** | Vulnerability enabling arbitrary code execution | Acknowledge ≤ 3 business days, fix ideally ≤ 14–21d |
126+
| **Medium** | XSS or content injection on docs site | Acknowledge ≤ 5 business days, fix in next release cycle |
127+
| **Low** | Minor issue with limited risk | Acknowledge ≤ 7 business days, fix as scheduled |
128+
129+
**Note:** Timelines represent good-faith targets for a small volunteer core team, not hard SLAs. The maintainers will always prioritize public safety and transparency, even if timing varies.
130+
131+
---
132+
133+
## 6. Public disclosure principles
134+
135+
Bootstrap follows a responsible disclosure approach:
136+
137+
- Work privately with reporters and affected parties before publishing details.
138+
- Never name reporters without consent.
139+
- Coordinate embargo periods with downstream consumers when needed.
140+
- Publish advisories only after patches or mitigations are available.
141+
142+
---
143+
144+
## 7. Communication Channels
145+
146+
| Purpose | Channel |
147+
|----------|----------|
148+
| Private reporting | Email address in [`SECURITY.md`](./SECURITY.md) or GitHub advisory form |
149+
| General updates | [blog.getbootstrap.com/](https://blog.getbootstrap.com/) blog |
150+
| Security advisories | GitHub Security Advisory dashboard |
151+
| Social alerts | [@getbootstrap](https://x.com/getbootstrap) |
152+
| GitHub discussion alerts | [github.com/orgs/twbs/discussions](https://github.com/orgs/twbs/discussions) |
153+
154+
---
155+
156+
## 8. Plan Maintenance
157+
158+
This plan is reviewed at least annually or after any major incident. Changes are approved by the Core Team and recorded in Git history.
159+
160+
---
161+
162+
_The Bootstrap maintainers are committed to transparency, user trust, and continuous improvement in our security and response practices._

0 commit comments

Comments
 (0)