nvpn 4.1.4

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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
impl FipsPrivateMeshRuntime {
    fn received_stateful_control_frame(
        &self,
        received: ReceivedFipsControlFrame,
    ) -> Result<Option<FipsPrivateMeshEvent>> {
        let mesh = self.mesh.load();
        let source_pubkey =
            control_frame_source_pubkey(&mesh, received.source_peer, &received.frame);
        let Some(source_pubkey) = source_pubkey else {
            return Ok(None);
        };
        let now = unix_timestamp();
        let encoded_len = encode_fips_control_frame(&received.frame)?.len();
        self.note_control_rx(&source_pubkey, encoded_len, now)?;
        match received.frame {
            FipsControlFrame::JoinRequest {
                requested_at,
                request,
            } => Ok(Some(FipsPrivateMeshEvent::JoinRequest {
                sender_pubkey: source_pubkey,
                requested_at,
                request,
            })),
            FipsControlFrame::JoinRoster { control } => {
                Ok(Some(FipsPrivateMeshEvent::JoinRoster {
                    sender_pubkey: source_pubkey,
                    control,
                }))
            }
            FipsControlFrame::JoinRosterAck { .. } => Ok(None),
            FipsControlFrame::Roster { signed_roster, .. } => {
                Ok(Some(FipsPrivateMeshEvent::Roster {
                    sender_pubkey: source_pubkey,
                    signed_roster,
                }))
            }
            FipsControlFrame::Capabilities {
                network_id,
                capabilities,
            } => {
                self.record_peer_capabilities(&source_pubkey, &capabilities, now)?;
                Ok(Some(FipsPrivateMeshEvent::Capabilities {
                    sender_pubkey: source_pubkey,
                    network_id,
                    capabilities,
                }))
            }
            #[cfg(feature = "paid-exit")]
            FipsControlFrame::PaidRouteSessionOpen { open } => {
                Ok(Some(FipsPrivateMeshEvent::PaidRouteSessionOpen {
                    sender_pubkey: source_pubkey,
                    open,
                }))
            }
            #[cfg(feature = "paid-exit")]
            FipsControlFrame::PaidRouteSessionOpenAck { lease_id } => {
                Ok(Some(FipsPrivateMeshEvent::PaidRouteSessionOpenAck {
                    sender_pubkey: source_pubkey,
                    lease_id,
                }))
            }
            #[cfg(feature = "paid-exit")]
            FipsControlFrame::PaidRoutePayment { id, envelope } => {
                let encoded = serde_json::to_vec(&envelope)
                    .context("failed to encode received paid route payment")?;
                if id != hex::encode(Sha256::digest(encoded)) {
                    return Err(anyhow!("paid route payment id does not match envelope"));
                }
                let buyer_pubkey = normalize_nostr_pubkey(&envelope.buyer)
                    .context("invalid paid route payment buyer")?;
                if buyer_pubkey != source_pubkey {
                    return Err(anyhow!(
                        "paid route payment buyer does not match authenticated FIPS source"
                    ));
                }
                Ok(Some(FipsPrivateMeshEvent::PaidRoutePayment {
                    sender_pubkey: source_pubkey,
                    id,
                    envelope: Box::new(envelope),
                }))
            }
            #[cfg(feature = "paid-exit")]
            FipsControlFrame::PaidRoutePaymentAck { id } => {
                Ok(Some(FipsPrivateMeshEvent::PaidRoutePaymentAck {
                    sender_pubkey: source_pubkey,
                    id,
                }))
            }
            FipsControlFrame::Ping { .. } | FipsControlFrame::Pong { .. } => Ok(None),
        }
    }

