Merge branch 'scottnonnenberg-update-docs'

Author: Adam Baldwin

README.md

@@ -1,7 +1,8 @@
 # eslint-plugin-security
+
 ESLint rules for Node Security
 
-Probably not something you want to just toss and leave in a project. It will help identify potential security hotspots, but finds a lot of false positives that needs triaged by a human.
+This project will help identify potential security hotspots, but finds a lot of false positives which need triage by a human.
 
 ### Installation
 
@@ -17,22 +18,6 @@ Add the following to your `.eslintrc` file:
 ]
 ```
 
-### Rules
-
-- `detect-unsafe-regex` - Locates potentially unsafe regular expressions
-- `detect-buffer-noassert` - Detects calls to buffer with noassert flag set
-- `detect-child-process` - Detects instances of child_process & non-literal cp.exec()
-- `detect-disable-mustache-escape` - Detects instances of setting the escapeMarkup property to false
-- `detect-eval-with-expression` - Detects eval(var)
-- `detect-new-buffer` - Detects instances of new Buffer(argument) where argument is any non literal value
-- `detect-no-csrf-before-method-override` - Detects Express.csrf before method-override
-- `detect-non-literal-fs-filename` - Detects var in filename argument of fs calls
-- `detect-non-literal-regexp` - Detects RegExp(var)
-- `detect-non-literal-require` - Detects require(var)
-- `detect-object-injection` - Detects var[var]
-- `detect-possible-timing-attacks` - Detects insecure comparisons (== != !== ===)
-- `detect-pseudoRandomBytes` - Detects if pseudoRandomBytes() is in use
-
 
 ## Developer guide
 
@@ -48,3 +33,77 @@ Add the following to your `.eslintrc` file:
 ```sh
 npm test
 ```
+
+### Rules
+
+#### `detect-unsafe-regex`
+
+Locates potentially unsafe regular expressions, which may take a very long time to run, blocking the event loop.
+
+More information: https://blog.liftsecurity.io/2014/11/03/regular-expression-dos-and-node.js
+
+#### `detect-buffer-noassert`
+
+Detects calls to [`buffer`](https://nodejs.org/api/buffer.html) with `noAssert` flag set
+
+From the Node.js API docs: "Setting `noAssert` to true skips validation of the `offset`. This allows the `offset` to be beyond the end of the `Buffer`."
+
+#### `detect-child-process`
+
+Detects instances of [`child_process`](https://nodejs.org/api/child_process.html) & non-literal [`exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback)
+
+More information: https://blog.liftsecurity.io/2014/08/19/Avoid-Command-Injection-Node.js
+
+#### `detect-disable-mustache-escape`
+
+Detects `object.escapeMarkup = false`, which can be used with some template engines to disable escaping of HTML entities. This can lead to Cross-Site Scripting (XSS) vulnerabilities.
+
+More information: https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)
+
+#### `detect-eval-with-expression`
+
+Detects `eval(variable)` which can allow an attacker to run arbitary code inside your process.
+
+More information: http://security.stackexchange.com/questions/94017/what-are-the-security-issues-with-eval-in-javascript
+
+#### `detect-no-csrf-before-method-override`
+
+Detects Express `csrf` middleware setup before `method-override` middleware. This can allow `GET` requests (which are not checked by `csrf`) to turn into `POST` requests later.
+
+More information: https://blog.liftsecurity.io/2013/09/07/bypass-connect-csrf-protection-by-abusing
+
+#### `detect-non-literal-fs-filename`
+
+Detects variable in filename argument of `fs` calls, which might allow an attacker to access anything on your system.
+
+More information: https://www.owasp.org/index.php/Path_Traversal
+
+#### `detect-non-literal-regexp`
+
+Detects `RegExp(variable)`, which might allow an attacker to DOS your server with a long-running regular expression.
+
+More information: https://blog.liftsecurity.io/2014/11/03/regular-expression-dos-and-node.js
+
+#### `detect-non-literal-require`
+
+Detects `require(variable)`, which might allow an attacker to load and run arbitrary code, or access arbitrary files on disk.
+
+More information: http://www.bennadel.com/blog/2169-where-does-node-js-and-require-look-for-modules.htm
+
+#### `detect-object-injection`
+
+Detects `variable[key]` as a left- or right-hand assignment operand.
+
+More information: https://blog.liftsecurity.io/2015/01/15/the-dangers-of-square-bracket-notation
+
+#### `detect-possible-timing-attacks`
+
+Detects insecure comparisons (`==`, `!=`, `!==` and `===`), which check input sequentially.
+
+More information: https://snyk.io/blog/node-js-timing-attack-ccc-ctf/
+
+#### `detect-pseudoRandomBytes`
+
+Detects if `pseudoRandomBytes()` is in use, which might not give you the randomness you need and expect.
+
+More information: http://stackoverflow.com/questions/18130254/randombytes-vs-pseudorandombytes