fips-core 0.4.31

Reusable FIPS mesh, endpoint, transport, and protocol library
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
use super::*;
use crate::node::{
    EndpointDataDelivery, EndpointDataPayload, NodeEndpointDataBatch, NodeEndpointPeer,
};

fn ipv6_tcp_packet(flags: u8, tcp_payload_len: usize) -> Vec<u8> {
    let tcp_len = 20 + tcp_payload_len;
    let mut packet = vec![0u8; 40 + tcp_len];
    packet[0] = 0x60;
    packet[4..6].copy_from_slice(&(tcp_len as u16).to_be_bytes());
    packet[6] = 6;
    packet[40 + 12] = 5 << 4;
    packet[40 + 13] = flags;
    packet
}

fn endpoint_payload(payload: Vec<u8>) -> EndpointDataPayload {
    EndpointDataPayload::from_packet_payload(payload)
        .expect("test endpoint payload should fit FSP endpoint data")
}

fn endpoint_payloads(payloads: Vec<Vec<u8>>) -> Vec<EndpointDataPayload> {
    payloads.into_iter().map(endpoint_payload).collect()
}

fn endpoint_batch(remote: PeerIdentity, payloads: Vec<Vec<u8>>) -> NodeEndpointDataBatch {
    NodeEndpointDataBatch::from_payloads(remote, endpoint_payloads(payloads), None)
        .expect("non-empty endpoint data batch")
}

#[test]
fn endpoint_peer_conversion_preserves_rekey_state() {
    let peer = FipsEndpointPeer::from(NodeEndpointPeer {
        npub: "npub1peer".to_string(),
        node_addr: NodeAddr::from_bytes([7; 16]),
        connected: true,
        transport_addr: Some("127.0.0.1:9000".to_string()),
        transport_type: Some("udp".to_string()),
        link_id: 7,
        srtt_ms: Some(12),
        srtt_age_ms: Some(34),
        packets_sent: 3,
        packets_recv: 4,
        bytes_sent: 120,
        bytes_recv: 240,
        rekey_in_progress: true,
        rekey_draining: true,
        current_k_bit: Some(true),
        last_outbound_route: Some("direct".to_string()),
        direct_probe_pending: false,
        direct_probe_after_ms: None,
        direct_probe_retry_count: 0,
        direct_probe_auto_reconnect: false,
        direct_probe_expires_at_ms: None,
        nostr_traversal_consecutive_failures: 2,
        nostr_traversal_in_cooldown: true,
        nostr_traversal_cooldown_until_ms: Some(1_234),
        nostr_traversal_last_observed_skew_ms: Some(-42),
    });

    assert!(peer.rekey_in_progress);
    assert!(peer.rekey_draining);
    assert_eq!(peer.current_k_bit, Some(true));
    assert_eq!(peer.last_outbound_route.as_deref(), Some("direct"));
    assert_eq!(peer.srtt_ms, Some(12));
    assert_eq!(peer.srtt_age_ms, Some(34));
    assert_eq!(peer.nostr_traversal_consecutive_failures, 2);
    assert!(peer.nostr_traversal_in_cooldown);
    assert_eq!(peer.nostr_traversal_cooldown_until_ms, Some(1_234));
    assert_eq!(peer.nostr_traversal_last_observed_skew_ms, Some(-42));
}

#[test]
fn endpoint_data_batches_charge_drain_budget_by_small_packet_groups() {
    let remote = PeerIdentity::from_pubkey_full(crate::Identity::generate().pubkey_full());
    let bulk_payload = || ipv6_tcp_packet(0x18, 512);
    let payloads = |count: usize| (0..count).map(|_| bulk_payload()).collect::<Vec<_>>();

    let single = endpoint_batch(remote, vec![ipv6_tcp_packet(0x18, 512)]);
    assert_eq!(single.drain_cost(), 1);

    let batch_1 = endpoint_batch(remote, payloads(1));
    assert_eq!(batch_1.drain_cost(), 1);

    let batch_8 = endpoint_batch(remote, payloads(8));
    assert_eq!(batch_8.drain_cost(), 1);

    let batch_9 = endpoint_batch(remote, payloads(9));
    assert_eq!(batch_9.drain_cost(), 2);

    let full_batch = endpoint_batch(remote, payloads(ENDPOINT_DATA_BATCH_MAX));
    assert_eq!(ENDPOINT_DATA_BATCH_MAX, 128);
    assert_eq!(full_batch.drain_cost(), 16);
}

#[test]
fn endpoint_data_drop_accounting_counts_packets_not_drain_quanta() {
    let remote = PeerIdentity::from_pubkey_full(crate::Identity::generate().pubkey_full());
    let discardable_payload = || vec![0, 1, 2, 3];
    let payloads = (0..ENDPOINT_DATA_BATCH_MAX)
        .map(|_| discardable_payload())
        .collect::<Vec<_>>();
    let full_batch = endpoint_batch(remote, payloads);

    assert_eq!(full_batch.drain_cost(), 16);
    assert_eq!(full_batch.packet_count(), ENDPOINT_DATA_BATCH_MAX);
}

#[tokio::test]
async fn endpoint_data_batch_enqueue_drops_when_full() {
    let (batch_tx, mut batch_rx) = crate::node::endpoint_data_batch_channel(1);
    let remote = PeerIdentity::from_pubkey_full(crate::Identity::generate().pubkey_full());

    let queued_data = endpoint_batch(remote, vec![vec![0, 1, 2, 3]]);
    batch_tx
        .send_or_drop(queued_data)
        .map_err(|_| FipsEndpointError::Closed)
        .expect("first endpoint data batch should enqueue");

    let dropped_tcp = endpoint_batch(remote, vec![ipv6_tcp_packet(0x18, 512)]);
    batch_tx
        .send_or_drop(dropped_tcp)
        .map_err(|_| FipsEndpointError::Closed)
        .expect("endpoint data batch should be accepted as dropped");

    let first = batch_rx
        .try_recv()
        .expect("only the first batch should remain queued");
    assert!(matches!(
        batch_rx.try_recv(),
        Err(mpsc::error::TryRecvError::Empty)
    ));
    assert_eq!(first.packet_count(), 1);
}

#[tokio::test]
async fn endpoint_data_batch_lane_charges_batches_by_drain_cost() {
    let (batch_tx, mut batch_rx) = crate::node::endpoint_data_batch_channel(2);
    let remote = PeerIdentity::from_pubkey_full(crate::Identity::generate().pubkey_full());
    let payloads = (0..9)
        .map(|_| ipv6_tcp_packet(0x18, 512))
        .collect::<Vec<_>>();
    let batch = endpoint_batch(remote, payloads);
    assert_eq!(batch.drain_cost(), 2);

    batch_tx
        .send_or_drop(batch)
        .map_err(|_| FipsEndpointError::Closed)
        .expect("nine-packet batch should fill the two-quanta lane");
    batch_tx
        .send_or_drop(endpoint_batch(remote, vec![vec![8, 9, 10, 11]]))
        .map_err(|_| FipsEndpointError::Closed)
        .expect("overflowing endpoint data batch should be accepted as dropped");

    let first = batch_rx
        .try_recv()
        .expect("the two-quanta batch should remain queued");
    assert_eq!(first.packet_count(), 9);
    assert!(matches!(
        batch_rx.try_recv(),
        Err(mpsc::error::TryRecvError::Empty)
    ));
}

#[test]
fn endpoint_data_batch_owns_payload_bytes_and_queue_stamp() {
    let remote = PeerIdentity::from_pubkey_full(crate::Identity::generate().pubkey_full());
    let payload = ipv6_tcp_packet(0x18, 512);
    let queued_at = Some(crate::perf_profile::test_stamp());
    let enqueued_at_ms = 1_234;

    let batch = crate::node::NodeEndpointDataBatch::from_payloads_with_enqueued_at_ms(
        remote,
        vec![endpoint_payload(payload.clone())],
        queued_at,
        enqueued_at_ms,
    )
    .expect("one-packet endpoint data batch");

    let (owned_remote, owned_payloads, owned_queued_at, owned_enqueued_at_ms) = batch.into_parts();
    assert_eq!(owned_remote, remote);
    let owned_payloads = owned_payloads
        .into_iter()
        .map(|payload| payload.into_body().into_vec())
        .collect::<Vec<_>>();
    assert_eq!(owned_payloads, vec![payload]);
    assert_eq!(owned_queued_at, queued_at);
    assert_eq!(owned_enqueued_at_ms, enqueued_at_ms);
}

mod local_rendezvous;
mod runtime;

