Skip to content

Commit 3527e02

Browse files
authored
Enhance SECURITY.md with protection and reporting details
Expanded security policy with guidelines on staying protected and reporting vulnerabilities.
1 parent 59487c3 commit 3527e02

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We prioritize the security of our users by providing regular patches and updates. Our support policy is as follows:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 5.1.x | :white_check_mark: |
10+
| 5.0.x | :x: |
11+
| 4.0.x | :white_check_mark: |
12+
| < 4.0 | :x: |
13+
14+
## How to Stay Protected
15+
16+
**1.Upgrade Promptly:** We strongly recommend running the latest version to ensure you have the newest features and security protections.
17+
18+
**2.Monitor Advisories:** Subscribe to our security mailing list or check our GitHub security advisories page.
19+
20+
**3.Check Version:** Use command --version to verify your current version.
21+
22+
If you are running a version listed as End of Life, you should upgrade immediately to avoid security risks.
23+
24+
*For more information on how we handle security vulnerabilities, please refer to our Security Policy.*
25+
26+
## Reporting a Vulnerability
27+
28+
Please do not report security vulnerabilities through public GitHub issues.
29+
30+
## Reporting Security Issues
31+
32+
If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
33+
34+
Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.
35+
36+
Instead, please send an email to opensource-security[@]github.com.
37+
38+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
39+
40+
- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
41+
- Full paths of source file(s) related to the manifestation of the issue
42+
- The location of the affected source code (tag/branch/commit or direct URL)
43+
- Any special configuration required to reproduce the issue
44+
- What version(s) you've tested on and what other versions you think may be affected
45+
- The environment in which you tested the exploit, including but not limited to OS family/version and Python version
46+
- Step-by-step instructions to reproduce the issue
47+
- Proof-of-concept or exploit code (if possible)
48+
- Impact of the issue, including how an attacker might exploit the issue
49+
- This information will help us triage your report more quickly.
50+
51+
> [!IMPORTANT]
52+
> IMPORTANT! No information should be made public about the vulnerability until it is formally announced at the end of this process. That means, for example that a GitHub Issue must NOT be created to track the issue since that will make the issue public. Also the messages associated with any commits should not make ANY reference to the security nature of the commit.
53+
54+
**If the issue is confirmed as a vulnerability, the team will proceed to create a private GitHub security advisory within the affected package's GitHub repo**
55+
56+
**Once the fix is ready, it will be merged back into the original repository and a release will be generated. The private security advisory will also be published (i.e. made public) so that package users can be notified in a timely manner.**

0 commit comments

Comments
 (0)