Skip to content

Commit 13d0295

Browse files
authored
Create vuln report template
1 parent 0ab6219 commit 13d0295

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

docs/report-template.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
*This vulnerability report template is offered to you by the GitHub Security Lab. Use it as an inspiration for your own reports. Reporting a vulnerability using this template does not imply that this report has been acknowledged by the GitHub Security Lab. Remove this first section and any mention of the GitHub Security Lab when you use this template.*
2+
3+
# Vulnerability Report
4+
5+
I identified potential security vulnerabilities in [product].
6+
7+
I am committed to working with you to help resolve these issues. In this report you will find everything you need to effectively coordinate a resolution of these issues.
8+
9+
If at any point you have concerns or questions about this process, please do not hesitate to reach out to me at [email].
10+
11+
If you are _NOT_ the correct point of contact for this report, please let me know!
12+
13+
## Summary
14+
15+
*Short summary of the problem. Make the impact and severity as clear as possible. For example: An unsafe deserialization vulnerability allows any unauthenticated user to execute arbitrary code on the server.*
16+
17+
## Product
18+
19+
[product]
20+
21+
## Tested Version
22+
23+
[version]
24+
25+
## Details
26+
27+
*Give all details on the vulnerability. Pointing to the incriminated source code is very helpful for the maintainer.*
28+
29+
## PoC
30+
31+
*Complete instructions, including specific configuration details, to reproduce the vulnerability*
32+
33+
## Impact
34+
35+
[impact]
36+
37+
## Remediation
38+
39+
*Propose a remediation suggestion if you have one. Make it clear that this is just a suggestion, as the maintainer might have a better idea to fix the issue.*
40+
41+
## GitHub Security Advisories
42+
43+
We recommend you create a private [GitHub Security Advisory](https://help.github.com/en/github/managing-security-vulnerabilities/creating-a-security-advisory) for these findings. This also allows you to invite me to collaborate and further discuss these findings in private before they are [published](https://help.github.com/en/github/managing-security-vulnerabilities/publishing-a-security-advisory). I will be happy to collaborate with you, and review your fix to make sure that all corner cases are covered.
44+
When you use a GitHub Security Advisory, you can request a CVE identification number from GitHub. GitHub usually reviews the request within 72 hours, and the CVE details will be published after you make your security advisory public. Publishing a GitHub Security Advisory and a CVE will help notify the downstream consumers of your project, so they can update to the fixed version.
45+
46+
## Credit
47+
48+
*List all researchers who contributed to this disclosure.*
49+
*Mention if you found the vulnerability with a specific tool.*
50+
51+
## Contact
52+
53+
[contact]
54+
55+
## Disclosure Policy
56+
57+
*Describe or link to your disclosure policy.*

0 commit comments

Comments
 (0)