Expand description
Provider-neutral OpenRTC 2.0 control-plane client for pure native hosts.
Consumer applications own authentication, attestation registration, and secure private-key storage. OpenRTC owns assertion exchange, device enrollment, avenue-scoped gateway grants, renewal, and replay-safe device proofs. No Firebase type or project identifier is exposed by this module.
Structs§
- Anonymous
Capability - A backend-free native capability. Its install-bound principal and device identity come from the host-secure Ed25519 key, and the handle owns exactly one live avenue.
- Attestation
Evidence - Capability
Options - Control
Plane - Control
Plane Http Error - Credential
Relay - Mutable opaque-credential relay for native runtimes constructed before the application finishes login. It carries only OpenRTC-issued device certificates and follows certificate renewal performed by the grant owner.
- Device
Options - Device
Profile - Public presentation metadata for one enrolled native installation.
- Devices
- An authenticated device-mesh capability plus its stable app-scoped
principal. The handle remains network-idle until the runtime publishes its
initial presence, and
close()stops its socket and grant-refresh owner. - Features
- File
Signer - Persistent software signer, with no OS keychain prompt. Supports Unix
private directories (including macOS/Linux and native mobile sandboxes).
Other hosts can implement
DeviceSigner/OfflineSignerwith their store. - Identity
Assertion - InMemory
Certificate - Network-idle, process-local certificate cache for prototypes and tests. Production native applications should supply durable protected storage.
- Native
Authority Assignment - Native
Authority Interest Assignment - Signed, application-owned AOI/interest assignment delivered by the room authority. OpenRTC validates its bounded wire shape and uses it only as a routing input; the application remains the owner of entity semantics.
- Native
Capabilities - Lightweight, network-idle entrypoint for pure-Rust OpenRTC 2.0 capability activation. It mirrors the public SDK namespaces without putting consumer authentication, attestation, or provider-specific types into the runtime.
- Native
Capability Handle - Disposable OpenRTC 2.0 native avenue.
- Native
Gateway Grant - Native
Gateway Grant Request - Native
Service Error Observation - A historical, capability-local service denial observation. This is a diagnostic projection only; it does not authorize recovery or change gateway retry policy.
- Relay
Availability - Room
Architecture Snapshot - Customer-safe room policy projection delivered by the avenue gateway.
- Room
Authority - One connected developer authority capability. It uses the same native gateway and Rust peer-session owner as every other room; it adds only the signed AOI assignment permission carried by its server-minted grant.
- Room
Authority Options - Developer-backend-only configuration for one authoritative room replica. The service grant is bound to this replica’s device signer; the separate assignment signer can be shared by equivalent replicas after an application-owned state handoff.
- Room
Options - Signaling
Slot - One-time, fail-closed signaling installation point for native hosts whose process is created before user authentication completes. Installation may happen exactly once; replacement requires closing and rebuilding the capability/runtime so this cannot become a shadow lifecycle owner.
- Stored
Certificate
Enums§
- Effective
Room Architecture - Native
Capability Kind - Room
Architecture Mode - Room
Architecture Phase - Room
Architecture Reason - Room
Delivery
Constants§
Traits§
- Assertion
Provider - Application-owned source of short-lived OIDC/JWKS assertions.
- Attestation
Provider - Optional application-owned managed-attestation bridge. It is invoked only during enrollment or certificate renewal, never as a socket heartbeat.
- Certificate
Store - Application-owned durable certificate storage. Desktop applications should protect this value with owner-only file permissions or the OS credential store. A certificate is public-key bound, but remains bearer authorization and therefore must not be placed in logs or world-readable preferences.
- Device
Signer - Host secure-storage bridge for the per-install Ed25519 device key. Private key bytes never enter the OpenRTC runtime.
- Native
Gateway Grant Provider
Functions§
- load_
or_ create_ endpoint_ key - Reopen the device’s private Iroh identity at process construction. Pass it directly to the native endpoint initializer; never return it through IPC.