Skip to content

Commit 213be44

Browse files
authoredMar 25, 2025
Create SECURITY.md file.
1 parent cb597d0 commit 213be44

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed
 

‎SECURITY.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the latest version receives security updates. Users are encouraged to upgrade to the latest stable release.
6+
7+
8+
## Reporting a Vulnerability
9+
10+
We take security seriously and appreciate your efforts to responsibly disclose vulnerabilities. If you believe you have found a vulnerability, please follow the guidelines below to submit a report.
11+
12+
### **What to Include in Your Report**
13+
To help us quickly understand and address the issue, please include the following sections in your report:
14+
15+
#### 1. **Summary**
16+
- A brief description of the vulnerability.
17+
18+
#### 2. **Affected Versions**
19+
- The version(s) of the project affected by the vulnerability.
20+
- Example: "Affects versions 3.4.0 to 3.6.23."
21+
22+
#### 3. **Details**
23+
- A detailed explanation of the vulnerability, including:
24+
- How to reproduce the issue (step-by-step instructions).
25+
- The code or component where the vulnerability exists.
26+
- The expected vs. actual behavior.
27+
28+
#### 4. **Proof of Concept (PoC)**
29+
- Provide a proof of concept to demonstrate the vulnerability. This could be:
30+
- Code snippets.
31+
- Screenshots or videos.
32+
- A minimal reproducible example.
33+
34+
#### 5. **Patches (if applicable)**
35+
- If you have a suggested fix or patch, include it in your report.
36+
- Example: "Sanitize user input using `DOMPurify`."
37+
38+
#### 6. **Impact**
39+
- Describe the potential impact of the vulnerability, such as:
40+
- Remote Code Execution.
41+
- CSRF.
42+
- Data exposure.
43+
- Denial of service.
44+
45+
46+
47+
### **What to Expect**
48+
- **Acknowledgement**: You will receive an acknowledgment of your report within **48 hours**.
49+
- **Timeline**: We will provide a timeline for investigating and addressing the issue.
50+
- **Updates**: You will receive regular updates on the progress of the vulnerability resolution.
51+
- **CVE ID**: If the vulnerability is confirmed, we can help you apply for a CVE ID to formally recognize the issue.
52+
53+
54+
### **Out of Scope**
55+
The following issues are considered out of scope for security reports:
56+
- Vulnerabilities in outdated or unsupported versions.
57+
- Issues related to non-security-impacting bugs or feature requests.
58+
- Vulnerabilities requiring physical access to the device or social engineering.
59+
60+
61+
62+
## Security Updates
63+
64+
We are committed to providing timely security updates for supported versions. Here’s our process:
65+
1. **Assessment**:
66+
- All reported vulnerabilities are assessed for severity and impact.
67+
2. **Patch Development**:
68+
- Patches are developed and tested in a private repository to prevent premature disclosure.
69+
3. **Release**:
70+
- Security patches are released as soon as possible, along with a detailed advisory.
71+
72+
73+
74+
## Acknowledgments
75+
76+
We deeply appreciate the efforts of security researchers and users who help us improve the security of our project.
77+
78+
79+
80+
## Contact
81+
82+
For any questions or concerns regarding security, please contact us at `security@yourproject.com`.

0 commit comments

Comments
 (0)