fips-core 0.4.49

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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
use super::*;
use crate::node::route_impl::TransitNextHopPlan;
use crate::node::session::{EndToEndState, SessionEntry};
use crate::noise::HandshakeState;

fn insert_established_session(node: &mut Node, target: &Identity) {
    let mut initiator =
        HandshakeState::new_initiator(node.identity().keypair(), target.pubkey_full());
    let mut responder = HandshakeState::new_responder(target.keypair());
    initiator.set_local_epoch([1; 8]);
    responder.set_local_epoch([2; 8]);
    let msg1 = initiator.write_message_1().expect("session msg1");
    responder.read_message_1(&msg1).expect("session read msg1");
    let msg2 = responder.write_message_2().expect("session msg2");
    initiator.read_message_2(&msg2).expect("session read msg2");
    let session = initiator.into_session().expect("established session");
    node.sessions.insert(
        *target.node_addr(),
        SessionEntry::new(
            *target.node_addr(),
            target.pubkey_full(),
            EndToEndState::Established(session),
            1_000,
            false,
        ),
    );
}

#[tokio::test]
async fn test_response_decode_error() {
    let mut node = make_node();
    let from = make_node_addr(0xAA);
    node.handle_lookup_response(&from, &[0x00; 10]).await;
    // No panic, no route cached
    assert!(node.coord_cache().is_empty());
}

#[tokio::test]
async fn test_response_originator_caches_route() {
    let mut node = make_node();
    let from = make_node_addr(0xAA);

    // Use the target identity's actual node_addr for consistency
    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let root = make_node_addr(0xF0);
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();

    // Register target identity in cache so verification can find it
    node.register_identity(target, target_identity.pubkey_full());

    // Create a valid response with a real proof signature (includes coords)
    let proof_data = LookupResponse::proof_bytes(555, &target, &coords);
    let proof = target_identity.sign(&proof_data);

    let response = LookupResponse::new(555, target, coords.clone(), proof);
    let payload = &response.encode()[1..]; // skip msg_type

    // No entry in recent_requests for 555 → we're the originator
    assert!(!node.recent_requests.contains_key(&555));

    node.handle_lookup_response(&from, payload).await;

    // Route should be cached in coord_cache
    let now_ms = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as u64)
        .unwrap_or(0);
    assert!(node.coord_cache().contains(&target, now_ms));
    assert_eq!(node.coord_cache().get(&target, now_ms).unwrap(), &coords);
}

#[tokio::test]
async fn established_session_lookup_does_not_revive_failed_payload_hop() {
    let mut config = Config::new();
    config.node.routing.mode = RoutingMode::ReplyLearned;
    let mut node = Node::new(config).unwrap();
    let from = make_node_addr(0xAA);
    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let root = make_node_addr(0xF0);
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();

    node.register_identity(target, target_identity.pubkey_full());
    node.learn_reverse_route(target, from);
    node.learned_routes.quarantine_failed_next_hop(
        target,
        from,
        Node::now_ms(),
        node.config.node.routing.learned_ttl_secs,
        node.config.node.routing.max_learned_routes_per_dest,
    );

    insert_established_session(&mut node, &target_identity);
    assert!(
        node.learned_routes
            .failed_next_hops(&target, Node::now_ms())
            .contains(&from),
        "fixture must begin with a recently failed payload next hop"
    );

    let proof_data = LookupResponse::proof_bytes(556, &target, &coords);
    let response = LookupResponse::new(556, target, coords, target_identity.sign(&proof_data));
    node.handle_lookup_response(&from, &response.encode()[1..])
        .await;

    assert!(
        node.learned_routes
            .failed_next_hops(&target, Node::now_ms())
            .contains(&from),
        "a control-plane lookup response must not erase an established session's payload failure"
    );
}

