fips-core 0.3.94

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
use super::*;

#[tokio::test]
async fn test_graph_auto_connect_races_direct_address_before_timeout() {
    let edges = vec![(0, 1), (1, 2)];
    let mut nodes = run_tree_test(3, &edges, false).await;
    verify_tree_convergence(&nodes);
    populate_all_coord_caches(&mut nodes);

    let dest_addr = *nodes[2].node.node_addr();
    let peer = crate::config::PeerConfig {
        npub: nodes[2].node.npub(),
        alias: Some("graph-timeout-direct".to_string()),
        addresses: vec![crate::config::PeerAddress::new(
            "udp",
            nodes[2].addr.to_string(),
        )],
        connect_policy: crate::config::ConnectPolicy::AutoConnect,
        auto_reconnect: true,
        discovery_fallback_transit: true,
    };

    nodes[0].node.update_peers(vec![peer]).await.unwrap();
    assert!(
        has_outbound_handshake_to(&nodes[0].node, &dest_addr),
        "direct path should be tried without waiting for graph session timeout"
    );

    cleanup_nodes(&mut nodes).await;
}

#[tokio::test]
async fn test_update_peers_starts_lookup_for_auto_connect_peer_without_cached_route() {
    let edges = vec![(0, 1), (1, 2)];
    let mut nodes = run_tree_test(3, &edges, false).await;
    verify_tree_convergence(&nodes);
    nodes[0].node.config.node.routing.mode = RoutingMode::ReplyLearned;

    let dest_addr = *nodes[2].node.node_addr();
    nodes[0].node.coord_cache_mut().remove(&dest_addr);
    let peer = crate::config::PeerConfig {
        npub: nodes[2].node.npub(),
        alias: Some("lookup-peer".to_string()),
        addresses: Vec::new(),
        connect_policy: crate::config::ConnectPolicy::AutoConnect,
        auto_reconnect: true,
        discovery_fallback_transit: true,
    };

    let outcome = nodes[0].node.update_peers(vec![peer]).await.unwrap();

    assert_eq!(outcome.added, 1);
    assert!(
        nodes[0].node.pending_lookups.contains_key(&dest_addr),
        "configured peer should start FIPS discovery immediately when no route is cached"
    );

    cleanup_nodes(&mut nodes).await;
}

#[tokio::test]
async fn test_tun_packet_for_pending_session_triggers_reply_learned_discovery() {
    let mut node = make_reply_learned_node_with_tree_peer();
    let dest = Identity::generate();
    let dest_addr = *dest.node_addr();
    add_direct_peer_for_identity(&mut node, &dest);
    node.register_identity(dest_addr, dest.pubkey_full());
    insert_initiating_session(&mut node, &dest);
    assert!(
        node.find_next_hop(&dest_addr).is_some(),
        "fixture should model a stale direct route that still looks sendable"
    );

    let src_fips = crate::FipsAddress::from_node_addr(node.node_addr());
    let dst_fips = crate::FipsAddress::from_node_addr(&dest_addr);
    let ipv6_packet = build_ipv6_packet(&src_fips, &dst_fips, b"tun-probe");
    let baseline = node.stats().discovery.req_initiated;

    node.handle_dataplane_deferred_tun_packet(ipv6_packet).await;

    assert_eq!(
        node.pending_session_traffic
            .tun_packets_for(&dest_addr)
            .map(|queue| queue.len()),
        Some(1),
        "TUN packet should stay queued until the pending session recovers"
    );
    assert!(
        node.pending_lookups.contains_key(&dest_addr),
        "a stale pending session must start mesh discovery in reply-learned mode"
    );
    assert_eq!(
        node.stats().discovery.req_initiated,
        baseline + 1,
        "discovery should be initiated exactly once"
    );
}

#[tokio::test]
async fn test_tun_packet_for_established_session_with_no_route_queues_and_discovers() {
    let mut node = make_reply_learned_node_with_tree_peer();
    let dest = Identity::generate();
    let dest_addr = *dest.node_addr();
    node.register_identity(dest_addr, dest.pubkey_full());
    insert_established_session(&mut node, &dest);
    assert!(
        node.find_next_hop(&dest_addr).is_none(),
        "fixture should model an established end-to-end session whose direct path disappeared"
    );

    let src_fips = crate::FipsAddress::from_node_addr(node.node_addr());
    let dst_fips = crate::FipsAddress::from_node_addr(&dest_addr);
    let ipv6_packet = build_ipv6_packet(&src_fips, &dst_fips, b"tun-probe");
    let baseline = node.stats().discovery.req_initiated;

    node.handle_dataplane_deferred_tun_packet(ipv6_packet).await;

    assert_eq!(
        node.pending_session_traffic
            .tun_packets_for(&dest_addr)
            .map(|queue| queue.len()),
        Some(1),
        "TUN packet should stay queued while fallback discovery repairs the route"
    );
    assert!(
        node.pending_lookups.contains_key(&dest_addr),
        "route loss under an established session must start mesh discovery"
    );
    assert_eq!(
        node.stats().discovery.req_initiated,
        baseline + 1,
        "discovery should be initiated exactly once"
    );
}

