Giter VIP home page Giter VIP logo

dbuentello / vent Goto Github PK

View Code? Open in Web Editor NEW

This project forked from cyberreboot/vent

0.0 2.0 0.0 16.67 MB

Vent is a light-weight platform built to automate network collection and analysis pipelines using a flexible set of popular open source tools and technologies. Vent is python-based, extensible, leverages docker containers, and provides both an API and CLI.

License: Apache License 2.0

Dockerfile 2.28% Makefile 1.01% Python 79.29% Go 0.05% Shell 0.38% CSS 3.20% JavaScript 13.46% HTML 0.33%

vent's Introduction

vent

Network Visibility (an anagram)

Codacy Badge Build Status Documentation Status PyPI version codecov Docker Hub Downloads

Vent Logo

Overview

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 that perform user-defined processing on incoming network data. See this blog post - Introducing vent

Dependencies

docker>=1.13.1
git
make (if building from source)
pip3
python3.6.x

Installation

Option 1: Running inside of a Docker container

docker run -it -v /var/run/docker.sock:/var/run/docker.sock cyberreboot/vent

Option 2: Installing directly

pip3 install vent

Option 3: Getting the source and building

git clone https://github.com/CyberReboot/vent.git
cd vent

Root/sudo users can simply run make to compile and install the platform. Users with limited permissions or require user-local installation can use the following:

sudo env "PATH=$PATH" make

Note - If you already have docker-py installed on your machine, you may need to pip 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.

Running

vent

Plugins

vent supports custom plugins that perform user-defined processing on incoming 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!

The vent-plugins repository showcases a number of example plugins and contains details on how to create your own.

Documentation

Want to read the documentation for vent? Great! You can find it here

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 TUI used by Vent!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.