Skip to content

Commit d9307fe

Browse files
TrottMylesBorins
authored andcommitted
doc: improve security section of README.md
* Remove fluff text and get to the point: Report security flaws to [email protected]. Please do not disclose security flaws publicly until they have been handled by the security team. * Fix somewhat confusing paragraph that says there are no "hard and fast rules" but then uses _must_ in the context of a "general rule". Easiest solution seems to be to change _must_ to _should_. * Minor style change (_you will_ instead of _you'll_) PR-URL: #17929 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 9b2c98d commit d9307fe

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -172,20 +172,19 @@ Node.js from source along with a list of officially supported platforms.
172172

173173
## Security
174174

175-
All security bugs in Node.js are taken seriously and should be reported by
176-
emailing [email protected]. This will be delivered to a subset of the project
177-
team who handle security issues. Please don't disclose security bugs
178-
publicly until they have been handled by the security team.
175+
Security flaws in Node.js should be reported by emailing [email protected].
176+
Please do not disclose security bugs publicly until they have been handled by
177+
the security team.
179178

180-
Your email will be acknowledged within 24 hours, and you’ll receive a more
179+
Your email will be acknowledged within 24 hours, and you will receive a more
181180
detailed response to your email within 48 hours indicating the next steps in
182181
handling your report.
183182

184183
There are no hard and fast rules to determine if a bug is worth reporting as
185-
a security issue. The general rule is any issue worth reporting
186-
must allow an attacker to compromise the confidentiality, integrity
187-
or availability of the Node.js application or its system for which the attacker
188-
does not already have the capability.
184+
a security issue. The general rule is an issue worth reporting should allow an
185+
attacker to compromise the confidentiality, integrity, or availability of the
186+
Node.js application or its system for which the attacker does not already have
187+
the capability.
189188

190189
To illustrate the point, here are some examples of past issues and what the
191190
Security Response Team thinks of them. When in doubt, however, please do send

0 commit comments

Comments
 (0)