Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

2.7 KB
Raw Blame
import { checkmarxEvidence } from "./checkmarx-evidence.js";
import type { ExternalImportTarget } from "./external-import-contract.js";
import {
  array,
  normalizeRecords,
  record,
  requiredText,
  stableId,
} from "./scanner-import.js";

export function checkmarxOneId(value: unknown): string {
  const row = record(value, "Checkmarx One result");
  const type = requiredText(row["type"], "Checkmarx One result type");
  if (type !== "sast")
    throw new Error(
      `Checkmarx One result type ${type} is outside the SAST import.`,
    );
  const data = record(row["data"], "Checkmarx One SAST data");
  return stableId("checkmarx-one", [
    requiredText(row["similarityId"], "Checkmarx One similarityId"),
    requiredText(data["resultHash"], "Checkmarx One resultHash"),
  ]);
}

export function normalizeCheckmarxOne(
  contents: string,
  repository: string,
  target: ExternalImportTarget,
) {
  // SAST query IDs can be 64-bit integers. Keep their exact digits in evidence.
  function preserveQueryId(
    key: string,
    value: unknown,
    context?: { source: string },
  ) {
    if (
      key === "queryId" &&
      Number.isInteger(value) &&
      !Number.isSafeInteger(value)
    )
      return context!.source;
    return value;
  }
  const document = record(
    JSON.parse(contents, preserveQueryId),
    "Checkmarx One CLI JSON report",
  );
  const scanId = requiredText(document["scanID"], "Checkmarx One scanID");
  const rows =
    document["results"] === null && document["totalCount"] === 0
      ? []
      : array(document["results"], "Checkmarx One results");
  if (document["totalCount"] !== rows.length)
    throw new Error(
      "Checkmarx One totalCount must equal the number of exported results.",
    );
  const report = {
    format: "checkmarx-one-json",
    scanId,
    sourceRepositoryUrl: repository,
    totalCount: rows.length,
  } as const;
  return normalizeRecords(
    rows,
    (value) => {
      const row = record(value, "Checkmarx One result");
      const data = record(row["data"], "Checkmarx One SAST data");
      for (const node of array(data["nodes"] ?? [], "Checkmarx One SAST nodes"))
        record(node, "Checkmarx One SAST node");
      return checkmarxEvidence(
        report,
        {
          title: requiredText(data["queryName"], "Checkmarx One queryName"),
          ruleId: data["queryId"],
          severity: row["severity"],
          description: row["description"],
          status: row["status"],
          verdict: row["state"],
          cwe: record(
            row["vulnerabilityDetails"] ?? {},
            "Checkmarx One vulnerability details",
          )["cweId"],
          sourceData: { row },
        },
        target,
      );
    },
    checkmarxOneId,
    target,
    { report },
  );
}