README

Packetry

A fast, intuitive USB 2.0 protocol analysis application for use with Cynthion.

!Screenshot of Packetry

 Documentation

Read the latest Packetry Documentation.

 Development

Packetry is written in Rust, with its GUI using GTK 4 via the gtk-rs bindings.

To build it, you need a working Rust development environment. The minimum supported Rust version is 1.93.

You must also have the GTK 4 headers installed and discoverable via pkg-config, as this is required for Rust to build the gtk-rs crates.

 Building and running

To build, run cargo build after installing the necessary prerequisites (see below). Run with cargo run.

If you pass a capture filename as an argument, Packetry will attempt to load it. The current supported file format is a .pcap file with the LINKTYPE_USB_2_0 link layer header type.

Note: Do not build with --all-features. All the optional features currently in the package are for debug/test purposes only, and will prevent or degrade normal use of the application if enabled. See Cargo.toml for details.

 Installing prerequisites

 Linux

Install the Rust build tools, other essential build tools, and GTK 4 headers.

On Debian based systems it may be sufficient to use the command:

apt install rustc cargo build-essential libgtk-4-dev

For Fedora systems:

yum install rust cargo make gcc gcc-c++ gtk4-devel pango-devel

For other distributions, a similar set of packages should be required.

Note that Packetry requires a minimum Rust version of 1.93. If your distribution's packages are older than this, use rustup to get the latest Rust toolchain and manage your Rust installation.

 macOS

Install Rust with rustup, and install Homebrew.

Install GTK 4 with brew install gtk4.

 Windows

Follow the installation instructions from GUI development with Rust and GTK 4.

You can use either the MSVC or GNU toolchains.

Top issues

Latest release

Added

- Add support for non-packet events from Cynthion analyzer.
- Add support for VBUS power control with Cynthion analyzer.
- Add support for the PcapNG file format with custom non-packet blocks.
- Add decoding of HID report descriptors.
- Add facility to dump the capture database for debugging.

 Changed

- The device list is maintained automatically and the scan button is removed.
- USB capture devices are kept open whilst selected for use.
- Filename extensions are added automatically when saving.
- File dialogs remember the last used directory.
- Backtraces are always cap