Skip to content

Commit 0f67f24

Browse files
committed
address some review comments
1 parent 6956246 commit 0f67f24

2 files changed

Lines changed: 11 additions & 9 deletions

File tree

content/github/managing-security-vulnerabilities/about-disclosing-vulnerabilities.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ versions:
1010

1111
{% data reusables.security-advisory.disclosing-vulnerabilities %}
1212

13-
The initial report of a vulnerability is made privately, and the full details are only published once a patch has been made available, sometimes with a delay to allow more time for the patches to be installed. For more information, see the "[OWASP Cheat Sheet Series about vulnerability disclosure](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html#commercial-and-open-source-software)" on the OWASP Cheat Sheet Series website.
13+
The initial report of a vulnerability is made privately, and the full details are only published once the maintainer has acknowledged the issue, and ideally made remediations or a patch available, sometimes with a delay to allow more time for the patches to be installed. For more information, see the "[OWASP Cheat Sheet Series about vulnerability disclosure](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html#commercial-and-open-source-software)" on the OWASP Cheat Sheet Series website.
1414

1515
#### Best practices for security researchers
1616

17-
Security researchers should report vulnerabilities privately to maintainers. It's not acceptable to:
18-
- Disclose the vulnerability publicly
19-
- Not contact the maintainer
20-
- Disclose the vulnerability before a fixed version of the code is available
17+
Security researchers should try to report vulnerabilities privately to maintainers. When possible, please avoid:
18+
- Disclosing the vulnerability publicly
19+
- Bypassing the maintainer
20+
- Disclosing the vulnerability before a fixed version of the code is available
21+
- Expecting to be compensated for reporting an issue, where no public bounty program exists
2122

2223
It's acceptable for security researchers to disclose a vulnerability publicly after a period of time, if they have tried to contact the maintainers and not received a response, or contacted them and been asked to wait too long to disclose it.
2324

@@ -26,19 +27,20 @@ It's acceptable for security researchers to disclose a vulnerability publicly af
2627
Maintainers should disclose vulnerabilities in a timely manner. If there is a security vulnerability in your repository, you should:
2728
- Treat the vulnerability as a security issue rather than a simple bug
2829
- Plan to disclose the vulnerability responsibly
30+
- Give credit where credit is due
2931
- Aim to publish a fix as soon as you can
3032

31-
Publishing the details of a security vulnerability doesn't make maintainers look bad. Security vulnerabilities are present everywhere in sofware nowadays, and users will trust maintainers who have a clear and established process for disclosing security vulnerabilities in their code.
33+
Publishing the details of a security vulnerability doesn't make maintainers look bad. Security vulnerabilities are present everywhere in software nowadays, and users will trust maintainers who have a clear and established process for disclosing security vulnerabilities in their code.
3234

3335
### About reporting and disclosing vulnerabilities in {% data variables.product.prodname_dotcom %}
3436

35-
The process for reporting and disclosing vulnerabilities in {% data variables.product.prodname_dotcom_the_website %} is as follows:
37+
The process for reporting and disclosing vulnerabilities for projects on {% data variables.product.prodname_dotcom_the_website %} is as follows:
3638

3739
If you are a security researcher who would like report a vulnerability, first check if there is a security policy for the related repository. For more information, see "[About security policies](/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository#about-security-policies)." If there is one, follow it to understand the process before contacting the security team for that repository. If there isn't a security policy for the repository, you may try to privately contact the maintainer based on information available in the _security.md_ file.
3840

3941
{% note %}
4042

41-
**Note**: _For npm only_ - If you report a vulnerability to npm, we try to contact you privately. If you don't address the issue in a timely manner, we will disclose it. For more information, see "[Reporting malware in an npm package](https://docs.npmjs.com/reporting-malware-in-an-npm-package)" on the npm Docs website.
43+
**Note**: _For npm only_ - If we receive a report of malware in an npm package, we try to contact you privately. If you don't address the issue in a timely manner, we will disclose it. For more information, see "[Reporting malware in an npm package](https://docs.npmjs.com/reporting-malware-in-an-npm-package)" on the npm Docs website.
4244

4345
{% endnote %}
4446

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Vulnerability disclosure is an area where collaboration between security researchers and project maintainers is very important, from the moment a potentially harmful security vulnerability is found, right until a patch is available, and the vulnerability is disclosed to the world. Typically, when someone lets a maintainer know privately about a security vulnerability, the maintainer develops a fix, validates it, and notifies the repository users.
1+
Vulnerability disclosure is an area where collaboration between security researchers and project maintainers is very important, from the moment a potentially harmful security vulnerability is found, right until a vulnerability is disclosed to the world, ideally with a patch available. Typically, when someone lets a maintainer know privately about a security vulnerability, the maintainer develops a fix, validates it, and notifies the users of a project or a package.

0 commit comments

Comments
 (0)