@appland/scanner 1.54.1 → 1.57.0

package/built/configuration/configurationProvider.js

@@ -31,266 +31,187 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseConfigFile = exports.loadConfig = exports.loadRule = void 0;
-var ajv_1 = __importDefault(require("ajv"));
-var js_yaml_1 = __importDefault(require("js-yaml"));
-var fs_1 = require("fs");
-var check_1 = __importDefault(require("../check"));
-var util_1 = require("../rules/lib/util");
-var matchEvent_1 = require("../rules/lib/matchEvent");
-var parseRuleDescription_1 = __importDefault(require("../rules/lib/parseRuleDescription"));
-var options_json_1 = __importDefault(require("./schema/options.json"));
-var match_pattern_config_json_1 = __importDefault(require("./schema/match-pattern-config.json"));
-var url_1 = require("url");
-var ajv = new ajv_1.default();
+const ajv_1 = __importDefault(require("ajv"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const fs_1 = require("fs");
+const check_1 = __importDefault(require("../check"));
+const util_1 = require("../rules/lib/util");
+const matchEvent_1 = require("../rules/lib/matchEvent");
+const parseRuleDescription_1 = __importDefault(require("../rules/lib/parseRuleDescription"));
+const options_json_1 = __importDefault(require("./schema/options.json"));
+const match_pattern_config_json_1 = __importDefault(require("./schema/match-pattern-config.json"));
+const url_1 = require("url");
+const util_2 = require("util");
+const path_1 = require("path");
+const ajv = new ajv_1.default();
 ajv.addSchema(match_pattern_config_json_1.default);
 function loadFromFile(ruleName) {
-    var _this = this;
-    return function () { return __awaiter(_this, void 0, void 0, function () {
-        var ruleSpec, e_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    _a.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("../rules/".concat(ruleName))); })];
-                case 1:
-                    ruleSpec = _a.sent();
-                    return [3 /*break*/, 3];
-                case 2:
-                    e_1 = _a.sent();
-                    return [2 /*return*/];
-                case 3: return [2 /*return*/, ruleSpec.default];
-            }
-        });
-    }); };
+    return () => __awaiter(this, void 0, void 0, function* () {
+        let ruleSpec;
+        try {
+            ruleSpec = yield Promise.resolve().then(() => __importStar(require(`../rules/${ruleName}`)));
+        }
+        catch (e) {
+            return;
+        }
+        return ruleSpec.default;
+    });
 }
 function loadFromDir(ruleName) {
-    var _this = this;
-    return function () { return __awaiter(_this, void 0, void 0, function () {
-        var metadata, rule, options, e_2, _a, _b, description, references;
-        return __generator(this, function (_c) {
-            switch (_c.label) {
-                case 0:
-                    _c.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("../rules/".concat(ruleName, "/metadata"))); })];
-                case 1:
-                    metadata = (_c.sent()).default;
-                    return [3 /*break*/, 3];
-                case 2:
-                    e_2 = _c.sent();
-                    return [2 /*return*/];
-                case 3:
-                    _c.trys.push([3, 5, , 6]);
-                    return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("../rules/".concat(ruleName, "/rule"))); })];
-                case 4:
-                    rule = (_c.sent()).default;
-                    return [3 /*break*/, 6];
-                case 5:
-                    _a = _c.sent();
-                    console.warn("Rule ".concat(ruleName, " has no rule.js or rule.ts file, or the file doesn't have a default export"));
-                    return [2 /*return*/];
-                case 6:
-                    if ((0, util_1.verbose)())
-                        console.log("Loaded rule ".concat(ruleName, ": ").concat(rule));
-                    _c.label = 7;
-                case 7:
-                    _c.trys.push([7, 9, , 10]);
-                    return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("../rules/".concat(ruleName, "/options"))); })];
-                case 8:
-                    options = _c.sent();
-                    if ((0, util_1.verbose)())
-                        console.log("Loaded rule ".concat(ruleName, " options: ").concat(options));
-                    return [3 /*break*/, 10];
-                case 9:
-                    _b = _c.sent();
-                    return [3 /*break*/, 10];
-                case 10:
-                    description = (0, parseRuleDescription_1.default)(ruleName);
-                    references = Object.keys(metadata.references || {}).reduce(function (memo, key) {
-                        memo[key] = new url_1.URL(metadata.references[key]);
-                        return memo;
-                    }, {});
-                    return [2 /*return*/, {
-                            id: (0, util_1.dasherize)(ruleName),
-                            title: metadata.title,
-                            description: description,
-                            url: "https://appland.com/docs/analysis/rules-reference.html#".concat((0, util_1.dasherize)(ruleName)),
-                            labels: metadata.labels || [],
-                            scope: metadata.scope,
-                            enumerateScope: metadata.enumerateScope,
-                            impactDomain: metadata.impactDomain,
-                            references: references,
-                            Options: options,
-                            build: rule,
-                        }];
-            }
-        });
-    }); };
+    return () => __awaiter(this, void 0, void 0, function* () {
+        let metadata;
+        let rule;
+        let options;
+        try {
+            metadata = (yield Promise.resolve().then(() => __importStar(require(`../rules/${ruleName}/metadata`)))).default;
+        }
+        catch (e) {
+            return;
+        }
+        try {
+            rule = (yield Promise.resolve().then(() => __importStar(require(`../rules/${ruleName}/rule`)))).default;
+        }
+        catch (_a) {
+            console.warn(`Rule ${ruleName} has no rule.js or rule.ts file, or the file doesn't have a default export`);
+            return;
+        }
+        if ((0, util_1.verbose)())
+            console.log(`Loaded rule ${ruleName}: ${rule}`);
+        try {
+            options = yield Promise.resolve().then(() => __importStar(require(`../rules/${ruleName}/options`)));
+            if ((0, util_1.verbose)())
+                console.log(`Loaded rule ${ruleName} options: ${options}`);
+        }
+        catch (_b) {
+            // This is OK
+        }
+        const description = (0, parseRuleDescription_1.default)(ruleName);
+        const references = Object.keys(metadata.references || {}).reduce((memo, key) => {
+            memo[key] = new url_1.URL(metadata.references[key]);
+            return memo;
+        }, {});
+        return {
+            id: (0, util_1.dasherize)(ruleName),
+            title: metadata.title,
+            description,
+            url: `https://appland.com/docs/analysis/rules-reference.html#${(0, util_1.dasherize)(ruleName)}`,
+            labels: metadata.labels || [],
+            scope: metadata.scope,
+            enumerateScope: metadata.enumerateScope,
+            impactDomain: metadata.impactDomain,
+            references,
+            Options: options,
+            build: rule,
+        };
+    });
 }
 function buildBuiltinCheck(config) {
-    return __awaiter(this, void 0, void 0, function () {
-        var rule, options, check;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, loadRule(config.rule)];
-                case 1:
-                    rule = _a.sent();
-                    if ((0, util_1.verbose)()) {
-                        console.log("Loaded rule: ".concat(rule));
-                    }
-                    if (rule.Options) {
-                        options = new rule.Options();
-                    }
-                    else {
-                        options = {};
-                    }
-                    if (config.properties) {
-                        Object.keys(config.properties).forEach(function (name) {
-                            var value = config.properties[name];
-                            options[name] = value;
-                        });
-                    }
-                    check = new check_1.default(rule, options);
-                    if (config.scope) {
-                        check.scope = config.scope;
-                    }
-                    if (config.id) {
-                        check.id = (0, util_1.dasherize)(config.id);
-                    }
-                    check.includeScope = (0, matchEvent_1.buildFilters)((config.include || []).filter(function (item) { return item.scope; }).map(function (item) { return item.scope; }));
-                    check.excludeScope = (0, matchEvent_1.buildFilters)((config.exclude || []).filter(function (item) { return item.scope; }).map(function (item) { return item.scope; }));
-                    check.includeEvent = (0, matchEvent_1.buildFilters)((config.include || []).filter(function (item) { return item.event; }).map(function (item) { return item.event; }));
-                    check.excludeEvent = (0, matchEvent_1.buildFilters)((config.exclude || []).filter(function (item) { return item.event; }).map(function (item) { return item.event; }));
-                    if ((0, util_1.verbose)()) {
-                        console.log("Loaded check: ".concat(check));
-                    }
-                    return [2 /*return*/, check];
-            }
-        });
+    return __awaiter(this, void 0, void 0, function* () {
+        const rule = yield loadRule(config.rule);
+        if ((0, util_1.verbose)()) {
+            console.log(`Loaded rule: ${rule}`);
+        }
+        let options;
+        if (rule.Options) {
+            options = new rule.Options();
+        }
+        else {
+            options = {};
+        }
+        if (config.properties) {
+            Object.keys(config.properties).forEach((name) => {
+                const value = config.properties[name];
+                options[name] = value;
+            });
+        }
+        const check = new check_1.default(rule, options);
+        if (config.scope) {
+            check.scope = config.scope;
+        }
+        if (config.id) {
+            check.id = (0, util_1.dasherize)(config.id);
+        }
+        check.includeScope = (0, matchEvent_1.buildFilters)((config.include || []).filter((item) => item.scope).map((item) => item.scope));
+        check.excludeScope = (0, matchEvent_1.buildFilters)((config.exclude || []).filter((item) => item.scope).map((item) => item.scope));
+        check.includeEvent = (0, matchEvent_1.buildFilters)((config.include || []).filter((item) => item.event).map((item) => item.event));
+        check.excludeEvent = (0, matchEvent_1.buildFilters)((config.exclude || []).filter((item) => item.event).map((item) => item.event));
+        if ((0, util_1.verbose)()) {
+            console.log(`Loaded check: ${check}`);
+        }
+        return check;
     });
 }