    #[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
    fn recv_direct_endpoint_tun_batch_blocking(
        &self,
        stop: &AtomicBool,
        packet_outputs: &mut DirectTunWriteBatch,
        event_tx: &mpsc::Sender<FipsPrivateMeshEvent>,
    ) -> Result<Option<usize>> {
        loop {
            if stop.load(Ordering::Acquire) {
                return Ok(None);
            }

            let mut emitted = 0usize;
            let mut received = 0usize;
            let mut turn_start = None;
            let mut mesh = None;
            while received < FIPS_MESH_RECV_BURST {
                let runs = if received == 0 {
                    loop {
                        if stop.load(Ordering::Acquire) {
                            return Ok(None);
                        }
                        match self.direct_endpoint_rx.recv_timeout(
                            Duration::from_millis(100),
                            FIPS_MESH_RECV_BURST,
                        ) {
                            Ok(runs) => break runs,
                            Err(std::sync::mpsc::RecvTimeoutError::Timeout) => continue,
                            Err(std::sync::mpsc::RecvTimeoutError::Disconnected) => {
                                return Ok(None);
                            }
                        }
                    }
                } else {
                    match self
                        .direct_endpoint_rx
                        .try_recv(FIPS_MESH_RECV_BURST.saturating_sub(received))
                    {
                        Ok(runs) => runs,
                        Err(std::sync::mpsc::TryRecvError::Empty) => break,
                        Err(std::sync::mpsc::TryRecvError::Disconnected) => return Ok(None),
                    }
                };

                if turn_start.is_none() {
                    turn_start = crate::pipeline_profile::stamp();
                }
                crate::pipeline_profile::record_direct_endpoint_rx_batch(
                    runs.len(),
                    runs.iter().map(FipsEndpointDirectPacketRun::len).sum(),
                );
                let mesh = mesh.get_or_insert_with(|| self.stable_mesh_snapshot().1);
                packet_outputs.set_admission_mesh(Arc::clone(mesh));

                let (received_packets, accepted_packets) = self
                    .admit_direct_endpoint_packet_runs_blocking(
                    mesh.as_ref(),
                    runs,
                    packet_outputs,
                    event_tx,
                )?;
                received = received.saturating_add(received_packets);
                if accepted_packets > 0 {
                    emitted = emitted.saturating_add(accepted_packets);
                }
                if should_flush_direct_endpoint_tun_batch_early(packet_outputs) {
                    break;
                }
            }

            if stop.load(Ordering::Acquire) {
                return Ok(None);
            }
            if emitted > 0 {
                crate::pipeline_profile::record_since(
                    crate::pipeline_profile::Stage::DirectEndpointRecv,
                    turn_start,
                );
                return Ok(Some(emitted));
            }
        }
    }

    #[cfg(any(target_os = "linux", target_os = "macos"))]
    fn wake_blocking_mesh_recv(&self) {
        self.direct_endpoint_rx.interrupt();
    }

    #[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
    fn finalize_direct_endpoint_tun_batch_blocking(
        &self,
        packet_outputs: &DirectTunWriteBatch,
    ) -> Result<()> {
        let _t = crate::pipeline_profile::Timer::start(
            crate::pipeline_profile::Stage::DirectEndpointFinalize,
        );
        if packet_outputs.is_empty() {
            return Ok(());
        }
        let mesh = packet_outputs
            .admission_mesh()
            .ok_or_else(|| anyhow!("FIPS direct TUN batch missing admission snapshot"))?;
        #[cfg(feature = "paid-exit")]
        self.note_paid_route_inbound_batch(mesh, packet_outputs)?;
        self.note_data_rx_batch(mesh, &packet_outputs.runs, None)
    }

    fn endpoint_message_to_mesh_event_outcome(
        &self,
        message: FipsEndpointMessage,
        now: Option<u64>,
    ) -> Result<FipsEndpointMessageOutcome> {
        let mesh = self.mesh.load();
        self.endpoint_message_to_mesh_event_outcome_inner_with_mesh(message, now, &mesh)
    }

    fn endpoint_message_to_mesh_event_outcome_inner_with_mesh(
        &self,
        message: FipsEndpointMessage,
        now: Option<u64>,
        mesh: &FipsMeshRuntime,
    ) -> Result<FipsEndpointMessageOutcome> {
        if let Some(frame) = decode_endpoint_control_frame(&message)? {
            let source_pubkey = control_frame_source_pubkey(mesh, message.source_peer, &frame);
            let Some(source_pubkey) = source_pubkey else {
                return Ok(FipsEndpointMessageOutcome::none());
            };
            let now = now.unwrap_or_else(unix_timestamp);
            self.note_control_rx(&source_pubkey, message.data.len(), now)?;
            match frame {
                FipsControlFrame::Ping {
                    network_id,
                    sent_at,
                } => {
                    let reply = FipsControlFrame::Pong {
                        network_id,
                        sent_at,
                        replied_at: now,
                    };
                    let encoded = encode_fips_control_frame(&reply)?;
                    return Ok(FipsEndpointMessageOutcome::event_with_reply(
                        FipsPrivateMeshEvent::Presence {
                            participant_pubkey: source_pubkey,
                            last_seen_at: now,
                        },
                        message.source_peer,
                        encoded,
                    ));
                }
                FipsControlFrame::Pong { sent_at, .. } => {
                    self.note_pong(&source_pubkey, sent_at)?;
                    return Ok(FipsEndpointMessageOutcome::event(
                        FipsPrivateMeshEvent::Presence {
                            participant_pubkey: source_pubkey,
                            last_seen_at: now,
                        },
                    ));
                }
                _ => return Ok(FipsEndpointMessageOutcome::none()),
            }
        }

        let data_len = message.data.len();
        let source_node_addr = *message.source_peer.node_addr();
        if let Some(packet) = mesh.receive_endpoint_data_owned_with_source_node_addr(
            source_node_addr.as_bytes(),
            message.data,
        ) {
            let now = now.unwrap_or_else(unix_timestamp);
            #[cfg(feature = "paid-exit")]
            self.note_paid_route_inbound_packet(
                Some(packet.source_pubkey),
                packet.source_pubkey_bytes,
                packet.bytes.as_ref(),
            )?;
            self.note_data_rx(packet.source_pubkey, packet.source_pubkey_bytes, data_len, now)?;
            return Ok(FipsEndpointMessageOutcome::event(
                FipsPrivateMeshEvent::Packet(packet.bytes),
            ));
        }

        Ok(FipsEndpointMessageOutcome::none())
    }

    #[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
    fn note_data_rx_batch(
        &self,
        mesh: &FipsMeshRuntime,
        runs: &[FipsEndpointDirectPacketRun],
        now: Option<u64>,
    ) -> Result<()> {
        if runs.is_empty() {
            return Ok(());
        }
        let now = now.unwrap_or_else(unix_timestamp);
        let peer_activity = self.peer_activity.load();
        let mut presence_needed = false;
        for run in runs {
            let admitter = direct_run_admitter(mesh, run)?;
            if let Some(activity) = admitter
                .source_pubkey_bytes()
                .and_then(|key| peer_activity.get(key))
            {
                activity.note_rx(run.packet_bytes(), now, FipsPeerRxKind::Data);
            } else {
                presence_needed = true;
            }
        }
        if !presence_needed {
            return Ok(());
        }

        let mut presence = self
            .presence
            .write()
            .map_err(|_| anyhow!("FIPS mesh presence lock poisoned"))?;
        for run in runs {
            let admitter = direct_run_admitter(mesh, run)?;
            if admitter
                .source_pubkey_bytes()
                .is_some_and(|key| peer_activity.contains_key(key))
            {
                continue;
            }
            let participant = admitter.source_pubkey();
            let bytes = run.packet_bytes();
            if let Some(entry) = presence.get_mut(participant) {
                entry.last_seen_at = Some(now);
                entry.last_data_seen_at = Some(now);
                entry.rx_bytes = entry.rx_bytes.saturating_add(bytes as u64);
                entry.error = None;
            } else {
                presence.insert(
                    participant.to_string(),
                    FipsPeerPresence {
                        last_seen_at: Some(now),
                        last_data_seen_at: Some(now),
                        rx_bytes: bytes as u64,
                        error: None,
                        ..Default::default()
                    },
                );
            }
        }
        Ok(())
    }

    #[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
    fn admit_direct_endpoint_packet_runs_blocking(
        &self,
        mesh: &FipsMeshRuntime,
        runs: Vec<FipsEndpointDirectPacketRun>,
        batch_outputs: &mut DirectTunWriteBatch,
        event_tx: &mpsc::Sender<FipsPrivateMeshEvent>,
    ) -> Result<(usize, usize)> {
        let mut current_source_node_addr = None;
        let mut current_admitter = None;
        let mut current_admission_cache = FipsEndpointAdmissionCache::default();
        let mut received = 0usize;
        let mut accepted = 0usize;
        let mut control_events_open = true;
        for run in runs {
            received = received.saturating_add(run.len());
            let source_node_addr = *run.source_peer().node_addr().as_bytes();
            if current_source_node_addr != Some(source_node_addr) {
                current_source_node_addr = Some(source_node_addr);
                current_admitter = mesh.endpoint_source_admitter(&source_node_addr);
                current_admission_cache = FipsEndpointAdmissionCache::default();
            }
            let accepted_count = self.admit_direct_endpoint_packet_run_blocking(
                current_admitter.as_ref(),
                run,
                &mut current_admission_cache,
                batch_outputs,
                event_tx,
                &mut control_events_open,
            )?;
            if accepted_count == 0 {
                continue;
            }
            accepted = accepted.saturating_add(accepted_count);
        }
        Ok((received, accepted))
    }

