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(sdk): leave Git-ignored SECURITY.md files out of policy discovery (#1535)

ilaigold716e74d7263f
diff --git a/sdk/typescript/src/security-policy.ts b/sdk/typescript/src/security-policy.ts
index 17d385fc4..50fe1ed14 100644
--- a/sdk/typescript/src/security-policy.ts
+++ b/sdk/typescript/src/security-policy.ts
@@ -42,6 +42,7 @@ import {
enclosingGitWorktreeRoots,
gitMetadataDirectories,
gitObjectDirectories,
+ gitOutput,
isGitMetadataDirectory,
normalizeRepository,
normalizeTarget,
@@ -430,10 +431,13 @@ async function securityPolicyPaths(
const gitDirectories = new Set<string>();
const policies: string[] = [];
const reportingPaths = new Set<string>();
+ const ignored = new Set<string>();
const isGitData = (path: string): boolean =>
[...gitDirectories].some(
(directory) => !relativePathIsOutside(relative(directory, path)),
);
+ const isIgnored = (path: string): boolean =>
+ ignored.has(path) || (dirname(path) !== path && isIgnored(dirname(path)));
const addRoot = async (repository: string) => {
if (knownRoots.has(repository)) return;
knownRoots.add(repository);
@@ -444,6 +448,21 @@ async function securityPolicyPaths(
gitDirectories.add(join(gitRoot, ".git"));
for (const directory of await gitMetadataDirectories(gitRoot, signal))
gitDirectories.add(directory);
+ // Like scans, skip Git-ignored files such as installed dependencies.
+ const ignoredPaths = await gitOutput(
+ gitRoot,
+ [
+ "ls-files",
+ "--others",
+ "--ignored",
+ "--exclude-standard",
+ "--directory",
+ "-z",
+ ],
+ signal,
+ );
+ for (const path of ignoredPaths.split("\0").filter(Boolean))
+ ignored.add(resolve(gitRoot, path));
}
for (const name of [".github", "docs"]) {
let directory = join(repository, name);
@@ -507,7 +526,11 @@ async function securityPolicyPaths(
gitDirectories.add(path);
// Git storage can reference a directory visited earlier in the walk.
return {
- paths: [...policies, ...reportingPaths].filter((path) => !isGitData(path)),
+ paths: [...policies, ...reportingPaths].filter(
+ (path) =>
+ !isGitData(path) &&
+ (path === join(root, "SECURITY.md") || !isIgnored(path)),
+ ),
gitMetadataPaths: [...gitDirectories],
};
}
diff --git a/sdk/typescript/tests-ts/api-policy.test.ts b/sdk/typescript/tests-ts/api-policy.test.ts
index bdcd4183c..b700eb3e2 100644
--- a/sdk/typescript/tests-ts/api-policy.test.ts
+++ b/sdk/typescript/tests-ts/api-policy.test.ts
@@ -866,13 +866,16 @@ describe("CodexSecurity policy API", () => {
}
});
- test("rejects hard-linked policy evidence before starting Codex", async () => {
- for (const [scope, policyPath] of [
- [".", "SECURITY.md"],
- ["component", "SECURITY.md"],
- [".", "child/SECURITY.md"],
- [".", ".github/SECURITY.md"],
- ] as const) {
+ test.each([
+ [".", "SECURITY.md", false],
+ ["component", "SECURITY.md", false],
+ [".", "child/SECURITY.md", false],
+ [".", ".github/SECURITY.md", false],
+ [".", "SECURITY.md", true],
+ ["component", "component/SECURITY.md", true],
+ ] as const)(
+ "rejects hard-linked policy evidence before starting Codex (%s, %s, ignored: %j)",
+ async (scope, policyPath, ignored) => {
let prepared = false;
const f = await setup({ onPrepare: () => (prepared = true) });
policyGit(f.repository, "init", "--quiet");
@@ -880,6 +883,8 @@ describe("CodexSecurity policy API", () => {
await mkdir(join(f.repository, scope), { recursive: true });
await mkdir(dirname(target), { recursive: true });
await link(join(f.repository, ".git", "config"), target);
+ if (ignored)
+ await writeFile(join(f.repository, ".gitignore"), `${policyPath}\n`);
const options = { path: scope, outputDir: f.outputDir };
await expect(
f.security.preflightPolicy(f.repository, options),
@@ -891,8 +896,8 @@ describe("CodexSecurity policy API", () => {
expect(f.threads).toHaveLength(0);
expect(await readdir(f.outputDir)).toEqual([]);
await f.security.close();
- }
- });
+ },
+ );
test("rejects non-UTF-8 descendant policies before starting Codex", async () => {
let prepared = false;
diff --git a/sdk/typescript/tests-ts/security-policy.test.ts b/sdk/typescript/tests-ts/security-policy.test.ts
index edff19be8..1f5734ad3 100644
--- a/sdk/typescript/tests-ts/security-policy.test.ts
+++ b/sdk/typescript/tests-ts/security-policy.test.ts
@@ -398,6 +398,44 @@ describe("security policy generation", () => {
expect(inventory.gitMetadataPaths).toEqual([]);
});
+ test("leaves Git-ignored dependencies out of the policy inventory", async () => {
+ const f = await fixture();
+ policyGit(f.repository, "init", "--quiet");
+ await writeFile(
+ join(f.repository, ".gitignore"),
+ "/SECURITY.md\nnode_modules/\n.venv/\n",
+ );
+ await writeFile(join(f.repository, "SECURITY.md"), POLICY);
+ for (const directory of [
+ "node_modules/dependency",
+ "node_modules/tracked",
+ ".venv/src/dependency",
+ "services/api",
+ ]) {
+ await mkdir(join(f.repository, directory), { recursive: true });
+ await writeFile(join(f.repository, directory, "SECURITY.md"), POLICY);
+ }
+ policyGit(join(f.repository, ".venv/src/dependency"), "init", "--quiet");
+ policyGit(f.repository, "add", "--force", "node_modules/tracked");
+ const inventory = await inspectSecurityPolicySources(
+ await resolveSecurityPolicyTarget(f.repository),
+ );
+ expect(inventory.policyPaths).toEqual([
+ "SECURITY.md",
+ "node_modules/tracked/SECURITY.md",
+ "services/api/SECURITY.md",
+ ]);
+ const selectedDependency = await inspectSecurityPolicySources(
+ await resolveSecurityPolicyTarget(
+ f.repository,
+ "node_modules/dependency",
+ ),
+ );
+ expect(selectedDependency.policyPaths).toEqual([
+ "node_modules/dependency/SECURITY.md",
+ ]);
+ });
+
test("recognizes shared Git storage without HEAD during policy discovery", async () => {
const f = await fixture();
const metadata = join(f.repository, "shared-data");