Vent is a library that includes a CLI designed to serve as a general platform for analyzing network traffic. Built with some basic functionality, Vent serves as a user-friendly platform to build custom
plugins on to perform user-defined processing on incoming network data. Vent is filetype-agnostic in that the plugins installed within your specific vent instance determine what type of files your instance supports.
Simply create your
plugins, point Vent to them, install them, and drop a file in Vent to begin processing!
docker >= 1.13.1 make (if building from source) pip3 python3.6.x
Getting Set Up¶
There’s two ways to get Vent up and running on your machine:
$ pip3 install vent
Clone the repo:
$ git clone --recursive https://github.com/CyberReboot/vent.git $ cd vent
Build from source (for sudo/root privileged users):
Users with limited permissions or require user-local installation can use the following:
$ sudo env "PATH=$PATH" make
If you already have
docker-py installed on your machine, you may need to
pip3 uninstall docker-py first.
vent will install
docker-py as part of the installation process. However, there are known incompatibilities of
docker-py with older versions.
Once installed, it’s simply:
Contributing to Vent¶
Want to contribute? Awesome! Issue a pull request or see more details here.
See this for a crash course on npyscreen: the GUI used by Vent!
- Vent Quickstart Guide
- Custom Vent Plugins
- Custom Configurations of Plugins
- Vent Initialization
- Contributing to Vent
- New Vent Releases