6/contrib/pf/pfctl/pfctl.8

   1 .\" $OpenBSD: pfctl.8,v 1.118 2005/01/05 23:41:45 jmc 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 November 20, 2002
  30 .Dt PFCTL 8
  31 .Os
  32 .Sh NAME
  33 .Nm pfctl
  34 .Nd "control the packet filter (PF) and network address translation (NAT) device"
  35 .Sh SYNOPSIS
  36 .Nm pfctl
  37 .Bk -words
  38 .Op Fl AdeghmNnOoqRrvz
  39 .Op Fl a Ar anchor
  40 .Xo
  41 .Oo Fl D
  42 .Ar macro Ns = Ns Ar value Oc
  43 .Xc
  44 .Op Fl F Ar modifier
  45 .Op Fl f Ar file
  46 .Op Fl i Ar interface
  47 .Op Fl k Ar host
  48 .Op Fl p Ar device
  49 .Op Fl s Ar modifier
  50 .Oo Xo
  51 .Fl t Ar table
  52 .Fl T Ar command
  53 .Op Ar address ... Oc
  54 .Xc
  55 .Op Fl x Ar level
  56 .Ek
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility communicates with the packet filter device using the
  61 ioctl interface described in
  62 .Xr pf 4 .
  63 It allows ruleset and parameter configuration and retrieval of status
  64 information from the packet filter.
  65 .Pp
  66 Packet filtering restricts the types of packets that pass through
  67 network interfaces entering or leaving the host based on filter
  68 rules as described in
  69 .Xr pf.conf 5 .
  70 The packet filter can also replace addresses and ports of packets.
  71 Replacing source addresses and ports of outgoing packets is called
  72 NAT (Network Address Translation) and is used to connect an internal
  73 network (usually reserved address space) to an external one (the
  74 Internet) by making all connections to external hosts appear to
  75 come from the gateway.
  76 Replacing destination addresses and ports of incoming packets
  77 is used to redirect connections to different hosts and/or ports.
  78 A combination of both translations, bidirectional NAT, is also
  79 supported.
  80 Translation rules are described in
  81 .Xr pf.conf 5 .
  82 .Pp
  83 When the variable
  84 .Va pf
  85 is set to
  86 .Dv YES
  87 in
  88 .Xr rc.conf.local 5 ,
  89 the rule file specified with the variable
  90 .Va pf_rules
  91 is loaded automatically by the
  92 .Xr rc 8
  93 scripts and the packet filter is enabled.
  94 .Pp
  95 The packet filter does not itself forward packets between interfaces.
  96 Forwarding can be enabled by setting the
  97 .Xr sysctl 8
  98 variables
  99 .Em net.inet.ip.forwarding
 100 and/or
 101 .Em net.inet6.ip6.forwarding
 102 to 1.
 103 Set them permanently in
 104 .Xr sysctl.conf 5 .
 105 .Pp
 106 The
 107 .Nm
 108 utility provides several commands.
 109 The options are as follows:
 110 .Bl -tag -width Ds
 111 .It Fl A
 112 Load only the queue rules present in the rule file.
 113 Other rules and options are ignored.
 114 .It Fl a Ar anchor
 115 Apply flags
 116 .Fl f ,
 117 .Fl F ,
 118 and
 119 .Fl s
 120 only to the rules in the specified
 121 .Ar anchor .
 122 In addition to the main ruleset,
 123 .Nm
 124 can load and manipulate additional rulesets by name,
 125 called anchors.
 126 The main ruleset is the default anchor.
 127 .Pp
 128 Anchors are referenced by name and may be nested,
 129 with the various components of the anchor path separated by
 130 .Sq /
 131 characters, similar to how file system hierarchies are laid out.
 132 The last component of the anchor path is where ruleset operations are
 133 performed.
 134 .Pp
 135 Evaluation of
 136 .Ar anchor
 137 rules from the main ruleset is described in
 138 .Xr pf.conf 5 .
 139 .Pp
 140 For example, the following will show all filter rules (see the
 141 .Fl s
 142 flag below) inside the anchor
 143 .Li authpf/smith(1234) ,
 144 which would have been created for user smith by
 145 .Xr authpf 8 ,
 146 PID 1234:
 147 .Bd -literal -offset indent
 148 # pfctl -a "authpf/smith(1234)" -s rules
 149 .Ed
 150 .Pp
 151 Private tables can also be put inside anchors, either by having table
 152 statements in the
 153 .Xr pf.conf 5
 154 file that is loaded in the anchor, or by using regular table commands, as in:
 155 .Bd -literal -offset indent
 156 # pfctl -a foo/bar -t mytable -T add 1.2.3.4 5.6.7.8
 157 .Ed
 158 .Pp
 159 When a rule referring to a table is loaded in an anchor, the rule will use the
 160 private table if one is defined, and then fall back to the table defined in the
 161 main ruleset, if there is one.
 162 This is similar to C rules for variable scope.
 163 It is possible to create distinct tables with the same name in the global
 164 ruleset and in an anchor, but this is often bad design and a warning will be
 165 issued in that case.
 166 .It Fl D Ar macro Ns = Ns Ar value
 167 Define
 168 .Ar macro
 169 to be set to
 170 .Ar value
 171 on the command line.
 172 Overrides the definition of
 173 .Ar macro
 174 in the ruleset.
 175 .It Fl d
 176 Disable the packet filter.
 177 .It Fl e
 178 Enable the packet filter.
 179 .It Fl F Ar modifier
 180 Flush the filter parameters specified by
 181 .Ar modifier
 182 (may be abbreviated):
 183 .Pp
 184 .Bl -tag -width xxxxxxxxxxxx -compact
 185 .It Fl F Cm nat
 186 Flush the NAT rules.
 187 .It Fl F Cm queue
 188 Flush the queue rules.
 189 .It Fl F Cm rules
 190 Flush the filter rules.
 191 .It Fl F Cm state
 192 Flush the state table (NAT and filter).
 193 .It Fl F Cm Sources
 194 Flush the source tracking table.
 195 .It Fl F Cm info
 196 Flush the filter information (statistics that are not bound to rules).
 197 .It Fl F Cm Tables
 198 Flush the tables.
 199 .It Fl F Cm osfp
 200 Flush the passive operating system fingerprints.
 201 .It Fl F Cm all
 202 Flush all of the above.
 203 .El
 204 .It Fl f Ar file
 205 Load the rules contained in
 206 .Ar file .
 207 This
 208 .Ar file
 209 may contain macros, tables, options, and normalization, queueing,
 210 translation, and filtering rules.
 211 With the exception of macros and tables, the statements must appear in that
 212 order.
 213 .It Fl g
 214 Include output helpful for debugging.
 215 .It Fl h
 216 Help.
 217 .It Fl i Ar interface
 218 Restrict the operation to the given
 219 .Ar interface .
 220 .It Fl k Ar host
 221 Kill all of the state entries originating from the specified
 222 .Ar host .
 223 A second
 224 .Fl k Ar host
 225 option may be specified, which will kill all the state entries
 226 from the first
 227 .Ar host
 228 to the second
 229 .Ar host .
 230 For example, to kill all of the state entries originating from
 231 .Li host :
 232 .Bd -literal -offset indent
 233 # pfctl -k host
 234 .Ed
 235 .Pp
 236 To kill all of the state entries from
 237 .Li host1
 238 to
 239 .Li host2 :
 240 .Bd -literal -offset indent
 241 # pfctl -k host1 -k host2
 242 .Ed
 243 .It Fl m
 244 Merge in explicitly given options without resetting those
 245 which are omitted.
 246 Allows single options to be modified without disturbing the others:
 247 .Bd -literal -offset indent
 248 # echo "set loginterface fxp0" | pfctl -mf -
 249 .Ed
 250 .It Fl N
 251 Load only the NAT rules present in the rule file.
 252 Other rules and options are ignored.
 253 .It Fl n
 254 Do not actually load rules, just parse them.
 255 .It Fl O
 256 Load only the options present in the rule file.
 257 Other rules and options are ignored.
 258 .It Fl o
 259 Enable the ruleset optimizer.
 260 The ruleset optimizer attempts to improve rulesets by removing rule
 261 duplication and making better use of rule ordering.
 262 Specifically, it does four things:
 263 .Pp
 264 .Bl -enum -compact
 265 .It
 266 remove duplicate rules
 267 .It
 268 remove rules that are a subset of another rule
 269 .It
 270 combine multiple rules into a table when advantageous
 271 .It
 272 re-order the rules to improve evaluation performance
 273 .El
 274 .Pp
 275 A second
 276 .Fl o
 277 may be specified to use the currently loaded ruleset as a feedback profile
 278 to tailor the optimization of the
 279 .Ar quick
 280 rules to the actual network behavior.
 281 .Pp
 282 It is important to note that the ruleset optimizer will modify the ruleset
 283 to improve performance.
 284 A side effect of the ruleset modification is that per-rule accounting
 285 statistics will have different meanings than before.
 286 If per-rule accounting is important for billing purposes or whatnot, either
 287 the ruleset optimizer should not be used or a
 288 .Ar label
 289 field should be added to all of the accounting rules to act as optimization
 290 barriers.
 291 .It Fl p Ar device
 292 Use the device file
 293 .Ar device
 294 instead of the default
 295 .Pa /dev/pf .
 296 .It Fl q
 297 Only print errors and warnings.
 298 .It Fl R
 299 Load only the filter rules present in the rule file.
 300 Other rules and options are ignored.
 301 .It Fl r
 302 Perform reverse DNS lookups on states when displaying them.
 303 .It Fl s Ar modifier
 304 Show the filter parameters specified by
 305 .Ar modifier
 306 (may be abbreviated):
 307 .Pp
 308 .Bl -tag -width xxxxxxxxxxxxx -compact
 309 .It Fl s Cm nat
 310 Show the currently loaded NAT rules.
 311 .It Fl s Cm queue
 312 Show the currently loaded queue rules.
 313 When used together with
 314 .Fl v ,
 315 per-queue statistics are also shown.
 316 When used together with
 317 .Fl v v ,
 318 .Nm
 319 will loop and show updated queue statistics every five seconds, including
 320 measured bandwidth and packets per second.
 321 .It Fl s Cm rules
 322 Show the currently loaded filter rules.
 323 When used together with
 324 .Fl v ,
 325 the per-rule statistics (number of evaluations,
 326 packets and bytes) are also shown.
 327 Note that the
 328 .Dq skip step
 329 optimization done automatically by the kernel
 330 will skip evaluation of rules where possible.
 331 Packets passed statefully are counted in the rule that created the state
 332 (even though the rule isn't evaluated more than once for the entire
 333 connection).
 334 .It Fl s Cm Anchors
 335 Show the currently loaded anchors directly attached to the main ruleset.
 336 If
 337 .Fl a Ar anchor
 338 is specified as well, the anchors loaded directly below the given
 339 .Ar anchor
 340 are shown instead.
 341 If
 342 .Fl v
 343 is specified, all anchors attached under the target anchor will be
 344 displayed recursively.
 345 .It Fl s Cm state
 346 Show the contents of the state table.
 347 .It Fl s Cm Sources
 348 Show the contents of the source tracking table.
 349 .It Fl s Cm info
 350 Show filter information (statistics and counters).
 351 When used together with
 352 .Fl v ,
 353 source tracking statistics are also shown.
 354 .It Fl s Cm labels
 355 Show per-rule statistics (label, evaluations, packets, bytes) of
 356 filter rules with labels, useful for accounting.
 357 .It Fl s Cm timeouts
 358 Show the current global timeouts.
 359 .It Fl s Cm memory
 360 Show the current pool memory hard limits.
 361 .It Fl s Cm Tables
 362 Show the list of tables.
 363 .It Fl s Cm osfp
 364 Show the list of operating system fingerprints.
 365 .It Fl s Cm Interfaces
 366 Show the list of interfaces and interface drivers available to PF.
 367 When used together with a double
 368 .Fl v ,
 369 interface statistics are also shown.
 370 .Fl i
 371 can be used to select an interface or a group of interfaces.
 372 .It Fl s Cm all
 373 Show all of the above, except for the lists of interfaces and operating
 374 system fingerprints.
 375 .El
 376 .It Fl T Ar command Op Ar address ...
 377 Specify the
 378 .Ar command
 379 (may be abbreviated) to apply to the table.
 380 Commands include:
 381 .Pp
 382 .Bl -tag -width xxxxxxxxxxxx -compact
 383 .It Fl T Cm kill
 384 Kill a table.
 385 .It Fl T Cm flush
 386 Flush all addresses of a table.
 387 .It Fl T Cm add
 388 Add one or more addresses in a table.
 389 Automatically create a nonexisting table.
 390 .It Fl T Cm delete
 391 Delete one or more addresses from a table.
 392 .It Fl T Cm replace
 393 Replace the addresses of the table.
 394 Automatically create a nonexisting table.
 395 .It Fl T Cm show
 396 Show the content (addresses) of a table.
 397 .It Fl T Cm test
 398 Test if the given addresses match a table.
 399 .It Fl T Cm zero
 400 Clear all the statistics of a table.
 401 .It Fl T Cm load
 402 Load only the table definitions from
 403 .Xr pf.conf 5 .
 404 This is used in conjunction with the
 405 .Fl f
 406 flag, as in:
 407 .Bd -literal -offset indent
 408 # pfctl -Tl -f pf.conf
 409 .Ed
 410 .El
 411 .Pp
 412 For the
 413 .Cm add ,
 414 .Cm delete ,
 415 .Cm replace ,
 416 and
 417 .Cm test
 418 commands, the list of addresses can be specified either directly on the command
 419 line and/or in an unformatted text file, using the
 420 .Fl f
 421 flag.
 422 Comments starting with a
 423 .Sq #
 424 are allowed in the text file.
 425 With these commands, the
 426 .Fl v
 427 flag can also be used once or twice, in which case
 428 .Nm
 429 will print the
 430 detailed result of the operation for each individual address, prefixed by
 431 one of the following letters:
 432 .Pp
 433 .Bl -tag -width XXX -compact
 434 .It A
 435 The address/network has been added.
 436 .It C
 437 The address/network has been changed (negated).
 438 .It D
 439 The address/network has been deleted.
 440 .It M
 441 The address matches
 442 .Po
 443 .Cm test
 444 operation only
 445 .Pc .
 446 .It X
 447 The address/network is duplicated and therefore ignored.
 448 .It Y
 449 The address/network cannot be added/deleted due to conflicting
 450 .Sq \&!
 451 attributes.
 452 .It Z
 453 The address/network has been cleared (statistics).
 454 .El
 455 .Pp
 456 Each table maintains a set of counters that can be retrieved using the
 457 .Fl v
 458 flag of
 459 .Nm .
 460 For example, the following commands define a wide open firewall which will keep
 461 track of packets going to or coming from the
 462 .Ox
 463 FTP server.
 464 The following commands configure the firewall and send 10 pings to the FTP
 465 server:
 466 .Bd -literal -offset indent
 467 # printf "table <test> { ftp.openbsd.org }\en \e
 468     pass out to <test> keep state\en" | pfctl -f-
 469 # ping -qc10 ftp.openbsd.org
 470 .Ed
 471 .Pp
 472 We can now use the table
 473 .Cm show
 474 command to output, for each address and packet direction, the number of packets
 475 and bytes that are being passed or blocked by rules referencing the table.
 476 The time at which the current accounting started is also shown with the
 477 .Dq Cleared
 478 line.
 479 .Bd -literal -offset indent
 480 # pfctl -t test -vTshow
 481    129.128.5.191
 482     Cleared:     Thu Feb 13 18:55:18 2003
 483     In/Block:    [ Packets: 0        Bytes: 0        ]
 484     In/Pass:     [ Packets: 10       Bytes: 840      ]
 485     Out/Block:   [ Packets: 0        Bytes: 0        ]
 486     Out/Pass:    [ Packets: 10       Bytes: 840      ]
 487 .Ed
 488 .Pp
 489 Similarly, it is possible to view global information about the tables
 490 by using the
 491 .Fl v
 492 modifier twice and the
 493 .Fl s
 494 .Cm Tables
 495 command.
 496 This will display the number of addresses on each table,
 497 the number of rules which reference the table, and the global
 498 packet statistics for the whole table:
 499 .Bd -literal -offset indent
 500 # pfctl -vvsTables
 501 --a-r-  test
 502     Addresses:   1
 503     Cleared:     Thu Feb 13 18:55:18 2003
 504     References:  [ Anchors: 0        Rules: 1        ]
 505     Evaluations: [ NoMatch: 3496     Match: 1        ]
 506     In/Block:    [ Packets: 0        Bytes: 0        ]
 507     In/Pass:     [ Packets: 10       Bytes: 840      ]
 508     In/XPass:    [ Packets: 0        Bytes: 0        ]
 509     Out/Block:   [ Packets: 0        Bytes: 0        ]
 510     Out/Pass:    [ Packets: 10       Bytes: 840      ]
 511     Out/XPass:   [ Packets: 0        Bytes: 0        ]
 512 .Ed
 513 .Pp
 514 As we can see here, only one packet \- the initial ping request \- matched the
 515 table, but all packets passing as the result of the state are correctly
 516 accounted for.
 517 Reloading the table(s) or ruleset will not affect packet accounting in any way.
 518 The two
 519 .Dq XPass
 520 counters are incremented instead of the
 521 .Dq Pass
 522 counters when a
 523 .Dq stateful
 524 packet is passed but doesn't match the table anymore.
 525 This will happen in our example if someone flushes the table while the
 526 .Xr ping 8
 527 command is running.
 528 .Pp
 529 When used with a single
 530 .Fl v ,
 531 .Nm
 532 will only display the first line containing the table flags and name.
 533 The flags are defined as follows:
 534 .Pp
 535 .Bl -tag -width XXX -compact
 536 .It c
 537 For constant tables, which cannot be altered outside
 538 .Xr pf.conf 5 .
 539 .It p
 540 For persistent tables, which don't get automatically killed when no rules
 541 refer to them.
 542 .It a
 543 For tables which are part of the
 544 .Em active
 545 tableset.
 546 Tables without this flag do not really exist, cannot contain addresses, and are
 547 only listed if the
 548 .Fl g
 549 flag is given.
 550 .It i
 551 For tables which are part of the
 552 .Em inactive
 553 tableset.
 554 This flag can only be witnessed briefly during the loading of
 555 .Xr pf.conf 5 .
 556 .It r
 557 For tables which are referenced (used) by rules.
 558 .It h
 559 This flag is set when a table in the main ruleset is hidden by one or more
 560 tables of the same name from anchors attached below it.
 561 .El
 562 .It Fl t Ar table
 563 Specify the name of the table.
 564 .It Fl v
 565 Produce more verbose output.
 566 A second use of
 567 .Fl v
 568 will produce even more verbose output including ruleset warnings.
 569 See the previous section for its effect on table commands.
 570 .It Fl x Ar level
 571 Set the debug
 572 .Ar level
 573 (may be abbreviated) to one of the following:
 574 .Pp
 575 .Bl -tag -width xxxxxxxxxxxx -compact
 576 .It Fl x Cm none
 577 Don't generate debug messages.
 578 .It Fl x Cm urgent
 579 Generate debug messages only for serious errors.
 580 .It Fl x Cm misc
 581 Generate debug messages for various errors.
 582 .It Fl x Cm loud
 583 Generate debug messages for common conditions.
 584 .El
 585 .It Fl z
 586 Clear per-rule statistics.
 587 .El
 588 .Sh FILES
 589 .Bl -tag -width "/etc/pf.conf" -compact
 590 .It Pa /etc/pf.conf
 591 Packet filter rules file.
 592 .It Pa /etc/pf.os
 593 Passive operating system fingerprint database.
 594 .El
 595 .Sh SEE ALSO
 596 .Xr pf 4 ,
 597 .Xr pf.conf 5 ,
 598 .Xr pf.os 5 ,
 599 .Xr rc.conf 5 ,
 600 .Xr sysctl.conf 5 ,
 601 .Xr authpf 8 ,
 602 .Xr ftp-proxy 8 ,
 603 .Xr rc 8 ,
 604 .Xr sysctl 8
 605 .Sh HISTORY
 606 The
 607 .Nm
 608 program and the
 609 .Xr pf 4
 610 filter mechanism first appeared in
 611 .Ox 3.0 .