Skip to content

Commit 4afab37

Browse files
authored
Enhance security policy with detailed guidelines
Expanded the security policy to include detailed reporting methods, security scope, response processes, and guidelines for responsible disclosure.
1 parent 299edd7 commit 4afab37

1 file changed

Lines changed: 318 additions & 0 deletions

File tree

‎SECURITY.md‎

Lines changed: 318 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,318 @@
1+
# Security Policy
2+
3+
Security is important to this project. We appreciate security researchers,
4+
developers, contributors, and users who responsibly report potential
5+
security vulnerabilities.
6+
7+
## Supported Versions
8+
9+
Security updates are generally provided for the latest maintained version
10+
of this project.
11+
12+
| Version | Supported |
13+
| ------- | --------- |
14+
| Latest release / main branch | ✅ |
15+
| Older versions | ❌ |
16+
17+
Users are encouraged to use the latest available version.
18+
19+
## Reporting a Vulnerability
20+
21+
Please do **not** report security vulnerabilities through public GitHub
22+
issues, discussions, pull requests, or other public channels.
23+
24+
If you believe you have discovered a security vulnerability, please report
25+
it privately.
26+
27+
### Preferred Reporting Method
28+
29+
Use GitHub Private Vulnerability Reporting for this repository when it is
30+
available.
31+
32+
This allows the repository maintainers to review and investigate the report
33+
privately before vulnerability information becomes public.
34+
35+
## Security Contact
36+
37+
For security-related questions or vulnerability reports, use one of the
38+
following methods:
39+
40+
- **Preferred:** GitHub Private Vulnerability Reporting
41+
- **Repository owner:** `beer-sakthai`
42+
- **Security email:** `[ADD YOUR SECURITY EMAIL HERE]`
43+
44+
When reporting by email, please use:
45+
46+
**Subject:** `Security Vulnerability Report`
47+
48+
Do not include sensitive vulnerability information in public GitHub issues,
49+
discussions, or pull requests.
50+
51+
## What to Include in a Report
52+
53+
Please provide as much of the following information as possible:
54+
55+
- A clear description of the vulnerability
56+
- The affected component, workflow, dependency, file, or feature
57+
- The affected version or commit, if known
58+
- Steps required to reproduce the issue
59+
- The potential security impact
60+
- Relevant logs or screenshots with sensitive information removed
61+
- Proof-of-concept information, when appropriate
62+
- Any suggested mitigation or fix
63+
- Your preferred contact information for follow-up
64+
65+
Detailed reports help maintainers investigate security issues more
66+
efficiently.
67+
68+
## Security Scope
69+
70+
Security reports may include vulnerabilities involving:
71+
72+
- Source code
73+
- GitHub Actions workflows
74+
- Dependencies
75+
- Authentication
76+
- Authorization
77+
- Access control
78+
- Secrets or credentials exposure
79+
- Code injection
80+
- Configuration vulnerabilities
81+
- Supply-chain security
82+
- Dependency vulnerabilities
83+
- Unexpected exposure of sensitive information
84+
- Insecure handling of user or application data
85+
86+
General bugs that do not have a security impact should be reported through
87+
the normal GitHub issue tracker.
88+
89+
## Secrets and Credentials
90+
91+
Never include real passwords, API keys, access tokens, private keys,
92+
certificates, authentication cookies, or other active credentials in a
93+
vulnerability report.
94+
95+
If you believe a credential belonging to this project has been exposed,
96+
report the issue privately as soon as possible.
97+
98+
Affected credentials may be rotated or revoked as part of the security
99+
response.
100+
101+
## Responsible Disclosure
102+
103+
Please give the project maintainers a reasonable opportunity to investigate
104+
and address a reported vulnerability before publicly disclosing it.
105+
106+
Please avoid:
107+
108+
- Publishing vulnerability details before a fix or mitigation is available
109+
- Creating public issues containing sensitive security information
110+
- Accessing or modifying data that does not belong to you
111+
- Attempting to obtain unnecessary sensitive information
112+
- Disrupting services or systems
113+
- Performing destructive security testing
114+
- Using a vulnerability beyond what is necessary to demonstrate the issue
115+
116+
## Security Response Process
117+
118+
After receiving a security report, maintainers will aim to:
119+
120+
1. Acknowledge and review the report.
121+
2. Determine the preliminary severity.
122+
3. Attempt to reproduce and validate the vulnerability.
123+
4. Evaluate the affected components and potential impact.
124+
5. Identify an appropriate mitigation or fix.
125+
6. Develop and test the security fix when necessary.
126+
7. Release the fix through an appropriate project update.
127+
8. Coordinate responsible disclosure when appropriate.
128+
9. Publish a GitHub Security Advisory when appropriate.
129+
130+
Priority and response targets are determined according to the
131+
Severity-Based Response Policy below.
132+
133+
## Severity-Based Response Policy
134+
135+
Reported vulnerabilities are reviewed and prioritized according to their
136+
potential impact, exploitability, affected users, exposure of sensitive
137+
information, and overall risk.
138+
139+
The following response targets are guidelines rather than guaranteed
140+
service-level agreements (SLAs).
141+
142+
| Severity | Examples | Initial Response Target | Remediation Target |
143+
| -------- | -------- | ----------------------- | ------------------ |
144+
| 🔴 Critical | Remote code execution, authentication bypass, exposed secrets with significant impact, major supply-chain compromise | Within 24 hours | As soon as reasonably possible |
145+
| 🟠 High | Privilege escalation, significant authorization bypass, serious data exposure, exploitable workflow or dependency vulnerabilities | Within 2 business days | Typically within 7 days |
146+
| 🟡 Medium | Limited information disclosure, vulnerabilities requiring significant user interaction or specific conditions | Within 5 business days | Typically within 30 days |
147+
| 🟢 Low | Minor security weaknesses, hardening opportunities, or issues with limited practical impact | Within 10 business days | Addressed as resources and release schedules allow |
148+
149+
### Critical Vulnerabilities
150+
151+
Critical vulnerabilities receive the highest priority.
152+
153+
When a critical vulnerability is confirmed, maintainers may:
154+
155+
1. Restrict public discussion of the issue.
156+
2. Investigate the affected code, dependency, workflow, or configuration.
157+
3. Develop and test an appropriate mitigation or fix.
158+
4. Rotate or revoke affected secrets or credentials when necessary.
159+
5. Release an emergency security update when appropriate.
160+
6. Coordinate responsible disclosure after remediation.
161+
162+
### Severity Assessment
163+
164+
Severity may be adjusted during investigation as additional information
165+
becomes available.
166+
167+
Factors considered may include:
168+
169+
- Attack complexity
170+
- Required privileges
171+
- User interaction
172+
- Confidentiality impact
173+
- Integrity impact
174+
- Availability impact
175+
- Scope of affected users or systems
176+
- Exposure of secrets or credentials
177+
- Supply-chain impact
178+
- Availability of mitigations
179+
- Likelihood of exploitation
180+
181+
Where appropriate, industry-standard vulnerability scoring approaches,
182+
such as CVSS, may be used to help assess severity.
183+
184+
### Response Times
185+
186+
Response and remediation targets are goals, not guarantees.
187+
188+
Some vulnerabilities may require additional investigation, dependency
189+
updates, coordination with third-party maintainers, or significant
190+
architectural changes.
191+
192+
Security reporters should receive updates when there is meaningful progress
193+
on a confirmed vulnerability.
194+
195+
## Dependency and Supply-Chain Security
196+
197+
This project may depend on third-party libraries, packages, GitHub Actions,
198+
development tools, or other software.
199+
200+
Security issues originating in third-party dependencies may also need to be
201+
reported to the relevant project's maintainers.
202+
203+
Where practical, the project aims to:
204+
205+
- Keep dependencies up to date
206+
- Review security-related dependency updates
207+
- Address known vulnerabilities
208+
- Reduce unnecessary dependencies
209+
- Review automated dependency security alerts
210+
- Maintain secure GitHub Actions workflows
211+
- Avoid exposing credentials or secrets in workflows
212+
213+
## Security Updates
214+
215+
Security-related fixes may be delivered through:
216+
217+
- Repository commits
218+
- Pull requests
219+
- Dependency updates
220+
- GitHub Actions workflow changes
221+
- Configuration changes
222+
- Patches
223+
- New project releases
224+
225+
Users should keep their local copies, dependencies, and integrations up to
226+
date.
227+
228+
## Public Security Advisories
229+
230+
When appropriate, confirmed vulnerabilities may be documented using GitHub
231+
Security Advisories following remediation or coordinated disclosure.
232+
233+
An advisory may contain information about:
234+
235+
- The affected versions
236+
- The vulnerability severity
237+
- The security impact
238+
- Available mitigations
239+
- Fixed versions
240+
- Upgrade recommendations
241+
242+
## Good-Faith Security Research
243+
244+
We appreciate responsible, good-faith security research intended to improve
245+
the security of this project.
246+
247+
Researchers should make reasonable efforts to:
248+
249+
- Protect user and project data
250+
- Respect privacy
251+
- Avoid unnecessary access to sensitive information
252+
- Avoid disruption or degradation of services
253+
- Avoid destructive testing
254+
- Report discovered vulnerabilities privately
255+
- Allow reasonable time for investigation and remediation
256+
257+
Security testing should be limited to what is reasonably necessary to
258+
identify and demonstrate a vulnerability.
259+
260+
## Out of Scope
261+
262+
The following generally do not require a private security report unless
263+
they create a genuine security risk:
264+
265+
- Feature requests
266+
- General software bugs
267+
- Documentation errors
268+
- Unsupported versions
269+
- Cosmetic issues
270+
- Issues without a demonstrable security impact
271+
- Vulnerabilities that only affect intentionally unsafe configurations
272+
273+
These issues may normally be submitted through the project's standard
274+
GitHub issue tracker.
275+
276+
## Privacy
277+
278+
Please minimize the collection, storage, or sharing of personal or sensitive
279+
information while conducting security research.
280+
281+
If sensitive information is encountered unintentionally:
282+
283+
1. Stop accessing the information.
284+
2. Do not copy, distribute, publish, or retain it unnecessarily.
285+
3. Report the issue privately.
286+
4. Include only the minimum information necessary to explain the security
287+
issue.
288+
289+
## Coordinated Disclosure
290+
291+
If a vulnerability affects another project, package, dependency, or service,
292+
the maintainers may coordinate disclosure with the relevant third party.
293+
294+
Please avoid publicly disclosing the vulnerability until affected parties
295+
have had a reasonable opportunity to investigate and address the issue.
296+
297+
## Security Acknowledgements
298+
299+
We appreciate researchers and contributors who help improve the security of
300+
this project through responsible disclosure.
301+
302+
Where appropriate and agreed upon, contributors who responsibly report
303+
confirmed vulnerabilities may be acknowledged in release notes, security
304+
advisories, or project documentation.
305+
306+
## Policy Changes
307+
308+
This security policy may be updated as the project evolves.
309+
310+
Please review the latest version of this file before submitting a security
311+
report.
312+
313+
## Thank You
314+
315+
Thank you for helping keep this project and its users secure.
316+
317+
Responsible vulnerability reports help improve the security, reliability,
318+
and trustworthiness of the project.

0 commit comments

Comments
 (0)