@trustify-da/trustify-da-javascript-client 0.3.0-ea.e660b02 → 0.3.0-ea.efdc87d

package/dist/src/providers/base_javascript.d.ts

@@ -1,4 +1,17 @@
-export type purlType = import("../provider").Provider;
+/**
+ * Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
+ * SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
+ * expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
+ * digest. When the SRI string contains multiple space-separated hashes, only
+ * the first is used.
+ * @param {string} integrity - SRI string from a lock file
+ * @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
+ */
+export function sriToHash(integrity: string): {
+    alg: string;
+    content: string;
+} | null;
+export type purlType = any;
 /** @typedef {import('../provider').Provider} */
 /** @typedef {import('../provider').Provided} Provided */
 /**
@@ -19,7 +32,7 @@ export default class Base_javascript {
    * @param {Object} opts - Configuration options for the provider
    * @protected
    */
-    protected _setUp(manifestPath: string, opts: any): void;
+    protected _setUp(manifestPath: string, opts: Object): void;
     /**
      * Gets the current manifest object
      * @returns {Manifest} The manifest object
@@ -65,6 +78,47 @@ export default class Base_javascript {
    * @protected
    */
     protected _updateLockFileCmdArgs(): Array<string>;
+    /**
+     * Parses the provider's lock file into a hash map keyed by `name@version`.
+     * Subclasses override this (accepting the lock directory) to support their
+     * lock file format. The default implementation returns an empty map so
+     * providers without lock parsing (or without a lock file present) gracefully
+     * omit hashes.
+     * @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
+     * @protected
+     */
+    protected _parseLockFileHashes(): Map<string, Array<{
+        alg: string;
+        content: string;
+    }>>;
+    /**
+     * Loads lock-file hashes for the given directory into internal state.
+     * Parsing failures degrade gracefully to an empty map (no hashes emitted).
+     * @param {string} lockDir - Directory containing the lock file
+     * @protected
+     */
+    protected _loadHashes(lockDir: string): void;
+    /**
+     * Looks up CycloneDX hashes for a package by name and resolved version.
+     * @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
+     * @param {string} version - The resolved package version
+     * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
+     * @protected
+     */
+    protected _hashesFor(name: string, version: string): Array<{
+        alg: string;
+        content: string;
+    }> | undefined;
+    /**
+     * Looks up CycloneDX hashes for a package described by a PackageURL.
+     * @param {PackageURL} purl - The package URL
+     * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
+     * @protected
+     */
+    protected _hashesForPurl(purl: PackageURL): Array<{
+        alg: string;
+        content: string;
+    }> | undefined;
     /**
    * Checks if the provider supports the given manifest name
    * @param {string} manifestName - The manifest name to check
@@ -91,21 +145,21 @@ export default class Base_javascript {
    * @param {Object} [opts={}] - optional; may contain TRUSTIFY_DA_WORKSPACE_DIR
    * @returns {boolean} True if the lock file exists
    */
-    validateLockFile(manifestDir: string, opts?: any): boolean;
+    validateLockFile(manifestDir: string, opts?: Object): boolean;
     /**
    * Provides content and content type for stack analysis
    * @param {string} manifestPath - The manifest path or name
    * @param {Object} [opts={}] - Optional configuration options
    * @returns {Provided} The provided data for stack analysis
    */
-    provideStack(manifestPath: string, opts?: any): Provided;
+    provideStack(manifestPath: string, opts?: Object): Provided;
     /**
    * Provides content and content type for component analysis
    * @param {string} manifestPath - Path to package.json for component report
    * @param {Object} [opts={}] - Optional configuration options
    * @returns {Provided} The provided data for component analysis
    */
-    provideComponent(manifestPath: string, opts?: any): Provided;
+    provideComponent(manifestPath: string, opts?: Object): Provided;
     /**
      * Read license from manifest (package.json). Reused by npm, pnpm, yarn.
      * @param {string} manifestPath - path to package.json
@@ -119,21 +173,21 @@ export default class Base_javascript {
    * @returns {Object} The dependency tree
    * @protected
    */
-    protected _buildDependencyTree(includeTransitive: boolean, opts?: any): any;
+    protected _buildDependencyTree(includeTransitive: boolean, opts?: Object): Object;
     /**
    * Recursively builds the Sbom from the JSON that npm listing returns
    * @param {Sbom} sbom - The SBOM object to add dependencies to
    * @param {Object} depTree - The current dependency tree
    * @protected
    */
-    protected _addDependenciesToSbom(sbom: Sbom, depTree: any): void;
+    protected _addDependenciesToSbom(sbom: Sbom, depTree: Object): void;
     /**
    * Extracts root dependencies from the dependency tree
    * @param {Object} depTree - The dependency tree object
    * @returns {Map<string, PackageURL>} Map of dependency names to their PackageURL objects
    * @protected
    */
-    protected _getRootDependencies(depTree: any): Map<string, PackageURL>;
+    protected _getRootDependencies(depTree: Object): Map<string, PackageURL>;
     /**
    * Gets the version of the package manager
    * @returns {string} The version string of the package manager
@@ -155,6 +209,6 @@ export default class Base_javascript {
     protected _parseDepTreeOutput(output: string): string;
     #private;
 }
-export type Provided = import("../provider").Provided;
+export type Provided = any;
 import Manifest from './manifest.js';
 import Sbom from '../sbom.js';

package/dist/src/providers/base_javascript.js

@@ -12,6 +12,49 @@ import Manifest from './manifest.js';
  * @type {string}
  */
 export const purlType = 'npm';
+/**
+ * Maps a Subresource Integrity (SRI) algorithm token to its CycloneDX label.
+ * @type {Object<string, string>}
+ */
+const SRI_ALG_LABELS = {
+    sha1: 'SHA-1',
+    sha256: 'SHA-256',
+    sha384: 'SHA-384',
+    sha512: 'SHA-512',
+};
+/**
+ * Converts a Subresource Integrity (SRI) string to a CycloneDX hash object.
+ * SRI is formatted as `<alg>-<base64>` (e.g. `sha512-Ab3d...`). CycloneDX
+ * expects an uppercased algorithm label (e.g. `SHA-512`) and a hex-encoded
+ * digest. When the SRI string contains multiple space-separated hashes, only
+ * the first is used.
+ * @param {string} integrity - SRI string from a lock file
+ * @returns {{alg: string, content: string}|null} CycloneDX hash, or null when unparseable
+ */
+export function sriToHash(integrity) {
+    if (typeof integrity !== 'string') {
+        return null;
+    }
+    const first = integrity.trim().split(/\s+/)[0];
+    if (!first) {
+        return null;
+    }
+    const dash = first.indexOf('-');
+    if (dash < 0) {
+        return null;
+    }
+    const alg = SRI_ALG_LABELS[first.slice(0, dash).toLowerCase()];
+    // Strip any SRI options (e.g. "?foo") that may follow the base64 payload
+    const base64 = first.slice(dash + 1).split('?')[0];
+    if (!alg || !base64) {
+        return null;
+    }
+    const content = Buffer.from(base64, 'base64').toString('hex');
+    if (!content) {
+        return null;
+    }
+    return { alg, content };
+}
 /**
  * Base class for JavaScript package manager providers.
  * This class provides common functionality for different JavaScript package managers
@@ -25,6 +68,11 @@ export default class Base_javascript {
     #cmd;
     /** @type {string} */
     #ecosystem;
