eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
119 lines (118 loc) • 5.41 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/S5667/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");
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, undefined, true),
create(context) {
const MESSAGE = 'Enable server hostname verification on this SSL/TLS connection.';
const SECONDARY_MESSAGE = 'Set "rejectUnauthorized" to "true".';
function checkSensitiveArgument(callExpression, sensitiveArgumentIndex) {
if (callExpression.arguments.length < sensitiveArgumentIndex + 1) {
return;
}
const sensitiveArgument = callExpression.arguments[sensitiveArgumentIndex];
const secondaryLocations = [];
let shouldReport = false;
const argumentValue = (0, index_js_1.getValueOfExpression)(context, sensitiveArgument, 'ObjectExpression');
if (!argumentValue) {
return;
}
if (sensitiveArgument !== argumentValue) {
secondaryLocations.push((0, index_js_1.toSecondaryLocation)(argumentValue));
}
const unsafeRejectUnauthorizedConfiguration = (0, index_js_1.getPropertyWithValue)(context, argumentValue, 'rejectUnauthorized', false);
if (unsafeRejectUnauthorizedConfiguration) {
secondaryLocations.push((0, index_js_1.toSecondaryLocation)(unsafeRejectUnauthorizedConfiguration, SECONDARY_MESSAGE));
shouldReport = true;
}
const checkServerIdentityProperty = (0, index_js_1.getProperty)(argumentValue, 'checkServerIdentity', context);
if (checkServerIdentityProperty &&
shouldReportOnCheckServerIdentityCallBack(checkServerIdentityProperty)) {
secondaryLocations.push((0, index_js_1.toSecondaryLocation)(checkServerIdentityProperty));
shouldReport = true;
}
if (shouldReport) {
(0, index_js_1.report)(context, {
node: callExpression.callee,
message: MESSAGE,
}, secondaryLocations);
}
}
function shouldReportOnCheckServerIdentityCallBack(checkServerIdentityProperty) {
let baseFunction;
baseFunction = (0, index_js_1.getValueOfExpression)(context, checkServerIdentityProperty.value, 'FunctionExpression');
if (!baseFunction) {
baseFunction = (0, index_js_1.getValueOfExpression)(context, checkServerIdentityProperty.value, 'ArrowFunctionExpression');
}
if (baseFunction?.body.type === 'BlockStatement') {
const returnStatements = ReturnStatementsVisitor.getReturnStatements(baseFunction.body, context);
if (returnStatements.length === 0 ||
returnStatements.every(r => {
return (!r.argument || (0, index_js_1.getValueOfExpression)(context, r.argument, 'Literal')?.value === true);
})) {
return true;
}
}
return false;
}
return {
CallExpression: (node) => {
const callExpression = node;
const fqn = (0, index_js_1.getFullyQualifiedName)(context, callExpression);
if (fqn === 'https.request') {
checkSensitiveArgument(callExpression, 0);
}
if (fqn === 'request.get') {
checkSensitiveArgument(callExpression, 0);
}
if (fqn === 'tls.connect') {
checkSensitiveArgument(callExpression, 2);
}
},
};
},
};
class ReturnStatementsVisitor {
constructor() {
this.returnStatements = [];
}
static getReturnStatements(node, context) {
const visitor = new ReturnStatementsVisitor();
visitor.visit(node, context);
return visitor.returnStatements;
}
visit(root, context) {
const visitNode = (node) => {
switch (node.type) {
case 'ReturnStatement':
this.returnStatements.push(node);
break;
case 'FunctionDeclaration':
case 'FunctionExpression':
case 'ArrowFunctionExpression':
return;
}
(0, index_js_1.childrenOf)(node, context.sourceCode.visitorKeys).forEach(visitNode);
};
visitNode(root);
}
}