0.0
No commit activity in last 3 years
No release in over 3 years
Magically streaming live packet captures with a simple REST API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.14
~> 10.0
~> 3.0

Runtime

 Project Readme

Genie Lamp

Packet Genie

Packet Genie is a simple packet capturing solution that implements a streaming REST API to orchestrate packet captures in a magical way.

Why?

Have you ever wanted to stream live packet captures on multiple hosts? Ever just wanted to do that over HTTP(s) with a REST API to make it easy to do?

🚧 Development Notice

Currently, a pre-release gem is avaiable to install with the --pre flag to help with early testing.

Installation

$ gem install packet_genie --pre

Usage

Server

The Packet Genie server will stream packets on the host running the Packet Genie server. This allows you to perform a live, remote packet capture over HTTP(s).

require 'packet_genie'

# Start server without SSL
PacketGenie.server.run!(ssl: false)

Then, easily start a packet capture with CURL ( for example ):

$ curl localhost:4567/packets

Client

Don't want to mess around with CURL? Why not use the Packet Genie client?

require 'packet_genie'

client = PacketGenie.client.new(uri: "http://localhost:4567")

client.packets do |packet|
  puts packet # do something with json
end

License

The gem is available as open source under the terms of the MIT License.