Add support for ICMP Extensions in Tui (#752)

src/config.rs

@@ -117,6 +117,25 @@ pub enum AsMode {
     Name,
 }
 
+/// How to render `icmp` extensions in the hops table.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, ValueEnum, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum IcmpExtensionMode {
+    /// Do not show `icmp` extensions.
+    Off,
+    /// Show MPLS label(s) only.
+    Mpls,
+    /// Show full `icmp` extension data for all known extensions.
+    ///
+    /// For MPLS the fields shown are `label`, `ttl`, `exp` & `bos`.
+    Full,
+    /// Show full `icmp` extension data for all known and unknown classes.
+    ///
+    /// This is the same as `Full`, but also shows `class`, `subtype` and
+    /// `object` for unknown extensions.
+    All,
+}
+
 /// How to render `GeoIp` information in the hop table.
 ///
 /// Note that the hop details view is always shown using the `Long` representation.
@@ -217,6 +236,7 @@ pub struct TrippyConfig {
     pub tui_privacy_max_ttl: u8,
     pub tui_address_mode: AddressMode,
     pub tui_as_mode: AsMode,
+    pub tui_icmp_extension_mode: IcmpExtensionMode,
     pub tui_geoip_mode: GeoIpMode,
     pub tui_max_addrs: Option<u8>,
     pub tui_theme: TuiTheme,
@@ -418,6 +438,13 @@ impl TrippyConfig {
             cfg_file_tui.tui_as_mode,
             constants::DEFAULT_TUI_AS_MODE,
         );
+
+        let tui_icmp_extension_mode = cfg_layer(
+            args.tui_icmp_extension_mode,
+            cfg_file_tui.tui_icmp_extension_mode,
+            constants::DEFAULT_TUI_ICMP_EXTENSION_MODE,
+        );
+
         let tui_geoip_mode = cfg_layer(
             args.tui_geoip_mode,
             cfg_file_tui.tui_geoip_mode,
@@ -577,6 +604,7 @@ impl TrippyConfig {
             tui_privacy_max_ttl,
             tui_address_mode,
             tui_as_mode,
+            tui_icmp_extension_mode,
             tui_geoip_mode,
             tui_max_addrs,
             tui_theme,
@@ -626,6 +654,7 @@ impl Default for TrippyConfig {
             tui_privacy_max_ttl: constants::DEFAULT_TUI_PRIVACY_MAX_TTL,
             tui_address_mode: constants::DEFAULT_TUI_ADDRESS_MODE,
             tui_as_mode: constants::DEFAULT_TUI_AS_MODE,
+            tui_icmp_extension_mode: constants::DEFAULT_TUI_ICMP_EXTENSION_MODE,
             tui_geoip_mode: constants::DEFAULT_TUI_GEOIP_MODE,
             tui_max_addrs: None,
             tui_theme: TuiTheme::default(),

src/config/cmd.rs

@@ -1,8 +1,8 @@
 use crate::config::binding::TuiCommandItem;
 use crate::config::theme::TuiThemeItem;
 use crate::config::{
-    AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, LogFormat, LogSpanEvents, Mode,
-    MultipathStrategyConfig, Protocol, TuiColor, TuiKeyBinding,
+    AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, IcmpExtensionMode, LogFormat,
+    LogSpanEvents, Mode, MultipathStrategyConfig, Protocol, TuiColor, TuiKeyBinding,
 };
 use anyhow::anyhow;
 use clap::builder::Styles;
@@ -161,6 +161,10 @@ pub struct Args {
     #[arg(value_enum, long)]
     pub tui_as_mode: Option<AsMode>,
 
+    /// How to render ICMP extensions [default: mpls]
+    #[arg(value_enum, long)]
+    pub tui_icmp_extension_mode: Option<IcmpExtensionMode>,
+
     /// How to render GeoIp information [default: short]
     #[arg(value_enum, long)]
     pub tui_geoip_mode: Option<GeoIpMode>,

src/config/constants.rs

@@ -1,6 +1,6 @@
 use crate::config::{
-    AddressFamily, AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, LogFormat,
-    LogSpanEvents, Mode, MultipathStrategyConfig, Protocol,
+    AddressFamily, AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, IcmpExtensionMode,
+    LogFormat, LogSpanEvents, Mode, MultipathStrategyConfig, Protocol,
 };
 use std::time::Duration;
 
@@ -82,6 +82,9 @@ pub const DEFAULT_TUI_PRESERVE_SCREEN: bool = false;
 /// The default value for `tui-as-mode`.
 pub const DEFAULT_TUI_AS_MODE: AsMode = AsMode::Asn;
 
+/// The default value for `tui-icmp-extension-mode`.
+pub const DEFAULT_TUI_ICMP_EXTENSION_MODE: IcmpExtensionMode = IcmpExtensionMode::Off;
+
 /// The default value for `tui-geoip-mode`.
 pub const DEFAULT_TUI_GEOIP_MODE: GeoIpMode = GeoIpMode::Off;
 

src/config/file.rs

@@ -1,8 +1,8 @@
 use crate::config::binding::TuiKeyBinding;
 use crate::config::theme::TuiColor;
 use crate::config::{
-    AddressFamily, AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, LogFormat,
-    LogSpanEvents, Mode, MultipathStrategyConfig, Protocol,
+    AddressFamily, AddressMode, AsMode, DnsResolveMethodConfig, GeoIpMode, IcmpExtensionMode,
+    LogFormat, LogSpanEvents, Mode, MultipathStrategyConfig, Protocol,
 };
 use anyhow::Context;
 use etcetera::BaseStrategy;
@@ -218,6 +218,7 @@ pub struct ConfigTui {
     pub tui_privacy_max_ttl: Option<u8>,
     pub tui_address_mode: Option<AddressMode>,
     pub tui_as_mode: Option<AsMode>,
+    pub tui_icmp_extension_mode: Option<IcmpExtensionMode>,
     pub tui_geoip_mode: Option<GeoIpMode>,
     pub tui_max_addrs: Option<u8>,
     pub geoip_mmdb_file: Option<String>,
@@ -232,6 +233,7 @@ impl Default for ConfigTui {
             tui_privacy_max_ttl: Some(super::constants::DEFAULT_TUI_PRIVACY_MAX_TTL),
             tui_address_mode: Some(super::constants::DEFAULT_TUI_ADDRESS_MODE),
             tui_as_mode: Some(super::constants::DEFAULT_TUI_AS_MODE),
+            tui_icmp_extension_mode: Some(super::constants::DEFAULT_TUI_ICMP_EXTENSION_MODE),
             tui_geoip_mode: Some(super::constants::DEFAULT_TUI_GEOIP_MODE),
             tui_max_addrs: Some(super::constants::DEFAULT_TUI_MAX_ADDRS),
             geoip_mmdb_file: None,

src/frontend/config.rs

@@ -1,5 +1,5 @@
-use crate::config::TuiBindings;
 use crate::config::{AddressMode, AsMode, GeoIpMode, TuiTheme};
+use crate::config::{IcmpExtensionMode, TuiBindings};
 use crate::frontend::binding::Bindings;
 use crate::frontend::theme::Theme;
 use std::time::Duration;
@@ -19,6 +19,8 @@ pub struct TuiConfig {
     pub lookup_as_info: bool,
     /// How to render AS data.
     pub as_mode: AsMode,
+    /// How to render ICMP extensions.
+    pub icmp_extension_mode: IcmpExtensionMode,
     /// How to render GeoIp data.
     pub geoip_mode: GeoIpMode,
     /// The maximum number of addresses to show per hop.
@@ -40,6 +42,7 @@ impl TuiConfig {
         address_mode: AddressMode,
         lookup_as_info: bool,
         as_mode: AsMode,
+        icmp_extension_mode: IcmpExtensionMode,
         geoip_mode: GeoIpMode,
         max_addrs: Option<u8>,
         max_samples: usize,
@@ -53,6 +56,7 @@ impl TuiConfig {
             address_mode,
             lookup_as_info,
             as_mode,
+            icmp_extension_mode,
             geoip_mode,
             max_addrs,
             max_samples,

src/frontend/render/header.rs

@@ -11,6 +11,7 @@ use trippy::dns::{ResolveMethod, Resolver};
 use trippy::tracing::{PortDirection, TracerProtocol};
 
 /// Render the title, config, target, clock and keyboard controls.
+#[allow(clippy::too_many_lines)]
 pub fn render(f: &mut Frame<'_>, app: &TuiApp, rect: Rect) {
     let header_block = Block::default()
         .title(format!(" Trippy v{} ", clap::crate_version!()))
@@ -83,6 +84,11 @@ pub fn render(f: &mut Frame<'_>, app: &TuiApp, rect: Rect) {
     let source = render_source(app);
     let dest = render_destination(app);
     let target = format!("{source} -> {dest}");
+    let plural_flows = if app.tracer_data().flows().len() > 1 {
+        "flows"
+    } else {
+        "flow"
+    };
     let left_line = vec![
         Line::from(vec![
             Span::styled("Target: ", Style::default().add_modifier(Modifier::BOLD)),
@@ -98,8 +104,10 @@ pub fn render(f: &mut Frame<'_>, app: &TuiApp, rect: Rect) {
             Span::styled("Status: ", Style::default().add_modifier(Modifier::BOLD)),
             Span::raw(render_status(app)),
             Span::raw(format!(
-                ", discovered {} hops",
-                app.tracer_data().hops(app.selected_flow).len()
+                ", discovered {} hops and {} unique {}",
+                app.tracer_data().hops(app.selected_flow).len(),
+                app.tracer_data().flows().len(),
+                plural_flows
             )),
         ]),
     ];

src/frontend/render/settings.rs

@@ -216,6 +216,7 @@ fn format_trace_settings(app: &TuiApp) -> Vec<SettingsItem> {
         ),
         SettingsItem::new("packet-size", format!("{}", cfg.packet_size)),
         SettingsItem::new("payload-pattern", format!("{}", cfg.payload_pattern)),
+        SettingsItem::new("icmp-extensions", format!("{}", cfg.icmp_extensions)),
         SettingsItem::new("interface", interface),
         SettingsItem::new("multipath-strategy", cfg.multipath_strategy.to_string()),
         SettingsItem::new("target-port", dst_port),
@@ -419,7 +420,7 @@ fn format_theme_settings(app: &TuiApp) -> Vec<SettingsItem> {
 /// The name and number of items for each tabs in the setting dialog.
 pub const SETTINGS_TABS: [(&str, usize); 6] = [
     ("Tui", 8),
-    ("Trace", 14),
+    ("Trace", 15),
     ("Dns", 4),
     ("GeoIp", 1),
     ("Bindings", 29),