@coana-tech/cli 14.12.83 → 14.12.85
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli.mjs +51 -18
- package/package.json +1 -1
- package/repos/coana-tech/alucard/alucard.jar +0 -0
- package/repos/coana-tech/goana/bin/goana-darwin-amd64.gz +0 -0
- package/repos/coana-tech/goana/bin/goana-darwin-arm64.gz +0 -0
- package/repos/coana-tech/goana/bin/goana-linux-amd64.gz +0 -0
- package/repos/coana-tech/goana/bin/goana-linux-arm64.gz +0 -0
package/cli.mjs
CHANGED
|
@@ -221333,6 +221333,7 @@ var NpmSocketUpgradeManager = class {
|
|
|
221333
221333
|
artifacts: i3(artifacts),
|
|
221334
221334
|
message: `Failed to update lockfile: ${result.error?.message ?? "Unknown error"}`
|
|
221335
221335
|
});
|
|
221336
|
+
throw new Error(`Failed to update lockfile: ${result.error?.message ?? "Unknown error"}`);
|
|
221336
221337
|
}
|
|
221337
221338
|
});
|
|
221338
221339
|
}
|
|
@@ -245909,7 +245910,7 @@ async function onlineScan(dependencyTree, apiKey, timeout) {
|
|
|
245909
245910
|
}
|
|
245910
245911
|
|
|
245911
245912
|
// dist/version.js
|
|
245912
|
-
var version2 = "14.12.
|
|
245913
|
+
var version2 = "14.12.85";
|
|
245913
245914
|
|
|
245914
245915
|
// dist/cli-core.js
|
|
245915
245916
|
var { mapValues, omit, partition, pick } = import_lodash15.default;
|
|
@@ -246372,10 +246373,14 @@ Subproject: ${subproject}`);
|
|
|
246372
246373
|
async runReachabilityAnalysisForWorkspaces(workspacePathToDataForAnalysis, workspaceToVulnerabilities, workspaceToDirectDependencies, otherModulesCommunicator, subprojectPath, ecosystem, reachabilitySupported, analysisStarting) {
|
|
246373
246374
|
const workspaces = Object.keys(workspacePathToDataForAnalysis);
|
|
246374
246375
|
const totalWorkspaces = workspaces.length;
|
|
246376
|
+
const concurrency = Number(this.options.concurrency);
|
|
246377
|
+
const shouldIncludeWorkspaceInLogs = concurrency > 1;
|
|
246378
|
+
let npmAnalysisMutex = Promise.resolve();
|
|
246375
246379
|
const workspaceToAugmentedVulnerabilities = Object.fromEntries(await asyncMap(workspaces, async (workspacePath, index2) => {
|
|
246376
246380
|
analysisStarting?.(workspacePath, index2 + 1, totalWorkspaces);
|
|
246377
246381
|
const vulnerabilities = workspaceToVulnerabilities[workspacePath] ?? [];
|
|
246378
|
-
|
|
246382
|
+
const workspacePrefix = shouldIncludeWorkspaceInLogs ? `[${workspacePath}] ` : "";
|
|
246383
|
+
logger.info(`${workspacePrefix}Process workspace ${workspacePath} with ${vulnerabilities.length} ${pluralize(vulnerabilities.length, "vulnerability")}`);
|
|
246379
246384
|
try {
|
|
246380
246385
|
const dataForAnalysis = workspacePathToDataForAnalysis[workspacePath];
|
|
246381
246386
|
const [vulnsSatisfyingThreshold, vulnerabilitiesBelowThreshold] = this.options.minSeverity ? partition(vulnerabilities, (v) => !v.severity || shouldAnalyzeBasedOnSeverity(v.severity, this.options.minSeverity)) : [vulnerabilities, []];
|
|
@@ -246395,21 +246400,34 @@ Subproject: ${subproject}`);
|
|
|
246395
246400
|
}
|
|
246396
246401
|
}));
|
|
246397
246402
|
if (vulnerabilitiesBelowThreshold.length > 0) {
|
|
246398
|
-
logger.info(
|
|
246403
|
+
logger.info(`${workspacePrefix}Reachability analysis skipped for ${vulnerabilitiesBelowThreshold.length} ${pluralize(vulnerabilities.length, "vulnerability")} with severity below the min severity threshold: ${this.options.minSeverity}`);
|
|
246399
246404
|
}
|
|
246400
246405
|
if (vulnsUnreachableFromPrecomputation.length > 0) {
|
|
246401
|
-
logger.info(
|
|
246406
|
+
logger.info(`${workspacePrefix}Reachability analysis skipped for ${vulnsUnreachableFromPrecomputation.length} ${pluralize(vulnerabilities.length, "vulnerability")} that ${vulnerabilities.length !== 1 ? "are" : "is"} already known to be unreachable from precomputed (Tier 2) reachability analysis`);
|
|
246402
246407
|
}
|
|
246403
246408
|
if (vulnerabilitiesToAnalyze.length > 0) {
|
|
246404
|
-
logger.info(
|
|
246409
|
+
logger.info(`${workspacePrefix}Running reachability analysis for ${vulnerabilitiesToAnalyze.length} ${pluralize(vulnerabilities.length, "vulnerability")}`);
|
|
246405
246410
|
}
|
|
246406
|
-
|
|
246407
|
-
|
|
246408
|
-
|
|
246409
|
-
|
|
246410
|
-
|
|
246411
|
+
let augmentedVulnerabilitiesToAnalyze;
|
|
246412
|
+
if (vulnerabilitiesToAnalyze.length === 0) {
|
|
246413
|
+
augmentedVulnerabilitiesToAnalyze = [];
|
|
246414
|
+
} else if (reachabilitySupported && !this.shouldExcludeAnalyzingWorkspace(subprojectPath, workspacePath, workspacePrefix)) {
|
|
246415
|
+
if (ecosystem === "NPM" && concurrency > 1) {
|
|
246416
|
+
augmentedVulnerabilitiesToAnalyze = await this.runReachabilityAnalysisWithoutConcurrency(async () => npmAnalysisMutex, (mutex) => {
|
|
246417
|
+
npmAnalysisMutex = mutex;
|
|
246418
|
+
}, otherModulesCommunicator, subprojectPath, workspacePath, dataForAnalysis, ecosystem, vulnerabilitiesToAnalyze, workspacePrefix);
|
|
246419
|
+
} else {
|
|
246420
|
+
augmentedVulnerabilitiesToAnalyze = await this.runReachabilityAnalysis(otherModulesCommunicator, subprojectPath, workspacePath, dataForAnalysis, ecosystem, vulnerabilitiesToAnalyze, workspacePrefix);
|
|
246411
246421
|
}
|
|
246412
|
-
}
|
|
246422
|
+
} else {
|
|
246423
|
+
augmentedVulnerabilitiesToAnalyze = vulnerabilitiesToAnalyze.map((v) => ({
|
|
246424
|
+
...v,
|
|
246425
|
+
results: {
|
|
246426
|
+
type: "otherError",
|
|
246427
|
+
message: `Reachability analysis for languages using ${ecosystem} not supported yet`
|
|
246428
|
+
}
|
|
246429
|
+
}));
|
|
246430
|
+
}
|
|
246413
246431
|
const augmentedVulnerabilities = [
|
|
246414
246432
|
...vulnerabilitiesDeterminedUnreachableFromPrecomputation,
|
|
246415
246433
|
...augmentedVulnerabilitiesToAnalyze,
|
|
@@ -246417,7 +246435,7 @@ Subproject: ${subproject}`);
|
|
|
246417
246435
|
];
|
|
246418
246436
|
return [workspacePath, augmentedVulnerabilities];
|
|
246419
246437
|
} catch (e) {
|
|
246420
|
-
logger.error(
|
|
246438
|
+
logger.error(`${workspacePrefix}Reachability analysis failed for workspace ${workspacePath} in subproject ${subprojectPath}: ${e.message}`);
|
|
246421
246439
|
return [
|
|
246422
246440
|
workspacePath,
|
|
246423
246441
|
vulnerabilities.map((v) => ({
|
|
@@ -246429,7 +246447,7 @@ Subproject: ${subproject}`);
|
|
|
246429
246447
|
}))
|
|
246430
246448
|
];
|
|
246431
246449
|
}
|
|
246432
|
-
}));
|
|
246450
|
+
}, concurrency));
|
|
246433
246451
|
const successfulWorkspaceToAugmentedVulnerabilities = Object.fromEntries(Object.entries(workspaceToAugmentedVulnerabilities).filter(([_, vulns]) => vulns !== void 0));
|
|
246434
246452
|
if (ecosystem === "MAVEN" || ecosystem === "NUGET") {
|
|
246435
246453
|
pruneVulnerablePathsToShortestPathsOnly(ecosystem, successfulWorkspaceToAugmentedVulnerabilities);
|
|
@@ -246482,7 +246500,22 @@ Subproject: ${subproject}`);
|
|
|
246482
246500
|
}
|
|
246483
246501
|
}
|
|
246484
246502
|
}
|
|
246485
|
-
|
|
246503
|
+
async runReachabilityAnalysisWithoutConcurrency(getAnalysisMutex, setAnalysisMutex, otherModulesCommunicator, subprojectPath, workspacePath, dataForAnalysis, ecosystem, vulnerabilitiesToAnalyze, workspacePrefix) {
|
|
246504
|
+
const previousAnalysis = getAnalysisMutex();
|
|
246505
|
+
let resolveCurrentAnalysis;
|
|
246506
|
+
setAnalysisMutex(new Promise((resolve44) => {
|
|
246507
|
+
resolveCurrentAnalysis = resolve44;
|
|
246508
|
+
}));
|
|
246509
|
+
await previousAnalysis;
|
|
246510
|
+
let augmentedVulnerabilitiesToAnalyze;
|
|
246511
|
+
try {
|
|
246512
|
+
augmentedVulnerabilitiesToAnalyze = await this.runReachabilityAnalysis(otherModulesCommunicator, subprojectPath, workspacePath, dataForAnalysis, ecosystem, vulnerabilitiesToAnalyze, workspacePrefix);
|
|
246513
|
+
} finally {
|
|
246514
|
+
resolveCurrentAnalysis();
|
|
246515
|
+
}
|
|
246516
|
+
return augmentedVulnerabilitiesToAnalyze;
|
|
246517
|
+
}
|
|
246518
|
+
shouldExcludeAnalyzingWorkspace(subprojectPath, workspacePath, workspacePrefix = "") {
|
|
246486
246519
|
const shouldExcludeWorkspaceForAnalysis = shouldIgnoreDueToExcludeDirsOrChangedFiles({
|
|
246487
246520
|
mainProjectDir: this.rootWorkingDirectory,
|
|
246488
246521
|
excludeDirs: this.options.excludeDirs ?? [],
|
|
@@ -246490,15 +246523,15 @@ Subproject: ${subproject}`);
|
|
|
246490
246523
|
includeDirs: this.options.includeDirs ?? []
|
|
246491
246524
|
}, resolve42(subprojectPath, workspacePath));
|
|
246492
246525
|
if (shouldExcludeWorkspaceForAnalysis) {
|
|
246493
|
-
logger.info(
|
|
246526
|
+
logger.info(`${workspacePrefix}Skipping reachability analysis for workspace ${workspacePath} due to it being excluded.`);
|
|
246494
246527
|
}
|
|
246495
246528
|
return shouldExcludeWorkspaceForAnalysis;
|
|
246496
246529
|
}
|
|
246497
|
-
async runReachabilityAnalysis(otherModulesCommunicator, subprojectPath, workspacePath, workspaceData, ecosystem, vulnerabilities) {
|
|
246530
|
+
async runReachabilityAnalysis(otherModulesCommunicator, subprojectPath, workspacePath, workspaceData, ecosystem, vulnerabilities, workspacePrefix = "") {
|
|
246498
246531
|
const [vulnsWithActualAPIPatterns, result] = partition(vulnerabilities, (v) => Array.isArray(v.vulnerabilityAccessPaths));
|
|
246499
246532
|
for (const v of result)
|
|
246500
246533
|
v.results = typeof v.vulnerabilityAccessPaths === "string" ? { type: "noAnalysisCheck", message: v.vulnerabilityAccessPaths } : { type: "missingVulnerabilityPattern" };
|
|
246501
|
-
logger.info(
|
|
246534
|
+
logger.info(`${workspacePrefix}Reachability analysis not possible for ${result.length} of the ${pluralize(vulnerabilities.length, "vulnerability")}`);
|
|
246502
246535
|
if (!vulnsWithActualAPIPatterns.length)
|
|
246503
246536
|
return result;
|
|
246504
246537
|
this.sendProgress("REACHABILITY_ANALYSIS", true, subprojectPath, workspacePath);
|
|
@@ -246666,7 +246699,7 @@ async function getGitDataToMetadataIfAvailable(rootWorkingDirectory) {
|
|
|
246666
246699
|
// dist/index.js
|
|
246667
246700
|
var program2 = new Command();
|
|
246668
246701
|
var run2 = new Command();
|
|
246669
|
-
run2.name("run").argument("<path>", "File system path to folder containing the project").option("-o, --output-dir <path>", "Write json report to <path>/coana-report.json").option("-d, --debug", "Enable debug logging", false).option("-s, --silent", "Silence all debug/warning output", false).option("--silent-spinner", "Silence spinner", "CI" in process.env || !process.stdin.isTTY).option("-p, --print-report", "Print the report to the console", false).option("--offline-database <path>", "Path to a coana-offline-db.json file for running the CLI without internet connectivity", void 0).option("-t, --timeout <timeout>", "Set API <timeout> in milliseconds to Coana backend.", "300000").option("-a, --analysis-timeout <timeout>", "Set <timeout> in seconds for each reachability analysis run").option("--memory-limit <memoryInMB>", "Set memory limit for analysis to <memoryInMB> megabytes of memory.", "8192").option("-c, --concurrency <concurrency>", "Set the maximum number of concurrent reachability analysis runs. It's recommended to choose a concurrency level that ensures that each analysis run has at least the --memory-limit amount of memory available.", "1").option("--api-key <key>", "Set the Coana dashboard API key. By setting you also enable the dashboard integration.").addOption(new Option("--write-report-to-file", "Write the report dashboard-compatible report to dashboard-report.json. This report may help the Coana team debug issues with the report insertion mechanism.").default(false).hideHelp()).option("--project-name <repoName>", "Set the name of the repository. Used for dashboard integration.").option("--repo-url <repoUrl>", "Set the URL of the repository. Used for dashboard integration.").option("--include-dirs <relativeDirs...>", "globs for directories to include from the detection of subprojects (space-separated)(use relative paths from the project root). Notice, projects that are not included may still be scanned if they are referenced from included projects.").option("--exclude-dirs <relativeDirs...>", "globs for directories to exclude from the detection of subprojects (space-separated)(use relative paths from the project root). Notice, excluded projects may still be scanned if they are referenced from non-excluded projects.").option("--disable-analysis-splitting", "Limits Coana to at most 1 reachability analysis run per workspace").option("--print-analysis-log-file", "Store log output from the JavaScript/TypeScript reachability analysis in the file js-analysis.log file in the root of each workspace", false).option("--entry-points <entryPoints...>", "List of files to analyze for root workspace. The reachability analysis automatically analyzes all files used by the entry points. If not provided, all JavaScript and TypeScript files are considered entry points. For non-root workspaces, all JavaScript and TypeScript files are analyzed as well.").option("--include-projects-with-no-reachability-support", "Also runs Coana on projects where we support traditional SCA, but does not yet support reachability analysis.", false).option("--ecosystems <ecosystems...>", "List of ecosystems to analyze (space-separated). Currently NPM, PIP, MAVEN, NUGET and GO are supported. Default is all supported ecosystems.").addOption(new Option("--purl-types <purlTypes...>", "List of PURL types to analyze (space-separated). Currently npm, pypi, maven, nuget, golang and cargo are supported. Default is all supported purl types.").hideHelp()).option("--changed-files <files...>", "List of files that have changed. If provided, Coana only analyzes workspaces and modules that contain changed files.").option("--disable-report-submission", "Disable the submission of the report to the Coana dashboard. Used by the pipeline blocking feature.", false).option("--disable-analytics-sharing", "Disable analytics sharing.", false).option("--provider-project <path>", "File system path to folder containing the provider project (Only supported for Maven, Gradle, and SBT)").option("--provider-workspaces <dirs...>", "List of workspaces that build the provided runtime environment (Only supported for Maven, Gradle, and SBT)", (paths) => paths.split(" ")).option("--lightweight-reachability", "Runs Coana in lightweight mode. This increases analysis speed but also raises the risk of Coana misclassifying the reachability of certain complex vulnerabilities. Recommended only for use with Coana Guardrail mode.", false).addOption(new Option("--run-without-docker", "Run package managers and reachability analyzers without using docker").default(process.env.RUN_WITHOUT_DOCKER === "true").hideHelp()).addOption(new Option("--run-env <env>", "Specifies the environment in which the CLI is run. So far only MANAGED_SCAN and UNKNOWN are supported.").default("UNKNOWN").choices(["UNKNOWN", "MANAGED_SCAN"]).hideHelp()).addOption(new Option("--guardrail-mode", "Run Coana in guardrail mode. This mode is used to prevent new reachable vulnerabilities from being introduced into the codebase. Usually run as a CI check when pushing new commits to a pull request.")).option("--ignore-failing-workspaces", "Continue processing when a workspace fails instead of exiting. Failed workspaces will be logged at termination.", false).addOption(new Option("--socket-mode <output-file>", "Run Coana in socket mode and write report to <output-file>").hideHelp()).addOption(new Option("--manifests-tar-hash <hash>", "Hash of the tarball containing all manifest files already uploaded to Socket. If provided, Socket will be used for computing dependency trees.").hideHelp()).option("--skip-cache-usage", "Do not attempt to use cached analysis configuration from previous runs", false).addOption(new Option("--min-severity <severity>", "Set the minimum severity of vulnerabilities to analyze. Supported severities are info, low, moderate, high and critical.").choices(["info", "INFO", "low", "LOW", "moderate", "MODERATE", "high", "HIGH", "critical", "CRITICAL"])).option("--use-unreachable-from-precomputation", "Skip the reachability analysis for vulnerabilities that are already known to be unreachable from the precomputed reachability analysis (Tier 2).", false).version(version2).configureHelp({ sortOptions: true }).action(async (path2, options) => {
|
|
246702
|
+
run2.name("run").argument("<path>", "File system path to folder containing the project").option("-o, --output-dir <path>", "Write json report to <path>/coana-report.json").option("-d, --debug", "Enable debug logging", false).option("-s, --silent", "Silence all debug/warning output", false).option("--silent-spinner", "Silence spinner", "CI" in process.env || !process.stdin.isTTY).option("-p, --print-report", "Print the report to the console", false).option("--offline-database <path>", "Path to a coana-offline-db.json file for running the CLI without internet connectivity", void 0).option("-t, --timeout <timeout>", "Set API <timeout> in milliseconds to Coana backend.", "300000").option("-a, --analysis-timeout <timeout>", "Set <timeout> in seconds for each reachability analysis run").option("--memory-limit <memoryInMB>", "Set memory limit for analysis to <memoryInMB> megabytes of memory.", "8192").option("-c, --concurrency <concurrency>", "Set the maximum number of concurrent reachability analysis runs. It's recommended to choose a concurrency level that ensures that each analysis run has at least the --memory-limit amount of memory available. NPM reachability analysis does not support concurrent execution, so the concurrency level is ignored for NPM.", "1").option("--api-key <key>", "Set the Coana dashboard API key. By setting you also enable the dashboard integration.").addOption(new Option("--write-report-to-file", "Write the report dashboard-compatible report to dashboard-report.json. This report may help the Coana team debug issues with the report insertion mechanism.").default(false).hideHelp()).option("--project-name <repoName>", "Set the name of the repository. Used for dashboard integration.").option("--repo-url <repoUrl>", "Set the URL of the repository. Used for dashboard integration.").option("--include-dirs <relativeDirs...>", "globs for directories to include from the detection of subprojects (space-separated)(use relative paths from the project root). Notice, projects that are not included may still be scanned if they are referenced from included projects.").option("--exclude-dirs <relativeDirs...>", "globs for directories to exclude from the detection of subprojects (space-separated)(use relative paths from the project root). Notice, excluded projects may still be scanned if they are referenced from non-excluded projects.").option("--disable-analysis-splitting", "Limits Coana to at most 1 reachability analysis run per workspace").option("--print-analysis-log-file", "Store log output from the JavaScript/TypeScript reachability analysis in the file js-analysis.log file in the root of each workspace", false).option("--entry-points <entryPoints...>", "List of files to analyze for root workspace. The reachability analysis automatically analyzes all files used by the entry points. If not provided, all JavaScript and TypeScript files are considered entry points. For non-root workspaces, all JavaScript and TypeScript files are analyzed as well.").option("--include-projects-with-no-reachability-support", "Also runs Coana on projects where we support traditional SCA, but does not yet support reachability analysis.", false).option("--ecosystems <ecosystems...>", "List of ecosystems to analyze (space-separated). Currently NPM, PIP, MAVEN, NUGET and GO are supported. Default is all supported ecosystems.").addOption(new Option("--purl-types <purlTypes...>", "List of PURL types to analyze (space-separated). Currently npm, pypi, maven, nuget, golang and cargo are supported. Default is all supported purl types.").hideHelp()).option("--changed-files <files...>", "List of files that have changed. If provided, Coana only analyzes workspaces and modules that contain changed files.").option("--disable-report-submission", "Disable the submission of the report to the Coana dashboard. Used by the pipeline blocking feature.", false).option("--disable-analytics-sharing", "Disable analytics sharing.", false).option("--provider-project <path>", "File system path to folder containing the provider project (Only supported for Maven, Gradle, and SBT)").option("--provider-workspaces <dirs...>", "List of workspaces that build the provided runtime environment (Only supported for Maven, Gradle, and SBT)", (paths) => paths.split(" ")).option("--lightweight-reachability", "Runs Coana in lightweight mode. This increases analysis speed but also raises the risk of Coana misclassifying the reachability of certain complex vulnerabilities. Recommended only for use with Coana Guardrail mode.", false).addOption(new Option("--run-without-docker", "Run package managers and reachability analyzers without using docker").default(process.env.RUN_WITHOUT_DOCKER === "true").hideHelp()).addOption(new Option("--run-env <env>", "Specifies the environment in which the CLI is run. So far only MANAGED_SCAN and UNKNOWN are supported.").default("UNKNOWN").choices(["UNKNOWN", "MANAGED_SCAN"]).hideHelp()).addOption(new Option("--guardrail-mode", "Run Coana in guardrail mode. This mode is used to prevent new reachable vulnerabilities from being introduced into the codebase. Usually run as a CI check when pushing new commits to a pull request.")).option("--ignore-failing-workspaces", "Continue processing when a workspace fails instead of exiting. Failed workspaces will be logged at termination.", false).addOption(new Option("--socket-mode <output-file>", "Run Coana in socket mode and write report to <output-file>").hideHelp()).addOption(new Option("--manifests-tar-hash <hash>", "Hash of the tarball containing all manifest files already uploaded to Socket. If provided, Socket will be used for computing dependency trees.").hideHelp()).option("--skip-cache-usage", "Do not attempt to use cached analysis configuration from previous runs", false).addOption(new Option("--min-severity <severity>", "Set the minimum severity of vulnerabilities to analyze. Supported severities are info, low, moderate, high and critical.").choices(["info", "INFO", "low", "LOW", "moderate", "MODERATE", "high", "HIGH", "critical", "CRITICAL"])).option("--use-unreachable-from-precomputation", "Skip the reachability analysis for vulnerabilities that are already known to be unreachable from the precomputed reachability analysis (Tier 2).", false).version(version2).configureHelp({ sortOptions: true }).action(async (path2, options) => {
|
|
246670
246703
|
process.env.DOCKER_IMAGE_TAG ??= version2;
|
|
246671
246704
|
options.ecosystems = options.ecosystems?.map((e) => e.toUpperCase());
|
|
246672
246705
|
options.minSeverity = options.minSeverity?.toUpperCase();
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|