irosh 0.2.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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Iroh endpoint initialization and connection routing.

use crate::error::{Result, TransportError};
use iroh::{Endpoint, EndpointAddr, RelayConfig, RelayMode, SecretKey};

/// The base Application-Layer Protocol Negotiation (ALPN) string.
pub(crate) const BASE_ALPN: &[u8] = b"irosh/1";

/// Derives a unique ALPN for this session based on an optional shared secret.
/// If no secret is provided, the standard "irosh/1" protocol is used.
/// If a secret is provided, it is hashed to create a private stealth protocol.
pub fn derive_alpn(secret: Option<&str>) -> Vec<u8> {
    match secret {
        None => BASE_ALPN.to_vec(),
        Some(s) => {
            use sha2::{Digest, Sha256};
            let mut hasher = Sha256::new();
            hasher.update(s.as_bytes());
            let hash = hex::encode(&hasher.finalize()[..8]); // Use first 8 bytes for brevity
            format!("{}/{}", String::from_utf8_lossy(BASE_ALPN), hash).into_bytes()
        }
    }
}

#[derive(Debug, Clone)]
pub struct ServerEndpoint {
    /// The actual Iroh endpoint bound on the networking interfaces.
    pub endpoint: Endpoint,
    /// The endpoint address, used for out-of-band P2P connection sharing.
    pub addr: EndpointAddr,
    /// The unique identifier of the node (Node ID).
    pub endpoint_id: String,
    /// The list of relay server URLs this node is connected to.
    pub relay_urls: Vec<String>,
    /// The direct IP addresses this node is bound to.
    pub direct_addresses: Vec<String>,
}

/// Binds a new Iroh endpoint for the server to listen on.
pub async fn bind_server_endpoint(
    secret_key: SecretKey,
    alpns: Vec<Vec<u8>>,
    relay_mode: RelayMode,
) -> Result<ServerEndpoint> {
    let endpoint = Endpoint::builder()
        .secret_key(secret_key)
        .alpns(alpns)
        .relay_mode(relay_mode)
        .bind()
        .await
        .map_err(|source| TransportError::EndpointBind { source })?;

    // Wait until the node finishes initial networking setup and is online.
    // Timeout prevents blocking forever if relays are unreachable.
    let _ = tokio::time::timeout(std::time::Duration::from_secs(10), endpoint.online()).await;

    let endpoint_addr = endpoint.addr();
    let node_id = endpoint.id();

    let direct_addresses = endpoint_addr
        .ip_addrs()
        .map(|addr| addr.to_string())
        .collect::<Vec<_>>();
    let relay_urls = endpoint_addr
        .relay_urls()
        .map(|url| url.to_string())
        .collect::<Vec<_>>();

    Ok(ServerEndpoint {
        endpoint_id: node_id.to_string(),
        endpoint,
        addr: endpoint_addr,
        relay_urls,
        direct_addresses,
    })
}

/// Binds a new Iroh endpoint for a client connection.
pub async fn bind_client_endpoint(
    secret_key: SecretKey,
    alpns: Vec<Vec<u8>>,
    relay_mode: RelayMode,
) -> Result<Endpoint> {
    let endpoint = Endpoint::builder()
        .secret_key(secret_key)
        .alpns(alpns)
        .relay_mode(relay_mode)
        .bind()
        .await
        .map_err(|source| TransportError::EndpointBind { source })?;

    // Wait until the node finishes initial networking setup and is online.
    // Timeout prevents blocking forever if relays are unreachable.
    let _ = tokio::time::timeout(std::time::Duration::from_secs(10), endpoint.online()).await;
    Ok(endpoint)
}

/// Parses a relay string into an Iroh `RelayMode`.
///
/// Supported formats:
/// - "disabled": Disables relaying entirely.
/// - "default": Uses the default Iroh relay servers.
/// - Any valid URL: Uses a custom relay server at that address.
pub fn parse_relay_mode(url: &str) -> Result<RelayMode> {
    match url {
        "disabled" => Ok(RelayMode::Disabled),
        "default" => Ok(RelayMode::Default),
        u if u.starts_with("http") => {
            let url: iroh::RelayUrl = u
                .parse()
                .map_err(|_| TransportError::InvalidRelayUrl { url: u.to_string() })?;
            Ok(RelayMode::Custom(RelayConfig::from(url).into()))
        }
        _ => Ok(RelayMode::Default),
    }
}