-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #333 from tofuutils/docs/add-md-files
feat: add SECURITY.md
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
```release-note:enhancement | ||
Add SECURITY.md file | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
## Security | ||
|
||
Thank you for taking the time to contribute to the security of [tofuutils/tenv](https://github.com/tofuutils/tenv). This document outlines the steps to report vulnerabilities and our approach to addressing security issues. Please report it to us as described below. | ||
|
||
## Reporting Security Issues | ||
|
||
**Please do not report security vulnerabilities through public GitHub issues.** | ||
|
||
If you discover a vulnerability, please follow these steps: | ||
|
||
1. Contact us directly via the secure channels listed below. | ||
2. Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: | ||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) | ||
* Full paths of source file(s) related to the manifestation of the issue | ||
* The location of the affected source code (tag/branch/commit or direct URL) | ||
* Any special configuration required to reproduce the issue | ||
* Step-by-step instructions to reproduce the issue | ||
* Proof-of-concept or exploit code (if possible) | ||
* Impact of the issue, including how an attacker might exploit the issue | ||
* Any suggested fixes. | ||
|
||
This information will help us triage your report more quickly. | ||
|
||
## Preferred Languages | ||
|
||
We prefer all communications to be in English. | ||
|
||
## Contact | ||
Email: [security@example.com](mailto:security@example.com) | ||
GPG Key (Optional): [Link to GPG Key] | ||
Response time: We aim to respond to all reports as quickly as possible and provide a timeline for resolution. | ||
|
||
## Disclosure Policy | ||
|
||
We follow a responsible disclosure process: | ||
1. Acknowledge receipt of the vulnerability report. | ||
2. Assess and prioritize the issue based on severity. | ||
3. Work on a fix and test the solution. | ||
4. Release a patch and publicly announce the resolution. |