https://github.com/bannsec/gallimaufry
Command Line Parsing Library for USB PCAP Files
https://github.com/bannsec/gallimaufry
Last synced: over 1 year ago
JSON representation
Command Line Parsing Library for USB PCAP Files
- Host: GitHub
- URL: https://github.com/bannsec/gallimaufry
- Owner: bannsec
- Created: 2017-04-09T20:23:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-24T13:06:34.000Z (about 2 years ago)
- Last Synced: 2025-03-26T07:22:55.431Z (over 1 year ago)
- Language: Python
- Size: 565 KB
- Stars: 29
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](http://gallimaufry.readthedocs.org/en/latest/?badge=latest)
[](https://travis-ci.org/bannsec/gallimaufry)
# Overview
`Gallimaufry` is a python framework for parsing and working with packet capture files (PCAPs) of USB traffic. It utilizes `tshark` in the backend to perform the initial translation of the packet capture into python. The goal of this framework is to make it easy to parse out information from USB pcaps as well as easy to extend the framework for more USB traffic types.
For a quick understanding of how it works, check out the [examples](http://gallimaufry.readthedocs.io/en/latest/index.html) in the documentation.
# Docs
http://gallimaufry.readthedocs.io/en/latest/index.html
# Quick Start
Once installed, you can load up a pcap and analyze it:
```python
In [1]: from Gallimaufry.USB import USB
In [2]: usb = USB("./task.pcap")
In [3]: usb
Out[3]:
In [4]: usb.devices
Out[4]: []
```
# Requires
- python 3.5+
- tshark
# Install
## Pip
Install using pip:
```bash
$ pip install .
```
## Docker
There is an auto-build Docker container that has everything set up already. Download it with the following:
```bash
$ sudo docker pull bannsec/Gallimaufry
```
Run it:
```bash
$ sudo docker run -it --rm -v $PWD:/my_mount bannsec/Gallimaufry
```