Skip to main content

fips_core/node/
core_impl.rs

1use super::*;
2
3impl Node {
4    fn new_dataplane_node() -> DataplaneNode {
5        DataplaneLiveNode::new(AdmissionConfig::new(
6            1024,
7            FIPS_ENDPOINT_DIRECT_PACKET_QUEUE_MAX_PACKETS,
8        ))
9    }
10
11    /// Create a new node from configuration.
12    pub fn new(config: Config) -> Result<Self, NodeError> {
13        config.validate()?;
14        let identity = config.create_identity()?;
15        let node_addr = *identity.node_addr();
16        let is_leaf_only = config.is_leaf_only();
17
18        let mut startup_epoch = [0u8; 8];
19        rand::rng().fill_bytes(&mut startup_epoch);
20
21        let mut bloom_state = if is_leaf_only {
22            BloomState::leaf_only(node_addr)
23        } else {
24            BloomState::new(node_addr)
25        };
26        bloom_state.set_update_debounce_ms(config.node.bloom.update_debounce_ms);
27
28        let tun_state = if config.tun.enabled {
29            TunState::Configured
30        } else {
31            TunState::Disabled
32        };
33
34        // Initialize tree state with signed self-declaration
35        let mut tree_state = TreeState::new(node_addr);
36        tree_state.set_parent_hysteresis(config.node.tree.parent_hysteresis);
37        tree_state.set_hold_down(config.node.tree.hold_down_secs);
38        tree_state.set_flap_dampening(
39            config.node.tree.flap_threshold,
40            config.node.tree.flap_window_secs,
41            config.node.tree.flap_dampening_secs,
42        );
43        tree_state
44            .sign_declaration(&identity)
45            .expect("signing own declaration should never fail");
46
47        let coord_cache = CoordCache::new(
48            config.node.cache.coord_size,
49            config.node.cache.coord_ttl_secs * 1000,
50        );
51        let rl = &config.node.rate_limit;
52        let msg1_rate_limiter = HandshakeRateLimiter::with_params(
53            rate_limit::TokenBucket::with_params(rl.handshake_burst, rl.handshake_rate),
54            config.node.limits.max_pending_inbound,
55        );
56
57        let max_connections = config.node.limits.max_connections;
58        let max_peers = config.node.limits.max_peers;
59        let max_links = config.node.limits.max_links;
60        let coords_response_interval_ms = config.node.session.coords_response_interval_ms;
61        let backoff_base_secs = config.node.discovery.backoff_base_secs;
62        let backoff_max_secs = config.node.discovery.backoff_max_secs;
63        let forward_min_interval_secs = config.node.discovery.forward_min_interval_secs;
64
65        let (host_map, peer_acl) = Self::host_map_and_peer_acl(&config);
66        let configured_peers = ConfiguredPeerLookup::from_config(&config);
67
68        Ok(Self {
69            identity,
70            startup_epoch,
71            started_at: std::time::Instant::now(),
72            config,
73            state: NodeState::Created,
74            is_leaf_only,
75            tree_state,
76            bloom_state,
77            coord_cache,
78            learned_routes: LearnedRouteTable::default(),
79            session_direct_degradation: SessionDirectDegradation::default(),
80            recent_requests: RecentDiscoveryRequests::default(),
81            transports: HashMap::new(),
82            transport_drops: TransportDropTracker::default(),
83            transport_socket_drops: TransportDropTracker::default(),
84            transport_namespace_drops: TransportDropTracker::default(),
85            links: LinkRegistry::default(),
86            packet_tx: None,
87            packet_rx: None,
88            dataplane: Self::new_dataplane_node(),
89            deferred_dataplane_control_turns: VecDeque::new(),
90            deferred_session_forwards: Default::default(),
91            dataplane_fast_ingress_rx: None,
92            dataplane_direct_fsp_sources: Arc::new(HashMap::new()),
93            dataplane_direct_fsp_sources_dirty: true,
94            dataplane_transport_send_batch_packets: DATAPLANE_TRANSPORT_SEND_BATCH_PACKETS,
95            peers: PeerLifecycleRegistry::default(),
96            sessions: SessionRegistry::default(),
97            identity_cache: IdentityCache::default(),
98            pending_session_traffic: PendingSessionTrafficQueues::default(),
99            pending_lookups: handlers::discovery::PendingDiscoveryLookups::default(),
100            max_connections,
101            max_peers,
102            max_links,
103            next_link_id: 1,
104            next_transport_id: 1,
105            stats: stats::NodeStats::new(),
106            stats_history: stats_history::StatsHistory::new(),
107            tun_state,
108            tun_name: None,
109            tun_tx: None,
110            tun_outbound_rx: None,
111            external_packet_tx: None,
112            endpoint_control_rx: None,
113            endpoint_data_rx: None,
114            endpoint_events: EndpointEventRuntime::default(),
115            endpoint_services: EndpointServiceRuntime::default(),
116            tun_reader_handle: None,
117            tun_writer_handle: None,
118            #[cfg(target_os = "macos")]
119            tun_shutdown_fd: None,
120            dns_identity_rx: None,
121            dns_task: None,
122            index_allocator: IndexAllocator::new(),
123            pending_outbound: PendingOutboundHandshakes::default(),
124            msg1_rate_limiter,
125            icmp_rate_limiter: IcmpRateLimiter::new(),
126            routing_error_rate_limiter: RoutingErrorRateLimiter::new(),
127            coords_response_rate_limiter: RoutingErrorRateLimiter::with_interval(
128                std::time::Duration::from_millis(coords_response_interval_ms),
129            ),
130            discovery_backoff: DiscoveryBackoff::with_params(backoff_base_secs, backoff_max_secs),
131            discovery_forward_limiter: DiscoveryForwardRateLimiter::with_interval(
132                std::time::Duration::from_secs(forward_min_interval_secs),
133            ),
134            pending_connects: Vec::new(),
135            retry_pending: retry::PendingRouteRetries::default(),
136            nostr_discovery: None,
137            nostr_discovery_started_at_ms: None,
138            lan_discovery: None,
139            local_instance_registry: None,
140            local_instance_started_at_ms: None,
141            last_local_instance_publish_ms: None,
142            last_local_instance_scan_ms: None,
143            startup_open_discovery_sweep_done: false,
144            bootstrap_transports: BootstrapTransports::default(),
145            discovery_fallback_transit: DiscoveryFallbackTransit::default(),
146            last_parent_reeval: None,
147            last_congestion_log: None,
148            estimated_mesh_size: None,
149            last_mesh_size_log: None,
150            last_self_warn: None,
151            local_send_failures: LocalSendFailures::default(),
152            last_rx_loop_maintenance_timeout_at: None,
153            peer_aliases: HashMap::new(),
154            configured_peers,
155            peer_acl,
156            host_map,
157            path_mtu_lookup: Arc::new(std::sync::RwLock::new(HashMap::new())),
158        })
159    }
160
161    /// Create a node with a specific identity.
162    ///
163    /// This constructor validates cross-field config invariants before
164    /// constructing the node, same as [`Node::new`].
165    pub fn with_identity(identity: Identity, config: Config) -> Result<Self, NodeError> {
166        config.validate()?;
167        let node_addr = *identity.node_addr();
168
169        let mut startup_epoch = [0u8; 8];
170        rand::rng().fill_bytes(&mut startup_epoch);
171
172        let tun_state = if config.tun.enabled {
173            TunState::Configured
174        } else {
175            TunState::Disabled
176        };
177
178        // Initialize tree state with signed self-declaration
179        let mut tree_state = TreeState::new(node_addr);
180        tree_state.set_parent_hysteresis(config.node.tree.parent_hysteresis);
181        tree_state.set_hold_down(config.node.tree.hold_down_secs);
182        tree_state.set_flap_dampening(
183            config.node.tree.flap_threshold,
184            config.node.tree.flap_window_secs,
185            config.node.tree.flap_dampening_secs,
186        );
187        tree_state
188            .sign_declaration(&identity)
189            .expect("signing own declaration should never fail");
190
191        let mut bloom_state = BloomState::new(node_addr);
192        bloom_state.set_update_debounce_ms(config.node.bloom.update_debounce_ms);
193
194        let coord_cache = CoordCache::new(
195            config.node.cache.coord_size,
196            config.node.cache.coord_ttl_secs * 1000,
197        );
198        let rl = &config.node.rate_limit;
199        let msg1_rate_limiter = HandshakeRateLimiter::with_params(
200            rate_limit::TokenBucket::with_params(rl.handshake_burst, rl.handshake_rate),
201            config.node.limits.max_pending_inbound,
202        );
203
204        let max_connections = config.node.limits.max_connections;
205        let max_peers = config.node.limits.max_peers;
206        let max_links = config.node.limits.max_links;
207        let coords_response_interval_ms = config.node.session.coords_response_interval_ms;
208
209        let (host_map, peer_acl) = Self::host_map_and_peer_acl(&config);
210        let configured_peers = ConfiguredPeerLookup::from_config(&config);
211
212        Ok(Self {
213            identity,
214            startup_epoch,
215            started_at: std::time::Instant::now(),
216            config,
217            state: NodeState::Created,
218            is_leaf_only: false,
219            tree_state,
220            bloom_state,
221            coord_cache,
222            learned_routes: LearnedRouteTable::default(),
223            session_direct_degradation: SessionDirectDegradation::default(),
224            recent_requests: RecentDiscoveryRequests::default(),
225            transports: HashMap::new(),
226            transport_drops: TransportDropTracker::default(),
227            transport_socket_drops: TransportDropTracker::default(),
228            transport_namespace_drops: TransportDropTracker::default(),
229            links: LinkRegistry::default(),
230            packet_tx: None,
231            packet_rx: None,
232            dataplane: Self::new_dataplane_node(),
233            deferred_dataplane_control_turns: VecDeque::new(),
234            deferred_session_forwards: Default::default(),
235            dataplane_fast_ingress_rx: None,
236            dataplane_direct_fsp_sources: Arc::new(HashMap::new()),
237            dataplane_direct_fsp_sources_dirty: true,
238            dataplane_transport_send_batch_packets: DATAPLANE_TRANSPORT_SEND_BATCH_PACKETS,
239            peers: PeerLifecycleRegistry::default(),
240            sessions: SessionRegistry::default(),
241            identity_cache: IdentityCache::default(),
242            pending_session_traffic: PendingSessionTrafficQueues::default(),
243            pending_lookups: handlers::discovery::PendingDiscoveryLookups::default(),
244            max_connections,
245            max_peers,
246            max_links,
247            next_link_id: 1,
248            next_transport_id: 1,
249            stats: stats::NodeStats::new(),
250            stats_history: stats_history::StatsHistory::new(),
251            tun_state,
252            tun_name: None,
253            tun_tx: None,
254            tun_outbound_rx: None,
255            external_packet_tx: None,
256            endpoint_control_rx: None,
257            endpoint_data_rx: None,
258            endpoint_events: EndpointEventRuntime::default(),
259            endpoint_services: EndpointServiceRuntime::default(),
260            tun_reader_handle: None,
261            tun_writer_handle: None,
262            #[cfg(target_os = "macos")]
263            tun_shutdown_fd: None,
264            dns_identity_rx: None,
265            dns_task: None,
266            index_allocator: IndexAllocator::new(),
267            pending_outbound: PendingOutboundHandshakes::default(),
268            msg1_rate_limiter,
269            icmp_rate_limiter: IcmpRateLimiter::new(),
270            routing_error_rate_limiter: RoutingErrorRateLimiter::new(),
271            coords_response_rate_limiter: RoutingErrorRateLimiter::with_interval(
272                std::time::Duration::from_millis(coords_response_interval_ms),
273            ),
274            discovery_backoff: DiscoveryBackoff::new(),
275            discovery_forward_limiter: DiscoveryForwardRateLimiter::new(),
276            pending_connects: Vec::new(),
277            retry_pending: retry::PendingRouteRetries::default(),
278            nostr_discovery: None,
279            nostr_discovery_started_at_ms: None,
280            lan_discovery: None,
281            local_instance_registry: None,
282            local_instance_started_at_ms: None,
283            last_local_instance_publish_ms: None,
284            last_local_instance_scan_ms: None,
285            startup_open_discovery_sweep_done: false,
286            bootstrap_transports: BootstrapTransports::default(),
287            discovery_fallback_transit: DiscoveryFallbackTransit::default(),
288            last_parent_reeval: None,
289            last_congestion_log: None,
290            estimated_mesh_size: None,
291            last_mesh_size_log: None,
292            last_self_warn: None,
293            local_send_failures: LocalSendFailures::default(),
294            last_rx_loop_maintenance_timeout_at: None,
295            peer_aliases: HashMap::new(),
296            configured_peers,
297            peer_acl,
298            host_map,
299            path_mtu_lookup: Arc::new(std::sync::RwLock::new(HashMap::new())),
300        })
301    }
302
303    /// Create a leaf-only node (simplified state).
304    pub fn leaf_only(config: Config) -> Result<Self, NodeError> {
305        let mut node = Self::new(config)?;
306        node.is_leaf_only = true;
307        node.bloom_state = BloomState::leaf_only(*node.identity.node_addr());
308        Ok(node)
309    }
310
311    pub(super) fn host_map_and_peer_acl(config: &Config) -> (Arc<HostMap>, acl::PeerAclReloader) {
312        let base_host_map = HostMap::from_peer_configs(config.peers());
313        if !config.node.system_files_enabled {
314            return (
315                Arc::new(base_host_map.clone()),
316                acl::PeerAclReloader::memory_only(base_host_map),
317            );
318        }
319
320        let mut host_map = base_host_map.clone();
321        let hosts_path = std::path::PathBuf::from(crate::upper::hosts::DEFAULT_HOSTS_PATH);
322        let hosts_file = HostMap::load_hosts_file(std::path::Path::new(
323            crate::upper::hosts::DEFAULT_HOSTS_PATH,
324        ));
325        host_map.merge(hosts_file);
326        let peer_acl = acl::PeerAclReloader::with_alias_sources(
327            std::path::PathBuf::from(acl::DEFAULT_PEERS_ALLOW_PATH),
328            std::path::PathBuf::from(acl::DEFAULT_PEERS_DENY_PATH),
329            base_host_map,
330            hosts_path,
331        );
332        (Arc::new(host_map), peer_acl)
333    }
334
335    /// Create transport instances from configuration.
336    ///
337    /// Returns a vector of TransportHandles for all configured transports.
338    pub(super) async fn create_transports(&mut self, packet_tx: &PacketTx) -> Vec<TransportHandle> {
339        let mut transports = Vec::new();
340
341        // Collect UDP configs with optional names to avoid borrow conflicts
342        let udp_instances: Vec<_> = self
343            .config
344            .transports
345            .udp
346            .iter()
347            .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
348            .collect();
349
350        // Create UDP transport instances
351        for (name, udp_config) in udp_instances {
352            let transport_id = self.allocate_transport_id();
353            let udp = UdpTransport::new(transport_id, name, udp_config, packet_tx.clone());
354            transports.push(TransportHandle::Udp(udp));
355        }
356
357        #[cfg(feature = "sim-transport")]
358        {
359            let sim_instances: Vec<_> = self
360                .config
361                .transports
362                .sim
363                .iter()
364                .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
365                .collect();
366
367            for (name, sim_config) in sim_instances {
368                let transport_id = self.allocate_transport_id();
369                let sim = crate::transport::sim::SimTransport::new(
370                    transport_id,
371                    name,
372                    sim_config,
373                    packet_tx.clone(),
374                );
375                transports.push(TransportHandle::Sim(sim));
376            }
377        }
378
379        // Create Ethernet transport instances where raw-socket support exists.
380        #[cfg(any(target_os = "linux", target_os = "macos"))]
381        {
382            let eth_instances: Vec<_> = self
383                .config
384                .transports
385                .ethernet
386                .iter()
387                .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
388                .collect();
389            let xonly = self.identity.pubkey();
390            for (name, eth_config) in eth_instances {
391                let mut eth_config = eth_config;
392                if eth_config.discovery_scope.is_none() {
393                    eth_config.discovery_scope = self.lan_discovery_scope();
394                }
395                let transport_id = self.allocate_transport_id();
396                let mut eth =
397                    EthernetTransport::new(transport_id, name, eth_config, packet_tx.clone());
398                eth.set_local_pubkey(xonly);
399                transports.push(TransportHandle::Ethernet(eth));
400            }
401        }
402
403        // Create TCP transport instances
404        let tcp_instances: Vec<_> = self
405            .config
406            .transports
407            .tcp
408            .iter()
409            .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
410            .collect();
411
412        for (name, tcp_config) in tcp_instances {
413            let transport_id = self.allocate_transport_id();
414            let tcp = TcpTransport::new(transport_id, name, tcp_config, packet_tx.clone());
415            transports.push(TransportHandle::Tcp(tcp));
416        }
417
418        // Create Tor transport instances
419        let tor_instances: Vec<_> = self
420            .config
421            .transports
422            .tor
423            .iter()
424            .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
425            .collect();
426
427        for (name, tor_config) in tor_instances {
428            let transport_id = self.allocate_transport_id();
429            let tor = TorTransport::new(transport_id, name, tor_config, packet_tx.clone());
430            transports.push(TransportHandle::Tor(tor));
431        }
432
433        let webrtc_instances: Vec<_> = self
434            .config
435            .transports
436            .webrtc
437            .iter()
438            .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
439            .collect();
440
441        #[cfg(feature = "webrtc-transport")]
442        {
443            for (name, webrtc_config) in webrtc_instances {
444                let transport_id = self.allocate_transport_id();
445                match WebRtcTransport::new(
446                    transport_id,
447                    name,
448                    webrtc_config,
449                    packet_tx.clone(),
450                    &self.identity,
451                    &self.config.node.discovery.nostr,
452                ) {
453                    Ok(webrtc) => transports.push(TransportHandle::WebRtc(Box::new(webrtc))),
454                    Err(err) => {
455                        warn!(
456                            transport_id = %transport_id,
457                            error = %err,
458                            "failed to initialize WebRTC transport"
459                        );
460                    }
461                }
462            }
463        }
464        #[cfg(not(feature = "webrtc-transport"))]
465        if !webrtc_instances.is_empty() {
466            warn!("WebRTC transport configured but this build lacks WebRTC transport support");
467        }
468
469        // Create BLE transport instances
470        #[cfg(bluer_available)]
471        {
472            let ble_instances: Vec<_> = self
473                .config
474                .transports
475                .ble
476                .iter()
477                .map(|(name, config)| (name.map(|s| s.to_string()), config.clone()))
478                .collect();
479
480            #[cfg(all(bluer_available, not(test)))]
481            for (name, ble_config) in ble_instances {
482                let transport_id = self.allocate_transport_id();
483                let adapter = ble_config.adapter().to_string();
484                let mtu = ble_config.mtu();
485                match crate::transport::ble::io::BluerIo::new(&adapter, mtu).await {
486                    Ok(io) => {
487                        let mut ble = crate::transport::ble::BleTransport::new(
488                            transport_id,
489                            name,
490                            ble_config,
491                            io,
492                            packet_tx.clone(),
493                        );
494                        ble.set_local_pubkey(self.identity.pubkey().serialize());
495                        transports.push(TransportHandle::Ble(ble));
496                    }
497                    Err(e) => {
498                        tracing::warn!(adapter = %adapter, error = %e, "failed to initialize BLE adapter");
499                    }
500                }
501            }
502
503            #[cfg(any(not(bluer_available), test))]
504            if !ble_instances.is_empty() {
505                #[cfg(not(test))]
506                tracing::warn!("BLE transport configured but this build lacks BlueZ support");
507            }
508        }
509
510        transports
511    }
512
513    /// Find an operational transport that matches the given transport type name.
514    ///
515    /// Adopted UDP bootstrap transports are point-to-point sockets handed off
516    /// from Nostr/STUN traversal. They must not be reused for ordinary
517    /// `udp host:port` dials discovered through static config, mDNS, or overlay
518    /// adverts: on macOS a `send_to` through the wrong adopted socket can fail
519    /// with `EINVAL`, and even on platforms that allow it the packet would use
520    /// the wrong 5-tuple/NAT mapping. Prefer configured transports and make the
521    /// choice deterministic by lowest transport id instead of HashMap order.
522    pub(super) fn find_transport_for_type(&self, transport_type: &str) -> Option<TransportId> {
523        self.transports
524            .iter()
525            .filter(|(id, handle)| {
526                handle.transport_type().name == transport_type
527                    && handle.is_operational()
528                    && !self.bootstrap_transports.contains(id)
529            })
530            .min_by_key(|(id, _)| id.as_u32())
531            .map(|(id, _)| *id)
532    }
533
534    /// Resolve an Ethernet peer address ("interface/mac") to a transport ID
535    /// and binary TransportAddr.
536    ///
537    /// Finds the Ethernet transport instance bound to the named interface
538    /// and parses the MAC portion into a 6-byte TransportAddr.
539    #[cfg(any(target_os = "linux", target_os = "macos"))]
540    pub(super) fn resolve_ethernet_addr(
541        &self,
542        addr_str: &str,
543    ) -> Result<(TransportId, TransportAddr), NodeError> {
544        let (iface, mac_str) = addr_str.split_once('/').ok_or_else(|| {
545            NodeError::NoTransportForType(format!(
546                "invalid Ethernet address format '{}': expected 'interface/mac'",
547                addr_str
548            ))
549        })?;
550
551        // Find the Ethernet transport bound to this interface
552        let transport_id = self
553            .transports
554            .iter()
555            .find(|(_, handle)| {
556                handle.transport_type().name == "ethernet"
557                    && handle.is_operational()
558                    && handle.interface_name() == Some(iface)
559            })
560            .map(|(id, _)| *id)
561            .ok_or_else(|| {
562                NodeError::NoTransportForType(format!(
563                    "no operational Ethernet transport for interface '{}'",
564                    iface
565                ))
566            })?;
567
568        let mac = crate::transport::ethernet::parse_mac_string(mac_str).map_err(|e| {
569            NodeError::NoTransportForType(format!("invalid MAC in '{}': {}", addr_str, e))
570        })?;
571
572        Ok((transport_id, TransportAddr::from_bytes(&mac)))
573    }
574
575    #[cfg(not(any(target_os = "linux", target_os = "macos")))]
576    pub(super) fn resolve_ethernet_addr(
577        &self,
578        _addr_str: &str,
579    ) -> Result<(TransportId, TransportAddr), NodeError> {
580        Err(NodeError::NoTransportForType(
581            "Ethernet transport is not supported on this platform".to_string(),
582        ))
583    }
584
585    /// Resolve a BLE address string (`"adapter/AA:BB:CC:DD:EE:FF"`) to a
586    /// (TransportId, TransportAddr) pair by finding the BLE transport
587    /// instance matching the adapter name.
588    #[cfg(bluer_available)]
589    pub(super) fn resolve_ble_addr(
590        &self,
591        addr_str: &str,
592    ) -> Result<(TransportId, TransportAddr), NodeError> {
593        let ta = TransportAddr::from_string(addr_str);
594        let adapter = crate::transport::ble::addr::adapter_from_addr(&ta).ok_or_else(|| {
595            NodeError::NoTransportForType(format!(
596                "invalid BLE address format '{}': expected 'adapter/mac'",
597                addr_str
598            ))
599        })?;
600
601        // Find the BLE transport for this adapter
602        let transport_id = self
603            .transports
604            .iter()
605            .find(|(_, handle)| handle.transport_type().name == "ble" && handle.is_operational())
606            .map(|(id, _)| *id)
607            .ok_or_else(|| {
608                NodeError::NoTransportForType(format!(
609                    "no operational BLE transport for adapter '{}'",
610                    adapter
611                ))
612            })?;
613
614        // Validate the address format
615        crate::transport::ble::addr::BleAddr::parse(addr_str).map_err(|e| {
616            NodeError::NoTransportForType(format!("invalid BLE address '{}': {}", addr_str, e))
617        })?;
618
619        Ok((transport_id, TransportAddr::from_string(addr_str)))
620    }
621}