Crate trippy

Expand description

Trippy

A network diagnostic tool, inspired by mtr.

Trippy combines the functionality of traceroute and ping and is designed to assist with the diagnosis of network issues.

Features

Trace using multiple protocols:
- ICMP, UDP & TCP
- IPv4 & IPv6
Customizable tracing options:
- packet size & payload pattern
- start and maximum time-to-live (TTL)
- minimum and maximum round duration
- round end grace period & maximum number of unknown hops
- source & destination port (TCP & UDP)
- Equal Cost Multi-path Routing strategies (classic, paris and dublin)
- source address and source interface
- TOS (aka DSCP + ECN)
Tui interface:
- Trace multiple targets simultaneously from a single instance of Trippy
- Per hop stats (sent, received, loss%, last, avg, best, worst, stddev & status)
- Per hop round-trip-time (RTT) history and frequency distributing charts
- Chart of RTT for all hops in a trace with zooming capability
- Customizable color theme & key bindings
- Multiple hosts per hop with ability to cap display to N hosts and show frequency %
- Freeze/unfreeze the Tui, reset the stats, flush the cache, preserve screen on exit
- Responsive UI with adjustable refresh rate
DNS:
- use system, external (Google 8.8.8.8 or Cloudflare 1.1.1.1) or custom resolver
- Lazy reverse DNS queries
- Lookup autonomous system number (ASN) and name
Generate tracing reports:
- json, csv & tabular (pretty-printed and markdown)
- configurable reporting cycles
Runs on multiple platform (macOS, Linux, NetBSD, Windows)
Capabilities aware application (Linux only)

Distributions

Cargo

cargo install trippy

Homebrew

brew install trippy

NetBSD

pkgin install trippy

Pacman (Arch Linux)

pacman -S trippy

Snap

snap install trippy

Docker

docker run -it fujiapple/trippy

Platforms

Trippy has been (lightly…) tested on the following platforms:

IPv4

Platform	ICMP	UDP	TCP	Notes
Linux	✅	✅	✅
macOS	✅	✅	✅
NetBSD	✅	✅	✅
OpenBSD	⏳	⏳	⏳	See #213
FreeBSD	⏳	⏳	⏳	See #214
Windows	✅	✅	✅	See #98

IPv6

Platform	ICMP	UDP	TCP	Notes
Linux	✅	✅	✅
macOS	✅	✅	✅
NetBSD	✅	✅	✅
OpenBSD	⏳	⏳	⏳	See #213
FreeBSD	⏳	⏳	⏳	See #214
Windows	✅	✅	✅	See #98

Equal Cost Multi-path Routing

Support for Equal Cost Multi-path Routing strategies are shown in the following table (see the tracking issue):

Strategy	Family	Protocol	Status
Classic	IPv4 / IPv6	UDP / TCP	✅
Paris	IPv4 / IPv6	UDP / TCP	❌
Dublin	IPv4	UDP	✅
Dublin	IPv4	TCP	❌
Dublin	IPv6	UDP / TCP	❌

Privileges

Trippy uses a raw socket which require elevated privileges. Enabling the required privilege can be achieved in several ways, including:

1: Run as root user via sudo:

sudo trip www.bitwizard.nl

2: chown trip as the root user and set the setuid bit:

sudo chown root $(which trip) && sudo chmod +s $(which trip)

3: [Linux only] Set the CAP_NET_RAW capability:

sudo setcap CAP_NET_RAW+p $(which trip)

Trippy is a capability aware application and will add CAP_NET_RAW to the effective set if it is present in the allowed set. Note that trippy will drop all capabilities after creating the raw socket.

Usage Examples

Basic usage with default parameters:

trip www.bitwizard.nl

Trace using the udp (or tcp or icmp) protocol (also aliases --udp & --tcp):

trip www.bitwizard.nl -p udp

