[](https://github.com/fujiapple852/trippy/actions/workflows/ci.yml)
[](https://crates.io/crates/trippy/0.3.1)
# Trippy
A network diagnostic tool, inspired by [mtr](https://github.com/traviscross/mtr).
<img src="assets/trippy-0.3.0-08-05-2022.gif" alt="trippy"/>
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`
- 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 port (`TCP` & `UDP`)
- 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
- 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](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)) number (ASN) and name
- Generate tracing reports:
- `json`, `csv` & tabular (pretty-printed and markdown)
- configurable reporting cycles
- Runs on multiple platform (macOS, Linux, NetBSD)
- Capabilities aware application (Linux only)
## Distributions
### Cargo
```shell
cargo install trippy
```
### NetBSD
```shell
pkgin install trippy
```
### Docker (Linux only)
```shell
docker run -it fujiapple/trippy www.bitwizard.nl
```
## Platforms
Trippy has been (lightly...) tested on the following platforms:
| Linux (Ubuntu) | 20.04 | ✅ | |
| macOS | 11.4 (Big Sur) | ✅ | |
| NetBSD | current | ✅ | |
| Windows | 10 | ❌ | See [#98](https://github.com/fujiapple852/trippy/issues/98) |
## 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`:
```shell
sudo trip www.bitwizard.nl
```
2: `chown` `trip` as the `root` user and set the `setuid` bit:
```shell
sudo chown root $(which trip) && sudo chmod +s $(which trip)
```
3: [Linux only] Set the `CAP_NET_RAW` capability:
```shell
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:
```shell
trip www.bitwizard.nl
```
Trace using the `udp` (or `tcp` or `icmp`) protocol:
```shell
trip www.bitwizard.nl -p udp
```
Trace to multiple targets simultaneously (`icmp` protocol only,
see [#72](https://github.com/fujiapple852/trippy/issues/72)):
```shell
trip www.bitwizard.nl google.com crates.io
```
Trace with a minimum round time of `250ms` and a grace period of `50ms`:
```shell
trip www.bitwizard.nl -i 250ms -g 50ms
```
Trace with a custom first and maximum `time-to-live`:
```shell
trip www.bitwizard.nl --first-ttl 2 --max-ttl 10
```
Generate a `json` (or `csv`, `pretty`, `markdown`) tracing report with 5 rounds of data:
```shell
trip www.bitwizard.nl -m json -c 5
```
Perform DNS queries using the `google` DNS resolver (or `cloudflare`, `system`, `resolv`):
```shell
trip www.bitwizard.nl -r google
```
Lookup AS information for all discovered IP addresses (not yet available for the `system` resolver,
see [#66](https://github.com/fujiapple852/trippy/issues/66)):
```shell
trip www.bitwizard.nl -r google -z
```
## Reference
```shell
USAGE:
trip [OPTIONS] <HOSTNAME>
ARGS:
<TARGETS>... A space delimited list of hostnames and IPs to trace
OPTIONS:
-a, --tui-address-mode <TUI_ADDRESS_MODE>
How to render addresses [default: host] [possible values: ip, host,
both]
-c, --report-cycles <REPORT_CYCLES>
The number of report cycles to run [default: 10]
--dns-timeout <DNS_TIMEOUT>
The maximum time to wait to perform DNS queries [default: 5s]
--first-ttl <FIRST_TTL>
The TTL to start from [default: 1]
-g, --grace-duration <GRACE_DURATION>
The period of time to wait for additional ICMP responses after the
target has responded [default: 100ms]
-h, --help
Print help information
-i, --min-round-duration <MIN_ROUND_DURATION>
The minimum duration of every round [default: 1s]
-I, --max-round-duration <MAX_ROUND_DURATION>
The maximum duration of every round [default: 1s]
--initial-sequence <INITIAL_SEQUENCE>
The initial sequence number [default: 33000]
-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]
--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]
-r, --dns-resolve-method <DNS_RESOLVE_METHOD>
How to perform DNS queries [default: system] [possible values:
system, resolv, google, cloudflare]
--read-timeout <READ_TIMEOUT>
The socket read timeout [default: 10ms]
-s, --tui-max-samples <TUI_MAX_SAMPLES>
The maximum number of samples to record per hop [default: 256]
--source-port <SOURCE_PORT>
The source port (TCP & UDP only)
-t, --max-ttl <MAX_TTL>
The maximum number of hops [default: 64]
--tui-max-addresses-per-hop <TUI_MAX_ADDRESSES_PER_HOP>
The maximum number of addresses to show per hop
--tui-preserve-screen
Preserve the screen on exit
--tui-refresh-rate <TUI_REFRESH_RATE>
The TUI refresh rate [default: 100ms]
-U, --max-inflight <MAX_INFLIGHT>
The maximum number of in-flight ICMP echo requests [default: 24]
-V, --version
Print version information
-z, --dns-lookup-as-info
Lookup autonomous system (AS) information during DNS queries
```
## Acknowledgements
Trippy is made possible by [tui-rs](https://github.com/fdehau/tui-rs)
, [crossterm](https://github.com/crossterm-rs/crossterm) & [pnet](https://github.com/libpnet/libpnet) as well as several
common foundational Rust libraries. It also draws heavily from [mtr](https://github.com/traviscross/mtr).
The [AS](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)) data is retrieved from
the [IP to ASN Mapping Service](https://team-cymru.com/community-services/ip-asn-mapping/#dns) provided
by [Team Cymru](https://team-cymru.com).
The [trippy.cli.rs](https://trippy.cli.rs) CNAME hosting is provided by [cli.rs](https://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](LICENSE) for details.
Copyright 2022 [Trippy Contributors](https://github.com/fujiapple852/trippy/graphs/contributors)