-var validate = function (validator, data, context) {
-    var valid = validator(data);
+const validate = (validator, data, context) => {
+    const valid = validator(data);
     if (!valid) {
         throw new Error(validator
-            .errors.map(function (err) {
-            var instance = err.instancePath;
+            .errors.map((err) => {
+            let instance = err.instancePath;
             if (!instance || instance === '') {
                 instance = context;
             }
-            return "".concat(instance, " ").concat(err.message, " (").concat(err.schemaPath, ")");
+            return `${instance} ${err.message} (${err.schemaPath})`;
         })
             .join(', '));
     }
 };
 function loadRule(ruleName) {
-    return __awaiter(this, void 0, void 0, function () {
-        var ruleId, rules, rule;
-        var _this = this;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    ruleId = (0, util_1.dasherize)(ruleName);
-                    return [4 /*yield*/, Promise.all([
-                            loadFromDir(ruleId),
-                            loadFromFile(ruleId),
-                            loadFromDir((0, util_1.camelize)(ruleId)),
-                            loadFromFile((0, util_1.camelize)(ruleId)),
-                        ].map(function (loader) { return __awaiter(_this, void 0, void 0, function () {
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0: return [4 /*yield*/, loader()];
-                                    case 1: return [2 /*return*/, _a.sent()];
-                                }
-                            });
-                        }); }))];
-                case 1:
-                    rules = _a.sent();
-                    rule = rules.find(function (rule) { return rule; });
-                    if (!rule)
-                        throw new Error("Rule ".concat(ruleName, " not found"));
-                    return [2 /*return*/, rule];
-            }
-        });
+    return __awaiter(this, void 0, void 0, function* () {
+        const ruleId = (0, util_1.dasherize)(ruleName);
+        const rules = yield Promise.all([
+            loadFromDir(ruleId),
+            loadFromFile(ruleId),
+            loadFromDir((0, util_1.camelize)(ruleId)),
+            loadFromFile((0, util_1.camelize)(ruleId)),
+        ].map((loader) => __awaiter(this, void 0, void 0, function* () {
+            return yield loader();
+        })));
+        const rule = rules.find((rule) => rule);
+        if (!rule)
+            throw new Error(`Rule ${ruleName} not found`);
+        return rule;
     });
 }
 exports.loadRule = loadRule;
 function loadConfig(config) {
-    return __awaiter(this, void 0, void 0, function () {
-        var _this = this;
-        return __generator(this, function (_a) {
-            config.checks
-                .filter(function (check) { return check.properties; })
-                .forEach(function (check) {
-                var ruleId = check.rule;
-                var schemaKey = [(0, util_1.capitalize)(ruleId), 'Options'].join('.');
-                if ((0, util_1.verbose)()) {
-                    console.warn(schemaKey);
-                }
-                var propertiesSchema = options_json_1.default.definitions[schemaKey];
-                if (!propertiesSchema) {
-                    return;
-                }
-                if ((0, util_1.verbose)()) {
-                    console.warn(propertiesSchema);
-                    console.warn(check.properties);
-                }
-                validate(ajv.compile(propertiesSchema), check.properties || {}, "".concat(ruleId, " properties"));
-            });
-            return [2 /*return*/, Promise.all(config.checks.map(function (c) { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
-                    return [2 /*return*/, buildBuiltinCheck(c)];
-                }); }); }))];
+    return __awaiter(this, void 0, void 0, function* () {
+        config.checks
+            .filter((check) => check.properties)
+            .forEach((check) => {
+            const ruleId = check.rule;
+            const schemaKey = [(0, util_1.capitalize)(ruleId), 'Options'].join('.');
+            if ((0, util_1.verbose)()) {
+                console.warn(schemaKey);
+            }
+            const propertiesSchema = options_json_1.default.definitions[schemaKey];
+            if (!propertiesSchema) {
+                return;
+            }
+            if ((0, util_1.verbose)()) {
+                console.warn(propertiesSchema);
+                console.warn(check.properties);
+            }
+            validate(ajv.compile(propertiesSchema), check.properties || {}, `${ruleId} properties`);
         });
+        return Promise.all(config.checks.map((c) => __awaiter(this, void 0, void 0, function* () { return buildBuiltinCheck(c); })));
     });
 }
 exports.loadConfig = loadConfig;
 function parseConfigFile(configPath) {
-    return __awaiter(this, void 0, void 0, function () {
-        var yamlConfig;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    console.log("Using scanner configuration file ".concat(configPath));
-                    return [4 /*yield*/, fs_1.promises.readFile(configPath, 'utf-8')];
-                case 1:
-                    yamlConfig = _a.sent();
-                    return [2 /*return*/, js_yaml_1.default.load(yamlConfig, {
-                            filename: configPath,
-                        })];
-            }
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(yield (0, util_2.promisify)(fs_1.exists)(configPath))) {
+            configPath = (0, path_1.join)(__dirname, '../sampleConfig/default.yml');
+        }
+        console.log(`Using scanner configuration file ${configPath}`);
+        const yamlConfig = yield fs_1.promises.readFile(configPath, 'utf-8');
+        return js_yaml_1.default.load(yamlConfig, {
+            filename: configPath,
         });
     });
 }
 exports.parseConfigFile = parseConfigFile;
-//# sourceMappingURL=configurationProvider.js.map