snyk 1.857.0 → 1.858.0

package/dist/cli/272.index.js

@@ -76,7 +76,7 @@ exports.performanceAnalyticsObject = {
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.assertIaCOptionsFlags = exports.UnsupportedEntitlementCommandError = exports.UnsupportedEntitlementFlagError = exports.FlagValueError = exports.FlagError = void 0;
+exports.isIacShareResultsOptions = exports.assertIaCOptionsFlags = exports.UnsupportedEntitlementCommandError = exports.UnsupportedEntitlementFlagError = exports.FlagValueError = exports.FeatureFlagError = exports.FlagError = void 0;
 const errors_1 = __webpack_require__(55191);
 const args_1 = __webpack_require__(94765);
 const error_utils_1 = __webpack_require__(23872);
@@ -100,6 +100,7 @@ const keys = [
     'quiet',
     'scan',
     'legacy',
+    'report',
     // PolicyOptions
     'ignore-policy',
     'policy-path',
@@ -114,22 +115,33 @@ function getFlagName(key) {
     return `${dashes}${flag}`;
 }
 class FlagError extends errors_1.CustomError {
-    constructor(key, featureFlag) {
+    constructor(key) {
+        const flag = getFlagName(key);
+        const msg = `Unsupported flag "${flag}" provided. Run snyk iac test --help for supported flags`;
+        super(msg);
+        this.code = types_1.IaCErrorCodes.FlagError;
+        this.strCode = error_utils_1.getErrorStringCode(this.code);
+        this.userMessage = msg;
+    }
+}
+exports.FlagError = FlagError;
+class FeatureFlagError extends errors_1.CustomError {
+    constructor(key, featureFlag, hasSnykPreview) {
         const flag = getFlagName(key);
         let msg;
-        if (featureFlag) {
+        if (hasSnykPreview) {
             msg = `Flag "${flag}" is only supported if feature flag '${featureFlag}' is enabled. The feature flag can be enabled via Snyk Preview if you are on the Enterprise Plan`;
         }
         else {
-            msg = `Unsupported flag "${flag}" provided. Run snyk iac test --help for supported flags`;
+            msg = `Flag "${flag}" is only supported if feature flag "${featureFlag}" is enabled. To enable it, please contact Snyk support.`;
         }
         super(msg);
-        this.code = types_1.IaCErrorCodes.FlagError;
+        this.code = types_1.IaCErrorCodes.FeatureFlagError;
         this.strCode = error_utils_1.getErrorStringCode(this.code);
         this.userMessage = msg;
     }
 }
-exports.FlagError = FlagError;
+exports.FeatureFlagError = FeatureFlagError;
 class FlagValueError extends errors_1.CustomError {
     constructor(key, value) {
         const flag = getFlagName(key);
@@ -179,7 +191,7 @@ function assertIaCOptionsFlags(argv) {
         // flag strings passed to the command line (usually files)
         // and `iac` is the command provided.
         if (key !== '_' && key !== 'iac' && !allowed.has(key)) {
-            throw new FlagError(key, '');
+            throw new FlagError(key);
         }
     }
     if (parsed.options.scan) {
@@ -196,6 +208,10 @@ function assertTerraformPlanModes(scanModeArgValue) {
         throw new FlagValueError('scan', scanModeArgValue);
     }
 }
+function isIacShareResultsOptions(options) {
+    return options.iac && options.report && !options.legacy;
+}
+exports.isIacShareResultsOptions = isIacShareResultsOptions;
 
 
 /***/ }),
@@ -616,13 +632,14 @@ exports.FailedToExecutePolicyEngine = FailedToExecutePolicyEngine;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.computeCustomRulesBundleChecksum = exports.isValidBundle = exports.extractBundle = exports.createIacDir = void 0;
+exports.computePaths = exports.computeCustomRulesBundleChecksum = exports.isValidBundle = exports.extractBundle = exports.createIacDir = void 0;
 const fs = __webpack_require__(35747);
 const tar = __webpack_require__(97998);
 const path = __webpack_require__(85622);
 const crypto = __webpack_require__(76417);
 const local_cache_1 = __webpack_require__(6255);
 const oci_pull_1 = __webpack_require__(5029);
+const detect_1 = __webpack_require__(45318);
 function hashData(s) {
     const hashedData = crypto
         .createHash('sha1')
@@ -681,6 +698,33 @@ function computeCustomRulesBundleChecksum() {
     }
 }
 exports.computeCustomRulesBundleChecksum = computeCustomRulesBundleChecksum;
+function computePaths(filePath, pathArg = '.') {
+    const targetFilePath = path.resolve(filePath, '.');
+    // the absolute path is needed to compute the full project path
+    const cmdPath = path.resolve(pathArg);
+    let projectPath;
+    let targetFile;
+    if (!detect_1.isLocalFolder(cmdPath)) {
+        // if the provided path points to a file, then the project starts at the parent folder of that file
+        // and the target file was provided as the path argument
+        projectPath = path.dirname(cmdPath);
+        targetFile = path.isAbsolute(pathArg)
+            ? path.relative(process.cwd(), pathArg)
+            : pathArg;
+    }
+    else {
+        // otherwise, the project starts at the provided path
+        // and the target file must be the relative path from the project path to the path of the scanned file
+        projectPath = cmdPath;
+        targetFile = path.relative(projectPath, targetFilePath);
+    }
+    return {
+        targetFilePath,
+        projectName: path.basename(projectPath),
+        targetFile,
+    };
+}
+exports.computePaths = computePaths;
 
 
 /***/ }),
@@ -705,6 +749,7 @@ const feature_flags_1 = __webpack_require__(63011);
 const rules_1 = __webpack_require__(98895);
 const file_loader_1 = __webpack_require__(13552);
 const file_parser_1 = __webpack_require__(2314);
+const share_results_1 = __webpack_require__(3558);
 // this method executes the local processing engine and then formats the results to adapt with the CLI output.
 // this flow is the default GA flow for IAC scanning.
 async function test(pathToScan, options) {
@@ -771,7 +816,11 @@ async function test(pathToScan, options) {
         }
         const scannedFiles = await measurable_methods_1.scanFiles(parsedFiles);
         const resultsWithCustomSeverities = await measurable_methods_1.applyCustomSeverities(scannedFiles, iacOrgSettings.customPolicies);
-        const formattedResults = measurable_methods_1.formatScanResults(resultsWithCustomSeverities, options, iacOrgSettings.meta);
+        let projectPublicIds = {};
+        if (options.report) {
+            projectPublicIds = await share_results_1.formatAndShareResults(resultsWithCustomSeverities, options, orgPublicId);
+        }
+        const formattedResults = measurable_methods_1.formatScanResults(resultsWithCustomSeverities, options, iacOrgSettings.meta, projectPublicIds);
         const { filteredIssues, ignoreCount } = policy_1.filterIgnoredIssues(policy, formattedResults);
         try {
             await measurable_methods_1.trackUsage(filteredIssues);
@@ -1573,16 +1622,15 @@ function toFormattedResult(adapter) {
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.FailedToFormatResults = exports.filterPoliciesBySeverity = exports.formatScanResults = void 0;
 const types_1 = __webpack_require__(42258);
-const path = __webpack_require__(85622);
 const common_1 = __webpack_require__(53110);
 const constants_1 = __webpack_require__(68620);
 const errors_1 = __webpack_require__(55191);
 const extract_line_number_1 = __webpack_require__(26747);
 const error_utils_1 = __webpack_require__(23872);
-const detect_1 = __webpack_require__(45318);
 const cloud_config_parser_1 = __webpack_require__(98611);
+const file_utils_1 = __webpack_require__(58486);
 const severitiesArray = common_1.SEVERITIES.map((s) => s.verboseName);
-function formatScanResults(scanResults, options, meta) {
+function formatScanResults(scanResults, options, meta, projectPublicIds) {
     try {
         const groupedByFile = scanResults.reduce((memo, scanResult) => {
             const res = formatScanResult(scanResult, meta, options);
@@ -1590,6 +1638,7 @@ function formatScanResults(scanResults, options, meta) {
                 memo[scanResult.filePath].result.cloudConfigResults.push(...res.result.cloudConfigResults);
             }
             else {
+                res.meta.projectId = projectPublicIds[res.targetFile];
                 memo[scanResult.filePath] = res;
             }
             return memo;
@@ -1646,7 +1695,7 @@ function formatScanResult(scanResult, meta, options) {
             isGeneratedByCustomRule,
         };
     });
-    const { targetFilePath, projectName, targetFile } = computePaths(scanResult.filePath, options.path);
+    const { targetFilePath, projectName, targetFile } = file_utils_1.computePaths(scanResult.filePath, options.path);
     return {
         result: {
             cloudConfigResults: filterPoliciesBySeverity(formattedIssues, options.severityThreshold),
@@ -1671,32 +1720,6 @@ function formatScanResult(scanResult, meta, options) {
         packageManager: engineTypeToProjectType[scanResult.engineType],
     };
 }
-function computePaths(filePath, pathArg = '.') {
-    const targetFilePath = path.resolve(filePath, '.');
-    // the absolute path is needed to compute the full project path
-    const cmdPath = path.resolve(pathArg);
-    let projectPath;
-    let targetFile;
-    if (!detect_1.isLocalFolder(cmdPath)) {
-        // if the provided path points to a file, then the project starts at the parent folder of that file
-        // and the target file was provided as the path argument
-        projectPath = path.dirname(cmdPath);
-        targetFile = path.isAbsolute(pathArg)
-            ? path.relative(process.cwd(), pathArg)
-            : pathArg;
-    }
-    else {
-        // otherwise, the project starts at the provided path
-        // and the target file must be the relative path from the project path to the path of the scanned file
-        projectPath = cmdPath;
-        targetFile = path.relative(projectPath, targetFilePath);
-    }
-    return {
-        targetFilePath,
-        projectName: path.basename(projectPath),
-        targetFile,
-    };
-}
 function filterPoliciesBySeverity(violatedPolicies, severityThreshold) {
     if (!severityThreshold || severityThreshold === common_1.SEVERITY.LOW) {
         return violatedPolicies.filter((violatedPolicy) => {
@@ -1881,6 +1904,72 @@ class FailedToExecuteCustomRulesError extends errors_1.CustomError {
 exports.FailedToExecuteCustomRulesError = FailedToExecuteCustomRulesError;
 
 
+/***/ }),
+
+/***/ 37324:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.formatShareResults = void 0;
+const file_utils_1 = __webpack_require__(58486);
+function formatShareResults(scanResults, options) {
+    const resultsGroupedByFilePath = groupByFilePath(scanResults);
+    return resultsGroupedByFilePath.map((result) => {
+        const { projectName, targetFile } = file_utils_1.computePaths(result.filePath, options.path);
+        return {
+            projectName,
+            targetFile,
+            filePath: result.filePath,
+            fileType: result.fileType,
+            projectType: result.projectType,
+            violatedPolicies: result.violatedPolicies,
+        };
+    });
+}
+exports.formatShareResults = formatShareResults;
+function groupByFilePath(scanResults) {
+    const groupedByFilePath = scanResults.reduce((memo, scanResult) => {
+        scanResult.violatedPolicies.forEach((violatedPolicy) => {
+            violatedPolicy.docId = scanResult.docId;
+        });
+        if (memo[scanResult.filePath]) {
+            memo[scanResult.filePath].violatedPolicies.push(...scanResult.violatedPolicies);
+        }
+        else {
+            memo[scanResult.filePath] = scanResult;
+        }
+        return memo;
+    }, {});
+    return Object.values(groupedByFilePath);
+}
+
+
+/***/ }),
+
+/***/ 3558:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.formatAndShareResults = void 0;
+const feature_flags_1 = __webpack_require__(63011);
+const cli_share_results_1 = __webpack_require__(24016);
+const assert_iac_options_flag_1 = __webpack_require__(68590);
+const share_results_formatter_1 = __webpack_require__(37324);
+async function formatAndShareResults(results, options, orgPublicId) {
+    const isCliReportEnabled = await feature_flags_1.isFeatureFlagSupportedForOrg('iacCliShareResults', orgPublicId);
+    if (!isCliReportEnabled.ok) {
+        throw new assert_iac_options_flag_1.FeatureFlagError('report', 'iacCliShareResults');
+    }
+    const formattedResults = share_results_formatter_1.formatShareResults(results, options);
+    return await cli_share_results_1.shareResults(formattedResults);
+}
+exports.formatAndShareResults = formatAndShareResults;
+
+
 /***/ }),
 
 /***/ 80256:
@@ -2019,6 +2108,68 @@ exports.UnsupportedEntitlementError = UnsupportedEntitlementError;
 UnsupportedEntitlementError.ERROR_CODE = 403;
 
 
+/***/ }),
+
+/***/ 24016:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.shareResults = void 0;
+const config_1 = __webpack_require__(22541);
+const request_1 = __webpack_require__(52050);
+const api_token_1 = __webpack_require__(95181);
+const envelope_formatters_1 = __webpack_require__(88784);
+const authentication_failed_error_1 = __webpack_require__(23770);
+async function shareResults(results) {
+    const scanResults = results.map(envelope_formatters_1.convertIacResultToScanResult);
+    const { res, body } = await request_1.makeRequest({
+        method: 'POST',
+        url: `${config_1.default.API}/iac-cli-share-results`,
+        json: true,
+        headers: {
+            authorization: api_token_1.getAuthHeader(),
+        },
+        body: scanResults,
+    });
+    if (res.statusCode === 401) {
+        throw authentication_failed_error_1.AuthFailedError();
+    }
+    return body;
+}
+exports.shareResults = shareResults;
+
+
+/***/ }),
+
+/***/ 88784:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.convertIacResultToScanResult = void 0;
+function convertIacResultToScanResult(iacResult) {
+    return {
+        identity: {
+            type: iacResult.projectType,
+            targetFile: iacResult.targetFile,
+        },
+        facts: [],
+        findings: iacResult.violatedPolicies.map((policy) => {
+            return {
+                data: { metadata: policy, docId: policy.docId },
+                type: 'iacIssue',
+            };
+        }),
+        name: iacResult.projectName,
+        target: { name: iacResult.projectName },
+    };
+}
+exports.convertIacResultToScanResult = convertIacResultToScanResult;
+
+
 /***/ }),
 
 /***/ 24135: