openrtc 1.0.1

OpenRTC: a Rust-first P2P runtime for device discovery, signaling, and iroh/QUIC networking.
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

//! Native LAN local peer discovery registry.

#![cfg(all(not(target_arch = "wasm32"), feature = "transport-lan"))]

use std::collections::HashMap;
use std::sync::Arc;

use tokio::sync::RwLock;

#[cfg(feature = "transport-lan")]
use iroh_mdns_address_lookup::{DiscoveryEvent, MdnsAddressLookup};
#[cfg(feature = "transport-lan")]
use n0_future::StreamExt;
#[cfg(feature = "transport-lan")]
use std::net::IpAddr;

/// A peer discovered on the local network via mDNS.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct LocalPeerSnapshot {
    pub node_id: String,
    pub discovered_at_ms: i64,
    pub local_reachable: bool,
}

#[derive(Clone)]
pub struct LocalDiscoveryRegistry {
    peers: Arc<RwLock<HashMap<String, LocalPeerSnapshot>>>,
}

impl LocalDiscoveryRegistry {
    pub fn new() -> Self {
        Self {
            peers: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    pub async fn list_peers(&self) -> Vec<LocalPeerSnapshot> {
        self.peers
            .read()
            .await
            .values()
            .cloned()
            .collect::<Vec<_>>()
    }

    pub async fn is_locally_reachable(&self, node_id: &str) -> bool {
        self.peers
            .read()
            .await
            .get(node_id)
            .map(|peer| peer.local_reachable)
            .unwrap_or(false)
    }

    pub async fn upsert_peer(&self, node_id: String) {
        let now = crate::firebase::now_millis_u64().min(i64::MAX as u64) as i64;
        self.peers.write().await.insert(
            node_id.clone(),
            LocalPeerSnapshot {
                node_id,
                discovered_at_ms: now,
                local_reachable: true,
            },
        );
    }

    pub async fn remove_peer(&self, node_id: &str) {
        self.peers.write().await.remove(node_id);
    }
}

impl Default for LocalDiscoveryRegistry {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(feature = "transport-lan")]
/// Returns true when the selected iroh path remote address is a private or link-local IP.
pub fn is_lan_ip_addr(addr: &std::net::SocketAddr) -> bool {
    match addr.ip() {
        IpAddr::V4(v4) => {
            v4.is_private() || v4.is_link_local() || v4.is_loopback() || v4.octets()[0] == 169
        }
        IpAddr::V6(v6) => v6.is_unique_local() || v6.is_unicast_link_local() || v6.is_loopback(),
    }
}

#[cfg(feature = "transport-lan")]
pub fn selected_path_is_direct_lan(connection: &iroh::endpoint::Connection) -> bool {
    connection.paths().iter().any(|path| {
        if !path.is_selected() || !path.is_ip() {
            return false;
        }
        matches!(path.remote_addr(), iroh::TransportAddr::Ip(addr) if is_lan_ip_addr(addr))
    })
}

#[cfg(feature = "transport-lan")]
pub fn classify_iroh_path_kind(
    connection: &iroh::endpoint::Connection,
) -> crate::client::IrohPathKind {
    let paths = connection.paths();
    let has_direct_lan = selected_path_is_direct_lan(connection);
    let has_direct = paths.iter().any(|p| p.is_selected() && p.is_ip());
    let has_relay = paths.iter().any(|p| p.is_selected() && p.is_relay());

    if has_direct_lan {
        crate::client::IrohPathKind::DirectLan
    } else if has_direct {
        crate::client::IrohPathKind::DirectQuic
    } else if has_relay {
        crate::client::IrohPathKind::Relay
    } else {
        crate::client::IrohPathKind::Unknown
    }
}

#[cfg(feature = "transport-lan")]
pub fn spawn_mdns_discovery_task(
    mdns: MdnsAddressLookup,
    registry: LocalDiscoveryRegistry,
    local_node_id: String,
) {
    tokio::spawn(async move {
        let mut events = mdns.subscribe().await;

        while let Some(event) = events.next().await {
            match event {
                DiscoveryEvent::Discovered { endpoint_info, .. } => {
                    let node_id = endpoint_info.endpoint_id.to_string();
                    if node_id == local_node_id {
                        continue;
                    }
                    registry.upsert_peer(node_id).await;
                }
                DiscoveryEvent::Expired { endpoint_id } => {
                    registry.remove_peer(&endpoint_id.to_string()).await;
                }
                _ => {}
            }
        }
    });
}

#[cfg(all(test, feature = "transport-lan"))]
mod tests {
    use super::*;

    #[test]
    fn lan_ip_classification() {
        assert!(is_lan_ip_addr(&"192.168.1.10:4433".parse().unwrap()));
        assert!(is_lan_ip_addr(&"10.0.0.5:4433".parse().unwrap()));
        assert!(is_lan_ip_addr(&"127.0.0.1:4433".parse().unwrap()));
        assert!(!is_lan_ip_addr(&"8.8.8.8:4433".parse().unwrap()));
    }
}