eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
131 lines (130 loc) • 5.34 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
// https://sonarsource.github.io/rspec/#/rspec/S5689/javascript
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const index_js_1 = require("../helpers/index.js");
const meta_js_1 = require("./meta.js");
const HELMET = 'helmet';
const HIDE_POWERED_BY = 'hide-powered-by';
const HEADER_X_POWERED_BY = 'X-Powered-By'.toLowerCase();
const PROTECTING_MIDDLEWARES = [HELMET, HIDE_POWERED_BY];
/** Expected number of arguments in `app.set`. */
const APP_SET_NUM_ARGS = 2;
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, {
messages: {
headerSet: 'Make sure disclosing the fingerprinting of this web technology is safe here.',
headerDefault: 'This framework implicitly discloses version information by default. Make sure it is safe here.',
},
}),
create(context) {
let appInstantiation = null;
let isSafe = false;
let isExplicitelyUnsafe = false;
return {
Program() {
appInstantiation = null;
isSafe = false;
isExplicitelyUnsafe = true;
},
CallExpression: (node) => {
if (!isSafe && appInstantiation) {
const callExpr = node;
isSafe =
index_js_1.Express.isUsingMiddleware(context, callExpr, appInstantiation, isProtecting(context)) ||
isDisabledXPoweredBy(callExpr, appInstantiation) ||
isSetFalseXPoweredBy(callExpr, appInstantiation) ||
isAppEscaping(callExpr, appInstantiation);
isExplicitelyUnsafe = isSetTrueXPoweredBy(callExpr, appInstantiation);
}
},
VariableDeclarator: (node) => {
if (!isSafe && !appInstantiation) {
const varDecl = node;
const app = index_js_1.Express.attemptFindAppInstantiation(varDecl, context);
if (app) {
appInstantiation = app;
}
}
},
ReturnStatement: (node) => {
if (!isSafe && appInstantiation) {
const ret = node;
isSafe = isAppEscapingThroughReturn(ret, appInstantiation);
}
},
'Program:exit'() {
if (!isSafe && appInstantiation) {
let messageId = 'headerDefault';
if (isExplicitelyUnsafe) {
messageId = 'headerSet';
}
context.report({
node: appInstantiation,
messageId,
});
}
},
};
},
};
/**
* Checks whether node looks like `helmet.hidePoweredBy()`.
*/
function isHidePoweredByFromHelmet(context, n) {
if (n.type === 'CallExpression') {
return (0, index_js_1.getFullyQualifiedName)(context, n) === `${HELMET}.hidePoweredBy`;
}
return false;
}
function isProtecting(context) {
return (n) => index_js_1.Express.isMiddlewareInstance(context, PROTECTING_MIDDLEWARES, n) ||
isHidePoweredByFromHelmet(context, n);
}
function isDisabledXPoweredBy(callExpression, app) {
if ((0, index_js_1.isMethodInvocation)(callExpression, app.name, 'disable', 1)) {
const arg0 = callExpression.arguments[0];
return arg0.type === 'Literal' && String(arg0.value).toLowerCase() === HEADER_X_POWERED_BY;
}
return false;
}
function isSetFalseXPoweredBy(callExpression, app) {
return getSetTrueXPoweredByValue(callExpression, app) === false;
}
function isSetTrueXPoweredBy(callExpression, app) {
return getSetTrueXPoweredByValue(callExpression, app) === true;
}
function getSetTrueXPoweredByValue(callExpression, app) {
if ((0, index_js_1.isMethodInvocation)(callExpression, app.name, 'set', APP_SET_NUM_ARGS)) {
const [headerName, onOff] = callExpression.arguments;
if (headerName.type === 'Literal' &&
String(headerName.value).toLowerCase() === HEADER_X_POWERED_BY &&
onOff.type === 'Literal') {
return onOff.value;
}
}
return undefined;
}
function isAppEscaping(callExpr, app) {
return Boolean(callExpr.arguments.find(arg => arg.type === 'Identifier' && arg.name === app.name));
}
function isAppEscapingThroughReturn(ret, app) {
const arg = ret.argument;
return Boolean(arg && arg.type === 'Identifier' && arg.name === app.name);
}