@trustify-da/trustify-da-javascript-client 0.3.0-ea.608d6fa → 0.3.0-ea.61444d4

package/dist/src/providers/rust_cargo.js

@@ -4,8 +4,8 @@ import { PackageURL } from 'packageurl-js';
 import { parse as parseToml } from 'smol-toml';
 import { getLicense } from '../license/license_utils.js';
 import Sbom from '../sbom.js';
-import { getCustomPath, invokeCommand } from '../tools.js';
-export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest };
+import { getCustom, getCustomPath, invokeCommand } from '../tools.js';
+export default { isSupported, validateLockFile, provideComponent, provideStack, readLicenseFromManifest, packageManagerName() { return 'cargo'; } };
 /** @typedef {import('../provider').Provider} */
 /** @typedef {import('../provider').Provided} Provided */
 /**
@@ -71,15 +71,22 @@ function isSupported(manifestName) {
  * Read project license from Cargo.toml, with fallback to LICENSE file.
  * Supports the `license` field under `[package]` (single crate / workspace
  * with root) and under `[workspace.package]` (virtual workspaces).
+ * When a member crate uses `license = { workspace = true }`, the actual
+ * license is resolved from the workspace root Cargo.toml.
  * @param {string} manifestPath - path to Cargo.toml
+ * @param {object} [metadata] - cargo metadata output (needed for workspace license resolution)
  * @returns {string|null} SPDX identifier or null
  */
-function readLicenseFromManifest(manifestPath) {
+function readLicenseFromManifest(manifestPath, metadata) {
     let fromManifest = null;
     try {
         let content = fs.readFileSync(manifestPath, 'utf-8');
         let parsed = parseToml(content);
-        fromManifest = parsed.package?.license
+        let packageLicense = parsed.package?.license;
+        if (typeof packageLicense === 'object' && packageLicense?.workspace === true) {
+            packageLicense = resolveWorkspaceLicense(parsed, metadata);
+        }
+        fromManifest = packageLicense
             || parsed.workspace?.package?.license
             || null;
     }
@@ -88,6 +95,26 @@ function readLicenseFromManifest(manifestPath) {
     }
     return getLicense(fromManifest, manifestPath);
 }
+/**
+ * Resolve a workspace-inherited license from the workspace root Cargo.toml.
+ * @param {object} parsed - the parsed member crate Cargo.toml
+ * @param {object} [metadata] - cargo metadata output with workspace_root
+ * @returns {string|null} resolved license string or null
+ */
+function resolveWorkspaceLicense(parsed, metadata) {
+    if (metadata?.workspace_root) {
+        let cargoTomlPath = path.join(metadata.workspace_root, 'Cargo.toml');
+        try {
+            let content = fs.readFileSync(cargoTomlPath, 'utf-8');
+            let workspaceParsed = parseToml(content);
+            return workspaceParsed.workspace?.package?.license || null;
+        }
+        catch (_) {
+            // fall through
+        }
+    }
+    return parsed.workspace?.package?.license || null;
+}
 /**
  * Validates that Cargo.lock exists in the manifest directory or in a parent
  * workspace root directory.  In Cargo workspaces the lock file always lives at
@@ -95,10 +122,18 @@ function readLicenseFromManifest(manifestPath) {
  * up the directory tree looking for Cargo.lock (stopping when we find a
  * Cargo.toml that contains a [workspace] section, or when we reach the
  * filesystem root).
+ * When TRUSTIFY_DA_WORKSPACE_DIR is provided (via env var or opts),
+ * checks only that directory for Cargo.lock — no walk-up.
  * @param {string} manifestDir - the directory where the manifest lies
+ * @param {{TRUSTIFY_DA_WORKSPACE_DIR?: string}} [opts={}] - optional workspace root
  * @returns {boolean} true if Cargo.lock is found
  */
-function validateLockFile(manifestDir) {
+function validateLockFile(manifestDir, opts = {}) {
+    const workspaceDir = getCustom('TRUSTIFY_DA_WORKSPACE_DIR', null, opts);
+    if (workspaceDir) {
+        const dir = path.resolve(workspaceDir);
+        return fs.existsSync(path.join(dir, 'Cargo.lock'));
+    }
     let dir = path.resolve(manifestDir);
     let parent = dir;
     do {
@@ -165,13 +200,14 @@ function getSBOM(manifest, opts = {}, includeTransitive) {
     let metadata = executeCargoMetadata(cargoBin, manifestDir);
     let ignoredDeps = getIgnoredDeps(manifest, metadata);
     let crateType = detectCrateType(metadata);
-    let license = readLicenseFromManifest(manifest);
+    let license = readLicenseFromManifest(manifest, metadata);
+    let hashMap = parseCargoLockHashes(manifestDir);
     let sbom;
     if (crateType === CrateType.WORKSPACE_VIRTUAL) {
-        sbom = handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license);
+        sbom = handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license, hashMap);
     }
     else {
-        sbom = handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license);
+        sbom = handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license, hashMap);
     }
     return sbom;
 }
