eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
115 lines (114 loc) • 5.16 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/S6265/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 messages = {
accessLevel: (param) => `Make sure granting ${param} access is safe here.`,
unrestricted: 'Make sure allowing unrestricted access to objects from this bucket is safe here.',
};
const ACCESS_CONTROL_KEY = 'accessControl';
const INVALID_ACCESS_CONTROL_VALUES = ['PUBLIC_READ', 'PUBLIC_READ_WRITE', 'AUTHENTICATED_READ'];
const PUBLIC_READ_ACCESS_KEY = 'publicReadAccess';
const INVALID_PUBLIC_READ_ACCESS_VALUE = true;
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, undefined, true),
create(context) {
return (0, index_js_1.mergeRules)(s3BucketConstructorRule.create(context), s3BucketDeploymentConstructorRule.create(context), handleGrantPublicAccess.create(context));
},
};
const s3BucketConstructorRule = (0, index_js_1.S3BucketTemplate)((bucketConstructor, context) => {
for (const value of INVALID_ACCESS_CONTROL_VALUES) {
checkConstantParam(context, bucketConstructor, ACCESS_CONTROL_KEY, [
'BucketAccessControl',
value,
]);
}
checkBooleanParam(context, bucketConstructor, PUBLIC_READ_ACCESS_KEY, INVALID_PUBLIC_READ_ACCESS_VALUE);
});
const s3BucketDeploymentConstructorRule = {
create(context) {
return {
NewExpression: (node) => {
if ((0, index_js_1.isS3BucketDeploymentConstructor)(context, node)) {
for (const value of INVALID_ACCESS_CONTROL_VALUES) {
checkConstantParam(context, node, ACCESS_CONTROL_KEY, ['BucketAccessControl', value]);
}
}
},
};
},
};
function checkBooleanParam(context, bucketConstructor, propName, propValue) {
const property = (0, index_js_1.getBucketProperty)(context, bucketConstructor, propName);
if (property == null) {
return;
}
const propertyLiteralValue = (0, index_js_1.getValueOfExpression)(context, property.value, 'Literal');
if (propertyLiteralValue?.value === propValue) {
const secondary = (0, index_js_1.findPropagatedSetting)(property, propertyLiteralValue);
(0, index_js_1.report)(context, {
message: messages.unrestricted,
node: property,
}, secondary ? [secondary] : []);
}
}
function checkConstantParam(context, bucketConstructor, propName, paramQualifiers) {
const property = (0, index_js_1.getBucketProperty)(context, bucketConstructor, propName);
if (property == null) {
return;
}
const propertyLiteralValue = (0, index_js_1.getValueOfExpression)(context, property.value, 'MemberExpression');
if (propertyLiteralValue !== undefined &&
(0, index_js_1.normalizeFQN)((0, index_js_1.getFullyQualifiedName)(context, propertyLiteralValue)) ===
`aws_cdk_lib.aws_s3.${paramQualifiers.join('.')}`) {
const secondary = (0, index_js_1.findPropagatedSetting)(property, propertyLiteralValue);
(0, index_js_1.report)(context, {
message: messages.accessLevel(paramQualifiers[paramQualifiers.length - 1]),
node: property,
}, secondary ? [secondary] : []);
}
}
const handleGrantPublicAccess = {
create(context) {
return {
CallExpression: (node) => {
if (!(0, index_js_1.isMethodCall)(node)) {
return;
}
const { object, property } = node.callee;
const isGrantPublicAccessMethodCall = (0, index_js_1.isIdentifier)(property, 'grantPublicAccess');
if (!isGrantPublicAccessMethodCall) {
return;
}
const variableAssignment = (0, index_js_1.getUniqueWriteUsageOrNode)(context, object);
const isS3bucketInstance = variableAssignment.type === 'NewExpression' &&
(0, index_js_1.isS3BucketConstructor)(context, variableAssignment);
if (!isS3bucketInstance) {
return;
}
(0, index_js_1.report)(context, {
message: messages.unrestricted,
node: property,
});
},
};
},
};