summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2017-12-31 20:54:56 -0800
committerMyles Borins <mylesborins@google.com>2018-02-12 19:28:32 -0500
commit12db4d97b24a7bb90f91b64d2e0810179a632f98 (patch)
tree5563820e3c3e7d360779afb1a2d2da3a8a275c33
parentb79189b9b678bedc9c9ccf4470d9d07cdfc22570 (diff)
downloadnode-new-12db4d97b24a7bb90f91b64d2e0810179a632f98.tar.gz
doc: improve security section of README.md
* Remove fluff text and get to the point: Report security flaws to security@nodejs.org. 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: https://github.com/nodejs/node/pull/17929 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
-rw-r--r--README.md17
1 files changed, 8 insertions, 9 deletions
diff --git a/README.md b/README.md
index c2fb5543bc..4fa0e438f6 100644
--- a/README.md
+++ b/README.md
@@ -172,20 +172,19 @@ Node.js from source along with a list of officially supported platforms.
## Security
-All security bugs in Node.js are taken seriously and should be reported by
-emailing security@nodejs.org. This will be delivered to a subset of the project
-team who handle security issues. Please don't disclose security bugs
-publicly until they have been handled by the security team.
+Security flaws in Node.js should be reported by emailing security@nodejs.org.
+Please do not disclose security bugs publicly until they have been handled by
+the security team.
-Your email will be acknowledged within 24 hours, and you’ll receive a more
+Your email will be acknowledged within 24 hours, and you will receive a more
detailed response to your email within 48 hours indicating the next steps in
handling your report.
There are no hard and fast rules to determine if a bug is worth reporting as
-a security issue. The general rule is any issue worth reporting
-must allow an attacker to compromise the confidentiality, integrity
-or availability of the Node.js application or its system for which the attacker
-does not already have the capability.
+a security issue. The general rule is an issue worth reporting should allow an
+attacker to compromise the confidentiality, integrity, or availability of the
+Node.js application or its system for which the attacker does not already have
+the capability.
To illustrate the point, here are some examples of past issues and what the
Security Response Team thinks of them. When in doubt, however, please do send