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
//! MRT table dump version 2 structs
use crate::models::*;
use bitflags::bitflags;
use num_enum::{IntoPrimitive, TryFromPrimitive};
use std::collections::HashMap;
use std::net::{IpAddr, Ipv4Addr};
use std::str::FromStr;
/// TableDump message version 2 enum
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TableDumpV2Message {
PeerIndexTable(PeerIndexTable),
RibAfi(RibAfiEntries),
/// Currently unsupported
RibGeneric(RibGenericEntries),
}
impl TableDumpV2Message {
pub const fn dump_type(&self) -> TableDumpV2Type {
match self {
TableDumpV2Message::PeerIndexTable(_) => TableDumpV2Type::PeerIndexTable,
TableDumpV2Message::RibAfi(x) => x.rib_type,
TableDumpV2Message::RibGeneric(_) => TableDumpV2Type::RibGeneric,
}
}
}
/// TableDump version 2 subtypes.
///
/// <https://www.iana.org/assignments/mrt/mrt.xhtml#subtype-codes>
#[derive(Debug, TryFromPrimitive, IntoPrimitive, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(u16)]
pub enum TableDumpV2Type {
PeerIndexTable = 1,
RibIpv4Unicast = 2,
RibIpv4Multicast = 3,
RibIpv6Unicast = 4,
RibIpv6Multicast = 5,
RibGeneric = 6,
GeoPeerTable = 7,
RibIpv4UnicastAddPath = 8,
RibIpv4MulticastAddPath = 9,
RibIpv6UnicastAddPath = 10,
RibIpv6MulticastAddPath = 11,
RibGenericAddPath = 12,
}
/// AFI/SAFI-Specific RIB Subtypes.
///
/// ```text
/// The AFI/SAFI-specific RIB Subtypes consist of the RIB_IPV4_UNICAST,
/// RIB_IPV4_MULTICAST, RIB_IPV6_UNICAST, and RIB_IPV6_MULTICAST
/// Subtypes. These specific RIB table entries are given their own MRT
/// TABLE_DUMP_V2 subtypes as they are the most common type of RIB table
/// instances, and providing specific MRT subtypes for them permits more
/// compact encodings. These subtypes permit a single MRT record to
/// encode multiple RIB table entries for a single prefix. The Prefix
/// Length and Prefix fields are encoded in the same manner as the BGP
/// NLRI encoding for IPv4 and IPv6 prefixes. Namely, the Prefix field
/// contains address prefixes followed by enough trailing bits to make
/// the end of the field fall on an octet boundary. The value of
/// trailing bits is irrelevant.
///
/// 0 1 2 3
/// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Sequence Number |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Prefix Length |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Prefix (variable) |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Entry Count | RIB Entries (variable)
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct RibAfiEntries {
pub rib_type: TableDumpV2Type,
pub sequence_number: u32,
pub prefix: NetworkPrefix,
pub rib_entries: Vec<RibEntry>,
}
/// RIB generic entries subtype.
///
/// ```text
/// The RIB_GENERIC header is shown below. It is used to cover RIB
/// entries that do not fall under the common case entries defined above.
/// It consists of an AFI, Subsequent AFI (SAFI), and a single NLRI
/// entry. The NLRI information is specific to the AFI and SAFI values.
/// An implementation that does not recognize particular AFI and SAFI
/// values SHOULD discard the remainder of the MRT record.
/// 0 1 2 3
/// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Sequence Number |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Address Family Identifier |Subsequent AFI |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Network Layer Reachability Information (variable) |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Entry Count | RIB Entries (variable)
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct RibGenericEntries {
pub sequence_number: u32,
pub afi: Afi,
pub safi: Safi,
pub nlri: NetworkPrefix,
pub rib_entries: Vec<RibEntry>,
}
/// RIB entry.
///
/// ```text
/// The RIB Entries are repeated Entry Count times. These entries share
/// a common format as shown below. They include a Peer Index from the
/// PEER_INDEX_TABLE MRT record, an originated time for the RIB Entry,
/// and the BGP path attribute length and attributes. All AS numbers in
/// the AS_PATH attribute MUST be encoded as 4-byte AS numbers.
///
/// 0 1 2 3
/// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Peer Index |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Originated Time |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Attribute Length |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | BGP Attributes... (variable)
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct RibEntry {
pub peer_index: u16,
pub originated_time: u32,
pub attributes: Attributes,
}
/// peer index table.
///
/// ```text
/// An initial PEER_INDEX_TABLE MRT record provides the BGP ID of the
/// collector, an OPTIONAL view name, and a list of indexed peers.
/// Following the PEER_INDEX_TABLE MRT record, a series of MRT records is
/// used to encode RIB table entries. This series of MRT records uses
/// subtypes 2-6 and is separate from the PEER_INDEX_TABLE MRT record
/// itself and includes full MRT record headers. The RIB entry MRT
/// records MUST immediately follow the PEER_INDEX_TABLE MRT record.
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PeerIndexTable {
pub collector_bgp_id: BgpIdentifier,
pub view_name: String,
pub id_peer_map: HashMap<u16, Peer>,
pub peer_addr_id_map: HashMap<IpAddr, u16>,
}
impl Default for PeerIndexTable {
fn default() -> Self {
PeerIndexTable {
collector_bgp_id: Ipv4Addr::from_str("0.0.0.0").unwrap(),
view_name: "".to_string(),
id_peer_map: HashMap::new(),
peer_addr_id_map: HashMap::new(),
}
}
}
bitflags! {
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PeerType: u8 {
const AS_SIZE_32BIT = 0x2;
const ADDRESS_FAMILY_IPV6 = 0x1;
}
}
/// Peer struct.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Peer {
pub peer_type: PeerType,
pub peer_bgp_id: BgpIdentifier,
pub peer_address: IpAddr,
pub peer_asn: Asn,
}
impl Peer {
pub fn new(peer_bgp_id: BgpIdentifier, peer_address: IpAddr, peer_asn: Asn) -> Self {
let mut peer_type = PeerType::empty();
if peer_asn.is_four_byte() {
peer_type.insert(PeerType::AS_SIZE_32BIT);
}
if peer_address.is_ipv6() {
peer_type.insert(PeerType::ADDRESS_FAMILY_IPV6);
}
Peer {
peer_type,
peer_bgp_id,
peer_address,
peer_asn,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
// Create a helper function to initialize Peer structure
fn create_peer() -> Peer {
let bgp_id = Ipv4Addr::from_str("1.1.1.1").unwrap();
let peer_address: IpAddr = Ipv4Addr::from_str("2.2.2.2").unwrap().into();
// Assuming Asn::new(u32) is defined.
let asn = Asn::new_32bit(65000);
Peer::new(bgp_id, peer_address, asn)
}
#[test]
fn test_peer_new() {
let peer = create_peer();
assert_eq!(peer.peer_type, PeerType::AS_SIZE_32BIT);
assert_eq!(peer.peer_bgp_id, Ipv4Addr::from_str("1.1.1.1").unwrap());
assert_eq!(
peer.peer_address,
IpAddr::V4(Ipv4Addr::from_str("2.2.2.2").unwrap())
);
assert_eq!(peer.peer_asn, Asn::new_32bit(65000));
}
#[test]
fn test_default_peer_index_table() {
let peer_index_table = PeerIndexTable::default();
assert_eq!(
peer_index_table.collector_bgp_id,
Ipv4Addr::from_str("0.0.0.0").unwrap()
);
assert_eq!(peer_index_table.view_name, "".to_string());
assert_eq!(peer_index_table.id_peer_map, HashMap::new());
assert_eq!(peer_index_table.peer_addr_id_map, HashMap::new());
}
#[test]
fn test_peer_type_flags() {
let mut peer_type = PeerType::empty();
assert_eq!(peer_type, PeerType::empty());
peer_type.insert(PeerType::AS_SIZE_32BIT);
assert_eq!(peer_type, PeerType::AS_SIZE_32BIT);
peer_type.insert(PeerType::ADDRESS_FAMILY_IPV6);
assert_eq!(
peer_type,
PeerType::AS_SIZE_32BIT | PeerType::ADDRESS_FAMILY_IPV6
);
peer_type.remove(PeerType::AS_SIZE_32BIT);
assert_eq!(peer_type, PeerType::ADDRESS_FAMILY_IPV6);
peer_type.remove(PeerType::ADDRESS_FAMILY_IPV6);
assert_eq!(peer_type, PeerType::empty());
}
#[test]
fn test_dump_type() {
let peer_index_table = TableDumpV2Message::PeerIndexTable(PeerIndexTable::default());
assert_eq!(
peer_index_table.dump_type(),
TableDumpV2Type::PeerIndexTable
);
let rib_afi = TableDumpV2Message::RibAfi(RibAfiEntries {
rib_type: TableDumpV2Type::RibIpv4Unicast,
sequence_number: 1,
prefix: NetworkPrefix::from_str("10.0.0.0/24").unwrap(),
rib_entries: vec![],
});
assert_eq!(rib_afi.dump_type(), TableDumpV2Type::RibIpv4Unicast);
let rib_generic = TableDumpV2Message::RibGeneric(RibGenericEntries {
sequence_number: 1,
afi: Afi::Ipv4,
safi: Safi::Unicast,
nlri: NetworkPrefix::from_str("10.0.0.0/24").unwrap(),
rib_entries: vec![],
});
assert_eq!(rib_generic.dump_type(), TableDumpV2Type::RibGeneric);
}
#[test]
#[cfg(feature = "serde")]
fn test_serialization() {
let peer_index_table = TableDumpV2Message::PeerIndexTable(PeerIndexTable::default());
let serialized = serde_json::to_string(&peer_index_table).unwrap();
let deserialized: TableDumpV2Message = serde_json::from_str(&serialized).unwrap();
assert_eq!(deserialized, peer_index_table);
let rib_entry = RibEntry {
peer_index: 1,
originated_time: 1,
attributes: Attributes::default(),
};
let rib_afi = TableDumpV2Message::RibAfi(RibAfiEntries {
rib_type: TableDumpV2Type::RibIpv4Unicast,
sequence_number: 1,
prefix: NetworkPrefix::from_str("10.0.0.0/24").unwrap(),
rib_entries: vec![rib_entry],
});
let serialized = serde_json::to_string(&rib_afi).unwrap();
let deserialized: TableDumpV2Message = serde_json::from_str(&serialized).unwrap();
assert_eq!(deserialized, rib_afi);
let rib_generic = TableDumpV2Message::RibGeneric(RibGenericEntries {
sequence_number: 1,
afi: Afi::Ipv4,
safi: Safi::Unicast,
nlri: NetworkPrefix::from_str("10.0.0.0/24").unwrap(),
rib_entries: vec![],
});
let serialized = serde_json::to_string(&rib_generic).unwrap();
let deserialized: TableDumpV2Message = serde_json::from_str(&serialized).unwrap();
assert_eq!(deserialized, rib_generic);
}
}