flowscope 0.22.0

Passive flow & session tracking for packet capture (runtime-free, cross-platform)
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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
//! [`FiveTuple`] — protocol + (src, dst) endpoints.

use std::net::SocketAddr;

use super::parse::{self, ParsedL4};
use crate::{
    extractor::{Extracted, FlowExtractor, L4Proto, Orientation, TcpInfo},
    view::PacketView,
};

/// Standard 5-tuple flow extractor: protocol + source + destination
/// IP/port. Bidirectional by default — A→B and B→A merge into one
/// flow with [`Orientation::Forward`] / [`Orientation::Reverse`].
#[derive(Debug, Clone, Copy)]
pub struct FiveTuple {
    bidirectional: bool,
}

impl FiveTuple {
    /// A→B and B→A are tracked as **separate** flows.
    pub const fn directional() -> Self {
        Self {
            bidirectional: false,
        }
    }

    /// A→B and B→A are merged into one flow. The endpoints are
    /// canonically sorted into `(a, b)` where `a < b`.
    pub const fn bidirectional() -> Self {
        Self {
            bidirectional: true,
        }
    }

    /// Whether this extractor canonicalizes endpoint ordering.
    pub const fn is_bidirectional(&self) -> bool {
        self.bidirectional
    }
}

impl Default for FiveTuple {
    /// Defaults to bidirectional.
    fn default() -> Self {
        Self::bidirectional()
    }
}

/// Flow key for [`FiveTuple`].
///
/// In bidirectional mode, `a < b` (lexicographic on `SocketAddr`).
/// In directional mode, `a` is always source, `b` always destination.
#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct FiveTupleKey {
    pub proto: L4Proto,
    pub a: SocketAddr,
    pub b: SocketAddr,
}

impl FiveTupleKey {
    /// Construct a key from its parts. Endpoints are stored as
    /// given (no canonicalisation — that is the extractor's job);
    /// use this for tests, fixtures, and manual key construction
    /// now that the struct is `#[non_exhaustive]`.
    #[inline]
    pub fn new(proto: L4Proto, a: SocketAddr, b: SocketAddr) -> Self {
        Self { proto, a, b }
    }

    /// Convenience: matches either endpoint's port.
    ///
    /// Useful in idle-timeout predicates (see
    /// [`crate::FlowTracker::set_idle_timeout_fn`]) and any place
    /// where you want to route on "either side talks to port X."
    ///
    /// In bidirectional-mode flows (default), `a` and `b` are
    /// canonicalised lexicographically so neither is "source" —
    /// this helper avoids that footgun.
    #[inline]
    pub fn either_port(&self, port: u16) -> bool {
        self.a.port() == port || self.b.port() == port
    }

    /// Lower-numbered endpoint port — the "well-known" side for
    /// client/server flows. Useful for protocol labelling without
    /// having to remember which of `a` / `b` is which.
    ///
    /// New in 0.10.0.
    #[inline]
    pub fn well_known_port(&self) -> u16 {
        self.a.port().min(self.b.port())
    }

    /// Canonical short protocol label (`"http"`, `"tls/https"`,
    /// `"dns"`, …) for this flow, or `None` if neither endpoint
    /// hits a known port. See [`crate::well_known::protocol_label`]
    /// for the curated table and disambiguation rules.
    ///
    /// New in 0.10.0.
    #[inline]
    pub fn protocol_label(&self) -> Option<&'static str> {
        crate::well_known::protocol_label(self.proto, self.a.port(), self.b.port())
    }

    /// Construct a canonical `FiveTupleKey` from a partial
    /// 5-tuple (typically the embedded original 5-tuple from
    /// an ICMPv4 / ICMPv6 error message — see
    /// [`crate::icmp::IcmpInner`]).
    ///
    /// Applies the same `src > dst`-swap canonicalisation that
    /// [`FiveTuple::bidirectional()`]'s extractor uses, so the
    /// returned key matches the live flow's key regardless of
    /// which direction the flow started in.
    ///
    /// Returns `None` if a port-carrying proto (TCP / UDP /
    /// SCTP) has missing ports — without ports the lookup
    /// can't disambiguate the flow.
    ///
    /// **Bidirectional-extractor assumption**: this method
    /// produces a key matching the standard
    /// `FiveTuple::bidirectional()` extractor. If your tracker
    /// runs `FiveTuple::unidirectional()`, the returned key
    /// may not match the live flow's literal orientation —
    /// call [`Self::from_inner_literal`] instead, or call this
    /// method with the inner's `src` and `dst` swapped if you
    /// know the flow was responder-initiated.
    ///
    /// Plan 161 (0.14).
    #[cfg(feature = "icmp")]
    pub fn from_inner_canonical(inner: &crate::icmp::IcmpInner) -> Option<Self> {
        use crate::extractor::L4Proto;
        let needs_ports = matches!(inner.proto, L4Proto::Tcp | L4Proto::Udp | L4Proto::Sctp);
        let src_port = if needs_ports {
            inner.src_port?
        } else {
            inner.src_port.unwrap_or(0)
        };
        let dst_port = if needs_ports {
            inner.dst_port?
        } else {
            inner.dst_port.unwrap_or(0)
        };
        let src = SocketAddr::new(inner.src, src_port);
        let dst = SocketAddr::new(inner.dst, dst_port);
        // Mirror the canonicalisation in extract_from_parsed
        // (file head, line ~186).
        let (a, b) = if src > dst { (dst, src) } else { (src, dst) };
        Some(FiveTupleKey {
            proto: inner.proto,
            a,
            b,
        })
    }

    /// Construct a `FiveTupleKey` from an [`crate::icmp::IcmpInner`]
    /// preserving the literal `(src, dst)` orientation —
    /// **does not** apply the bidirectional canonicalisation.
    ///
    /// Use this when the live tracker runs
    /// `FiveTuple::unidirectional()` and the caller wants to
    /// match flows by literal orientation. For bidirectional
    /// trackers, prefer [`Self::from_inner_canonical`].
    ///
    /// Same `None`-on-missing-ports contract as
    /// [`Self::from_inner_canonical`].
    ///
    /// Plan 161 (0.14).
    #[cfg(feature = "icmp")]
    pub fn from_inner_literal(inner: &crate::icmp::IcmpInner) -> Option<Self> {
        use crate::extractor::L4Proto;
        let needs_ports = matches!(inner.proto, L4Proto::Tcp | L4Proto::Udp | L4Proto::Sctp);
        let src_port = if needs_ports {
            inner.src_port?
        } else {
            inner.src_port.unwrap_or(0)
        };
        let dst_port = if needs_ports {
            inner.dst_port?
        } else {
            inner.dst_port.unwrap_or(0)
        };
        Some(FiveTupleKey {
            proto: inner.proto,
            a: SocketAddr::new(inner.src, src_port),
            b: SocketAddr::new(inner.dst, dst_port),
        })
    }

    /// Always-`Some` companion to [`Self::protocol_label`].
    /// Falls back to [`crate::L4Proto::canonical_name`] when
    /// no port-based label matches.
    ///
    /// Use this for bandwidth-by-app and metric-label reports
    /// where "we don't know the L7 app, but we know the L4" is
    /// the right fallback. Use `protocol_label()` directly when
    /// an L7 label is the *only* acceptable answer. Use
    /// [`Self::app_label_with`] for site-custom port overrides
    /// via [`crate::well_known::LabelTable`].
    ///
    /// Examples:
    /// - `(TCP, 80, 33000)` → `"http"` (well-known port match)
    /// - `(TCP, 33000, 33001)` → `"tcp"` (L4 fallback)
    /// - `(SCTP, 100, 200)` → `"sctp"` (L4 fallback)
    ///
    /// Plan 163 (0.14).
    #[inline]
    pub fn app_label(&self) -> &'static str {
        self.protocol_label()
            .unwrap_or_else(|| self.proto.canonical_name())
    }

    /// Companion to [`Self::protocol_label`] that consults a
    /// caller-provided [`crate::well_known::LabelTable`]
    /// first. The table can override or extend the built-in
    /// well-known ports — typically used for site-custom
    /// services ("our gRPC on 8765").
    ///
    /// Plan 165 (0.14).
    #[inline]
    pub fn protocol_label_with(
        &self,
        table: &crate::well_known::LabelTable,
    ) -> Option<&'static str> {
        table.lookup(self.proto, self.a.port(), self.b.port())
    }

    /// Always-`Some` variant of [`Self::protocol_label_with`].
    /// Falls back to [`crate::L4Proto::canonical_name`] when
    /// neither the table override nor (if inherited) the
    /// built-in dispatch matches.
    ///
    /// Use [`Self::app_label`] (no `_with`) when no site-custom
    /// overrides are needed.
    ///
    /// Plan 165 (0.14).
    #[inline]
    pub fn app_label_with(&self, table: &crate::well_known::LabelTable) -> &'static str {
        self.protocol_label_with(table)
            .unwrap_or_else(|| self.proto.canonical_name())
    }

    /// Seed-fixed 64-bit hash over the canonical (direction-
    /// normalized) 5-tuple — **reproducible across threads and
    /// processes** (unlike `#[derive(Hash)]` through a random
    /// `RandomState`). A→B and B→A produce the same value.
    ///
    /// This is the infallible companion to
    /// [`crate::KeyFields::stable_hash`] (a `FiveTupleKey` always
    /// carries a full 5-tuple). It is a fast, **non-portable**
    /// in-process hash — for the portable cross-tool flow id (what the
    /// EVE / NDJSON writers emit since 0.19) use
    /// [`Self::community_id`]. Use this to shard a merged flow table so
    /// both legs of a flow land on the same worker — see
    /// [`Self::shard_index`].
    ///
    /// Issue #76 (folds #70).
    #[inline]
    pub fn stable_hash(&self) -> u64 {
        let mut id_buf = [0u8; 1];
        let proto: &[u8] = match crate::KeyFields::proto_str(&self.proto) {
            Some(s) => s.as_bytes(),
            None => {
                id_buf[0] = self.proto.as_u8();
                &id_buf
            }
        };
        crate::anomaly_fields::fnv1a_five_tuple(
            proto,
            self.a.ip(),
            self.a.port(),
            self.b.ip(),
            self.b.port(),
        )
    }

    /// Deterministic shard index in `0..n` (or `0` if `n == 0`).
    /// Both directions of a flow map to the same shard across
    /// processes — the correctness requirement for tap-merge
    /// sharding. Built on [`Self::stable_hash`].
    ///
    /// Issue #76 (folds #70).
    #[inline]
    pub fn shard_index(&self, n: usize) -> usize {
        if n == 0 {
            return 0;
        }
        (self.stable_hash() % n as u64) as usize
    }

    /// [Corelight Community ID](https://github.com/corelight/community-id-spec)
    /// v1 (universal default seed 0) — the cross-tool flow id for
    /// pivoting flowscope output against Zeek / Suricata / Security
    /// Onion. TCP/UDP/SCTP are exact; ICMP is stable but not
    /// spec-compatible (see [`crate::community_id`]).
    ///
    /// Requires the `community-id` feature. Issue #76.
    #[cfg(feature = "community-id")]
    #[inline]
    pub fn community_id(&self) -> String {
        self.community_id_seeded(0)
    }

    /// [`Self::community_id`] with an explicit sensor seed.
    #[cfg(feature = "community-id")]
    #[inline]
    pub fn community_id_seeded(&self, seed: u16) -> String {
        crate::community_id::community_id_v1(
            self.proto.as_u8(),
            self.a.ip(),
            self.a.port(),
            self.b.ip(),
            self.b.port(),
            seed,
        )
    }
}

impl crate::KeyFields for FiveTupleKey {
    fn src_ip(&self) -> Option<std::net::IpAddr> {
        Some(self.a.ip())
    }
    fn src_port(&self) -> Option<u16> {
        Some(self.a.port())
    }
    fn dest_ip(&self) -> Option<std::net::IpAddr> {
        Some(self.b.ip())
    }
    fn dest_port(&self) -> Option<u16> {
        Some(self.b.port())
    }
    fn proto_str(&self) -> Option<&'static str> {
        self.proto.proto_str()
    }
    fn protocol_identifier(&self) -> Option<u8> {
        Some(self.proto.as_u8())
    }
    /// Best-effort app-protocol from the well-known port table.
    fn app_proto_str(&self) -> Option<&'static str> {
        crate::well_known::protocol_label(self.proto, self.a.port(), self.b.port())
    }
}

impl FlowExtractor for FiveTuple {
    type Key = FiveTupleKey;

    fn extract(&self, view: PacketView<'_>) -> Option<Extracted<FiveTupleKey>> {
        let parsed = parse::parse_eth(view.frame)?;
        extract_from_parsed(parsed, self.bidirectional)
    }
}

/// Shared logic between L2 and post-decap (raw IP) entry points.
/// Used by [`crate::extract::InnerGtpU`] for inner-flow keying.
pub(crate) fn extract_from_parsed(
    parsed: parse::ParsedFrame<'_>,
    bidirectional: bool,
) -> Option<Extracted<FiveTupleKey>> {
    let ip = parsed.ip?;
    let (src_port, dst_port, l4, tcp_info) = match parsed.l4 {
        Some(ParsedL4::Tcp(t)) => (
            t.src_port,
            t.dst_port,
            L4Proto::Tcp,
            Some(TcpInfo {
                flags: t.flags,
                seq: t.seq,
                ack: t.ack,
                payload_offset: t.payload_offset,
                payload_len: t.payload_len,
                window: t.window,
            }),
        ),
        Some(ParsedL4::Udp(u)) => (u.src_port, u.dst_port, L4Proto::Udp, None),
        Some(ParsedL4::Other) | None => {
            // ICMP / ICMPv6 / SCTP / unknown — keep the flow but
            // ports are unavailable.
            let l4 = match ip.proto {
                1 => L4Proto::Icmp,
                58 => L4Proto::IcmpV6,
                132 => L4Proto::Sctp,
                p => L4Proto::Other(p),
            };
            (0u16, 0u16, l4, None)
        }
    };

    let src = SocketAddr::new(ip.src, src_port);
    let dst = SocketAddr::new(ip.dst, dst_port);

    let (a, b, orientation) = if bidirectional && src > dst {
        (dst, src, Orientation::Reverse)
    } else {
        (src, dst, Orientation::Forward)
    };

    Some(Extracted {
        key: FiveTupleKey { proto: l4, a, b },
        orientation,
        l4: Some(l4),
        tcp: tcp_info,
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{Timestamp, extract::parse::test_frames::*, extractor::TcpFlags};

    #[test]
    fn syn_packet_forward() {
        let f = ipv4_tcp(
            [0; 6],
            [0; 6],
            [10, 0, 0, 1],
            [10, 0, 0, 2],
            1234,
            80,
            1000,
            0,
            0x02,
            b"",
        );
        let view = PacketView::new(&f, Timestamp::default());
        let e = FiveTuple::bidirectional().extract(view).unwrap();
        assert_eq!(e.key.proto, L4Proto::Tcp);
        // 10.0.0.1:1234 < 10.0.0.2:80 in SocketAddr ordering, so a=src.
        assert_eq!(e.orientation, Orientation::Forward);
        assert!(e.tcp.is_some());
        let tcp = e.tcp.unwrap();
        assert!(tcp.flags.contains(TcpFlags::SYN));
        assert_eq!(tcp.seq, 1000);
    }

    #[test]
    fn bidirectional_canonicalizes() {
        // A→B (forward) and B→A (reverse) should yield the same key
        // but opposite orientations.
        let fwd = ipv4_tcp(
            [0; 6],
            [0; 6],
            [10, 0, 0, 1],
            [10, 0, 0, 2],
            1234,
            80,
            1000,
            0,
            0x02,
            b"",
        );
        let rev = ipv4_tcp(
            [0; 6],
            [0; 6],
            [10, 0, 0, 2],
            [10, 0, 0, 1],
            80,
            1234,
            0,
            1001,
            0x12,
            b"",
        );
        let e_fwd = FiveTuple::bidirectional()
            .extract(PacketView::new(&fwd, Timestamp::default()))
            .unwrap();
        let e_rev = FiveTuple::bidirectional()
            .extract(PacketView::new(&rev, Timestamp::default()))
            .unwrap();
        assert_eq!(e_fwd.key, e_rev.key, "keys must match");
        assert_ne!(e_fwd.orientation, e_rev.orientation);
    }

    #[test]
    fn directional_distinguishes_directions() {
        let fwd = ipv4_tcp(
            [0; 6],
            [0; 6],
            [10, 0, 0, 1],
            [10, 0, 0, 2],
            1234,
            80,
            0,
            0,
            0x02,
            b"",
        );
        let rev = ipv4_tcp(
            [0; 6],
            [0; 6],
            [10, 0, 0, 2],
            [10, 0, 0, 1],
            80,
            1234,
            0,
            0,
            0x12,
            b"",
        );
        let e_fwd = FiveTuple::directional()
            .extract(PacketView::new(&fwd, Timestamp::default()))
            .unwrap();
        let e_rev = FiveTuple::directional()
            .extract(PacketView::new(&rev, Timestamp::default()))
            .unwrap();
        assert_ne!(e_fwd.key, e_rev.key, "directional keys must differ");
    }

    #[test]
    fn udp_no_tcp_info() {
        let f = ipv4_udp([1, 2, 3, 4], [5, 6, 7, 8], 53, 5353, b"hello");
        let e = FiveTuple::bidirectional()
            .extract(PacketView::new(&f, Timestamp::default()))
            .unwrap();
        assert_eq!(e.key.proto, L4Proto::Udp);
        assert!(e.tcp.is_none());
    }

    #[test]
    fn ipv6_supported() {
        let f = ipv6_tcp(
            [0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1],
            [0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2],
            1,
            2,
            0,
            0x02,
            b"",
        );
        let e = FiveTuple::bidirectional()
            .extract(PacketView::new(&f, Timestamp::default()))
            .unwrap();
        assert_eq!(e.key.proto, L4Proto::Tcp);
    }

    #[test]
    fn malformed_returns_none() {
        let f = [0u8; 4];
        assert!(
            FiveTuple::bidirectional()
                .extract(PacketView::new(&f, Timestamp::default()))
                .is_none()
        );
    }

    #[test]
    fn key_hash_eq_consistency() {
        use std::collections::HashSet;
        let f1 = ipv4_tcp(
            [0; 6],
            [0; 6],
            [1, 1, 1, 1],
            [2, 2, 2, 2],
            10,
            20,
            0,
            0,
            0x02,
            b"",
        );
        let f2 = ipv4_tcp(
            [0; 6],
            [0; 6],
            [2, 2, 2, 2],
            [1, 1, 1, 1],
            20,
            10,
            0,
            0,
            0x12,
            b"",
        );
        let e1 = FiveTuple::bidirectional()
            .extract(PacketView::new(&f1, Timestamp::default()))
            .unwrap();
        let e2 = FiveTuple::bidirectional()
            .extract(PacketView::new(&f2, Timestamp::default()))
            .unwrap();
        let mut set = HashSet::new();
        set.insert(e1.key);
        set.insert(e2.key);
        assert_eq!(set.len(), 1, "bidirectional keys must hash equal");
    }

    // ── Plan 163 (0.14) — app_label + canonical_name tests ──

    use std::net::SocketAddr;

    fn tuple(proto: L4Proto, a_port: u16, b_port: u16) -> FiveTupleKey {
        FiveTupleKey {
            proto,
            a: SocketAddr::from(([10, 0, 0, 1], a_port)),
            b: SocketAddr::from(([10, 0, 0, 2], b_port)),
        }
    }

    #[test]
    fn canonical_name_returns_lowercase_slug_for_every_l4proto() {
        assert_eq!(L4Proto::Tcp.canonical_name(), "tcp");
        assert_eq!(L4Proto::Udp.canonical_name(), "udp");
        assert_eq!(L4Proto::Icmp.canonical_name(), "icmp");
        assert_eq!(L4Proto::IcmpV6.canonical_name(), "icmp6");
        assert_eq!(L4Proto::Sctp.canonical_name(), "sctp");
    }

    #[test]
    fn canonical_name_returns_other_for_other_variant() {
        assert_eq!(L4Proto::Other(132).canonical_name(), "other");
    }

    #[test]
    fn app_label_returns_well_known_label_when_port_matches() {
        // Port 80 hits the well-known TCP table → "http".
        let k = tuple(L4Proto::Tcp, 80, 33000);
        assert_eq!(k.app_label(), "http");
        // Reverse direction also matches.
        let k = tuple(L4Proto::Tcp, 33000, 80);
        assert_eq!(k.app_label(), "http");
    }

    #[test]
    fn app_label_falls_back_to_canonical_name_when_no_port_match() {
        // No well-known TCP port → "tcp".
        let k = tuple(L4Proto::Tcp, 33000, 33001);
        assert_eq!(k.app_label(), "tcp");
        // SCTP — no well-known port table at all → "sctp".
        let k = tuple(L4Proto::Sctp, 100, 200);
        assert_eq!(k.app_label(), "sctp");
        // Unknown L4 → "other".
        let k = tuple(L4Proto::Other(99), 100, 200);
        assert_eq!(k.app_label(), "other");
    }

    #[test]
    fn app_label_and_proto_str_remain_distinct() {
        // proto_str is uppercase + Option<&'static str>;
        // canonical_name is lowercase + always-Some.
        use crate::KeyFields;
        assert_eq!(L4Proto::Tcp.proto_str(), Some("TCP"));
        assert_eq!(L4Proto::Tcp.canonical_name(), "tcp");
        assert_eq!(L4Proto::Other(42).proto_str(), None);
        assert_eq!(L4Proto::Other(42).canonical_name(), "other");
    }

    fn key(proto: L4Proto, a: [u8; 4], ap: u16, b: [u8; 4], bp: u16) -> FiveTupleKey {
        FiveTupleKey {
            proto,
            a: SocketAddr::from((a, ap)),
            b: SocketAddr::from((b, bp)),
        }
    }

    #[test]
    fn stable_hash_is_direction_invariant() {
        let fwd = key(L4Proto::Tcp, [10, 0, 0, 1], 1234, [10, 0, 0, 2], 80);
        let rev = key(L4Proto::Tcp, [10, 0, 0, 2], 80, [10, 0, 0, 1], 1234);
        assert_eq!(fwd.stable_hash(), rev.stable_hash());
        // Distinct flows differ.
        let other = key(L4Proto::Tcp, [10, 0, 0, 1], 1234, [10, 0, 0, 3], 80);
        assert_ne!(fwd.stable_hash(), other.stable_hash());
    }

    #[test]
    fn stable_hash_matches_keyfields_trait() {
        use crate::KeyFields;
        let k = key(L4Proto::Udp, [10, 0, 0, 1], 5000, [8, 8, 8, 8], 53);
        // The inherent infallible value equals the trait's Option value.
        assert_eq!(Some(k.stable_hash()), KeyFields::stable_hash(&k));
    }

    #[test]
    fn stable_hash_infallible_for_other_proto() {
        // proto_str is None for Other(_), but the inherent hash still
        // works (falls back to the numeric id) and is direction-stable.
        let fwd = key(L4Proto::Other(99), [10, 0, 0, 1], 0, [10, 0, 0, 2], 0);
        let rev = key(L4Proto::Other(99), [10, 0, 0, 2], 0, [10, 0, 0, 1], 0);
        assert_eq!(fwd.stable_hash(), rev.stable_hash());
    }

    #[test]
    fn shard_index_in_range_and_coherent() {
        let fwd = key(L4Proto::Tcp, [10, 0, 0, 1], 1234, [10, 0, 0, 2], 80);
        let rev = key(L4Proto::Tcp, [10, 0, 0, 2], 80, [10, 0, 0, 1], 1234);
        for n in [1usize, 4, 16, 256] {
            let s = fwd.shard_index(n);
            assert!(s < n);
            // Both legs of a flow land on the same shard.
            assert_eq!(s, rev.shard_index(n));
        }
        assert_eq!(fwd.shard_index(0), 0); // n == 0 guard
    }

    #[cfg(feature = "community-id")]
    #[test]
    fn community_id_matches_golden_vector() {
        // Same published TCP vector as the community_id module test,
        // reached through the key method.
        let k = key(
            L4Proto::Tcp,
            [128, 232, 110, 120],
            34855,
            [66, 35, 250, 204],
            80,
        );
        assert_eq!(k.community_id(), "1:LQU9qZlK+B5F3KDmev6m5PMibrg=");
        // Direction-invariant via the key too.
        let rev = key(
            L4Proto::Tcp,
            [66, 35, 250, 204],
            80,
            [128, 232, 110, 120],
            34855,
        );
        assert_eq!(k.community_id(), rev.community_id());
    }
}