xref: /netbsd-src/usr.sbin/npf/npf.7 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: npf.7,v 1.4 2017/12/10 22:04:41 rmind 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 July 13, 2015
31.Dt NPF 7
32.Os
33.Sh NAME
34.Nm NPF
35.Nd NetBSD packet filter
36.\" -----
37.Sh DESCRIPTION
38NPF is a layer 3 packet filter, supporting IPv4 and IPv6 as well as
39layer 4 protocols such as TCP, UDP, and ICMP.
40It was designed with a focus on high performance, scalability, and
41modularity.
42.Pp
43NPF was written from scratch in 2009 and is distributed under the
442-clause BSD license.
45.\" -----
46.Sh FEATURES
47NPF offers the traditional set of features provided by packet filters.
48Some key features are:
49.Bl -bullet -offset indent
50.It
51Stateful inspection (connection tracking).
52.It
53Network address translation (NAT).
54This includes static (stateless) and dynamic (stateful) translation,
55port translation, bi-directional NAT, etc.
56.It
57IPv6-to-IPv6 network prefix translation (NPTv6).
58.It
59Tables for efficient IP sets.
60.It
61Application Level Gateways (e.g., to support traceroute).
62.It
63NPF uses BPF with just-in-time (JIT) compilation.
64.It
65Rule procedures and a framework for NPF extensions.
66.It
67Traffic normalization (extension).
68.It
69Packet logging (extension).
70.El
71.Pp
72For a full set of features and their description, see the NPF
73documentation and other manual pages.
74.\" -----
75.Sh SEE ALSO
76.Xr libnpf 3 ,
77.Xr bpf 4 ,
78.Xr bpfjit 4 ,
79.Xr npf.conf 5 ,
80.Xr pcap-filter 7 ,
81.Xr npfctl 8 ,
82.Xr npfd 8
83.Pp
84.Lk http://www.netbsd.org/~rmind/npf/ "NPF documentation"
85.Sh HISTORY
86.Nm
87first appeared in
88.Nx 6.0 .
89.Sh AUTHORS
90.Nm
91was designed and implemented by
92.An Mindaugas Rasiukevicius .
93