ehsantux / npf

NPF -- packet filter with stateful inspection, NAT, IP sets, etc.

NPF: stateful packet filter supporting NAT, IP sets, etc

NPF is a layer 3 packet filter, supporting stateful packet inspection, IPv6, NAT, IP sets, extensions and many more. It was designed with a focus on high performance, scalability, multi-threading and modularity. NPF was written from scratch in 2009. It is written in C99 and distributed under the 2-clause BSD license.

Features

NPF offers the traditional set of features provided by packet filters. Some key features are:

• Stateful inspection (connection tracking).
  • Including the full TCP state tracking.
• Network address translation (NAT):
  • Static (stateless) and dynamic (stateful) translation.
  • NAPT and other forms of port translation (e.g. port forwarding).
  • Inbound and outbound NAT as well as bi-directional NAT.
  • Network-to-network translation, including NPTv6.
• Tables for efficient IP sets, including the longest prefix match support.
• Application Level Gateways (e.g. to support traceroute).
• NPF uses BPF with just-in-time (JIT) compilation.
• Rule procedures and a framework for NPF extensions (plugins).
• Extensions include: traffic normalization and packet logging.
• Data Plane Development Kit integration.

For a full set of features and their description, see the NPF documentation and other manual pages.

Documentation

http://www.netbsd.org/~rmind/npf/

Dependencies

• libnv: git clone https://github.com/rmind/nvlist
• libqsbr: git clone https://github.com/rmind/libqsbr
• liblpm: git clone https://github.com/rmind/liblpm
• bpfjit: git clone https://github.com/rmind/bpfjit
• libcdb: git clone https://github.com/rmind/libcdb

Each repository provides build files for the RPM (cd pkg && make rpm) or DEB (cd pkg && make deb) packages. You can also check the Travis for an example of how to build everything.

Source code structure

src/                - root source code directory
    kern/           - the kernel component (npfkern library)
    libnpf/         - library to manage the NPF configuration
    npfctl/         - command line user interface to control NPF
    npftest/        - unit tests and a tool to debug NPF
dpdk/               - DPDK integration code and a demo
pkg/                - packaging files (RPM and DEB)

Packages

To build the libnpf library (link using the -lnpf and -lnpfkern flags) packages:

• RPM (tested on RHEL/CentOS 7): cd pkg && make rpm
• DEB (tested on Debian 9): cd pkg && make deb