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 September 6, 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 (user) 1688Logs the 1689.Ux 1690user ID of the user that owns the socket and the PID of the process that 1691has the socket open where the packet is sourced from or destined to 1692(depending on which socket is local). 1693This is in addition to the normal information logged. 1694.Pp 1695Only the first packet 1696logged via 1697.Ar log (all, user) 1698will have the user credentials logged when using stateful matching. 1699.It Ar log (to Aq Ar interface ) 1700Send logs to the specified 1701.Xr pflog 4 1702interface instead of 1703.Ar pflog0 . 1704.It Ar quick 1705If a packet matches a rule which has the 1706.Ar quick 1707option set, this rule 1708is considered the last matching rule, and evaluation of subsequent rules 1709is skipped. 1710.It Ar on Aq Ar interface 1711This rule applies only to packets coming in on, or going out through, this 1712particular interface or interface group. 1713For more information on interface groups, 1714see the 1715.Ic group 1716keyword in 1717.Xr ifconfig 8 . 1718.It Aq Ar af 1719This rule applies only to packets of this address family. 1720Supported values are 1721.Ar inet 1722and 1723.Ar inet6 . 1724.It Ar proto Aq Ar protocol 1725This rule applies only to packets of this protocol. 1726Common protocols are 1727.Xr icmp 4 , 1728.Xr icmp6 4 , 1729.Xr tcp 4 , 1730.Xr sctp 4 , 1731and 1732.Xr udp 4 . 1733For a list of all the protocol name to number mappings used by 1734.Xr pfctl 8 , 1735see the file 1736.Pa /etc/protocols . 1737.It Xo 1738.Ar from Aq Ar source 1739.Ar port Aq Ar source 1740.Ar os Aq Ar source 1741.Ar to Aq Ar dest 1742.Ar port Aq Ar dest 1743.Xc 1744This rule applies only to packets with the specified source and destination 1745addresses and ports. 1746.Pp 1747Addresses can be specified in CIDR notation (matching netblocks), as 1748symbolic host names, interface names or interface group names, or as any 1749of the following keywords: 1750.Pp 1751.Bl -tag -width xxxxxxxxxxxxxx -compact 1752.It Ar any 1753Any address. 1754.It Ar no-route 1755Any address which is not currently routable. 1756.It Ar urpf-failed 1757Any source address that fails a unicast reverse path forwarding (URPF) 1758check, i.e. packets coming in on an interface other than that which holds 1759the route back to the packet's source address. 1760.It Aq Ar table 1761Any address that matches the given table. 1762.El 1763.Pp 1764Ranges of addresses are specified by using the 1765.Sq - 1766operator. 1767For instance: 1768.Dq 10.1.1.10 - 10.1.1.12 1769means all addresses from 10.1.1.10 to 10.1.1.12, 1770hence addresses 10.1.1.10, 10.1.1.11, and 10.1.1.12. 1771.Pp 1772Interface names and interface group names can have modifiers appended: 1773.Pp 1774.Bl -tag -width xxxxxxxxxxxx -compact 1775.It Ar :network 1776Translates to the network(s) attached to the interface. 1777.It Ar :broadcast 1778Translates to the interface's broadcast address(es). 1779.It Ar :peer 1780Translates to the point-to-point interface's peer address(es). 1781.It Ar :0 1782Do not include interface aliases. 1783.El 1784.Pp 1785Host names may also have the 1786.Ar :0 1787option appended to restrict the name resolution to the first of each 1788v4 and non-link-local v6 address found. 1789.Pp 1790Host name resolution and interface to address translation are done at 1791ruleset load-time. 1792When the address of an interface (or host name) changes (under DHCP or PPP, 1793for instance), the ruleset must be reloaded for the change to be reflected 1794in the kernel. 1795Surrounding the interface name (and optional modifiers) in parentheses 1796changes this behaviour. 1797When the interface name is surrounded by parentheses, the rule is 1798automatically updated whenever the interface changes its address. 1799The ruleset does not need to be reloaded. 1800This is especially useful with 1801.Ar nat . 1802.Pp 1803Ports can be specified either by number or by name. 1804For example, port 80 can be specified as 1805.Em www . 1806For a list of all port name to number mappings used by 1807.Xr pfctl 8 , 1808see the file 1809.Pa /etc/services . 1810.Pp 1811Ports and ranges of ports are specified by using these operators: 1812.Bd -literal -offset indent 1813= (equal) 1814!= (unequal) 1815\*(Lt (less than) 1816\*(Le (less than or equal) 1817\*(Gt (greater than) 1818\*(Ge (greater than or equal) 1819: (range including boundaries) 1820\*(Gt\*(Lt (range excluding boundaries) 1821\*(Lt\*(Gt (except range) 1822.Ed 1823.Pp 1824.Sq \*(Gt\*(Lt , 1825.Sq \*(Lt\*(Gt 1826and 1827.Sq \&: 1828are binary operators (they take two arguments). 1829For instance: 1830.Bl -tag -width Fl 1831.It Ar port 2000:2004 1832means 1833.Sq all ports \*(Ge 2000 and \*(Le 2004 , 1834hence ports 2000, 2001, 2002, 2003 and 2004. 1835.It Ar port 2000 \*(Gt\*(Lt 2004 1836means 1837.Sq all ports \*(Gt 2000 and \*(Lt 2004 , 1838hence ports 2001, 2002 and 2003. 1839.It Ar port 2000 \*(Lt\*(Gt 2004 1840means 1841.Sq all ports \*(Lt 2000 or \*(Gt 2004 , 1842hence ports 1-1999 and 2005-65535. 1843.El 1844.Pp 1845The operating system of the source host can be specified in the case of TCP 1846rules with the 1847.Ar OS 1848modifier. 1849See the 1850.Sx OPERATING SYSTEM FINGERPRINTING 1851section for more information. 1852.Pp 1853The host, port and OS specifications are optional, as in the following examples: 1854.Bd -literal -offset indent 1855pass in all 1856pass in from any to any 1857pass in proto tcp from any port \*(Le 1024 to any 1858pass in proto tcp from any to any port 25 1859pass in proto tcp from 10.0.0.0/8 port \*(Gt 1024 \e 1860 to ! 10.1.2.3 port != ssh 1861pass in proto tcp from any os "OpenBSD" 1862.Ed 1863.It Ar all 1864This is equivalent to "from any to any". 1865.It Ar group Aq Ar group 1866Similar to 1867.Ar user , 1868this rule only applies to packets of sockets owned by the specified group. 1869.It Ar user Aq Ar user 1870This rule only applies to packets of sockets owned by the specified user. 1871For outgoing connections initiated from the firewall, this is the user 1872that opened the connection. 1873For incoming connections to the firewall itself, this is the user that 1874listens on the destination port. 1875For forwarded connections, where the firewall is not a connection endpoint, 1876the user and group are 1877.Em unknown . 1878.Pp 1879All packets, both outgoing and incoming, of one connection are associated 1880with the same user and group. 1881Only TCP and UDP packets can be associated with users; for other protocols 1882these parameters are ignored. 1883.Pp 1884User and group refer to the effective (as opposed to the real) IDs, in 1885case the socket is created by a setuid/setgid process. 1886User and group IDs are stored when a socket is created; 1887when a process creates a listening socket as root (for instance, by 1888binding to a privileged port) and subsequently changes to another 1889user ID (to drop privileges), the credentials will remain root. 1890.Pp 1891User and group IDs can be specified as either numbers or names. 1892The syntax is similar to the one for ports. 1893The value 1894.Em unknown 1895matches packets of forwarded connections. 1896.Em unknown 1897can only be used with the operators 1898.Cm = 1899and 1900.Cm != . 1901Other constructs like 1902.Cm user \*(Ge unknown 1903are invalid. 1904Forwarded packets with unknown user and group ID match only rules 1905that explicitly compare against 1906.Em unknown 1907with the operators 1908.Cm = 1909or 1910.Cm != . 1911For instance 1912.Cm user \*(Ge 0 1913does not match forwarded packets. 1914The following example allows only selected users to open outgoing 1915connections: 1916.Bd -literal -offset indent 1917block out proto { tcp, udp } all 1918pass out proto { tcp, udp } all user { \*(Lt 1000, dhartmei } 1919.Ed 1920.It Xo Ar flags Aq Ar a 1921.Pf / Ns Aq Ar b 1922.No \*(Ba / Ns Aq Ar b 1923.No \*(Ba any 1924.Xc 1925This rule only applies to TCP packets that have the flags 1926.Aq Ar a 1927set out of set 1928.Aq Ar b . 1929Flags not specified in 1930.Aq Ar b 1931are ignored. 1932For stateful connections, the default is 1933.Ar flags S/SA . 1934To indicate that flags should not be checked at all, specify 1935.Ar flags any . 1936The flags are: (F)IN, (S)YN, (R)ST, (P)USH, (A)CK, (U)RG, (E)CE, and C(W)R. 1937.Bl -tag -width Fl 1938.It Ar flags S/S 1939Flag SYN is set. 1940The other flags are ignored. 1941.It Ar flags S/SA 1942This is the default setting for stateful connections. 1943Out of SYN and ACK, exactly SYN may be set. 1944SYN, SYN+PSH and SYN+RST match, but SYN+ACK, ACK and ACK+RST do not. 1945This is more restrictive than the previous example. 1946.It Ar flags /SFRA 1947If the first set is not specified, it defaults to none. 1948All of SYN, FIN, RST and ACK must be unset. 1949.El 1950.Pp 1951Because 1952.Ar flags S/SA 1953is applied by default (unless 1954.Ar no state 1955is specified), only the initial SYN packet of a TCP handshake will create 1956a state for a TCP connection. 1957It is possible to be less restrictive, and allow state creation from 1958intermediate 1959.Pq non-SYN 1960packets, by specifying 1961.Ar flags any . 1962This will cause 1963.Xr pf 4 1964to synchronize to existing connections, for instance 1965if one flushes the state table. 1966However, states created from such intermediate packets may be missing 1967connection details such as the TCP window scaling factor. 1968States which modify the packet flow, such as those affected by 1969.Ar nat , binat No or Ar rdr 1970rules, 1971.Ar modulate No or Ar synproxy state 1972options, or scrubbed with 1973.Ar reassemble tcp 1974will also not be recoverable from intermediate packets. 1975Such connections will stall and time out. 1976.It Xo Ar icmp-type Aq Ar type 1977.Ar code Aq Ar code 1978.Xc 1979.It Xo Ar icmp6-type Aq Ar type 1980.Ar code Aq Ar code 1981.Xc 1982This rule only applies to ICMP or ICMPv6 packets with the specified type 1983and code. 1984Text names for ICMP types and codes are listed in 1985.Xr icmp 4 1986and 1987.Xr icmp6 4 . 1988This parameter is only valid for rules that cover protocols ICMP or 1989ICMP6. 1990The protocol and the ICMP type indicator 1991.Po 1992.Ar icmp-type 1993or 1994.Ar icmp6-type 1995.Pc 1996must match. 1997.It Xo Ar tos Aq Ar string 1998.No \*(Ba Aq Ar number 1999.Xc 2000This rule applies to packets with the specified 2001.Em TOS 2002bits set. 2003.Em TOS 2004may be 2005given as one of 2006.Ar critical , 2007.Ar inetcontrol , 2008.Ar lowdelay , 2009.Ar netcontrol , 2010.Ar throughput , 2011.Ar reliability , 2012or one of the DiffServ Code Points: 2013.Ar ef , 2014.Ar va , 2015.Ar af11 No ... Ar af43 , 2016.Ar cs0 No ... Ar cs7 ; 2017or as either hex or decimal. 2018.Pp 2019For example, the following rules are identical: 2020.Bd -literal -offset indent 2021pass all tos lowdelay 2022pass all tos 0x10 2023pass all tos 16 2024.Ed 2025.It Ar allow-opts 2026By default, IPv4 packets with IP options or IPv6 packets with routing 2027extension headers are blocked. 2028When 2029.Ar allow-opts 2030is specified for a 2031.Ar pass 2032rule, packets that pass the filter based on that rule (last matching) 2033do so even if they contain IP options or routing extension headers. 2034For packets that match state, the rule that initially created the 2035state is used. 2036The implicit 2037.Ar pass 2038rule that is used when a packet does not match any rules does not 2039allow IP options. 2040.It Ar label Aq Ar string 2041Adds a label (name) to the rule, which can be used to identify the rule. 2042For instance, 2043pfctl -s labels 2044shows per-rule statistics for rules that have labels. 2045.Pp 2046The following macros can be used in labels: 2047.Pp 2048.Bl -tag -width $srcaddr -compact -offset indent 2049.It Ar $if 2050The interface. 2051.It Ar $srcaddr 2052The source IP address. 2053.It Ar $dstaddr 2054The destination IP address. 2055.It Ar $srcport 2056The source port specification. 2057.It Ar $dstport 2058The destination port specification. 2059.It Ar $proto 2060The protocol name. 2061.It Ar $nr 2062The rule number. 2063.El 2064.Pp 2065For example: 2066.Bd -literal -offset indent 2067ips = \&"{ 1.2.3.4, 1.2.3.5 }\&" 2068pass in proto tcp from any to $ips \e 2069 port \*(Gt 1023 label \&"$dstaddr:$dstport\&" 2070.Ed 2071.Pp 2072expands to 2073.Bd -literal -offset indent 2074pass in inet proto tcp from any to 1.2.3.4 \e 2075 port \*(Gt 1023 label \&"1.2.3.4:\*(Gt1023\&" 2076pass in inet proto tcp from any to 1.2.3.5 \e 2077 port \*(Gt 1023 label \&"1.2.3.5:\*(Gt1023\&" 2078.Ed 2079.Pp 2080The macro expansion for the 2081.Ar label 2082directive occurs only at configuration file parse time, not during runtime. 2083.It Ar ridentifier Aq Ar number 2084Add an identifier (number) to the rule, which can be used to correlate the rule 2085to pflog entries, even after ruleset updates. 2086.It Xo Ar queue Aq Ar queue 2087.No \*(Ba ( Aq Ar queue , 2088.Aq Ar queue ) 2089.Xc 2090Packets matching this rule will be assigned to the specified queue. 2091If two queues are given, packets which have a 2092.Em TOS 2093of 2094.Em lowdelay 2095and TCP ACKs with no data payload will be assigned to the second one. 2096See 2097.Sx QUEUEING 2098for setup details. 2099.Pp 2100For example: 2101.Bd -literal -offset indent 2102pass in proto tcp to port 25 queue mail 2103pass in proto tcp to port 22 queue(ssh_bulk, ssh_prio) 2104.Ed 2105.It Cm set prio Ar priority | Pq Ar priority , priority 2106Packets matching this rule will be assigned a specific queueing priority. 2107Priorities are assigned as integers 0 through 7. 2108If the packet is transmitted on a 2109.Xr vlan 4 2110interface, the queueing priority will be written as the priority 2111code point in the 802.1Q VLAN header. 2112If two priorities are given, packets which have a TOS of 2113.Cm lowdelay 2114and TCP ACKs with no data payload will be assigned to the second one. 2115.Pp 2116For example: 2117.Bd -literal -offset indent 2118pass in proto tcp to port 25 set prio 2 2119pass in proto tcp to port 22 set prio (2, 5) 2120.Ed 2121.It Ar received-on Aq Ar interface 2122Only match packets which were received on the specified 2123.Ar interface 2124(or interface group). 2125.Ed 2126.It Ar tag Aq Ar string 2127Packets matching this rule will be tagged with the 2128specified string. 2129The tag acts as an internal marker that can be used to 2130identify these packets later on. 2131This can be used, for example, to provide trust between 2132interfaces and to determine if packets have been 2133processed by translation rules. 2134Tags are 2135.Qq sticky , 2136meaning that the packet will be tagged even if the rule 2137is not the last matching rule. 2138Further matching rules can replace the tag with a 2139new one but will not remove a previously applied tag. 2140A packet is only ever assigned one tag at a time. 2141Packet tagging can be done during 2142.Ar nat , 2143.Ar rdr , 2144.Ar binat 2145or 2146.Ar ether 2147rules in addition to filter rules. 2148Tags take the same macros as labels (see above). 2149.It Ar tagged Aq Ar string 2150Used with filter, translation or scrub rules 2151to specify that packets must already 2152be tagged with the given tag in order to match the rule. 2153Inverse tag matching can also be done 2154by specifying the 2155.Cm !\& 2156operator before the 2157.Ar tagged 2158keyword. 2159.It Ar rtable Aq Ar number 2160Used to select an alternate routing table for the routing lookup. 2161Only effective before the route lookup happened, i.e. when filtering inbound. 2162.It Xo Ar divert-to Aq Ar host 2163.Ar port Aq Ar port 2164.Xc 2165Used to 2166.Xr divert 4 2167packets to the given divert 2168.Ar port . 2169Historically 2170.Ox pf has another meaning for this, and 2171.Fx pf uses 2172this syntax to support 2173.Xr divert 4 instead. Hence, 2174.Ar host 2175has no meaning and can be set to anything like 127.0.0.1. 2176If a packet is re-injected and does not change direction then it will not be 2177re-diverted. 2178.It Ar divert-reply 2179It has no meaning in 2180.Fx pf . 2181.It Ar probability Aq Ar number 2182A probability attribute can be attached to a rule, with a value set between 21830 and 1, bounds not included. 2184In that case, the rule will be honoured using the given probability value 2185only. 2186For example, the following rule will drop 20% of incoming ICMP packets: 2187.Bd -literal -offset indent 2188block in proto icmp probability 20% 2189.Ed 2190.It Ar prio Aq Ar number 2191Only match packets which have the given queueing priority assigned. 2192.El 2193.Sh ROUTING 2194If a packet matches a rule with a route option set, the packet filter will 2195route the packet according to the type of route option. 2196When such a rule creates state, the route option is also applied to all 2197packets matching the same connection. 2198.Bl -tag -width xxxx 2199.It Ar route-to 2200The 2201.Ar route-to 2202option routes the packet to the specified interface with an optional address 2203for the next hop. 2204When a 2205.Ar route-to 2206rule creates state, only packets that pass in the same direction as the 2207filter rule specifies will be routed in this way. 2208Packets passing in the opposite direction (replies) are not affected 2209and are routed normally. 2210.It Ar reply-to 2211The 2212.Ar reply-to 2213option is similar to 2214.Ar route-to , 2215but routes packets that pass in the opposite direction (replies) to the 2216specified interface. 2217Opposite direction is only defined in the context of a state entry, and 2218.Ar reply-to 2219is useful only in rules that create state. 2220It can be used on systems with multiple external connections to 2221route all outgoing packets of a connection through the interface 2222the incoming connection arrived through (symmetric routing enforcement). 2223.It Ar dup-to 2224The 2225.Ar dup-to 2226option creates a duplicate of the packet and routes it like 2227.Ar route-to . 2228The original packet gets routed as it normally would. 2229.El 2230.Sh POOL OPTIONS 2231For 2232.Ar nat 2233and 2234.Ar rdr 2235rules, (as well as for the 2236.Ar route-to , 2237.Ar reply-to 2238and 2239.Ar dup-to 2240rule options) for which there is a single redirection address which has a 2241subnet mask smaller than 32 for IPv4 or 128 for IPv6 (more than one IP 2242address), a variety of different methods for assigning this address can be 2243used: 2244.Bl -tag -width xxxx 2245.It Ar bitmask 2246The 2247.Ar bitmask 2248option applies the network portion of the redirection address to the address 2249to be modified (source with 2250.Ar nat , 2251destination with 2252.Ar rdr ) . 2253.It Ar random 2254The 2255.Ar random 2256option selects an address at random within the defined block of addresses. 2257.It Ar source-hash 2258The 2259.Ar source-hash 2260option uses a hash of the source address to determine the redirection address, 2261ensuring that the redirection address is always the same for a given source. 2262An optional key can be specified after this keyword either in hex or as a 2263string; by default 2264.Xr pfctl 8 2265randomly generates a key for source-hash every time the 2266ruleset is reloaded. 2267.It Ar round-robin 2268The 2269.Ar round-robin 2270option loops through the redirection address(es). 2271.Pp 2272When more than one redirection address is specified, 2273.Ar round-robin 2274is the only permitted pool type. 2275.It Ar static-port 2276With 2277.Ar nat 2278rules, the 2279.Ar static-port 2280option prevents 2281.Xr pf 4 2282from modifying the source port on TCP and UDP packets. 2283.It Xo Ar map-e-portset Aq Ar psid-offset 2284.No / Aq Ar psid-len 2285.No / Aq Ar psid 2286.Xc 2287With 2288.Ar nat 2289rules, the 2290.It Ar endpoint-independent 2291With 2292.Ar nat 2293rules, the 2294.Ar endpoint-independent 2295option caues 2296.Xr pf 4 2297to always map connections from a UDP source address and port to the same 2298NAT address and port. 2299This feature implements "full-cone" NAT behavior. 2300.Ar map-e-portset 2301option enables the source port translation of MAP-E (RFC 7597) Customer Edge. 2302In order to make the host act as a MAP-E Customer Edge, setting up a tunneling 2303interface and pass rules for encapsulated packets are required in addition 2304to the map-e-portset nat rule. 2305.Pp 2306For example: 2307.Bd -literal -offset indent 2308nat on $gif_mape_if from $int_if:network to any \e 2309 -> $ipv4_mape_src map-e-portset 6/8/0x34 2310.Ed 2311.Pp 2312sets PSID offset 6, PSID length 8, PSID 0x34. 2313.El 2314.Pp 2315Additionally, the 2316.Ar sticky-address 2317option can be specified to help ensure that multiple connections from the 2318same source are mapped to the same redirection address. 2319This option can be used with the 2320.Ar random 2321and 2322.Ar round-robin 2323pool options. 2324Note that by default these associations are destroyed as soon as there are 2325no longer states which refer to them; in order to make the mappings last 2326beyond the lifetime of the states, increase the global options with 2327.Ar set timeout src.track . 2328See 2329.Sx STATEFUL TRACKING OPTIONS 2330for more ways to control the source tracking. 2331.Sh STATE MODULATION 2332Much of the security derived from TCP is attributable to how well the 2333initial sequence numbers (ISNs) are chosen. 2334Some popular stack implementations choose 2335.Em very 2336poor ISNs and thus are normally susceptible to ISN prediction exploits. 2337By applying a 2338.Ar modulate state 2339rule to a TCP connection, 2340.Xr pf 4 2341will create a high quality random sequence number for each connection 2342endpoint. 2343.Pp 2344The 2345.Ar modulate state 2346directive implicitly keeps state on the rule and is 2347only applicable to TCP connections. 2348.Pp 2349For instance: 2350.Bd -literal -offset indent 2351block all 2352pass out proto tcp from any to any modulate state 2353pass in proto tcp from any to any port 25 flags S/SFRA modulate state 2354.Ed 2355.Pp 2356Note that modulated connections will not recover when the state table 2357is lost (firewall reboot, flushing the state table, etc...). 2358.Xr pf 4 2359will not be able to infer a connection again after the state table flushes 2360the connection's modulator. 2361When the state is lost, the connection may be left dangling until the 2362respective endpoints time out the connection. 2363It is possible on a fast local network for the endpoints to start an ACK 2364storm while trying to resynchronize after the loss of the modulator. 2365The default 2366.Ar flags 2367settings (or a more strict equivalent) should be used on 2368.Ar modulate state 2369rules to prevent ACK storms. 2370.Pp 2371Note that alternative methods are available 2372to prevent loss of the state table 2373and allow for firewall failover. 2374See 2375.Xr carp 4 2376and 2377.Xr pfsync 4 2378for further information. 2379.Sh SYN PROXY 2380By default, 2381.Xr pf 4 2382passes packets that are part of a 2383.Xr tcp 4 2384handshake between the endpoints. 2385The 2386.Ar synproxy state 2387option can be used to cause 2388.Xr pf 4 2389itself to complete the handshake with the active endpoint, perform a handshake 2390with the passive endpoint, and then forward packets between the endpoints. 2391.Pp 2392No packets are sent to the passive endpoint before the active endpoint has 2393completed the handshake, hence so-called SYN floods with spoofed source 2394addresses will not reach the passive endpoint, as the sender can't complete the 2395handshake. 2396.Pp 2397The proxy is transparent to both endpoints, they each see a single 2398connection from/to the other endpoint. 2399.Xr pf 4 2400chooses random initial sequence numbers for both handshakes. 2401Once the handshakes are completed, the sequence number modulators 2402(see previous section) are used to translate further packets of the 2403connection. 2404.Ar synproxy state 2405includes 2406.Ar modulate state . 2407.Pp 2408Rules with 2409.Ar synproxy 2410will not work if 2411.Xr pf 4 2412operates on a 2413.Xr bridge 4 . 2414.Pp 2415Example: 2416.Bd -literal -offset indent 2417pass in proto tcp from any to any port www synproxy state 2418.Ed 2419.Sh STATEFUL TRACKING OPTIONS 2420A number of options related to stateful tracking can be applied on a 2421per-rule basis. 2422.Ar keep state , 2423.Ar modulate state 2424and 2425.Ar synproxy state 2426support these options, and 2427.Ar keep state 2428must be specified explicitly to apply options to a rule. 2429.Pp 2430.Bl -tag -width xxxx -compact 2431.It Ar max Aq Ar number 2432Limits the number of concurrent states the rule may create. 2433When this limit is reached, further packets that would create 2434state will not match this rule until existing states time out. 2435.It Ar no-sync 2436Prevent state changes for states created by this rule from appearing on the 2437.Xr pfsync 4 2438interface. 2439.It Xo Aq Ar timeout 2440.Aq Ar seconds 2441.Xc 2442Changes the timeout values used for states created by this rule. 2443For a list of all valid timeout names, see 2444.Sx OPTIONS 2445above. 2446.It Ar sloppy 2447Uses a sloppy TCP connection tracker that does not check sequence 2448numbers at all, which makes insertion and ICMP teardown attacks way 2449easier. 2450This is intended to be used in situations where one does not see all 2451packets of a connection, e.g. in asymmetric routing situations. 2452Cannot be used with modulate or synproxy state. 2453.It Ar pflow 2454States created by this rule are exported on the 2455.Xr pflow 4 2456interface. 2457.El 2458.Pp 2459Multiple options can be specified, separated by commas: 2460.Bd -literal -offset indent 2461pass in proto tcp from any to any \e 2462 port www keep state \e 2463 (max 100, source-track rule, max-src-nodes 75, \e 2464 max-src-states 3, tcp.established 60, tcp.closing 5) 2465.Ed 2466.Pp 2467When the 2468.Ar source-track 2469keyword is specified, the number of states per source IP is tracked. 2470.Pp 2471.Bl -tag -width xxxx -compact 2472.It Ar source-track rule 2473The maximum number of states created by this rule is limited by the rule's 2474.Ar max-src-nodes 2475and 2476.Ar max-src-states 2477options. 2478Only state entries created by this particular rule count toward the rule's 2479limits. 2480.It Ar source-track global 2481The number of states created by all rules that use this option is limited. 2482Each rule can specify different 2483.Ar max-src-nodes 2484and 2485.Ar max-src-states 2486options, however state entries created by any participating rule count towards 2487each individual rule's limits. 2488.El 2489.Pp 2490The following limits can be set: 2491.Pp 2492.Bl -tag -width xxxx -compact 2493.It Ar max-src-nodes Aq Ar number 2494Limits the maximum number of source addresses which can simultaneously 2495have state table entries. 2496.It Ar max-src-states Aq Ar number 2497Limits the maximum number of simultaneous state entries that a single 2498source address can create with this rule. 2499.El 2500.Pp 2501For stateful TCP connections, limits on established connections (connections 2502which have completed the TCP 3-way handshake) can also be enforced 2503per source IP. 2504.Pp 2505.Bl -tag -width xxxx -compact 2506.It Ar max-src-conn Aq Ar number 2507Limits the maximum number of simultaneous TCP connections which have 2508completed the 3-way handshake that a single host can make. 2509.It Xo Ar max-src-conn-rate Aq Ar number 2510.No / Aq Ar seconds 2511.Xc 2512Limit the rate of new connections over a time interval. 2513The connection rate is an approximation calculated as a moving average. 2514.El 2515.Pp 2516Because the 3-way handshake ensures that the source address is not being 2517spoofed, more aggressive action can be taken based on these limits. 2518With the 2519.Ar overload Aq Ar table 2520state option, source IP addresses which hit either of the limits on 2521established connections will be added to the named table. 2522This table can be used in the ruleset to block further activity from 2523the offending host, redirect it to a tarpit process, or restrict its 2524bandwidth. 2525.Pp 2526The optional 2527.Ar flush 2528keyword kills all states created by the matching rule which originate 2529from the host which exceeds these limits. 2530The 2531.Ar global 2532modifier to the flush command kills all states originating from the 2533offending host, regardless of which rule created the state. 2534.Pp 2535For example, the following rules will protect the webserver against 2536hosts making more than 100 connections in 10 seconds. 2537Any host which connects faster than this rate will have its address added 2538to the 2539.Aq bad_hosts 2540table and have all states originating from it flushed. 2541Any new packets arriving from this host will be dropped unconditionally 2542by the block rule. 2543.Bd -literal -offset indent 2544block quick from \*(Ltbad_hosts\*(Gt 2545pass in on $ext_if proto tcp to $webserver port www keep state \e 2546 (max-src-conn-rate 100/10, overload \*(Ltbad_hosts\*(Gt flush global) 2547.Ed 2548.Sh OPERATING SYSTEM FINGERPRINTING 2549Passive OS Fingerprinting is a mechanism to inspect nuances of a TCP 2550connection's initial SYN packet and guess at the host's operating system. 2551Unfortunately these nuances are easily spoofed by an attacker so the 2552fingerprint is not useful in making security decisions. 2553But the fingerprint is typically accurate enough to make policy decisions 2554upon. 2555.Pp 2556The fingerprints may be specified by operating system class, by 2557version, or by subtype/patchlevel. 2558The class of an operating system is typically the vendor or genre 2559and would be 2560.Ox 2561for the 2562.Xr pf 4 2563firewall itself. 2564The version of the oldest available 2565.Ox 2566release on the main FTP site 2567would be 2.6 and the fingerprint would be written 2568.Pp 2569.Dl \&"OpenBSD 2.6\&" 2570.Pp 2571The subtype of an operating system is typically used to describe the 2572patchlevel if that patch led to changes in the TCP stack behavior. 2573In the case of 2574.Ox , 2575the only subtype is for a fingerprint that was 2576normalized by the 2577.Ar no-df 2578scrub option and would be specified as 2579.Pp 2580.Dl \&"OpenBSD 3.3 no-df\&" 2581.Pp 2582Fingerprints for most popular operating systems are provided by 2583.Xr pf.os 5 . 2584Once 2585.Xr pf 4 2586is running, a complete list of known operating system fingerprints may 2587be listed by running: 2588.Pp 2589.Dl # pfctl -so 2590.Pp 2591Filter rules can enforce policy at any level of operating system specification 2592assuming a fingerprint is present. 2593Policy could limit traffic to approved operating systems or even ban traffic 2594from hosts that aren't at the latest service pack. 2595.Pp 2596The 2597.Ar unknown 2598class can also be used as the fingerprint which will match packets for 2599which no operating system fingerprint is known. 2600.Pp 2601Examples: 2602.Bd -literal -offset indent 2603pass out proto tcp from any os OpenBSD 2604block out proto tcp from any os Doors 2605block out proto tcp from any os "Doors PT" 2606block out proto tcp from any os "Doors PT SP3" 2607block out from any os "unknown" 2608pass on lo0 proto tcp from any os "OpenBSD 3.3 lo0" 2609.Ed 2610.Pp 2611Operating system fingerprinting is limited only to the TCP SYN packet. 2612This means that it will not work on other protocols and will not match 2613a currently established connection. 2614.Pp 2615Caveat: operating system fingerprints are occasionally wrong. 2616There are three problems: an attacker can trivially craft his packets to 2617appear as any operating system he chooses; 2618an operating system patch could change the stack behavior and no fingerprints 2619will match it until the database is updated; 2620and multiple operating systems may have the same fingerprint. 2621.Sh BLOCKING SPOOFED TRAFFIC 2622"Spoofing" is the faking of IP addresses, typically for malicious 2623purposes. 2624The 2625.Ar antispoof 2626directive expands to a set of filter rules which will block all 2627traffic with a source IP from the network(s) directly connected 2628to the specified interface(s) from entering the system through 2629any other interface. 2630.Pp 2631For example, the line 2632.Bd -literal -offset indent 2633antispoof for lo0 2634.Ed 2635.Pp 2636expands to 2637.Bd -literal -offset indent 2638block drop in on ! lo0 inet from 127.0.0.1/8 to any 2639block drop in on ! lo0 inet6 from ::1 to any 2640.Ed 2641.Pp 2642For non-loopback interfaces, there are additional rules to block incoming 2643packets with a source IP address identical to the interface's IP(s). 2644For example, assuming the interface wi0 had an IP address of 10.0.0.1 and a 2645netmask of 255.255.255.0, 2646the line 2647.Bd -literal -offset indent 2648antispoof for wi0 inet 2649.Ed 2650.Pp 2651expands to 2652.Bd -literal -offset indent 2653block drop in on ! wi0 inet from 10.0.0.0/24 to any 2654block drop in inet from 10.0.0.1 to any 2655.Ed 2656.Pp 2657Caveat: Rules created by the 2658.Ar antispoof 2659directive interfere with packets sent over loopback interfaces 2660to local addresses. 2661One should pass these explicitly. 2662.Sh FRAGMENT HANDLING 2663The size of IP datagrams (packets) can be significantly larger than the 2664maximum transmission unit (MTU) of the network. 2665In cases when it is necessary or more efficient to send such large packets, 2666the large packet will be fragmented into many smaller packets that will each 2667fit onto the wire. 2668Unfortunately for a firewalling device, only the first logical fragment will 2669contain the necessary header information for the subprotocol that allows 2670.Xr pf 4 2671to filter on things such as TCP ports or to perform NAT. 2672.Pp 2673Besides the use of 2674.Ar set reassemble 2675option or 2676.Ar scrub 2677rules as described in 2678.Sx TRAFFIC NORMALIZATION 2679above, there are three options for handling fragments in the packet filter. 2680.Pp 2681One alternative is to filter individual fragments with filter rules. 2682If no 2683.Ar scrub 2684rule applies to a fragment or 2685.Ar set reassemble 2686is set to 2687.Cm no 2688, it is passed to the filter. 2689Filter rules with matching IP header parameters decide whether the 2690fragment is passed or blocked, in the same way as complete packets 2691are filtered. 2692Without reassembly, fragments can only be filtered based on IP header 2693fields (source/destination address, protocol), since subprotocol header 2694fields are not available (TCP/UDP port numbers, ICMP code/type). 2695The 2696.Ar fragment 2697option can be used to restrict filter rules to apply only to 2698fragments, but not complete packets. 2699Filter rules without the 2700.Ar fragment 2701option still apply to fragments, if they only specify IP header fields. 2702For instance, the rule 2703.Bd -literal -offset indent 2704pass in proto tcp from any to any port 80 2705.Ed 2706.Pp 2707never applies to a fragment, even if the fragment is part of a TCP 2708packet with destination port 80, because without reassembly this information 2709is not available for each fragment. 2710This also means that fragments cannot create new or match existing 2711state table entries, which makes stateful filtering and address 2712translation (NAT, redirection) for fragments impossible. 2713.Pp 2714It's also possible to reassemble only certain fragments by specifying 2715source or destination addresses or protocols as parameters in 2716.Ar scrub 2717rules. 2718.Pp 2719In most cases, the benefits of reassembly outweigh the additional 2720memory cost, and it's recommended to use 2721.Ar set reassemble 2722option or 2723.Ar scrub 2724rules with the 2725.Ar fragment reassemble 2726modifier to reassemble 2727all fragments. 2728.Pp 2729The memory allocated for fragment caching can be limited using 2730.Xr pfctl 8 . 2731Once this limit is reached, fragments that would have to be cached 2732are dropped until other entries time out. 2733The timeout value can also be adjusted. 2734.Pp 2735When forwarding reassembled IPv6 packets, pf refragments them with 2736the original maximum fragment size. 2737This allows the sender to determine the optimal fragment size by 2738path MTU discovery. 2739.Sh ANCHORS 2740Besides the main ruleset, 2741.Xr pfctl 8 2742can load rulesets into 2743.Ar anchor 2744attachment points. 2745An 2746.Ar anchor 2747is a container that can hold rules, address tables, and other anchors. 2748.Pp 2749An 2750.Ar anchor 2751has a name which specifies the path where 2752.Xr pfctl 8 2753can be used to access the anchor to perform operations on it, such as 2754attaching child anchors to it or loading rules into it. 2755Anchors may be nested, with components separated by 2756.Sq / 2757characters, similar to how file system hierarchies are laid out. 2758The main ruleset is actually the default anchor, so filter and 2759translation rules, for example, may also be contained in any anchor. 2760.Pp 2761An anchor can reference another 2762.Ar anchor 2763attachment point 2764using the following kinds 2765of rules: 2766.Bl -tag -width xxxx 2767.It Ar nat-anchor Aq Ar name 2768Evaluates the 2769.Ar nat 2770rules in the specified 2771.Ar anchor . 2772.It Ar rdr-anchor Aq Ar name 2773Evaluates the 2774.Ar rdr 2775rules in the specified 2776.Ar anchor . 2777.It Ar binat-anchor Aq Ar name 2778Evaluates the 2779.Ar binat 2780rules in the specified 2781.Ar anchor . 2782.It Ar anchor Aq Ar name 2783Evaluates the filter rules in the specified 2784.Ar anchor . 2785.It Xo Ar load anchor 2786.Aq Ar name 2787.Ar from Aq Ar file 2788.Xc 2789Loads the rules from the specified file into the 2790anchor 2791.Ar name . 2792.El 2793.Pp 2794When evaluation of the main ruleset reaches an 2795.Ar anchor 2796rule, 2797.Xr pf 4 2798will proceed to evaluate all rules specified in that anchor. 2799.Pp 2800Matching filter and translation rules marked with the 2801.Ar quick 2802option are final and abort the evaluation of the rules in other 2803anchors and the main ruleset. 2804If the 2805.Ar anchor 2806itself is marked with the 2807.Ar quick 2808option, 2809ruleset evaluation will terminate when the anchor is exited if the packet is 2810matched by any rule within the anchor. 2811.Pp 2812.Ar anchor 2813rules are evaluated relative to the anchor in which they are contained. 2814For example, all 2815.Ar anchor 2816rules specified in the main ruleset will reference anchor 2817attachment points underneath the main ruleset, and 2818.Ar anchor 2819rules specified in a file loaded from a 2820.Ar load anchor 2821rule will be attached under that anchor point. 2822.Pp 2823Rules may be contained in 2824.Ar anchor 2825attachment points which do not contain any rules when the main ruleset 2826is loaded, and later such anchors can be manipulated through 2827.Xr pfctl 8 2828without reloading the main ruleset or other anchors. 2829For example, 2830.Bd -literal -offset indent 2831ext_if = \&"kue0\&" 2832block on $ext_if all 2833anchor spam 2834pass out on $ext_if all 2835pass in on $ext_if proto tcp from any \e 2836 to $ext_if port smtp 2837.Ed 2838.Pp 2839blocks all packets on the external interface by default, then evaluates 2840all rules in the 2841.Ar anchor 2842named "spam", and finally passes all outgoing connections and 2843incoming connections to port 25. 2844.Bd -literal -offset indent 2845# echo \&"block in quick from 1.2.3.4 to any\&" \&| \e 2846 pfctl -a spam -f - 2847.Ed 2848.Pp 2849This loads a single rule into the 2850.Ar anchor , 2851which blocks all packets from a specific address. 2852.Pp 2853The anchor can also be populated by adding a 2854.Ar load anchor 2855rule after the 2856.Ar anchor 2857rule: 2858.Bd -literal -offset indent 2859anchor spam 2860load anchor spam from "/etc/pf-spam.conf" 2861.Ed 2862.Pp 2863When 2864.Xr pfctl 8 2865loads 2866.Nm pf.conf , 2867it will also load all the rules from the file 2868.Pa /etc/pf-spam.conf 2869into the anchor. 2870.Pp 2871Optionally, 2872.Ar anchor 2873rules can specify packet filtering parameters using the same syntax as 2874filter rules. 2875When parameters are used, the 2876.Ar anchor 2877rule is only evaluated for matching packets. 2878This allows conditional evaluation of anchors, like: 2879.Bd -literal -offset indent 2880block on $ext_if all 2881anchor spam proto tcp from any to any port smtp 2882pass out on $ext_if all 2883pass in on $ext_if proto tcp from any to $ext_if port smtp 2884.Ed 2885.Pp 2886The rules inside 2887.Ar anchor 2888spam are only evaluated for 2889.Ar tcp 2890packets with destination port 25. 2891Hence, 2892.Bd -literal -offset indent 2893# echo \&"block in quick from 1.2.3.4 to any" \&| \e 2894 pfctl -a spam -f - 2895.Ed 2896.Pp 2897will only block connections from 1.2.3.4 to port 25. 2898.Pp 2899Anchors may end with the asterisk 2900.Pq Sq * 2901character, which signifies that all anchors attached at that point 2902should be evaluated in the alphabetical ordering of their anchor name. 2903For example, 2904.Bd -literal -offset indent 2905anchor "spam/*" 2906.Ed 2907.Pp 2908will evaluate each rule in each anchor attached to the 2909.Li spam 2910anchor. 2911Note that it will only evaluate anchors that are directly attached to the 2912.Li spam 2913anchor, and will not descend to evaluate anchors recursively. 2914.Pp 2915Since anchors are evaluated relative to the anchor in which they are 2916contained, there is a mechanism for accessing the parent and ancestor 2917anchors of a given anchor. 2918Similar to file system path name resolution, if the sequence 2919.Dq .. 2920appears as an anchor path component, the parent anchor of the current 2921anchor in the path evaluation at that point will become the new current 2922anchor. 2923As an example, consider the following: 2924.Bd -literal -offset indent 2925# echo ' anchor "spam/allowed" ' | pfctl -f - 2926# echo -e ' anchor "../banned" \en pass' | \e 2927 pfctl -a spam/allowed -f - 2928.Ed 2929.Pp 2930Evaluation of the main ruleset will lead into the 2931.Li spam/allowed 2932anchor, which will evaluate the rules in the 2933.Li spam/banned 2934anchor, if any, before finally evaluating the 2935.Ar pass 2936rule. 2937.Pp 2938Filter rule 2939.Ar anchors 2940can also be loaded inline in the ruleset within a brace ('{' '}') delimited 2941block. 2942Brace delimited blocks may contain rules or other brace-delimited blocks. 2943When anchors are loaded this way the anchor name becomes optional. 2944.Bd -literal -offset indent 2945anchor "external" on $ext_if { 2946 block 2947 anchor out { 2948 pass proto tcp from any to port { 25, 80, 443 } 2949 } 2950 pass in proto tcp to any port 22 2951} 2952.Ed 2953.Pp 2954Since the parser specification for anchor names is a string, any 2955reference to an anchor name containing 2956.Sq / 2957characters will require double quote 2958.Pq Sq \&" 2959characters around the anchor name. 2960.Sh SCTP CONSIDERATIONS 2961.Xr pf 4 2962supports 2963.Xr sctp 4 2964connections. 2965It can match ports, track state and NAT SCTP traffic. 2966However, it will not alter port numbers during nat or rdr translations. 2967Doing so would break SCTP multihoming. 2968.Sh TRANSLATION EXAMPLES 2969This example maps incoming requests on port 80 to port 8080, on 2970which a daemon is running (because, for example, it is not run as root, 2971and therefore lacks permission to bind to port 80). 2972.Bd -literal 2973# use a macro for the interface name, so it can be changed easily 2974ext_if = \&"ne3\&" 2975 2976# map daemon on 8080 to appear to be on 80 2977rdr on $ext_if proto tcp from any to any port 80 -\*(Gt 127.0.0.1 port 8080 2978.Ed 2979.Pp 2980If the 2981.Ar pass 2982modifier is given, packets matching the translation rule are passed without 2983inspecting the filter rules: 2984.Bd -literal 2985rdr pass on $ext_if proto tcp from any to any port 80 -\*(Gt 127.0.0.1 \e 2986 port 8080 2987.Ed 2988.Pp 2989In the example below, vlan12 is configured as 192.168.168.1; 2990the machine translates all packets coming from 192.168.168.0/24 to 204.92.77.111 2991when they are going out any interface except vlan12. 2992This has the net effect of making traffic from the 192.168.168.0/24 2993network appear as though it is the Internet routable address 2994204.92.77.111 to nodes behind any interface on the router except 2995for the nodes on vlan12. 2996(Thus, 192.168.168.1 can talk to the 192.168.168.0/24 nodes.) 2997.Bd -literal 2998nat on ! vlan12 from 192.168.168.0/24 to any -\*(Gt 204.92.77.111 2999.Ed 3000.Pp 3001In the example below, the machine sits between a fake internal 144.19.74.* 3002network, and a routable external IP of 204.92.77.100. 3003The 3004.Ar no nat 3005rule excludes protocol AH from being translated. 3006.Bd -literal 3007# NO NAT 3008no nat on $ext_if proto ah from 144.19.74.0/24 to any 3009nat on $ext_if from 144.19.74.0/24 to any -\*(Gt 204.92.77.100 3010.Ed 3011.Pp 3012In the example below, packets bound for one specific server, as well as those 3013generated by the sysadmins are not proxied; all other connections are. 3014.Bd -literal 3015# NO RDR 3016no rdr on $int_if proto { tcp, udp } from any to $server port 80 3017no rdr on $int_if proto { tcp, udp } from $sysadmins to any port 80 3018rdr on $int_if proto { tcp, udp } from any to any port 80 -\*(Gt 127.0.0.1 \e 3019 port 80 3020.Ed 3021.Pp 3022This longer example uses both a NAT and a redirection. 3023The external interface has the address 157.161.48.183. 3024On localhost, we are running 3025.Xr ftp-proxy 8 , 3026waiting for FTP sessions to be redirected to it. 3027The three mandatory anchors for 3028.Xr ftp-proxy 8 3029are omitted from this example; see the 3030.Xr ftp-proxy 8 3031manpage. 3032.Bd -literal 3033# NAT 3034# Translate outgoing packets' source addresses (any protocol). 3035# In this case, any address but the gateway's external address is mapped. 3036nat on $ext_if inet from ! ($ext_if) to any -\*(Gt ($ext_if) 3037 3038# NAT PROXYING 3039# Map outgoing packets' source port to an assigned proxy port instead of 3040# an arbitrary port. 3041# In this case, proxy outgoing isakmp with port 500 on the gateway. 3042nat on $ext_if inet proto udp from any port = isakmp to any -\*(Gt ($ext_if) \e 3043 port 500 3044 3045# BINAT 3046# Translate outgoing packets' source address (any protocol). 3047# Translate incoming packets' destination address to an internal machine 3048# (bidirectional). 3049binat on $ext_if from 10.1.2.150 to any -\*(Gt $ext_if 3050 3051# Translate packets arriving on $peer_if addressed to 172.22.16.0/20 3052# to the corresponding address in 172.21.16.0/20 (bidirectional). 3053binat on $peer_if from 172.21.16.0/20 to any -> 172.22.16.0/20 3054 3055# RDR 3056# Translate incoming packets' destination addresses. 3057# As an example, redirect a TCP and UDP port to an internal machine. 3058rdr on $ext_if inet proto tcp from any to ($ext_if) port 8080 \e 3059 -\*(Gt 10.1.2.151 port 22 3060rdr on $ext_if inet proto udp from any to ($ext_if) port 8080 \e 3061 -\*(Gt 10.1.2.151 port 53 3062 3063# RDR 3064# Translate outgoing ftp control connections to send them to localhost 3065# for proxying with ftp-proxy(8) running on port 8021. 3066rdr on $int_if proto tcp from any to any port 21 -\*(Gt 127.0.0.1 port 8021 3067.Ed 3068.Pp 3069In this example, a NAT gateway is set up to translate internal addresses 3070using a pool of public addresses (192.0.2.16/28) and to redirect 3071incoming web server connections to a group of web servers on the internal 3072network. 3073.Bd -literal 3074# NAT LOAD BALANCE 3075# Translate outgoing packets' source addresses using an address pool. 3076# A given source address is always translated to the same pool address by 3077# using the source-hash keyword. 3078nat on $ext_if inet from any to any -\*(Gt 192.0.2.16/28 source-hash 3079 3080# RDR ROUND ROBIN 3081# Translate incoming web server connections to a group of web servers on 3082# the internal network. 3083rdr on $ext_if proto tcp from any to any port 80 \e 3084 -\*(Gt { 10.1.2.155, 10.1.2.160, 10.1.2.161 } round-robin 3085.Ed 3086.Sh FILTER EXAMPLES 3087.Bd -literal 3088# The external interface is kue0 3089# (157.161.48.183, the only routable address) 3090# and the private network is 10.0.0.0/8, for which we are doing NAT. 3091 3092# Reassemble incoming traffic 3093set reassemble yes 3094 3095# use a macro for the interface name, so it can be changed easily 3096ext_if = \&"kue0\&" 3097 3098# block and log everything by default 3099block return log on $ext_if all 3100 3101# block anything coming from source we have no back routes for 3102block in from no-route to any 3103 3104# block packets whose ingress interface does not match the one in 3105# the route back to their source address 3106block in from urpf-failed to any 3107 3108# block and log outgoing packets that do not have our address as source, 3109# they are either spoofed or something is misconfigured (NAT disabled, 3110# for instance), we want to be nice and do not send out garbage. 3111block out log quick on $ext_if from ! 157.161.48.183 to any 3112 3113# silently drop broadcasts (cable modem noise) 3114block in quick on $ext_if from any to 255.255.255.255 3115 3116# block and log incoming packets from reserved address space and invalid 3117# addresses, they are either spoofed or misconfigured, we cannot reply to 3118# them anyway (hence, no return-rst). 3119block in log quick on $ext_if from { 10.0.0.0/8, 172.16.0.0/12, \e 3120 192.168.0.0/16, 255.255.255.255/32 } to any 3121 3122# ICMP 3123 3124# pass out/in certain ICMP queries and keep state (ping) 3125# state matching is done on host addresses and ICMP id (not type/code), 3126# so replies (like 0/0 for 8/0) will match queries 3127# ICMP error messages (which always refer to a TCP/UDP packet) are 3128# handled by the TCP/UDP states 3129pass on $ext_if inet proto icmp all icmp-type 8 code 0 3130 3131# UDP 3132 3133# pass out all UDP connections and keep state 3134pass out on $ext_if proto udp all 3135 3136# pass in certain UDP connections and keep state (DNS) 3137pass in on $ext_if proto udp from any to any port domain 3138 3139# TCP 3140 3141# pass out all TCP connections and modulate state 3142pass out on $ext_if proto tcp all modulate state 3143 3144# pass in certain TCP connections and keep state (SSH, SMTP, DNS, IDENT) 3145pass in on $ext_if proto tcp from any to any port { ssh, smtp, domain, \e 3146 auth } 3147 3148# Do not allow Windows 9x SMTP connections since they are typically 3149# a viral worm. Alternately we could limit these OSes to 1 connection each. 3150block in on $ext_if proto tcp from any os {"Windows 95", "Windows 98"} \e 3151 to any port smtp 3152 3153# IPv6 3154# pass in/out all IPv6 traffic: note that we have to enable this in two 3155# different ways, on both our physical interface and our tunnel 3156pass quick on gif0 inet6 3157pass quick on $ext_if proto ipv6 3158 3159# Packet Tagging 3160 3161# three interfaces: $int_if, $ext_if, and $wifi_if (wireless). NAT is 3162# being done on $ext_if for all outgoing packets. tag packets in on 3163# $int_if and pass those tagged packets out on $ext_if. all other 3164# outgoing packets (i.e., packets from the wireless network) are only 3165# permitted to access port 80. 3166 3167pass in on $int_if from any to any tag INTNET 3168pass in on $wifi_if from any to any 3169 3170block out on $ext_if from any to any 3171pass out quick on $ext_if tagged INTNET 3172pass out on $ext_if proto tcp from any to any port 80 3173 3174# tag incoming packets as they are redirected to spamd(8). use the tag 3175# to pass those packets through the packet filter. 3176 3177rdr on $ext_if inet proto tcp from \*(Ltspammers\*(Gt to port smtp \e 3178 tag SPAMD -\*(Gt 127.0.0.1 port spamd 3179 3180block in on $ext_if 3181pass in on $ext_if inet proto tcp tagged SPAMD 3182.Ed 3183.Sh GRAMMAR 3184Syntax for 3185.Nm 3186in BNF: 3187.Bd -literal 3188line = ( option | ether-rule | pf-rule | nat-rule | binat-rule | 3189 rdr-rule | antispoof-rule | altq-rule | queue-rule | 3190 trans-anchors | anchor-rule | anchor-close | load-anchor | 3191 table-rule | include ) 3192 3193option = "set" ( [ "timeout" ( timeout | "{" timeout-list "}" ) ] | 3194 [ "ruleset-optimization" [ "none" | "basic" | "profile" ]] | 3195 [ "optimization" [ "default" | "normal" | 3196 "high-latency" | "satellite" | 3197 "aggressive" | "conservative" ] ] 3198 [ "limit" ( limit-item | "{" limit-list "}" ) ] | 3199 [ "loginterface" ( interface-name | "none" ) ] | 3200 [ "block-policy" ( "drop" | "return" ) ] | 3201 [ "state-policy" ( "if-bound" | "floating" ) ] 3202 [ "state-defaults" state-opts ] 3203 [ "require-order" ( "yes" | "no" ) ] 3204 [ "fingerprints" filename ] | 3205 [ "skip on" ifspec ] | 3206 [ "debug" ( "none" | "urgent" | "misc" | "loud" ) ] 3207 [ "keepcounters" ] ) 3208 3209ether-rule = "ether" etheraction [ ( "in" | "out" ) ] 3210 [ "quick" ] [ "on" ifspec ] [ "bridge-to" interface-name ] 3211 [ etherprotospec ] etherhosts [ "l3" hosts ] 3212 [ etherfilteropt-list ] 3213 3214pf-rule = action [ ( "in" | "out" ) ] 3215 [ "log" [ "(" logopts ")"] ] [ "quick" ] 3216 [ "on" ifspec ] [ route ] [ af ] [ protospec ] 3217 hosts [ filteropt-list ] 3218 3219logopts = logopt [ "," logopts ] 3220logopt = "all" | "user" | "to" interface-name 3221 3222etherfilteropt-list = etherfilteropt-list etherfilteropt | etherfilteropt 3223etherfilteropt = "tag" string | "tagged" string | "queue" ( string ) | 3224 "ridentifier" number | "label" string 3225 3226filteropt-list = filteropt-list filteropt | filteropt 3227filteropt = user | group | flags | icmp-type | icmp6-type | "tos" tos | 3228 ( "no" | "keep" | "modulate" | "synproxy" ) "state" 3229 [ "(" state-opts ")" ] | 3230 "fragment" | "no-df" | "min-ttl" number | "set-tos" tos | 3231 "max-mss" number | "random-id" | "reassemble tcp" | 3232 fragmentation | "allow-opts" | 3233 "label" string | "tag" string | [ ! ] "tagged" string | 3234 "set prio" ( number | "(" number [ [ "," ] number ] ")" ) | 3235 "queue" ( string | "(" string [ [ "," ] string ] ")" ) | 3236 "rtable" number | "probability" number"%" | "prio" number | 3237 "dnpipe" ( number | "(" number "," number ")" ) | 3238 "dnqueue" ( number | "(" number "," number ")" ) | 3239 "ridentifier" number | 3240 "received-on" ( interface-name | interface-group ) 3241 3242nat-rule = [ "no" ] "nat" [ "pass" [ "log" [ "(" logopts ")" ] ] ] 3243 [ "on" ifspec ] [ af ] 3244 [ protospec ] hosts [ "tag" string ] [ "tagged" string ] 3245 [ "-\*(Gt" ( redirhost | "{" redirhost-list "}" ) 3246 [ portspec ] [ pooltype ] [ "static-port" ] 3247 [ "map-e-portset" number "/" number "/" number ] ] 3248 3249binat-rule = [ "no" ] "binat" [ "pass" [ "log" [ "(" logopts ")" ] ] ] 3250 [ "on" interface-name ] [ af ] 3251 [ "proto" ( proto-name | proto-number ) ] 3252 "from" address [ "/" mask-bits ] "to" ipspec 3253 [ "tag" string ] [ "tagged" string ] 3254 [ "-\*(Gt" address [ "/" mask-bits ] ] 3255 3256rdr-rule = [ "no" ] "rdr" [ "pass" [ "log" [ "(" logopts ")" ] ] ] 3257 [ "on" ifspec ] [ af ] 3258 [ protospec ] hosts [ "tag" string ] [ "tagged" string ] 3259 [ "-\*(Gt" ( redirhost | "{" redirhost-list "}" ) 3260 [ portspec ] [ pooltype ] ] 3261 3262antispoof-rule = "antispoof" [ "log" ] [ "quick" ] 3263 "for" ifspec [ af ] [ "label" string ] 3264 [ "ridentifier" number ] 3265 3266table-rule = "table" "\*(Lt" string "\*(Gt" [ tableopts-list ] 3267tableopts-list = tableopts-list tableopts | tableopts 3268tableopts = "persist" | "const" | "counters" | "file" string | 3269 "{" [ tableaddr-list ] "}" 3270tableaddr-list = tableaddr-list [ "," ] tableaddr-spec | tableaddr-spec 3271tableaddr-spec = [ "!" ] tableaddr [ "/" mask-bits ] 3272tableaddr = hostname | ifspec | "self" | 3273 ipv4-dotted-quad | ipv6-coloned-hex 3274 3275altq-rule = "altq on" interface-name queueopts-list 3276 "queue" subqueue 3277queue-rule = "queue" string [ "on" interface-name ] queueopts-list 3278 subqueue 3279 3280anchor-rule = "anchor" [ string ] [ ( "in" | "out" ) ] [ "on" ifspec ] 3281 [ af ] [ protospec ] [ hosts ] [ filteropt-list ] [ "{" ] 3282 3283anchor-close = "}" 3284 3285trans-anchors = ( "nat-anchor" | "rdr-anchor" | "binat-anchor" ) string 3286 [ "on" ifspec ] [ af ] [ "proto" ] [ protospec ] [ hosts ] 3287 3288load-anchor = "load anchor" string "from" filename 3289 3290queueopts-list = queueopts-list queueopts | queueopts 3291queueopts = [ "bandwidth" bandwidth-spec ] | 3292 [ "qlimit" number ] | [ "tbrsize" number ] | 3293 [ "priority" number ] | [ schedulers ] 3294schedulers = ( cbq-def | priq-def | hfsc-def ) 3295bandwidth-spec = "number" ( "b" | "Kb" | "Mb" | "Gb" | "%" ) 3296 3297etheraction = "pass" | "block" 3298action = "pass" | "match" | "block" [ return ] | [ "no" ] "scrub" 3299return = "drop" | "return" | "return-rst" [ "( ttl" number ")" ] | 3300 "return-icmp" [ "(" icmpcode [ [ "," ] icmp6code ] ")" ] | 3301 "return-icmp6" [ "(" icmp6code ")" ] 3302icmpcode = ( icmp-code-name | icmp-code-number ) 3303icmp6code = ( icmp6-code-name | icmp6-code-number ) 3304 3305ifspec = ( [ "!" ] ( interface-name | interface-group ) ) | 3306 "{" interface-list "}" 3307interface-list = [ "!" ] ( interface-name | interface-group ) 3308 [ [ "," ] interface-list ] 3309route = ( "route-to" | "reply-to" | "dup-to" ) 3310 ( routehost | "{" routehost-list "}" ) 3311 [ pooltype ] 3312af = "inet" | "inet6" 3313 3314etherprotospec = "proto" ( proto-number | "{" etherproto-list "}" ) 3315etherproto-list = proto-number [ [ "," ] etherproto-list ] 3316protospec = "proto" ( proto-name | proto-number | 3317 "{" proto-list "}" ) 3318proto-list = ( proto-name | proto-number ) [ [ "," ] proto-list ] 3319 3320etherhosts = "from" macaddress "to" macaddress 3321macaddress = mac | mac "/" masklen | mac "&" mask 3322 3323hosts = "all" | 3324 "from" ( "any" | "no-route" | "urpf-failed" | "self" | host | 3325 "{" host-list "}" ) [ port ] [ os ] 3326 "to" ( "any" | "no-route" | "self" | host | 3327 "{" host-list "}" ) [ port ] 3328 3329ipspec = "any" | host | "{" host-list "}" 3330host = [ "!" ] ( address [ "/" mask-bits ] | "\*(Lt" string "\*(Gt" ) 3331redirhost = address [ "/" mask-bits ] 3332routehost = "(" interface-name [ address [ "/" mask-bits ] ] ")" 3333address = ( interface-name | interface-group | 3334 "(" ( interface-name | interface-group ) ")" | 3335 hostname | ipv4-dotted-quad | ipv6-coloned-hex ) 3336host-list = host [ [ "," ] host-list ] 3337redirhost-list = redirhost [ [ "," ] redirhost-list ] 3338routehost-list = routehost [ [ "," ] routehost-list ] 3339 3340port = "port" ( unary-op | binary-op | "{" op-list "}" ) 3341portspec = "port" ( number | name ) [ ":" ( "*" | number | name ) ] 3342os = "os" ( os-name | "{" os-list "}" ) 3343user = "user" ( unary-op | binary-op | "{" op-list "}" ) 3344group = "group" ( unary-op | binary-op | "{" op-list "}" ) 3345 3346unary-op = [ "=" | "!=" | "\*(Lt" | "\*(Le" | "\*(Gt" | "\*(Ge" ] 3347 ( name | number ) 3348binary-op = number ( "\*(Lt\*(Gt" | "\*(Gt\*(Lt" | ":" ) number 3349op-list = ( unary-op | binary-op ) [ [ "," ] op-list ] 3350 3351os-name = operating-system-name 3352os-list = os-name [ [ "," ] os-list ] 3353 3354flags = "flags" ( [ flag-set ] "/" flag-set | "any" ) 3355flag-set = [ "F" ] [ "S" ] [ "R" ] [ "P" ] [ "A" ] [ "U" ] [ "E" ] 3356 [ "W" ] 3357 3358icmp-type = "icmp-type" ( icmp-type-code | "{" icmp-list "}" ) 3359icmp6-type = "icmp6-type" ( icmp-type-code | "{" icmp-list "}" ) 3360icmp-type-code = ( icmp-type-name | icmp-type-number ) 3361 [ "code" ( icmp-code-name | icmp-code-number ) ] 3362icmp-list = icmp-type-code [ [ "," ] icmp-list ] 3363 3364tos = ( "lowdelay" | "throughput" | "reliability" | 3365 [ "0x" ] number ) 3366 3367state-opts = state-opt [ [ "," ] state-opts ] 3368state-opt = ( "max" number | "no-sync" | timeout | "sloppy" | 3369 "source-track" [ ( "rule" | "global" ) ] | 3370 "max-src-nodes" number | "max-src-states" number | 3371 "max-src-conn" number | 3372 "max-src-conn-rate" number "/" number | 3373 "overload" "\*(Lt" string "\*(Gt" [ "flush" ] | 3374 "if-bound" | "floating" | "pflow" ) 3375 3376fragmentation = [ "fragment reassemble" ] 3377 3378timeout-list = timeout [ [ "," ] timeout-list ] 3379timeout = ( "tcp.first" | "tcp.opening" | "tcp.established" | 3380 "tcp.closing" | "tcp.finwait" | "tcp.closed" | 3381 "sctp.first" | "sctp.opening" | "sctp.established" | 3382 "sctp.closing" | "sctp.closed" | 3383 "udp.first" | "udp.single" | "udp.multiple" | 3384 "icmp.first" | "icmp.error" | 3385 "other.first" | "other.single" | "other.multiple" | 3386 "frag" | "interval" | "src.track" | 3387 "adaptive.start" | "adaptive.end" ) number 3388 3389limit-list = limit-item [ [ "," ] limit-list ] 3390limit-item = ( "states" | "frags" | "src-nodes" ) number 3391 3392pooltype = ( "bitmask" | "random" | 3393 "source-hash" [ ( hex-key | string-key ) ] | 3394 "round-robin" ) [ sticky-address ] 3395 3396subqueue = string | "{" queue-list "}" 3397queue-list = string [ [ "," ] string ] 3398cbq-def = "cbq" [ "(" cbq-opt [ [ "," ] cbq-opt ] ")" ] 3399priq-def = "priq" [ "(" priq-opt [ [ "," ] priq-opt ] ")" ] 3400hfsc-def = "hfsc" [ "(" hfsc-opt [ [ "," ] hfsc-opt ] ")" ] 3401cbq-opt = ( "default" | "borrow" | "red" | "ecn" | "rio" ) 3402priq-opt = ( "default" | "red" | "ecn" | "rio" ) 3403hfsc-opt = ( "default" | "red" | "ecn" | "rio" | 3404 linkshare-sc | realtime-sc | upperlimit-sc ) 3405linkshare-sc = "linkshare" sc-spec 3406realtime-sc = "realtime" sc-spec 3407upperlimit-sc = "upperlimit" sc-spec 3408sc-spec = ( bandwidth-spec | 3409 "(" bandwidth-spec number bandwidth-spec ")" ) 3410include = "include" filename 3411.Ed 3412.Sh FILES 3413.Bl -tag -width "/etc/protocols" -compact 3414.It Pa /etc/hosts 3415Host name database. 3416.It Pa /etc/pf.conf 3417Default location of the ruleset file. 3418The file has to be created manually as it is not installed with a 3419standard installation. 3420.It Pa /etc/pf.os 3421Default location of OS fingerprints. 3422.It Pa /etc/protocols 3423Protocol name database. 3424.It Pa /etc/services 3425Service name database. 3426.El 3427.Sh SEE ALSO 3428.Xr altq 4 , 3429.Xr carp 4 , 3430.Xr icmp 4 , 3431.Xr icmp6 4 , 3432.Xr ip 4 , 3433.Xr ip6 4 , 3434.Xr pf 4 , 3435.Xr pflow 4 , 3436.Xr pfsync 4 , 3437.Xr tcp 4 , 3438.Xr sctp 4 , 3439.Xr udp 4 , 3440.Xr hosts 5 , 3441.Xr pf.os 5 , 3442.Xr protocols 5 , 3443.Xr services 5 , 3444.Xr ftp-proxy 8 , 3445.Xr pfctl 8 , 3446.Xr pflogd 8 3447.Sh HISTORY 3448The 3449.Nm 3450file format first appeared in 3451.Ox 3.0 . 3452