]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sbin/pfctl/pfctl.8
Import mandoc snapshot 2017-06-08
[FreeBSD/FreeBSD.git] / sbin / pfctl / pfctl.8
1 .\" $OpenBSD: pfctl.8,v 1.138 2008/06/10 20:55:02 mcbride Exp $
2 .\"
3 .\" Copyright (c) 2001 Kjell Wooding.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. The name of the author may not be used to endorse or promote products
14 .\"    derived from this software without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD$
28 .\"
29 .Dd October 3, 2016
30 .Dt PFCTL 8
31 .Os
32 .Sh NAME
33 .Nm pfctl
34 .Nd control the packet filter (PF) device
35 .Sh SYNOPSIS
36 .Nm pfctl
37 .Bk -words
38 .Op Fl AdeghmNnOPqRrvz
39 .Op Fl a Ar anchor
40 .Oo Fl D Ar macro Ns =
41 .Ar value Oc
42 .Op Fl F Ar modifier
43 .Op Fl f Ar file
44 .Op Fl i Ar interface
45 .Op Fl K Ar host | network
46 .Xo
47 .Oo Fl k
48 .Ar host | network | label | id
49 .Oc Xc
50 .Op Fl o Ar level
51 .Op Fl p Ar device
52 .Op Fl s Ar modifier
53 .Xo
54 .Oo Fl t Ar table
55 .Fl T Ar command
56 .Op Ar address ...
57 .Oc Xc
58 .Op Fl x Ar level
59 .Ek
60 .Sh DESCRIPTION
61 The
62 .Nm
63 utility communicates with the packet filter device using the
64 ioctl interface described in
65 .Xr pf 4 .
66 It allows ruleset and parameter configuration and retrieval of status
67 information from the packet filter.
68 .Pp
69 Packet filtering restricts the types of packets that pass through
70 network interfaces entering or leaving the host based on filter
71 rules as described in
72 .Xr pf.conf 5 .
73 The packet filter can also replace addresses and ports of packets.
74 Replacing source addresses and ports of outgoing packets is called
75 NAT (Network Address Translation) and is used to connect an internal
76 network (usually reserved address space) to an external one (the
77 Internet) by making all connections to external hosts appear to
78 come from the gateway.
79 Replacing destination addresses and ports of incoming packets
80 is used to redirect connections to different hosts and/or ports.
81 A combination of both translations, bidirectional NAT, is also
82 supported.
83 Translation rules are described in
84 .Xr pf.conf 5 .
85 .Pp
86 When the variable
87 .Va pf
88 is set to
89 .Dv YES
90 in
91 .Xr rc.conf 5 ,
92 the rule file specified with the variable
93 .Va pf_rules
94 is loaded automatically by the
95 .Xr rc 8
96 scripts and the packet filter is enabled.
97 .Pp
98 The packet filter does not itself forward packets between interfaces.
99 Forwarding can be enabled by setting the
100 .Xr sysctl 8
101 variables
102 .Em net.inet.ip.forwarding
103 and/or
104 .Em net.inet6.ip6.forwarding
105 to 1.
106 Set them permanently in
107 .Xr sysctl.conf 5 .
108 .Pp
109 The
110 .Nm
111 utility provides several commands.
112 The options are as follows:
113 .Bl -tag -width Ds
114 .It Fl A
115 Load only the queue rules present in the rule file.
116 Other rules and options are ignored.
117 .It Fl a Ar anchor
118 Apply flags
119 .Fl f ,
120 .Fl F ,
121 and
122 .Fl s
123 only to the rules in the specified
124 .Ar anchor .
125 In addition to the main ruleset,
126 .Nm
127 can load and manipulate additional rulesets by name,
128 called anchors.
129 The main ruleset is the default anchor.
130 .Pp
131 Anchors are referenced by name and may be nested,
132 with the various components of the anchor path separated by
133 .Sq /
134 characters, similar to how file system hierarchies are laid out.
135 The last component of the anchor path is where ruleset operations are
136 performed.
137 .Pp
138 Evaluation of
139 .Ar anchor
140 rules from the main ruleset is described in
141 .Xr pf.conf 5 .
142 .Pp
143 For example, the following will show all filter rules (see the
144 .Fl s
145 flag below) inside the anchor
146 .Dq authpf/smith(1234) ,
147 which would have been created for user
148 .Dq smith
149 by
150 .Xr authpf 8 ,
151 PID 1234:
152 .Bd -literal -offset indent
153 # pfctl -a "authpf/smith(1234)" -s rules
154 .Ed
155 .Pp
156 Private tables can also be put inside anchors, either by having table
157 statements in the
158 .Xr pf.conf 5
159 file that is loaded in the anchor, or by using regular table commands, as in:
160 .Bd -literal -offset indent
161 # pfctl -a foo/bar -t mytable -T add 1.2.3.4 5.6.7.8
162 .Ed
163 .Pp
164 When a rule referring to a table is loaded in an anchor, the rule will use the
165 private table if one is defined, and then fall back to the table defined in the
166 main ruleset, if there is one.
167 This is similar to C rules for variable scope.
168 It is possible to create distinct tables with the same name in the global
169 ruleset and in an anchor, but this is often bad design and a warning will be
170 issued in that case.
171 .Pp
172 By default, recursive inline printing of anchors applies only to unnamed
173 anchors specified inline in the ruleset.
174 If the anchor name is terminated with a
175 .Sq *
176 character, the
177 .Fl s
178 flag will recursively print all anchors in a brace delimited block.
179 For example the following will print the
180 .Dq authpf
181 ruleset recursively:
182 .Bd -literal -offset indent
183 # pfctl -a 'authpf/*' -sr
184 .Ed
185 .Pp
186 To print the main ruleset recursively, specify only
187 .Sq *
188 as the anchor name:
189 .Bd -literal -offset indent
190 # pfctl -a '*' -sr
191 .Ed
192 .It Fl D Ar macro Ns = Ns Ar value
193 Define
194 .Ar macro
195 to be set to
196 .Ar value
197 on the command line.
198 Overrides the definition of
199 .Ar macro
200 in the ruleset.
201 .It Fl d
202 Disable the packet filter.
203 .It Fl e
204 Enable the packet filter.
205 .It Fl F Ar modifier
206 Flush the filter parameters specified by
207 .Ar modifier
208 (may be abbreviated):
209 .Pp
210 .Bl -tag -width xxxxxxxxxxxx -compact
211 .It Fl F Cm nat
212 Flush the NAT rules.
213 .It Fl F Cm queue
214 Flush the queue rules.
215 .It Fl F Cm rules
216 Flush the filter rules.
217 .It Fl F Cm states
218 Flush the state table (NAT and filter).
219 .It Fl F Cm Sources
220 Flush the source tracking table.
221 .It Fl F Cm info
222 Flush the filter information (statistics that are not bound to rules).
223 .It Fl F Cm Tables
224 Flush the tables.
225 .It Fl F Cm osfp
226 Flush the passive operating system fingerprints.
227 .It Fl F Cm all
228 Flush all of the above.
229 .El
230 .It Fl f Ar file
231 Load the rules contained in
232 .Ar file .
233 This
234 .Ar file
235 may contain macros, tables, options, and normalization, queueing,
236 translation, and filtering rules.
237 With the exception of macros and tables, the statements must appear in that
238 order.
239 .It Fl g
240 Include output helpful for debugging.
241 .It Fl h
242 Help.
243 .It Fl i Ar interface
244 Restrict the operation to the given
245 .Ar interface .
246 .It Fl K Ar host | network
247 Kill all of the source tracking entries originating from the specified
248 .Ar host
249 or
250 .Ar network .
251 A second
252 .Fl K Ar host
253 or
254 .Fl K Ar network
255 option may be specified, which will kill all the source tracking
256 entries from the first host/network to the second.
257 .It Xo
258 .Fl k
259 .Ar host | network | label | id
260 .Xc
261 Kill all of the state entries matching the specified
262 .Ar host ,
263 .Ar network ,
264 .Ar label ,
265 or
266 .Ar id .
267 .Pp
268 For example, to kill all of the state entries originating from
269 .Dq host :
270 .Pp
271 .Dl # pfctl -k host
272 .Pp
273 A second
274 .Fl k Ar host
275 or
276 .Fl k Ar network
277 option may be specified, which will kill all the state entries
278 from the first host/network to the second.
279 To kill all of the state entries from
280 .Dq host1
281 to
282 .Dq host2 :
283 .Pp
284 .Dl # pfctl -k host1 -k host2
285 .Pp
286 To kill all states originating from 192.168.1.0/24 to 172.16.0.0/16:
287 .Pp
288 .Dl # pfctl -k 192.168.1.0/24 -k 172.16.0.0/16
289 .Pp
290 A network prefix length of 0 can be used as a wildcard.
291 To kill all states with the target
292 .Dq host2 :
293 .Pp
294 .Dl # pfctl -k 0.0.0.0/0 -k host2
295 .Pp
296 It is also possible to kill states by rule label or state ID.
297 In this mode the first
298 .Fl k
299 argument is used to specify the type
300 of the second argument.
301 The following command would kill all states that have been created
302 from rules carrying the label
303 .Dq foobar :
304 .Pp
305 .Dl # pfctl -k label -k foobar
306 .Pp
307 To kill one specific state by its unique state ID
308 (as shown by pfctl -s state -vv),
309 use the
310 .Ar id
311 modifier and as a second argument the state ID and optional creator ID.
312 To kill a state with ID 4823e84500000003 use:
313 .Pp
314 .Dl # pfctl -k id -k 4823e84500000003
315 .Pp
316 To kill a state with ID 4823e84500000018 created from a backup
317 firewall with hostid 00000002 use:
318 .Pp
319 .Dl # pfctl -k id -k 4823e84500000018/2
320 .It Fl m
321 Merge in explicitly given options without resetting those
322 which are omitted.
323 Allows single options to be modified without disturbing the others:
324 .Bd -literal -offset indent
325 # echo "set loginterface fxp0" | pfctl -mf -
326 .Ed
327 .It Fl N
328 Load only the NAT rules present in the rule file.
329 Other rules and options are ignored.
330 .It Fl n
331 Do not actually load rules, just parse them.
332 .It Fl O
333 Load only the options present in the rule file.
334 Other rules and options are ignored.
335 .It Fl o Ar level
336 Control the ruleset optimizer, overriding any rule file settings.
337 .Pp
338 .Bl -tag -width xxxxxxxxxxxx -compact
339 .It Fl o Cm none
340 Disable the ruleset optimizer.
341 .It Fl o Cm basic
342 Enable basic ruleset optimizations.
343 This is the default behaviour.
344 .It Fl o Cm profile
345 Enable basic ruleset optimizations with profiling.
346 .El
347 For further information on the ruleset optimizer, see
348 .Xr pf.conf 5 .
349 .It Fl P
350 Do not perform service name lookup for port specific rules,
351 instead display the ports numerically.
352 .It Fl p Ar device
353 Use the device file
354 .Ar device
355 instead of the default
356 .Pa /dev/pf .
357 .It Fl q
358 Only print errors and warnings.
359 .It Fl R
360 Load only the filter rules present in the rule file.
361 Other rules and options are ignored.
362 .It Fl r
363 Perform reverse DNS lookups on states when displaying them.
364 .It Fl s Ar modifier
365 Show the filter parameters specified by
366 .Ar modifier
367 (may be abbreviated):
368 .Pp
369 .Bl -tag -width xxxxxxxxxxxxx -compact
370 .It Fl s Cm nat
371 Show the currently loaded NAT rules.
372 .It Fl s Cm queue
373 Show the currently loaded queue rules.
374 When used together with
375 .Fl v ,
376 per-queue statistics are also shown.
377 When used together with
378 .Fl v v ,
379 .Nm
380 will loop and show updated queue statistics every five seconds, including
381 measured bandwidth and packets per second.
382 .It Fl s Cm rules
383 Show the currently loaded filter rules.
384 When used together with
385 .Fl v ,
386 the per-rule statistics (number of evaluations,
387 packets and bytes) are also shown.
388 Note that the
389 .Dq skip step
390 optimization done automatically by the kernel
391 will skip evaluation of rules where possible.
392 Packets passed statefully are counted in the rule that created the state
393 (even though the rule is not evaluated more than once for the entire
394 connection).
395 .It Fl s Cm Anchors
396 Show the currently loaded anchors directly attached to the main ruleset.
397 If
398 .Fl a Ar anchor
399 is specified as well, the anchors loaded directly below the given
400 .Ar anchor
401 are shown instead.
402 If
403 .Fl v
404 is specified, all anchors attached under the target anchor will be
405 displayed recursively.
406 .It Fl s Cm states
407 Show the contents of the state table.
408 .It Fl s Cm Sources
409 Show the contents of the source tracking table.
410 .It Fl s Cm info
411 Show filter information (statistics and counters).
412 When used together with
413 .Fl v ,
414 source tracking statistics are also shown.
415 .It Fl s Cm labels
416 Show per-rule statistics (label, evaluations, packets total, bytes total,
417 packets in, bytes in, packets out, bytes out, state creations) of
418 filter rules with labels, useful for accounting.
419 .It Fl s Cm timeouts
420 Show the current global timeouts.
421 .It Fl s Cm memory
422 Show the current pool memory hard limits.
423 .It Fl s Cm Tables
424 Show the list of tables.
425 .It Fl s Cm osfp
426 Show the list of operating system fingerprints.
427 .It Fl s Cm Interfaces
428 Show the list of interfaces and interface drivers available to PF.
429 When used together with
430 .Fl v ,
431 it additionally lists which interfaces have skip rules activated.
432 When used together with
433 .Fl vv ,
434 interface statistics are also shown.
435 .Fl i
436 can be used to select an interface or a group of interfaces.
437 .It Fl s Cm all
438 Show all of the above, except for the lists of interfaces and operating
439 system fingerprints.
440 .El
441 .It Fl T Ar command Op Ar address ...
442 Specify the
443 .Ar command
444 (may be abbreviated) to apply to the table.
445 Commands include:
446 .Pp
447 .Bl -tag -width xxxxxxxxxxxx -compact
448 .It Fl T Cm kill
449 Kill a table.
450 .It Fl T Cm flush
451 Flush all addresses of a table.
452 .It Fl T Cm add
453 Add one or more addresses in a table.
454 Automatically create a nonexisting table.
455 .It Fl T Cm delete
456 Delete one or more addresses from a table.
457 .It Fl T Cm expire Ar number
458 Delete addresses which had their statistics cleared more than
459 .Ar number
460 seconds ago.
461 For entries which have never had their statistics cleared,
462 .Ar number
463 refers to the time they were added to the table.
464 .It Fl T Cm replace
465 Replace the addresses of the table.
466 Automatically create a nonexisting table.
467 .It Fl T Cm show
468 Show the content (addresses) of a table.
469 .It Fl T Cm test
470 Test if the given addresses match a table.
471 .It Fl T Cm zero
472 Clear all the statistics of a table.
473 .It Fl T Cm load
474 Load only the table definitions from
475 .Xr pf.conf 5 .
476 This is used in conjunction with the
477 .Fl f
478 flag, as in:
479 .Bd -literal -offset indent
480 # pfctl -Tl -f pf.conf
481 .Ed
482 .El
483 .Pp
484 For the
485 .Cm add ,
486 .Cm delete ,
487 .Cm replace ,
488 and
489 .Cm test
490 commands, the list of addresses can be specified either directly on the command
491 line and/or in an unformatted text file, using the
492 .Fl f
493 flag.
494 Comments starting with a
495 .Sq #
496 are allowed in the text file.
497 With these commands, the
498 .Fl v
499 flag can also be used once or twice, in which case
500 .Nm
501 will print the
502 detailed result of the operation for each individual address, prefixed by
503 one of the following letters:
504 .Pp
505 .Bl -tag -width XXX -compact
506 .It A
507 The address/network has been added.
508 .It C
509 The address/network has been changed (negated).
510 .It D
511 The address/network has been deleted.
512 .It M
513 The address matches
514 .Po
515 .Cm test
516 operation only
517 .Pc .
518 .It X
519 The address/network is duplicated and therefore ignored.
520 .It Y
521 The address/network cannot be added/deleted due to conflicting
522 .Sq \&!
523 attributes.
524 .It Z
525 The address/network has been cleared (statistics).
526 .El
527 .Pp
528 Each table can maintain a set of counters that can be retrieved using the
529 .Fl v
530 flag of
531 .Nm .
532 For example, the following commands define a wide open firewall which will keep
533 track of packets going to or coming from the
534 .Ox
535 FTP server.
536 The following commands configure the firewall and send 10 pings to the FTP
537 server:
538 .Bd -literal -offset indent
539 # printf "table <test> counters { ftp.openbsd.org }\en \e
540     pass out to <test>\en" | pfctl -f-
541 # ping -qc10 ftp.openbsd.org
542 .Ed
543 .Pp
544 We can now use the table
545 .Cm show
546 command to output, for each address and packet direction, the number of packets
547 and bytes that are being passed or blocked by rules referencing the table.
548 The time at which the current accounting started is also shown with the
549 .Dq Cleared
550 line.
551 .Bd -literal -offset indent
552 # pfctl -t test -vTshow
553    129.128.5.191
554     Cleared:     Thu Feb 13 18:55:18 2003
555     In/Block:    [ Packets: 0        Bytes: 0        ]
556     In/Pass:     [ Packets: 10       Bytes: 840      ]
557     Out/Block:   [ Packets: 0        Bytes: 0        ]
558     Out/Pass:    [ Packets: 10       Bytes: 840      ]
559 .Ed
560 .Pp
561 Similarly, it is possible to view global information about the tables
562 by using the
563 .Fl v
564 modifier twice and the
565 .Fl s
566 .Cm Tables
567 command.
568 This will display the number of addresses on each table,
569 the number of rules which reference the table, and the global
570 packet statistics for the whole table:
571 .Bd -literal -offset indent
572 # pfctl -vvsTables
573 --a-r-C test
574     Addresses:   1
575     Cleared:     Thu Feb 13 18:55:18 2003
576     References:  [ Anchors: 0        Rules: 1        ]
577     Evaluations: [ NoMatch: 3496     Match: 1        ]
578     In/Block:    [ Packets: 0        Bytes: 0        ]
579     In/Pass:     [ Packets: 10       Bytes: 840      ]
580     In/XPass:    [ Packets: 0        Bytes: 0        ]
581     Out/Block:   [ Packets: 0        Bytes: 0        ]
582     Out/Pass:    [ Packets: 10       Bytes: 840      ]
583     Out/XPass:   [ Packets: 0        Bytes: 0        ]
584 .Ed
585 .Pp
586 As we can see here, only one packet \- the initial ping request \- matched the
587 table, but all packets passing as the result of the state are correctly
588 accounted for.
589 Reloading the table(s) or ruleset will not affect packet accounting in any way.
590 The two
591 .Dq XPass
592 counters are incremented instead of the
593 .Dq Pass
594 counters when a
595 .Dq stateful
596 packet is passed but does not match the table anymore.
597 This will happen in our example if someone flushes the table while the
598 .Xr ping 8
599 command is running.
600 .Pp
601 When used with a single
602 .Fl v ,
603 .Nm
604 will only display the first line containing the table flags and name.
605 The flags are defined as follows:
606 .Pp
607 .Bl -tag -width XXX -compact
608 .It c
609 For constant tables, which cannot be altered outside
610 .Xr pf.conf 5 .
611 .It p
612 For persistent tables, which do not get automatically killed when no rules
613 refer to them.
614 .It a
615 For tables which are part of the
616 .Em active
617 tableset.
618 Tables without this flag do not really exist, cannot contain addresses, and are
619 only listed if the
620 .Fl g
621 flag is given.
622 .It i
623 For tables which are part of the
624 .Em inactive
625 tableset.
626 This flag can only be witnessed briefly during the loading of
627 .Xr pf.conf 5 .
628 .It r
629 For tables which are referenced (used) by rules.
630 .It h
631 This flag is set when a table in the main ruleset is hidden by one or more
632 tables of the same name from anchors attached below it.
633 .It C
634 This flag is set when per-address counters are enabled on the table.
635 .El
636 .It Fl t Ar table
637 Specify the name of the table.
638 .It Fl v
639 Produce more verbose output.
640 A second use of
641 .Fl v
642 will produce even more verbose output including ruleset warnings.
643 See the previous section for its effect on table commands.
644 .It Fl x Ar level
645 Set the debug
646 .Ar level
647 (may be abbreviated) to one of the following:
648 .Pp
649 .Bl -tag -width xxxxxxxxxxxx -compact
650 .It Fl x Cm none
651 Do not generate debug messages.
652 .It Fl x Cm urgent
653 Generate debug messages only for serious errors.
654 .It Fl x Cm misc
655 Generate debug messages for various errors.
656 .It Fl x Cm loud
657 Generate debug messages for common conditions.
658 .El
659 .It Fl z
660 Clear per-rule statistics.
661 .El
662 .Sh FILES
663 .Bl -tag -width "/etc/pf.conf" -compact
664 .It Pa /etc/pf.conf
665 Packet filter rules file.
666 .It Pa /etc/pf.os
667 Passive operating system fingerprint database.
668 .El
669 .Sh SEE ALSO
670 .Xr pf 4 ,
671 .Xr pf.conf 5 ,
672 .Xr pf.os 5 ,
673 .Xr rc.conf 5 ,
674 .Xr services 5 ,
675 .Xr sysctl.conf 5 ,
676 .Xr authpf 8 ,
677 .Xr ftp-proxy 8 ,
678 .Xr rc 8 ,
679 .Xr sysctl 8
680 .Sh HISTORY
681 The
682 .Nm
683 program and the
684 .Xr pf 4
685 filter mechanism appeared in
686 .Ox 3.0 .
687 They first appeared in
688 .Fx 5.3
689 ported from the version in
690 .Ox 3.5