xref: /netbsd-src/usr.sbin/npf/npf.7 (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.\"	$NetBSD: npf.7,v 1.7 2019/08/11 22:27:15 gutteridge Exp $
2.\"
3.\" Copyright (c) 2009-2014 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This material is based upon work partially supported by The
7.\" NetBSD Foundation under a contract with Mindaugas Rasiukevicius.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd August 11, 2019
31.Dt NPF 7
32.Os
33.Sh NAME
34.Nm NPF
35.Nd NetBSD packet filter
36.\" -----
37.Sh DESCRIPTION
38.Nm
39is a layer 3 packet filter, supporting IPv4 and IPv6 as well as
40layer 4 protocols such as TCP, UDP, and ICMP.
41It was designed with a focus on high performance, scalability, and
42modularity.
43.\" -----
44.Sh FEATURES
45.Nm
46offers the traditional set of features provided by packet filters.
47Some key features are:
48.Bl -bullet -offset indent
49.It
50Stateful inspection (connection tracking).
51.It
52Network address translation (NAT).
53This includes static (stateless) and dynamic (stateful) translation,
54port translation, bi-directional NAT, etc.
55.It
56IPv6-to-IPv6 network prefix translation (NPTv6).
57.It
58Tables for efficient IP sets.
59.It
60Application Level Gateways (e.g., to support traceroute).
61.It
62Use of BPF with just-in-time (JIT) compilation.
63.It
64Rule procedures and a framework for
65.Nm
66extensions.
67.It
68Traffic normalisation (extension).
69.It
70Packet logging (extension).
71.El
72.Pp
73For a full set of features and their description, see the
74.Nm
75documentation website and other manual pages.
76.\" -----
77.Sh SEE ALSO
78.Xr libnpf 3 ,
79.Xr bpf 4 ,
80.Xr bpfjit 4 ,
81.Xr npf.conf 5 ,
82.Xr npf-params 7 ,
83.Xr pcap-filter 7 ,
84.Xr npfctl 8 ,
85.Xr npfd 8
86.Pp
87.Lk https://github.com/rmind/npf/ "NPF project page"
88.Pp
89.Lk http://rmind.github.io/npf/ "NPF documentation website"
90.Sh HISTORY
91.Nm
92was written from scratch in 2009 and is distributed under the
932-clause BSD license.
94It first appeared in
95.Nx 6.0 .
96.Sh AUTHORS
97.Nm
98was designed and implemented by
99.An Mindaugas Rasiukevicius .
100