Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 3.75 KB

README.md

File metadata and controls

66 lines (45 loc) · 3.75 KB
Raw

route-graph

CLI tool for creating graphs of routes.

This tool simply wraps the example of TCP traceroute which is mentioned in the scapy documentation.

# scapy
>>> res, unans = traceroute(["target"], dport=[22, 80, 443], maxttl=20, retry=-2)
>>> res.graph(target="> target.png")

Requirements

You will need graphviz to be installed. If graphviz is not available on your system the graph can not be created.

route-graph has to be executed with sudo.

Installation

The package is available in the Python Package Index.

$ pip3 install route-graph --user

To get the lastest state:

$ pip install git+https://github.com/audiusGmbH/route-graph.git

For Nix or NixOS users is a package available in Nixpkgs. Keep in mind that the lastest releases might only be present in the unstable channel.

$ nix-env -iA nixos.route-graph

Usage

$ sudo ./route-graph --help
                                                                                                                       
 Usage: route-graph [OPTIONS] COMMAND [ARGS]...                                                                        
                                                                                                                       
 Tool to draw a graph of traceroute results.                                                                           
                                                                                                                       
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                             │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.      │
│ --help                        Show this message and exit.                                                           │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ graph           Create a graph from traceroute results.                                                             │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

The graph could then be found in the current directory. The format is png.

License

route-graph is licensed under MIT, for more details check the LICENSE file.