#[test]
fn discovery_scope_enables_default_scoped_udp_discovery() {
    let config = FipsEndpoint::builder()
        .discovery_scope("nostr-vpn:test")
        .prepared_config();

    assert!(!config.tun.enabled);
    assert!(!config.dns.enabled);
    assert!(!config.node.system_files_enabled);
    assert!(config.node.discovery.nostr.enabled);
    assert!(config.node.discovery.nostr.advertise);
    assert_eq!(
        config.node.discovery.nostr.policy,
        NostrDiscoveryPolicy::Open
    );
    assert!(config.node.discovery.nostr.share_local_candidates);
    assert_eq!(config.node.discovery.nostr.app, "nostr-vpn:test");
    assert_eq!(
        config.node.discovery.lan.scope.as_deref(),
        Some("nostr-vpn:test")
    );
    assert!(config.node.discovery.local.enabled);

    let udp = match config.transports.udp {
        TransportInstances::Single(udp) => udp,
        TransportInstances::Named(_) => panic!("expected a default UDP transport"),
    };
    assert_eq!(udp.bind_addr(), "0.0.0.0:0");
    assert!(udp.advertise_on_nostr());
    assert!(!udp.is_public());
    assert!(!udp.outbound_only());
    assert!(udp.accept_connections());
}

#[test]
fn local_rendezvous_enables_fixed_loopback_without_adding_transports() {
    let config = FipsEndpoint::builder().local_rendezvous().prepared_config();

    assert!(config.node.discovery.local.enabled);
    assert_eq!(
        config.node.discovery.local.rendezvous_addr,
        crate::discovery::local::DEFAULT_LOCAL_RENDEZVOUS_ADDR
    );
    assert!(config.transports.is_empty());
}

#[test]
fn discovery_scope_preserves_explicit_connectivity_config() {
    let mut explicit = Config::new();
    explicit.node.discovery.nostr.enabled = true;
    explicit.node.discovery.nostr.app = "custom-app".to_string();
    explicit.node.discovery.nostr.policy = NostrDiscoveryPolicy::ConfiguredOnly;
    explicit.node.discovery.nostr.share_local_candidates = false;
    explicit.node.discovery.lan.scope = Some("iris-local-v1".to_string());
    explicit.transports.udp = TransportInstances::Single(UdpConfig {
        bind_addr: Some("127.0.0.1:34567".to_string()),
        advertise_on_nostr: Some(false),
        outbound_only: Some(true),
        ..UdpConfig::default()
    });

    let config = FipsEndpoint::builder()
        .config(explicit.clone())
        .discovery_scope("nostr-vpn:test")
        .prepared_config();

    assert_eq!(config.node.discovery.nostr.app, "custom-app");
    assert_eq!(
        config.node.discovery.nostr.policy,
        NostrDiscoveryPolicy::ConfiguredOnly
    );
    assert!(!config.node.discovery.nostr.share_local_candidates);
    assert_eq!(
        config.node.discovery.lan.scope.as_deref(),
        Some("iris-local-v1")
    );
    assert!(!config.node.discovery.local.enabled);
    let TransportInstances::Single(udp) = config.transports.udp else {
        panic!("expected the explicit UDP transport");
    };
    assert_eq!(udp.bind_addr.as_deref(), Some("127.0.0.1:34567"));
    assert_eq!(udp.advertise_on_nostr, Some(false));
    assert_eq!(udp.outbound_only, Some(true));

    let local = FipsEndpoint::builder()
        .config(explicit)
        .discovery_scope("nostr-vpn:test")
        .local_rendezvous()
        .prepared_config();
    assert!(local.node.discovery.local.enabled);
    let TransportInstances::Single(udp) = local.transports.udp else {
        panic!("expected the explicit UDP transport");
    };
    assert_eq!(udp.bind_addr.as_deref(), Some("127.0.0.1:34567"));
}