    #[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
    fn admit_direct_endpoint_packet_run_blocking(
        &self,
        admitter: Option<&FipsEndpointSourceAdmitter<'_>>,
        mut run: FipsEndpointDirectPacketRun,
        admission_cache: &mut FipsEndpointAdmissionCache,
        batch_outputs: &mut DirectTunWriteBatch,
        event_tx: &mpsc::Sender<FipsPrivateMeshEvent>,
        control_events_open: &mut bool,
    ) -> Result<usize> {
        let source_peer = *run.source_peer();
        let enqueued_at_ms = run.enqueued_at_ms();
        let mut control_now = None;
        let mut control_error = None;
        run.retain_packets(|_index, packet| {
            if control_error.is_some() {
                return false;
            }
            if is_fips_control_frame(packet) {
                match decode_fips_control_frame(packet) {
                    Ok(Some(_frame)) => {
                        if *control_events_open {
                            let message = FipsEndpointMessage {
                                source_peer,
                                data: FipsEndpointData::new(packet.to_vec()),
                                enqueued_at_ms,
                            };
                            let now = Some(*control_now.get_or_insert_with(unix_timestamp));
                            match self.endpoint_message_to_mesh_event_outcome(message, now) {
                                Ok(outcome) => {
                                    if let Some(reply) = outcome.reply
                                        && let Err(error) = self
                                            .endpoint
                                            .blocking_send_batch_to_peer(reply.peer, vec![reply.data])
                                    {
                                        eprintln!("fips: failed to reply to peer ping: {error}");
                                    }
                                    if let Some(event) = outcome.event
                                        && event_tx.blocking_send(event).is_err()
                                    {
                                        *control_events_open = false;
                                    }
                                }
                                Err(error) => control_error = Some(error),
                            }
                        }
                        return false;
                    }
                    Ok(None) => {}
                    Err(error) => {
                        control_error = Some(error);
                        return false;
                    }
                }
            }

            let Some(admitter) = admitter else {
                return false;
            };
            if !admitter.admit_packet_cached(packet, admission_cache) {
                return false;
            }
            true
        });
        if let Some(error) = control_error {
            return Err(error);
        }
        let accepted_count = run.len();
        if accepted_count == 0 {
            return Ok(0);
        }

        if fips_tun_packet_debug_enabled() {
            for packet in run.packet_slices() {
                eprintln!(
                    "fips: mesh -> TUN {} bytes {}",
                    packet.len(),
                    describe_ip_packet(packet)
                );
            }
        }
        batch_outputs.push_run(run);
        Ok(accepted_count)
    }
}

fn decode_endpoint_control_frame(
    message: &FipsEndpointMessage,
) -> Result<Option<FipsControlFrame>> {
    decode_fips_control_frame(message.data.as_slice())
}

#[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
fn direct_run_admitter<'a>(
    mesh: &'a FipsMeshRuntime,
    run: &FipsEndpointDirectPacketRun,
) -> Result<FipsEndpointSourceAdmitter<'a>> {
    let source_node_addr = run.source_peer().node_addr().as_bytes();
    mesh.endpoint_source_admitter(source_node_addr)
        .ok_or_else(|| anyhow!("accepted FIPS direct packet run lost admission source"))
}

#[cfg(any(target_os = "linux", target_os = "macos", target_os = "windows"))]
fn should_flush_direct_endpoint_tun_batch_early(packet_outputs: &DirectTunWriteBatch) -> bool {
    const LATENCY_BATCH_PACKETS: usize = 16;
    const LATENCY_PACKET_BYTES: usize = 256;

    packet_outputs.len() >= LATENCY_BATCH_PACKETS
        && packet_outputs.bytes() <= packet_outputs.len().saturating_mul(LATENCY_PACKET_BYTES)
}

#[cfg(any(target_os = "linux", target_os = "macos"))]
fn fips_tun_packet_debug_enabled() -> bool {
    fips_unix_packet_debug_enabled()
}

#[cfg(target_os = "windows")]
fn fips_tun_packet_debug_enabled() -> bool {
    windows_fips_packet_debug_enabled()
}