+    /**
+     * Lock-file hashes keyed by `name@version`.
+     * @type {Map<string, Array<{alg: string, content: string}>>}
+     */
+    #hashes = new Map();
     /**
    * Sets up the provider with the manifest path and options
    * @param {string} manifestPath - Path to the package.json manifest file
@@ -95,6 +143,58 @@ export default class Base_javascript {
     _updateLockFileCmdArgs() {
         throw new TypeError("_updateLockFileCmdArgs must be implemented");
     }
+    /**
+     * Parses the provider's lock file into a hash map keyed by `name@version`.
+     * Subclasses override this (accepting the lock directory) to support their
+     * lock file format. The default implementation returns an empty map so
+     * providers without lock parsing (or without a lock file present) gracefully
+     * omit hashes.
+     * @returns {Map<string, Array<{alg: string, content: string}>>} Hash map
+     * @protected
+     */
+    _parseLockFileHashes() {
+        return new Map();
+    }
+    /**
+     * Loads lock-file hashes for the given directory into internal state.
+     * Parsing failures degrade gracefully to an empty map (no hashes emitted).
+     * @param {string} lockDir - Directory containing the lock file
+     * @protected
+     */
+    _loadHashes(lockDir) {
+        try {
+            this.#hashes = this._parseLockFileHashes(lockDir) || new Map();
+        }
+        catch (_) {
+            this.#hashes = new Map();
+        }
+    }
+    /**
+     * Looks up CycloneDX hashes for a package by name and resolved version.
+     * @param {string} name - The package name (including scope, e.g. `@hapi/joi`)
+     * @param {string} version - The resolved package version
+     * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
+     * @protected
+     */
+    _hashesFor(name, version) {
+        if (!name || !version) {
+            return undefined;
+        }
+        return this.#hashes.get(`${name}@${version}`);
+    }
+    /**
+     * Looks up CycloneDX hashes for a package described by a PackageURL.
+     * @param {PackageURL} purl - The package URL
+     * @returns {Array<{alg: string, content: string}>|undefined} Hashes, or undefined
+     * @protected
+     */
+    _hashesForPurl(purl) {
+        if (!purl) {
+            return undefined;
+        }
+        const name = purl.namespace ? `${purl.namespace}/${purl.name}` : purl.name;
+        return this._hashesFor(name, purl.version);
+    }
     /**
    * Checks if the provider supports the given manifest name
    * @param {string} manifestName - The manifest name to check
@@ -225,6 +325,7 @@ export default class Base_javascript {
         const manifestDir = path.dirname(this.#manifest.manifestPath);
         const cmdDir = this._findLockFileDir(manifestDir, opts) || manifestDir;
         this._createLockFile(cmdDir);
+        this._loadHashes(cmdDir);
         let output = this.#executeListCmd(includeTransitive, cmdDir);
         output = this._parseDepTreeOutput(output);
         return JSON.parse(output);
@@ -284,7 +385,7 @@ export default class Base_javascript {
             const [name, artifact] = entry;
             const target = toPurl(purlType, name, artifact.version);
             const rootPurl = toPurl(purlType, this.#manifest.name, this.#manifest.version);
-            sbom.addDependency(rootPurl, target);
+            sbom.addDependency(rootPurl, target, undefined, this._hashesFor(name, artifact.version));
             this.#addDependenciesOf(sbom, target, artifact);
         });
     }
@@ -302,7 +403,7 @@ export default class Base_javascript {
             const [name, depArtifact] = entry;
             if (depArtifact.version !== undefined) {
                 const target = toPurl(purlType, name, depArtifact.version);
-                sbom.addDependency(from, target);
+                sbom.addDependency(from, target, undefined, this._hashesFor(name, depArtifact.version));
                 this.#addDependenciesOf(sbom, target, depArtifact);
             }
         });
@@ -326,7 +427,8 @@ export default class Base_javascript {
             .sort();
         for (const key of sortedDepsKeys) {
             const rootPurl = toPurlFromString(sbom.getRoot().purl);
-            sbom.addDependency(rootPurl, rootDeps.get(key));
+            const targetPurl = rootDeps.get(key);
+            sbom.addDependency(rootPurl, targetPurl, undefined, this._hashesForPurl(targetPurl));
         }
         this.#ensurePeerAndOptionalDeps(sbom);
         sbom.filterIgnoredDeps(this.#manifest.ignored);
@@ -430,7 +532,7 @@ export default class Base_javascript {
                 }
             }
             // Try to find the command in the following order:
-            // 1. Custom path from environment/opts (via getCustomPath)
+            // 1. Custom path from opts/environment (via getCustomPath)
             // 2. Local node_modules/.bin
             // 3. Global installation
             let cmd = this.#cmd;

package/dist/src/providers/base_pyproject.d.ts

@@ -13,7 +13,7 @@ export default class Base_pyproject {
      * @param {Object} [opts={}]
      * @returns {boolean}
      */
-    validateLockFile(manifestDir: string, opts?: any): boolean;
+    validateLockFile(manifestDir: string, opts?: Object): boolean;
     /**
      * Walk up from manifestDir to find the directory containing the lock file.
      * Follows the same pattern as Base_javascript._findLockFileDir().
@@ -22,7 +22,7 @@ export default class Base_pyproject {
      * @returns {string|null}
      * @protected
      */
-    protected _findLockFileDir(manifestDir: string, opts?: any): string | null;
+    protected _findLockFileDir(manifestDir: string, opts?: Object): string | null;
     /**
      * Detect workspace root boundaries.
      * Currently only uv has native workspace support ([tool.uv.workspace] in pyproject.toml).
@@ -44,13 +44,13 @@ export default class Base_pyproject {
      * @param {Object} [opts={}]
      * @returns {Promise<Provided>}
      */
-    provideStack(manifest: string, opts?: any): Promise<Provided>;
+    provideStack(manifest: string, opts?: Object): Promise<Provided>;
     /**
      * @param {string} manifest - path to pyproject.toml
      * @param {Object} [opts={}]
      * @returns {Promise<Provided>}
      */
-    provideComponent(manifest: string, opts?: any): Promise<Provided>;
+    provideComponent(manifest: string, opts?: Object): Promise<Provided>;
     /**
      * @returns {string}
      * @protected
@@ -77,7 +77,7 @@ export default class Base_pyproject {
      * @returns {Promise<DependencyData>}
      * @protected
      */
-    protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: any): Promise<DependencyData>;
+    protected _getDependencyData(manifestDir: string, workspaceDir: string, parsed: object, opts: Object): Promise<DependencyData>;
     /**
      * Canonicalize a Python package name per PEP 503.
      * @param {string} name

package/dist/src/providers/containerfile_parser.d.ts

@@ -0,0 +1,5 @@
+export function getParser(): Promise<Parser>;
+export function getFromQuery(): Promise<Query>;
+export function getArgQuery(): Promise<Query>;
+import { Parser } from 'web-tree-sitter';
+import { Query } from 'web-tree-sitter';

package/dist/src/providers/containerfile_parser.js

@@ -0,0 +1,20 @@
+import { readFile } from 'node:fs/promises';
+import { Language, Parser, Query } from 'web-tree-sitter';
+const wasmUrl = new URL('./tree-sitter-containerfile.wasm', import.meta.url);
+async function init() {
+    await Parser.init();
+    const wasmBytes = new Uint8Array(await readFile(wasmUrl));
+    return await Language.load(wasmBytes);
+}
+export async function getParser() {
+    const language = await init();
+    return new Parser().setLanguage(language);
+}
+export async function getFromQuery() {
+    const language = await init();
+    return new Query(language, '(from_instruction (image_spec) @image)');
+}
+export async function getArgQuery() {
+    const language = await init();
+    return new Query(language, '(arg_instruction (arg_pair name: (_) @name default: (_) @default))');
+}

package/dist/src/providers/golang_gomodules.d.ts

@@ -16,7 +16,7 @@ declare namespace _default {
     export function packageManagerName(): string;
 }
 export default _default;
-export type Provided = import("../provider").Provided;
+export type Provided = any;
 export type Package = {
     name: string;
     version: string;

package/dist/src/providers/golang_gomodules.js

@@ -78,9 +78,10 @@ function getChildVertexFromEdge(edge) {
     return edge.split(" ")[1];
 }
 /**
- * Check whether a require_spec has a valid exhortignore marker.
- * For direct dependencies: `//exhortignore` or `// exhortignore`
- * For indirect dependencies: `// indirect; exhortignore` (semicolon-separated)
+ * Check whether a require_spec has a valid ignore marker.
+ * Supports both the legacy `exhortignore` marker and the new `trustify-da-ignore` marker.
+ * For direct dependencies: `//exhortignore` or `// trustify-da-ignore`
+ * For indirect dependencies: `// indirect; exhortignore` or `// indirect; trustify-da-ignore` (semicolon-separated)
  * @param {import('web-tree-sitter').SyntaxNode} specNode
  * @return {boolean}
  */
