What is eslint-plugin-security?
eslint-plugin-security is an ESLint plugin that helps identify potential security issues in your JavaScript code. It provides a set of rules that can be used to catch common security vulnerabilities, such as the use of eval(), potential XSS vulnerabilities, and more.
What are eslint-plugin-security's main functionalities?
Detecting the use of eval()
This rule detects the use of eval() with an expression, which can lead to code injection vulnerabilities. The code sample shows a scenario where user input is passed to eval(), which is flagged by the rule.
/* eslint security/detect-eval-with-expression: 'error' */
const userInput = '2 + 2';
eval(userInput);
Detecting potential XSS vulnerabilities
This rule detects the use of non-literal regular expressions, which can be a source of XSS vulnerabilities. The code sample demonstrates creating a RegExp object with user input, which is flagged by the rule.
/* eslint security/detect-non-literal-regexp: 'error' */
const userInput = '.*';
const regex = new RegExp(userInput);
Detecting potential ReDoS vulnerabilities
This rule detects potentially unsafe regular expressions that could lead to Regular Expression Denial of Service (ReDoS) attacks. The code sample shows an unsafe regex pattern that is flagged by the rule.
/* eslint security/detect-unsafe-regex: 'error' */
const unsafeRegex = /(a+)+$/;
unsafeRegex.test('aaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
Other packages similar to eslint-plugin-security
eslint-plugin-no-unsanitized
eslint-plugin-no-unsanitized is an ESLint plugin that focuses on preventing the use of unsanitized methods that can lead to XSS vulnerabilities. It is similar to eslint-plugin-security in that it helps identify potential security issues, but it specifically targets unsanitized DOM manipulations.
eslint-plugin-scanjs-rules
eslint-plugin-scanjs-rules is an ESLint plugin that provides a set of security rules based on the Mozilla ScanJS project. It is similar to eslint-plugin-security in that it aims to identify security issues in JavaScript code, but it includes a different set of rules inspired by the ScanJS project.
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.
Installation
npm install --save-dev eslint-plugin-security
Usage
Add the following to your .eslintrc
file:
"plugins": [
"security"
]
Rules
detect-unsafe-regex
- Locates potentially unsafe regular expressionsdetect-buffer-noassert
- Detects calls to buffer with noassert flag setdetect-child-process
- Detects instances of child_process & non-literal cp.exec()detect-disable-mustache-escape
-detect-eval-with-expression
- Detects eval(var)detect-no-csrf-before-method-override
- Detects Express.csrf before method-overridedetect-non-literal-fs-filename
- Detects var in filename argument of fs callsdetect-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