Repository navigation
fix(ocsf): validate sandbox attribution against exported schemas - #5048
Conversation
Move supervisor attribution to device.container and gateway attribution to resources or unmapped. Remove the top-level container validation exemption and cover exported schemas, gateway profiles, and runtime JSONL attribution. Refs NVIDIA#4915 Signed-off-by: Louis Deng <louisaeilotd@gmail.com>
Port resolved Docker and Podman image identity to the exported-schema implementation. Preserve upstream network trust helpers, validate complete image-bearing events, and assert the actual workload image identity in supervisor JSONL conformance. Refs NVIDIA#4915 Signed-off-by: Louis Deng <louisaeilotd@gmail.com>
Merge upstream dependency security fixes and Go SDK routing updates before review. Validate OCSF regressions, gateway SPIFFE JWT verification, and Docker/Podman end-to-end behavior against the synchronized tree. Refs NVIDIA#4915 Signed-off-by: Louis Deng <louisaeilotd@gmail.com>
|
All contributors have signed the DCO ✍️ ✅ |
|
I have read the DCO document and I hereby sign the DCO. |
|
recheck |
|
@aeilot Let's get those merge conflicts resolved and I can kick off CI for it. |
Sure, I'll do that. |
Signed-off-by: Louis Deng <louisaeilotd@gmail.com>
|
@krishicks The merge conflicts have now been resolved. You can start the CI. |
|
/ok to test 0e08ac2 |
Compatibility review (advisory)New or updated breaking changes; see the full report for all findings. 1. api-behavior — No explicit risk acceptance foundTop-level container.uid and container.name move to device.container for supervisor records and resources or unmapped for gateway records.
2. api-behavior — No explicit risk acceptance foundKubernetes supervisor records previously emitted container.image.name for known image references but now omit the entire image object without a resolved image UID.
Review details
Advisory review; publication gates are unchanged. |
|
Written by Claude Code, reviewed by @krishicks Thanks for this, the supervisor side looks right: 1. Gateway attribution must not route on request-supplied sandbox IDs. Routing should only use identity that came from 2. Keep the image reference when no UID is available. 3. Smaller items.
We'll handle the XSIAM content pack notification before this ships. |
|
Thanks for the review. I’ll make the following changes before requesting another review:
The compatibility advisory will still need an explicit release decision: preserving the image reference prevents information loss, but existing parsers still need to migrate from the legacy field paths. Could you record whether that migration is accepted for v0.1.7 or should move to a later release? Thanks for handling the XSIAM content pack notification before shipping. |
Signed-off-by: Louis Deng <louisaeilotd@gmail.com>
|
Thanks for the detailed review. I’ve pushed the changes in fea7613. Thanks for coordinating the XSIAM content pack notification |
|
/ok to test fea7613 |
OpenShell after v0.1.7 (NVIDIA/OpenShell#5048) moves supervisor sandbox identity from the top-level container object to device.container. The hydrator read only the top-level field, so every record from an upgraded supervisor was unmapped. Prefer device.container and fall back to the top-level container so mixed fleets keep attributing during upgrades. Fixes #23 Signed-off-by: chou-godaddy <chou@godaddy.com> Co-authored-by: Keith Perry <80783921+kperry-godaddy@users.noreply.github.com>
Moves NemoClaw's OpenShell pins from v0.1.7 to v0.1.8: the native CLI, the gateway, supervisor and sandbox images, the gateway chart, the OpenShell crates, and the vendored SDK. Deployments built from this revision run OpenShell v0.1.8, which no longer waits out a Kubernetes sandbox pod's termination grace period on delete and renews client-credentials tokens in the CLI. ## Problem NemoClaw pins OpenShell v0.1.7 (`5d25211`). v0.1.8 (`f3d9765`, 80 commits later) is the latest release. Among its fixes: - deleting a sandbox on Kubernetes no longer waits out the pod's 30-second termination grace period (NVIDIA/OpenShell#5279), which every Kubernetes destroy and sandbox replacement paid (NVIDIA/OpenShell#5025); - the CLI renews an expired client-credentials token by repeating the grant (NVIDIA/OpenShell#4389, closing NVIDIA/OpenShell#4287), a limit our Kubernetes guide and GPU autoscaling example documented; - deleted sandboxes no longer leave memory behind on the gateway (NVIDIA/OpenShell#5428). ## Change - **Pins:** the Cargo revision of `openshell-core`, `openshell-sdk` and `openshell-policy`, and of the vendored SDK's `openshell-core` and `openshell-crypto`; in `versions.json`, the version, revision, Linux CLI archives, gateway, supervisor and sandbox images, and gateway chart; the managed-gateway reference, a contract test and the gateway contract module, which carry the gateway digest. The CLI checksums come from the release's `openshell-checksums-sha256.txt` and match the downloaded archives; the image and chart digests come from GHCR's `0.1.8` tags, and GHCR's `0.1.7` tags match the previous pins. - **Vendored SDK:** upstream changed only `src/client.rs` (a new `auth_interceptor()` accessor), copied unchanged. The SDK manifest still enables core telemetry, so the manifest patch stays; `NOTICE.md` records the refresh. `Cargo.lock` changes only the five OpenShell crates' revision. - **SDK integration limits:** the table in `internal-docs/design/architecture.md` still holds at v0.1.8 and now cites that revision. - **`websocket_credential_rewrite`:** OpenShell now rejects it on a `rest` endpoint (NVIDIA/OpenShell#5336), through the `openshell-policy` validation NemoClaw already runs on explicit policies. The field's description says it needs `protocol: websocket`; the JSON Schema, configuration reference and provider schema snapshot are regenerated. - **Live / Kind budgets:** with v0.1.8 the two kind cases take about 35-40 s less each: 98-108 s and 62-70 s on this pull request's runs, against 138-143 s and 94-100 s on recent `v1` runs. The per-test budget and the `live-kind` slow-timeout drop from 180 s to 140 s, and the step's wall budget from 300 s to 240 s. - **Limits removed:** the Kubernetes guide and the GPU autoscaling example no longer tell readers to sign in again when a client-credentials token expires; they say to keep `OPENSHELL_OIDC_CLIENT_SECRET` set. - **Release notes** list the new pin, the fixes above, and the policy changes that can stop an existing explicit policy: `websocket_credential_rewrite` on `rest`, filesystem paths through a symlink in a writable workspace (NVIDIA/OpenShell#5278), and IPv4-mapped IPv6 endpoint hosts (NVIDIA/OpenShell#5101). Resolves #13959. ## Upgrade notes checked - **Static credential placement** (NVIDIA/OpenShell#4886): every profile NemoClaw registers (inference, `api` integrations, Brave and Tavily search) already declares `auth_style` and `header_name`, including Anthropic's `x-api-key` and Brave's `X-Subscription-Token`, so their credentials keep resolving. - **OCSF attribution** (NVIDIA/OpenShell#5048): NemoClaw reads no OCSF records. - **SDK moves:** the Python and Go SDK changes don't apply; NemoClaw uses the Rust SDK. - **Gateway interceptors** (NVIDIA/OpenShell#5173): NemoClaw registers none. - **Chart:** v0.1.8 adds optional `metrics.tls`, `priorityClassName` and `topologySpreadConstraints`; NemoClaw sets none of them. NVIDIA/OpenShell#5478, which would replace the `metricsPort: 0` setting, isn't in v0.1.8, so that setting stays. - **User guide:** apart from the lines above, `docs/` still describes NemoClaw `637bdb6` and its OpenShell 0.1.7 links; moving them belongs to the next guide refresh. --------- Signed-off-by: Carlos Villela <cvillela@nvidia.com>
…0.1.8 (#31) The device.container test data came from an OpenShell dev build because no release included NVIDIA/OpenShell#5048 yet. v0.1.8 is the first release that does, so replace the capture with unedited records from its supervisor. Fixes #25 Signed-off-by: chou-godaddy <chou@godaddy.com> Co-authored-by: Connor Snitker <csnitker@godaddy.com>
Move supervisor attribution to device.container and gateway attribution to resources or unmapped. Remove the top-level container validation exemption and cover exported schemas, gateway profiles, and runtime JSONL attribution.
Refs #4915
Signed-off-by: Louis Deng louisaeilotd@gmail.com
Summary
Fix sandbox-associated OCSF records being rejected by strict OCSF 1.8.0 consumers because of the undefined top-level
containerattribute. Preserve sandbox identity in schema-defined fields and validate the complete records without a container exemption.Related Issue
Closes #4915
Changes
device.containerand declare thecontainerprofile.device. Use sandboxresourcesentries for API Activity and Detection Finding, andunmappedfor other applicable gateway classes. Authentication records do not attach a sandbox container.image.uidfrom the resolved workload image ID, retaining the requested reference inimage.name. Omitimagewhen no resolved UID is available.containerallowance fromopenshell-ocsf-validate, following the validator replacement in feat(ocsf): validate OCSF events against exported JSON Schemas #5019.Kubernetes image enrichment remains a follow-up, as agreed in the issue. Kubernetes records omit
imagewhile retaining sandbox identity.Release Notes
Sandbox attribution paths have changed:
device.container.uidanddevice.container.name.resourcesentries withtype: "sandbox".unmapped.sandbox_idandunmapped.sandbox_name.SIEM parsers using top-level
container.uidorcontainer.namemust update their mappings.The new shape is finalized for review. As discussed in the issue, maintainers will coordinate with the XSIAM content pack maintainer before shipping; that notification remains outstanding.
Testing
After synchronizing with upstream main:
ocsf_consolepassed using rebuilt runtime images.ocsf_jsonl_conformancepassed, validating real supervisor JSONL, sandbox attribution, and the resolved workload image UID.Thirty synthetic records also passed the official OCSF 1.8 validator with zero errors. This online validation is separate from the real JSONL validation performed by the Podman E2E test.
Documentation validation reported zero errors and three warnings: MDX parsing on the unchanged gateway configuration page, redirect checking skipped without authentication, and theme contrast.
Checklist