nvpn 4.1.1

CLI and daemon for Nostr VPN private mesh networks
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

use super::*;

pub(super) struct FipsHeartbeatContext<'a> {
    pub(super) runtime: &'a mut Option<crate::fips_private_mesh::FipsPrivateTunnelRuntime>,
    pub(super) app: &'a AppConfig,
    pub(super) config_path: &'a Path,
    pub(super) network_id: &'a str,
    pub(super) fallback_iface: &'a str,
    pub(super) underlay_interface_mtu: Option<u32>,
    pub(super) own_pubkey: Option<&'a str>,
    pub(super) recent_peers: &'a nostr_vpn_core::recent_peers::RecentPeerEndpoints,
    pub(super) ethernet_underlay: Option<&'a crate::fips_private_mesh::FipsEthernetUnderlayConfig>,
    pub(super) expected_peers: usize,
    pub(super) last_endpoint_peer_signature: &'a mut EndpointPeerSignature,
    pub(super) last_stale_participant_restart_at: &'a mut Option<u64>,
    pub(super) pending_roster_restart_state: &'a mut FipsPendingRosterRestartState,
    pub(super) roster_sync_state: &'a mut FipsRosterSyncState,
    pub(super) pending_roster_recipients: &'a mut HashSet<String>,
    pub(super) join_request_sends: &'a mut HashMap<String, u64>,
}

pub(super) async fn maintain_fips_heartbeat(context: FipsHeartbeatContext<'_>) {
    let FipsHeartbeatContext {
        runtime,
        app,
        config_path,
        network_id,
        fallback_iface,
        underlay_interface_mtu,
        own_pubkey,
        recent_peers,
        ethernet_underlay,
        expected_peers,
        last_endpoint_peer_signature,
        last_stale_participant_restart_at,
        pending_roster_restart_state,
        roster_sync_state,
        pending_roster_recipients,
        join_request_sends,
    } = context;
    let now = unix_timestamp();

    if let Some(current) = runtime.as_ref() {
        if let Err(error) = current.ping_peers(network_id, now).await {
            eprintln!("fips: peer ping failed: {error}");
        }
        if let Err(error) = current.refresh_link_statuses().await {
            eprintln!("fips: peer link snapshot failed: {error:#}");
            if fips_endpoint_control_requires_runtime_replacement(&error) {
                if fips_stale_participant_restart_due(last_stale_participant_restart_at, now) {
                    eprintln!(
                        "daemon: replacing unresponsive FIPS endpoint after local control timeout"
                    );
                    let recovery = rebuild_fips_tunnel_runtime_after_control_failure(
                        runtime,
                        FipsRestartContext {
                            app,
                            config_path,
                            network_id,
                            fallback_iface,
                            underlay_interface_mtu,
                            own_pubkey,
                            recent_peers: Some(recent_peers),
                            ethernet_underlay,
                            last_endpoint_peer_signature,
                        },
                        "local endpoint control timeout",
                    )
                    .await;
                    match recovery {
                        Ok(()) => {
                            *pending_roster_restart_state =
                                FipsPendingRosterRestartState::default();
                            *roster_sync_state = FipsRosterSyncState::default();
                        }
                        Err(error) => {
                            eprintln!("fips: endpoint control recovery failed: {error:#}");
                        }
                    }
                }
                return;
            }
        }
    }

    match restart_fips_tunnel_runtime_after_stale_participants(
        runtime,
        FipsRestartContext {
            app,
            config_path,
            network_id,
            fallback_iface,
            underlay_interface_mtu,
            own_pubkey,
            recent_peers: Some(recent_peers),
            ethernet_underlay,
            last_endpoint_peer_signature,
        },
        last_stale_participant_restart_at,
        now,
    )
    .await
    {
        Ok(true) => *roster_sync_state = FipsRosterSyncState::default(),
        Ok(false) => {}
        Err(error) => eprintln!("fips: stale participant recovery failed: {error:#}"),
    }

    match restart_fips_tunnel_runtime_after_pending_roster_links(
        runtime,
        FipsRestartContext {
            app,
            config_path,
            network_id,
            fallback_iface,
            underlay_interface_mtu,
            own_pubkey,
            recent_peers: Some(recent_peers),
            ethernet_underlay,
            last_endpoint_peer_signature,
        },
        expected_peers,
        pending_roster_restart_state,
        now,
    )
    .await
    {
        Ok(true) => *roster_sync_state = FipsRosterSyncState::default(),
        Ok(false) => {}
        Err(error) => eprintln!("fips: pending roster recovery failed: {error}"),
    }

    let Some(runtime) = runtime.as_ref() else {
        return;
    };
    if let Err(error) =
        sync_fips_roster_with_connected_peers(runtime, app, config_path, roster_sync_state)
    {
        eprintln!("fips: roster peer sync failed: {error}");
    }
    flush_pending_fips_roster_recipients(runtime, app, config_path, pending_roster_recipients);
    if let Err(error) = send_pending_fips_join_requests(runtime, app, join_request_sends, now).await
    {
        eprintln!("fips: join request send failed: {error}");
    }
}