1.\" $OpenBSD: pf.conf.5,v 1.406 2009/01/31 19:37:12 sobrado Exp $ 2.\" 3.\" Copyright (c) 2002, Daniel Hartmeier 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 10.\" - Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" - Redistributions in binary form must reproduce the above 13.\" copyright notice, this list of conditions and the following 14.\" disclaimer in the documentation and/or other materials provided 15.\" with the distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 20.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 21.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 23.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 24.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 25.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 27.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd October 2, 2024 31.Dt PF.CONF 5 32.Os 33.Sh NAME 34.Nm pf.conf 35.Nd packet filter configuration file 36.Sh DESCRIPTION 37The 38.Xr pf 4 39packet filter modifies, drops or passes packets according to rules or 40definitions specified in 41.Nm pf.conf . 42.Sh STATEMENT ORDER 43There are eight types of statements in 44.Nm pf.conf : 45.Bl -tag -width xxxx 46.It Cm Macros 47User-defined variables may be defined and used later, simplifying 48the configuration file. 49Macros must be defined before they are referenced in 50.Nm pf.conf . 51.It Cm Tables 52Tables provide a mechanism for increasing the performance and flexibility of 53rules with large numbers of source or destination addresses. 54.It Cm Options 55Options tune the behaviour of the packet filtering engine. 56.It Cm Ethernet Filtering 57Ethernet filtering provides rule-based blocking or passing of Ethernet packets. 58.It Cm Traffic Normalization Li (e.g. Em scrub ) 59Traffic normalization protects internal machines against inconsistencies 60in Internet protocols and implementations. 61.It Cm Queueing 62Queueing provides rule-based bandwidth control. 63.It Cm Translation Li (Various forms of NAT) 64Translation rules specify how addresses are to be mapped or redirected to 65other addresses. 66.It Cm Packet Filtering 67Packet filtering provides rule-based blocking or passing of packets. 68.El 69.Pp 70With the exception of 71.Cm macros 72and 73.Cm tables , 74the types of statements should be grouped and appear in 75.Nm pf.conf 76in the order shown above, as this matches the operation of the underlying 77packet filtering engine. 78By default 79.Xr pfctl 8 80enforces this order (see 81.Ar set require-order 82below). 83.Pp 84Comments can be put anywhere in the file using a hash mark 85.Pq Sq # , 86and extend to the end of the current line. 87.Pp 88Additional configuration files can be included with the 89.Ic include 90keyword, for example: 91.Bd -literal -offset indent 92include "/etc/pf/sub.filter.conf" 93.Ed 94.Sh MACROS 95Macros can be defined that will later be expanded in context. 96Macro names must start with a letter, and may contain letters, digits 97and underscores. 98Macro names may not be reserved words (for example 99.Ar pass , 100.Ar in , 101.Ar out ) . 102Macros are not expanded inside quotes. 103.Pp 104For example, 105.Bd -literal -offset indent 106ext_if = \&"kue0\&" 107all_ifs = \&"{\&" $ext_if lo0 \&"}\&" 108pass out on $ext_if from any to any 109pass in on $ext_if proto tcp from any to any port 25 110.Ed 111.Sh TABLES 112Tables are named structures which can hold a collection of addresses and 113networks. 114Lookups against tables in 115.Xr pf 4 116are relatively fast, making a single rule with tables much more efficient, 117in terms of 118processor usage and memory consumption, than a large number of rules which 119differ only in IP address (either created explicitly or automatically by rule 120expansion). 121.Pp 122Tables can be used as the source or destination of filter rules, 123.Ar scrub 124rules 125or 126translation rules such as 127.Ar nat 128or 129.Ar rdr 130(see below for details on the various rule types). 131Tables can also be used for the redirect address of 132.Ar nat 133and 134.Ar rdr 135rules and in the routing options of filter rules, but only for 136.Ar round-robin 137pools. 138.Pp 139Tables can be defined with any of the following 140.Xr pfctl 8 141mechanisms. 142As with macros, reserved words may not be used as table names. 143.Bl -tag -width "manually" 144.It Ar manually 145Persistent tables can be manually created with the 146.Ar add 147or 148.Ar replace 149option of 150.Xr pfctl 8 , 151before or after the ruleset has been loaded. 152.It Pa pf.conf 153Table definitions can be placed directly in this file, and loaded at the 154same time as other rules are loaded, atomically. 155Table definitions inside 156.Nm pf.conf 157use the 158.Ar table 159statement, and are especially useful to define non-persistent tables. 160The contents of a pre-existing table defined without a list of addresses 161to initialize it is not altered when 162.Nm pf.conf 163is loaded. 164A table initialized with the empty list, 165.Li { } , 166will be cleared on load. 167.El 168.Pp 169Tables may be defined with the following attributes: 170.Bl -tag -width persist 171.It Ar persist 172The 173.Ar persist 174flag forces the kernel to keep the table even when no rules refer to it. 175If the flag is not set, the kernel will automatically remove the table 176when the last rule referring to it is flushed. 177.It Ar const 178The 179.Ar const 180flag prevents the user from altering the contents of the table once it 181has been created. 182Without that flag, 183.Xr pfctl 8 184can be used to add or remove addresses from the table at any time, even 185when running with 186.Xr securelevel 7 187= 2. 188.It Ar counters 189The 190.Ar counters 191flag enables per-address packet and byte counters which can be displayed with 192.Xr pfctl 8 . 193Note that this feature carries significant memory overhead for large tables. 194.El 195.Pp 196For example, 197.Bd -literal -offset indent 198table \*(Ltprivate\*(Gt const { 10/8, 172.16/12, 192.168/16 } 199table \*(Ltbadhosts\*(Gt persist 200block on fxp0 from { \*(Ltprivate\*(Gt, \*(Ltbadhosts\*(Gt } to any 201.Ed 202.Pp 203creates a table called private, to hold RFC 1918 private network 204blocks, and a table called badhosts, which is initially empty. 205A filter rule is set up to block all traffic coming from addresses listed in 206either table. 207The private table cannot have its contents changed and the badhosts table 208will exist even when no active filter rules reference it. 209Addresses may later be added to the badhosts table, so that traffic from 210these hosts can be blocked by using 211.Bd -literal -offset indent 212# pfctl -t badhosts -Tadd 204.92.77.111 213.Ed 214.Pp 215A table can also be initialized with an address list specified in one or more 216external files, using the following syntax: 217.Bd -literal -offset indent 218table \*(Ltspam\*(Gt persist file \&"/etc/spammers\&" file \&"/etc/openrelays\&" 219block on fxp0 from \*(Ltspam\*(Gt to any 220.Ed 221.Pp 222The files 223.Pa /etc/spammers 224and 225.Pa /etc/openrelays 226list IP addresses, one per line. 227Any lines beginning with a # are treated as comments and ignored. 228In addition to being specified by IP address, hosts may also be 229specified by their hostname. 230When the resolver is called to add a hostname to a table, 231.Em all 232resulting IPv4 and IPv6 addresses are placed into the table. 233IP addresses can also be entered in a table by specifying a valid interface 234name, a valid interface group or the 235.Em self 236keyword, in which case all addresses assigned to the interface(s) will be 237added to the table. 238.Sh OPTIONS 239.Xr pf 4 240may be tuned for various situations using the 241.Ar set 242command. 243.Bl -tag -width xxxx 244.It Ar set timeout 245.Pp 246.Bl -tag -width "src.track" -compact 247.It Ar interval 248Interval between purging expired states and fragments. 249.It Ar frag 250Seconds before an unassembled fragment is expired. 251.It Ar src.track 252Length of time to retain a source tracking entry after the last state 253expires. 254.El 255.Pp 256When a packet matches a stateful connection, the seconds to live for the 257connection will be updated to that of the 258.Ar proto.modifier 259which corresponds to the connection state. 260Each packet which matches this state will reset the TTL. 261Tuning these values may improve the performance of the 262firewall at the risk of dropping valid idle connections. 263.Pp 264.Bl -tag -width xxxx -compact 265.It Ar tcp.first 266The state after the first packet. 267.It Ar tcp.opening 268The state before the destination host ever sends a packet. 269.It Ar tcp.established 270The fully established state. 271.It Ar tcp.closing 272The state after the first FIN has been sent. 273.It Ar tcp.finwait 274The state after both FINs have been exchanged and the connection is closed. 275Some hosts (notably web servers on Solaris) send TCP packets even after closing 276the connection. 277Increasing 278.Ar tcp.finwait 279(and possibly 280.Ar tcp.closing ) 281can prevent blocking of such packets. 282.It Ar tcp.closed 283The state after one endpoint sends an RST. 284.El 285.Pp 286SCTP timeout are handled similar to TCP, but with its own set of states: 287.Pp 288.Bl -tag -width xxxx -compact 289.It Ar sctp.first 290The state after the first packet. 291.It Ar sctp.opening 292The state before the destination host ever sends a packet. 293.It Ar sctp.established 294The fully established state. 295.It Ar sctp.closing 296The state after the first SHUTDOWN chunk has been sent. 297.It Ar sctp.closed 298The state after SHUTDOWN_ACK has been exchanged and the connection is closed. 299.El 300.Pp 301ICMP and UDP are handled in a fashion similar to TCP, but with a much more 302limited set of states: 303.Pp 304.Bl -tag -width xxxx -compact 305.It Ar udp.first 306The state after the first packet. 307.It Ar udp.single 308The state if the source host sends more than one packet but the destination 309host has never sent one back. 310.It Ar udp.multiple 311The state if both hosts have sent packets. 312.It Ar icmp.first 313The state after the first packet. 314.It Ar icmp.error 315The state after an ICMP error came back in response to an ICMP packet. 316.El 317.Pp 318Other protocols are handled similarly to UDP: 319.Pp 320.Bl -tag -width xxxx -compact 321.It Ar other.first 322.It Ar other.single 323.It Ar other.multiple 324.El 325.Pp 326Timeout values can be reduced adaptively as the number of state table 327entries grows. 328.Pp 329.Bl -tag -width xxxx -compact 330.It Ar adaptive.start 331When the number of state entries exceeds this value, adaptive scaling 332begins. 333All timeout values are scaled linearly with factor 334(adaptive.end - number of states) / (adaptive.end - adaptive.start). 335.It Ar adaptive.end 336When reaching this number of state entries, all timeout values become 337zero, effectively purging all state entries immediately. 338This value is used to define the scale factor, it should not actually 339be reached (set a lower state limit, see below). 340.El 341.Pp 342Adaptive timeouts are enabled by default, with an adaptive.start value 343equal to 60% of the state limit, and an adaptive.end value equal to 344120% of the state limit. 345They can be disabled by setting both adaptive.start and adaptive.end to 0. 346.Pp 347The adaptive timeout values can be defined both globally and for each rule. 348When used on a per-rule basis, the values relate to the number of 349states created by the rule, otherwise to the total number of 350states. 351.Pp 352For example: 353.Bd -literal -offset indent 354set timeout tcp.first 120 355set timeout tcp.established 86400 356set timeout { adaptive.start 6000, adaptive.end 12000 } 357set limit states 10000 358.Ed 359.Pp 360With 9000 state table entries, the timeout values are scaled to 50% 361(tcp.first 60, tcp.established 43200). 362.It Ar set loginterface 363Enable collection of packet and byte count statistics for the given 364interface or interface group. 365These statistics can be viewed using 366.Bd -literal -offset indent 367# pfctl -s info 368.Ed 369.Pp 370In this example 371.Xr pf 4 372collects statistics on the interface named dc0: 373.Bd -literal -offset indent 374set loginterface dc0 375.Ed 376.Pp 377One can disable the loginterface using: 378.Bd -literal -offset indent 379set loginterface none 380.Ed 381.It Ar set limit 382Sets hard limits on the memory pools used by the packet filter. 383See 384.Xr zone 9 385for an explanation of memory pools. 386.Pp 387For example, 388.Bd -literal -offset indent 389set limit states 20000 390.Ed 391.Pp 392sets the maximum number of entries in the memory pool used by state table 393entries (generated by 394.Ar pass 395rules which do not specify 396.Ar no state ) 397to 20000. 398Using 399.Bd -literal -offset indent 400set limit frags 20000 401.Ed 402.Pp 403sets the maximum number of entries in the memory pool used for fragment 404reassembly (generated by the 405.Ar set reassemble 406option or 407.Ar scrub 408rules) to 20000. 409Using 410.Bd -literal -offset indent 411set limit src-nodes 2000 412.Ed 413.Pp 414sets the maximum number of entries in the memory pool used for tracking 415source IP addresses (generated by the 416.Ar sticky-address 417and 418.Ar src.track 419options) to 2000. 420Using 421.Bd -literal -offset indent 422set limit table-entries 100000 423.Ed 424.Pp 425sets the limit on the overall number of addresses that can be stored 426in tables to 100000. 427.Pp 428Various limits can be combined on a single line: 429.Bd -literal -offset indent 430set limit { states 20000, frags 20000, src-nodes 2000 } 431.Ed 432.It Ar set ruleset-optimization 433.Bl -tag -width xxxxxxxx -compact 434.It Ar none 435Disable the ruleset optimizer. 436.It Ar basic 437Enable basic ruleset optimization. 438This is the default behaviour. 439Basic ruleset optimization does four things to improve the 440performance of ruleset evaluations: 441.Pp 442.Bl -enum -compact 443.It 444remove duplicate rules 445.It 446remove rules that are a subset of another rule 447.It 448combine multiple rules into a table when advantageous 449.It 450re-order the rules to improve evaluation performance 451.El 452.Pp 453.It Ar profile 454Uses the currently loaded ruleset as a feedback profile to tailor the 455ordering of quick rules to actual network traffic. 456.El 457.Pp 458It is important to note that the ruleset optimizer will modify the ruleset 459to improve performance. 460A side effect of the ruleset modification is that per-rule accounting 461statistics will have different meanings than before. 462If per-rule accounting is important for billing purposes or whatnot, 463either the ruleset optimizer should not be used or a label field should 464be added to all of the accounting rules to act as optimization barriers. 465.Pp 466Optimization can also be set as a command-line argument to 467.Xr pfctl 8 , 468overriding the settings in 469.Nm . 470.It Ar set optimization 471Optimize state timeouts for one of the following network environments: 472.Pp 473.Bl -tag -width xxxx -compact 474.It Ar normal 475A normal network environment. 476Suitable for almost all networks. 477.It Ar high-latency 478A high-latency environment (such as a satellite connection). 479.It Ar satellite 480Alias for 481.Ar high-latency . 482.It Ar aggressive 483Aggressively expire connections. 484This can greatly reduce the memory usage of the firewall at the cost of 485dropping idle connections early. 486.It Ar conservative 487Extremely conservative settings. 488Avoid dropping legitimate connections at the 489expense of greater memory utilization (possibly much greater on a busy 490network) and slightly increased processor utilization. 491.El 492.Pp 493For example: 494.Bd -literal -offset indent 495set optimization aggressive 496.Ed 497.It Ar set reassemble yes | no Op Cm no-df 498The 499.Cm reassemble 500option is used to enable or disable the reassembly of fragmented packets, 501and can be set to 502.Cm yes 503or 504.Cm no . 505If 506.Cm no-df 507is also specified, fragments with the 508.Dq dont-fragment 509bit set are reassembled too, 510instead of being dropped; 511the reassembled packet will have the 512.Dq dont-fragment 513bit cleared. 514The default value is 515.Cm no . 516.Pp 517This option is ignored if there are pre-FreeBSD 14 518.Cm scrub 519rules present. 520.It Ar set block-policy 521The 522.Ar block-policy 523option sets the default behaviour for the packet 524.Ar block 525action: 526.Pp 527.Bl -tag -width xxxxxxxx -compact 528.It Ar drop 529Packet is silently dropped. 530.It Ar return 531A TCP RST is returned for blocked TCP packets, 532an SCTP ABORT chunk is returned for blocked SCTP packets, 533an ICMP UNREACHABLE is returned for blocked UDP packets, 534and all other packets are silently dropped. 535.El 536.Pp 537For example: 538.Bd -literal -offset indent 539set block-policy return 540.Ed 541.It Ar set fail-policy 542The 543.Ar fail-policy 544option sets the behaviour of rules which should pass a packet but were 545unable to do so. 546This might happen when a nat or route-to rule uses an empty table as list 547of targets or if a rule fails to create state or source node. 548The following 549.Ar block 550actions are possible: 551.Pp 552.Bl -tag -width xxxxxxxx -compact 553.It Ar drop 554Incoming packet is silently dropped. 555.It Ar return 556Incoming packet is dropped and TCP RST is returned for TCP packets, 557an SCTP ABORT chunk is returned for blocked SCTP packets, 558an ICMP UNREACHABLE is returned for UDP packets, 559and no response is sent for other packets. 560.El 561.Pp 562For example: 563.Bd -literal -offset indent 564set fail-policy return 565.Ed 566.It Ar set state-policy 567The 568.Ar state-policy 569option sets the default behaviour for states: 570.Pp 571.Bl -tag -width group-bound -compact 572.It Ar if-bound 573States are bound to interface. 574.It Ar floating 575States can match packets on any interfaces (the default). 576.El 577.Pp 578For example: 579.Bd -literal -offset indent 580set state-policy if-bound 581.Ed 582.It Ar set syncookies never | always | adaptive 583When 584.Cm syncookies 585are active, pf will answer each incoming TCP SYN with a syncookie SYNACK, 586without allocating any resources. 587Upon reception of the client's ACK in response to the syncookie 588SYNACK, pf will evaluate the ruleset and create state if the ruleset 589permits it, complete the three way handshake with the target host and 590continue the connection with synproxy in place. 591This allows pf to be resilient against large synflood attacks which would 592run the state table against its limits otherwise. 593Due to the blind answers to every incoming SYN syncookies share the caveats of 594synproxy, namely seemingly accepting connections that will be dropped later on. 595.Pp 596.Bl -tag -width adaptive -compact 597.It Cm never 598pf will never send syncookie SYNACKs (the default). 599.It Cm always 600pf will always send syncookie SYNACKs. 601.It Cm adaptive 602pf will enable syncookie mode when a given percentage of the state table 603is used up by half-open TCP connections, as in, those that saw the initial 604SYN but didn't finish the three way handshake. 605The thresholds for entering and leaving syncookie mode can be specified using 606.Bd -literal -offset indent 607set syncookies adaptive (start 25%, end 12%) 608.Ed 609.El 610.It Ar set state-defaults 611The 612.Ar state-defaults 613option sets the state options for states created from rules 614without an explicit 615.Ar keep state . 616For example: 617.Bd -literal -offset indent 618set state-defaults no-sync 619.Ed 620.It Ar set hostid 621The 32-bit 622.Ar hostid 623identifies this firewall's state table entries to other firewalls 624in a 625.Xr pfsync 4 626failover cluster. 627By default the hostid is set to a pseudo-random value, however it may be 628desirable to manually configure it, for example to more easily identify the 629source of state table entries. 630.Bd -literal -offset indent 631set hostid 1 632.Ed 633.Pp 634The hostid may be specified in either decimal or hexadecimal. 635.It Ar set require-order 636By default 637.Xr pfctl 8 638enforces an ordering of the statement types in the ruleset to: 639.Em options , 640.Em normalization , 641.Em queueing , 642.Em translation , 643.Em filtering . 644Setting this option to 645.Ar no 646disables this enforcement. 647There may be non-trivial and non-obvious implications to an out of 648order ruleset. 649Consider carefully before disabling the order enforcement. 650.It Ar set fingerprints 651Load fingerprints of known operating systems from the given filename. 652By default fingerprints of known operating systems are automatically 653loaded from 654.Xr pf.os 5 655in 656.Pa /etc 657but can be overridden via this option. 658Setting this option may leave a small period of time where the fingerprints 659referenced by the currently active ruleset are inconsistent until the new 660ruleset finishes loading. 661.Pp 662For example: 663.Pp 664.Dl set fingerprints \&"/etc/pf.os.devel\&" 665.It Ar set skip on Aq Ar ifspec 666List interfaces for which packets should not be filtered. 667Packets passing in or out on such interfaces are passed as if pf was 668disabled, i.e. pf does not process them in any way. 669This can be useful on loopback and other virtual interfaces, when 670packet filtering is not desired and can have unexpected effects. 671For example: 672.Pp 673.Dl set skip on lo0 674.It Ar set debug 675Set the debug 676.Ar level 677to one of the following: 678.Pp 679.Bl -tag -width xxxxxxxxxxxx -compact 680.It Ar none 681Don't generate debug messages. 682.It Ar urgent 683Generate debug messages only for serious errors. 684.It Ar misc 685Generate debug messages for various errors. 686.It Ar loud 687Generate debug messages for common conditions. 688.El 689.It Ar set keepcounters 690Preserve rule counters across rule updates. 691Usually rule counters are reset to zero on every update of the ruleset. 692With 693.Ar keepcounters 694set pf will attempt to find matching rules between old and new rulesets 695and preserve the rule counters. 696.El 697.Sh ETHERNET FILTERING 698.Xr pf 4 699has the ability to 700.Ar block 701and 702.Ar pass 703packets based on attributes of their Ethernet (layer 2) header. 704.Pp 705For each packet processed by the packet filter, the filter rules are 706evaluated in sequential order, from first to last. 707The last matching rule decides what action is taken. 708If no rule matches the packet, the default action is to pass 709the packet. 710.Pp 711The following actions can be used in the filter: 712.Bl -tag -width xxxx 713.It Ar block 714The packet is blocked. 715Unlike for layer 3 traffic the packet is always silently dropped. 716.It Ar pass 717The packet is passed; 718no state is created for layer 2 traffic. 719.El 720.Sh PARAMETERS 721The rule parameters specify the packets to which a rule applies. 722A packet always comes in on, or goes out through, one interface. 723Most parameters are optional. 724If a parameter is specified, the rule only applies to packets with 725matching attributes. 726Certain parameters can be expressed as lists, in which case 727.Xr pfctl 8 728generates all needed rule combinations. 729.Bl -tag -width xxxx 730.It Ar in No or Ar out 731This rule applies to incoming or outgoing packets. 732If neither 733.Ar in 734nor 735.Ar out 736are specified, the rule will match packets in both directions. 737.It Ar quick 738If a packet matches a rule which has the 739.Ar quick 740option set, this rule 741is considered the last matching rule, and evaluation of subsequent rules 742is skipped. 743.It Ar on Aq Ar ifspec 744This rule applies only to packets coming in on, or going out through, this 745particular interface or interface group. 746For more information on interface groups, 747see the 748.Ic group 749keyword in 750.Xr ifconfig 8 . 751.It Ar bridge-to Aq interface 752Packets matching this rule will be sent out of the specified interface without 753further processing. 754.It Ar proto Aq Ar protocol 755This rule applies only to packets of this protocol. 756Note that Ethernet protocol numbers are different from those used in 757.Xr ip 4 758and 759.Xr ip6 4 . 760.It Xo 761.Ar from Aq Ar source 762.Ar to Aq Ar dest 763.Xc 764This rule applies only to packets with the specified source and destination 765MAC addresses. 766.It Xo Ar queue Aq Ar queue 767.Xc 768Packets matching this rule will be assigned to the specified queue. 769See 770.Sx QUEUEING 771for setup details. 772.Pp 773.It Ar tag Aq Ar string 774Packets matching this rule will be tagged with the 775specified string. 776The tag acts as an internal marker that can be used to 777identify these packets later on. 778This can be used, for example, to provide trust between 779interfaces and to determine if packets have been 780processed by translation rules. 781Tags are 782.Qq sticky , 783meaning that the packet will be tagged even if the rule 784is not the last matching rule. 785Further matching rules can replace the tag with a 786new one but will not remove a previously applied tag. 787A packet is only ever assigned one tag at a time. 788.It Ar tagged Aq Ar string 789Used to specify that packets must already be tagged with the given tag in order 790to match the rule. 791Inverse tag matching can also be done by specifying the ! operator before the 792tagged keyword. 793.El 794.Sh TRAFFIC NORMALIZATION 795Traffic normalization is a broad umbrella term 796for aspects of the packet filter which deal with 797verifying packets, packet fragments, spoofed traffic, 798and other irregularities. 799.Ss Scrub 800Scrub involves sanitising packet content in such a way 801that there are no ambiguities in packet interpretation on the receiving side. 802It is invoked with the 803.Cm scrub 804option, added to filter rules. 805.Pp 806Parameters are specified enclosed in parentheses. 807At least one of the following parameters must be specified: 808.Bl -tag -width xxxx 809.It Ar no-df 810Clears the 811.Ar dont-fragment 812bit from a matching IP packet. 813Some operating systems are known to generate fragmented packets with the 814.Ar dont-fragment 815bit set. 816This is particularly true with NFS. 817.Ar Scrub 818will drop such fragmented 819.Ar dont-fragment 820packets unless 821.Ar no-df 822is specified. 823.Pp 824Unfortunately some operating systems also generate their 825.Ar dont-fragment 826packets with a zero IP identification field. 827Clearing the 828.Ar dont-fragment 829bit on packets with a zero IP ID may cause deleterious results if an 830upstream router later fragments the packet. 831Using the 832.Ar random-id 833modifier (see below) is recommended in combination with the 834.Ar no-df 835modifier to ensure unique IP identifiers. 836.It Ar min-ttl Aq Ar number 837Enforces a minimum TTL for matching IP packets. 838.It Ar max-mss Aq Ar number 839Enforces a maximum MSS for matching TCP packets. 840.It Xo Ar set-tos Aq Ar string 841.No \*(Ba Aq Ar number 842.Xc 843Enforces a 844.Em TOS 845for matching IP packets. 846.Em TOS 847may be 848given as one of 849.Ar critical , 850.Ar inetcontrol , 851.Ar lowdelay , 852.Ar netcontrol , 853.Ar throughput , 854.Ar reliability , 855or one of the DiffServ Code Points: 856.Ar ef , 857.Ar va , 858.Ar af11 No ... Ar af43 , 859.Ar cs0 No ... Ar cs7 ; 860or as either hex or decimal. 861.It Ar random-id 862Replaces the IP identification field with random values to compensate 863for predictable values generated by many hosts. 864This option only applies to packets that are not fragmented 865after the optional fragment reassembly. 866.It Ar reassemble tcp 867Statefully normalizes TCP connections. 868.Ar reassemble tcp 869performs the following normalizations: 870.Pp 871.Bl -tag -width timeout -compact 872.It ttl 873Neither side of the connection is allowed to reduce their IP TTL. 874An attacker may send a packet such that it reaches the firewall, affects 875the firewall state, and expires before reaching the destination host. 876.Ar reassemble tcp 877will raise the TTL of all packets back up to the highest value seen on 878the connection. 879.It timestamp modulation 880Modern TCP stacks will send a timestamp on every TCP packet and echo 881the other endpoint's timestamp back to them. 882Many operating systems will merely start the timestamp at zero when 883first booted, and increment it several times a second. 884The uptime of the host can be deduced by reading the timestamp and multiplying 885by a constant. 886Also observing several different timestamps can be used to count hosts 887behind a NAT device. 888And spoofing TCP packets into a connection requires knowing or guessing 889valid timestamps. 890Timestamps merely need to be monotonically increasing and not derived off a 891guessable base time. 892.Ar reassemble tcp 893will cause 894.Ar scrub 895to modulate the TCP timestamps with a random number. 896.It extended PAWS checks 897There is a problem with TCP on long fat pipes, in that a packet might get 898delayed for longer than it takes the connection to wrap its 32-bit sequence 899space. 900In such an occurrence, the old packet would be indistinguishable from a 901new packet and would be accepted as such. 902The solution to this is called PAWS: Protection Against Wrapped Sequence 903numbers. 904It protects against it by making sure the timestamp on each packet does 905not go backwards. 906.Ar reassemble tcp 907also makes sure the timestamp on the packet does not go forward more 908than the RFC allows. 909By doing this, 910.Xr pf 4 911artificially extends the security of TCP sequence numbers by 10 to 18 912bits when the host uses appropriately randomized timestamps, since a 913blind attacker would have to guess the timestamp as well. 914.El 915.El 916.Pp 917For example, 918.Bd -literal -offset indent 919match in all scrub (no-df random-id max-mss 1440) 920.Ed 921.Ss Scrub ruleset (pre-FreeBSD 14) 922In order to maintain compatibility with older releases of FreeBSD 923.Ar scrub 924rules can also be specified in their own ruleset. 925In such case they are invoked with the 926.Ar scrub 927directive. 928If there are such rules present they determine packet reassembly behaviour. 929When no such rules are present the option 930.Ar set reassembly 931takes precedence. 932The 933.Ar scrub 934rules can take all parameters specified above for a 935.Ar scrub 936option of filter rules and 2 more parameters controlling fragment reassembly: 937.Bl -tag -width xxxx 938.It Ar fragment reassemble 939Using 940.Ar scrub 941rules, fragments can be reassembled by normalization. 942In this case, fragments are buffered until they form a complete 943packet, and only the completed packet is passed on to the filter. 944The advantage is that filter rules have to deal only with complete 945packets, and can ignore fragments. 946The drawback of caching fragments is the additional memory cost. 947This is the default behaviour unless no fragment reassemble is specified. 948.It Ar no fragment reassemble 949Do not reassemble fragments. 950.El 951.Pp 952For example, 953.Bd -literal -offset indent 954scrub in on $ext_if all fragment reassemble 955.Ed 956.Pp 957The 958.Ar no 959option prefixed to a scrub rule causes matching packets to remain unscrubbed, 960much in the same way as 961.Ar drop quick 962works in the packet filter (see below). 963This mechanism should be used when it is necessary to exclude specific packets 964from broader scrub rules. 965.Pp 966.Ar scrub 967rules in the 968.Ar scrub 969ruleset are evaluated for every packet before stateful filtering. 970This means excessive usage of them will cause performance penalty. 971.Ar scrub reassemble tcp 972rules must not have the direction (in/out) specified. 973.Sh QUEUEING with ALTQ 974The ALTQ system is currently not available in the GENERIC kernel nor as 975loadable modules. 976In order to use the herein after called queueing options one has to use a 977custom built kernel. 978Please refer to 979.Xr altq 4 980to learn about the related kernel options. 981.Pp 982Packets can be assigned to queues for the purpose of bandwidth 983control. 984At least two declarations are required to configure queues, and later 985any packet filtering rule can reference the defined queues by name. 986During the filtering component of 987.Nm pf.conf , 988the last referenced 989.Ar queue 990name is where any packets from 991.Ar pass 992rules will be queued, while for 993.Ar block 994rules it specifies where any resulting ICMP or TCP RST 995packets should be queued. 996The 997.Ar scheduler 998defines the algorithm used to decide which packets get delayed, dropped, or 999sent out immediately. 1000There are three 1001.Ar schedulers 1002currently supported. 1003.Bl -tag -width xxxx 1004.It Ar cbq 1005Class Based Queueing. 1006.Ar Queues 1007attached to an interface build a tree, thus each 1008.Ar queue 1009can have further child 1010.Ar queues . 1011Each queue can have a 1012.Ar priority 1013and a 1014.Ar bandwidth 1015assigned. 1016.Ar Priority 1017mainly controls the time packets take to get sent out, while 1018.Ar bandwidth 1019has primarily effects on throughput. 1020.Ar cbq 1021achieves both partitioning and sharing of link bandwidth 1022by hierarchically structured classes. 1023Each class has its own 1024.Ar queue 1025and is assigned its share of 1026.Ar bandwidth . 1027A child class can borrow bandwidth from its parent class 1028as long as excess bandwidth is available 1029(see the option 1030.Ar borrow , 1031below). 1032.It Ar priq 1033Priority Queueing. 1034.Ar Queues 1035are flat attached to the interface, thus, 1036.Ar queues 1037cannot have further child 1038.Ar queues . 1039Each 1040.Ar queue 1041has a unique 1042.Ar priority 1043assigned, ranging from 0 to 15. 1044Packets in the 1045.Ar queue 1046with the highest 1047.Ar priority 1048are processed first. 1049.It Ar hfsc 1050Hierarchical Fair Service Curve. 1051.Ar Queues 1052attached to an interface build a tree, thus each 1053.Ar queue 1054can have further child 1055.Ar queues . 1056Each queue can have a 1057.Ar priority 1058and a 1059.Ar bandwidth 1060assigned. 1061.Ar Priority 1062mainly controls the time packets take to get sent out, while 1063.Ar bandwidth 1064primarily affects throughput. 1065.Ar hfsc 1066supports both link-sharing and guaranteed real-time services. 1067It employs a service curve based QoS model, 1068and its unique feature is an ability to decouple 1069.Ar delay 1070and 1071.Ar bandwidth 1072allocation. 1073.El 1074.Pp 1075The interfaces on which queueing should be activated are declared using 1076the 1077.Ar altq on 1078declaration. 1079.Ar altq on 1080has the following keywords: 1081.Bl -tag -width xxxx 1082.It Aq Ar interface 1083Queueing is enabled on the named interface. 1084.It Aq Ar scheduler 1085Specifies which queueing scheduler to use. 1086Currently supported values 1087are 1088.Ar cbq 1089for Class Based Queueing, 1090.Ar priq 1091for Priority Queueing and 1092.Ar hfsc 1093for the Hierarchical Fair Service Curve scheduler. 1094.It Ar bandwidth Aq Ar bw 1095The maximum bitrate for all queues on an 1096interface may be specified using the 1097.Ar bandwidth 1098keyword. 1099The value can be specified as an absolute value or as a 1100percentage of the interface bandwidth. 1101When using an absolute value, the suffixes 1102.Ar b , 1103.Ar Kb , 1104.Ar Mb , 1105and 1106.Ar Gb 1107are used to represent bits, kilobits, megabits, and 1108gigabits per second, respectively. 1109The value must not exceed the interface bandwidth. 1110If 1111.Ar bandwidth 1112is not specified, the interface bandwidth is used 1113(but take note that some interfaces do not know their bandwidth, 1114or can adapt their bandwidth rates). 1115.It Ar qlimit Aq Ar limit 1116The maximum number of packets held in the queue. 1117The default is 50. 1118.It Ar tbrsize Aq Ar size 1119Adjusts the size, in bytes, of the token bucket regulator. 1120If not specified, heuristics based on the 1121interface bandwidth are used to determine the size. 1122.It Ar queue Aq Ar list 1123Defines a list of subqueues to create on an interface. 1124.El 1125.Pp 1126In the following example, the interface dc0 1127should queue up to 5Mbps in four second-level queues using 1128Class Based Queueing. 1129Those four queues will be shown in a later example. 1130.Bd -literal -offset indent 1131altq on dc0 cbq bandwidth 5Mb queue { std, http, mail, ssh } 1132.Ed 1133.Pp 1134Once interfaces are activated for queueing using the 1135.Ar altq 1136directive, a sequence of 1137.Ar queue 1138directives may be defined. 1139The name associated with a 1140.Ar queue 1141must match a queue defined in the 1142.Ar altq 1143directive (e.g. mail), or, except for the 1144.Ar priq 1145.Ar scheduler , 1146in a parent 1147.Ar queue 1148declaration. 1149The following keywords can be used: 1150.Bl -tag -width xxxx 1151.It Ar on Aq Ar interface 1152Specifies the interface the queue operates on. 1153If not given, it operates on all matching interfaces. 1154.It Ar bandwidth Aq Ar bw 1155Specifies the maximum bitrate to be processed by the queue. 1156This value must not exceed the value of the parent 1157.Ar queue 1158and can be specified as an absolute value or a percentage of the parent 1159queue's bandwidth. 1160If not specified, defaults to 100% of the parent queue's bandwidth. 1161The 1162.Ar priq 1163scheduler does not support bandwidth specification. 1164.It Ar priority Aq Ar level 1165Between queues a priority level can be set. 1166For 1167.Ar cbq 1168and 1169.Ar hfsc , 1170the range is 0 to 7 and for 1171.Ar priq , 1172the range is 0 to 15. 1173The default for all is 1. 1174.Ar Priq 1175queues with a higher priority are always served first. 1176.Ar Cbq 1177and 1178.Ar Hfsc 1179queues with a higher priority are preferred in the case of overload. 1180.It Ar qlimit Aq Ar limit 1181The maximum number of packets held in the queue. 1182The default is 50. 1183.El 1184.Pp 1185The 1186.Ar scheduler 1187can get additional parameters with 1188.Xo Aq Ar scheduler 1189.Pf ( Aq Ar parameters ) . 1190.Xc 1191Parameters are as follows: 1192.Bl -tag -width Fl 1193.It Ar default 1194Packets not matched by another queue are assigned to this one. 1195Exactly one default queue is required. 1196.It Ar red 1197Enable RED (Random Early Detection) on this queue. 1198RED drops packets with a probability proportional to the average 1199queue length. 1200.It Ar rio 1201Enables RIO on this queue. 1202RIO is RED with IN/OUT, thus running 1203RED two times more than RIO would achieve the same effect. 1204RIO is currently not supported in the GENERIC kernel. 1205.It Ar ecn 1206Enables ECN (Explicit Congestion Notification) on this queue. 1207ECN implies RED. 1208.El 1209.Pp 1210The 1211.Ar cbq 1212.Ar scheduler 1213supports an additional option: 1214.Bl -tag -width Fl 1215.It Ar borrow 1216The queue can borrow bandwidth from the parent. 1217.El 1218.Pp 1219The 1220.Ar hfsc 1221.Ar scheduler 1222supports some additional options: 1223.Bl -tag -width Fl 1224.It Ar realtime Aq Ar sc 1225The minimum required bandwidth for the queue. 1226.It Ar upperlimit Aq Ar sc 1227The maximum allowed bandwidth for the queue. 1228.It Ar linkshare Aq Ar sc 1229The bandwidth share of a backlogged queue. 1230.El 1231.Pp 1232.Aq Ar sc 1233is an acronym for 1234.Ar service curve . 1235.Pp 1236The format for service curve specifications is 1237.Ar ( m1 , d , m2 ) . 1238.Ar m2 1239controls the bandwidth assigned to the queue. 1240.Ar m1 1241and 1242.Ar d 1243are optional and can be used to control the initial bandwidth assignment. 1244For the first 1245.Ar d 1246milliseconds the queue gets the bandwidth given as 1247.Ar m1 , 1248afterwards the value given in 1249.Ar m2 . 1250.Pp 1251Furthermore, with 1252.Ar cbq 1253and 1254.Ar hfsc , 1255child queues can be specified as in an 1256.Ar altq 1257declaration, thus building a tree of queues using a part of 1258their parent's bandwidth. 1259.Pp 1260Packets can be assigned to queues based on filter rules by using the 1261.Ar queue 1262keyword. 1263Normally only one 1264.Ar queue 1265is specified; when a second one is specified it will instead be used for 1266packets which have a 1267.Em TOS 1268of 1269.Em lowdelay 1270and for TCP ACKs with no data payload. 1271.Pp 1272To continue the previous example, the examples below would specify the 1273four referenced 1274queues, plus a few child queues. 1275Interactive 1276.Xr ssh 1 1277sessions get priority over bulk transfers like 1278.Xr scp 1 1279and 1280.Xr sftp 1 . 1281The queues may then be referenced by filtering rules (see 1282.Sx PACKET FILTERING 1283below). 1284.Bd -literal 1285queue std bandwidth 10% cbq(default) 1286queue http bandwidth 60% priority 2 cbq(borrow red) \e 1287 { employees, developers } 1288queue developers bandwidth 75% cbq(borrow) 1289queue employees bandwidth 15% 1290queue mail bandwidth 10% priority 0 cbq(borrow ecn) 1291queue ssh bandwidth 20% cbq(borrow) { ssh_interactive, ssh_bulk } 1292queue ssh_interactive bandwidth 50% priority 7 cbq(borrow) 1293queue ssh_bulk bandwidth 50% priority 0 cbq(borrow) 1294 1295block return out on dc0 inet all queue std 1296pass out on dc0 inet proto tcp from $developerhosts to any port 80 \e 1297 queue developers 1298pass out on dc0 inet proto tcp from $employeehosts to any port 80 \e 1299 queue employees 1300pass out on dc0 inet proto tcp from any to any port 22 \e 1301 queue(ssh_bulk, ssh_interactive) 1302pass out on dc0 inet proto tcp from any to any port 25 \e 1303 queue mail 1304.Ed 1305.Sh QUEUEING with dummynet 1306Queueing can also be done with 1307.Xr dummynet 4 . 1308Queues and pipes can be created with 1309.Xr dnctl 8 . 1310.Pp 1311Packets can be assigned to queues and pipes using 1312.Ar dnqueue 1313and 1314.Ar dnpipe 1315respectively. 1316.Pp 1317Both 1318.Ar dnqueue 1319and 1320.Ar dnpipe 1321take either a single pipe or queue number or two numbers as arguments. 1322The first pipe or queue number will be used to shape the traffic in the rule 1323direction, the second will be used to shape the traffic in the reverse 1324direction. 1325If the rule does not specify a direction the first packet to create state will 1326be shaped according to the first number, and the response traffic according to 1327the second. 1328.Pp 1329If the 1330.Xr dummynet 4 1331module is not loaded any traffic sent into a queue or pipe will be dropped. 1332.Sh TRANSLATION 1333Translation rules modify either the source or destination address of the 1334packets associated with a stateful connection. 1335A stateful connection is automatically created to track packets matching 1336such a rule as long as they are not blocked by the filtering section of 1337.Nm pf.conf . 1338The translation engine modifies the specified address and/or port in the 1339packet, recalculates IP, TCP and UDP checksums as necessary, and passes 1340it to the packet filter for evaluation. 1341.Pp 1342Since translation occurs before filtering the filter 1343engine will see packets as they look after any 1344addresses and ports have been translated. 1345Filter rules will therefore have to filter based on the translated 1346address and port number. 1347Packets that match a translation rule are only automatically passed if 1348the 1349.Ar pass 1350modifier is given, otherwise they are 1351still subject to 1352.Ar block 1353and 1354.Ar pass 1355rules. 1356.Pp 1357The state entry created permits 1358.Xr pf 4 1359to keep track of the original address for traffic associated with that state 1360and correctly direct return traffic for that connection. 1361.Pp 1362Various types of translation are possible with pf: 1363.Bl -tag -width xxxx 1364.It Ar binat 1365A 1366.Ar binat 1367rule specifies a bidirectional mapping between an external IP netblock 1368and an internal IP netblock. 1369.It Ar nat 1370A 1371.Ar nat 1372rule specifies that IP addresses are to be changed as the packet 1373traverses the given interface. 1374This technique allows one or more IP addresses 1375on the translating host to support network traffic for a larger range of 1376machines on an "inside" network. 1377Although in theory any IP address can be used on the inside, it is strongly 1378recommended that one of the address ranges defined by RFC 1918 be used. 1379These netblocks are: 1380.Bd -literal 138110.0.0.0 - 10.255.255.255 (all of net 10, i.e., 10/8) 1382172.16.0.0 - 172.31.255.255 (i.e., 172.16/12) 1383192.168.0.0 - 192.168.255.255 (i.e., 192.168/16) 1384.Ed 1385.It Pa rdr 1386The packet is redirected to another destination and possibly a 1387different port. 1388.Ar rdr 1389rules can optionally specify port ranges instead of single ports. 1390rdr ... port 2000:2999 -\*(Gt ... port 4000 1391redirects ports 2000 to 2999 (inclusive) to port 4000. 1392rdr ... port 2000:2999 -\*(Gt ... port 4000:* 1393redirects port 2000 to 4000, 2001 to 4001, ..., 2999 to 4999. 1394.El 1395.Pp 1396In addition to modifying the address, some translation rules may modify 1397source or destination ports for 1398.Xr tcp 4 1399or 1400.Xr udp 4 1401connections; implicitly in the case of 1402.Ar nat 1403rules and both implicitly and explicitly in the case of 1404.Ar rdr 1405rules. 1406A 1407.Ar rdr 1408rule may cause the source port to be modified if doing so avoids a conflict 1409with an existing connection. 1410A random source port in the range 50001-65535 is chosen in this case; to 1411avoid excessive CPU consumption, the number of searches for a free port is 1412limited by the 1413.Va net.pf.rdr_srcport_rewrite_tries 1414sysctl. 1415Port numbers are never translated with a 1416.Ar binat 1417rule. 1418.Pp 1419Evaluation order of the translation rules is dependent on the type 1420of the translation rules and of the direction of a packet. 1421.Ar binat 1422rules are always evaluated first. 1423Then either the 1424.Ar rdr 1425rules are evaluated on an inbound packet or the 1426.Ar nat 1427rules on an outbound packet. 1428Rules of the same type are evaluated in the same order in which they 1429appear in the ruleset. 1430The first matching rule decides what action is taken. 1431.Pp 1432The 1433.Ar no 1434option prefixed to a translation rule causes packets to remain untranslated, 1435much in the same way as 1436.Ar drop quick 1437works in the packet filter (see below). 1438If no rule matches the packet it is passed to the filter engine unmodified. 1439.Pp 1440Translation rules apply only to packets that pass through 1441the specified interface, and if no interface is specified, 1442translation is applied to packets on all interfaces. 1443For instance, redirecting port 80 on an external interface to an internal 1444web server will only work for connections originating from the outside. 1445Connections to the address of the external interface from local hosts will 1446not be redirected, since such packets do not actually pass through the 1447external interface. 1448Redirections cannot reflect packets back through the interface they arrive 1449on, they can only be redirected to hosts connected to different interfaces 1450or to the firewall itself. 1451.Pp 1452Note that redirecting external incoming connections to the loopback 1453address, as in 1454.Bd -literal -offset indent 1455rdr on ne3 inet proto tcp to port smtp -\*(Gt 127.0.0.1 port spamd 1456.Ed 1457.Pp 1458will effectively allow an external host to connect to daemons 1459bound solely to the loopback address, circumventing the traditional 1460blocking of such connections on a real interface. 1461Unless this effect is desired, any of the local non-loopback addresses 1462should be used as redirection target instead, which allows external 1463connections only to daemons bound to this address or not bound to 1464any address. 1465.Pp 1466See 1467.Sx TRANSLATION EXAMPLES 1468below. 1469.Sh PACKET FILTERING 1470.Xr pf 4 1471has the ability to 1472.Ar block 1473, 1474.Ar pass 1475and 1476.Ar match 1477packets based on attributes of their layer 3 (see 1478.Xr ip 4 1479and 1480.Xr ip6 4 ) 1481and layer 4 (see 1482.Xr icmp 4 , 1483.Xr icmp6 4 , 1484.Xr tcp 4 , 1485.Xr sctp 4 , 1486.Xr udp 4 ) 1487headers. 1488In addition, packets may also be 1489assigned to queues for the purpose of bandwidth control. 1490.Pp 1491For each packet processed by the packet filter, the filter rules are 1492evaluated in sequential order, from first to last. 1493For 1494.Ar block 1495and 1496.Ar pass 1497, the last matching rule decides what action is taken. 1498For 1499.Ar match 1500, rules are evaluated every time they match; the pass/block state of a packet 1501remains unchanged. 1502If no rule matches the packet, the default action is to pass 1503the packet. 1504.Pp 1505The following actions can be used in the filter: 1506.Bl -tag -width xxxx 1507.It Ar block 1508The packet is blocked. 1509There are a number of ways in which a 1510.Ar block 1511rule can behave when blocking a packet. 1512The default behaviour is to 1513.Ar drop 1514packets silently, however this can be overridden or made 1515explicit either globally, by setting the 1516.Ar block-policy 1517option, or on a per-rule basis with one of the following options: 1518.Pp 1519.Bl -tag -width xxxx -compact 1520.It Ar drop 1521The packet is silently dropped. 1522.It Ar return-rst 1523This applies only to 1524.Xr tcp 4 1525packets, and issues a TCP RST which closes the 1526connection. 1527.It Ar return-icmp 1528.It Ar return-icmp6 1529This causes ICMP messages to be returned for packets which match the rule. 1530By default this is an ICMP UNREACHABLE message, however this 1531can be overridden by specifying a message as a code or number. 1532.It Ar return 1533This causes a TCP RST to be returned for 1534.Xr tcp 4 1535packets, an SCTP ABORT for SCTP 1536and an ICMP UNREACHABLE for UDP and other packets. 1537.El 1538.Pp 1539Options returning ICMP packets currently have no effect if 1540.Xr pf 4 1541operates on a 1542.Xr if_bridge 4 , 1543as the code to support this feature has not yet been implemented. 1544.Pp 1545The simplest mechanism to block everything by default and only pass 1546packets that match explicit rules is specify a first filter rule of: 1547.Bd -literal -offset indent 1548block all 1549.Ed 1550.It Ar match 1551The packet is matched. 1552This mechanism is used to provide fine grained filtering without altering the 1553block/pass state of a packet. 1554.Ar match 1555rules differ from 1556.Ar block 1557and 1558.Ar pass 1559rules in that parameters are set for every rule a packet matches, not only 1560on the last matching rule. 1561For the following parameters, this means that the parameter effectively becomes 1562"sticky" until explicitly overridden: 1563.Ar queue , 1564.Ar dnpipe , 1565.Ar dnqueue , 1566.Ar rtable , 1567.Ar scrub 1568. 1569.It Ar pass 1570The packet is passed; 1571state is created unless the 1572.Ar no state 1573option is specified. 1574.El 1575.Pp 1576By default 1577.Xr pf 4 1578filters packets statefully; the first time a packet matches a 1579.Ar pass 1580rule, a state entry is created; for subsequent packets the filter checks 1581whether the packet matches any state. 1582If it does, the packet is passed without evaluation of any rules. 1583After the connection is closed or times out, the state entry is automatically 1584removed. 1585.Pp 1586This has several advantages. 1587For TCP connections, comparing a packet to a state involves checking 1588its sequence numbers, as well as TCP timestamps if a 1589.Ar scrub reassemble tcp 1590rule applies to the connection. 1591If these values are outside the narrow windows of expected 1592values, the packet is dropped. 1593This prevents spoofing attacks, such as when an attacker sends packets with 1594a fake source address/port but does not know the connection's sequence 1595numbers. 1596Similarly, 1597.Xr pf 4 1598knows how to match ICMP replies to states. 1599For example, 1600.Bd -literal -offset indent 1601pass out inet proto icmp all icmp-type echoreq 1602.Ed 1603.Pp 1604allows echo requests (such as those created by 1605.Xr ping 8 ) 1606out statefully, and matches incoming echo replies correctly to states. 1607.Pp 1608Also, looking up states is usually faster than evaluating rules. 1609If there are 50 rules, all of them are evaluated sequentially in O(n). 1610Even with 50000 states, only 16 comparisons are needed to match a 1611state, since states are stored in a binary search tree that allows 1612searches in O(log2 n). 1613.Pp 1614Furthermore, correct handling of ICMP error messages is critical to 1615many protocols, particularly TCP. 1616.Xr pf 4 1617matches ICMP error messages to the correct connection, checks them against 1618connection parameters, and passes them if appropriate. 1619For example if an ICMP source quench message referring to a stateful TCP 1620connection arrives, it will be matched to the state and get passed. 1621.Pp 1622Finally, state tracking is required for 1623.Ar nat , binat No and Ar rdr 1624rules, in order to track address and port translations and reverse the 1625translation on returning packets. 1626.Pp 1627.Xr pf 4 1628will also create state for other protocols which are effectively stateless by 1629nature. 1630UDP packets are matched to states using only host addresses and ports, 1631and other protocols are matched to states using only the host addresses. 1632.Pp 1633If stateless filtering of individual packets is desired, 1634the 1635.Ar no state 1636keyword can be used to specify that state will not be created 1637if this is the last matching rule. 1638A number of parameters can also be set to affect how 1639.Xr pf 4 1640handles state tracking. 1641See 1642.Sx STATEFUL TRACKING OPTIONS 1643below for further details. 1644.Sh PARAMETERS 1645The rule parameters specify the packets to which a rule applies. 1646A packet always comes in on, or goes out through, one interface. 1647Most parameters are optional. 1648If a parameter is specified, the rule only applies to packets with 1649matching attributes. 1650Certain parameters can be expressed as lists, in which case 1651.Xr pfctl 8 1652generates all needed rule combinations. 1653.Bl -tag -width xxxx 1654.It Ar in No or Ar out 1655This rule applies to incoming or outgoing packets. 1656If neither 1657.Ar in 1658nor 1659.Ar out 1660are specified, the rule will match packets in both directions. 1661.It Ar log 1662In addition to the action specified, a log message is generated. 1663Only the packet that establishes the state is logged, 1664unless the 1665.Ar no state 1666option is specified. 1667The logged packets are sent to a 1668.Xr pflog 4 1669interface, by default 1670.Ar pflog0 . 1671This interface is monitored by the 1672.Xr pflogd 8 1673logging daemon, which dumps the logged packets to the file 1674.Pa /var/log/pflog 1675in 1676.Xr pcap 3 1677binary format. 1678.It Ar log (all) 1679Used to force logging of all packets for a connection. 1680This is not necessary when 1681.Ar no state 1682is explicitly specified. 1683As with 1684.Ar log , 1685packets are logged to 1686.Xr pflog 4 . 1687.It Ar log (matches) 1688Used to force logging of this packet on all subsequent matching rules. 1689.It Ar log (user) 1690Logs the 1691.Ux 1692user ID of the user that owns the socket and the PID of the process that 1693has the socket open where the packet is sourced from or destined to 1694(depending on which socket is local). 1695This is in addition to the normal information logged. 1696.Pp 1697Only the first packet 1698logged via 1699.Ar log (all, user) 1700will have the user credentials logged when using stateful matching. 1701.It Ar log (to Aq Ar interface ) 1702Send logs to the specified 1703.Xr pflog 4 1704interface instead of 1705.Ar pflog0 . 1706.It Ar quick 1707If a packet matches a rule which has the 1708.Ar quick 1709option set, this rule 1710is considered the last matching rule, and evaluation of subsequent rules 1711is skipped. 1712.It Ar on Aq Ar interface 1713This rule applies only to packets coming in on, or going out through, this 1714particular interface or interface group. 1715For more information on interface groups, 1716see the 1717.Ic group 1718keyword in 1719.Xr ifconfig 8 . 1720.It Aq Ar af 1721This rule applies only to packets of this address family. 1722Supported values are 1723.Ar inet 1724and 1725.Ar inet6 . 1726.It Ar proto Aq Ar protocol 1727This rule applies only to packets of this protocol. 1728Common protocols are 1729.Xr icmp 4 , 1730.Xr icmp6 4 , 1731.Xr tcp 4 , 1732.Xr sctp 4 , 1733and 1734.Xr udp 4 . 1735For a list of all the protocol name to number mappings used by 1736.Xr pfctl 8 , 1737see the file 1738.Pa /etc/protocols . 1739.It Xo 1740.Ar from Aq Ar source 1741.Ar port Aq Ar source 1742.Ar os Aq Ar source 1743.Ar to Aq Ar dest 1744.Ar port Aq Ar dest 1745.Xc 1746This rule applies only to packets with the specified source and destination 1747addresses and ports. 1748.Pp 1749Addresses can be specified in CIDR notation (matching netblocks), as 1750symbolic host names, interface names or interface group names, or as any 1751of the following keywords: 1752.Pp 1753.Bl -tag -width xxxxxxxxxxxxxx -compact 1754.It Ar any 1755Any address. 1756.It Ar no-route 1757Any address which is not currently routable. 1758.It Ar urpf-failed 1759Any source address that fails a unicast reverse path forwarding (URPF) 1760check, i.e. packets coming in on an interface other than that which holds 1761the route back to the packet's source address. 1762.It Aq Ar table 1763Any address that matches the given table. 1764.El 1765.Pp 1766Ranges of addresses are specified by using the 1767.Sq - 1768operator. 1769For instance: 1770.Dq 10.1.1.10 - 10.1.1.12 1771means all addresses from 10.1.1.10 to 10.1.1.12, 1772hence addresses 10.1.1.10, 10.1.1.11, and 10.1.1.12. 1773.Pp 1774Interface names and interface group names can have modifiers appended: 1775.Pp 1776.Bl -tag -width xxxxxxxxxxxx -compact 1777.It Ar :network 1778Translates to the network(s) attached to the interface. 1779.It Ar :broadcast 1780Translates to the interface's broadcast address(es). 1781.It Ar :peer 1782Translates to the point-to-point interface's peer address(es). 1783.It Ar :0 1784Do not include interface aliases. 1785.El 1786.Pp 1787Host names may also have the 1788.Ar :0 1789option appended to restrict the name resolution to the first of each 1790v4 and non-link-local v6 address found. 1791.Pp 1792Host name resolution and interface to address translation are done at 1793ruleset load-time. 1794When the address of an interface (or host name) changes (under DHCP or PPP, 1795for instance), the ruleset must be reloaded for the change to be reflected 1796in the kernel. 1797Surrounding the interface name (and optional modifiers) in parentheses 1798changes this behaviour. 1799When the interface name is surrounded by parentheses, the rule is 1800automatically updated whenever the interface changes its address. 1801The ruleset does not need to be reloaded. 1802This is especially useful with 1803.Ar nat . 1804.Pp 1805Ports can be specified either by number or by name. 1806For example, port 80 can be specified as 1807.Em www . 1808For a list of all port name to number mappings used by 1809.Xr pfctl 8 , 1810see the file 1811.Pa /etc/services . 1812.Pp 1813Ports and ranges of ports are specified by using these operators: 1814.Bd -literal -offset indent 1815= (equal) 1816!= (unequal) 1817\*(Lt (less than) 1818\*(Le (less than or equal) 1819\*(Gt (greater than) 1820\*(Ge (greater than or equal) 1821: (range including boundaries) 1822\*(Gt\*(Lt (range excluding boundaries) 1823\*(Lt\*(Gt (except range) 1824.Ed 1825.Pp 1826.Sq \*(Gt\*(Lt , 1827.Sq \*(Lt\*(Gt 1828and 1829.Sq \&: 1830are binary operators (they take two arguments). 1831For instance: 1832.Bl -tag -width Fl 1833.It Ar port 2000:2004 1834means 1835.Sq all ports \*(Ge 2000 and \*(Le 2004 , 1836hence ports 2000, 2001, 2002, 2003 and 2004. 1837.It Ar port 2000 \*(Gt\*(Lt 2004 1838means 1839.Sq all ports \*(Gt 2000 and \*(Lt 2004 , 1840hence ports 2001, 2002 and 2003. 1841.It Ar port 2000 \*(Lt\*(Gt 2004 1842means 1843.Sq all ports \*(Lt 2000 or \*(Gt 2004 , 1844hence ports 1-1999 and 2005-65535. 1845.El 1846.Pp 1847The operating system of the source host can be specified in the case of TCP 1848rules with the 1849.Ar OS 1850modifier. 1851See the 1852.Sx OPERATING SYSTEM FINGERPRINTING 1853section for more information. 1854.Pp 1855The host, port and OS specifications are optional, as in the following examples: 1856.Bd -literal -offset indent 1857pass in all 1858pass in from any to any 1859pass in proto tcp from any port \*(Le 1024 to any 1860pass in proto tcp from any to any port 25 1861pass in proto tcp from 10.0.0.0/8 port \*(Gt 1024 \e 1862 to ! 10.1.2.3 port != ssh 1863pass in proto tcp from any os "OpenBSD" 1864.Ed 1865.It Ar all 1866This is equivalent to "from any to any". 1867.It Ar group Aq Ar group 1868Similar to 1869.Ar user , 1870this rule only applies to packets of sockets owned by the specified group. 1871.It Ar user Aq Ar user 1872This rule only applies to packets of sockets owned by the specified user. 1873For outgoing connections initiated from the firewall, this is the user 1874that opened the connection. 1875For incoming connections to the firewall itself, this is the user that 1876listens on the destination port. 1877For forwarded connections, where the firewall is not a connection endpoint, 1878the user and group are 1879.Em unknown . 1880.Pp 1881All packets, both outgoing and incoming, of one connection are associated 1882with the same user and group. 1883Only TCP and UDP packets can be associated with users; for other protocols 1884these parameters are ignored. 1885.Pp 1886User and group refer to the effective (as opposed to the real) IDs, in 1887case the socket is created by a setuid/setgid process. 1888User and group IDs are stored when a socket is created; 1889when a process creates a listening socket as root (for instance, by 1890binding to a privileged port) and subsequently changes to another 1891user ID (to drop privileges), the credentials will remain root. 1892.Pp 1893User and group IDs can be specified as either numbers or names. 1894The syntax is similar to the one for ports. 1895The value 1896.Em unknown 1897matches packets of forwarded connections. 1898.Em unknown 1899can only be used with the operators 1900.Cm = 1901and 1902.Cm != . 1903Other constructs like 1904.Cm user \*(Ge unknown 1905are invalid. 1906Forwarded packets with unknown user and group ID match only rules 1907that explicitly compare against 1908.Em unknown 1909with the operators 1910.Cm = 1911or 1912.Cm != . 1913For instance 1914.Cm user \*(Ge 0 1915does not match forwarded packets. 1916The following example allows only selected users to open outgoing 1917connections: 1918.Bd -literal -offset indent 1919block out proto { tcp, udp } all 1920pass out proto { tcp, udp } all user { \*(Lt 1000, dhartmei } 1921.Ed 1922.It Xo Ar flags Aq Ar a 1923.Pf / Ns Aq Ar b 1924.No \*(Ba / Ns Aq Ar b 1925.No \*(Ba any 1926.Xc 1927This rule only applies to TCP packets that have the flags 1928.Aq Ar a 1929set out of set 1930.Aq Ar b . 1931Flags not specified in 1932.Aq Ar b 1933are ignored. 1934For stateful connections, the default is 1935.Ar flags S/SA . 1936To indicate that flags should not be checked at all, specify 1937.Ar flags any . 1938The flags are: (F)IN, (S)YN, (R)ST, (P)USH, (A)CK, (U)RG, (E)CE, and C(W)R. 1939.Bl -tag -width Fl 1940.It Ar flags S/S 1941Flag SYN is set. 1942The other flags are ignored. 1943.It Ar flags S/SA 1944This is the default setting for stateful connections. 1945Out of SYN and ACK, exactly SYN may be set. 1946SYN, SYN+PSH and SYN+RST match, but SYN+ACK, ACK and ACK+RST do not. 1947This is more restrictive than the previous example. 1948.It Ar flags /SFRA 1949If the first set is not specified, it defaults to none. 1950All of SYN, FIN, RST and ACK must be unset. 1951.El 1952.Pp 1953Because 1954.Ar flags S/SA 1955is applied by default (unless 1956.Ar no state 1957is specified), only the initial SYN packet of a TCP handshake will create 1958a state for a TCP connection. 1959It is possible to be less restrictive, and allow state creation from 1960intermediate 1961.Pq non-SYN 1962packets, by specifying 1963.Ar flags any . 1964This will cause 1965.Xr pf 4 1966to synchronize to existing connections, for instance 1967if one flushes the state table. 1968However, states created from such intermediate packets may be missing 1969connection details such as the TCP window scaling factor. 1970States which modify the packet flow, such as those affected by 1971.Ar nat , binat No or Ar rdr 1972rules, 1973.Ar modulate No or Ar synproxy state 1974options, or scrubbed with 1975.Ar reassemble tcp 1976will also not be recoverable from intermediate packets. 1977Such connections will stall and time out. 1978.It Xo Ar icmp-type Aq Ar type 1979.Ar code Aq Ar code 1980.Xc 1981.It Xo Ar icmp6-type Aq Ar type 1982.Ar code Aq Ar code 1983.Xc 1984This rule only applies to ICMP or ICMPv6 packets with the specified type 1985and code. 1986Text names for ICMP types and codes are listed in 1987.Xr icmp 4 1988and 1989.Xr icmp6 4 . 1990This parameter is only valid for rules that cover protocols ICMP or 1991ICMP6. 1992The protocol and the ICMP type indicator 1993.Po 1994.Ar icmp-type 1995or 1996.Ar icmp6-type 1997.Pc 1998must match. 1999.It Xo Ar tos Aq Ar string 2000.No \*(Ba Aq Ar number 2001.Xc 2002This rule applies to packets with the specified 2003.Em TOS 2004bits set. 2005.Em TOS 2006may be 2007given as one of 2008.Ar critical , 2009.Ar inetcontrol , 2010.Ar lowdelay , 2011.Ar netcontrol , 2012.Ar throughput , 2013.Ar reliability , 2014or one of the DiffServ Code Points: 2015.Ar ef , 2016.Ar va , 2017.Ar af11 No ... Ar af43 , 2018.Ar cs0 No ... Ar cs7 ; 2019or as either hex or decimal. 2020.Pp 2021For example, the following rules are identical: 2022.Bd -literal -offset indent 2023pass all tos lowdelay 2024pass all tos 0x10 2025pass all tos 16 2026.Ed 2027.It Ar allow-opts 2028By default, IPv4 packets with IP options or IPv6 packets with routing 2029extension headers are blocked. 2030When 2031.Ar allow-opts 2032is specified for a 2033.Ar pass 2034rule, packets that pass the filter based on that rule (last matching) 2035do so even if they contain IP options or routing extension headers. 2036For packets that match state, the rule that initially created the 2037state is used. 2038The implicit 2039.Ar pass 2040rule that is used when a packet does not match any rules does not 2041allow IP options. 2042.It Ar label Aq Ar string 2043Adds a label (name) to the rule, which can be used to identify the rule. 2044For instance, 2045pfctl -s labels 2046shows per-rule statistics for rules that have labels. 2047.Pp 2048The following macros can be used in labels: 2049.Pp 2050.Bl -tag -width $srcaddr -compact -offset indent 2051.It Ar $if 2052The interface. 2053.It Ar $srcaddr 2054The source IP address. 2055.It Ar $dstaddr 2056The destination IP address. 2057.It Ar $srcport 2058The source port specification. 2059.It Ar $dstport 2060The destination port specification. 2061.It Ar $proto 2062The protocol name. 2063.It Ar $nr 2064The rule number. 2065.El 2066.Pp 2067For example: 2068.Bd -literal -offset indent 2069ips = \&"{ 1.2.3.4, 1.2.3.5 }\&" 2070pass in proto tcp from any to $ips \e 2071 port \*(Gt 1023 label \&"$dstaddr:$dstport\&" 2072.Ed 2073.Pp 2074expands to 2075.Bd -literal -offset indent 2076pass in inet proto tcp from any to 1.2.3.4 \e 2077 port \*(Gt 1023 label \&"1.2.3.4:\*(Gt1023\&" 2078pass in inet proto tcp from any to 1.2.3.5 \e 2079 port \*(Gt 1023 label \&"1.2.3.5:\*(Gt1023\&" 2080.Ed 2081.Pp 2082The macro expansion for the 2083.Ar label 2084directive occurs only at configuration file parse time, not during runtime. 2085.It Ar ridentifier Aq Ar number 2086Add an identifier (number) to the rule, which can be used to correlate the rule 2087to pflog entries, even after ruleset updates. 2088.It Xo Ar queue Aq Ar queue 2089.No \*(Ba ( Aq Ar queue , 2090.Aq Ar queue ) 2091.Xc 2092Packets matching this rule will be assigned to the specified queue. 2093If two queues are given, packets which have a 2094.Em TOS 2095of 2096.Em lowdelay 2097and TCP ACKs with no data payload will be assigned to the second one. 2098See 2099.Sx QUEUEING 2100for setup details. 2101.Pp 2102For example: 2103.Bd -literal -offset indent 2104pass in proto tcp to port 25 queue mail 2105pass in proto tcp to port 22 queue(ssh_bulk, ssh_prio) 2106.Ed 2107.It Cm set prio Ar priority | Pq Ar priority , priority 2108Packets matching this rule will be assigned a specific queueing priority. 2109Priorities are assigned as integers 0 through 7. 2110If the packet is transmitted on a 2111.Xr vlan 4 2112interface, the queueing priority will be written as the priority 2113code point in the 802.1Q VLAN header. 2114If two priorities are given, packets which have a TOS of 2115.Cm lowdelay 2116and TCP ACKs with no data payload will be assigned to the second one. 2117.Pp 2118For example: 2119.Bd -literal -offset indent 2120pass in proto tcp to port 25 set prio 2 2121pass in proto tcp to port 22 set prio (2, 5) 2122.Ed 2123.It Ar received-on Aq Ar interface 2124Only match packets which were received on the specified 2125.Ar interface 2126(or interface group). 2127.It Ar tag Aq Ar string 2128Packets matching this rule will be tagged with the 2129specified string. 2130The tag acts as an internal marker that can be used to 2131identify these packets later on. 2132This can be used, for example, to provide trust between 2133interfaces and to determine if packets have been 2134processed by translation rules. 2135Tags are 2136.Qq sticky , 2137meaning that the packet will be tagged even if the rule 2138is not the last matching rule. 2139Further matching rules can replace the tag with a 2140new one but will not remove a previously applied tag. 2141A packet is only ever assigned one tag at a time. 2142Packet tagging can be done during 2143.Ar nat , 2144.Ar rdr , 2145.Ar binat 2146or 2147.Ar ether 2148rules in addition to filter rules. 2149Tags take the same macros as labels (see above). 2150.It Ar tagged Aq Ar string 2151Used with filter, translation or scrub rules 2152to specify that packets must already 2153be tagged with the given tag in order to match the rule. 2154Inverse tag matching can also be done 2155by specifying the 2156.Cm !\& 2157operator before the 2158.Ar tagged 2159keyword. 2160.It Ar rtable Aq Ar number 2161Used to select an alternate routing table for the routing lookup. 2162Only effective before the route lookup happened, i.e. when filtering inbound. 2163.It Xo Ar divert-to Aq Ar host 2164.Ar port Aq Ar port 2165.Xc 2166Used to 2167.Xr divert 4 2168packets to the given divert 2169.Ar port . 2170Historically 2171.Ox pf has another meaning for this, and 2172.Fx pf uses 2173this syntax to support 2174.Xr divert 4 instead. Hence, 2175.Ar host 2176has no meaning and can be set to anything like 127.0.0.1. 2177If a packet is re-injected and does not change direction then it will not be 2178re-diverted. 2179.It Ar divert-reply 2180It has no meaning in 2181.Fx pf . 2182.It Ar probability Aq Ar number 2183A probability attribute can be attached to a rule, with a value set between 21840 and 1, bounds not included. 2185In that case, the rule will be honoured using the given probability value 2186only. 2187For example, the following rule will drop 20% of incoming ICMP packets: 2188.Bd -literal -offset indent 2189block in proto icmp probability 20% 2190.Ed 2191.It Ar prio Aq Ar number 2192Only match packets which have the given queueing priority assigned. 2193.El 2194.Sh ROUTING 2195If a packet matches a rule with a route option set, the packet filter will 2196route the packet according to the type of route option. 2197When such a rule creates state, the route option is also applied to all 2198packets matching the same connection. 2199.Bl -tag -width xxxx 2200.It Ar route-to 2201The 2202.Ar route-to 2203option routes the packet to the specified interface with an optional address 2204for the next hop. 2205When a 2206.Ar route-to 2207rule creates state, only packets that pass in the same direction as the 2208filter rule specifies will be routed in this way. 2209Packets passing in the opposite direction (replies) are not affected 2210and are routed normally. 2211.It Ar reply-to 2212The 2213.Ar reply-to 2214option is similar to 2215.Ar route-to , 2216but routes packets that pass in the opposite direction (replies) to the 2217specified interface. 2218Opposite direction is only defined in the context of a state entry, and 2219.Ar reply-to 2220is useful only in rules that create state. 2221It can be used on systems with multiple external connections to 2222route all outgoing packets of a connection through the interface 2223the incoming connection arrived through (symmetric routing enforcement). 2224.It Ar dup-to 2225The 2226.Ar dup-to 2227option creates a duplicate of the packet and routes it like 2228.Ar route-to . 2229The original packet gets routed as it normally would. 2230.El 2231.Sh POOL OPTIONS 2232For 2233.Ar nat 2234and 2235.Ar rdr 2236rules, (as well as for the 2237.Ar route-to , 2238.Ar reply-to 2239and 2240.Ar dup-to 2241rule options) for which there is a single redirection address which has a 2242subnet mask smaller than 32 for IPv4 or 128 for IPv6 (more than one IP 2243address), a variety of different methods for assigning this address can be 2244used: 2245.Bl -tag -width xxxx 2246.It Ar bitmask 2247The 2248.Ar bitmask 2249option applies the network portion of the redirection address to the address 2250to be modified (source with 2251.Ar nat , 2252destination with 2253.Ar rdr ) . 2254.It Ar random 2255The 2256.Ar random 2257option selects an address at random within the defined block of addresses. 2258.It Ar source-hash 2259The 2260.Ar source-hash 2261option uses a hash of the source address to determine the redirection address, 2262ensuring that the redirection address is always the same for a given source. 2263An optional key can be specified after this keyword either in hex or as a 2264string; by default 2265.Xr pfctl 8 2266randomly generates a key for source-hash every time the 2267ruleset is reloaded. 2268.It Ar round-robin 2269The 2270.Ar round-robin 2271option loops through the redirection address(es). 2272.Pp 2273When more than one redirection address is specified, 2274.Ar round-robin 2275is the only permitted pool type. 2276.It Ar static-port 2277With 2278.Ar nat 2279rules, the 2280.Ar static-port 2281option prevents 2282.Xr pf 4 2283from modifying the source port on TCP and UDP packets. 2284.It Xo Ar map-e-portset Aq Ar psid-offset 2285.No / Aq Ar psid-len 2286.No / Aq Ar psid 2287.Xc 2288With 2289.Ar nat 2290rules, the 2291.It Ar endpoint-independent 2292With 2293.Ar nat 2294rules, the 2295.Ar endpoint-independent 2296option caues 2297.Xr pf 4 2298to always map connections from a UDP source address and port to the same 2299NAT address and port. 2300This feature implements "full-cone" NAT behavior. 2301.Ar map-e-portset 2302option enables the source port translation of MAP-E (RFC 7597) Customer Edge. 2303In order to make the host act as a MAP-E Customer Edge, setting up a tunneling 2304interface and pass rules for encapsulated packets are required in addition 2305to the map-e-portset nat rule. 2306.Pp 2307For example: 2308.Bd -literal -offset indent 2309nat on $gif_mape_if from $int_if:network to any \e 2310 -> $ipv4_mape_src map-e-portset 6/8/0x34 2311.Ed 2312.Pp 2313sets PSID offset 6, PSID length 8, PSID 0x34. 2314.El 2315.Pp 2316Additionally, the 2317.Ar sticky-address 2318option can be specified to help ensure that multiple connections from the 2319same source are mapped to the same redirection address. 2320This option can be used with the 2321.Ar random 2322and 2323.Ar round-robin 2324pool options. 2325Note that by default these associations are destroyed as soon as there are 2326no longer states which refer to them; in order to make the mappings last 2327beyond the lifetime of the states, increase the global options with 2328.Ar set timeout src.track . 2329See 2330.Sx STATEFUL TRACKING OPTIONS 2331for more ways to control the source tracking. 2332.Sh STATE MODULATION 2333Much of the security derived from TCP is attributable to how well the 2334initial sequence numbers (ISNs) are chosen. 2335Some popular stack implementations choose 2336.Em very 2337poor ISNs and thus are normally susceptible to ISN prediction exploits. 2338By applying a 2339.Ar modulate state 2340rule to a TCP connection, 2341.Xr pf 4 2342will create a high quality random sequence number for each connection 2343endpoint. 2344.Pp 2345The 2346.Ar modulate state 2347directive implicitly keeps state on the rule and is 2348only applicable to TCP connections. 2349.Pp 2350For instance: 2351.Bd -literal -offset indent 2352block all 2353pass out proto tcp from any to any modulate state 2354pass in proto tcp from any to any port 25 flags S/SFRA modulate state 2355.Ed 2356.Pp 2357Note that modulated connections will not recover when the state table 2358is lost (firewall reboot, flushing the state table, etc...). 2359.Xr pf 4 2360will not be able to infer a connection again after the state table flushes 2361the connection's modulator. 2362When the state is lost, the connection may be left dangling until the 2363respective endpoints time out the connection. 2364It is possible on a fast local network for the endpoints to start an ACK 2365storm while trying to resynchronize after the loss of the modulator. 2366The default 2367.Ar flags 2368settings (or a more strict equivalent) should be used on 2369.Ar modulate state 2370rules to prevent ACK storms. 2371.Pp 2372Note that alternative methods are available 2373to prevent loss of the state table 2374and allow for firewall failover. 2375See 2376.Xr carp 4 2377and 2378.Xr pfsync 4 2379for further information. 2380.Sh SYN PROXY 2381By default, 2382.Xr pf 4 2383passes packets that are part of a 2384.Xr tcp 4 2385handshake between the endpoints. 2386The 2387.Ar synproxy state 2388option can be used to cause 2389.Xr pf 4 2390itself to complete the handshake with the active endpoint, perform a handshake 2391with the passive endpoint, and then forward packets between the endpoints. 2392.Pp 2393No packets are sent to the passive endpoint before the active endpoint has 2394completed the handshake, hence so-called SYN floods with spoofed source 2395addresses will not reach the passive endpoint, as the sender can't complete the 2396handshake. 2397.Pp 2398The proxy is transparent to both endpoints, they each see a single 2399connection from/to the other endpoint. 2400.Xr pf 4 2401chooses random initial sequence numbers for both handshakes. 2402Once the handshakes are completed, the sequence number modulators 2403(see previous section) are used to translate further packets of the 2404connection. 2405.Ar synproxy state 2406includes 2407.Ar modulate state . 2408.Pp 2409Rules with 2410.Ar synproxy 2411will not work if 2412.Xr pf 4 2413operates on a 2414.Xr bridge 4 . 2415.Pp 2416Example: 2417.Bd -literal -offset indent 2418pass in proto tcp from any to any port www synproxy state 2419.Ed 2420.Sh STATEFUL TRACKING OPTIONS 2421A number of options related to stateful tracking can be applied on a 2422per-rule basis. 2423.Ar keep state , 2424.Ar modulate state 2425and 2426.Ar synproxy state 2427support these options, and 2428.Ar keep state 2429must be specified explicitly to apply options to a rule. 2430.Pp 2431.Bl -tag -width xxxx -compact 2432.It Ar max Aq Ar number 2433Limits the number of concurrent states the rule may create. 2434When this limit is reached, further packets that would create 2435state are dropped until existing states time out. 2436.It Ar no-sync 2437Prevent state changes for states created by this rule from appearing on the 2438.Xr pfsync 4 2439interface. 2440.It Xo Aq Ar timeout 2441.Aq Ar seconds 2442.Xc 2443Changes the timeout values used for states created by this rule. 2444For a list of all valid timeout names, see 2445.Sx OPTIONS 2446above. 2447.It Ar sloppy 2448Uses a sloppy TCP connection tracker that does not check sequence 2449numbers at all, which makes insertion and ICMP teardown attacks way 2450easier. 2451This is intended to be used in situations where one does not see all 2452packets of a connection, e.g. in asymmetric routing situations. 2453Cannot be used with modulate or synproxy state. 2454.It Ar pflow 2455States created by this rule are exported on the 2456.Xr pflow 4 2457interface. 2458.El 2459.Pp 2460Multiple options can be specified, separated by commas: 2461.Bd -literal -offset indent 2462pass in proto tcp from any to any \e 2463 port www keep state \e 2464 (max 100, source-track rule, max-src-nodes 75, \e 2465 max-src-states 3, tcp.established 60, tcp.closing 5) 2466.Ed 2467.Pp 2468When the 2469.Ar source-track 2470keyword is specified, the number of states per source IP is tracked. 2471.Pp 2472.Bl -tag -width xxxx -compact 2473.It Ar source-track rule 2474The maximum number of states created by this rule is limited by the rule's 2475.Ar max-src-nodes 2476and 2477.Ar max-src-states 2478options. 2479Only state entries created by this particular rule count toward the rule's 2480limits. 2481.It Ar source-track global 2482The number of states created by all rules that use this option is limited. 2483Each rule can specify different 2484.Ar max-src-nodes 2485and 2486.Ar max-src-states 2487options, however state entries created by any participating rule count towards 2488each individual rule's limits. 2489.El 2490.Pp 2491The following limits can be set: 2492.Pp 2493.Bl -tag -width xxxx -compact 2494.It Ar max-src-nodes Aq Ar number 2495Limits the maximum number of source addresses which can simultaneously 2496have state table entries. 2497.It Ar max-src-states Aq Ar number 2498Limits the maximum number of simultaneous state entries that a single 2499source address can create with this rule. 2500.El 2501.Pp 2502For stateful TCP connections, limits on established connections (connections 2503which have completed the TCP 3-way handshake) can also be enforced 2504per source IP. 2505.Pp 2506.Bl -tag -width xxxx -compact 2507.It Ar max-src-conn Aq Ar number 2508Limits the maximum number of simultaneous TCP connections which have 2509completed the 3-way handshake that a single host can make. 2510.It Xo Ar max-src-conn-rate Aq Ar number 2511.No / Aq Ar seconds 2512.Xc 2513Limit the rate of new connections over a time interval. 2514The connection rate is an approximation calculated as a moving average. 2515.El 2516.Pp 2517When one of these limits is reached, further packets that would create 2518state are dropped until existing states time out. 2519.Pp 2520Because the 3-way handshake ensures that the source address is not being 2521spoofed, more aggressive action can be taken based on these limits. 2522With the 2523.Ar overload Aq Ar table 2524state option, source IP addresses which hit either of the limits on 2525established connections will be added to the named table. 2526This table can be used in the ruleset to block further activity from 2527the offending host, redirect it to a tarpit process, or restrict its 2528bandwidth. 2529.Pp 2530The optional 2531.Ar flush 2532keyword kills all states created by the matching rule which originate 2533from the host which exceeds these limits. 2534The 2535.Ar global 2536modifier to the flush command kills all states originating from the 2537offending host, regardless of which rule created the state. 2538.Pp 2539For example, the following rules will protect the webserver against 2540hosts making more than 100 connections in 10 seconds. 2541Any host which connects faster than this rate will have its address added 2542to the 2543.Aq bad_hosts 2544table and have all states originating from it flushed. 2545Any new packets arriving from this host will be dropped unconditionally 2546by the block rule. 2547.Bd -literal -offset indent 2548block quick from \*(Ltbad_hosts\*(Gt 2549pass in on $ext_if proto tcp to $webserver port www keep state \e 2550 (max-src-conn-rate 100/10, overload \*(Ltbad_hosts\*(Gt flush global) 2551.Ed 2552.Sh OPERATING SYSTEM FINGERPRINTING 2553Passive OS Fingerprinting is a mechanism to inspect nuances of a TCP 2554connection's initial SYN packet and guess at the host's operating system. 2555Unfortunately these nuances are easily spoofed by an attacker so the 2556fingerprint is not useful in making security decisions. 2557But the fingerprint is typically accurate enough to make policy decisions 2558upon. 2559.Pp 2560The fingerprints may be specified by operating system class, by 2561version, or by subtype/patchlevel. 2562The class of an operating system is typically the vendor or genre 2563and would be 2564.Ox 2565for the 2566.Xr pf 4 2567firewall itself. 2568The version of the oldest available 2569.Ox 2570release on the main FTP site 2571would be 2.6 and the fingerprint would be written 2572.Pp 2573.Dl \&"OpenBSD 2.6\&" 2574.Pp 2575The subtype of an operating system is typically used to describe the 2576patchlevel if that patch led to changes in the TCP stack behavior. 2577In the case of 2578.Ox , 2579the only subtype is for a fingerprint that was 2580normalized by the 2581.Ar no-df 2582scrub option and would be specified as 2583.Pp 2584.Dl \&"OpenBSD 3.3 no-df\&" 2585.Pp 2586Fingerprints for most popular operating systems are provided by 2587.Xr pf.os 5 . 2588Once 2589.Xr pf 4 2590is running, a complete list of known operating system fingerprints may 2591be listed by running: 2592.Pp 2593.Dl # pfctl -so 2594.Pp 2595Filter rules can enforce policy at any level of operating system specification 2596assuming a fingerprint is present. 2597Policy could limit traffic to approved operating systems or even ban traffic 2598from hosts that aren't at the latest service pack. 2599.Pp 2600The 2601.Ar unknown 2602class can also be used as the fingerprint which will match packets for 2603which no operating system fingerprint is known. 2604.Pp 2605Examples: 2606.Bd -literal -offset indent 2607pass out proto tcp from any os OpenBSD 2608block out proto tcp from any os Doors 2609block out proto tcp from any os "Doors PT" 2610block out proto tcp from any os "Doors PT SP3" 2611block out from any os "unknown" 2612pass on lo0 proto tcp from any os "OpenBSD 3.3 lo0" 2613.Ed 2614.Pp 2615Operating system fingerprinting is limited only to the TCP SYN packet. 2616This means that it will not work on other protocols and will not match 2617a currently established connection. 2618.Pp 2619Caveat: operating system fingerprints are occasionally wrong. 2620There are three problems: an attacker can trivially craft his packets to 2621appear as any operating system he chooses; 2622an operating system patch could change the stack behavior and no fingerprints 2623will match it until the database is updated; 2624and multiple operating systems may have the same fingerprint. 2625.Sh BLOCKING SPOOFED TRAFFIC 2626"Spoofing" is the faking of IP addresses, typically for malicious 2627purposes. 2628The 2629.Ar antispoof 2630directive expands to a set of filter rules which will block all 2631traffic with a source IP from the network(s) directly connected 2632to the specified interface(s) from entering the system through 2633any other interface. 2634.Pp 2635For example, the line 2636.Bd -literal -offset indent 2637antispoof for lo0 2638.Ed 2639.Pp 2640expands to 2641.Bd -literal -offset indent 2642block drop in on ! lo0 inet from 127.0.0.1/8 to any 2643block drop in on ! lo0 inet6 from ::1 to any 2644.Ed 2645.Pp 2646For non-loopback interfaces, there are additional rules to block incoming 2647packets with a source IP address identical to the interface's IP(s). 2648For example, assuming the interface wi0 had an IP address of 10.0.0.1 and a 2649netmask of 255.255.255.0, 2650the line 2651.Bd -literal -offset indent 2652antispoof for wi0 inet 2653.Ed 2654.Pp 2655expands to 2656.Bd -literal -offset indent 2657block drop in on ! wi0 inet from 10.0.0.0/24 to any 2658block drop in inet from 10.0.0.1 to any 2659.Ed 2660.Pp 2661Caveat: Rules created by the 2662.Ar antispoof 2663directive interfere with packets sent over loopback interfaces 2664to local addresses. 2665One should pass these explicitly. 2666.Sh FRAGMENT HANDLING 2667The size of IP datagrams (packets) can be significantly larger than the 2668maximum transmission unit (MTU) of the network. 2669In cases when it is necessary or more efficient to send such large packets, 2670the large packet will be fragmented into many smaller packets that will each 2671fit onto the wire. 2672Unfortunately for a firewalling device, only the first logical fragment will 2673contain the necessary header information for the subprotocol that allows 2674.Xr pf 4 2675to filter on things such as TCP ports or to perform NAT. 2676.Pp 2677Besides the use of 2678.Ar set reassemble 2679option or 2680.Ar scrub 2681rules as described in 2682.Sx TRAFFIC NORMALIZATION 2683above, there are three options for handling fragments in the packet filter. 2684.Pp 2685One alternative is to filter individual fragments with filter rules. 2686If no 2687.Ar scrub 2688rule applies to a fragment or 2689.Ar set reassemble 2690is set to 2691.Cm no 2692, it is passed to the filter. 2693Filter rules with matching IP header parameters decide whether the 2694fragment is passed or blocked, in the same way as complete packets 2695are filtered. 2696Without reassembly, fragments can only be filtered based on IP header 2697fields (source/destination address, protocol), since subprotocol header 2698fields are not available (TCP/UDP port numbers, ICMP code/type). 2699The 2700.Ar fragment 2701option can be used to restrict filter rules to apply only to 2702fragments, but not complete packets. 2703Filter rules without the 2704.Ar fragment 2705option still apply to fragments, if they only specify IP header fields. 2706For instance, the rule 2707.Bd -literal -offset indent 2708pass in proto tcp from any to any port 80 2709.Ed 2710.Pp 2711never applies to a fragment, even if the fragment is part of a TCP 2712packet with destination port 80, because without reassembly this information 2713is not available for each fragment. 2714This also means that fragments cannot create new or match existing 2715state table entries, which makes stateful filtering and address 2716translation (NAT, redirection) for fragments impossible. 2717.Pp 2718It's also possible to reassemble only certain fragments by specifying 2719source or destination addresses or protocols as parameters in 2720.Ar scrub 2721rules. 2722.Pp 2723In most cases, the benefits of reassembly outweigh the additional 2724memory cost, and it's recommended to use 2725.Ar set reassemble 2726option or 2727.Ar scrub 2728rules with the 2729.Ar fragment reassemble 2730modifier to reassemble 2731all fragments. 2732.Pp 2733The memory allocated for fragment caching can be limited using 2734.Xr pfctl 8 . 2735Once this limit is reached, fragments that would have to be cached 2736are dropped until other entries time out. 2737The timeout value can also be adjusted. 2738.Pp 2739When forwarding reassembled IPv6 packets, pf refragments them with 2740the original maximum fragment size. 2741This allows the sender to determine the optimal fragment size by 2742path MTU discovery. 2743.Sh ANCHORS 2744Besides the main ruleset, 2745.Xr pfctl 8 2746can load rulesets into 2747.Ar anchor 2748attachment points. 2749An 2750.Ar anchor 2751is a container that can hold rules, address tables, and other anchors. 2752.Pp 2753An 2754.Ar anchor 2755has a name which specifies the path where 2756.Xr pfctl 8 2757can be used to access the anchor to perform operations on it, such as 2758attaching child anchors to it or loading rules into it. 2759Anchors may be nested, with components separated by 2760.Sq / 2761characters, similar to how file system hierarchies are laid out. 2762The main ruleset is actually the default anchor, so filter and 2763translation rules, for example, may also be contained in any anchor. 2764.Pp 2765An anchor can reference another 2766.Ar anchor 2767attachment point 2768using the following kinds 2769of rules: 2770.Bl -tag -width xxxx 2771.It Ar nat-anchor Aq Ar name 2772Evaluates the 2773.Ar nat 2774rules in the specified 2775.Ar anchor . 2776.It Ar rdr-anchor Aq Ar name 2777Evaluates the 2778.Ar rdr 2779rules in the specified 2780.Ar anchor . 2781.It Ar binat-anchor Aq Ar name 2782Evaluates the 2783.Ar binat 2784rules in the specified 2785.Ar anchor . 2786.It Ar anchor Aq Ar name 2787Evaluates the filter rules in the specified 2788.Ar anchor . 2789.It Xo Ar load anchor 2790.Aq Ar name 2791.Ar from Aq Ar file 2792.Xc 2793Loads the rules from the specified file into the 2794anchor 2795.Ar name . 2796.El 2797.Pp 2798When evaluation of the main ruleset reaches an 2799.Ar anchor 2800rule, 2801.Xr pf 4 2802will proceed to evaluate all rules specified in that anchor. 2803.Pp 2804Matching filter and translation rules marked with the 2805.Ar quick 2806option are final and abort the evaluation of the rules in other 2807anchors and the main ruleset. 2808If the 2809.Ar anchor 2810itself is marked with the 2811.Ar quick 2812option, 2813ruleset evaluation will terminate when the anchor is exited if the packet is 2814matched by any rule within the anchor. 2815.Pp 2816.Ar anchor 2817rules are evaluated relative to the anchor in which they are contained. 2818For example, all 2819.Ar anchor 2820rules specified in the main ruleset will reference anchor 2821attachment points underneath the main ruleset, and 2822.Ar anchor 2823rules specified in a file loaded from a 2824.Ar load anchor 2825rule will be attached under that anchor point. 2826.Pp 2827Rules may be contained in 2828.Ar anchor 2829attachment points which do not contain any rules when the main ruleset 2830is loaded, and later such anchors can be manipulated through 2831.Xr pfctl 8 2832without reloading the main ruleset or other anchors. 2833For example, 2834.Bd -literal -offset indent 2835ext_if = \&"kue0\&" 2836block on $ext_if all 2837anchor spam 2838pass out on $ext_if all 2839pass in on $ext_if proto tcp from any \e 2840 to $ext_if port smtp 2841.Ed 2842.Pp 2843blocks all packets on the external interface by default, then evaluates 2844all rules in the 2845.Ar anchor 2846named "spam", and finally passes all outgoing connections and 2847incoming connections to port 25. 2848.Bd -literal -offset indent 2849# echo \&"block in quick from 1.2.3.4 to any\&" \&| \e 2850 pfctl -a spam -f - 2851.Ed 2852.Pp 2853This loads a single rule into the 2854.Ar anchor , 2855which blocks all packets from a specific address. 2856.Pp 2857The anchor can also be populated by adding a 2858.Ar load anchor 2859rule after the 2860.Ar anchor 2861rule: 2862.Bd -literal -offset indent 2863anchor spam 2864load anchor spam from "/etc/pf-spam.conf" 2865.Ed 2866.Pp 2867When 2868.Xr pfctl 8 2869loads 2870.Nm pf.conf , 2871it will also load all the rules from the file 2872.Pa /etc/pf-spam.conf 2873into the anchor. 2874.Pp 2875Optionally, 2876.Ar anchor 2877rules can specify packet filtering parameters using the same syntax as 2878filter rules. 2879When parameters are used, the 2880.Ar anchor 2881rule is only evaluated for matching packets. 2882This allows conditional evaluation of anchors, like: 2883.Bd -literal -offset indent 2884block on $ext_if all 2885anchor spam proto tcp from any to any port smtp 2886pass out on $ext_if all 2887pass in on $ext_if proto tcp from any to $ext_if port smtp 2888.Ed 2889.Pp 2890The rules inside 2891.Ar anchor 2892spam are only evaluated for 2893.Ar tcp 2894packets with destination port 25. 2895Hence, 2896.Bd -literal -offset indent 2897# echo \&"block in quick from 1.2.3.4 to any" \&| \e 2898 pfctl -a spam -f - 2899.Ed 2900.Pp 2901will only block connections from 1.2.3.4 to port 25. 2902.Pp 2903Anchors may end with the asterisk 2904.Pq Sq * 2905character, which signifies that all anchors attached at that point 2906should be evaluated in the alphabetical ordering of their anchor name. 2907For example, 2908.Bd -literal -offset indent 2909anchor "spam/*" 2910.Ed 2911.Pp 2912will evaluate each rule in each anchor attached to the 2913.Li spam 2914anchor. 2915Note that it will only evaluate anchors that are directly attached to the 2916.Li spam 2917anchor, and will not descend to evaluate anchors recursively. 2918.Pp 2919Since anchors are evaluated relative to the anchor in which they are 2920contained, there is a mechanism for accessing the parent and ancestor 2921anchors of a given anchor. 2922Similar to file system path name resolution, if the sequence 2923.Dq .. 2924appears as an anchor path component, the parent anchor of the current 2925anchor in the path evaluation at that point will become the new current 2926anchor. 2927As an example, consider the following: 2928.Bd -literal -offset indent 2929# echo ' anchor "spam/allowed" ' | pfctl -f - 2930# echo -e ' anchor "../banned" \en pass' | \e 2931 pfctl -a spam/allowed -f - 2932.Ed 2933.Pp 2934Evaluation of the main ruleset will lead into the 2935.Li spam/allowed 2936anchor, which will evaluate the rules in the 2937.Li spam/banned 2938anchor, if any, before finally evaluating the 2939.Ar pass 2940rule. 2941.Pp 2942Filter rule 2943.Ar anchors 2944can also be loaded inline in the ruleset within a brace ('{' '}') delimited 2945block. 2946Brace delimited blocks may contain rules or other brace-delimited blocks. 2947When anchors are loaded this way the anchor name becomes optional. 2948.Bd -literal -offset indent 2949anchor "external" on $ext_if { 2950 block 2951 anchor out { 2952 pass proto tcp from any to port { 25, 80, 443 } 2953 } 2954 pass in proto tcp to any port 22 2955} 2956.Ed 2957.Pp 2958Since the parser specification for anchor names is a string, any 2959reference to an anchor name containing 2960.Sq / 2961characters will require double quote 2962.Pq Sq \&" 2963characters around the anchor name. 2964.Sh SCTP CONSIDERATIONS 2965.Xr pf 4 2966supports 2967.Xr sctp 4 2968connections. 2969It can match ports, track state and NAT SCTP traffic. 2970However, it will not alter port numbers during nat or rdr translations. 2971Doing so would break SCTP multihoming. 2972.Sh TRANSLATION EXAMPLES 2973This example maps incoming requests on port 80 to port 8080, on 2974which a daemon is running (because, for example, it is not run as root, 2975and therefore lacks permission to bind to port 80). 2976.Bd -literal 2977# use a macro for the interface name, so it can be changed easily 2978ext_if = \&"ne3\&" 2979 2980# map daemon on 8080 to appear to be on 80 2981rdr on $ext_if proto tcp from any to any port 80 -\*(Gt 127.0.0.1 port 8080 2982.Ed 2983.Pp 2984If the 2985.Ar pass 2986modifier is given, packets matching the translation rule are passed without 2987inspecting the filter rules: 2988.Bd -literal 2989rdr pass on $ext_if proto tcp from any to any port 80 -\*(Gt 127.0.0.1 \e 2990 port 8080 2991.Ed 2992.Pp 2993In the example below, vlan12 is configured as 192.168.168.1; 2994the machine translates all packets coming from 192.168.168.0/24 to 204.92.77.111 2995when they are going out any interface except vlan12. 2996This has the net effect of making traffic from the 192.168.168.0/24 2997network appear as though it is the Internet routable address 2998204.92.77.111 to nodes behind any interface on the router except 2999for the nodes on vlan12. 3000(Thus, 192.168.168.1 can talk to the 192.168.168.0/24 nodes.) 3001.Bd -literal 3002nat on ! vlan12 from 192.168.168.0/24 to any -\*(Gt 204.92.77.111 3003.Ed 3004.Pp 3005In the example below, the machine sits between a fake internal 144.19.74.* 3006network, and a routable external IP of 204.92.77.100. 3007The 3008.Ar no nat 3009rule excludes protocol AH from being translated. 3010.Bd -literal 3011# NO NAT 3012no nat on $ext_if proto ah from 144.19.74.0/24 to any 3013nat on $ext_if from 144.19.74.0/24 to any -\*(Gt 204.92.77.100 3014.Ed 3015.Pp 3016In the example below, packets bound for one specific server, as well as those 3017generated by the sysadmins are not proxied; all other connections are. 3018.Bd -literal 3019# NO RDR 3020no rdr on $int_if proto { tcp, udp } from any to $server port 80 3021no rdr on $int_if proto { tcp, udp } from $sysadmins to any port 80 3022rdr on $int_if proto { tcp, udp } from any to any port 80 -\*(Gt 127.0.0.1 \e 3023 port 80 3024.Ed 3025.Pp 3026This longer example uses both a NAT and a redirection. 3027The external interface has the address 157.161.48.183. 3028On localhost, we are running 3029.Xr ftp-proxy 8 , 3030waiting for FTP sessions to be redirected to it. 3031The three mandatory anchors for 3032.Xr ftp-proxy 8 3033are omitted from this example; see the 3034.Xr ftp-proxy 8 3035manpage. 3036.Bd -literal 3037# NAT 3038# Translate outgoing packets' source addresses (any protocol). 3039# In this case, any address but the gateway's external address is mapped. 3040nat on $ext_if inet from ! ($ext_if) to any -\*(Gt ($ext_if) 3041 3042# NAT PROXYING 3043# Map outgoing packets' source port to an assigned proxy port instead of 3044# an arbitrary port. 3045# In this case, proxy outgoing isakmp with port 500 on the gateway. 3046nat on $ext_if inet proto udp from any port = isakmp to any -\*(Gt ($ext_if) \e 3047 port 500 3048 3049# BINAT 3050# Translate outgoing packets' source address (any protocol). 3051# Translate incoming packets' destination address to an internal machine 3052# (bidirectional). 3053binat on $ext_if from 10.1.2.150 to any -\*(Gt $ext_if 3054 3055# Translate packets arriving on $peer_if addressed to 172.22.16.0/20 3056# to the corresponding address in 172.21.16.0/20 (bidirectional). 3057binat on $peer_if from 172.21.16.0/20 to any -> 172.22.16.0/20 3058 3059# RDR 3060# Translate incoming packets' destination addresses. 3061# As an example, redirect a TCP and UDP port to an internal machine. 3062rdr on $ext_if inet proto tcp from any to ($ext_if) port 8080 \e 3063 -\*(Gt 10.1.2.151 port 22 3064rdr on $ext_if inet proto udp from any to ($ext_if) port 8080 \e 3065 -\*(Gt 10.1.2.151 port 53 3066 3067# RDR 3068# Translate outgoing ftp control connections to send them to localhost 3069# for proxying with ftp-proxy(8) running on port 8021. 3070rdr on $int_if proto tcp from any to any port 21 -\*(Gt 127.0.0.1 port 8021 3071.Ed 3072.Pp 3073In this example, a NAT gateway is set up to translate internal addresses 3074using a pool of public addresses (192.0.2.16/28) and to redirect 3075incoming web server connections to a group of web servers on the internal 3076network. 3077.Bd -literal 3078# NAT LOAD BALANCE 3079# Translate outgoing packets' source addresses using an address pool. 3080# A given source address is always translated to the same pool address by 3081# using the source-hash keyword. 3082nat on $ext_if inet from any to any -\*(Gt 192.0.2.16/28 source-hash 3083 3084# RDR ROUND ROBIN 3085# Translate incoming web server connections to a group of web servers on 3086# the internal network. 3087rdr on $ext_if proto tcp from any to any port 80 \e 3088 -\*(Gt { 10.1.2.155, 10.1.2.160, 10.1.2.161 } round-robin 3089.Ed 3090.Sh FILTER EXAMPLES 3091.Bd -literal 3092# The external interface is kue0 3093# (157.161.48.183, the only routable address) 3094# and the private network is 10.0.0.0/8, for which we are doing NAT. 3095 3096# Reassemble incoming traffic 3097set reassemble yes 3098 3099# use a macro for the interface name, so it can be changed easily 3100ext_if = \&"kue0\&" 3101 3102# block and log everything by default 3103block return log on $ext_if all 3104 3105# block anything coming from source we have no back routes for 3106block in from no-route to any 3107 3108# block packets whose ingress interface does not match the one in 3109# the route back to their source address 3110block in from urpf-failed to any 3111 3112# block and log outgoing packets that do not have our address as source, 3113# they are either spoofed or something is misconfigured (NAT disabled, 3114# for instance), we want to be nice and do not send out garbage. 3115block out log quick on $ext_if from ! 157.161.48.183 to any 3116 3117# silently drop broadcasts (cable modem noise) 3118block in quick on $ext_if from any to 255.255.255.255 3119 3120# block and log incoming packets from reserved address space and invalid 3121# addresses, they are either spoofed or misconfigured, we cannot reply to 3122# them anyway (hence, no return-rst). 3123block in log quick on $ext_if from { 10.0.0.0/8, 172.16.0.0/12, \e 3124 192.168.0.0/16, 255.255.255.255/32 } to any 3125 3126# ICMP 3127 3128# pass out/in certain ICMP queries and keep state (ping) 3129# state matching is done on host addresses and ICMP id (not type/code), 3130# so replies (like 0/0 for 8/0) will match queries 3131# ICMP error messages (which always refer to a TCP/UDP packet) are 3132# handled by the TCP/UDP states 3133pass on $ext_if inet proto icmp all icmp-type 8 code 0 3134 3135# UDP 3136 3137# pass out all UDP connections and keep state 3138pass out on $ext_if proto udp all 3139 3140# pass in certain UDP connections and keep state (DNS) 3141pass in on $ext_if proto udp from any to any port domain 3142 3143# TCP 3144 3145# pass out all TCP connections and modulate state 3146pass out on $ext_if proto tcp all modulate state 3147 3148# pass in certain TCP connections and keep state (SSH, SMTP, DNS, IDENT) 3149pass in on $ext_if proto tcp from any to any port { ssh, smtp, domain, \e 3150 auth } 3151 3152# Do not allow Windows 9x SMTP connections since they are typically 3153# a viral worm. Alternately we could limit these OSes to 1 connection each. 3154block in on $ext_if proto tcp from any os {"Windows 95", "Windows 98"} \e 3155 to any port smtp 3156 3157# IPv6 3158# pass in/out all IPv6 traffic: note that we have to enable this in two 3159# different ways, on both our physical interface and our tunnel 3160pass quick on gif0 inet6 3161pass quick on $ext_if proto ipv6 3162 3163# Packet Tagging 3164 3165# three interfaces: $int_if, $ext_if, and $wifi_if (wireless). NAT is 3166# being done on $ext_if for all outgoing packets. tag packets in on 3167# $int_if and pass those tagged packets out on $ext_if. all other 3168# outgoing packets (i.e., packets from the wireless network) are only 3169# permitted to access port 80. 3170 3171pass in on $int_if from any to any tag INTNET 3172pass in on $wifi_if from any to any 3173 3174block out on $ext_if from any to any 3175pass out quick on $ext_if tagged INTNET 3176pass out on $ext_if proto tcp from any to any port 80 3177 3178# tag incoming packets as they are redirected to spamd(8). use the tag 3179# to pass those packets through the packet filter. 3180 3181rdr on $ext_if inet proto tcp from \*(Ltspammers\*(Gt to port smtp \e 3182 tag SPAMD -\*(Gt 127.0.0.1 port spamd 3183 3184block in on $ext_if 3185pass in on $ext_if inet proto tcp tagged SPAMD 3186.Ed 3187.Sh GRAMMAR 3188Syntax for 3189.Nm 3190in BNF: 3191.Bd -literal 3192line = ( option | ether-rule | pf-rule | nat-rule | binat-rule | 3193 rdr-rule | antispoof-rule | altq-rule | queue-rule | 3194 trans-anchors | anchor-rule | anchor-close | load-anchor | 3195 table-rule | include ) 3196 3197option = "set" ( [ "timeout" ( timeout | "{" timeout-list "}" ) ] | 3198 [ "ruleset-optimization" [ "none" | "basic" | "profile" ]] | 3199 [ "optimization" [ "default" | "normal" | 3200 "high-latency" | "satellite" | 3201 "aggressive" | "conservative" ] ] 3202 [ "limit" ( limit-item | "{" limit-list "}" ) ] | 3203 [ "loginterface" ( interface-name | "none" ) ] | 3204 [ "block-policy" ( "drop" | "return" ) ] | 3205 [ "state-policy" ( "if-bound" | "floating" ) ] 3206 [ "state-defaults" state-opts ] 3207 [ "require-order" ( "yes" | "no" ) ] 3208 [ "fingerprints" filename ] | 3209 [ "skip on" ifspec ] | 3210 [ "debug" ( "none" | "urgent" | "misc" | "loud" ) ] 3211 [ "keepcounters" ] ) 3212 3213ether-rule = "ether" etheraction [ ( "in" | "out" ) ] 3214 [ "quick" ] [ "on" ifspec ] [ "bridge-to" interface-name ] 3215 [ etherprotospec ] etherhosts [ "l3" hosts ] 3216 [ etherfilteropt-list ] 3217 3218pf-rule = action [ ( "in" | "out" ) ] 3219 [ "log" [ "(" logopts ")"] ] [ "quick" ] 3220 [ "on" ifspec ] [ route ] [ af ] [ protospec ] 3221 hosts [ filteropt-list ] 3222 3223logopts = logopt [ "," logopts ] 3224logopt = "all" | "matches" | "user" | "to" interface-name 3225 3226etherfilteropt-list = etherfilteropt-list etherfilteropt | etherfilteropt 3227etherfilteropt = "tag" string | "tagged" string | "queue" ( string ) | 3228 "ridentifier" number | "label" string 3229 3230filteropt-list = filteropt-list filteropt | filteropt 3231filteropt = user | group | flags | icmp-type | icmp6-type | "tos" tos | 3232 ( "no" | "keep" | "modulate" | "synproxy" ) "state" 3233 [ "(" state-opts ")" ] | 3234 "fragment" | "no-df" | "min-ttl" number | "set-tos" tos | 3235 "max-mss" number | "random-id" | "reassemble tcp" | 3236 fragmentation | "allow-opts" | 3237 "label" string | "tag" string | [ ! ] "tagged" string | 3238 "set prio" ( number | "(" number [ [ "," ] number ] ")" ) | 3239 "queue" ( string | "(" string [ [ "," ] string ] ")" ) | 3240 "rtable" number | "probability" number"%" | "prio" number | 3241 "dnpipe" ( number | "(" number "," number ")" ) | 3242 "dnqueue" ( number | "(" number "," number ")" ) | 3243 "ridentifier" number | 3244 "received-on" ( interface-name | interface-group ) 3245 3246nat-rule = [ "no" ] "nat" [ "pass" [ "log" [ "(" logopts ")" ] ] ] 3247 [ "on" ifspec ] [ af ] 3248 [ protospec ] hosts [ "tag" string ] [ "tagged" string ] 3249 [ "-\*(Gt" ( redirhost | "{" redirhost-list "}" ) 3250 [ portspec ] [ pooltype ] [ "static-port" ] 3251 [ "map-e-portset" number "/" number "/" number ] ] 3252 3253binat-rule = [ "no" ] "binat" [ "pass" [ "log" [ "(" logopts ")" ] ] ] 3254 [ "on" interface-name ] [ af ] 3255 [ "proto" ( proto-name | proto-number ) ] 3256 "from" address [ "/" mask-bits ] "to" ipspec 3257 [ "tag" string ] [ "tagged" string ] 3258 [ "-\*(Gt" address [ "/" mask-bits ] ] 3259 3260rdr-rule = [ "no" ] "rdr" [ "pass" [ "log" [ "(" logopts ")" ] ] ] 3261 [ "on" ifspec ] [ af ] 3262 [ protospec ] hosts [ "tag" string ] [ "tagged" string ] 3263 [ "-\*(Gt" ( redirhost | "{" redirhost-list "}" ) 3264 [ portspec ] [ pooltype ] ] 3265 3266antispoof-rule = "antispoof" [ "log" ] [ "quick" ] 3267 "for" ifspec [ af ] [ "label" string ] 3268 [ "ridentifier" number ] 3269 3270table-rule = "table" "\*(Lt" string "\*(Gt" [ tableopts-list ] 3271tableopts-list = tableopts-list tableopts | tableopts 3272tableopts = "persist" | "const" | "counters" | "file" string | 3273 "{" [ tableaddr-list ] "}" 3274tableaddr-list = tableaddr-list [ "," ] tableaddr-spec | tableaddr-spec 3275tableaddr-spec = [ "!" ] tableaddr [ "/" mask-bits ] 3276tableaddr = hostname | ifspec | "self" | 3277 ipv4-dotted-quad | ipv6-coloned-hex 3278 3279altq-rule = "altq on" interface-name queueopts-list 3280 "queue" subqueue 3281queue-rule = "queue" string [ "on" interface-name ] queueopts-list 3282 subqueue 3283 3284anchor-rule = "anchor" [ string ] [ ( "in" | "out" ) ] [ "on" ifspec ] 3285 [ af ] [ protospec ] [ hosts ] [ filteropt-list ] [ "{" ] 3286 3287anchor-close = "}" 3288 3289trans-anchors = ( "nat-anchor" | "rdr-anchor" | "binat-anchor" ) string 3290 [ "on" ifspec ] [ af ] [ "proto" ] [ protospec ] [ hosts ] 3291 3292load-anchor = "load anchor" string "from" filename 3293 3294queueopts-list = queueopts-list queueopts | queueopts 3295queueopts = [ "bandwidth" bandwidth-spec ] | 3296 [ "qlimit" number ] | [ "tbrsize" number ] | 3297 [ "priority" number ] | [ schedulers ] 3298schedulers = ( cbq-def | priq-def | hfsc-def ) 3299bandwidth-spec = "number" ( "b" | "Kb" | "Mb" | "Gb" | "%" ) 3300 3301etheraction = "pass" | "block" 3302action = "pass" | "match" | "block" [ return ] | [ "no" ] "scrub" 3303return = "drop" | "return" | "return-rst" [ "( ttl" number ")" ] | 3304 "return-icmp" [ "(" icmpcode [ [ "," ] icmp6code ] ")" ] | 3305 "return-icmp6" [ "(" icmp6code ")" ] 3306icmpcode = ( icmp-code-name | icmp-code-number ) 3307icmp6code = ( icmp6-code-name | icmp6-code-number ) 3308 3309ifspec = ( [ "!" ] ( interface-name | interface-group ) ) | 3310 "{" interface-list "}" 3311interface-list = [ "!" ] ( interface-name | interface-group ) 3312 [ [ "," ] interface-list ] 3313route = ( "route-to" | "reply-to" | "dup-to" ) 3314 ( routehost | "{" routehost-list "}" ) 3315 [ pooltype ] 3316af = "inet" | "inet6" 3317 3318etherprotospec = "proto" ( proto-number | "{" etherproto-list "}" ) 3319etherproto-list = proto-number [ [ "," ] etherproto-list ] 3320protospec = "proto" ( proto-name | proto-number | 3321 "{" proto-list "}" ) 3322proto-list = ( proto-name | proto-number ) [ [ "," ] proto-list ] 3323 3324etherhosts = "from" macaddress "to" macaddress 3325macaddress = mac | mac "/" masklen | mac "&" mask 3326 3327hosts = "all" | 3328 "from" ( "any" | "no-route" | "urpf-failed" | "self" | host | 3329 "{" host-list "}" ) [ port ] [ os ] 3330 "to" ( "any" | "no-route" | "self" | host | 3331 "{" host-list "}" ) [ port ] 3332 3333ipspec = "any" | host | "{" host-list "}" 3334host = [ "!" ] ( address [ "/" mask-bits ] | "\*(Lt" string "\*(Gt" ) 3335redirhost = address [ "/" mask-bits ] 3336routehost = "(" interface-name [ address [ "/" mask-bits ] ] ")" 3337address = ( interface-name | interface-group | 3338 "(" ( interface-name | interface-group ) ")" | 3339 hostname | ipv4-dotted-quad | ipv6-coloned-hex ) 3340host-list = host [ [ "," ] host-list ] 3341redirhost-list = redirhost [ [ "," ] redirhost-list ] 3342routehost-list = routehost [ [ "," ] routehost-list ] 3343 3344port = "port" ( unary-op | binary-op | "{" op-list "}" ) 3345portspec = "port" ( number | name ) [ ":" ( "*" | number | name ) ] 3346os = "os" ( os-name | "{" os-list "}" ) 3347user = "user" ( unary-op | binary-op | "{" op-list "}" ) 3348group = "group" ( unary-op | binary-op | "{" op-list "}" ) 3349 3350unary-op = [ "=" | "!=" | "\*(Lt" | "\*(Le" | "\*(Gt" | "\*(Ge" ] 3351 ( name | number ) 3352binary-op = number ( "\*(Lt\*(Gt" | "\*(Gt\*(Lt" | ":" ) number 3353op-list = ( unary-op | binary-op ) [ [ "," ] op-list ] 3354 3355os-name = operating-system-name 3356os-list = os-name [ [ "," ] os-list ] 3357 3358flags = "flags" ( [ flag-set ] "/" flag-set | "any" ) 3359flag-set = [ "F" ] [ "S" ] [ "R" ] [ "P" ] [ "A" ] [ "U" ] [ "E" ] 3360 [ "W" ] 3361 3362icmp-type = "icmp-type" ( icmp-type-code | "{" icmp-list "}" ) 3363icmp6-type = "icmp6-type" ( icmp-type-code | "{" icmp-list "}" ) 3364icmp-type-code = ( icmp-type-name | icmp-type-number ) 3365 [ "code" ( icmp-code-name | icmp-code-number ) ] 3366icmp-list = icmp-type-code [ [ "," ] icmp-list ] 3367 3368tos = ( "lowdelay" | "throughput" | "reliability" | 3369 [ "0x" ] number ) 3370 3371state-opts = state-opt [ [ "," ] state-opts ] 3372state-opt = ( "max" number | "no-sync" | timeout | "sloppy" | 3373 "source-track" [ ( "rule" | "global" ) ] | 3374 "max-src-nodes" number | "max-src-states" number | 3375 "max-src-conn" number | 3376 "max-src-conn-rate" number "/" number | 3377 "overload" "\*(Lt" string "\*(Gt" [ "flush" ] | 3378 "if-bound" | "floating" | "pflow" ) 3379 3380fragmentation = [ "fragment reassemble" ] 3381 3382timeout-list = timeout [ [ "," ] timeout-list ] 3383timeout = ( "tcp.first" | "tcp.opening" | "tcp.established" | 3384 "tcp.closing" | "tcp.finwait" | "tcp.closed" | 3385 "sctp.first" | "sctp.opening" | "sctp.established" | 3386 "sctp.closing" | "sctp.closed" | 3387 "udp.first" | "udp.single" | "udp.multiple" | 3388 "icmp.first" | "icmp.error" | 3389 "other.first" | "other.single" | "other.multiple" | 3390 "frag" | "interval" | "src.track" | 3391 "adaptive.start" | "adaptive.end" ) number 3392 3393limit-list = limit-item [ [ "," ] limit-list ] 3394limit-item = ( "states" | "frags" | "src-nodes" ) number 3395 3396pooltype = ( "bitmask" | "random" | 3397 "source-hash" [ ( hex-key | string-key ) ] | 3398 "round-robin" ) [ sticky-address ] 3399 3400subqueue = string | "{" queue-list "}" 3401queue-list = string [ [ "," ] string ] 3402cbq-def = "cbq" [ "(" cbq-opt [ [ "," ] cbq-opt ] ")" ] 3403priq-def = "priq" [ "(" priq-opt [ [ "," ] priq-opt ] ")" ] 3404hfsc-def = "hfsc" [ "(" hfsc-opt [ [ "," ] hfsc-opt ] ")" ] 3405cbq-opt = ( "default" | "borrow" | "red" | "ecn" | "rio" ) 3406priq-opt = ( "default" | "red" | "ecn" | "rio" ) 3407hfsc-opt = ( "default" | "red" | "ecn" | "rio" | 3408 linkshare-sc | realtime-sc | upperlimit-sc ) 3409linkshare-sc = "linkshare" sc-spec 3410realtime-sc = "realtime" sc-spec 3411upperlimit-sc = "upperlimit" sc-spec 3412sc-spec = ( bandwidth-spec | 3413 "(" bandwidth-spec number bandwidth-spec ")" ) 3414include = "include" filename 3415.Ed 3416.Sh FILES 3417.Bl -tag -width "/etc/protocols" -compact 3418.It Pa /etc/hosts 3419Host name database. 3420.It Pa /etc/pf.conf 3421Default location of the ruleset file. 3422The file has to be created manually as it is not installed with a 3423standard installation. 3424.It Pa /etc/pf.os 3425Default location of OS fingerprints. 3426.It Pa /etc/protocols 3427Protocol name database. 3428.It Pa /etc/services 3429Service name database. 3430.El 3431.Sh SEE ALSO 3432.Xr altq 4 , 3433.Xr carp 4 , 3434.Xr icmp 4 , 3435.Xr icmp6 4 , 3436.Xr ip 4 , 3437.Xr ip6 4 , 3438.Xr pf 4 , 3439.Xr pflow 4 , 3440.Xr pfsync 4 , 3441.Xr sctp 4 , 3442.Xr tcp 4 , 3443.Xr udp 4 , 3444.Xr hosts 5 , 3445.Xr pf.os 5 , 3446.Xr protocols 5 , 3447.Xr services 5 , 3448.Xr ftp-proxy 8 , 3449.Xr pfctl 8 , 3450.Xr pflogd 8 3451.Sh HISTORY 3452The 3453.Nm 3454file format first appeared in 3455.Ox 3.0 . 3456