irosh 0.1.0

SSH sessions over Iroh peer-to-peer transport
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Session state types shared by the client and CLI layers.

/// The lifecycle state of an irosh client session.
///
/// This state model intentionally includes both connection-attempt phases and
/// active-session phases so the library can classify failures and successful
/// transitions with the same vocabulary.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum SessionState {
    /// A connection attempt has started but transport is not yet established.
    Dialing,
    /// The Iroh transport connection is established.
    TransportConnected,
    /// The SSH layer is negotiating and authenticating.
    SshHandshaking,
    /// SSH authentication succeeded and a session channel is open.
    Authenticated,
    /// The remote shell has been requested and the session is ready for I/O.
    ShellReady,
    /// The connection attempt failed because the remote rejected authentication.
    AuthRejected,
    /// The connection attempt failed because the remote host key mismatched trust state.
    TrustMismatch,
    /// The session is closed locally or remotely.
    Closed,
}

impl SessionState {
    /// Returns whether this state terminates the current session lifecycle.
    pub fn is_terminal(self) -> bool {
        matches!(
            self,
            SessionState::AuthRejected | SessionState::TrustMismatch | SessionState::Closed
        )
    }
}