@cdxgen/cdxgen 13.0.0 → 13.1.0

package/lib/cli/index.js

@@ -18,6 +18,7 @@ import {
   recordActivity,
   setActivityContext,
 } from "../core/activity.js";
+import { recordDegradation } from "../core/buildLedger.js";
 import { hasAnyProjectType, PROJECT_TYPE_ALIASES } from "../core/env.js";
 import {
   clearFileDiscoveryCache,
@@ -40,7 +41,7 @@ import {
 } from "../ecosystems/parsers-misc.js";
 import { isPyLockFile } from "../ecosystems/pylockutils.js";
 import {
-  buildDependencyTrackBomPayload,
+  buildDependencyTrackBomRequest,
   getDependencyTrackBomApiUrl,
 } from "../helpers/remote/dependency-track.js";
 import { optionIncludesAiInventoryProjectType } from "../inventory/aiInventory.js";
@@ -173,6 +174,11 @@ export {
   createZigBom,
 } from "./nativeBom.js";
 
+import {
+  deferFailOnError,
+  isDeferredFailOnError,
+} from "../core/deferredExit.js";
+
 const dirName = dirNameStr;
 
 const isWin = _platform() === "win32";
@@ -816,6 +822,23 @@ export async function createMultiXBom(pathList, options) {
   // from here on, so repeated walks of them can share one view of the tree.
   setDirWalkCacheRoot(options.allLayersExplodedDir);
   const scanOnePath = async (path) => {
+    try {
+      return await scanOnePathInner(path);
+    } catch (err) {
+      if (!isDeferredFailOnError(err)) {
+        throw err;
+      }
+      // The failing path contributes nothing, and the remaining paths still
+      // do: fail-on-error scopes the loss to the leg that failed.
+      return {
+        components: [],
+        dependencies: [],
+        options: { ...sharedOptions },
+        parentSubComponents: [],
+      };
+    }
+  };
+  const scanOnePathInner = async (path) => {
     // Each path accumulates into its own lists and its own view of options, so
     // that legs which record a parent component or a tool cannot overwrite
     // another path's. The lists are merged below in pathList order.
@@ -1433,6 +1456,14 @@ export async function createMultiXBom(pathList, options) {
         );
       }
       setProjectTypeActivityContext("jar", path);
+      recordDegradation("jvm.jar.heuristic", {
+        ecosystem: "java",
+        tool: "jar",
+        impact: "versions",
+        path,
+        detail:
+          "Components are being inferred by scanning jar/war/ear files from disk.",
+      });
       bomData = await createJarBom(path, options);
       if (bomData?.bomJson?.components?.length) {
         thoughtLog(
@@ -2292,7 +2323,28 @@ export async function createHBom(_path, options) {
  * @param {Object} options Parse options from the cli
  * @returns {Promise<Object>} Promise resolving to BOM object
  */
+/**
+ * Generate a BOM for one path, letting a deferred fail-on-error abort return
+ * the empty BOM the flag promises rather than unwinding past the reports.
+ *
+ * @param {string} path Source path.
+ * @param {Object} options CLI options.
+ * @returns {Promise<Object>} BOM NS data.
+ */
 export async function createBom(path, options) {
+  try {
+    return await createBomForPath(path, options);
+  } catch (err) {
+    if (!isDeferredFailOnError(err)) {
+      throw err;
+    }
+    // fail-on-error forbids an incomplete result, so the extractor kept
+    // nothing; the CLI still writes the reports and exits non-zero.
+    return buildBomNSData(options, [], "", { src: path, filename: "" });
+  }
+}
+
+async function createBomForPath(path, options) {
   clearFileDiscoveryCache();
   let { projectType } = options;
   if (!projectType) {
@@ -2327,7 +2379,11 @@ export async function createBom(path, options) {
       console.log(
         `OS BOM generation has failed due to problems with exporting the image ${path}`,
       );
-      options.failOnError && process.exit(1);
+      deferFailOnError(options, {
+        ecosystem: "container",
+        tool: "docker",
+        detail: "exporting the image for the OS BOM failed",
+      });
       return {};
     }
     isContainerMode = true;
@@ -2367,7 +2423,11 @@ export async function createBom(path, options) {
         console.log(
           `OCI BOM generation has failed due to problems with exporting the image ${path}.`,
         );
-        options.failOnError && process.exit(1);
+        deferFailOnError(options, {
+          ecosystem: "container",
+          tool: "docker",
+          detail: "exporting the image for the OCI BOM failed",
+        });
         return {};
       }
       if (DEBUG_MODE) {
@@ -2660,8 +2720,8 @@ export async function submitBom(args, bomContents) {
     });
     return undefined;
   }
-  const bomPayload = buildDependencyTrackBomPayload(args, bomContents);
-  if (!bomPayload) {
+  const bomRequest = buildDependencyTrackBomRequest(args, bomContents);
+  if (!bomRequest) {
     console.log(
       "Invalid Dependency-Track submission arguments. Provide projectId or projectName (projectVersion defaults to main) and specify parent project either by UUID or by parent project name + version.",
     );
@@ -2674,21 +2734,21 @@ export async function submitBom(args, bomContents) {
       serverUrl,
       "params",
       args.projectName,
-      bomPayload.projectVersion,
+      args.projectVersion || "main",
     );
   }
   try {
     const requestOptions = {
-      method: "PUT",
+      method: "POST",
       followRedirect: false,
       https: {
         rejectUnauthorized: !args.skipDtTlsCheck,
       },
       headers: {
         "X-Api-Key": (args.apiKey || "").replace(/[\r\n]/g, ""),
-        "Content-Type": "application/json",
+        "Content-Type": bomRequest.contentType,
       },
-      json: bomPayload,
+      body: bomRequest.body,
       responseType: "json",
       context: {
         activityIntent: "bom-submit",
@@ -2711,47 +2771,15 @@ export async function submitBom(args, bomContents) {
       );
     } else if (error.response && error.response.statusCode === 405) {
       console.log(
-        "Method PUT not allowed on Dependency-Track server. Trying with POST ...",
+        `The server at ${serverUrl} does not accept a multipart/form-data POST on /api/v1/bom. Check that the URL points to a Dependency-Track 4.x or later API server.`,
+      );
+    } else if (DEBUG_MODE) {
+      console.log(
+        "Unable to submit the SBOM to the Dependency-Track server",
+        error,
       );
-      // Method not allowed errors
-      try {
-        return await cdxgenAgent(dependencyTrackApiUrl, {
-          method: "POST",
-          followRedirect: false,
-          https: {
-            rejectUnauthorized: !args.skipDtTlsCheck,
-          },
-          headers: {
-            "X-Api-Key": (args.apiKey || "").replace(/[\r\n]/g, ""),
-            "Content-Type": "application/json",
-          },
-          json: bomPayload,
-          responseType: "json",
-          context: {
-            activityIntent: "bom-submit",
-          },
-        }).json();
-      } catch (error) {
-        if (DEBUG_MODE) {
-          console.log(
-            "Unable to submit the SBOM to the Dependency-Track server using POST method",
-            error,
-          );
-        } else {
-          console.log(
-            "Unable to submit the SBOM to the Dependency-Track server using POST method",
-          );
-        }
-      }
     } else {
-      if (DEBUG_MODE) {
-        console.log(
-          "Unable to submit the SBOM to the Dependency-Track server using POST method",
-          error,
-        );
-      } else {
-        console.log("Unable to submit the SBOM to the Dependency-Track server");
-      }
+      console.log("Unable to submit the SBOM to the Dependency-Track server");
     }
     // rethrow error as function is async and we should try to catch it in the caller
     throw error;

package/lib/cli/jsBom.js

@@ -11,6 +11,8 @@ import {
   readEnvironmentVariable,
   recordSensitiveFileRead,
 } from "../core/activity.js";
+import { recordDegradation } from "../core/buildLedger.js";
+import { deferFailOnError } from "../core/deferredExit.js";
 import { hasAnyProjectType, isPackageManagerAllowed } from "../core/env.js";
 import { getAllFiles, safeExistsSync, safeSpawnSync } from "../core/fs.js";
 import { thoughtLog } from "../core/logger.js";
@@ -529,6 +531,14 @@ export async function createNodejsBom(path, options) {
         isSecureMode &&
         !installArgs.join(" ").includes("--allow-git")
       ) {
+        recordDegradation("js.git-dependency", {
+          ecosystem: "npm",
+          tool: pkgMgr,
+          impact: "integrity",
+          command: `${pkgMgr} ${installArgs.join(" ")}`,
+          detail:
+            "Secure mode npm install may still fetch and install git dependencies.",
+        });
         console.log(
           "Consider passing '--allow-git=none' via the environment variable NPM_INSTALL_ARGS to prevent any git dependencies from being fetched and installed via npm.",
         );
@@ -580,6 +590,13 @@ export async function createNodejsBom(path, options) {
           `**PACKAGE MANAGER**: Let's run the '${pkgMgr}' command with the arguments '${installArgs.join(" ")}' to generate the needed lock files.`,
         );
       }
+      recordDegradation("js.no-lockfile", {
+        ecosystem: "npm",
+        tool: pkgMgr,
+        impact: "versions",
+        detail:
+          "No lockfile was found for this project, so the SBOM is generated without pinned dependency versions.",
+      });
       console.warn(
         "\x1b[1;35mNotice: Generating an SBOM without a lockfile is risky and non-deterministic. Consider generating and committing the lockfile to your repository to ensure reproducible builds and SBOMs.\x1b[0m",
       );
@@ -640,7 +657,11 @@ export async function createNodejsBom(path, options) {
           console.log("---------------");
           console.log(result.stderr);
         }
-        options.failOnError && process.exit(1);
+        deferFailOnError(options, {
+          ecosystem: "npm",
+          tool: "npm",
+          detail: "the npm command failed",
+        });
       } else {
         anyInstallSuccess = true;
       }
@@ -936,7 +957,11 @@ export async function createNodejsBom(path, options) {
       );
       if (result.status === 1 || result.error) {
         console.error(result.stdout, result.stderr);
-        options.failOnError && process.exit(1);
+        deferFailOnError(options, {
+          ecosystem: "npm",
+          tool: "npm",
+          detail: "the yarn or pnpm command failed",
+        });
       }
     }
     // Look for shrinkwrap file
@@ -1013,7 +1038,11 @@ export async function createNodejsBom(path, options) {
       pnpmLock,
       "was found!",
     );
-    options.failOnError && process.exit(1);
+    deferFailOnError(options, {
+      ecosystem: "npm",
+      tool: "npm",
+      detail: "no JavaScript dependency evidence could be collected",
+    });
   }
   if (
     yarnLockFiles?.length &&