Skip to content

videre-host: document handshake admission boundaries - #533

Merged
mfw78 merged 1 commit into
dev/m1from
docs/519-handshake-admission-boundaries
Jul 23, 2026
Merged

videre-host: document handshake admission boundaries#533
mfw78 merged 1 commit into
dev/m1from
docs/519-handshake-admission-boundaries

Conversation

@mfw78

@mfw78 mfw78 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

What

Doc-only change in crates/videre-host recording two admission-boundary facts that the code already enforces but did not spell out.

handshake.rs: a terse "Opt-in" rustdoc line on both admit_provider and admit_worker stating that a manifest omitting [venue] is admitted unconditionally, an intentional silent opt-out for non-venue keepers.

registry.rs: a comment before verify_exported_versions (after VenueAdapter::instantiate_async) noting it runs post-instantiation, pre-init, so unlike the pre-compile manifest-section predicates in supervisor.rs a buggy or malicious adapter fully instantiates, running any instantiation side effects, before this divergence check catches the mismatch.

No code behaviour changed.

Why

Both boundaries are load-bearing but non-obvious. The vacuous admit on absent [venue] reads like a missing check rather than a deliberate opt-out, and the export-divergence check's ordering relative to instantiation determines whether adapter side effects can run before the mismatch is caught. Documenting them in place keeps the security-relevant intent next to the code that realizes it.

Testing

cargo fmt --all -- --check clean, and cargo clippy -p videre-host --all-targets --all-features -- -D warnings clean after a cold rebuild of the crate. Both run under nix develop (rustc 1.94.0). The vacuous opt-out is backed by the existing undeclared_sections_are_admitted test; the ordering note matches verify_exported_versions running after instantiate_async and before call_init.

AI Assistance

Implemented, reviewed and verified with Claude Code (Opus).

Closes #519

@mfw78
mfw78 force-pushed the docs/519-handshake-admission-boundaries branch from 3a38002 to 774fbaa Compare July 23, 2026 14:15
@mfw78
mfw78 changed the base branch from feat/m5-pre-carve-runbook to dev/m1 July 23, 2026 14:15
Document the opt-in precondition on admit_worker/admit_provider (a
manifest omitting [venue] is admitted unconditionally) and the
post-instantiation, pre-init ordering of the registry export-divergence
check.
@mfw78
mfw78 force-pushed the docs/519-handshake-admission-boundaries branch from 774fbaa to 654d37d Compare July 23, 2026 14:52
@mfw78
mfw78 merged commit a5573a3 into dev/m1 Jul 23, 2026
7 checks passed
@mfw78
mfw78 deleted the docs/519-handshake-admission-boundaries branch July 23, 2026 23:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant