netindex 2.0.1

Immutable IP-range and ASN indexes with borrowed payloads
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

//! Conservative routing must never discard an exact match.

#![cfg(test)]

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

use netindex::{Builder, CoverageRouter, Error, Limits, Reader, Target};

#[test]
fn coverage_matches_bucket_boundaries_and_preserves_ranges_and_full_networks() {
    let cases = [
        vec![Target::Range {
            start: Ipv4Addr::from((63 << 20) + 7).into(),
            end: Ipv4Addr::from((129 << 20) + 3).into(),
        }],
        vec![Target::Range {
            start: Ipv6Addr::from((63u128 << 116) + 7).into(),
            end: Ipv6Addr::from((129u128 << 116) + 3).into(),
        }],
        vec![Target::Network {
            address: Ipv4Addr::UNSPECIFIED.into(),
            prefix: 0,
        }],
        vec![Target::Network {
            address: Ipv6Addr::UNSPECIFIED.into(),
            prefix: 0,
        }],
        vec![
            Target::Address(Ipv4Addr::BROADCAST.into()),
            Target::Address(Ipv6Addr::from(u128::MAX).into()),
        ],
        vec![Target::Asn(64512)],
        vec![],
    ];
    let readers: Vec<_> = cases.iter().map(|targets| reader(targets)).collect();
    let coverage: Vec<_> = readers.iter().map(|reader| reader.coverage()).collect();
    let router = CoverageRouter::new(&coverage).unwrap();

    for bucket in 0..4096u128 {
        for offset in [0, 3, 7, (1u128 << 20) - 1] {
            let address = IpAddr::from(Ipv4Addr::from(((bucket << 20) + offset) as u32));
            let candidates: Vec<_> = router.candidates(address).collect();

            assert_eq!(candidates.contains(&0), (63..=129).contains(&bucket));
            assert!(candidates.contains(&2));
            assert!(!candidates.contains(&1));
            assert!(!candidates.contains(&3));

            check_matches(&readers, &coverage, &candidates, address);
        }

        for offset in [0, 3, 7, (1u128 << 116) - 1] {
            let address = IpAddr::from(Ipv6Addr::from((bucket << 116) + offset));
            let candidates: Vec<_> = router.candidates(address).collect();

            assert_eq!(candidates.contains(&1), (63..=129).contains(&bucket));
            assert!(candidates.contains(&3));
            assert!(!candidates.contains(&0));
            assert!(!candidates.contains(&2));

            check_matches(&readers, &coverage, &candidates, address);
        }
    }
}

#[test]
fn routing_supports_empty_sets_and_the_highest_source_bit() {
    let empty = CoverageRouter::new(&[]).unwrap();
    let query = "203.0.113.42".parse().unwrap();

    assert_eq!(empty.candidates(query).count(), 0);

    let coverage = reader(&[Target::Address(query), Target::Address(query)]).coverage();
    let router = CoverageRouter::new(&vec![coverage.clone(); 64]).unwrap();

    assert_eq!(
        router.candidates(query).collect::<Vec<_>>(),
        (0..64).collect::<Vec<_>>()
    );

    assert!(matches!(
        CoverageRouter::new(&vec![coverage; 65]),
        Err(Error::Limit("routed readers"))
    ));
}

#[test]
fn fixed_components_produce_conservative_coverage() {
    for bytes in [
        include_bytes!("fixtures/interval.nidx").as_slice(),
        include_bytes!("fixtures/packed-ipv4.nidx").as_slice(),
        include_bytes!("fixtures/packed-ipv6.nidx").as_slice(),
        include_bytes!("fixtures/mixed.nidx").as_slice(),
    ] {
        let reader = Reader::open(bytes, Limits::default()).unwrap();
        let coverage = reader.coverage();

        reader
            .visit_all(|matched| {
                let address = match matched.target {
                    Target::Address(address) | Target::Network { address, .. } => address,
                    Target::Range { start, .. } => start,
                    Target::Asn(_) => return Ok::<_, Error>(()),
                };

                assert!(coverage.may_contain(address));

                Ok(())
            })
            .unwrap();
    }
}

fn reader(targets: &[Target]) -> Reader<Vec<u8>> {
    let mut builder = Builder::new(Limits::default());
    for &target in targets {
        builder.push(target, b"opaque").unwrap();
    }

    let mut bytes = Vec::new();
    builder.write_to(&mut bytes, b"").unwrap();

    Reader::open(bytes, Limits::default()).unwrap()
}

fn check_matches(
    readers: &[Reader<Vec<u8>>],
    coverage: &[netindex::Coverage],
    candidates: &[usize],
    address: IpAddr,
) {
    for (position, reader) in readers.iter().enumerate() {
        reader
            .visit_ip(address, |_| {
                assert!(coverage[position].may_contain(address));
                assert!(candidates.contains(&position));
                Ok::<_, Error>(())
            })
            .unwrap();
    }
}