snyk 1.803.0 → 1.807.0

package/README.md

@@ -160,12 +160,14 @@ Snyk also offers many integrations into developer tooling. These integrations wi
 
 # Getting started with Snyk CLI
 
-Once you installed the Snyk CLI, you can verify it's working by running
+Once you installed the Snyk CLI, you can verify it's working by running:
 
 ```bash
-snyk --version
+snyk --help
 ```
 
+See the [full Snyk CLI help](./help/cli-commands).
+
 ## Authorization
 
 Snyk CLI depends on [Snyk.io](https://snyk.io) APIs. Connect your Snyk CLI with [Snyk.io](https://snyk.io) by running:
@@ -246,7 +248,7 @@ Here are some flags that you might find useful:
 
   Auto-detect all projects in working directory
 
-See all the available commands and options by running `--help`:
+[See all the available commands and options](./help/cli-commands) by running `--help`:
 
 ```bash
 snyk --help

package/dist/cli/293.index.js

@@ -4684,19 +4684,26 @@ const api_token_1 = __webpack_require__(95181);
 const config_1 = __webpack_require__(22541);
 const spinner_1 = __webpack_require__(86766);
 const utils_1 = __webpack_require__(33113);
-const unsupported_feature_snyk_code_error_1 = __webpack_require__(90551);
+const errors_1 = __webpack_require__(61315);
 const proxy_from_env_1 = __webpack_require__(21394);
 const global_agent_1 = __webpack_require__(97959);
-async function getCodeAnalysisAndParseResults(root, options) {
+async function getCodeAnalysisAndParseResults(root, options, sastSettings) {
     await spinner_1.spinner.clearAll();
     utils_1.analysisProgressUpdate();
-    const codeAnalysis = await getCodeAnalysis(root, options);
+    const codeAnalysis = await getCodeAnalysis(root, options, sastSettings);
     spinner_1.spinner.clearAll();
     return parseSecurityResults(codeAnalysis);
 }
 exports.getCodeAnalysisAndParseResults = getCodeAnalysisAndParseResults;
-async function getCodeAnalysis(root, options) {
-    const baseURL = config_1.default.CODE_CLIENT_PROXY_URL;
+async function getCodeAnalysis(root, options, sastSettings) {
+    const isLocalCodeEngineEnabled = isLocalCodeEngine(sastSettings);
+    if (isLocalCodeEngineEnabled) {
+        validateLocalCodeEngineUrl(sastSettings.localCodeEngine.url);
+    }
+    const source = 'snyk-cli';
+    const baseURL = isLocalCodeEngineEnabled
+        ? sastSettings.localCodeEngine.url
+        : config_1.default.CODE_CLIENT_PROXY_URL;
     // TODO(james) This mirrors the implementation in request.ts and we need to use this for deeproxy calls
     // This ensures we support lowercase http(s)_proxy values as well
     // The weird IF around it ensures we don't create an envvar with
@@ -4719,9 +4726,15 @@ async function getCodeAnalysis(root, options) {
         ? severityToAnalysisSeverity(options.severityThreshold)
         : code_client_1.AnalysisSeverity.info;
     const result = await code_client_1.analyzeFolders({
-        connection: { baseURL, sessionToken, source: 'snyk-cli' },
+        connection: { baseURL, sessionToken, source },
         analysisOptions: { severity },
         fileOptions: { paths: [root] },
+        analysisContext: {
+            initiator: 'CLI',
+            flow: source,
+            orgDisplayName: config_1.default.org,
+            projectName: config_1.default.PROJECT_NAME,
+        },
     });
     if ((result === null || result === void 0 ? void 0 : result.analysisResults.type) === 'sarif') {
         return result.analysisResults.sarif;
@@ -4730,7 +4743,7 @@ async function getCodeAnalysis(root, options) {
 }
 function severityToAnalysisSeverity(severity) {
     if (severity === legacy_1.SEVERITY.CRITICAL) {
-        throw new unsupported_feature_snyk_code_error_1.FeatureNotSupportedBySnykCodeError(legacy_1.SEVERITY.CRITICAL);
+        throw new errors_1.FeatureNotSupportedBySnykCodeError(legacy_1.SEVERITY.CRITICAL);
     }
     const severityLevel = {
         low: 1,
@@ -4777,6 +4790,15 @@ function getSecurityResultsOnly(results, securityRules) {
     }, []);
     return securityResults;
 }
+function isLocalCodeEngine(sastSettings) {
+    const { sastEnabled, localCodeEngine } = sastSettings;
+    return sastEnabled && localCodeEngine.enabled;
+}
+function validateLocalCodeEngineUrl(localCodeEngineUrl) {
+    if (localCodeEngineUrl.length === 0) {
+        throw new errors_1.MissingConfigurationError('Local Code Engine');
+    }
+}
 
 
 /***/ }),
@@ -4822,6 +4844,41 @@ async function trackUsage(org) {
 exports.trackUsage = trackUsage;
 
 
+/***/ }),
+
+/***/ 61315:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+var missing_configuration_error_1 = __webpack_require__(73016);
+Object.defineProperty(exports, "MissingConfigurationError", ({ enumerable: true, get: function () { return missing_configuration_error_1.MissingConfigurationError; } }));
+var unsupported_feature_snyk_code_error_1 = __webpack_require__(90551);
+Object.defineProperty(exports, "FeatureNotSupportedBySnykCodeError", ({ enumerable: true, get: function () { return unsupported_feature_snyk_code_error_1.FeatureNotSupportedBySnykCodeError; } }));
+
+
+/***/ }),
+
+/***/ 73016:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.MissingConfigurationError = void 0;
+const custom_error_1 = __webpack_require__(17188);
+class MissingConfigurationError extends custom_error_1.CustomError {
+    constructor(action, additionalUserHelp = '') {
+        super(`Missing configuration for ${action}.`);
+        this.code = 422;
+        this.action = action;
+        this.userMessage = `'Configuration is missing or wrong for ${action}'. ${additionalUserHelp}`;
+    }
+}
+exports.MissingConfigurationError = MissingConfigurationError;
+
+
 /***/ }),
 
 /***/ 90551:
@@ -4973,7 +5030,7 @@ exports.codePlugin = void 0;
 const chalk_1 = __webpack_require__(32589);
 const debugLib = __webpack_require__(15158);
 const analysis_1 = __webpack_require__(2806);
-const validate_1 = __webpack_require__(33362);
+const settings_1 = __webpack_require__(24930);
 const output_format_1 = __webpack_require__(75802);
 const errors_1 = __webpack_require__(55191);
 const json_1 = __webpack_require__(27019);
@@ -4992,10 +5049,10 @@ exports.codePlugin = {
         var _a, _b;
         try {
             analytics.add('sast-scan', true);
-            await validate_1.validateCodeTest(options);
+            const sastSettings = await settings_1.getSastSettings(options);
             // Currently code supports only one path
             const path = paths[0];
-            const sarifTypedResult = await analysis_1.getCodeAnalysisAndParseResults(path, options);
+            const sarifTypedResult = await analysis_1.getCodeAnalysisAndParseResults(path, options, sastSettings);
             if (!sarifTypedResult) {
                 throw new errors_1.NoSupportedSastFiles();
             }
@@ -5053,6 +5110,47 @@ function hasIssues(readableResult) {
 }
 
 
+/***/ }),
+
+/***/ 24930:
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.getSastSettings = void 0;
+const config_1 = __webpack_require__(22541);
+const checks_1 = __webpack_require__(15976);
+const errors_1 = __webpack_require__(55191);
+async function getSastSettings(options) {
+    const org = options.org || config_1.default.org;
+    // This is an unexpected path, code plugin executed for non-code command.
+    if (!options.code) {
+        throw new errors_1.FeatureNotSupportedForOrgError(org);
+    }
+    const sastSettingsResponse = await checks_1.getSastSettingsForOrg(org);
+    if ((sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.code) === 401 ||
+        (sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.code) === 403) {
+        throw errors_1.AuthFailedError(sastSettingsResponse.error, sastSettingsResponse.code);
+    }
+    if ((sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.code) === 404) {
+        throw new errors_1.NotFoundError(sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.userMessage);
+    }
+    if (!sastSettingsResponse.sastEnabled) {
+        throw new errors_1.FeatureNotSupportedForOrgError(org, 'Snyk Code', 'enable in Settings > Snyk Code');
+    }
+    if (sastSettingsResponse.localCodeEngine.enabled) {
+        throw new errors_1.CustomError('Snyk Code Local Engine is enabled, Snyk Code CLI is temporary disabled.');
+    }
+    const trackUsageResponse = await checks_1.trackUsage(org);
+    if (trackUsageResponse.code === 429) {
+        throw new errors_1.FailedToRunTestError(trackUsageResponse.userMessage, trackUsageResponse.code);
+    }
+    return sastSettingsResponse;
+}
+exports.getSastSettings = getSastSettings;
+
+
 /***/ }),
 
 /***/ 33113:
@@ -5097,46 +5195,6 @@ function analysisProgressUpdate() {
 exports.analysisProgressUpdate = analysisProgressUpdate;
 
 
-/***/ }),
-
-/***/ 33362:
-/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.validateCodeTest = void 0;
-const config_1 = __webpack_require__(22541);
-const checks_1 = __webpack_require__(15976);
-const errors_1 = __webpack_require__(55191);
-async function validateCodeTest(options) {
-    const org = options.org || config_1.default.org;
-    // This is an unexpected path, code plugin executed for non-code command.
-    if (!options.code) {
-        throw new errors_1.FeatureNotSupportedForOrgError(org);
-    }
-    const sastSettingsResponse = await checks_1.getSastSettingsForOrg(org);
-    if ((sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.code) === 401 ||
-        (sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.code) === 403) {
-        throw errors_1.AuthFailedError(sastSettingsResponse.error, sastSettingsResponse.code);
-    }
-    if ((sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.code) === 404) {
-        throw new errors_1.NotFoundError(sastSettingsResponse === null || sastSettingsResponse === void 0 ? void 0 : sastSettingsResponse.userMessage);
-    }
-    if (!sastSettingsResponse.sastEnabled) {
-        throw new errors_1.FeatureNotSupportedForOrgError(org, 'Snyk Code', 'enable in Settings > Snyk Code');
-    }
-    if (sastSettingsResponse.localCodeEngine.enabled) {
-        throw new errors_1.CustomError('Snyk Code Local Engine is enabled, Snyk Code CLI is temporary disabled.');
-    }
-    const trackUsageResponse = await checks_1.trackUsage(org);
-    if (trackUsageResponse.code === 429) {
-        throw new errors_1.FailedToRunTestError(trackUsageResponse.userMessage, trackUsageResponse.code);
-    }
-}
-exports.validateCodeTest = validateCodeTest;
-
-
 /***/ }),
 
 /***/ 8820: