bgpkit_parser/models/network/
afi.rs

1use num_enum::{IntoPrimitive, TryFromPrimitive};
2use std::net::IpAddr;
3
4/// AFI -- Address Family Identifier
5///
6/// <https://www.iana.org/assignments/address-family-numbers/address-family-numbers.xhtml>
7#[derive(Debug, PartialEq, TryFromPrimitive, IntoPrimitive, Clone, Copy, Eq, Hash)]
8#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
9#[repr(u16)]
10pub enum Afi {
11    Ipv4 = 1,
12    Ipv6 = 2,
13    /// BGP Link-State - RFC 7752
14    LinkState = 16388,
15}
16
17impl From<IpAddr> for Afi {
18    #[inline]
19    fn from(value: IpAddr) -> Self {
20        match value {
21            IpAddr::V4(_) => Afi::Ipv4,
22            IpAddr::V6(_) => Afi::Ipv6,
23        }
24    }
25}
26
27/// SAFI -- Subsequent Address Family Identifier
28///
29/// SAFI can be: Unicast, Multicast, or both, as well as MPLS VPN variants.
30/// The AFI determines the IP version (IPv4/IPv6), while SAFI determines the application.
31///
32/// References:
33/// - RFC 4760: Multiprotocol Extensions for BGP-4
34/// - RFC 4364: BGP/MPLS IP Virtual Private Networks (VPNs) - defines SAFI 128
35/// - RFC 6514: BGP Signaling of Multicast VPNs - defines SAFI 129
36/// - RFC 7752: BGP Link-State - defines SAFI 71, 72
37/// - RFC 8950: Advertising IPv4 Network Layer Reachability Information (NLRI) with an IPv6 Next Hop
38#[derive(Debug, PartialEq, TryFromPrimitive, IntoPrimitive, Clone, Copy, Eq, Hash)]
39#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
40#[repr(u8)]
41pub enum Safi {
42    Unicast = 1,
43    Multicast = 2,
44    UnicastMulticast = 3,
45    /// BGP Link-State - RFC 7752
46    LinkState = 71,
47    /// BGP Link-State VPN - RFC 7752
48    LinkStateVpn = 72,
49    /// MPLS-labeled VPN address - RFC 4364, used in RFC 8950 Section 4
50    /// Works with both AFI 1 (VPN-IPv4) and AFI 2 (VPN-IPv6)
51    MplsVpn = 128,
52    /// Multicast for BGP/MPLS IP VPNs - RFC 6514
53    /// Works with both AFI 1 (Multicast VPN-IPv4) and AFI 2 (Multicast VPN-IPv6)
54    MulticastVpn = 129,
55    /// Flow Specification - RFC 8955/8956
56    /// Works with both AFI 1 (IPv4 Flow-Spec) and AFI 2 (IPv6 Flow-Spec)
57    FlowSpec = 133,
58    /// L3VPN Flow Specification - RFC 8955/8956
59    /// Works with both AFI 1 (VPN-IPv4 Flow-Spec) and AFI 2 (VPN-IPv6 Flow-Spec)
60    FlowSpecL3Vpn = 134,
61}
62
63#[cfg(test)]
64mod tests {
65    use super::*;
66
67    #[test]
68    fn test_afi_from() {
69        assert_eq!(
70            Afi::from(IpAddr::V4(std::net::Ipv4Addr::new(127, 0, 0, 1))),
71            Afi::Ipv4
72        );
73        assert_eq!(
74            Afi::from(IpAddr::V6(std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1))),
75            Afi::Ipv6
76        );
77    }
78
79    #[test]
80    fn test_afi_safi_repr() {
81        assert_eq!(Afi::Ipv4 as u16, 1);
82        assert_eq!(Afi::Ipv6 as u16, 2);
83        assert_eq!(Afi::LinkState as u16, 16388);
84
85        assert_eq!(Safi::Unicast as u8, 1);
86        assert_eq!(Safi::Multicast as u8, 2);
87        assert_eq!(Safi::UnicastMulticast as u8, 3);
88        // RFC 7752 Link-State SAFI values
89        assert_eq!(Safi::LinkState as u8, 71);
90        assert_eq!(Safi::LinkStateVpn as u8, 72);
91        // RFC 8950 VPN SAFI values
92        assert_eq!(Safi::MplsVpn as u8, 128);
93        assert_eq!(Safi::MulticastVpn as u8, 129);
94        // RFC 8955/8956 Flow-Spec SAFI values
95        assert_eq!(Safi::FlowSpec as u8, 133);
96        assert_eq!(Safi::FlowSpecL3Vpn as u8, 134);
97    }
98
99    #[test]
100    #[cfg(feature = "serde")]
101    fn test_afi_safi_serde() {
102        let afi = Afi::Ipv4;
103        let serialized = serde_json::to_string(&afi).unwrap();
104        assert_eq!(serialized, "\"Ipv4\"");
105        let deserialized: Afi = serde_json::from_str(&serialized).unwrap();
106        assert_eq!(deserialized, afi);
107
108        let afi = Afi::Ipv6;
109        let serialized = serde_json::to_string(&afi).unwrap();
110        assert_eq!(serialized, "\"Ipv6\"");
111        let deserialized: Afi = serde_json::from_str(&serialized).unwrap();
112        assert_eq!(deserialized, afi);
113
114        let safi = Safi::Unicast;
115        let serialized = serde_json::to_string(&safi).unwrap();
116        assert_eq!(serialized, "\"Unicast\"");
117        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
118        assert_eq!(deserialized, safi);
119
120        let safi = Safi::Multicast;
121        let serialized = serde_json::to_string(&safi).unwrap();
122        assert_eq!(serialized, "\"Multicast\"");
123        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
124        assert_eq!(deserialized, safi);
125
126        let safi = Safi::UnicastMulticast;
127        let serialized = serde_json::to_string(&safi).unwrap();
128        assert_eq!(serialized, "\"UnicastMulticast\"");
129        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
130        assert_eq!(deserialized, safi);
131
132        // RFC 8950 VPN SAFI variants
133        let safi = Safi::MplsVpn;
134        let serialized = serde_json::to_string(&safi).unwrap();
135        assert_eq!(serialized, "\"MplsVpn\"");
136        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
137        assert_eq!(deserialized, safi);
138
139        let safi = Safi::MulticastVpn;
140        let serialized = serde_json::to_string(&safi).unwrap();
141        assert_eq!(serialized, "\"MulticastVpn\"");
142        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
143        assert_eq!(deserialized, safi);
144
145        // RFC 8955/8956 Flow-Spec SAFI variants
146        let safi = Safi::FlowSpec;
147        let serialized = serde_json::to_string(&safi).unwrap();
148        assert_eq!(serialized, "\"FlowSpec\"");
149        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
150        assert_eq!(deserialized, safi);
151
152        let safi = Safi::FlowSpecL3Vpn;
153        let serialized = serde_json::to_string(&safi).unwrap();
154        assert_eq!(serialized, "\"FlowSpecL3Vpn\"");
155        let deserialized: Safi = serde_json::from_str(&serialized).unwrap();
156        assert_eq!(deserialized, safi);
157    }
158}
bgpkit_parser/models/network/afi.rs

bgpkit_parser/models/network/
afi.rs
