LEXICAL CONVENTIONS¶

Input is parsed line-wise. When the last character of a line, just before the newline character, is a non-quoted backslash (\), the next line is treated as a continuation. Multiple commands on the same line can be separated using a semicolon (;).

A hash sign (#) begins a comment. All following characters on the same line are ignored.

Identifiers begin with an alphabetic character (a-z,A-Z), followed zero or more alphanumeric characters (a-z,A-Z,0-9) and the characters slash (/), backslash (\), underscore (_) and dot (.). Identifiers using different characters or clashing with a keyword need to be enclosed in double quotes (").

INCLUDE FILES¶

include
filename

Other files can be included by using the include statement. The directories to be searched for include files can be specified using the -I/--includepath option. You can override this behaviour either by prepending ./ to your path to force inclusion of files located in the current working directory (ie. relative path) or / for file location expressed as an absolute path.

If -I/--includepath is not specified, then nft relies on the default directory that is specified at compile time. You can retrieve this default directory via -h/--help option.

Include statements support the usual shell wildcard symbols (*,?,[]). Having no matches for an include statement is not an error, if wildcard symbols are used in the include statement. This allows having potentially empty include directories for statements like include "/etc/firewall/rules/*". The wildcard matches are loaded in alphabetical order. Files beginning with dot (.) are not matched by include statements.

SYMBOLIC VARIABLES¶

define
variable expr

$variable

Symbolic variables can be defined using the define statement. Variable references are expressions and can be used initialize other variables. The scope of a definition is the current block and all blocks contained within.

Using symbolic variables

define int_if1 = eth0
define int_if2 = eth1
define int_ifs = { $int_if1, $int_if2 }
filter input iif $int_ifs accept
					

IPV4/IPV6/INET ADDRESS FAMILIES¶

The IPv4/IPv6/Inet address families handle IPv4, IPv6 or both types of packets. They contain five hooks at different packet processing stages in the network stack.

IPv4/IPv6/Inet address family hooks

ARP ADDRESS FAMILY¶

The ARP address family handles ARP packets received and sent by the system. It is commonly used to mangle ARP packets for clustering.

ARP address family hooks

BRIDGE ADDRESS FAMILY¶

The bridge address family handles ethernet packets traversing bridge devices.

The list of supported hooks is identical to IPv4/IPv6/Inet address families above.

NETDEV ADDRESS FAMILY¶

The Netdev address family handles packets from ingress.

Netdev address family hooks

CT¶

ct
{helper} {type} {type} {protocol} {protocol} [l3proto] [family]

Ct helper is used to define connection tracking helpers that can then be used in combination with the "ct helper set" statement. type and protocol are mandatory, l3proto is derived from the table family by default, i.e. in the inet table the kernel will try to load both the ipv4 and ipv6 helper backends, if they are supported by the kernel.

conntrack helper specifications

defining and assigning ftp helper

Unlike iptables, helper assignment needs to be performed after the conntrack lookup has completed, for example with the default 0 hook priority.

table inet myhelpers {


  ct helper ftp-standard {


     type "ftp" protocol tcp


  }


  chain prerouting {


      type filter hook prerouting priority 0;


      tcp dport 21 ct helper set "ftp-standard"


  }
}
				

COUNTER¶

counter
[packets bytes]

Counter specifications

QUOTA¶

quota
[over | until] [used]

Quota specifications

DESCRIBE COMMAND¶

describe
{expression}

The describe command shows information about the type of an expression and its data type.

The describe command

$ nft describe tcp flags
payload expression, datatype tcp_flag (TCP flag) (basetype bitmask, integer), 8 bits
pre-defined symbolic constants:
fin                           	0x01
syn                           	0x02
rst                           	0x04
psh                           	0x08
ack                           	0x10
urg                           	0x20
ecn                           	0x40
cwr                           	0x80
				

INTEGER TYPE¶

The integer type is used for numeric values. It may be specified as decimal, hexadecimal or octal number. The integer type doesn't have a fixed size, its size is determined by the expression for which it is used.

BITMASK TYPE¶

The bitmask type (bitmask) is used for bitmasks.

STRING TYPE¶

The string type is used to for character strings. A string begins with an alphabetic character (a-zA-Z) followed by zero or more alphanumeric characters or the characters /, -, _ and .. In addition anything enclosed in double quotes (") is recognized as a string.

String specification

# Interface name
filter input iifname eth0
# Weird interface name
filter input iifname "(eth0)"
				

LINK LAYER ADDRESS TYPE¶

The link layer address type is used for link layer addresses. Link layer addresses are specified as a variable amount of groups of two hexadecimal digits separated using colons (:).

Link layer address specification

# Ethernet destination MAC address
filter input ether daddr 20:c9:d0:43:12:d9
				

IPV4 ADDRESS TYPE¶

The IPv4 address type is used for IPv4 addresses. Addresses are specified in either dotted decimal, dotted hexadecimal, dotted octal, decimal, hexadecimal, octal notation or as a host name. A host name will be resolved using the standard system resolver.

IPv4 address specification

# dotted decimal notation
filter output ip daddr 127.0.0.1
# host name
filter output ip daddr localhost
				

IPV6 ADDRESS TYPE¶

The IPv6 address type is used for IPv6 addresses. FIXME

IPv6 address specification

# abbreviated loopback address
filter output ip6 daddr ::1
				

BOOLEAN TYPE¶

The boolean type is a syntactical helper type in user space. It's use is in the right-hand side of a (typically implicit) relational expression to change the expression on the left-hand side into a boolean check (usually for existence).

The following keywords will automatically resolve into a boolean type with given value:

Boolean specification

The following expressions support a boolean comparison:

# match if route exists
filter input fib daddr . iif oif exists
# match only non-fragmented packets in IPv6 traffic
filter input exthdr frag missing
# match if TCP timestamp option is present
filter input tcp option timestamp exists
				

ICMP TYPE TYPE¶

The ICMP Type type is used to conveniently specify the ICMP header's type field.

The following keywords may be used when specifying the ICMP type:

ICMP Type specification

# match ping packets
filter output icmp type { echo-request, echo-reply }
				

ICMP CODE TYPE¶

The ICMP Code type is used to conveniently specify the ICMP header's code field.

The following keywords may be used when specifying the ICMP code:

ICMPV6 TYPE TYPE¶

The ICMPv6 Type type is used to conveniently specify the ICMPv6 header's type field.

The following keywords may be used when specifying the ICMPv6 type:

ICMPv6 Type specification

# match ICMPv6 ping packets
filter output icmpv6 type { echo-request, echo-reply }
				

ICMPV6 CODE TYPE¶

The ICMPv6 Code type is used to conveniently specify the ICMPv6 header's code field.

The following keywords may be used when specifying the ICMPv6 code:

ICMPVX CODE TYPE¶

The ICMPvX Code type abstraction is a set of values which overlap between ICMP and ICMPv6 Code types to be used from the inet family.

The following keywords may be used when specifying the ICMPvX code:

CONNTRACK TYPES¶

This is an overview of types used in ct expression and statement:

For each of the types above, keywords are available for convenience:

conntrack state (ct_state)

conntrack direction (ct_dir)

conntrack status (ct_status)

conntrack event bits (ct_event)

Possible keywords for conntrack label type (ct_label) are read at runtime from /etc/connlabel.conf.

META EXPRESSIONS¶

meta
{length | nfproto | l4proto | protocol | priority}

[meta] {mark | iif | iifname | iiftype | oif | oifname | oiftype | skuid | skgid | nftrace | rtclassid | ibriport | obriport | pkttype | cpu | iifgroup | oifgroup | cgroup | random}

A meta expression refers to meta data associated with a packet.

There are two types of meta expressions: unqualified and qualified meta expressions. Qualified meta expressions require the meta keyword before the meta key, unqualified meta expressions can be specified by using the meta key directly or as qualified meta expressions.

Meta expression types

Meta expression specific types

Using meta expressions

# qualified meta expression
filter output meta oif eth0
# unqualified meta expression
filter output oif eth0
					

FIB EXPRESSIONS¶

fib
{saddr | daddr | [mark | iif | oif]} {oif | oifname | type}

A fib expression queries the fib (forwarding information base) to obtain information such as the output interface index a particular address would use. The input is a tuple of elements that is used as input to the fib lookup functions.

fib expression specific types

Using fib expressions

# drop packets without a reverse path
filter prerouting fib saddr . iif oif missing drop
# drop packets to address not configured on ininterface
filter prerouting fib daddr . iif type != { local, broadcast, multicast } drop
# perform lookup in a specific 'blackhole' table (0xdead, needs ip appropriate ip rule)
filter prerouting meta mark set 0xdead fib daddr . mark type vmap { blackhole : drop, prohibit : jump prohibited, unreachable : drop }
					

ROUTING EXPRESSIONS¶

rt
{classid | nexthop}

A routing expression refers to routing data associated with a packet.

Routing expression types

Routing expression specific types

Using routing expressions

# IP family independent rt expression
filter output rt classid 10
# IP family dependent rt expressions
ip filter output rt nexthop 192.168.0.1
ip6 filter output rt nexthop fd00::1
inet filter output rt ip nexthop 192.168.0.1
inet filter output rt ip6 nexthop fd00::1
					

ETHERNET HEADER EXPRESSION¶

ether
[ethernet header field]

Ethernet header expression types

VLAN HEADER EXPRESSION¶

vlan
[VLAN header field]

VLAN header expression

ARP HEADER EXPRESSION¶

arp
[ARP header field]

ARP header expression

IPV4 HEADER EXPRESSION¶

ip
[IPv4 header field]

IPv4 header expression

ICMP HEADER EXPRESSION¶

icmp
[ICMP header field]

ICMP header expression

IPV6 HEADER EXPRESSION¶

ip6
[IPv6 header field]

IPv6 header expression

ICMPV6 HEADER EXPRESSION¶

icmpv6
[ICMPv6 header field]

ICMPv6 header expression

TCP HEADER EXPRESSION¶

tcp
[TCP header field]

TCP header expression

UDP HEADER EXPRESSION¶

udp
[UDP header field]

UDP header expression

UDP-LITE HEADER EXPRESSION¶

udplite
[UDP-Lite header field]

UDP-Lite header expression

SCTP HEADER EXPRESSION¶

sctp
[SCTP header field]

SCTP header expression

DCCP HEADER EXPRESSION¶

dccp
[DCCP header field]

DCCP header expression

AUTHENTICATION HEADER EXPRESSION¶

ah
[AH header field]

AH header expression

ENCRYPTED SECURITY PAYLOAD HEADER EXPRESSION¶

esp
[ESP header field]

ESP header expression

IPCOMP HEADER EXPRESSION¶

comp
[IPComp header field]

IPComp header expression

EXTENSION HEADER EXPRESSIONS¶

Extension header expressions refer to data from variable-sized protocol headers, such as IPv6 extension headers and TCPs options.

nftables currently supports matching (finding) a given ipv6 extension header or TCP option.
hbh
{nexthdr | hdrlength}

frag
{nexthdr | frag-off | more-fragments | id}

rt
{nexthdr | hdrlength | type | seg-left}

dst
{nexthdr | hdrlength}

mh
{nexthdr | hdrlength | checksum | type}

tcp option
{eol | noop | maxseg | window | sack-permitted | sack | sack0 | sack1 | sack2 | sack3 | timestamp} tcp_option_field

The following syntaxes are valid only in a relational expression with boolean type on right-hand side for checking header existence only:
exthdr
{hbh | frag | rt | dst | mh}

tcp option
{eol | noop | maxseg | window | sack-permitted | sack | sack0 | sack1 | sack2 | sack3 | timestamp}

IPv6 extension headers

TCP Options

finding TCP options

filter input tcp option sack-permitted kind 1 counter
					

matching IPv6 exthdr

ip6 filter input frag more-fragments 1 counter
					

CONNTRACK EXPRESSIONS¶

Conntrack expressions refer to meta data of the connection tracking entry associated with a packet.

There are three types of conntrack expressions. Some conntrack expressions require the flow direction before the conntrack key, others must be used directly because they are direction agnostic. The packets, bytes and avgpkt keywords can be used with or without a direction. If the direction is omitted, the sum of the original and the reply direction is returned. The same is true for the zone, if a direction is given, the zone is only matched if the zone id is tied to the given direction.

ct
{state | direction | status | mark | expiration | helper | label | l3proto | protocol | bytes | packets | avgpkt | zone}

ct
{original | reply} {l3proto | protocol | proto-src | proto-dst | bytes | packets | avgpkt | zone}

ct
{original | reply} {ip | ip6} {saddr | daddr}

Conntrack expressions

A description of conntrack-specific types listed above can be found sub-section CONNTRACK TYPES above.

VERDICT STATEMENT¶

The verdict statement alters control flow in the ruleset and issues policy decisions for packets.

{accept | drop | queue | continue | return}
{jump | goto} {chain}

accept

Terminate ruleset evaluation and accept the packet.

drop

Terminate ruleset evaluation and drop the packet.

queue

Terminate ruleset evaluation and queue the packet to userspace.

continue

Continue ruleset evaluation with the next rule. FIXME

return

Return from the current chain and continue evaluation at the next rule in the last chain. If issued in a base chain, it is equivalent to accept.

jump chain

Continue evaluation at the first rule in chain. The current position in the ruleset is pushed to a call stack and evaluation will continue there when the new chain is entirely evaluated of a return verdict is issued.

goto chain

Similar to jump, but the current position is not pushed to the call stack, meaning that after the new chain evaluation will continue at the last chain instead of the one containing the goto statement.

Verdict statements

# process packets from eth0 and the internal network in from_lan
# chain, drop all packets from eth0 with different source addresses.
filter input iif eth0 ip saddr 192.168.0.0/24 jump from_lan
filter input iif eth0 drop
					

PAYLOAD STATEMENT¶

The payload statement alters packet content. It can be used for example to set ip DSCP (differv) header field or ipv6 flow labels.

route some packets instead of bridging

# redirect tcp:http from 192.160.0.0/16 to local machine for routing instead of bridging
# assumes 00:11:22:33:44:55 is local MAC address.
bridge input meta iif eth0 ip saddr 192.168.0.0/16 tcp dport 80 meta pkttype set unicast ether daddr set 00:11:22:33:44:55
					

Set IPv4 DSCP header field

ip forward ip dscp set 42
					

EXTENSION HEADER STATEMENT¶

The extension header statement alters packet content in variable-sized headers. This can currently be used to alter the TCP Maximum segment size of packets, similar to TCPMSS.

change tcp mss

tcp flags syn tcp option maxseg size set 1360
# set a size based on route information:
tcp flags syn tcp option maxseg size set rt mtu
					

LOG STATEMENT¶

log
[prefix quoted_string] [level syslog-level] [flags log-flags]

log
group nflog_group [prefix quoted_string] [queue-threshold value] [snaplen size]

The log statement enables logging of matching packets. When this statement is used from a rule, the Linux kernel will print some information on all matching packets, such as header fields, via the kernel log (where it can be read with dmesg(1) or read in the syslog). If the group number is specified, the Linux kernel will pass the packet to nfnetlink_log which will multicast the packet through a netlink socket to the specified multicast group. One or more userspace processes may subscribe to the group to receive the packets, see libnetfilter_queue documentation for details. This is a non-terminating statement, so the rule evaluation continues after the packet is logged.

log statement options

log-flags

Using log statement

# log the UID which generated the packet and ip options
ip filter output log flags skuid flags ip options
# log the tcp sequence numbers and tcp options from the TCP packet
ip filter output log flags tcp sequence,options
# enable all supported log flags
ip6 filter output log flags all
					

REJECT STATEMENT¶

reject
[ with {icmp | icmpv6 | icmpx} type {icmp_code | icmpv6_code | icmpx_code} ]

reject
[ with {tcp} {reset} ]

A reject statement is used to send back an error packet in response to the matched packet otherwise it is equivalent to drop so it is a terminating statement, ending rule traversal. This statement is only valid in the input, forward and output chains, and user-defined chains which are only called from those chains.

The different ICMP reject variants are meant for use in different table families:

For a description of the different types and a list of supported keywords refer to DATA TYPES section above. The common default reject value is port-unreachable.

COUNTER STATEMENT¶

A counter statement sets the hit count of packets along with the number of bytes.

counter
{packets number } {bytes number }

CONNTRACK STATEMENT¶

The conntrack statement can be used to set the conntrack mark and conntrack labels.

ct
{mark | event | label | zone} set value

The ct statement sets meta data associated with a connection. The zone id has to be assigned before a conntrack lookup takes place, i.e. this has to be done in prerouting and possibly output (if locally generated packets need to be placed in a distinct zone), with a hook priority of -300.

Conntrack statement types

save packet nfmark in conntrack

ct mark set meta mark
					

set zone mapped via interface

table inet raw {


  chain prerouting {


      type filter hook prerouting priority -300;


      ct zone set iif map { "eth1" : 1, "veth1" : 2 }


  }


  chain output {


      type filter hook output priority -300;


      ct zone set oif map { "eth1" : 1, "veth1" : 2 }


  }
}
				

restrict events reported by ctnetlink

ct event set new,related,destroy
				

META STATEMENT¶

A meta statement sets the value of a meta expression. The existing meta fields are: priority, mark, pkttype, nftrace.

meta
{mark | priority | pkttype | nftrace} set value

A meta statement sets meta data associated with a packet.

Meta statement types

LIMIT STATEMENT¶

limit
rate [over] packet_number / {second | minute | hour | day} [burst packet_number packets]

limit
rate [over] byte_number {bytes | kbytes | mbytes} / {second | minute | hour | day | week} [burst byte_number bytes]

A limit statement matches at a limited rate using a token bucket filter. A rule using this statement will match until this limit is reached. It can be used in combination with the log statement to give limited logging. The over keyword, that is optional, makes it match over the specified rate.

limit statement values

NAT STATEMENTS¶

snat
to address [:port] [persistent, random, fully-random]

snat
to address - address [:port - port] [persistent, random, fully-random]

dnat
to address [:port] [persistent, random, fully-random]

dnat
to address [:port - port] [persistent, random, fully-random]

masquerade
to [:port] [persistent, random, fully-random]

masquerade
to [:port - port] [persistent, random, fully-random]

redirect
to [:port] [persistent, random, fully-random]

redirect
to [:port - port] [persistent, random, fully-random]

The nat statements are only valid from nat chain types.

The snat and masquerade statements specify that the source address of the packet should be modified. While snat is only valid in the postrouting and input chains, masquerade makes sense only in postrouting. The dnat and redirect statements are only valid in the prerouting and output chains, they specify that the destination address of the packet should be modified. You can use non-base chains which are called from base chains of nat chain type too. All future packets in this connection will also be mangled, and rules should cease being examined.

The masquerade statement is a special form of snat which always uses the outgoing interface's IP address to translate to. It is particularly useful on gateways with dynamic (public) IP addresses.

The redirect statement is a special form of dnat which always translates the destination address to the local host's one. It comes in handy if one only wants to alter the destination port of incoming traffic on different interfaces.

Note that all nat statements require both prerouting and postrouting base chains to be present since otherwise packets on the return path won't be seen by netfilter and therefore no reverse translation will take place.

NAT statement values

NAT statement flags

Using NAT statements

# create a suitable table/chain setup for all further examples
add table nat
add chain nat prerouting { type nat hook prerouting priority 0; }
add chain nat postrouting { type nat hook postrouting priority 100; }
# translate source addresses of all packets leaving via eth0 to address 1.2.3.4
add rule nat postrouting oif eth0 snat to 1.2.3.4
# redirect all traffic entering via eth0 to destination address 192.168.1.120
add rule nat prerouting iif eth0 dnat to 192.168.1.120
# translate source addresses of all packets leaving via eth0 to whatever
# locally generated packets would use as source to reach the same destination
add rule nat postrouting oif eth0 masquerade
# redirect incoming TCP traffic for port 22 to port 2222
add rule nat prerouting tcp dport 22 redirect to :2222
					

QUEUE STATEMENT¶

This statement passes the packet to userspace using the nfnetlink_queue handler. The packet is put into the queue identified by its 16-bit queue number. Userspace can inspect and modify the packet if desired. Userspace must then drop or reinject the packet into the kernel. See libnetfilter_queue documentation for details.

queue
[num queue_number] [bypass]

queue
[num queue_number_from - queue_number_to] [bypass,fanout]

queue statement values

queue statement flags

MAP STATEMENT¶

The map statement is used to lookup data based on some specific input key.

expression map { key : value [ , key : value ]... }

using the map statement

# select DNAT target based on TCP dport:
# connections to port 80 are redirected to 192.168.1.100,
# connections to port 8888 are redirected to 192.168.1.101
nft add rule ip nat prerouting dnat tcp dport map { 80 : 192.168.1.100, 8888 : 192.168.1.101 }
# source address based SNAT:
# packets from net 192.168.1.0/24 will appear as originating from 10.0.0.1,
# packets from net 192.168.2.0/24 will appear as originating from 10.0.0.2
nft add rule ip nat postrouting snat to ip saddr map { 192.168.1.0/24 : 10.0.0.1, 192.168.2.0/24 : 10.0.0.2 }
				

VMAP STATEMENT¶

The verdict map (vmap) statement works analogous to the map statement, but contains verdicts as values.

expression vmap { key : value [ , key : value ]... }

using the vmap statement

# jump to different chains depending on layer 4 protocol type:
nft add rule ip filter input ip protocol vmap { tcp : jump tcp-chain, udp : jump udp-chain , icmp : jump icmp-chain }
				

MONITOR¶

The monitor command allows you to listen to Netlink events produced by the nf_tables subsystem, related to creation and deletion of objects. When they occur, nft will print to stdout the monitored events in either XML, JSON or native nft format.

To filter events related to a concrete object, use one of the keywords 'tables', 'chains', 'sets', 'rules', 'elements' , 'ruleset'.

To filter events related to a concrete action, use keyword 'new' or 'destroy'.

Hit ^C to finish the monitor operation.

Listen to all events, report in native nft format

% nft monitor
				

Listen to added tables, report in XML format

% nft monitor new tables xml
				

Listen to deleted rules, report in JSON format

% nft monitor destroy rules json
				

Listen to both new and destroyed chains, in native nft format

% nft monitor chains
				

Listen to ruleset events such as table, chain, rule, set, counters and quotas, in native nft format

% nft monitor ruleset