@@ -209,6 +245,63 @@ function executeCargoMetadata(cargoBin, manifestDir) {
         throw new Error('failed to execute cargo metadata', { cause: error });
     }
 }
+/**
+ * Parses Cargo.lock to extract SHA-256 checksums for each package.
+ * @param {string} manifestDir - directory containing Cargo.toml (Cargo.lock is searched upward)
+ * @returns {Map<string, Array<{alg: string, content: string}>>} map of "name@version" to CycloneDX hashes
+ * @private
+ */
+function parseCargoLockHashes(manifestDir) {
+    let hashMap = new Map();
+    let lockPath = findCargoLock(manifestDir);
+    if (!lockPath) {
+        return hashMap;
+    }
+    try {
+        let content = fs.readFileSync(lockPath, 'utf-8');
+        let parsed = parseToml(content);
+        for (let pkg of (parsed.package || [])) {
+            if (pkg.name && pkg.version && pkg.checksum) {
+                hashMap.set(`${pkg.name}@${pkg.version}`, [{ alg: 'SHA-256', content: pkg.checksum }]);
+            }
+        }
+    }
+    catch (error) {
+        console.warn('Failed to parse Cargo.lock for hashes, SBOM will be generated without hashes');
+    }
+    return hashMap;
+}
+/**
+ * Searches upward from the manifest directory to find the nearest Cargo.lock.
+ * @param {string} manifestDir - starting directory
+ * @returns {string|null} absolute path to Cargo.lock or null if not found
+ * @private
+ */
+function findCargoLock(manifestDir) {
+    let dir = path.resolve(manifestDir);
+    let parent = dir;
+    do {
+        dir = parent;
+        let lockFile = path.join(dir, 'Cargo.lock');
+        if (fs.existsSync(lockFile)) {
+            return lockFile;
+        }
+        let cargoToml = path.join(dir, 'Cargo.toml');
+        if (fs.existsSync(cargoToml)) {
+            try {
+                let content = fs.readFileSync(cargoToml, 'utf-8');
+                if (/\[workspace\]/.test(content)) {
+                    return null;
+                }
+            }
+            catch (_) {
+                // ignore read errors, keep searching
+            }
+        }
+        parent = path.dirname(dir);
+    } while (parent !== dir);
+    return null;
+}
 /**
  * Detects the type of Cargo project from metadata.
  * @param {object} metadata - parsed cargo metadata
@@ -240,7 +333,7 @@ function detectCrateType(metadata) {
  * @returns {string} SBOM json string
  * @private
  */
-function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license) {
+function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, license, hashMap) {
     let rootPackageId = metadata.resolve.root;
     let rootPackage = findPackageById(metadata, rootPackageId);
     let rootPurl = toPurl(rootPackage.name, rootPackage.version);
@@ -251,10 +344,10 @@ function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, licen
         return sbom.getAsJsonString(opts);
     }
     if (includeTransitive) {
-        addTransitiveDeps(sbom, metadata, rootPackageId, ignoredDeps, new Set(), rootPurl);
+        addTransitiveDeps(sbom, metadata, rootPackageId, ignoredDeps, new Set(), hashMap, rootPurl);
     }
     else {
-        addDirectDeps(sbom, metadata, rootPackageId, rootPurl, ignoredDeps);
+        addDirectDeps(sbom, metadata, rootPackageId, rootPurl, ignoredDeps, hashMap);
     }
     return sbom.getAsJsonString(opts);
 }