Trace to multiple targets simultaneously (icmp protocol only, see #72):

trip www.bitwizard.nl google.com crates.io

Trace with a minimum round time of 250ms and a grace period of 50ms:

trip www.bitwizard.nl -i 250ms -g 50ms

Trace with a custom first and maximum time-to-live:

trip www.bitwizard.nl --first-ttl 2 --max-ttl 10

Use custom destination port 443 for tcp tracing:

trip www.bitwizard.nl -p tcp -P 443

Use custom source port 5000 for udp tracing:

trip www.bitwizard.nl -p udp -S 5000

Use the dublin Equal Cost Multi-path Routing strategy for udp with fixed source and destination ports:

trip www.bitwizard.nl -p udp -R dublin -S 5000 -P 3500

Trace with a custom source address:

trip www.bitwizard.nl -p tcp -A 127.0.0.1

Trace with a source address determined by the IPv4 address for interface en0:

trip www.bitwizard.nl -p tcp -I en0

Trace using IPv6:

trip www.bitwizard.nl -6

Generate a json (or csv, pretty, markdown) tracing report with 5 rounds of data:

trip www.bitwizard.nl -m json -c 5

Perform DNS queries using the google DNS resolver (or cloudflare, system, resolv):

trip www.bitwizard.nl -r google

Lookup AS information for all discovered IP addresses (not yet available for the system resolver, see #66):

trip www.bitwizard.nl -r google -z

Customize the color theme:

trip www.bitwizard.nl --tui-theme-colors bg-color=blue,text-color=ffff00

List all Tui items that can have a custom color theme:

trip www.bitwizard.nl --print-tui-theme-items

Customize the key bindings:

trip www.bitwizard.nl --tui-key-bindings previous-hop=k,next-hop=j,quit=shift-q

List all Tui commands that can have a custo key binding:

trip www.bitwizard.nl --print-tui-binding-commands

Command Reference

Usage: trip [OPTIONS] <TARGETS>...

Arguments:
  <TARGETS>...  A space delimited list of hostnames and IPs to trace

Options:
  -m, --mode <MODE>
          Output mode [default: tui] [possible values: tui, stream, pretty,
          markdown, csv, json]
          
  -p, --protocol <PROTOCOL>
          Tracing protocol [default: icmp] [possible values: icmp, udp, tcp]
          
      --udp
          Trace using the UDP protocol
          
      --tcp
          Trace using the TCP protocol
          
  -4, --ipv4
          use IPv4 only
          
  -6, --ipv6
          Use IPv6 only
          
  -P, --target-port <TARGET_PORT>
          The target port (TCP & UDP only) [default: 80]
          
  -S, --source-port <SOURCE_PORT>
          The source port (TCP & UDP only) [default: auto]
          
  -A, --source-address <SOURCE_ADDRESS>
          The source IP address [default: auto]
          
  -I, --interface <INTERFACE>
          The network interface [default: auto]
          
  -i, --min-round-duration <MIN_ROUND_DURATION>
          The minimum duration of every round [default: 1s]
          
  -T, --max-round-duration <MAX_ROUND_DURATION>
          The maximum duration of every round [default: 1s]
          
      --initial-sequence <INITIAL_SEQUENCE>
          The initial sequence number [default: 33000]
          
  -R, --multipath-strategy <MULTIPATH_STRATEGY>
          The Equal-cost Multi-Path routing strategy (IPv4/UDP only) [default:
          classic] [possible values: classic, paris, dublin]
          
  -g, --grace-duration <GRACE_DURATION>
          The period of time to wait for additional ICMP responses after the
          target has responded [default: 100ms]
          
  -U, --max-inflight <MAX_INFLIGHT>
          The maximum number of in-flight ICMP echo requests [default: 24]
          
  -f, --first-ttl <FIRST_TTL>
          The TTL to start from [default: 1]
          
  -t, --max-ttl <MAX_TTL>
          The maximum number of TTL hops [default: 64]
          
      --packet-size <PACKET_SIZE>
          The size of IP packet to send (IP header + ICMP header + payload) [default:
          84]
          
      --payload-pattern <PAYLOAD_PATTERN>
          The repeating pattern in the payload of the ICMP packet [default: 0]
          
  -Q, --tos <TOS>
          The TOS (i.e. DSCP+ECN) IP header value (TCP and UDP only) [default:
          0]
          
      --read-timeout <READ_TIMEOUT>
          The socket read timeout [default: 10ms]
          
  -r, --dns-resolve-method <DNS_RESOLVE_METHOD>
          How to perform DNS queries [default: system] [possible values: 
          system, resolv, google, cloudflare]
          
      --dns-timeout <DNS_TIMEOUT>
          The maximum time to wait to perform DNS queries [default: 5s]
          
  -z, --dns-lookup-as-info
          Lookup autonomous system (AS) information during DNS queries
          
  -a, --tui-address-mode <TUI_ADDRESS_MODE>
          How to render addresses [default: host] [possible values: ip, host,
          both]
          
  -M, --tui-max-addrs <TUI_MAX_ADDRS>
          The maximum number of addresses to show per hop
          
  -s, --tui-max-samples <TUI_MAX_SAMPLES>
          The maximum number of samples to record per hop [default: 256]
          
      --tui-preserve-screen
          Preserve the screen on exit
          
      --tui-refresh-rate <TUI_REFRESH_RATE>
          The TUI refresh rate [default: 100ms]
          
      --tui-theme-colors <TUI_THEME_COLORS>
          The TUI theme colors [item=color,item=color,..]
          
      --print-tui-theme-items
          Print all TUI theme items and exit
          
      --tui-key-bindings <TUI_KEY_BINDINGS>
          The TUI key bindings [command=key,command=key,..]
          
      --print-tui-binding-commands
          Print all TUI commands that can be bound and exit
          
  -c, --report-cycles <REPORT_CYCLES>
          The number of report cycles to run [default: 10]
          
  -h, --help
          Print help (see more with '--help')
          
  -V, --version
          Print version

Theme Reference

The following table lists the default Tui color theme. These can be overridden with the --tui-theme-colors command line option.

Item	Description	Default
`bg-color`	The default background color	`Black`
`border-color`	The default color of borders	`Gray`
`text-color`	The default color of text	`Gray`
`tab-text-color`	The color of the text in traces tabs	`Green`
`hops-table-header-bg-color`	The background color of the hops table header	`White`
`hops-table-header-text-color`	The color of text in the hops table header	`Black`
`hops-table-row-active-text-color`	The color of text of active rows in the hops table	`Gray`
`hops-table-row-inactive-text-color`	The color of text of inactive rows in the hops table	`DarkGray`
`hops-chart-selected-color`	The color of the selected series in the hops chart	`Green`
`hops-chart-unselected-color`	The color of the unselected series in the hops chart	`Gray`
`hops-chart-axis-color`	The color of the axis in the hops chart	`DarkGray`
`frequency-chart-bar-color`	The color of bars in the frequency chart	`Green`
`frequency-chart-text-color`	The color of text in the bars of the frequency chart	`Gray`
`samples-chart-color`	The color of the samples chart	`Yellow`
`help-dialog-bg-color`	The background color of the help dialog	`Blue`
`help-dialog-text-color`	The color of the text in the help dialog	`Gray`

The supported colors are:

Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White

Color names are case insensitive and may contain dashes. Raw hex values, such as ffffff for white, may also be used.

Key Bindings Reference

The following table lists the default Tui command key bindings. These can be overridden with the --tui-key-bindings command line option.

Command	Description	Default
`toggle-help`	Toggle help	`h`
`next-hop`	Select next hop	`down`
`previous-hop`	Select previous hop	`up`
`next-trace`	Select next trace	`right`
`previous-trace`	Select previous trace	`left`
`address-mode-ip`	Show IP address only	`i`
`address-mode-host`	Show hostname only	`n`
`address-mode-both`	Show both IP address and hostname	`b`
`toggle-freeze`	Toggle freezing the display	`f`
`toggle-chart`	Toggle the chart	`c`
`expand-hosts`	Expand the hosts shown per hop	`]`
`expand-hosts-max`	Expand the hosts shown per hop to the maximum	`}`
`contract-hosts`	Contract the hosts shown per hop	`[`
`contract-hosts-min`	Contract the hosts shown per hop to the minimum	`{`
`chart-zoom-in`	Zoom in the chart	`=`
`chart-zoom-out`	Zoom out the chart	`-`
`clear-trace-data`	Clear all trace data	`ctrl-r`
`clear-dns-cache`	Flash the DNS cache	`ctrl-k`
`clear-selection`	Clear the current selection	`esc`
`toggle-as-info`	Toggle AS info display	`z`
`quit`	Quit the application	`q`

The supported modifiers are: shift, ctrl, alt, super, hyper & meta. Multiple modifiers may be specified, for example ctrl-shift-b.

Acknowledgements

Trippy is made possible by tui-rs, crossterm as well as several foundational Rust libraries.

Trippy draws heavily from mtr and also incorporates ideas from both libparistraceroute & Dublin Traceroute.

The Trippy networking code is inspired by pnet and some elements of that codebase are incorporated in Trippy.

The AS data is retrieved from the IP to ASN Mapping Service provided by Team Cymru.

The trippy.cli.rs CNAME hosting is provided by cli.rs.

License

This project is distributed under the terms of the Apache License (Version 2.0).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in time by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.

See LICENSE for details.

Modules

tracing