#[tokio::test]
async fn degraded_session_defers_lookup_and_adopts_a_recovered_response_hop() {
    let mut config = Config::new();
    config.node.routing.mode = RoutingMode::ReplyLearned;
    let mut node = Node::new(config).unwrap();
    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let failed_hop = make_node_addr(0xA0);

    assert!(node.register_endpoint_identity(target, target_identity.pubkey_full()));
    node.learn_reverse_route(target, failed_hop);
    node.learned_routes.quarantine_failed_next_hop(
        target,
        failed_hop,
        Node::now_ms(),
        node.config.node.routing.learned_ttl_secs,
        node.config.node.routing.max_learned_routes_per_dest,
    );

    insert_established_session(&mut node, &target_identity);
    assert!(node.sync_dataplane_fsp_owner_from_current_session(&target, 0));
    assert_eq!(node.dataplane.fsp_owner_next_hop(&target), None);
    assert!(node.mark_session_direct_path_degraded(target, Node::now_ms()));

    let initiated_before = node.stats().discovery.req_initiated;
    node.maybe_initiate_lookup(&target).await;
    assert!(
        node.pending_lookups.contains_key(&target),
        "an established degraded session must retain one deferred lookup until transit returns"
    );
    node.maybe_initiate_lookup(&target).await;
    assert_eq!(
        node.stats().discovery.req_initiated,
        initiated_before + 1,
        "repeated endpoint payload must deduplicate behind the deferred lookup"
    );

    let transit_link = LinkId::new(7);
    let transit_transport = TransportId::new(7);
    let (transit_connection, transit_identity) =
        make_completed_connection(&mut node, transit_link, transit_transport, 2_000);
    let transit = *transit_identity.node_addr();
    node.add_connection(transit_connection).unwrap();
    node.promote_connection(transit_link, transit_identity, 3_000)
        .unwrap();
    assert!(node.sync_dataplane_fmp_owner(&transit));
    node.retry_degraded_session_routes_after_peer_authenticated(transit, Node::now_ms())
        .await;
    assert_eq!(
        node.stats().discovery.req_initiated,
        initiated_before + 2,
        "transit authentication must immediately send the retained lookup"
    );

    let request_id = node
        .pending_lookups
        .last_origin_request_id(&target)
        .expect("recovered transit must carry a current origin lookup request");
    let root = *node.tree_state().my_coords().root_id();
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();
    let proof_data = LookupResponse::proof_bytes(request_id, &target, &coords);
    let response = LookupResponse::new(
        request_id,
        target,
        coords,
        target_identity.sign(&proof_data),
    );
    node.handle_lookup_response(&transit, &response.encode()[1..])
        .await;

    assert!(
        node.learned_routes
            .failed_next_hops(&target, Node::now_ms())
            .contains(&failed_hop),
        "recovery must not clear the quarantined payload branch"
    );
    assert_eq!(
        node.dataplane.fsp_owner_next_hop(&target),
        Some(transit),
        "the authenticated response hop must restore the established FSP owner"
    );
}

#[tokio::test]
async fn stale_signed_response_does_not_repin_an_established_degraded_session() {
    let mut config = Config::new();
    config.node.routing.mode = RoutingMode::ReplyLearned;
    let mut node = Node::new(config).unwrap();
    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();

    assert!(node.register_endpoint_identity(target, target_identity.pubkey_full()));
    insert_established_session(&mut node, &target_identity);
    assert!(node.sync_dataplane_fsp_owner_from_current_session(&target, 0));
    assert!(node.mark_session_direct_path_degraded(target, Node::now_ms()));
    node.maybe_initiate_lookup(&target).await;
    assert!(
        node.pending_lookups.contains_key(&target),
        "fixture must retain the deferred lookup while no transit is available"
    );

    let transit_link = LinkId::new(8);
    let transit_transport = TransportId::new(8);
    let (transit_connection, transit_identity) =
        make_completed_connection(&mut node, transit_link, transit_transport, 2_000);
    let transit = *transit_identity.node_addr();
    node.add_connection(transit_connection).unwrap();
    node.promote_connection(transit_link, transit_identity, 3_000)
        .unwrap();
    assert!(node.sync_dataplane_fmp_owner(&transit));

    let stale_request_id = 0x5a11_e000;
    let root = *node.tree_state().my_coords().root_id();
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();
    let proof_data = LookupResponse::proof_bytes(stale_request_id, &target, &coords);
    let stale_response = LookupResponse::new(
        stale_request_id,
        target,
        coords,
        target_identity.sign(&proof_data),
    );
    node.handle_lookup_response(&transit, &stale_response.encode()[1..])
        .await;

    assert_eq!(
        node.dataplane.fsp_owner_next_hop(&target),
        None,
        "a target-signed response outside the active origin lookup must not repin payload"
    );
    assert!(
        node.pending_lookups.contains_key(&target),
        "rejecting a stale response must leave the real recovery lookup pending"
    );
}

#[tokio::test]
async fn test_response_transit_learns_target_route() {
    let mut config = Config::new();
    config.node.routing.mode = RoutingMode::ReplyLearned;
    let mut node = Node::new(config).unwrap();
    let from = make_node_addr(0xAA);
    let target = make_node_addr(0xBB);
    let root = *node.tree_state().my_coords().root_id();
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();

    // Transit nodes don't verify proofs, so any valid signature suffices
    let proof_data = LookupResponse::proof_bytes(444, &target, &coords);
    let target_identity = Identity::generate();
    let proof = target_identity.sign(&proof_data);

    let response = LookupResponse::new(444, target, coords.clone(), proof);
    let payload = &response.encode()[1..];

    // Simulate being a transit node: record a recent_request for this ID
    let now_ms = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .unwrap()
        .as_millis() as u64;
    node.recent_requests
        .insert(444, RecentRequest::new(make_node_addr(0xDD), now_ms));

    // Handle response — should try to reverse-path forward to 0xDD
    // (will fail silently since 0xDD is not an actual peer)
    node.handle_lookup_response(&from, payload).await;

    // A following SessionSetup uses this same transit. Retain the coordinates
    // and reverse next hop learned from the response so it does not immediately
    // report CoordsRequired for the route it just discovered.
    let now_ms2 = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as u64)
        .unwrap_or(0);
    assert_eq!(node.coord_cache().get(&target, now_ms2), Some(&coords));
    let learned = node.learned_route_table_snapshot(now_ms2);
    assert_eq!(learned.destination_count, 1);
    assert_eq!(learned.route_count, 1);
    assert_eq!(learned.destinations[0].destination, target.to_string());
    assert_eq!(learned.destinations[0].routes[0].next_hop, from.to_string());
}

#[tokio::test]
async fn test_response_transit_keeps_foreign_root_out_of_strict_routing() {
    let mut config = Config::new();
    config.node.routing.mode = RoutingMode::ReplyLearned;
    let mut node = Node::new(config).unwrap();
    let transport_id = TransportId::new(1);

    let (target_side_connection, target_side_identity) =
        make_completed_connection(&mut node, LinkId::new(1), transport_id, 1_000);
    let target_side = *target_side_identity.node_addr();
    node.add_connection(target_side_connection).unwrap();
    node.promote_connection(LinkId::new(1), target_side_identity, 2_000)
        .unwrap();

    let (origin_side_connection, origin_side_identity) =
        make_completed_connection(&mut node, LinkId::new(2), transport_id, 1_000);
    let origin_side = *origin_side_identity.node_addr();
    node.add_connection(origin_side_connection).unwrap();
    node.promote_connection(LinkId::new(2), origin_side_identity, 2_000)
        .unwrap();

    let target = make_node_addr(0xBB);
    let foreign_coords = TreeCoordinate::from_addrs(vec![target]).unwrap();
    assert_ne!(
        foreign_coords.root_id(),
        node.tree_state().my_coords().root_id(),
        "fixture requires a target in a different tree component"
    );
    let proof_data = LookupResponse::proof_bytes(445, &target, &foreign_coords);
    let proof = Identity::generate().sign(&proof_data);
    let response = LookupResponse::new(445, target, foreign_coords, proof);
    let now_ms = Node::now_ms();
    node.recent_requests
        .insert(445, RecentRequest::new(origin_side, now_ms));

    node.handle_lookup_response(&target_side, &response.encode()[1..])
        .await;

    let now_ms = Node::now_ms();
    assert!(
        !node.coord_cache().contains(&target, now_ms),
        "foreign-root coordinates must not suppress the proven reply path"
    );
    match node.plan_transit_next_hop(&target, &origin_side) {
        TransitNextHopPlan::Route(next_hop) => assert_eq!(next_hop, target_side),
        TransitNextHopPlan::Loop(_) => panic!("foreign-root coordinates caused a route loop"),
        TransitNextHopPlan::NoRoute => panic!("verified response path was not retained"),
    }
}

// ============================================================================
// Unit Tests — LookupResponse Proof Verification
// ============================================================================

#[tokio::test]
async fn test_response_proof_verification_success() {
    // Verify that a properly signed response is accepted and cached
    // when the origin has the target's pubkey in identity_cache.
    let mut node = make_node();
    let from = make_node_addr(0xAA);

    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let root = make_node_addr(0xF0);
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();

    // Register target in identity_cache
    node.register_identity(target, target_identity.pubkey_full());

    // Sign with correct proof_bytes (including coords)
    let proof_data = LookupResponse::proof_bytes(700, &target, &coords);
    let proof = target_identity.sign(&proof_data);

    let response = LookupResponse::new(700, target, coords.clone(), proof);
    let payload = &response.encode()[1..];

    node.handle_lookup_response(&from, payload).await;

    let now_ms = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as u64)
        .unwrap_or(0);
    assert!(
        node.coord_cache().contains(&target, now_ms),
        "Valid proof should result in cached coords"
    );
    assert_eq!(node.coord_cache().get(&target, now_ms).unwrap(), &coords);
}

#[tokio::test]
async fn test_response_proof_verification_failure() {
    // Verify that a response with a bad signature is discarded.
    let mut node = make_node();
    let from = make_node_addr(0xAA);

    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let root = make_node_addr(0xF0);
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();

    // Register target in identity_cache
    node.register_identity(target, target_identity.pubkey_full());

    // Sign with a DIFFERENT identity (wrong key)
    let wrong_identity = Identity::generate();
    let proof_data = LookupResponse::proof_bytes(701, &target, &coords);
    let proof = wrong_identity.sign(&proof_data);

    let response = LookupResponse::new(701, target, coords, proof);
    let payload = &response.encode()[1..];

    node.handle_lookup_response(&from, payload).await;

    let now_ms = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as u64)
        .unwrap_or(0);
    assert!(
        !node.coord_cache().contains(&target, now_ms),
        "Bad signature should NOT result in cached coords"
    );
}

#[tokio::test]
async fn test_response_identity_cache_miss() {
    // Verify that a response is discarded when the origin lacks the
    // target's pubkey in identity_cache (e.g., XK responder before msg3).
    let mut node = make_node();
    let from = make_node_addr(0xAA);

    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let root = make_node_addr(0xF0);
    let coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();

    // Do NOT register target in identity_cache

    let proof_data = LookupResponse::proof_bytes(702, &target, &coords);
    let proof = target_identity.sign(&proof_data);

    let response = LookupResponse::new(702, target, coords, proof);
    let payload = &response.encode()[1..];

    node.handle_lookup_response(&from, payload).await;

    let now_ms = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as u64)
        .unwrap_or(0);
    assert!(
        !node.coord_cache().contains(&target, now_ms),
        "identity_cache miss should discard the response"
    );
}

#[tokio::test]
async fn test_response_coord_substitution_detected() {
    // Verify that if the proof was signed with correct coords but
    // different coords are placed in the response, verification fails.
    let mut node = make_node();
    let from = make_node_addr(0xAA);

    let target_identity = Identity::generate();
    let target = *target_identity.node_addr();
    let root = make_node_addr(0xF0);
    let real_coords = TreeCoordinate::from_addrs(vec![target, root]).unwrap();
    let fake_coords = TreeCoordinate::from_addrs(vec![target, make_node_addr(0xEE), root]).unwrap();

    // Register target in identity_cache
    node.register_identity(target, target_identity.pubkey_full());

    // Sign proof with real coords
    let proof_data = LookupResponse::proof_bytes(703, &target, &real_coords);
    let proof = target_identity.sign(&proof_data);

    // But construct the response with FAKE coords
    let response = LookupResponse::new(703, target, fake_coords, proof);
    let payload = &response.encode()[1..];

    node.handle_lookup_response(&from, payload).await;

    let now_ms = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as u64)
        .unwrap_or(0);
    assert!(
        !node.coord_cache().contains(&target, now_ms),
        "Substituted coords should be detected and response discarded"
    );
}

// ============================================================================
// Unit Tests — RecentRequest Expiry
// ============================================================================