pub enum ClientFrame {
AuthRequest {
pubkey: PubKey,
},
AuthResponse {
signature: Signature,
},
RegisterTunnel {
label: String,
kind: TunnelKind,
resume_session_id: Option<SessionId>,
inspect: bool,
},
UnregisterTunnel {
tunnel_id: TunnelId,
},
Ping {
nonce: u64,
},
Bye,
Enroll {
admin_token: String,
pubkey: PubKey,
label_hint: Option<String>,
},
ListPeers,
}Expand description
A frame sent by the client on the Control stream.
Variants§
AuthRequest
Begin authenticated session by presenting a public key (§7.1 step 1).
AuthResponse
Sign the challenge returned by the server (§7.1 step 3).
RegisterTunnel
Register a tunnel or resume a previous session (§7.2, §7.3).
inspect opts into the server-provided passive inspection
prelude on every server-opened Data stream (§16.2). When
false the server MUST NOT emit a prelude.
UnregisterTunnel
Explicitly close a previously registered tunnel.
Ping
Application-level ping. Server echoes with the same nonce.
Bye
Graceful shutdown signal. Prevents lease resumption for open tunnels.
Enroll
Bootstrap: exchange an admin token for enrollment (§14.2).
A connection presenting this frame is treated as bootstrap-only: the server closes it immediately after enrollment succeeds or fails.
ListPeers
Ask the server for the list of federated peer relays that this identity is authorized to publish tunnels on (§16.3.3).
The response is a ServerFrame::Peers whose relays is the
intersection of the server’s static peer list (§16.3.2) and the
identity’s federation= allowlist (§16.3.1).