#[tokio::test]
async fn test_tun_packet_for_established_session_with_stale_direct_queues_and_discovers() {
    let mut node = make_reply_learned_node_with_tree_peer();
    let dest = Identity::generate();
    let dest_addr = *dest.node_addr();
    node.register_identity(dest_addr, dest.pubkey_full());
    insert_established_session(&mut node, &dest);
    add_direct_peer_for_identity(&mut node, &dest);
    node.get_peer_mut(&dest_addr)
        .expect("direct peer")
        .mark_stale();

    assert!(
        node.get_peer(&dest_addr).expect("direct peer").can_send(),
        "stale direct peer should remain available for direct probing"
    );
    assert!(
        node.find_next_hop(&dest_addr).is_none(),
        "stale direct peer should not be selected for established-session payload"
    );

    let src_fips = crate::FipsAddress::from_node_addr(node.node_addr());
    let dst_fips = crate::FipsAddress::from_node_addr(&dest_addr);
    let ipv6_packet = build_ipv6_packet(&src_fips, &dst_fips, b"tun-stale-direct-probe");
    let baseline = node.stats().discovery.req_initiated;

    node.handle_dataplane_deferred_tun_packet(ipv6_packet).await;

    assert_eq!(
        node.pending_session_traffic
            .tun_packets_for(&dest_addr)
            .map(|queue| queue.len()),
        Some(1),
        "TUN packet should stay queued while fallback discovery runs"
    );
    assert!(
        node.pending_lookups.contains_key(&dest_addr),
        "stale direct payload failure must start mesh discovery"
    );
    assert_eq!(
        node.stats().discovery.req_initiated,
        baseline + 1,
        "discovery should be initiated exactly once"
    );
}

#[tokio::test]
async fn test_discovery_preserves_inflight_session_when_coords_refresh() {
    let edges = vec![(0, 1), (1, 2)];
    let mut nodes = run_tree_test(3, &edges, false).await;
    verify_tree_convergence(&nodes);
    for node in &mut nodes {
        node.node.config.node.routing.mode = RoutingMode::ReplyLearned;
    }

    let next_hop = *nodes[1].node.node_addr();
    let dest_addr = *nodes[2].node.node_addr();
    let dest_pubkey = nodes[2].node.identity().pubkey_full();
    nodes[0].node.register_identity(dest_addr, dest_pubkey);
    nodes[0].node.learn_reverse_route(dest_addr, next_hop);

    let now_ms = crate::time::now_ms();
    let stale_coords = nodes[0].node.tree_state().my_coords().clone();
    nodes[0]
        .node
        .coord_cache_mut()
        .insert(dest_addr, stale_coords.clone(), now_ms);
    nodes[0]
        .node
        .initiate_session(dest_addr, dest_pubkey)
        .await
        .expect("initial session should start over stale coordinates");
    let setup_before_refresh = nodes[0]
        .node
        .get_session(&dest_addr)
        .and_then(|entry| entry.handshake_payload())
        .expect("in-flight session should retain SessionSetup for resend")
        .to_vec();
    nodes[0]
        .node
        .pending_session_traffic
        .push_endpoint_data_batch_with_enqueued_at_ms(
            dest_addr,
            vec![
                crate::node::EndpointDataPayload::from_packet_payload(b"queued".to_vec())
                    .expect("test endpoint payload"),
            ],
            usize::MAX,
            usize::MAX,
            crate::time::now_ms(),
        );

    let fresh_coords = nodes[2].node.tree_state().my_coords().clone();
    nodes[0]
        .node
        .coord_cache_mut()
        .insert(dest_addr, fresh_coords.clone(), now_ms + 1);

    nodes[0].node.retry_session_after_discovery(dest_addr).await;

    let entry = nodes[0]
        .node
        .get_session(&dest_addr)
        .expect("discovery refresh should preserve the in-flight session");
    assert!(entry.is_initiating());
    let setup_payload = entry
        .handshake_payload()
        .expect("preserved session should retain SessionSetup for resend");
    assert_eq!(
        setup_payload, setup_before_refresh,
        "discovery must not reset an in-flight Noise handshake"
    );
    let setup = SessionSetup::decode(&setup_payload[FSP_COMMON_PREFIX_SIZE..])
        .expect("stored setup should decode");
    let setup_dest_path: Vec<NodeAddr> = setup.dest_coords.node_addrs().copied().collect();
    let fresh_path: Vec<NodeAddr> = fresh_coords.node_addrs().copied().collect();
    let stale_path: Vec<NodeAddr> = stale_coords.node_addrs().copied().collect();
    assert_eq!(setup_dest_path, stale_path);
    assert_ne!(
        setup_dest_path, fresh_path,
        "the preserved handshake payload must remain byte-stable while fresh coordinates are cached for subsequent traffic"
    );

    cleanup_nodes(&mut nodes).await;
}

#[tokio::test]
async fn test_discovery_warms_established_session_over_fresh_fallback_route() {
    let edges = vec![(0, 1), (1, 2)];
    let mut nodes = run_tree_test(3, &edges, false).await;
    verify_tree_convergence(&nodes);
    for node in &mut nodes {
        node.node.config.node.routing.mode = RoutingMode::ReplyLearned;
    }

    let fallback_next_hop = *nodes[1].node.node_addr();
    let dest_addr = *nodes[2].node.node_addr();
    let dest_pubkey = nodes[2].node.identity().pubkey_full();
    nodes[0].node.register_identity(dest_addr, dest_pubkey);
    populate_all_coord_caches(&mut nodes);
    nodes[0]
        .node
        .initiate_session(dest_addr, dest_pubkey)
        .await
        .expect("session should initiate over graph route");
    wait_for_session_established(
        &mut nodes,
        0,
        &dest_addr,
        Duration::from_secs(10),
        "fallback warmup fixture",
    )
    .await;
    nodes[0].node.coord_cache_mut().remove(&dest_addr);

    let request_id = 5150;
    let fresh_coords = nodes[2].node.tree_state().my_coords().clone();
    let proof_data =
        crate::protocol::LookupResponse::proof_bytes(request_id, &dest_addr, &fresh_coords);
    let proof = nodes[2].node.identity().sign(&proof_data);
    let response = crate::protocol::LookupResponse::new(request_id, dest_addr, fresh_coords, proof);
    let response_payload = &response.encode()[1..];
    let originated_before = nodes[0].node.stats().forwarding.originated_packets;

    nodes[0]
        .node
        .handle_lookup_response(&fallback_next_hop, response_payload)
        .await;

    assert_eq!(
        nodes[0]
            .node
            .pending_session_traffic
            .endpoint_data_for(&dest_addr)
            .map(|queue| queue.len()),
        None,
        "fixture should not rely on queued endpoint payloads for fallback warmup"
    );
    assert_eq!(
        nodes[0]
            .node
            .pending_session_traffic
            .tun_packets_for(&dest_addr)
            .map(|queue| queue.len()),
        None,
        "fixture should not rely on queued TUN packets for fallback warmup"
    );
    assert!(
        nodes[0].node.stats().forwarding.originated_packets > originated_before,
        "fresh discovery for an established session should immediately send a small fallback warmup"
    );
    drain_to_quiescence(&mut nodes).await;
    cleanup_nodes(&mut nodes).await;
}

#[tokio::test]
async fn test_discovery_flushes_queued_tun_for_established_session_with_fresh_route() {
    let edges = vec![(0, 1), (1, 2)];
    let mut nodes = run_tree_test(3, &edges, false).await;
    verify_tree_convergence(&nodes);
    for node in &mut nodes {
        node.node.config.node.routing.mode = RoutingMode::ReplyLearned;
    }

    let src_addr = *nodes[0].node.node_addr();
    let fallback_next_hop = *nodes[1].node.node_addr();
    let dest_addr = *nodes[2].node.node_addr();
    let dest_pubkey = nodes[2].node.identity().pubkey_full();
    nodes[0].node.register_identity(dest_addr, dest_pubkey);
    populate_all_coord_caches(&mut nodes);
    nodes[0]
        .node
        .initiate_session(dest_addr, dest_pubkey)
        .await
        .expect("session should initiate over graph route");
    wait_for_session_established(
        &mut nodes,
        0,
        &dest_addr,
        Duration::from_secs(10),
        "fallback TUN fixture",
    )
    .await;
    nodes[0].node.coord_cache_mut().remove(&dest_addr);

    let src_fips = crate::FipsAddress::from_node_addr(&src_addr);
    let dest_fips = crate::FipsAddress::from_node_addr(&dest_addr);
    let ipv6_packet = build_ipv6_packet(&src_fips, &dest_fips, b"queued-fallback");
    nodes[0].node.pending_session_traffic.push_tun_packet(
        dest_addr,
        ipv6_packet.clone(),
        usize::MAX,
        usize::MAX,
    );

    let request_id = 4242;
    let fresh_coords = nodes[2].node.tree_state().my_coords().clone();
    let proof_data =
        crate::protocol::LookupResponse::proof_bytes(request_id, &dest_addr, &fresh_coords);
    let proof = nodes[2].node.identity().sign(&proof_data);
    let response = crate::protocol::LookupResponse::new(request_id, dest_addr, fresh_coords, proof);
    let response_payload = &response.encode()[1..];

    nodes[0]
        .node
        .handle_lookup_response(&fallback_next_hop, response_payload)
        .await;

    let deadline = tokio::time::Instant::now() + Duration::from_secs(5);
    while nodes[0]
        .node
        .pending_session_traffic
        .has_traffic_for(&dest_addr)
        && tokio::time::Instant::now() < deadline
    {
        nodes[0].node.retry_pending_session_traffic().await;
        process_available_packets(&mut nodes).await;
        tokio::time::sleep(Duration::from_millis(10)).await;
    }

    assert!(
        nodes[0]
            .node
            .pending_session_traffic
            .tun_packets_for(&dest_addr)
            .is_none(),
        "discovery should flush queued TUN traffic through the established session"
    );
    cleanup_nodes(&mut nodes).await;
}