pcapng: add helpers to get the most common options for IDB

Author: chifflier

examples/pcap-info.rs

@@ -96,6 +96,15 @@ fn print_block_info_ng(block: &Block) {
  if let Some(option) = idb.if_os() {
  println!("\t\t\tif_os: {}", option.unwrap_or("<invalid>"));
  }
+ if let Some(option) = idb.if_tsresol() {
+ println!("\t\t\tif_tsresol: {}", option.unwrap_or(0));
+ }
+ if let Some(option) = idb.if_filter() {
+ println!("\t\t\tif_filter: {}", option.unwrap_or("<invalid>"));
+ }
+ if let Some(option) = idb.if_tsoffset() {
+ println!("\t\t\tif_tsoffset: {}", option.unwrap_or(0));
+ }
  }
  _ => (),
  }

src/pcapng/interface_description.rs

@@ -45,7 +45,7 @@ impl<'a> InterfaceDescriptionBlock<'a> {
  /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
  /// or `Some(Err(_))` if value is present but invalid
  pub fn if_name(&self) -> Option<Result<&str, PcapNGOptionError>> {
- options_get_as_string(&self.options, OptionCode::IfName)
+ options_get_as_str(&self.options, OptionCode::IfName)
  }
 
  /// Return the `if_description` option value, if present
@@ -55,7 +55,7 @@ impl<'a> InterfaceDescriptionBlock<'a> {
  /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
  /// or `Some(Err(_))` if value is present but invalid
  pub fn if_description(&self) -> Option<Result<&str, PcapNGOptionError>> {
- options_get_as_string(&self.options, OptionCode::IfDescription)
+ options_get_as_str(&self.options, OptionCode::IfDescription)
  }
 
  /// Return the `if_os` option value, if present
@@ -65,7 +65,7 @@ impl<'a> InterfaceDescriptionBlock<'a> {
  /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
  /// or `Some(Err(_))` if value is present but invalid
  pub fn if_os(&self) -> Option<Result<&str, PcapNGOptionError>> {
- options_get_as_string(&self.options, OptionCode::IfOs)
+ options_get_as_str(&self.options, OptionCode::IfOs)
  }
 
  /// Return the `if_ipv4addr` option values, if present
@@ -140,6 +140,66 @@ impl<'a> InterfaceDescriptionBlock<'a> {
  Some(res)
  }
  }
+
+ /// Return the `if_macaddr` option value, if present
+ ///
+ /// If the option is present multiple times, the first value is returned.
+ ///
+ /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
+ /// or `Some(Err(_))` if value is present but invalid
+ pub fn if_macaddr(&self) -> Option<Result<&[u8], PcapNGOptionError>> {
+ options_get_as_bytes(&self.options, OptionCode::IfMacAddr)
+ }
+
+ /// Return the `if_euiaddr` option value, if present
+ ///
+ /// If the option is present multiple times, the first value is returned.
+ ///
+ /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
+ /// or `Some(Err(_))` if value is present but invalid
+ pub fn if_euiaddr(&self) -> Option<Result<&[u8], PcapNGOptionError>> {
+ options_get_as_bytes(&self.options, OptionCode::IfEuiAddr)
+ }
+
+ /// Return the `if_speed` option value, if present
+ ///
+ /// If the option is present multiple times, the first value is returned.
+ ///
+ /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
+ /// or `Some(Err(_))` if value is present but invalid
+ pub fn if_speed(&self) -> Option<Result<u64, PcapNGOptionError>> {
+ options_get_as_u64_le(&self.options, OptionCode::IfSpeed)
+ }
+
+ /// Return the `if_tsresol` option value, if present
+ ///
+ /// If the option is present multiple times, the first value is returned.
+ ///
+ /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
+ /// or `Some(Err(_))` if value is present but invalid
+ pub fn if_tsresol(&self) -> Option<Result<u8, PcapNGOptionError>> {
+ options_get_as_u8(&self.options, OptionCode::IfTsresol)
+ }
+
+ /// Return the `if_filter` option value, if present
+ ///
+ /// If the option is present multiple times, the first value is returned.
+ ///
+ /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
+ /// or `Some(Err(_))` if value is present but invalid
+ pub fn if_filter(&self) -> Option<Result<&str, PcapNGOptionError>> {
+ options_get_as_str(&self.options, OptionCode::IfFilter)
+ }
+
+ /// Return the `if_tsoffset` option value, if present
+ ///
+ /// If the option is present multiple times, the first value is returned.
+ ///
+ /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
+ /// or `Some(Err(_))` if value is present but invalid
+ pub fn if_tsoffset(&self) -> Option<Result<i64, PcapNGOptionError>> {
+ options_get_as_i64_le(&self.options, OptionCode::IfTsoffset)
+ }
 }
 
 impl<'a, En: PcapEndianness> PcapNGBlockParser<'a, En, InterfaceDescriptionBlock<'a>>

src/pcapng/option.rs

@@ -23,7 +23,11 @@ impl debug OptionCode {
  IfDescription = 3,
  ShbUserAppl = 4,
  IfIpv4Addr = 4,
+ IfMacAddr = 6,
+ IfEuiAddr = 7,
+ IfSpeed = 8,
  IfTsresol = 9,
+ IfFilter = 11,
  IfOs = 12,
  IfTsoffset = 14,
  Custom2988 = 2988,
@@ -177,15 +181,58 @@ pub(crate) fn opt_parse_options<'i, En: PcapEndianness, E: ParseError<&'i [u8]>>
  }
 }
 
-pub(crate) fn options_get_as_string<'a>(
+#[inline]
+pub(crate) fn options_find_map<'a, F, O>(
+ options: &'a [PcapNGOption],
+ code: OptionCode,
+ f: F,
+) -> Option<Result<O, PcapNGOptionError>>
+where
+ F: Fn(&'a PcapNGOption) -> Result<O, PcapNGOptionError>,
+{
+ options
+ .iter()
+ .find_map(|opt| if opt.code == code { Some(f(opt)) } else { None })
+}
+
+pub(crate) fn options_get_as_bytes<'a>(
+ options: &'a [PcapNGOption],
+ code: OptionCode,
+) -> Option<Result<&'a [u8], PcapNGOptionError>> {
+ options_find_map(options, code, |opt| opt.as_bytes())
+}
+
+pub(crate) fn options_get_as_str<'a>(
  options: &'a [PcapNGOption],
  code: OptionCode,
 ) -> Option<Result<&'a str, PcapNGOptionError>> {
- options.iter().find_map(|opt| {
- if opt.code == code {
- Some(opt.as_str())
+ options_find_map(options, code, |opt| opt.as_str())
+}
+
+pub(crate) fn options_get_as_u8(
+ options: &[PcapNGOption],
+ code: OptionCode,
+) -> Option<Result<u8, PcapNGOptionError>> {
+ options_find_map(options, code, |opt| {
+ let value = opt.value();
+ if opt.len == 1 && !value.is_empty() {
+ Ok(value[0])
  } else {
- None
+ Err(PcapNGOptionError::InvalidLength)
  }
  })
 }
+
+pub(crate) fn options_get_as_i64_le(
+ options: &[PcapNGOption],
+ code: OptionCode,
+) -> Option<Result<i64, PcapNGOptionError>> {
+ options_find_map(options, code, |opt| opt.as_i64_le())
+}
+
+pub(crate) fn options_get_as_u64_le(
+ options: &[PcapNGOption],
+ code: OptionCode,
+) -> Option<Result<u64, PcapNGOptionError>> {
+ options_find_map(options, code, |opt| opt.as_u64_le())
+}

src/pcapng/section_header.rs

@@ -39,7 +39,7 @@ impl<'a> SectionHeaderBlock<'a> {
  /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
  /// or `Some(Err(_))` if value is present but invalid
  pub fn shb_hardware(&self) -> Option<Result<&str, PcapNGOptionError>> {
- options_get_as_string(&self.options, OptionCode::ShbHardware)
+ options_get_as_str(&self.options, OptionCode::ShbHardware)
  }
 
  /// Return the `shb_os` option value, if present
@@ -49,7 +49,7 @@ impl<'a> SectionHeaderBlock<'a> {
  /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
  /// or `Some(Err(_))` if value is present but invalid
  pub fn shb_os(&self) -> Option<Result<&str, PcapNGOptionError>> {
- options_get_as_string(&self.options, OptionCode::ShbOs)
+ options_get_as_str(&self.options, OptionCode::ShbOs)
  }
 
  /// Return the `shb_userappl` option value, if present
@@ -59,7 +59,7 @@ impl<'a> SectionHeaderBlock<'a> {
  /// Returns `None` if option is not present, `Some(Ok(value))` if the value is present and valid,
  /// or `Some(Err(_))` if value is present but invalid
  pub fn shb_userappl(&self) -> Option<Result<&str, PcapNGOptionError>> {
- options_get_as_string(&self.options, OptionCode::ShbUserAppl)
+ options_get_as_str(&self.options, OptionCode::ShbUserAppl)
  }
 }