#[tokio::test]
async fn endpoint_peer_snapshot_starts_empty() {
    let endpoint = FipsEndpoint::builder()
        .without_system_tun()
        .bind()
        .await
        .expect("endpoint should bind");

    let peers = endpoint.peers().await.expect("peer snapshot");
    assert!(peers.is_empty());

    endpoint.shutdown().await.expect("shutdown should succeed");
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn endpoint_accepts_dns_resolved_identity_and_blocking_host_packet() {
    let endpoint = Arc::new(
        FipsEndpoint::builder()
            .without_system_tun()
            .bind()
            .await
            .expect("endpoint should bind"),
    );
    let local = PeerIdentity::from_npub(endpoint.npub()).expect("local identity");

    assert!(
        endpoint
            .register_peer_identity(local)
            .await
            .expect("DNS identity should register")
    );

    let packet = ipv6_tcp_packet(0x02, 0);

    let endpoint_for_sender = Arc::clone(&endpoint);
    tokio::task::spawn_blocking(move || {
        endpoint_for_sender
            .blocking_send_ip_packet(packet)
            .expect("blocking TUN producer should enqueue without an async bridge");
    })
    .await
    .expect("blocking sender task");

    endpoint.shutdown().await.expect("shutdown should succeed");
}

#[tokio::test]
async fn endpoint_exposes_signed_machine_rating_events() {
    let endpoint = FipsEndpoint::builder()
        .without_system_tun()
        .bind()
        .await
        .expect("endpoint should bind");

    let events = endpoint
        .peer_rating_events("fips.peer")
        .await
        .expect("peer rating snapshot");
    assert!(events.is_empty());

    endpoint.shutdown().await.expect("shutdown should succeed");
}

#[cfg(feature = "host-ble-transport")]
#[tokio::test]
async fn discovery_scope_with_host_ble_does_not_inject_udp_or_nostr_defaults() {
    use crate::config::BleConfig;
    use crate::transport::ble::host::HostBleIo;

    let (io, _adapter) = HostBleIo::channel("ios", "local-device", 16).unwrap();
    let config = FipsEndpoint::builder()
        .config(Config::new())
        .discovery_scope("iris-chat:fips-nearby:v1")
        .host_ble(io, BleConfig::default())
        .prepared_config();

    assert!(!config.node.discovery.nostr.enabled);
    assert!(config.transports.udp.is_empty());
    assert!(!config.transports.ble.is_empty());
}

#[cfg(feature = "host-ble-transport")]
#[tokio::test]
async fn endpoint_host_ble_runs_platform_lifecycle_with_assigned_psm() {
    use crate::config::BleConfig;
    use crate::transport::ble::host::{HostBleCommand, HostBleIo};

    let (io, adapter) = HostBleIo::channel("ios", "local-device", 16).unwrap();
    let platform = tokio::spawn(run_endpoint_host_ble_platform(adapter));
    let endpoint = FipsEndpoint::builder()
        .without_system_tun()
        .host_ble(io, BleConfig::default())
        .bind()
        .await
        .expect("endpoint should bind with host BLE");

    endpoint.shutdown().await.expect("shutdown should succeed");
    let shutdown_commands = platform.await.expect("platform pump should finish");
    assert!(
        shutdown_commands
            .iter()
            .any(|command| matches!(command, HostBleCommand::StopAdvertising { .. }))
    );
    assert!(shutdown_commands.contains(&HostBleCommand::StopListening));
    assert!(shutdown_commands.contains(&HostBleCommand::StopScanning));
}

#[cfg(feature = "host-ble-transport")]
async fn run_endpoint_host_ble_platform(
    adapter: crate::transport::ble::host::HostBleAdapter,
) -> Vec<crate::transport::ble::host::HostBleCommand> {
    use crate::transport::ble::{
        bootstrap::BleBootstrap,
        host::{HostBleCommand, HostBleEvent},
    };

    let HostBleCommand::Listen {
        request_id,
        preferred_psm,
    } = adapter.next_command().await.expect("listener command")
    else {
        panic!("expected listener command");
    };
    assert_eq!(preferred_psm, 0x0085);
    adapter
        .emit(HostBleEvent::Listening {
            request_id,
            psm: 0x0091,
        })
        .await
        .unwrap();

    let HostBleCommand::StartAdvertising {
        request_id,
        bootstrap,
    } = adapter.next_command().await.expect("advertising command")
    else {
        panic!("expected advertising command");
    };
    let bootstrap = BleBootstrap::decode(&bootstrap).unwrap();
    assert_eq!(bootstrap.psm, 0x0091);
    assert_eq!(bootstrap.max_packet, 2048);
    adapter
        .emit(HostBleEvent::AdvertisingStarted { request_id })
        .await
        .unwrap();

    let HostBleCommand::StartScanning { request_id } =
        adapter.next_command().await.expect("scanning command")
    else {
        panic!("expected scanning command");
    };
    adapter
        .emit(HostBleEvent::ScanningStarted { request_id })
        .await
        .unwrap();

    let mut shutdown_commands = Vec::new();
    while shutdown_commands.len() < 3 {
        let command = tokio::time::timeout(Duration::from_secs(5), adapter.next_command())
            .await
            .expect("host BLE shutdown command should arrive")
            .expect("host BLE command channel should remain open through shutdown");
        if let HostBleCommand::StopAdvertising { request_id } = command {
            adapter
                .emit(HostBleEvent::AdvertisingStopped { request_id })
                .await
                .unwrap();
            shutdown_commands.push(HostBleCommand::StopAdvertising { request_id });
        } else {
            shutdown_commands.push(command);
        }
    }
    shutdown_commands
}