1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
.\" $OpenBSD: pfctl.8,v 1.3 2001/06/25 19:32:19 ian Exp $
.\"
.\" Copyright (c) 2001 Kjell Wooding. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Ericsson Radio Systems.
.\" 4. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd June 24, 2001
.Dt PFCTL 8
.Os
.Sh NAME
.Nm pfctl
.Nd control the packet filter and NAT subsystems
.Sh SYNOPSIS
.Nm pfctl
.Ar commands
.Sh DESCRIPTION
The
.Nm
utility communicates with the packet filter system using the
ioctl interface described in
.Xr pf 4 .
.Pp
Packet filtering lets you restrict packets entering or leaving
your host; packets can be specified in a variety of ways including
by protocol, by port number, and by address.
Network Address Translation lets you map a series of internal
host IP numbers to a single external address.
The NAT code also has provision for redirecting a
range of connections to a different host and/or port number.
Taken together this provides a powerful basic firewall mechanism.
.Pp
The
.Nm
command is normally invoked automatically at system initialization
time to start and load the packet filter,
but can also be used when the filter or translation rules change.
.Pp
To use
.Nm
successfully, you must:
.Bl -enum
.It
Be running a kernel with
.Xr pf 8
configured in (the GENERIC kernel qualifies);
.It
Have written a rules and/or nat file;
.It
If you are forwarding packets (using NAT), have enabled
.Li net.inet.ip.forwarding=1
in the file
.Pa /etc/sysctl.conf ,
and rebooted since enabling it.
.El
.Pp
For this mechanism to be started when the system reboots,
you should enable IPF and IPNAT in
.Pa /etc/rc.conf
as well.
.Pp
The
.Nm
utility provides several commands:
.Pp
.Bl -tag -width "parse" -compact
.It Cm start
Start the packet filter
.It Cm stop
Stop the packet filter
.It Cm show
.Bl -tag -width "status" -compact
.It Cm rules
Show filter rules
.It Cm nat
Show NAT rules
.It Cm states Op proto
Show active states, optionally for a particular protocol
.It Cm status
Filter status
.El
.It Cm clear
.Bl -tag -width "rules" -compact
.It Cm rules
Clear filter rules
.It Cm nat
Clear NAT rules
.El
.It Cm parse
.Bl -tag -width "wules" -compact
.It Cm rules Pa filename
Test the syntax of a rules file
.It Cm nat Pa filename
Test the syntax of a NAT file
.El
.It Cm load
.Bl -tag -width "rules" -compact
.It Cm rules Pa filename
Load rules into the filter
.It Cm nat
Load rules into NAT
.El
.It Cm log Ar if
Enable logging for an interface
.El
.Pp
.Sh BUGS
Yes
.Sh FILES
.Bl -tag -width /etc/nat.rules
.It Pa /etc/pf.rules
packet filter rules file
.It Pa /etc/nat.rules
rules for Network Address Translation
.Sh SEE ALSO
.Xr pf 4
|
