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

fix: validate code evidence paths (#1567)

Peter5df9b7793a5b
diff --git a/plugins/codex-security/tests/test_finalize_scan_contract.py b/plugins/codex-security/tests/test_finalize_scan_contract.py
index 9e395e061..cb0f9d26e 100644
--- a/plugins/codex-security/tests/test_finalize_scan_contract.py
+++ b/plugins/codex-security/tests/test_finalize_scan_contract.py
@@ -2524,6 +2524,23 @@ The extraction root is not enforced.
):
FINALIZER.finalize_scan(self.scan_dir)
+ def test_accepts_code_evidence_with_posix_colon_names(self) -> None:
+ for path in ("src/a:b.py", "report:summary.py"):
+ with self.subTest(path=path):
+ self.findings["findings"][0]["codeEvidence"] = [
+ {
+ "id": "source",
+ "label": "Source",
+ "path": path,
+ "startLine": 1,
+ "code": "source()",
+ "explanation": "Synthetic repository evidence.",
+ }
+ ]
+ self.write_scan()
+ _, findings, _ = FINALIZER.finalize_scan(self.scan_dir)
+ self.assertEqual(findings["findings"][0]["codeEvidence"][0]["path"], path)
+
def test_rejects_unsafe_deferred_paths(self) -> None:
for path in (
"",
diff --git a/sdk/typescript/src/contract.ts b/sdk/typescript/src/contract.ts
index 6b6acb7c8..345e6e468 100644
--- a/sdk/typescript/src/contract.ts
+++ b/sdk/typescript/src/contract.ts
@@ -315,6 +315,19 @@ function validateCanonicalContract(
);
}
}
+ for (const [evidenceIndex, evidence] of (
+ finding.codeEvidence ?? []
+ ).entries()) {
+ const evidenceContext = `${context}.codeEvidence[${evidenceIndex}].path`;
+ try {
+ safeRelativePath(evidence.path, evidenceContext);
+ } catch (error) {
+ throw new ContractValidationError(
+ `${evidenceContext}: expected a safe repository-relative POSIX path.`,
+ { cause: error },
+ );
+ }
+ }
const { findingId, occurrenceId, fingerprints } = deriveFindingIdentity(
manifest.scan.id,
diff --git a/sdk/typescript/tests-ts/contract.test.ts b/sdk/typescript/tests-ts/contract.test.ts
index 730f46604..1a0824a58 100644
--- a/sdk/typescript/tests-ts/contract.test.ts
+++ b/sdk/typescript/tests-ts/contract.test.ts
@@ -1096,6 +1096,65 @@ describe("canonical scan contract", () => {
).rejects.toThrow("unreadable JSON document");
});
+ test.each([
+ ["src/handler.py", true],
+ ["src/a:b.py", true],
+ ["report:summary.py", true],
+ ["src/name with spaces.py", true],
+ ["src/日本語.py", true],
+ ["./src//handler.py", true],
+ ["src/line\u2028separator.py", true],
+ ["../outside.py", false],
+ ["src/../../outside.py", false],
+ ["/outside.py", false],
+ ["C:/outside.py", false],
+ ["C:outside.py", false],
+ ["src\\outside.py", false],
+ [".", false],
+ ["src/\u0000outside.py", false],
+ ["src/name\t.py", false],
+ ] as const)(
+ "validates canonical code-evidence path %j",
+ async (path, valid) => {
+ const scanDir = await copyExample();
+ const findingsPath = join(scanDir, "findings.json");
+ const findings = await readJson(findingsPath);
+ findings["findings"][0]["codeEvidence"] = [
+ {
+ id: "source",
+ label: "Source",
+ path,
+ startLine: 1,
+ code: "source()",
+ explanation: "Synthetic repository evidence.",
+ },
+ ];
+ await writeJson(findingsPath, findings);
+ await reseal(scanDir);
+ const saved = await readFile(findingsPath);
+ const loaded = loadContract(scanDir, { pluginRoot: PLUGIN_ROOT });
+ const exported = pythonExport(scanDir);
+ const stderr = new TextDecoder().decode(exported.stderr);
+
+ if (valid) {
+ const contract = await loaded;
+ expect(contract.findings.findings[0]?.codeEvidence?.[0]?.path).toBe(
+ path,
+ );
+ expect(exported.exitCode, stderr).toBe(0);
+ } else {
+ await expect(loaded).rejects.toThrow(
+ "codeEvidence[0].path: expected a safe repository-relative POSIX path",
+ );
+ expect(exported.exitCode).not.toBe(0);
+ expect(stderr).toContain(
+ "codeEvidence[0].path: expected a safe repository-relative POSIX path",
+ );
+ }
+ expect(await readFile(findingsPath)).toEqual(saved);
+ },
+ );
+
test("rejects schema-valid but canonically invalid contract data", async () => {
const cases: Array<
[
diff --git a/sdk/typescript/tests-ts/publication.test.ts b/sdk/typescript/tests-ts/publication.test.ts
index ec9ab8125..18fca3599 100644
--- a/sdk/typescript/tests-ts/publication.test.ts
+++ b/sdk/typescript/tests-ts/publication.test.ts
@@ -388,7 +388,38 @@ describe("scan publication preparation", () => {
expect(description).not.toContain("/blob/");
});
- test("preserves unsafe evidence snippets without generating escaping source links", async () => {
+ test.each([
+ "../outside.py",
+ "src/../outside.py",
+ "/outside.py",
+ "src\\outside.py",
+ "C:/outside.py",
+ ])("rejects publication with an unsafe evidence path %s", async (path) => {
+ const scanDirectory = await copyExample();
+ const findingsPath = join(scanDirectory, "findings.json");
+ const findings = await readJson<FindingsDocument>(findingsPath);
+ findings.findings[0]!.codeEvidence = [
+ {
+ id: "unsafe-path",
+ label: "Unsafe path",
+ path,
+ startLine: 41,
+ code: "preserved_snippet()",
+ explanation:
+ "An unsafe path cannot be published as canonical evidence.",
+ },
+ ];
+ await writeJson(findingsPath, findings);
+ await reseal(scanDirectory);
+
+ await expect(
+ prepareScanPublication(scanDirectory, publicationOptions(scanDirectory)),
+ ).rejects.toThrow(
+ "findings.findings[0].codeEvidence[0].path: expected a safe repository-relative POSIX path.",
+ );
+ });
+
+ test("preserves evidence snippets for valid paths without safe source links", async () => {
const scanDirectory = await copyExample();
const manifestPath = join(scanDirectory, "scan-manifest.json");
const manifest = await readJson<ScanManifest>(manifestPath);
@@ -400,20 +431,15 @@ describe("scan publication preparation", () => {
const findingsPath = join(scanDirectory, "findings.json");
const findings = await readJson<FindingsDocument>(findingsPath);
const paths = [
- "../outside.py",
- "src/../outside.py",
"src/./outside.py",
"src//outside.py",
- "/outside.py",
- "src\\outside.py",
- "C:/outside.py",
"src/%2e%2e/outside.py",
"src/%2foutside.py",
"src/%5coutside.py",
];
findings.findings[0]!.codeEvidence = paths.map((path, index) => ({
- id: `unsafe-path-${index}`,
- label: `Unsafe path ${index}`,
+ id: `unlinked-path-${index}`,
+ label: `Unlinked path ${index}`,
path,
startLine: 41,
role: "source",