Expand description
Application-layer circuit directory and route selection.
This module deliberately sits in rings-node, not rings-core: Chord
remains the storage and discovery substrate, while exit policy is an
application protocol decision.
The current data plane selects route-aware circuits and exit policies, with layered
ElGamal-AEAD frames described by circuit::ONION_CIRCUIT_SECURITY.
Re-exports§
pub use route::select_onion_route;pub use route::OnionRoute;pub use route::OnionRouteHop;pub use route::OnionRouteRequest;pub use route::DEFAULT_ONION_ROUTE_HOPS;pub use target::OnionProxyTarget;pub use target::OnionProxyTargetError;
Modules§
- circuit
- Encrypted onion circuit data plane.
- https
- HTTPS onion-exit request/response adapter.
- proxy
- Client-side onion proxy planning.
- route
- Onion route selection.
- target
- Target authority parsing shared by onion policy and proxy adapters.
- tcp
- Native TCP adapter for route-aware onion circuits.
Structs§
- Native
Onion Gateway Connector - Native connector that maps one captured target to one Rings Onion TCP stream.
- Onion
Exit Descriptor - Signed descriptor published by onion exits.
- Onion
Exit Descriptor Body - Descriptor fields covered by the onion-exit signature.
- Onion
Exit Descriptor Decode Report - Result of decoding one onion-exit registry entry.
- Onion
Exit Policy - Signed policy fields for an onion exit.
- Onion
Exit Registration - Periodic node-layer registration for onion exit policy.
- Onion
Exit Service - One named service offered by an onion exit.
- Onion
Exit Target - Canonical target authority admitted by an onion exit policy.
- Onion
Service Name - Canonical onion-exit service name.
Enums§
- Onion
Exit Failure - Recoverable failure reported by an onion exit to its client.
- Onion
Exit Transport - Application transport exposed by an onion exit service.
- Onion
Route Error - Local route/circuit failure before any user-facing rendering.
Constants§
- ONION_
EXITS_ TOPIC - DHT topic used for application-layer onion exit descriptors.
- ONION_
RELAY_ CAPABILITY - Capability label for nodes willing to relay onion cells.
Functions§
- default_
onion_ exit_ policy - Default exit policy. It is intentionally closed until the operator configures targets.
- default_
onion_ exit_ services - Default native exit services. It is only published when onion-exit advertisement is enabled. HTTPS is advertised as a TCP-backed service because HTTPS proxying ultimately tunnels TLS bytes.
- https_
onion_ exit_ services - Standard HTTPS-over-TCP onion-exit service set.