Skip to content
A toolset for network packet capture, forwarding and analysis via GRE/Cloud.
C++ CMake Shell C Puppet Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cfg Init Jun 22, 2018
docker Kubernetes network traffic mirror with Packet-Agent. fix style 2 Sep 10, 2019
docs
img
include
scripts update install.md: add ubuntu / windows. Sep 29, 2019
src fix windows compile error Aug 30, 2019
test change version from 0.3.3 to 0.3.4 Aug 29, 2019
tools
.gitignore
BUILD.md
CHANGES.md fix change log Aug 29, 2019
CMakeLists.txt change version from 0.3.3 to 0.3.4 Aug 29, 2019
CMakeSettings.json enable windows Jan 17, 2019
DOCKER.md remove privileged option Apr 15, 2019
INSTALL.md update install.md: add ubuntu / windows. Sep 29, 2019
LICENSE.md fix some typo Jun 26, 2018
README-zh-Hans.md update install.md: add ubuntu / windows. Sep 29, 2019
README.md update install.md: add ubuntu / windows. Sep 29, 2019
USAGE.md
version.h.in

README.md

English ∙ 简体中文

packet agent's title

Netis Packet Agent 0.3.4

Stable release Software License

What is Netis Packet Agent?

Netis Packet Agent is an open source project to deal with such situation: it captures packets on Machine A but has to use them on Machine B. This case is very common when you try to monitor network traffic in the LAN but the infrastructure is incapable, for example

  • There is neither TAP nor SPAN device in a physical environment.
  • The Virtual Switch Flow Table does not support SPAN function in a virtualization environment.

Also, this project aims at developing a suite of low cost but high efficiency tools to survive the challenge above.

  • pktminerg is the very first one, which makes you easily capture packets from an NIC interface, encapsulate them with GRE and send them to a remote machine for monitoring and analysis.

packet agent's pktminerg capture traffic flow via GRE/Cloud

With 3 utilities:

  • pcapcompare is a utility for comparing 2 different pcap files.
  • gredump is used for capturing GRE packet with filter, and save them to pcap file.
  • gredemo is a demo app which is used to read packet from a pcap file and send them all to remote NIC. This can be only used when built from source code.

Getting Started

Installation

CentOS 6/7 and RedHat 7

  1. Install libpcap and wget
yum install libpcap wget
  1. Download and install the RPM package. Find the latest package from Releases Page.
wget https://github.com/Netis/packet-agent/releases/download/v0.3.4/netis-packet-agent-0.3.4.el6.x86_64.rpm
rpm -ivh netis-packet-agent-0.3.4.el6.x86_64.rpm

SUSE 12

  1. Download and install the RPM package. Find the latest package from Releases Page.
wget https://github.com/Netis/packet-agent/releases/download/v0.3.4/netis-packet-agent-0.3.4.el6.x86_64.rpm
rpm -ivh netis-packet-agent-0.3.4.el6.x86_64.rpm

Ubuntu 18.04LTS

  1. Install libpcap and wget
sudo apt-get install libpcap-dev wget
  1. Download and install the DEB package. Find the latest package from Releases Page.
wget https://github.com/Netis/packet-agent/releases/download/v0.3.4/netis-packet-agent-0.3.4_amd64.deb
sudo dpkg -i netis-packet-agent-0.3.4_amd64.deb
  1. If libpcap.so.1 not found when running pktminerg, create softlink for libpcap.so.1 in suitable directory.
whereis libpcap.so
cd /path/to/libpcap.so
ln -s libpcap.so.x.y.z libpcap.so.1

Remarks: If it encounter a library dependency error when install from rpm, you should install boost_1_59_0 or later. If this also can't work, you can build and run from source.

Remarks: Now only support CentOS 6/7, RedHat 7, SUSE 12, Ubuntu 18.04 LTS.

Windows 7/8/10 x64

  1. Download and Install Winpcap of latest version.
  2. Download and Install Microsoft Visual C++ Redistributable for Visual Studio 2017 x64.
  3. Extract pktminerg and other utilities from zip, and run it in cmd in Administrator Mode.

Note: On Windows platform, you must use NIC's NT Device Name with format "\Device\NPF_{UUID}" as interface param. You can get it with following command:

    C:\> getmac /fo csv /v 
    "Connection Name","Network Adapter","Physical Address","Transport Name" 
    "Ethernet","Intel(R) Ethernet Connection (4) I219-V","8C-16-45-6B-53-B5","\Device\Tcpip_{4C25EA92-09DF-4FD3-A8B3-1B68E57443E2}" 

Take last field(Transport Name) and replace "Tcpip_" with "NPF_" as follow, then you can get interface param of Windows.

    \Device\NPF_{4C25EA92-09DF-4FD3-A8B3-1B68E57443E2} 

Use example:

    C:\> pktminerg -i \Device\NPF_{4C25EA92-09DF-4FD3-A8B3-1B68E57443E2} -r 172.24.103.201 
    C:\> gredump -i \Device\NPF_{4C25EA92-09DF-4FD3-A8B3-1B68E57443E2} -o capture.pcap

Usage

Remarks: Make sure the firewall allows GRE packets to be sent to the target. https://lartc.org/howto/lartc.tunnel.gre.html provides a way to check firewall allows GRE packets to be sent.

# Capture packet from NIC "eth0", encapsulate with GRE header and send to 172.16.1.201
pktminerg -i eth0 -r 172.16.1.201

# Specify cpu 1 for this program with high priority to avoid thread switch cost.
pktminerg -i eth0 -r 172.16.1.201 --cpu 1 -p

# compare 2 pcap files
pcapcompare --lpcap /path/to/left_file.pcap --rpcap /path/to/right_file.pcap

# Capture packet from NIC "eth0" and save them to gredump_output.pcap
gredump -i eth0 -o /path/to/gredump_output.pcap

# Capture packet from NIC "eth0", do not set DF flag
pktminerg -i eth0 -r 172.16.1.201 -M dont

packet agent's pktminerg : network capture use case

For more information on using these tools, please refer to this document.

For docker usage, please refer to this document.

Build from source.

You can also clone source from Github and build Netis Packet Agent in local, then check"/path/to/packet-agent/bin" to find all binary.
For build precondition and steps, please refer to this document.

Documentation / Useful link

Contributing

Fork the project and send pull requests. We welcome pull requests from members of all open source community.

License

Copyright (c) 2018 Netis.
The content of this repository bound by the following licenses:

Contact info


You can’t perform that action at this time.