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

refactor: reuse object validation primitives (#1452)

mldangelo-oai3270582b1f59
diff --git a/plugins/codex-security/mcp-app/server.ts b/plugins/codex-security/mcp-app/server.ts
index 4234343da..2cd55f305 100644
--- a/plugins/codex-security/mcp-app/server.ts
+++ b/plugins/codex-security/mcp-app/server.ts
@@ -62,11 +62,10 @@ const workbenchStateSelectionLock = new AsyncLock();
const userContextSchema = z.string().trim().min(1);
const editableUserContextSchema = z.string().trim();
const verifiedAccessGrantSchema = z
- .object({
+ .strictObject({
level: z.enum(["tac1", "tac2", "tac3", "government"]),
source: z.enum(["user", "project", "current_account"]),
})
- .strict()
.refine(
({ level, source }) =>
level === "tac1" ||
@@ -74,7 +73,7 @@ const verifiedAccessGrantSchema = z
"Unsupported Daybreak grant source.",
);
const verifiedAccessSnapshotSchema = z
- .object({
+ .strictObject({
schemaVersion: z.literal(1),
status: z.enum(["granted", "not_granted", "unknown"]),
grants: z.array(verifiedAccessGrantSchema),
@@ -82,7 +81,6 @@ const verifiedAccessSnapshotSchema = z
stale: z.boolean(),
enrollmentUrl: z.url().optional(),
})
- .strict()
.superRefine((snapshot, context) => {
if (snapshot.status === "granted" && snapshot.grants.length === 0) {
context.addIssue({
@@ -131,37 +129,29 @@ async function scanRoot(): Promise<string> {
}
const diffTargetSchema = z.discriminatedUnion("kind", [
- z
- .object({
- kind: z.literal("working_tree"),
- baseRevision: z.string().trim().min(1).max(512).optional(),
- contentDigest: z.string().trim().min(1).max(128).optional(),
- headRevision: z.string().trim().min(1).max(512).optional(),
- })
- .strict(),
- z
- .object({
- kind: z.literal("commit"),
- baseRevision: z.string().trim().min(1).max(512).optional(),
- headRevision: z.string().trim().min(1).max(512),
- })
- .strict(),
- z
- .object({
- kind: z.literal("range"),
- baseRevision: z.string().trim().min(1).max(512),
- headRevision: z.string().trim().min(1).max(512),
- })
- .strict(),
+ z.strictObject({
+ kind: z.literal("working_tree"),
+ baseRevision: z.string().trim().min(1).max(512).optional(),
+ contentDigest: z.string().trim().min(1).max(128).optional(),
+ headRevision: z.string().trim().min(1).max(512).optional(),
+ }),
+ z.strictObject({
+ kind: z.literal("commit"),
+ baseRevision: z.string().trim().min(1).max(512).optional(),
+ headRevision: z.string().trim().min(1).max(512),
+ }),
+ z.strictObject({
+ kind: z.literal("range"),
+ baseRevision: z.string().trim().min(1).max(512),
+ headRevision: z.string().trim().min(1).max(512),
+ }),
]);
-const currentScanPreflightCheckSchema = z
- .object({
- capability: z.string().trim().min(1).max(128),
- reason: z.string().trim().min(1).max(1200),
- severity: z.enum(["block", "warn", "suggest"]),
- status: z.enum(["pass", "fail", "unknown"]),
- })
- .strict();
+const currentScanPreflightCheckSchema = z.strictObject({
+ capability: z.string().trim().min(1).max(128),
+ reason: z.string().trim().min(1).max(1200),
+ severity: z.enum(["block", "warn", "suggest"]),
+ status: z.enum(["pass", "fail", "unknown"]),
+});
const openSchema = {
diffTarget: diffTargetSchema
.optional()
@@ -283,14 +273,12 @@ type PromptOnlyScanInput = {
targetSummary?: string;
userContext?: string;
};
-const userInputOptionSchema = z
- .object({
- description: z.string().trim().min(1).max(1200),
- label: z.string().trim().min(1).max(200),
- })
- .strict();
+const userInputOptionSchema = z.strictObject({
+ description: z.string().trim().min(1).max(1200),
+ label: z.string().trim().min(1).max(200),
+});
const userInputQuestionSchema = z
- .object({
+ .strictObject({
header: z.string().trim().min(1).max(64),
id: z
.string()
@@ -305,7 +293,6 @@ const userInputQuestionSchema = z
options: z.array(userInputOptionSchema).min(2).max(3),
question: z.string().trim().min(1).max(1200),
})
- .strict()
.superRefine((question, context) => {
const labels = new Set<string>();
for (const [index, option] of question.options.entries()) {
@@ -630,7 +617,7 @@ export function createCodexSecurityServer(): McpServer {
title: "Check Codex Security Daybreak Access",
description:
"Check this ChatGPT account's Daybreak access and available Daybreak programs. This check is advisory and never authorizes or blocks a scan. Skip it for Amazon Bedrock scans: it does not check AWS model access or access to local CLI results.",
- inputSchema: z.object({}).strict(),
+ inputSchema: z.strictObject({}),
annotations: readingAnnotations,
_meta: {
...modelActionMeta,
diff --git a/plugins/codex-security/mcp-app/src/artifact-storage.ts b/plugins/codex-security/mcp-app/src/artifact-storage.ts
index 20f6eba3e..82af29711 100644
--- a/plugins/codex-security/mcp-app/src/artifact-storage.ts
+++ b/plugins/codex-security/mcp-app/src/artifact-storage.ts
@@ -24,21 +24,17 @@ const locationShape = {
path: z.string().min(1).optional(),
};
-export const saveArtifactInputSchema = z
- .object({
- ...locationShape,
- content: z.string().optional(),
- sourcePath: z.string().min(1).optional(),
- })
- .strict();
+export const saveArtifactInputSchema = z.strictObject({
+ ...locationShape,
+ content: z.string().optional(),
+ sourcePath: z.string().min(1).optional(),
+});
-export const readArtifactInputSchema = z
- .object({
- ...locationShape,
- path: z.string().min(1),
- encoding: z.enum(["utf8", "base64"]).default("utf8"),
- })
- .strict();
+export const readArtifactInputSchema = z.strictObject({
+ ...locationShape,
+ path: z.string().min(1),
+ encoding: z.enum(["utf8", "base64"]).default("utf8"),
+});
export type ArtifactLocation = z.infer<typeof saveArtifactInputSchema>;
diff --git a/plugins/codex-security/mcp-app/src/deep-scan/artifact-contracts.ts b/plugins/codex-security/mcp-app/src/deep-scan/artifact-contracts.ts
index 27a059119..596e4d4f2 100644
--- a/plugins/codex-security/mcp-app/src/deep-scan/artifact-contracts.ts
+++ b/plugins/codex-security/mcp-app/src/deep-scan/artifact-contracts.ts
@@ -5,7 +5,7 @@ const nonEmptyString = z
.min(1)
.regex(/\S/u, "Must contain non-whitespace text");
const candidateLocationSchemaV1 = z
- .object({
+ .strictObject({
path: nonEmptyString,
start_line: z.number().int().positive(),
end_line: z.number().int().positive(),
@@ -19,7 +19,6 @@ const candidateLocationSchemaV1 = z
"evidence",
]),
})
- .strict()
.refine((location) => location.end_line >= location.start_line, {
message: "end_line must be greater than or equal to start_line",
path: ["end_line"],
@@ -27,7 +26,7 @@ const candidateLocationSchemaV1 = z
/** Exact discovery rows emitted by the shared candidate normalizer. */
export const candidateSchemaV1 = z
- .object({
+ .strictObject({
candidate_id: nonEmptyString.regex(/^(?!\.{1,2}$)[^/\\]+$/u),
cwe_ids: z.array(z.string().regex(/^CWE-[1-9]\d*$/u)),
locations: z.array(candidateLocationSchemaV1).min(1),
@@ -36,7 +35,6 @@ export const candidateSchemaV1 = z
context: nonEmptyString.optional(),
instance: nonEmptyString.optional(),
})
- .strict()
.meta({
id: "codex-security-standard-scan-candidate-v1",
title: "Codex Security discovery candidate v1",
diff --git a/plugins/codex-security/mcp-app/src/helpers/json.ts b/plugins/codex-security/mcp-app/src/helpers/json.ts
index 06dae6ba3..a6d5ac7bc 100644
--- a/plugins/codex-security/mcp-app/src/helpers/json.ts
+++ b/plugins/codex-security/mcp-app/src/helpers/json.ts
@@ -1,6 +1,4 @@
-export function object(value: unknown): value is Record<string, unknown> {
- return typeof value === "object" && value !== null && !Array.isArray(value);
-}
+export { isRecord as object } from "../record.ts";
export function escapeControls(text: string): string {
return text.replace(/[\p{Cc}\p{Cf}]/gu, (character) => {
diff --git a/sdk/typescript/src/api.ts b/sdk/typescript/src/api.ts
index 6a28dc31f..70636d32f 100644
--- a/sdk/typescript/src/api.ts
+++ b/sdk/typescript/src/api.ts
@@ -358,12 +358,10 @@ const VALIDATION_DISPOSITIONS = [
"deferred",
] as const;
-const validationResponseSchema = z
- .object({
- disposition: z.enum(VALIDATION_DISPOSITIONS),
- report: z.string().trim().min(1),
- })
- .strict();
+const validationResponseSchema = z.strictObject({
+ disposition: z.enum(VALIDATION_DISPOSITIONS),
+ report: z.string().trim().min(1),
+});
export interface ValidationResult {
disposition: (typeof VALIDATION_DISPOSITIONS)[number];
diff --git a/sdk/typescript/src/classify-severity.ts b/sdk/typescript/src/classify-severity.ts
index 571eb5a15..1ae17b83b 100644
--- a/sdk/typescript/src/classify-severity.ts
+++ b/sdk/typescript/src/classify-severity.ts
@@ -77,34 +77,30 @@ const textSchema = z
.string()
.min(1)
.refine((value) => value.trim().length > 0);
-const decisionSchema = z
- .object({
- findingId: textSchema,
- decision: z.enum(["assessed", "excluded"]),
- level: levelSchema.nullable(),
- rubricLabel: textSchema.nullable(),
- rationale: textSchema,
- confidence: z.enum(["high", "medium", "low"]).nullable(),
- reviewTrigger: textSchema.nullable(),
- })
- .strict();
+const decisionSchema = z.strictObject({
+ findingId: textSchema,
+ decision: z.enum(["assessed", "excluded"]),
+ level: levelSchema.nullable(),
+ rubricLabel: textSchema.nullable(),
+ rationale: textSchema,
+ confidence: z.enum(["high", "medium", "low"]).nullable(),
+ reviewTrigger: textSchema.nullable(),
+});
const digestSchema = z.string().regex(/^[a-f0-9]{64}$/u);
/** @internal */
-export const severityClassificationSchema = z
- .object({
- schemaVersion: z.literal(1),
- assessedAt: z.string().datetime(),
- rubricSha256: digestSchema.nullable(),
- knowledgeBaseSha256: digestSchema.nullable(),
- assessments: z.array(
- decisionSchema.extend({
- occurrenceId: textSchema.nullable(),
- inputSha256: digestSchema,
- source: z.enum(["existing-severity", "rubric"]),
- }),
- ),
- })
- .strict() satisfies z.ZodType<SeverityClassification>;
+export const severityClassificationSchema = z.strictObject({
+ schemaVersion: z.literal(1),
+ assessedAt: z.string().datetime(),
+ rubricSha256: digestSchema.nullable(),
+ knowledgeBaseSha256: digestSchema.nullable(),
+ assessments: z.array(
+ decisionSchema.extend({
+ occurrenceId: textSchema.nullable(),
+ inputSha256: digestSchema,
+ source: z.enum(["existing-severity", "rubric"]),
+ }),
+ ),
+}) satisfies z.ZodType<SeverityClassification>;
/** Classify each supplied report independently, without scanning or writing findings. */
export async function classifySeverity(
diff --git a/sdk/typescript/src/component-plan.ts b/sdk/typescript/src/component-plan.ts
index 7108e0a78..099f072a7 100644
--- a/sdk/typescript/src/component-plan.ts
+++ b/sdk/typescript/src/component-plan.ts
@@ -22,20 +22,16 @@ import { resolveTrustedExecutable } from "./trusted-executable.js";
const execFile = promisify(execFileCallback);
/** @internal */
-export const componentPlanSchema = z
- .object({
- components: z
- .array(
- z
- .object({
- name: z.string().trim().min(1),
- paths: z.array(z.string().min(1)).min(1),
- })
- .strict(),
- )
- .min(1),
- })
- .strict();
+export const componentPlanSchema = z.strictObject({
+ components: z
+ .array(
+ z.strictObject({
+ name: z.string().trim().min(1),
+ paths: z.array(z.string().min(1)).min(1),
+ }),
+ )
+ .min(1),
+});
export interface ComponentPlan {
components: Array<{ name: string; paths: string[] }>;
diff --git a/sdk/typescript/src/deduplication/codex-review.ts b/sdk/typescript/src/deduplication/codex-review.ts
index 739040fc5..4f6802269 100644
--- a/sdk/typescript/src/deduplication/codex-review.ts
+++ b/sdk/typescript/src/deduplication/codex-review.ts
@@ -54,9 +54,7 @@ import {
type DeduplicationDiagnosticObserver,
} from "./diagnostics.js";
-const reviewErrorSchema = z
- .object({ reason: z.string().trim().min(1) })
- .strict();
+const reviewErrorSchema = z.strictObject({ reason: z.string().trim().min(1) });
export interface CodexReview<T> extends Pick<
DeduplicationReviewRequest,
diff --git a/sdk/typescript/src/deduplication/deduplication-reviewer.ts b/sdk/typescript/src/deduplication/deduplication-reviewer.ts
index dd26d7c2e..bd6b514b1 100644
--- a/sdk/typescript/src/deduplication/deduplication-reviewer.ts
+++ b/sdk/typescript/src/deduplication/deduplication-reviewer.ts
@@ -39,11 +39,9 @@ const screeningDecisionSchema = z.discriminatedUnion("decision", [
screeningDistinctSchema.strict(),
]);
// The host assigns exact slot names; finding IDs stay out of model output.
-const screeningSchema = z
- .object({
- decisions: z.record(z.string(), screeningDecisionSchema),
- })
- .strict();
+const screeningSchema = z.strictObject({
+ decisions: z.record(z.string(), screeningDecisionSchema),
+});
function requireMergedFinding(result: DuplicateDecision): void {
if (result.decision !== "SAME") return;
diff --git a/sdk/typescript/src/deduplication/records-protocol.ts b/sdk/typescript/src/deduplication/records-protocol.ts
index 80e9d8814..fe09faa87 100644
--- a/sdk/typescript/src/deduplication/records-protocol.ts
+++ b/sdk/typescript/src/deduplication/records-protocol.ts
@@ -4,39 +4,28 @@ import { z } from "incur";
import { deduplicateRecords, type DeduplicateRecordsInput } from "./records.js";
const rpcId = z.union([z.string(), z.number().int()]);
-const request = z
- .object({
+const request = z.strictObject({
+ jsonrpc: z.literal("2.0"),
+ id: rpcId,
+ method: z.literal("run"),
+ params: z.unknown(),
+});
+const cancellation = z.strictObject({
+ jsonrpc: z.literal("2.0"),
+ method: z.literal("cancel"),
+ params: z.strictObject({ id: rpcId }),
+});
+const response = z.union([
+ z.strictObject({ jsonrpc: z.literal("2.0"), id: rpcId, result: z.unknown() }),
+ z.strictObject({
jsonrpc: z.literal("2.0"),
id: rpcId,
- method: z.literal("run"),
- params: z.unknown(),
- })
- .strict();
-const cancellation = z
- .object({
- jsonrpc: z.literal("2.0"),
- method: z.literal("cancel"),
- params: z.object({ id: rpcId }).strict(),
- })
- .strict();
-const response = z.union([
- z
- .object({ jsonrpc: z.literal("2.0"), id: rpcId, result: z.unknown() })
- .strict()
- .refine((value) => Object.hasOwn(value, "result")),
- z
- .object({
- jsonrpc: z.literal("2.0"),
- id: rpcId,
- error: z
- .object({
- code: z.number().int(),
- message: z.string(),
- data: z.unknown().optional(),
- })
- .strict(),
- })
- .strict(),
+ error: z.strictObject({
+ code: z.number().int(),
+ message: z.string(),
+ data: z.unknown().optional(),
+ }),
+ }),
]);
type Output = Pick<NodeJS.WriteStream, "write"> & {
on?(event: "error", listener: (error: Error) => void): unknown;
diff --git a/sdk/typescript/src/deduplication/records.ts b/sdk/typescript/src/deduplication/records.ts
index 85b0373f3..5174aa072 100644
--- a/sdk/typescript/src/deduplication/records.ts
+++ b/sdk/typescript/src/deduplication/records.ts
@@ -47,27 +47,22 @@ export function recordsReviewAttribution(
}
const id = z.string().min(1);
-const record = z
- .object({
- id,
- finding: z.unknown().transform((value) => requireFinding(value)),
- })
- .strict();
+const record = z.strictObject({
+ id,
+ finding: z.unknown().transform((value) => requireFinding(value)),
+});
-const deduplicateRecordsInputSchema: z.ZodType<DeduplicateRecordsInput> = z
- .object({
+const deduplicateRecordsInputSchema: z.ZodType<DeduplicateRecordsInput> =
+ z.strictObject({
version: z.literal(1),
observations: z.array(record),
candidateRelationships: z.array(
- z
- .object({
- observationId: id,
- candidateObservationIds: z.array(id),
- })
- .strict(),
+ z.strictObject({
+ observationId: id,
+ candidateObservationIds: z.array(id),
+ }),
),
- })
- .strict();
+ });
export interface DeduplicateRecordsInput {
version: 1;
diff --git a/sdk/typescript/src/scan-comparison.ts b/sdk/typescript/src/scan-comparison.ts
index 5c0b559a4..07813ada8 100644
--- a/sdk/typescript/src/scan-comparison.ts
+++ b/sdk/typescript/src/scan-comparison.ts
@@ -193,48 +193,38 @@ const reason = z
.string()
.min(1)
.refine((value) => value.trim().length > 0);
-const findingPairSchema = z
- .object({
- beforeOccurrenceId: z.string(),
- afterOccurrenceId: z.string(),
- reason,
- })
- .strict();
-const comparisonSchema = z
- .object({
- matches: z.array(
- z
- .object({
- beforeOccurrenceIds: z.array(z.string()).min(1),
- afterOccurrenceIds: z.array(z.string()).min(1),
- confidence: z.literal("high"),
- reason,
- })
- .strict(),
- ),
- uncertain: z.array(findingPairSchema),
- related: z.array(findingPairSchema).optional(),
- })
- .strict();
+const findingPairSchema = z.strictObject({
+ beforeOccurrenceId: z.string(),
+ afterOccurrenceId: z.string(),
+ reason,
+});
+const comparisonSchema = z.strictObject({
+ matches: z.array(
+ z.strictObject({
+ beforeOccurrenceIds: z.array(z.string()).min(1),
+ afterOccurrenceIds: z.array(z.string()).min(1),
+ confidence: z.literal("high"),
+ reason,
+ }),
+ ),
+ uncertain: z.array(findingPairSchema),
+ related: z.array(findingPairSchema).optional(),
+});
-const evidenceRequestSchema = z
- .object({
- kind: z.literal("evidence"),
- beforeOccurrenceIds: z.array(z.string()),
- afterOccurrenceIds: z.array(z.string()),
- offset: z.number().int().nonnegative(),
- })
- .strict();
+const evidenceRequestSchema = z.strictObject({
+ kind: z.literal("evidence"),
+ beforeOccurrenceIds: z.array(z.string()),
+ afterOccurrenceIds: z.array(z.string()),
+ offset: z.number().int().nonnegative(),
+});
type EvidenceRequest = z.infer<typeof evidenceRequestSchema>;
const matchingTurnSchema = comparisonSchema.extend({
request: z
.union([
- z
- .object({
- kind: z.literal("catalogue"),
- page: z.number().int().nonnegative(),
- })
- .strict(),
+ z.strictObject({
+ kind: z.literal("catalogue"),
+ page: z.number().int().nonnegative(),
+ }),
evidenceRequestSchema,
])
.nullable()
diff --git a/sdk/typescript/src/security-policy.ts b/sdk/typescript/src/security-policy.ts
index 31435a9b8..ce6b8f7fe 100644
--- a/sdk/typescript/src/security-policy.ts
+++ b/sdk/typescript/src/security-policy.ts
@@ -130,14 +130,12 @@ export interface SecurityPolicyPreflight
maxCostUsd?: number;
}
-const securityPolicyStageSchema = z
- .object({
- markdown: z.string(),
- questions: z.array(z.string()),
- reviewNotes: z.array(z.string()),
- blockedReason: z.string().nullable(),
- })
- .strict();
+const securityPolicyStageSchema = z.strictObject({
+ markdown: z.string(),
+ questions: z.array(z.string()),
+ reviewNotes: z.array(z.string()),
+ blockedReason: z.string().nullable(),
+});
export interface SecurityPolicyStageResult {
markdown: string;
diff --git a/sdk/typescript/src/suggest-owners.ts b/sdk/typescript/src/suggest-owners.ts
index 226de28be..ba2ededb6 100644
--- a/sdk/typescript/src/suggest-owners.ts
+++ b/sdk/typescript/src/suggest-owners.ts
@@ -63,13 +63,11 @@ export interface OwnerSuggestions extends ScanModelConfiguration {
results: OwnerSuggestion[];
}
-const decisionSchema = z
- .object({
- identityIndex: z.number().int().min(-1),
- reason: text,
- evidenceIds: z.array(text),
- })
- .strict();
+const decisionSchema = z.strictObject({
+ identityIndex: z.number().int().min(-1),
+ reason: text,
+ evidenceIds: z.array(text),
+});
/** Suggest contributors from local Git evidence without changing findings or assigning tickets. */
export async function suggestOwners(