search

mmaraya / port-mirroring

OpenWrt package for copying network packets without iptables
BSD 2-Clause "Simplified" License
103 stars 32 forks source link

readme

port-mirroring logo port-mirroring Build Status Coverity Scan Build Status

port-mirroring is an OpenWrt package that sends copies of network packets from your OpenWrt router to another device on your network or beyond, giving you the ability to monitor and analyze network traffic without additional hardware. Intrusion detection systems, network application debugging, and network performance monitoring are common use cases. This is a continuation of the work started by Bruce Geng at https://code.google.com/p/port-mirroring/.

Supported Platforms

port-mirroring runs on all hardware platforms supported by OpenWrt.

Download

port-mirroring v1.4.4 has been compiled (but not tested) against OpenWrt 18.06.2 and is available for the the following platform(s):

If you need binaries for your router architecture, please submit a request.

Usage

These instructions will only work on routers that use the Atheros AR7xxx or AR9xxx platforms. If your router uses a different platform, please submit a request.

The default wget in OpenWrt is provided by Busybox and does not support SSL. The following commands from the OpenWrt terminal will install the full wget with SSL support and root certificates:

root@OpenWrt:~# opkg update
root@OpenWrt:~# opkg install wget
root@OpenWrt:~# mkdir -p /etc/ssl/certs
root@OpenWrt:~# echo "export SSL_CERT_DIR=/etc/ssl/certs" >> /etc/profile
root@OpenWrt:~# source /etc/profile
root@OpenWrt:~# opkg install ca-certificates

From your OpenWrt terminal, run the following commands to install the precompiled package.

root@OpenWrt:~# cd /tmp
root@OpenWrt:~# wget https://github.com/mmaraya/port-mirroring/releases/download/v1.4.4/port-mirroring_1.4.4-1_mips_24kc.ipk
root@OpenWrt:~# opkg install port-mirroring_1.4.4-1_mips_24kc.ipk

The last command will install the package and start it as a background process using the default configuration file. The default settings will probably not work on your environment, so the program should exit right after starting. Modify the /etc/config/port-mirroring file to suit your environment.

config 'port-mirroring'
    option source_ports 'eth0,wlan0'    # interfaces (maximum of 4) to copy packets from
    option promiscuous  '1'             # put source interface(s) in promiscuous mode
    option target       '10.1.4.2'      # interface or IP address to send packets to
    option protocol     'TEE'           # 'TEE' iptables (default) or 'TZSP' TaZmen Sniffer Protocol 
    option filter       ''              # optional tcpdump/libpcap packet filter expressions

To start port-mirroring as a foreground process with debugging on:

root@OpenWrt:~# port-mirroring --debug

To start port-mirroring as a daemon:

root@OpenWrt:~# /etc/init.d/port_mirroring start

To read the port-mirroring system logs:

root@OpenWrt:~# logread | grep port-mirroring

To stop the port-mirroring daemon:

root@OpenWrt:~# /etc/init.d/port_mirroring stop

To uninstall the port-mirroring package:

root@OpenWrt:~# opkg remove port-mirroring

Build Prerequisites

To compile the OpenWrt package, you will need the following:

Build Instructions

  1. Download OpenWrt SDK and link/rename it openwrt-sdk
  2. Install libpcap 
    ./scripts/feeds update -a
./scripts/feeds install libpcap
  3. Create the directory openwrt-sdk/package/port-mirroring/
  4. Create a link to port-mirroring/openwrt/Makefile in openwrt-sdk/package/port-mirroring/
  5. Customize port-mirroring/openwrt/Makefile to your build environment
  6. Run the following commands from your openwrt-sdk directory: 
    rm dl/port-mirroring-1.4.4.tar.bz2
make -j1 V=s package/port-mirroring/clean
make -j1 V=s package/port-mirroring/compile
  7. If everything works, you should find your package in openwrt-sdk/bin/packages/mips_24kc/base/

License

Please see the file named LICENSE.

Issues

Please submit questions, comments, bugs, enhancement requests at https://github.com/mmaraya/port-mirroring/issues.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.