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
//! MRT message and relevant structs.
pub mod bgp4mp;
pub mod table_dump;
pub mod table_dump_v2;
pub use bgp4mp::*;
use num_enum::{IntoPrimitive, TryFromPrimitive};
pub use table_dump::*;
pub use table_dump_v2::*;
/// MrtRecord is a wrapper struct that contains a header and a message.
///
/// A MRT record is constructed as the following:
/// ```text
/// 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
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Header... (variable) |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Message... (variable)
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
///
/// See [CommonHeader] for the content in header, and [MrtMessage] for the
/// message format.
#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MrtRecord {
pub common_header: CommonHeader,
pub message: MrtMessage,
}
/// MRT common header.
///
/// A CommonHeader ([RFC6396 section 2][header-link]) is constructed as the following:
/// ```text
/// 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
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Timestamp |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Type | Subtype |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Length |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
///
/// Or with extended timestamp:
/// ```text
/// 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
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Timestamp |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Type | Subtype |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Length |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// | Microsecond Timestamp |
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// ```
///
/// The headers include the following:
/// - timestamp: 32 bits
/// - entry_type: [EntryType] enum
/// - entry_subtype: entry subtype
/// - length: length of the message in octets
/// - (`ET` type only) microsecond_timestamp: microsecond part of the timestamp.
/// only applicable to the MRT message type with `_ET` suffix, such as
/// `BGP4MP_ET`
///
/// [header-link]: https://datatracker.ietf.org/doc/html/rfc6396#section-2
#[derive(Debug, Copy, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct CommonHeader {
pub timestamp: u32,
pub microsecond_timestamp: Option<u32>,
pub entry_type: EntryType,
pub entry_subtype: u16,
pub length: u32,
}
impl PartialEq for CommonHeader {
fn eq(&self, other: &Self) -> bool {
self.timestamp == other.timestamp
&& self.microsecond_timestamp == other.microsecond_timestamp
&& self.entry_type == other.entry_type
&& self.entry_subtype == other.entry_subtype
// && self.length == other.length
// relax the length check as it might be different due to incorrect encoding
}
}
#[derive(Debug, PartialEq, Eq, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum MrtMessage {
TableDumpMessage(TableDumpMessage),
TableDumpV2Message(TableDumpV2Message),
Bgp4Mp(Bgp4MpEnum),
}
/// MRT entry type.
///
/// EntryType indicates the type of the current MRT record. Type 0 to 10 are deprecated.
///
/// Excerpt from [RFC6396 section 4](https://datatracker.ietf.org/doc/html/rfc6396#section-4):
/// ```text
/// The following MRT Types are currently defined for the MRT format.
/// The MRT Types that contain the "_ET" suffix in their names identify
/// those types that use an Extended Timestamp MRT Header. The Subtype
/// and Message fields in these types remain as defined for the MRT Types
/// of the same name without the "_ET" suffix.
///
/// 11 OSPFv2
/// 12 TABLE_DUMP
/// 13 TABLE_DUMP_V2
/// 16 BGP4MP
/// 17 BGP4MP_ET
/// 32 ISIS
/// 33 ISIS_ET
/// 48 OSPFv3
/// 49 OSPFv3_ET
/// ```
#[derive(Debug, TryFromPrimitive, IntoPrimitive, Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[allow(non_camel_case_types)]
#[repr(u16)]
pub enum EntryType {
// START DEPRECATED
NULL = 0,
START = 1,
DIE = 2,
I_AM_DEAD = 3,
PEER_DOWN = 4,
BGP = 5,
RIP = 6,
IDRP = 7,
RIPNG = 8,
BGP4PLUS = 9,
BGP4PLUS_01 = 10,
// END DEPRECATED
OSPFv2 = 11,
TABLE_DUMP = 12,
TABLE_DUMP_V2 = 13,
BGP4MP = 16,
BGP4MP_ET = 17,
ISIS = 32,
ISIS_ET = 33,
OSPFv3 = 48,
OSPFv3_ET = 49,
}
#[cfg(test)]
mod tests {
#[test]
#[cfg(feature = "serde")]
fn test_entry_type_serialize_and_deserialize() {
use super::*;
let types = vec![
EntryType::NULL,
EntryType::START,
EntryType::DIE,
EntryType::I_AM_DEAD,
EntryType::PEER_DOWN,
EntryType::BGP,
EntryType::RIP,
EntryType::IDRP,
EntryType::RIPNG,
EntryType::BGP4PLUS,
EntryType::BGP4PLUS_01,
EntryType::OSPFv2,
EntryType::TABLE_DUMP,
EntryType::TABLE_DUMP_V2,
EntryType::BGP4MP,
EntryType::BGP4MP_ET,
EntryType::ISIS,
EntryType::ISIS_ET,
EntryType::OSPFv3,
EntryType::OSPFv3_ET,
];
for entry_type in types {
let serialized = serde_json::to_string(&entry_type).unwrap();
let deserialized: EntryType = serde_json::from_str(&serialized).unwrap();
assert_eq!(entry_type, deserialized);
}
}
#[test]
#[cfg(feature = "serde")]
fn test_serialization() {
use super::*;
use serde_json;
use std::net::IpAddr;
use std::str::FromStr;
let mrt_record = MrtRecord {
common_header: CommonHeader {
timestamp: 0,
microsecond_timestamp: None,
entry_type: EntryType::BGP4MP,
entry_subtype: 0,
length: 0,
},
message: MrtMessage::Bgp4Mp(Bgp4MpEnum::StateChange(Bgp4MpStateChange {
msg_type: Bgp4MpType::StateChange,
peer_asn: crate::models::Asn::new_32bit(0),
local_asn: crate::models::Asn::new_32bit(0),
interface_index: 1,
peer_addr: IpAddr::from_str("10.0.0.0").unwrap(),
local_addr: IpAddr::from_str("10.0.0.0").unwrap(),
old_state: BgpState::Idle,
new_state: BgpState::Connect,
})),
};
let serialized = serde_json::to_string(&mrt_record).unwrap();
let deserialized: MrtRecord = serde_json::from_str(&serialized).unwrap();
assert_eq!(mrt_record, deserialized);
}
}