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
import { z } from "zod";
import {
DeepScanSettingsSchema,
FailureSeveritySchema,
ScanSettingsSchema,
} from "./scan-settings.js";
const nonempty = z.string().min(1);
export const ProjectScopeSchema = z.union([
z.strictObject({
paths: z
.array(nonempty)
.min(1)
.describe("Literal paths relative to the selected repository."),
}),
z.strictObject({
diff: z.strictObject({
base: nonempty,
head: nonempty.optional().meta({ default: "HEAD" }),
}),
}),
z.strictObject({
working_tree: z.strictObject({
base: nonempty.optional().meta({ default: "HEAD" }),
}),
}),
]);
export const ProjectConfigInputSchema = z.strictObject({
$schema: nonempty
.optional()
.describe(
"Editor schema URI or relative path. The CLI does not fetch or select a validator from this value.",
),
auth: ScanSettingsSchema.shape.auth.describe(
"Credential-source choice only; never a credential value.",
),
scan: z
.strictObject({
mode: ScanSettingsSchema.shape.mode,
max_time_minutes: ScanSettingsSchema.shape.maxTimeMinutes,
cyber_access_program: ScanSettingsSchema.shape.cyberAccessProgram,
owner_suggestions: ScanSettingsSchema.shape.ownerSuggestions,
scope: ProjectScopeSchema.optional().describe(
"One scope variant. Omit for the whole repository. Mode compatibility is checked after overrides.",
),
knowledge_base: ScanSettingsSchema.shape.knowledgeBasePaths.describe(
"Context files or directories, relative to this file. An empty list selects no additional context.",
),
instructions_file: ScanSettingsSchema.shape.scanPromptFile.describe(
"Additional scan instructions, relative to this file.",
),
validation_file: ScanSettingsSchema.shape.validationPromptFile.describe(
"Custom validation instructions, relative to this file; not supported in active deep scans.",
),
deep: z
.strictObject({
workers: DeepScanSettingsSchema.shape.workers,
subagents_per_worker: DeepScanSettingsSchema.shape.subagents,
stop_after_no_new: DeepScanSettingsSchema.shape.stopAfterNoNew,
stop_after_consecutive_errors:
DeepScanSettingsSchema.shape.stopAfterConsecutiveErrors,
max_discovery_runs: DeepScanSettingsSchema.shape.maxDiscoveryRuns,
max_time_hours: DeepScanSettingsSchema.shape.maxTimeHours,
})
.optional()
.describe(
"Deep defaults; a valid block may be retained while standard mode is selected.",
),
})
.optional(),
codex: z
.object({
model: nonempty.optional(),
model_reasoning_effort: nonempty.optional(),
model_provider: nonempty.optional(),
})
.catchall(z.json())
.optional()
.describe(
"Native Codex overrides. Common key types are checked here; existing native and wrapper restrictions still apply.",
),
limits: z
.strictObject({
max_cost_usd_per_scan: ScanSettingsSchema.shape.maxCostUsd.describe(
"Estimated USD limit per launched scan attempt, not a total batch budget. Omit for no limit.",
),
})
.optional(),
policy: z
.strictObject({
fail_on_severity: FailureSeveritySchema.optional().describe(
"Exit threshold; does not filter retained findings. Omit for report-only behavior.",
),
})
.optional(),
output: z
.strictObject({
directory: ScanSettingsSchema.shape.outputDir.describe(
"Artifact directory relative to this file; existing outside-worktree checks still apply.",
),
})
.optional(),
});
export type ProjectConfigInput = z.infer<typeof ProjectConfigInputSchema>;
export type ProjectScope = z.infer<typeof ProjectScopeSchema>;
export function projectConfigJsonSchema() {
return {
...z.toJSONSchema(ProjectConfigInputSchema, {
target: "draft-07",
io: "input",
unrepresentable: "throw",
}),
title: "Codex Security project configuration",
description:
"Input schema for explicitly selected YAML or JSON project files. Filesystem, active scan combinations, native configuration, and runtime availability are checked separately.",
$comment:
"Generated from ProjectConfigInputSchema. Defaults are annotations; apply defaults only after merging input layers.",
};
}