@@ -280,7 +373,7 @@ function handleSingleCrate(metadata, ignoredDeps, includeTransitive, opts, licen
  * @returns {string} SBOM json string
  * @private
  */
-function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license) {
+function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransitive, opts, license, hashMap) {
     let workspaceRoot = metadata.workspace_root;
     let rootName = path.basename(workspaceRoot);
     let workspaceVersion = getWorkspaceVersion(metadata);
@@ -288,7 +381,6 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
     let sbom = new Sbom();
     sbom.addRoot(rootPurl, license);
     if (includeTransitive) {
-        // Stack analysis: walk all members and their full dependency trees
         let workspaceMembers = metadata.workspace_members || [];
         for (let memberId of workspaceMembers) {
             let memberPackage = findPackageById(metadata, memberId);
@@ -299,11 +391,10 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
                 ? toPathDepPurl(memberPackage.name, memberPackage.version)
                 : toPurl(memberPackage.name, memberPackage.version);
             sbom.addDependency(rootPurl, memberPurl);
-            addTransitiveDeps(sbom, metadata, memberId, ignoredDeps, new Set(), memberPurl);
+            addTransitiveDeps(sbom, metadata, memberId, ignoredDeps, new Set(), hashMap, memberPurl);
         }
     }
     else {
-        // Component analysis: only [workspace.dependencies] from root Cargo.toml
         let workspaceDeps = getWorkspaceDepsFromManifest(manifest);
         for (let depName of workspaceDeps) {
             if (isDepIgnored(depName, ignoredDeps)) {
@@ -320,7 +411,8 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
             let depPurl = pkg.source == null
                 ? toPathDepPurl(pkg.name, pkg.version)
                 : toPurl(pkg.name, pkg.version);
-            sbom.addDependency(rootPurl, depPurl);
+            let hashes = hashMap.get(`${pkg.name}@${pkg.version}`);
+            sbom.addDependency(rootPurl, depPurl, undefined, hashes);
         }
     }
     return sbom.getAsJsonString(opts);
@@ -339,7 +431,7 @@ function handleVirtualWorkspace(manifest, metadata, ignoredDeps, includeTransiti
  *   so callers can ensure it matches the purl already added to the SBOM
  * @private
  */
-function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, startingPurl) {
+function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, hashMap, startingPurl) {
     if (visited.has(packageId)) {
         return;
     }
@@ -367,8 +459,9 @@ function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, star
         let depPurl = depPackage.source == null
             ? toPathDepPurl(depPackage.name, depPackage.version)
             : toPurl(depPackage.name, depPackage.version);
-        sbom.addDependency(sourcePurl, depPurl);
-        addTransitiveDeps(sbom, metadata, depId, ignoredDeps, visited);
+        let hashes = hashMap ? hashMap.get(`${depPackage.name}@${depPackage.version}`) : undefined;
+        sbom.addDependency(sourcePurl, depPurl, undefined, hashes);
+        addTransitiveDeps(sbom, metadata, depId, ignoredDeps, visited, hashMap);
     }
 }
 /**
@@ -381,7 +474,7 @@ function addTransitiveDeps(sbom, metadata, packageId, ignoredDeps, visited, star
  * @param {Set<string>} ignoredDeps - set of ignored dependency names
  * @private
  */
-function addDirectDeps(sbom, metadata, packageId, parentPurl, ignoredDeps) {
+function addDirectDeps(sbom, metadata, packageId, parentPurl, ignoredDeps, hashMap) {
     let resolveNode = findResolveNode(metadata, packageId);
     if (!resolveNode) {
         return;
@@ -398,7 +491,8 @@ function addDirectDeps(sbom, metadata, packageId, parentPurl, ignoredDeps) {
         let depPurl = depPackage.source == null
             ? toPathDepPurl(depPackage.name, depPackage.version)
             : toPurl(depPackage.name, depPackage.version);
-        sbom.addDependency(parentPurl, depPurl);
+        let hashes = hashMap ? hashMap.get(`${depPackage.name}@${depPackage.version}`) : undefined;
+        sbom.addDependency(parentPurl, depPurl, undefined, hashes);
     }
 }
 /**

package/dist/src/remediate.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Orchestrates the full remediation pipeline for a single manifest or directory:
+ * discover manifests → scan via DA backend → extract remediations → apply or preview.
+ *
+ * @param {string} targetPath - path to a manifest file or directory
+ * @param {object} [options]
+ * @param {boolean} [options.dryRun=false] - preview changes without modifying files (applies by default)
+ * @param {string} [options.providers] - comma-separated provider list
+ * @param {string} [options.sources] - comma-separated source list
+ * @param {'dependency'|'bundle'} [options.groupBy='dependency'] - report grouping strategy
+ * @returns {Promise<{exitCode: number, output: string}>}
+ */
+export function runRemediation(targetPath: string, options?: {
+    dryRun?: boolean | undefined;
+    providers?: string | undefined;
+    sources?: string | undefined;
+    groupBy?: "dependency" | "bundle" | undefined;
+}): Promise<{
+    exitCode: number;
+    output: string;
+}>;

package/dist/src/remediate.js

@@ -0,0 +1,149 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import analysis from './analysis.js';
+import { availableProviders, match } from './provider.js';
+import { extractRemediations } from './remediation.js';
+import { generateReport } from './remediation_report.js';
+import { updateMavenVersions } from './updaters/maven_updater.js';
+import { updateTomlVersions } from './updaters/toml_updater.js';
+import { selectTrustifyDABackend } from './index.js';
+// Mirrors DEFAULT_WORKSPACE_DISCOVERY_IGNORE in workspace.js
+const SKIP_DIRS = new Set(['node_modules', '.git']);
+const MANIFEST_TYPES = [
+    {
+        test: (basename) => basename === 'pom.xml',
+        updater: updateMavenVersions,
+        label: 'maven',
+    },
+    {
+        test: (basename) => basename.endsWith('.versions.toml') || basename === 'libs.versions.toml',
+        updater: updateTomlVersions,
+        label: 'toml',
+    },
+];
+/**
+ * Discovers supported manifest files recursively within a directory.
+ * @param {string} dirPath - absolute path to the directory
+ * @returns {string[]} array of absolute paths to supported manifest files
+ */
+function discoverManifests(dirPath) {
+    const manifests = [];
+    function walk(dir) {
+        const entries = fs.readdirSync(dir, { withFileTypes: true });
+        for (const entry of entries) {
+            if (SKIP_DIRS.has(entry.name)) {
+                continue;
+            }
+            const fullPath = path.join(dir, entry.name);
+            if (entry.isDirectory()) {
+                walk(fullPath);
+            }
+            else if (getManifestType(entry.name)) {
+                manifests.push(fullPath);
+            }
+        }
+    }
+    walk(dirPath);
+    return manifests;
+}
+/**
+ * Returns the manifest type descriptor for a given filename, or null if unsupported.
+ * @param {string} basename - the file name to check
+ * @returns {{test: function, updater: function, label: string}|null}
+ */
+function getManifestType(basename) {
+    return MANIFEST_TYPES.find(t => t.test(basename)) || null;
+}
+/**
+ * Orchestrates the full remediation pipeline for a single manifest or directory:
+ * discover manifests → scan via DA backend → extract remediations → apply or preview.
+ *
+ * @param {string} targetPath - path to a manifest file or directory
+ * @param {object} [options]
+ * @param {boolean} [options.dryRun=false] - preview changes without modifying files (applies by default)
+ * @param {string} [options.providers] - comma-separated provider list
+ * @param {string} [options.sources] - comma-separated source list
+ * @param {'dependency'|'bundle'} [options.groupBy='dependency'] - report grouping strategy
+ * @returns {Promise<{exitCode: number, output: string}>}
+ */
+export async function runRemediation(targetPath, options = {}) {
+    const { dryRun = false, providers, sources, groupBy = 'dependency' } = options;
+    const resolvedPath = path.resolve(targetPath);
+    let manifestPaths;
+    let stat;
+    try {
+        stat = fs.statSync(resolvedPath);
+    }
+    catch {
+        throw new Error(`Path not found: ${resolvedPath}`);
+    }
+    if (stat.isDirectory()) {
+        manifestPaths = discoverManifests(resolvedPath);
+        if (manifestPaths.length === 0) {
+            return { exitCode: 0, output: 'No supported manifest files found.' };
+        }
+    }
+    else {
+        const basename = path.basename(resolvedPath);
+        if (!getManifestType(basename)) {
+            throw new Error(`Unsupported manifest type: ${basename}`);
+        }
+        manifestPaths = [resolvedPath];
+    }
+    const opts = {};
+    if (providers) {
+        opts.TRUSTIFY_DA_PROVIDERS = providers;
+    }
+    if (sources) {
+        opts.TRUSTIFY_DA_SOURCES = sources;
+    }
+    const url = selectTrustifyDABackend(opts);
+    const allRemediations = [];
+    const appliedFiles = [];
+    for (const manifestPath of manifestPaths) {
+        const basename = path.basename(manifestPath);
+        const manifestType = getManifestType(basename);
+        if (!manifestType) {
+            continue;
+        }
+        let provider;
+        try {
+            provider = match(manifestPath, availableProviders, opts);
+        }
+        catch {
+            continue;
+        }
+        const analysisReport = await analysis.requestStack(provider, manifestPath, url, false, opts);
+        const remediations = extractRemediations(analysisReport, {
+            providerPriority: providers ? providers.split(',').map(p => p.trim()).filter(Boolean) : undefined,
+        });
+        if (remediations.length === 0) {
+            continue;
+        }
+        allRemediations.push(...remediations);
+        if (!dryRun) {
+            const content = fs.readFileSync(manifestPath, 'utf-8');
+            const versionChanges = remediations.map(r => ({
+                groupId: r.groupId,
+                artifactId: r.artifactId,
+                newVersion: r.fixedInVersion,
+            }));
+            const result = manifestType.updater(content, versionChanges);
+            if (result.applied.length > 0) {
+                fs.writeFileSync(manifestPath, result.content, 'utf-8');
+                appliedFiles.push(manifestPath);
+            }
+        }
+    }
+    if (allRemediations.length === 0) {
+        return { exitCode: 0, output: 'No remediations found.' };
+    }
+    const report = generateReport(allRemediations, { groupBy });
+    if (dryRun) {
+        return { exitCode: 2, output: report };
+    }
+    const summary = appliedFiles.length > 0
+        ? `Updated ${appliedFiles.length} file(s):\n${appliedFiles.map(f => `  ${f}`).join('\n')}\n\n${report}`
+        : report;
+    return { exitCode: 0, output: summary };
+}

package/dist/src/remediation.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Extracts actionable remediation instructions from a DA AnalysisReport response.
+ *
+ * Walks the provider/source/dependency/issue tree, collects fixedIn and trustedContent
+ * remediation data, applies provider priority resolution, and uses the configured
+ * version selection strategy to resolve conflicts. Dependencies with no remediation
+ * data are skipped.
+ *
+ * @param {object} analysisReport - raw DA AnalysisReport JSON response
+ * @param {object} [options] - extraction options
+ * @param {string[]} [options.providerPriority] - provider names in descending priority order.
+ *   The first entry has the highest priority. Providers not listed share the lowest priority.
+ *   When omitted or empty, all providers are treated equally and the highest fix version wins.
+ * @param {object} [options.versionStrategy] - version selection strategy with selectVersion
+ *   and resolveConflict methods. Defaults to closestCoverageStrategy.
+ * @returns {Array<{purl: string, groupId: string, artifactId: string, currentVersion: string, fixedInVersion: string, fixedInPurl: string, provider: string, source: string, advisories: Array<{id: string, url: string}>, severity: string, cves: string[]}>}
+ */
+export function extractRemediations(analysisReport: object, options?: {
+    providerPriority?: string[] | undefined;
+    versionStrategy?: object | undefined;
+}): Array<{
+    purl: string;
+    groupId: string;
+    artifactId: string;
+    currentVersion: string;
+    fixedInVersion: string;
+    fixedInPurl: string;
+    provider: string;
+    source: string;
+    advisories: Array<{
+        id: string;
+        url: string;
+    }>;
+    severity: string;
+    cves: string[];
+}>;
+/**
+ * Version selection strategy that prefers the closest compatible version
+ * within the same major version stream. Falls back to the lowest cross-major
+ * version when no same-major option exists.
+ * @type {{selectVersion: function(string[], string): string, resolveConflict: function(object, object): string}}
+ */
+export const closestCoverageStrategy: {
+    selectVersion: (arg0: string[], arg1: string) => string;
+    resolveConflict: (arg0: object, arg1: object) => string;
+};
+/**
+ * Version selection strategy that always picks the highest version regardless
+ * of major version distance. Guarantees maximum CVE coverage but may produce
+ * large version jumps. This is the original behavior before pluggable strategies.
+ * @type {{selectVersion: function(string[], string): string, resolveConflict: function(object, object): string}}
+ */
+export const highestStrategy: {
+    selectVersion: (arg0: string[], arg1: string) => string;
+    resolveConflict: (arg0: object, arg1: object) => string;
+};
+export const SEVERITY_ORDER: string[];