OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security
TypeScript ai-securityapplication-securityclicode-scanningcodexcodex-securitycybersecuritydevsecopsnodejsnpmopenaisdksecuritytypescriptvulnerability-scanning
refactor(imports): separate report readers from source providers (#1871)
Michael D'Angelob3448fc0ad5f
diff --git a/sdk/typescript/src/cli.ts b/sdk/typescript/src/cli.tsindex f3bf4a3b2..5d2dbae92 100644--- a/sdk/typescript/src/cli.ts+++ b/sdk/typescript/src/cli.ts@@ -114,6 +114,7 @@ import {} from "./external-findings-publish.js";import { prepareLocalExternalImport } from "./external-findings-import.js";import { listLocalExternalFindings } from "./external-findings-local.js";+import { EXTERNAL_FINDINGS_READERS } from "./external-findings-read.js";import type { ExternalFindings } from "./external-findings.js";import {publishPatchReview,@@ -3618,7 +3619,7 @@ export async function main("Local repository path for --to local; authorized repository ID or URL for --to cloud.",),provider: z- .enum(["wiz", "snyk", "semgrep", "endor", "github"])+ .enum(EXTERNAL_FINDINGS_READERS).describe("Provider that produced these findings."),sourceRepositoryUrl: optionValue("--source-repository-url").optional()diff --git a/sdk/typescript/src/external-findings-import.ts b/sdk/typescript/src/external-findings-import.tsindex b06ad5f1c..c350472a3 100644--- a/sdk/typescript/src/external-findings-import.ts+++ b/sdk/typescript/src/external-findings-import.ts@@ -3,7 +3,10 @@ import {cloudRepositoryUrlKey,repositoryUrlKey,} from "./external-import-contract.js";-import { readExternalFindings } from "./external-findings-read.js";+import {+ EXTERNAL_FINDINGS_PROVIDERS,+ readExternalFindings,+} from "./external-findings-read.js";import {prepareNormalizedLocalImport,type LocalExternalImportDependencies,@@ -21,8 +24,12 @@ export async function prepareLocalExternalImport(() => readExternalFindings(path, options, "local"),dependencies.signal,);+ const normalizedOptions = {+ ...options,+ provider: EXTERNAL_FINDINGS_PROVIDERS[options.provider],+ };let sourceRepositories = parsed.sourceRepositories ?? [];- if (options.provider === "semgrep") {+ if (normalizedOptions.provider === "semgrep") {// The Cloud reader allows custom GitHub casing. Local provenance must also// agree with the caller's source URL when the checkout has no remote.const source = options.sourceRepositoryUrl!;@@ -47,7 +54,7 @@ export async function prepareLocalExternalImport(})),];}- return prepareNormalizedLocalImport(parsed.findings, options, {+ return prepareNormalizedLocalImport(parsed.findings, normalizedOptions, {...dependencies,sourceRepositories: [...(dependencies.sourceRepositories ?? []),diff --git a/sdk/typescript/src/external-findings-publish.ts b/sdk/typescript/src/external-findings-publish.tsindex c617b8234..5f5b83daf 100644--- a/sdk/typescript/src/external-findings-publish.ts+++ b/sdk/typescript/src/external-findings-publish.ts@@ -25,6 +25,7 @@ import {validatePreparedOutputDir,} from "./runtime.js";import {+ EXTERNAL_FINDINGS_PROVIDERS,readExternalFindings,type ExternalFindingsReaderOptions,} from "./external-findings-read.js";@@ -61,7 +62,10 @@ export interface NormalizedExternalPublicationOptions {}/** File readers accept the vendor formats installed in this SDK. */-export interface ExternalPublicationOptions extends NormalizedExternalPublicationOptions {+export interface ExternalPublicationOptions extends Omit<+ NormalizedExternalPublicationOptions,+ "provider"+> {provider: ExternalFindingsReaderOptions["provider"];sourceRepositoryUrl?: string;}@@ -347,11 +351,19 @@ export async function prepareExternalPublication(dependencies: ExternalPublicationDependencies = {},): Promise<PreparedExternalPublication> {const parsed = await readExternalFindings(path, options);+ const normalizedOptions = {+ ...options,+ provider: EXTERNAL_FINDINGS_PROVIDERS[options.provider],+ };return parsed.publication- ? preparePublicationInput(parsed.publication, options, dependencies)+ ? preparePublicationInput(+ parsed.publication,+ normalizedOptions,+ dependencies,+ ): prepareNormalizedExternalPublication(parsed.findings,- options,+ normalizedOptions,dependencies,);}diff --git a/sdk/typescript/src/external-findings-read.ts b/sdk/typescript/src/external-findings-read.tsindex a50e6292e..1115783d5 100644--- a/sdk/typescript/src/external-findings-read.ts+++ b/sdk/typescript/src/external-findings-read.ts@@ -3,6 +3,7 @@ import type {ExternalPublicationInput,ExternalSourceRepository,} from "./external-findings.js";+import type { Provider } from "./external-import-models.js";import type { ExternalImportTarget } from "./external-import-contract.js";import { wizCsvRepositoryUrl } from "./wiz-csv.js";import { readSnykFindings, snykRepositoryUrls } from "./snyk-findings.js";@@ -13,9 +14,24 @@ import { isGitHubCloudHost } from "./git-remote.js";import { isRecord } from "./record.js";import { readVendorFindingsForPublication } from "./wiz-findings.js";+/** File reader names mapped to their stored and Cloud source provider. */+export const EXTERNAL_FINDINGS_PROVIDERS = {+ wiz: "wiz",+ snyk: "snyk",+ semgrep: "semgrep",+ endor: "endor",+ github: "github",+} as const satisfies Record<string, Provider>;++export type ExternalFindingsReader = keyof typeof EXTERNAL_FINDINGS_PROVIDERS;++export const EXTERNAL_FINDINGS_READERS = Object.keys(+ EXTERNAL_FINDINGS_PROVIDERS,+) as ExternalFindingsReader[];+/** File readers available in this SDK, shared by local and Cloud imports. */export interface ExternalFindingsReaderOptions {- provider: "wiz" | "snyk" | "semgrep" | "endor" | "github";+ provider: ExternalFindingsReader;sourceRepositoryUrl?: string;}diff --git a/sdk/typescript/tests-ts/external-findings-import.test.ts b/sdk/typescript/tests-ts/external-findings-import.test.tsindex a378a3832..e9a192acd 100644--- a/sdk/typescript/tests-ts/external-findings-import.test.ts+++ b/sdk/typescript/tests-ts/external-findings-import.test.ts@@ -96,6 +96,10 @@ test("Wiz JSON imports retain parsed evidence through SQLite readback and updatedependencies,);expect(prepared.preview.findings).toEqual(parsed.findings);+ expect(prepared.preview.source).toEqual({+ provider: "wiz",+ source_key: options.sourceKey,+ });await expect(access(join(fixture.stateDirectory, "workbench.sqlite3")),).rejects.toThrow();@@ -107,6 +111,7 @@ test("Wiz JSON imports retain parsed evidence through SQLite readback and update);expect(stored).toEqual(first.findings);expect(stored[0]).toMatchObject({+ provider: "wiz",sourceFindingId: "package-occurrence",assessment: { state: "not_assessed" },version: 1,diff --git a/sdk/typescript/tests-ts/external-findings-publish.test.ts b/sdk/typescript/tests-ts/external-findings-publish.test.tsindex 63233bbe5..57d278b12 100644--- a/sdk/typescript/tests-ts/external-findings-publish.test.ts+++ b/sdk/typescript/tests-ts/external-findings-publish.test.ts@@ -3463,9 +3463,12 @@ test("Semgrep publication preserves identity across JSON and SARIF with explicitsourceKey: "organization/project/main",sourceRepositoryUrl: "https://github.com/example/project",};- const first = await (- await prepareExternalPublication(f.file, settings, f.deps)- ).publish();+ const prepared = await prepareExternalPublication(f.file, settings, f.deps);+ expect(prepared.preview.source).toEqual({+ provider: "semgrep",+ source_key: settings.sourceKey,+ });+ const first = await prepared.publish();expect(first.counts.created).toBe(1);expect(first.verified).toBe(1);const original = structuredClone([...f.reports.values()][0]!);diff --git a/sdk/typescript/tests-ts/semgrep-findings-local.test.ts b/sdk/typescript/tests-ts/semgrep-findings-local.test.tsindex c3559c9cd..de22cb8a8 100644--- a/sdk/typescript/tests-ts/semgrep-findings-local.test.ts+++ b/sdk/typescript/tests-ts/semgrep-findings-local.test.ts@@ -196,6 +196,10 @@ test.each(formats)();expect(prepared.preview.findings).toHaveLength(1);expect(prepared.preview.excluded).toEqual([]);+ expect(prepared.preview.source).toEqual({+ provider: "semgrep",+ source_key: options.sourceKey,+ });const imported = await prepared.import();expect(imported.counts).toEqual({ created: 1, updated: 0, unchanged: 0 });