docs: 0.3.0 sweep — kernel migration + verify-status gate, integration-point parity - #24
Conversation
…n-point parity across CLAUDE/README/docs End-to-end accuracy pass after the 0.3.0 release. Two themes weren't yet reflected in the long-form docs: 1. **Cryptographic primitives now delegate to the shared `ar-io-proof` kernel** (PyPI `>=0.2.0`, conformance-gated against `test-vectors-v1.0`). The plugin's `ProofEngine` is an adapter; key persistence stays plugin-owned. Old "via the `jcs` package" framing replaced with the kernel reference in CLAUDE.md, README.md, architecture.md, verification.md. 2. **`VerifyStatusClient` + the `VerifiedModel` agent verify-status gate** (Lane E shipped 0.2.x; per-predict re-check + cleanup shipped 0.3.0) are now first-class integration points alongside `anchor()` / `ArioMlflowClient` / `VerifiedModel`. README/CLAUDE bumped from "three integration points" to four; production + threat-model docs gain ops/defense sections. Per-file changes: - **CLAUDE.md** — "What this is" mentions the kernel + the agent verify-status gate. "Three integration points" → four (`VerifyStatusClient`). VerifiedModel description now covers `asset_id=`, `verify_status_client=`, `on_failure`, `recheck_per_predict`, `recheck_max_cache_age`, and the `phase` field on the structured WARN. Module layout: `proof.py` is described as a kernel adapter; `verify.py` mentions the `tx_id=` out-of-band routing pattern; new entries for `verify_status_client.py` and `errors.py`. Verification flow rephrased to note kernel-backed signature verify + the non-dict soft-fail diagnostic. Conventions add a "kernel discipline" rule (don't re-implement primitives, don't loosen the adapter to match old in-tree lenience the kernel rejects) and a "verify-status gate as a defense layer" rule. Further reading links to `docs/verified-model.md`. - **README.md** — dep list mentions `ar-io-proof`. New `#### Agent verify-status gate (runtime tamper detection)` subsection under `VerifiedModel` with the full constructor example (`recheck_per_predict=True` + `recheck_max_cache_age=15.0`), the exception-family link, and the loopback-only deployment caveat. - **docs/architecture.md** — adds a paragraph naming the `ar-io-proof` kernel as the family-contract implementation and pointing at the adapter shape. - **docs/verification.md** — top-of-doc note that the byte-level checks are kernel-backed. New `Tx-ID routing` subsection documents the `tx_id=` kwarg pattern and why the legacy `envelope["_tx_id"] = tx_id` mutation breaks on cross-product `ario.agent/v1` envelopes. - **docs/plugin-production.md** — new `Agent verify-status gate (runtime tamper detection)` subsection under CI/CD: co-location requirement (loopback-only endpoint), management-secret provisioning, the `on_failure` policy choice (`fail_closed` default vs `fail_open`-with-SIEM), and the api-guard license-503 fail-open behavior so an offline coordinator never bricks the gate. - **docs/plugin-threat-model.md** — new T1a "Deployed-file tamper (runtime)" sibling to T1's registry-file tamper. T1's `IntegrityError` covers the registry copy; T1a's verify-status gate covers the deployed copy, with the `phase`-keyed fail_open log call for SIEM as a non-bypass guarantee. Sanity-checked locally: full suite 230 passed / 21 skipped against PyPI-installed `ar-io-proof@0.2.0`. No code changes — docs only. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughDocumentation-only update across six files. Adds the ChangesDocumentation: ar-io-proof kernel, verify-status gate, and conventions
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
End-to-end accuracy sweep across CLAUDE.md, README.md, and
docs/*after the 0.3.0 release. Two themes weren't yet reflected in the long-form docs:ar-io-proofkernel (>=0.2.0, conformance-gated againsttest-vectors-v1.0). The plugin'sProofEngineis an adapter; key persistence stays plugin-owned. Old "via thejcspackage" framing replaced with the kernel reference.VerifyStatusClient+ theVerifiedModelagent verify-status gate (Lane E shipped 0.2.x; per-predict re-check + cleanup shipped 0.3.0) are now first-class integration points alongsideanchor()/ArioMlflowClient/VerifiedModel. README/CLAUDE bumped from "three integration points" to four; production + threat-model docs gain ops/defense sections.What changed (no code, docs only)
VerifyStatusClient). VerifiedModel description coversasset_id=,verify_status_client=,on_failure,recheck_per_predict,recheck_max_cache_age,phasefield. Module layout:proof.pyas adapter,verify.pymentionstx_id=out-of-band routing, newverify_status_client.py+errors.pyentries. Conventions add "kernel discipline" + "verify-status gate as defense layer" rules.ar-io-proof. New#### Agent verify-status gate (runtime tamper detection)subsection underVerifiedModelwith full constructor example + exception-family link + loopback-only caveat.ar-io-proofas the family-contract impl + adapter shape.Tx-ID routingsubsection on thetx_id=kwarg vs. legacy envelope mutation (which breaks on cross-productario.agent/v1envelopes).Agent verify-status gate (runtime tamper detection)subsection under CI/CD: co-location, secret provisioning,on_failurechoice, api-guard 503 fail-open behavior.IntegrityErrorcovers the registry copy.Test plan
ar-io-proof@0.2.0test_plugin_safety.py::test_version_matches_pyproject_tomlgreen (version pins untouched, still0.3.0)Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com
Summary by CodeRabbit