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

8.0 KB
Raw Blame
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "$schema": {
      "description": "Editor schema URI or relative path. The CLI does not fetch or select a validator from this value.",
      "type": "string",
      "minLength": 1
    },
    "auth": {
      "default": "auto",
      "description": "Credential-source choice only; never a credential value.",
      "type": "string",
      "enum": ["auto", "chatgpt", "api-key"]
    },
    "scan": {
      "type": "object",
      "properties": {
        "mode": {
          "default": "standard",
          "type": "string",
          "enum": ["standard", "deep"]
        },
        "max_time_minutes": {
          "description": "Investigation minutes: advisory in Standard (default: unset); enforced Deep discovery limit (default and maximum: 5760). Scans may finish early; reporting may run longer.",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "cyber_access_program": {
          "description": "Experimental Cyber access program for scan turns (OpenAI provider only). Omit to preserve Codex defaults.",
          "type": "string",
          "enum": ["standard", "daybreak_blue", "daybreak_red"]
        },
        "owner_suggestions": {
          "description": "Generate optional owner-suggestions.json after a committed scan (default: false).",
          "type": "boolean"
        },
        "scope": {
          "description": "One scope variant. Omit for the whole repository. Mode compatibility is checked after overrides.",
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "paths": {
                  "minItems": 1,
                  "type": "array",
                  "items": { "type": "string", "minLength": 1 },
                  "description": "Literal paths relative to the selected repository."
                }
              },
              "required": ["paths"],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "diff": {
                  "type": "object",
                  "properties": {
                    "base": { "type": "string", "minLength": 1 },
                    "head": {
                      "default": "HEAD",
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": ["base"],
                  "additionalProperties": false
                }
              },
              "required": ["diff"],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "working_tree": {
                  "type": "object",
                  "properties": {
                    "base": {
                      "default": "HEAD",
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "additionalProperties": false
                }
              },
              "required": ["working_tree"],
              "additionalProperties": false
            }
          ]
        },
        "knowledge_base": {
          "description": "Context files or directories, relative to this file. An empty list selects no additional context.",
          "type": "array",
          "items": { "type": "string", "minLength": 1 }
        },
        "instructions_file": {
          "description": "Additional scan instructions, relative to this file.",
          "type": "string",
          "minLength": 1
        },
        "validation_file": {
          "description": "Custom validation instructions, relative to this file; not supported in active deep scans.",
          "type": "string",
          "minLength": 1
        },
        "deep": {
          "description": "Deep defaults; a valid block may be retained while standard mode is selected.",
          "type": "object",
          "properties": {
            "workers": {
              "default": 4,
              "description": "Maximum concurrent deep-scan discovery workers.",
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "subagents_per_worker": {
              "default": 3,
              "description": "Subagents available to each deep-scan worker. Zero is valid.",
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "stop_after_no_new": {
              "default": 4,
              "description": "Stop after this many runs find no new issues.",
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "stop_after_consecutive_errors": {
              "default": 3,
              "description": "Stop after this many consecutive discovery errors.",
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "max_discovery_runs": {
              "default": 40,
              "description": "Maximum deep-scan discovery runs.",
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            "max_time_hours": {
              "default": 96,
              "deprecated": true,
              "description": "Deprecated Deep-only alias for maxTimeMinutes / --max-time, in hours (default: 96; maximum: 96).",
              "type": "number",
              "exclusiveMinimum": 0,
              "maximum": 96
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "codex": {
      "description": "Native Codex overrides. Common key types are checked here; existing native and wrapper restrictions still apply.",
      "type": "object",
      "properties": {
        "model": { "type": "string", "minLength": 1 },
        "model_reasoning_effort": { "type": "string", "minLength": 1 },
        "model_provider": { "type": "string", "minLength": 1 }
      },
      "additionalProperties": { "$ref": "#/definitions/__schema0" }
    },
    "limits": {
      "type": "object",
      "properties": {
        "max_cost_usd_per_scan": {
          "description": "Estimated USD limit per launched scan attempt, not a total batch budget. Omit for no limit.",
          "type": "number",
          "exclusiveMinimum": 0
        }
      },
      "additionalProperties": false
    },
    "policy": {
      "type": "object",
      "properties": {
        "fail_on_severity": {
          "description": "Exit threshold; does not filter retained findings. Omit for report-only behavior.",
          "type": "string",
          "enum": ["critical", "high", "medium", "low"]
        }
      },
      "additionalProperties": false
    },
    "output": {
      "type": "object",
      "properties": {
        "directory": {
          "description": "Artifact directory relative to this file; existing outside-worktree checks still apply.",
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "definitions": {
    "__schema0": {
      "anyOf": [
        { "type": "string" },
        { "type": "number" },
        { "type": "boolean" },
        { "type": "null" },
        { "type": "array", "items": { "$ref": "#/definitions/__schema0" } },
        {
          "type": "object",
          "propertyNames": { "type": "string" },
          "additionalProperties": { "$ref": "#/definitions/__schema0" }
        }
      ]
    }
  },
  "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."
}