@@ -92,10 +93,10 @@ function hasExhortIgnore(specNode) {
     let comments = specNode.children.filter(c => c.type === 'comment');
     for (let comment of comments) {
         let text = comment.text;
-        if (/^\/\/\s*indirect;\s*exhortignore/.test(text)) {
+        if (/^\/\/\s*indirect;\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
             return true;
         }
-        if (/^\/\/\s*exhortignore/.test(text)) {
+        if (/^\/\/\s*(exhortignore|trustify-da-ignore)(?![\w-])/.test(text)) {
             return true;
         }
     }
@@ -187,6 +188,36 @@ function performManifestVersionsCheck(rootElementName, goModGraphOutputRows, man
         throw error;
     }
 }
+/** Parses go.sum to build a hash map of module@version to CycloneDX hashes. */
+function parseGoSumHashes(manifestDir) {
+    let goSumPath = path.join(manifestDir, 'go.sum');
+    if (!fs.existsSync(goSumPath)) {
+        return new Map();
+    }
+    let hashMap = new Map();
+    let content = fs.readFileSync(goSumPath, 'utf-8');
+    for (let line of content.split('\n')) {
+        line = line.trim();
+        if (!line) {
+            continue;
+        }
+        let parts = line.split(/\s+/);
+        if (parts.length < 3) {
+            continue;
+        }
+        let [mod, version, hash] = parts;
+        if (version.endsWith('/go.mod')) {
+            continue;
+        }
+        if (!hash.startsWith('h1:')) {
+            continue;
+        }
+        let base64Part = hash.slice(3);
+        let hexDigest = Buffer.from(base64Part, 'base64').toString('hex');
+        hashMap.set(`${mod}@${version}`, [{ alg: "SHA-256", content: hexDigest }]);
+    }
+    return hashMap;
+}
 /**
  * Create SBOM json string for go Module.
  * @param {string} manifest - path for go.mod
@@ -241,6 +272,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
     if (matchManifestVersions === "true") {
         performManifestVersionsCheck(root, rows, manifestContent, parser, requireQuery);
     }
+    let goSumHashes = parseGoSumHashes(manifestDir);
     const mainModule = toPurl(root, "@");
     const license = readLicenseFromManifest(manifest);
     sbom.addRoot(mainModule, license);
@@ -262,7 +294,7 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
             if (getParentVertexFromEdge(row) === root && !directDepPaths.has(getPackageName(child))) {
                 return;
             }
-            sbom.addDependency(source, target);
+            sbom.addDependency(source, target, undefined, goSumHashes.get(child));
         });
         // at the end, filter out all ignored dependencies including versions.
         sbom.filterIgnoredDepsIncludingVersion(allIgnoredDeps);
@@ -275,12 +307,22 @@ async function getSBOM(manifest, opts = {}, includeTransitive) {
             let target = toPurl(child, "@");
             if (dependencyNotIgnored(ignoredDeps, target)) {
                 if (directDepPaths.has(getPackageName(child))) {
-                    sbom.addDependency(mainModule, target);
+                    sbom.addDependency(mainModule, target, undefined, goSumHashes.get(child));
                 }
             }
         });
         enforceRemovingIgnoredDepsInCaseOfAutomaticVersionUpdate(ignoredDeps, sbom);
     }
+    // Backfill hashes for components that were only seen as dependency sources
+    for (const comp of sbom.sbomModel.components) {
+        if (!comp.hashes && comp.purl) {
+            let key = decodeURIComponent(comp.purl.replace('pkg:golang/', ''));
+            let hashes = goSumHashes.get(key);
+            if (hashes) {
+                comp.hashes = hashes;
+            }
+        }
+    }
     return sbom.getAsJsonString(opts);
 }
 /**

package/dist/src/providers/java_gradle.d.ts

@@ -17,6 +17,30 @@ export function parseGradleInitScriptOutput(raw: string): {
     path: string;
     dir: string;
 }[];
+/**
+ * Parse the structured output from the Gradle hash init script.
+ * Each recognised line has the form `::DA_HASH::group:name:version::<file-path>`.
+ *
+ * @param {string} raw - Raw stdout from gradle
+ * @returns {{ id: string, file: string }[]} component id (`group:name:version`) and absolute artifact file path
+ */
+export function parseGradleHashScriptOutput(raw: string): {
+    id: string;
+    file: string;
+}[];
+/**
+ * Parse a Gradle module component id (`group:name:version`) into its coordinate
+ * parts. The caller builds the canonical PURL key from these parts using the same
+ * builder {@link parseDep} uses, so the stored key and the lookup key cannot drift.
+ *
+ * @param {string} id - the Gradle component id
+ * @returns {{group: string, name: string, version: string}|null} the parsed coordinate, or null when the id is malformed
+ */
+export function parseComponentId(id: string): {
+    group: string;
+    name: string;
+    version: string;
+} | null;
 /**
  * This class provides common functionality for Groovy and Kotlin DSL files.
  */
@@ -54,6 +78,30 @@ export default class Java_gradle extends Base_java {
      * @returns {Provided}
      */
     provideComponent(manifest: string, opts?: {}): Provided;
+    /**
+     * Compute SHA-256 hashes for the resolved artifacts of a Gradle manifest.
+     *
+     * Rather than scanning the local Gradle cache, this asks Gradle itself for
+     * the resolved artifact files via an init script (mirroring the pattern used
+     * by {@link discoverGradleSubprojects}), then hashes each file with the
+     * Node.js `crypto` module. The result is keyed by the canonical PURL string
+     * built via {@link Base_java#toPurl} — the same builder {@link parseDep} uses
+     * for the lookup — so the stored key and the lookup key cannot drift.
+     *
+     * Degrades gracefully: if Gradle cannot be invoked, the init script fails, or
+     * an artifact has no readable file (e.g. BOM/`platform()` dependencies), the
+     * hash for that component is omitted rather than throwing. A warning is emitted
+     * on every degradation path so incomplete hash coverage is visible even without
+     * `TRUSTIFY_DA_DEBUG` (mirroring the pip/cargo providers).
+     *
+     * @param {string} manifest - path to build.gradle[.kts]
+     * @param {{}} [opts={}] - optional various options to pass along the application
+     * @returns {Promise<Map<string, Array<{alg: string, content: string}>>>} map of canonical PURL string to CycloneDX hashes
+     */
+    parseGradleHashes(manifest: string, opts?: {}): Promise<Map<string, Array<{
+        alg: string;
+        content: string;
+    }>>>;
     #private;
 }
 export type Provided = import("../provider.js").Provided;