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

chore(release): 0.5.1 (#1778)

github-actions[bot]b2fa51576d81
diff --git a/.github/release-notes.md b/.github/release-notes.md
index bc7954e0c..39d5f6e6e 100644
--- a/.github/release-notes.md
+++ b/.github/release-notes.md
@@ -1,75 +1,56 @@
-<!-- release-version: 0.5.0 -->
+<!-- release-version: 0.5.1 -->
<!-- release-section: highlights:start -->
## Highlights
-Codex Security 0.5.0 adds investigation time budgets, host-provided finding reviews, and more inference provider options. It also improves saved finding evidence, usage reporting, and recovery after interrupted scans and publication. The minor version marks the retirement of advisory capability preflight; custom integrations should follow the migration guidance below.
+Codex Security 0.5.1 adds hosted patch generation and fix verification, and improves saved-scan replay, Deep Scan recovery, and Windows setup.
-- **Investigation budgets.** Set an investigation allowance with `codex-security scan . --max-time 15`, SDK `maxTimeMinutes`, or project setting `scan.max_time_minutes`. Values are positive minutes, including fractions. Standard and diff scans treat the allowance as advisory; Deep Scan enforces it for discovery, then combines completed findings. Reporting can continue beyond the deadline. See the [time-budget guide](https://github.com/openai/codex-security/blob/npm-v0.5.0/sdk/typescript/docs/cli.md#set-investigation-time). ([#1674](https://github.com/openai/codex-security/pull/1674))
-- **Host-provided finding reviews.** Hosts can validate findings against source with `codex-security validate --records` and `validateRecords()`, or classify canonical reports against a supplied severity rubric with `codex-security classify-severity --records` and `classifySeverityRecords()`. Both use host-provided model execution; classification requires no repository or saved scan. See the [validation guide](https://github.com/openai/codex-security/blob/npm-v0.5.0/sdk/typescript/docs/validate-records.md) and [classification guide](https://github.com/openai/codex-security/blob/npm-v0.5.0/sdk/typescript/docs/classify-severity-records.md) for input contracts and host responsibilities. ([#1682](https://github.com/openai/codex-security/pull/1682), [#1662](https://github.com/openai/codex-security/pull/1662))
-- **Inference providers.** Scans support Cheaper Inference through `--provider cheaperinference`, an explicit model, and `CHEAPER_INFERENCE_API_KEY`. The GitHub Action adds a `provider` input for Amazon Bedrock, OpenRouter, and Fireworks alongside the default OpenAI provider; non-OpenAI providers require an explicit model and the selected provider's credentials. See the [CLI provider documentation](https://github.com/openai/codex-security/blob/npm-v0.5.0/sdk/typescript/docs/cli.md) and [Action setup guide](https://github.com/openai/codex-security/blob/npm-v0.5.0/github-action/README.md#inference-providers). ([#1623](https://github.com/openai/codex-security/pull/1623), [#1677](https://github.com/openai/codex-security/pull/1677))
-- **Saved results and recovery.** Patching and fix verification use complete sealed evidence, and bulk scans validate saved artifacts before reusing completed results. See the upgrade guidance below.
-
-<!-- release-section: highlights:end -->
-
-<!-- release-section: upgrades:start -->
-
-## Upgrade notes
-
-### Custom capability-preflight integrations
-
-The plugin's `scripts/config_preflight.py` helper and `preflight/capability-profiles.toml` registry are removed. Custom capability registries and helper-derived progress inputs and events are no longer supported.
+- **Hosted patching and verification.** Integrations can generate patches and independently verify candidate fixes through `runHostedRemediation()` and its JSON-RPC adapter using a supplied executor. Hosts own checkout isolation, sandbox enforcement, candidate patch identity, and publication. See the [hosted remediation guide](https://github.com/openai/codex-security/blob/npm-v0.5.1/sdk/typescript/docs/hosted-remediation.md). ([#1684](https://github.com/openai/codex-security/pull/1684))
+- **Saved scan settings.** Daybreak selections persist across scans and remediation, including fresh and resumed Deep Scan workers. Saved Bedrock scans retain the effective AWS region and profile, and inline patches preserve the selected profile's provider settings. Severity classification uses the saved repository to select helpers. ([#1740](https://github.com/openai/codex-security/pull/1740), [#1811](https://github.com/openai/codex-security/pull/1811), [#1810](https://github.com/openai/codex-security/pull/1810), [#1815](https://github.com/openai/codex-security/pull/1815))
+- **Deep Scan recovery and progress.** Reports retain accepted worker coverage and its original evidence, including coverage recovered after cancellation or a discovery deadline. Standard and diff scans refresh phase and review counts from saved state even when the model emits no new progress markers. ([#1593](https://github.com/openai/codex-security/pull/1593), [#1757](https://github.com/openai/codex-security/pull/1757))
+- **Windows setup.** Runtime preparation uses private workspaces in the state directory so elevated-sandbox permissions on `TEMP` do not prevent scans from starting. Policy generation supports the default elevated Windows sandbox; see the access details below. Update notices also recognize global installations managed by nvm-windows. ([#1803](https://github.com/openai/codex-security/pull/1803), [#1741](https://github.com/openai/codex-security/pull/1741), [#1801](https://github.com/openai/codex-security/pull/1801))
+- **Reliable command results.** Optional logging, update notices, and scratch cleanup no longer override completed scan, import, or publication outcomes. Failed commands do not print success output, and patch and verification commands wait for required output writes to finish. ([#1800](https://github.com/openai/codex-security/pull/1800), [#1818](https://github.com/openai/codex-security/pull/1818), [#1824](https://github.com/openai/codex-security/pull/1824), [#1826](https://github.com/openai/codex-security/pull/1826), [#1775](https://github.com/openai/codex-security/pull/1775), [#1777](https://github.com/openai/codex-security/pull/1777))
<details>
-<summary>Migration steps for custom integrations</summary>
+<summary>Other fixes</summary>
-1. Remove helper invocations, custom-registry arguments, and gates that wait for a helper `ready` result. Replace references to `config-preflight.md` and `desktop-config-preflight.md` with the [scan runtime guidance](https://github.com/openai/codex-security/blob/npm-v0.5.0/plugins/codex-security/references/scan-runtime.md). Use available delegation tools and successful spawn results; continue in the parent when workers cannot start. Do not edit persistent configuration to enable optional workers or goal tools.
-2. Remove `kind: "preflight"` handling from `onWorkerStatus` consumers, including reads of `delegation` and `configuredSlots`, and stop waiting for the CLI's `worker.preflight` diagnostic. `onWorkerStatus` still emits `kind: "dispatch"` with `phase`, `planned`, and `started`. These counts are best-effort model reports; a missing event does not prove no worker ran.
-3. Stop sending `preflightChecks` to `update_codex_security_scan_progress` and remove the workbench arguments `--preflight-issues-json` and `--preflight-issues-json-stdin`. For host-backed Standard and diff scans, use the authoritative scan context and advance to `threat_model` before architecture mapping. Deep Scan's coordinator continues to own its setup and progress.
+- Saved scopes, component scans, CSV imports, and activity displays preserve literal paths. Helper values beginning with `-` and literal TOML strings retain their values. ([#1812](https://github.com/openai/codex-security/pull/1812), [#1814](https://github.com/openai/codex-security/pull/1814), [#1786](https://github.com/openai/codex-security/pull/1786), [#1827](https://github.com/openai/codex-security/pull/1827), [#1809](https://github.com/openai/codex-security/pull/1809), [#1792](https://github.com/openai/codex-security/pull/1792))
+- Basic patching supports Git repositories before their first commit. Directory inventories exclude `.svn` metadata, and component scans include tracked files matched by `.gitignore`. ([#1552](https://github.com/openai/codex-security/pull/1552), [#1768](https://github.com/openai/codex-security/pull/1768))
+- Scan history, feedback selection, and automatic matching consistently use scan start times when choosing and comparing results. ([#1772](https://github.com/openai/codex-security/pull/1772), [#1774](https://github.com/openai/codex-security/pull/1774), [#1776](https://github.com/openai/codex-security/pull/1776), [#1779](https://github.com/openai/codex-security/pull/1779))
+- SARIF exports preserve sealed scan artifacts. CSV processing preserves large quoted fields and finalized Deep Scan candidate metadata. ([#1769](https://github.com/openai/codex-security/pull/1769), [#1785](https://github.com/openai/codex-security/pull/1785), [#1828](https://github.com/openai/codex-security/pull/1828))
+- Canceled fix verification restores an already applied patch's state. Deduplication reviews retry temporary Codex rate-limit errors, and cancellation is honored around embedding callbacks and saved result writes. ([#1819](https://github.com/openai/codex-security/pull/1819), [#1767](https://github.com/openai/codex-security/pull/1767), [#1789](https://github.com/openai/codex-security/pull/1789), [#1821](https://github.com/openai/codex-security/pull/1821))
+- Runtime telemetry preserves analytics and OpenTelemetry controls across workers and remediation. ([#1691](https://github.com/openai/codex-security/pull/1691))
+- Release automation waits for npm, installed-package checks, the GitHub Action, and container publication. Containers retain their place in the publication queue. ([#1796](https://github.com/openai/codex-security/pull/1796), [#1806](https://github.com/openai/codex-security/pull/1806))
</details>
-Saved preflight history remains readable, and the scan lifecycle still includes a `preflight` phase. Local SDK `preflight()` input checks, authentication, sandbox enforcement, and Deep worker configuration remain in effect. Normal CLI and SDK scans need no capability-preflight configuration migration. ([#1609](https://github.com/openai/codex-security/pull/1609))
-
-### Investigation time settings
+<!-- release-section: highlights:end -->
-Prefer the new minute-based settings for Standard, diff, and Deep scans. For existing Deep Scan configurations, convert hours to minutes:
+<!-- release-section: upgrades:start -->
-| Previous setting | Preferred setting |
-| ------------------------------------- | ------------------------------------ |
-| `--max-time-hours 2` | `--max-time 120` |
-| SDK `maxTimeHours: 2` | SDK `maxTimeMinutes: 120` |
-| Project `scan.deep.max_time_hours: 2` | Project `scan.max_time_minutes: 120` |
+## Upgrade notes
-The hour-based settings, including legacy TOML `deep_scan.max_time_hours`, remain accepted as deprecated Deep-only aliases. Explicit settings override lower-priority configuration across units. At the winning configuration source, equivalent durations are accepted; conflicting minute/hour values are errors.
+### Windows policy generation
-Standard scans still have no time allowance by default. An allowance is neither a hard timeout nor a minimum runtime. Deep Scan's default and maximum discovery duration remain 5760 minutes (96 hours). Resuming Deep Scan retains its original deadline; rerunning starts a new allowance. For batch and component scans, project time settings apply separately to each scan attempt, not the campaign as a whole. See the [time-budget guide](https://github.com/openai/codex-security/blob/npm-v0.5.0/sdk/typescript/docs/cli.md#set-investigation-time). ([#1674](https://github.com/openai/codex-security/pull/1674))
+With the elevated Windows sandbox, policy generation can read other local source, including sibling components. The policy prompt retains the selected component's scope. Credential, configuration, and Git metadata denials, read-only access, and disabled network access remain enforced. Explicit sandbox choices and Unix read scope are unchanged. ([#1741](https://github.com/openai/codex-security/pull/1741))
-### Saved scan evidence and recovery
+### Saved scans of SVN working copies
-Keep the complete sealed artifacts with saved scans used for patching or fix verification. Missing or mismatched evidence now stops those tasks instead of passing a shortened preview to the model. Bulk-scan resume validates saved contracts and seals before reusing a completed result; invalid or unsuccessful results start a new attempt while preserving the old artifacts. ([#1608](https://github.com/openai/codex-security/pull/1608), [#1720](https://github.com/openai/codex-security/pull/1720))
+Directory scans and patch identities now exclude `.svn` metadata. If a saved scan or patch included that metadata and no longer matches its source, restart the scan or regenerate the patch. Git diff and working-tree scans still require Git. ([#1552](https://github.com/openai/codex-security/pull/1552))
-### GitHub Action release assets
+### Custom component and CSV scan clients
-If automation downloads the Action manifest or SBOM from an `npm-vX.Y.Z` release, switch those downloads to the matching `action-vX.Y.Z` release. The npm release remains the canonical changelog and Latest release; Action version tags and workflow usage syntax are unchanged. See the [Action release documentation](https://github.com/openai/codex-security/blob/npm-v0.5.0/github-action/README.md#development). ([#1711](https://github.com/openai/codex-security/pull/1711))
+Custom component clients and clients handling explicit CSV scopes now receive absolute scan targets. Component callers intentionally using home shorthand should supply an absolute path inside the repository. Saved plans and receipts retain their existing formats, and completed campaign receipts remain reusable. ([#1814](https://github.com/openai/codex-security/pull/1814))
-### Selected-profile approval policy
+### GitHub Action
-An explicitly selected Codex profile's `approval_policy` now takes precedence over the root policy. If you previously relied on a root `never` policy despite a selected profile specifying `on-request`, set the selected profile's policy to `never` to continue denying permission requests. An absent or null profile policy still inherits the root value; Deep Scan workers retain their explicit `never` policy. ([#530](https://github.com/openai/codex-security/pull/530))
+The Marketplace display name is now **OpenAI Codex Security**. Use `openai/[email protected]`, or pin the full distribution commit recorded in the Action release manifest. The npm package name remains `@openai/codex-security`. Marketplace publication is a separate step after the automated release. ([#1797](https://github.com/openai/codex-security/pull/1797))
-<!-- release-section: upgrades:end -->
+### Upgrading from earlier releases
-<details>
-<summary>More improvements</summary>
+If upgrading from before 0.5.0, also review the [0.5.0 upgrade notes](https://github.com/openai/codex-security/releases/tag/npm-v0.5.0), including custom capability-preflight integrations and selected-profile approval settings.
-- Hosted scans pass `reasoningEffort` strings through to the executor, including `max` and future values supported by the selected model or provider. The GitHub Action's `effort` input also accepts provider-supported strings and retains its `xhigh` default. Deep Scan forwards resolved native settings to fresh and resumed workers while retaining worker-specific permissions. ([#1712](https://github.com/openai/codex-security/pull/1712), [#1717](https://github.com/openai/codex-security/pull/1717))
-- Standard and diff scans use available workers and continue review in the parent when delegation is unavailable. Optional worker or goal-tool availability no longer depends on the removed capability registry. ([#1609](https://github.com/openai/codex-security/pull/1609))
-- Patching and fix verification use complete sealed findings from saved scans, preserving current triage and remediation state. Workbench excerpts stay tied to the source and scope of the saved scan, and publishing older findings preserves their historical root-cause details and code evidence. ([#1608](https://github.com/openai/codex-security/pull/1608), [#488](https://github.com/openai/codex-security/pull/488), [#1756](https://github.com/openai/codex-security/pull/1756))
-- Usage reporting distinguishes recorded tokens from missing worker receipts or unfinished turns. Partial totals display as "at least X tokens; some usage unavailable." Saved scan history includes parent/worker totals and measurement times alongside cost estimates; historical account-limit readings are not a live allowance check. See [progress and cost](https://github.com/openai/codex-security/blob/npm-v0.5.0/sdk/typescript/docs/cli.md#progress-and-cost). ([#1640](https://github.com/openai/codex-security/pull/1640))
-- Bulk-scan recovery validates completed artifacts before reusing them and preserves interrupted receipt bytes. Parallel workers serialize receipt writes, and publication replaces its latest receipt atomically. Completed Linear publication results remain available after late cancellation during a failed final receipt write. ([#1720](https://github.com/openai/codex-security/pull/1720), [#1748](https://github.com/openai/codex-security/pull/1748), [#1735](https://github.com/openai/codex-security/pull/1735), [#1738](https://github.com/openai/codex-security/pull/1738), [#1725](https://github.com/openai/codex-security/pull/1725))
-- Matching GitHub Action distributions publish their manifest, SBOM, and full distribution commit SHA in a companion `action-vX.Y.Z` release. Artifact upload failures propagate the original stream error and cancel active streams. ([#1711](https://github.com/openai/codex-security/pull/1711), [#1671](https://github.com/openai/codex-security/pull/1671))
-- Failed or canceled `dedupe --json --full-output` commands no longer print a false success envelope. Diff scans handle root commits in SHA-256 repositories and read blobs with Git versions older than 2.38. ([#1071](https://github.com/openai/codex-security/pull/1071), [#1716](https://github.com/openai/codex-security/pull/1716), [#1715](https://github.com/openai/codex-security/pull/1715))
-- DOCX knowledge-base extraction excludes deleted revisions and field instructions while preserving visible field results. ([#1714](https://github.com/openai/codex-security/pull/1714))
+If upgrading from before 0.4.0, upgrade CLI and plugin installations together when they share a Codex Security state directory. The shared issue-history migration preserves existing Linear receipts, but older publishers cannot write to the migrated database. ([#1426](https://github.com/openai/codex-security/pull/1426))
-</details>
+<!-- release-section: upgrades:end -->
diff --git a/.github/release-pr-state.json b/.github/release-pr-state.json
index 1d57b2fed..fb51847ba 100644
--- a/.github/release-pr-state.json
+++ b/.github/release-pr-state.json
@@ -1,13 +1,13 @@
{
- "baseVersion": "0.4.0",
- "baseCommit": "559b492b22bb457aea8ff88c1bd41aacc2cec8bf",
+ "baseVersion": "0.5.0",
+ "baseCommit": "03414ad84e91a8638bde85af08c47fe957dc9323",
"sections": {
"highlights": {
- "generatedHash": "07952b04e16a367470314af7e5b21770c4eba8b5b18088876541aaca543f61ec",
+ "generatedHash": "00960febb6fad941070c8071c18fa9d209d884b3e9e5d5f4ad264b24fe263aae",
"humanOwned": true
},
"upgrades": {
- "generatedHash": "afb441fc0f198f1c8bca468973660604d67d352a9a95c307afe16367cbb9279a",
+ "generatedHash": "f0e089f37da057fc30882ef40dfe50f6b52abdc17018bf2d70c34afb22c66fe2",
"humanOwned": true
}
}
diff --git a/examples/github-actions/codex-security.yml b/examples/github-actions/codex-security.yml
index 728d6e1ae..9df456414 100644
--- a/examples/github-actions/codex-security.yml
+++ b/examples/github-actions/codex-security.yml
@@ -32,7 +32,7 @@ jobs:
security-events: write
actions: read
env:
- CODEX_SECURITY_VERSION: "0.5.0"
+ CODEX_SECURITY_VERSION: "0.5.1"
BEDROCK_MODEL_ID: ${{ vars.BEDROCK_MODEL_ID }}
# Report-only by default. Set to "high" to fail on high/critical findings.
FAIL_ON_SEVERITY: ""
diff --git a/github-action/package-lock.json b/github-action/package-lock.json
index 2dcdceccd..66cf288d0 100644
--- a/github-action/package-lock.json
+++ b/github-action/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "codex-security-action",
- "version": "0.5.0",
+ "version": "0.5.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "codex-security-action",
- "version": "0.5.0",
+ "version": "0.5.1",
"dependencies": {
"@actions/artifact": "6.3.1",
"@actions/core": "3.0.1",
diff --git a/github-action/package.json b/github-action/package.json
index ea88a0c84..062f2fe4e 100644
--- a/github-action/package.json
+++ b/github-action/package.json
@@ -1,6 +1,6 @@
{
"name": "codex-security-action",
- "version": "0.5.0",
+ "version": "0.5.1",
"private": true,
"type": "module",
"description": "Run Codex Security in GitHub Actions with explicit scope, budgets, and scan health reporting",
diff --git a/sdk/typescript/package.json b/sdk/typescript/package.json
index 65d1bf7f6..c238f7aeb 100644
--- a/sdk/typescript/package.json
+++ b/sdk/typescript/package.json
@@ -1,6 +1,6 @@
{
"name": "@openai/codex-security",
- "version": "0.5.0",
+ "version": "0.5.1",
"description": "TypeScript SDK and CLI for Codex Security",
"license": "Apache-2.0",
"author": "OpenAI",