1iptables-extensions(8) iptables 1.8.0 iptables-extensions(8)
2
6 iptables-extensions — list of extensions in the standard iptables dis‐
7 tribution
8
10 ip6tables [-m name [module-options...]] [-j target-name [target-
11 options...]
12 iptables [-m name [module-options...]] [-j target-name [target-
14 options...]
15
17 iptables can use extended packet matching modules with the -m or
18 --match options, followed by the matching module name; after these,
19 various extra command line options become available, depending on the
20 specific module. You can specify multiple extended match modules in
21 one line, and you can use the -h or --help options after the module has
22 been specified to receive help specific to that module. The extended
23 match modules are evaluated in the order they are specified in the
24 rule.
25 If the -p or --protocol was specified and if and only if an unknown
27 option is encountered, iptables will try load a match module of the
28 same name as the protocol, to try making the option available.
29 addrtype
31 This module matches packets based on their address type. Address types
32 are used within the kernel networking stack and categorize addresses
33 into various groups. The exact definition of that group depends on the
34 specific layer three protocol.
35 The following address types are possible:
37 UNSPEC an unspecified address (i.e. 0.0.0.0)
39 UNICAST
41 an unicast address
42 LOCAL a local address
44 BROADCAST
46 a broadcast address
47 ANYCAST
49 an anycast packet
50 MULTICAST
52 a multicast address
53 BLACKHOLE
55 a blackhole address
56 UNREACHABLE
58 an unreachable address
59 PROHIBIT
61 a prohibited address
62 THROW FIXME
64 NAT FIXME
66 XRESOLVE
68 [!] --src-type type
70 Matches if the source address is of given type
71 [!] --dst-type type
73 Matches if the destination address is of given type
74 --limit-iface-in
76 The address type checking can be limited to the interface the
77 packet is coming in. This option is only valid in the PREROUT‐
78 ING, INPUT and FORWARD chains. It cannot be specified with the
79 --limit-iface-out option.
80 --limit-iface-out
82 The address type checking can be limited to the interface the
83 packet is going out. This option is only valid in the POSTROUT‐
84 ING, OUTPUT and FORWARD chains. It cannot be specified with the
85 --limit-iface-in option.
86 ah (IPv6-specific)
88 This module matches the parameters in Authentication header of IPsec
89 packets.
90 [!] --ahspi spi[:spi]
92 Matches SPI.
93 [!] --ahlen length
95 Total length of this header in octets.
96 --ahres
98 Matches if the reserved field is filled with zero.
99 ah (IPv4-specific)
101 This module matches the SPIs in Authentication header of IPsec packets.
102 [!] --ahspi spi[:spi]
104 bpf
106 Match using Linux Socket Filter. Expects a path to an eBPF object or a
107 cBPF program in decimal format.
108 --object-pinned path
110 Pass a path to a pinned eBPF object.
111 Applications load eBPF programs into the kernel with the bpf() system
113 call and BPF_PROG_LOAD command and can pin them in a virtual filesystem
114 with BPF_OBJ_PIN. To use a pinned object in iptables, mount the bpf
115 filesystem using
116 mount -t bpf bpf ${BPF_MOUNT}
118 then insert the filter in iptables by path:
120 iptables -A OUTPUT -m bpf --object-pinned
122 ${BPF_MOUNT}/{PINNED_PATH} -j ACCEPT
123 --bytecode code
125 Pass the BPF byte code format as generated by the nfbpf_compile
126 utility.
127 The code format is similar to the output of the tcpdump -ddd command:
129 one line that stores the number of instructions, followed by one line
130 for each instruction. Instruction lines follow the pattern 'u16 u8 u8
131 u32' in decimal notation. Fields encode the operation, jump offset if
132 true, jump offset if false and generic multiuse field 'K'. Comments are
133 not supported.
134 For example, to read only packets matching 'ip proto 6', insert the
136 following, without the comments or trailing whitespace:
137 4 # number of instructions
139 48 0 0 9 # load byte ip->proto
140 21 0 1 6 # jump equal IPPROTO_TCP
141 6 0 0 1 # return pass (non-zero)
142 6 0 0 0 # return fail (zero)
143 You can pass this filter to the bpf match with the following command:
145 iptables -A OUTPUT -m bpf --bytecode '4,48 0 0 9,21 0 1 6,6 0 0
147 1,6 0 0 0' -j ACCEPT
148 Or instead, you can invoke the nfbpf_compile utility.
150 iptables -A OUTPUT -m bpf --bytecode "`nfbpf_compile RAW 'ip
152 proto 6'`" -j ACCEPT
153 Or use tcpdump -ddd. In that case, generate BPF targeting a device with
155 the same data link type as the xtables match. Iptables passes packets
156 from the network layer up, without mac layer. Select a device with data
157 link type RAW, such as a tun device:
158 ip tuntap add tun0 mode tun
160 ip link set tun0 up
161 tcpdump -ddd -i tun0 ip proto 6
162 See tcpdump -L -i $dev for a list of known data link types for a given
164 device.
165 You may want to learn more about BPF from FreeBSD's bpf(4) manpage.
167 cgroup
169 [!] --path path
170 Match cgroup2 membership.
171 Each socket is associated with the v2 cgroup of the creating
173 process. This matches packets coming from or going to all sock‐
174 ets in the sub-hierarchy of the specified path. The path should
175 be relative to the root of the cgroup2 hierarchy.
176 [!] --cgroup classid
178 Match cgroup net_cls classid.
179 classid is the marker set through the cgroup net_cls controller.
181 This option and --path can't be used together.
182 Example:
184 iptables -A OUTPUT -p tcp --sport 80 -m cgroup ! --path ser‐
186 vice/http-server -j DROP
187 iptables -A OUTPUT -p tcp --sport 80 -m cgroup ! --cgroup 1 -j
189 DROP
190 IMPORTANT: when being used in the INPUT chain, the cgroup matcher is
192 currently only of limited functionality, meaning it will only match on
193 packets that are processed for local sockets through early socket
194 demuxing. Therefore, general usage on the INPUT chain is not advised
195 unless the implications are well understood.
196 Available since Linux 3.14.
198 cluster
200 Allows you to deploy gateway and back-end load-sharing clusters without
201 the need of load-balancers.
202 This match requires that all the nodes see the same packets. Thus, the
204 cluster match decides if this node has to handle a packet given the
205 following options:
206 --cluster-total-nodes num
208 Set number of total nodes in cluster.
209 [!] --cluster-local-node num
211 Set the local node number ID.
212 [!] --cluster-local-nodemask mask
214 Set the local node number ID mask. You can use this option
215 instead of --cluster-local-node.
216 --cluster-hash-seed value
218 Set seed value of the Jenkins hash.
219 Example:
221 iptables -A PREROUTING -t mangle -i eth1 -m cluster --clus‐
223 ter-total-nodes 2 --cluster-local-node 1 --cluster-hash-seed
224 0xdeadbeef -j MARK --set-mark 0xffff
225 iptables -A PREROUTING -t mangle -i eth2 -m cluster --clus‐
227 ter-total-nodes 2 --cluster-local-node 1 --cluster-hash-seed
228 0xdeadbeef -j MARK --set-mark 0xffff
229 iptables -A PREROUTING -t mangle -i eth1 -m mark ! --mark 0xffff
231 -j DROP
232 iptables -A PREROUTING -t mangle -i eth2 -m mark ! --mark 0xffff
234 -j DROP
235 And the following commands to make all nodes see the same packets:
237 ip maddr add 01:00:5e:00:01:01 dev eth1
239 ip maddr add 01:00:5e:00:01:02 dev eth2
241 arptables -A OUTPUT -o eth1 --h-length 6 -j mangle --mangle-mac-
243 s 01:00:5e:00:01:01
244 arptables -A INPUT -i eth1 --h-length 6 --destination-mac
246 01:00:5e:00:01:01 -j mangle --mangle-mac-d 00:zz:yy:xx:5a:27
247 arptables -A OUTPUT -o eth2 --h-length 6 -j mangle --man‐
249 gle-mac-s 01:00:5e:00:01:02
250 arptables -A INPUT -i eth2 --h-length 6 --destination-mac
252 01:00:5e:00:01:02 -j mangle --mangle-mac-d 00:zz:yy:xx:5a:27
253 NOTE: the arptables commands above use mainstream syntax. If you are
255 using arptables-jf included in some RedHat, CentOS and Fedora versions,
256 you will hit syntax errors. Therefore, you'll have to adapt these to
257 the arptables-jf syntax to get them working.
258 In the case of TCP connections, pickup facility has to be disabled to
260 avoid marking TCP ACK packets coming in the reply direction as valid.
261 echo 0 > /proc/sys/net/netfilter/nf_conntrack_tcp_loose
263 comment
265 Allows you to add comments (up to 256 characters) to any rule.
266 --comment comment
268 Example:
270 iptables -A INPUT -i eth1 -m comment --comment "my local LAN"
271 connbytes
273 Match by how many bytes or packets a connection (or one of the two
274 flows constituting the connection) has transferred so far, or by aver‐
275 age bytes per packet.
276 The counters are 64-bit and are thus not expected to overflow ;)
278 The primary use is to detect long-lived downloads and mark them to be
280 scheduled using a lower priority band in traffic control.
281 The transferred bytes per connection can also be viewed through `con‐
283 ntrack -L` and accessed via ctnetlink.
284 NOTE that for connections which have no accounting information, the
286 match will always return false. The "net.netfilter.nf_conntrack_acct"
287 sysctl flag controls whether new connections will be byte/packet
288 counted. Existing connection flows will not be gaining/losing a/the
289 accounting structure when be sysctl flag is flipped.
290 [!] --connbytes from[:to]
292 match packets from a connection whose packets/bytes/average
293 packet size is more than FROM and less than TO bytes/packets. if
294 TO is omitted only FROM check is done. "!" is used to match
295 packets not falling in the range.
296 --connbytes-dir {original|reply|both}
298 which packets to consider
299 --connbytes-mode {packets|bytes|avgpkt}
301 whether to check the amount of packets, number of bytes trans‐
302 ferred or the average size (in bytes) of all packets received so
303 far. Note that when "both" is used together with "avgpkt", and
304 data is going (mainly) only in one direction (for example HTTP),
305 the average packet size will be about half of the actual data
306 packets.
307 Example:
309 iptables .. -m connbytes --connbytes 10000:100000
310 --connbytes-dir both --connbytes-mode bytes ...
311 connlabel
313 Module matches or adds connlabels to a connection. connlabels are sim‐
314 ilar to connmarks, except labels are bit-based; i.e. all labels may be
315 attached to a flow at the same time. Up to 128 unique labels are cur‐
316 rently supported.
317 [!] --label name
319 matches if label name has been set on a connection. Instead of
320 a name (which will be translated to a number, see EXAMPLE
321 below), a number may be used instead. Using a number always
322 overrides connlabel.conf.
323 --set if the label has not been set on the connection, set it. Note
325 that setting a label can fail. This is because the kernel allo‐
326 cates the conntrack label storage area when the connection is
327 created, and it only reserves the amount of memory required by
328 the ruleset that exists at the time the connection is created.
329 In this case, the match will fail (or succeed, in case --label
330 option was negated).
331 This match depends on libnetfilter_conntrack 1.0.4 or later. Label
333 translation is done via the /etc/xtables/connlabel.conf configuration
334 file.
335 Example:
337 0 eth0-in
339 1 eth0-out
340 2 ppp-in
341 3 ppp-out
342 4 bulk-traffic
343 5 interactive
344 connlimit
346 Allows you to restrict the number of parallel connections to a server
347 per client IP address (or client address block).
348 --connlimit-upto n
350 Match if the number of existing connections is below or equal n.
351 --connlimit-above n
353 Match if the number of existing connections is above n.
354 --connlimit-mask prefix_length
356 Group hosts using the prefix length. For IPv4, this must be a
357 number between (including) 0 and 32. For IPv6, between 0 and
358 128. If not specified, the maximum prefix length for the appli‐
359 cable protocol is used.
360 --connlimit-saddr
362 Apply the limit onto the source group. This is the default if
363 --connlimit-daddr is not specified.
364 --connlimit-daddr
366 Apply the limit onto the destination group.
367 Examples:
369 # allow 2 telnet connections per client host
371 iptables -A INPUT -p tcp --syn --dport 23 -m connlimit
372 --connlimit-above 2 -j REJECT
373 # you can also match the other way around:
375 iptables -A INPUT -p tcp --syn --dport 23 -m connlimit
376 --connlimit-upto 2 -j ACCEPT
377 # limit the number of parallel HTTP requests to 16 per class C sized
379 source network (24 bit netmask)
380 iptables -p tcp --syn --dport 80 -m connlimit --connlimit-above
381 16 --connlimit-mask 24 -j REJECT
382 # limit the number of parallel HTTP requests to 16 for the link local
384 network
385 (ipv6) ip6tables -p tcp --syn --dport 80 -s fe80::/64 -m
386 connlimit --connlimit-above 16 --connlimit-mask 64 -j REJECT
387 # Limit the number of connections to a particular host:
389 ip6tables -p tcp --syn --dport 49152:65535 -d 2001:db8::1 -m
390 connlimit --connlimit-above 100 -j REJECT
391 connmark
393 This module matches the netfilter mark field associated with a connec‐
394 tion (which can be set using the CONNMARK target below).
395 [!] --mark value[/mask]
397 Matches packets in connections with the given mark value (if a
398 mask is specified, this is logically ANDed with the mark before
399 the comparison).
400 conntrack
402 This module, when combined with connection tracking, allows access to
403 the connection tracking state for this packet/connection.
404 [!] --ctstate statelist
406 statelist is a comma separated list of the connection states to
407 match. Possible states are listed below.
408 [!] --ctproto l4proto
410 Layer-4 protocol to match (by number or name)
411 [!] --ctorigsrc address[/mask]
413 [!] --ctorigdst address[/mask]
415 [!] --ctreplsrc address[/mask]
417 [!] --ctrepldst address[/mask]
419 Match against original/reply source/destination address
420 [!] --ctorigsrcport port[:port]
422 [!] --ctorigdstport port[:port]
424 [!] --ctreplsrcport port[:port]
426 [!] --ctrepldstport port[:port]
428 Match against original/reply source/destination port
429 (TCP/UDP/etc.) or GRE key. Matching against port ranges is only
430 supported in kernel versions above 2.6.38.
431 [!] --ctstatus statelist
433 statuslist is a comma separated list of the connection statuses
434 to match. Possible statuses are listed below.
435 [!] --ctexpire time[:time]
437 Match remaining lifetime in seconds against given value or range
438 of values (inclusive)
439 --ctdir {ORIGINAL|REPLY}
441 Match packets that are flowing in the specified direction. If
442 this flag is not specified at all, matches packets in both
443 directions.
444 States for --ctstate:
446 INVALID
448 The packet is associated with no known connection.
449 NEW The packet has started a new connection or otherwise associated
451 with a connection which has not seen packets in both directions.
452 ESTABLISHED
454 The packet is associated with a connection which has seen pack‐
455 ets in both directions.
456 RELATED
458 The packet is starting a new connection, but is associated with
459 an existing connection, such as an FTP data transfer or an ICMP
460 error.
461 UNTRACKED
463 The packet is not tracked at all, which happens if you explic‐
464 itly untrack it by using -j CT --notrack in the raw table.
465 SNAT A virtual state, matching if the original source address differs
467 from the reply destination.
468 DNAT A virtual state, matching if the original destination differs
470 from the reply source.
471 Statuses for --ctstatus:
473 NONE None of the below.
475 EXPECTED
477 This is an expected connection (i.e. a conntrack helper set it
478 up).
479 SEEN_REPLY
481 Conntrack has seen packets in both directions.
482 ASSURED
484 Conntrack entry should never be early-expired.
485 CONFIRMED
487 Connection is confirmed: originating packet has left box.
488 cpu
490 [!] --cpu number
491 Match cpu handling this packet. cpus are numbered from 0 to
492 NR_CPUS-1 Can be used in combination with RPS (Remote Packet
493 Steering) or multiqueue NICs to spread network traffic on dif‐
494 ferent queues.
495 Example:
497 iptables -t nat -A PREROUTING -p tcp --dport 80 -m cpu --cpu 0 -j REDI‐
499 RECT --to-port 8080
500 iptables -t nat -A PREROUTING -p tcp --dport 80 -m cpu --cpu 1 -j REDI‐
502 RECT --to-port 8081
503 Available since Linux 2.6.36.
505 dccp
507 [!] --source-port,--sport port[:port]
508 [!] --destination-port,--dport port[:port]
510 [!] --dccp-types mask
512 Match when the DCCP packet type is one of 'mask'. 'mask' is a
513 comma-separated list of packet types. Packet types are: REQUEST
514 RESPONSE DATA ACK DATAACK CLOSEREQ CLOSE RESET SYNC SYNCACK
515 INVALID.
516 [!] --dccp-option number
518 Match if DCCP option set.
519 devgroup
521 Match device group of a packets incoming/outgoing interface.
522 [!] --src-group name
524 Match device group of incoming device
525 [!] --dst-group name
527 Match device group of outgoing device
528 dscp
530 This module matches the 6 bit DSCP field within the TOS field in the IP
531 header. DSCP has superseded TOS within the IETF.
532 [!] --dscp value
534 Match against a numeric (decimal or hex) value [0-63].
535 [!] --dscp-class class
537 Match the DiffServ class. This value may be any of the BE, EF,
538 AFxx or CSx classes. It will then be converted into its accord‐
539 ing numeric value.
540 dst (IPv6-specific)
542 This module matches the parameters in Destination Options header
543 [!] --dst-len length
545 Total length of this header in octets.
546 --dst-opts type[:length][,type[:length]...]
548 numeric type of option and the length of the option data in
549 octets.
550 ecn
552 This allows you to match the ECN bits of the IPv4/IPv6 and TCP header.
553 ECN is the Explicit Congestion Notification mechanism as specified in
554 RFC3168
555 [!] --ecn-tcp-cwr
557 This matches if the TCP ECN CWR (Congestion Window Received) bit
558 is set.
559 [!] --ecn-tcp-ece
561 This matches if the TCP ECN ECE (ECN Echo) bit is set.
562 [!] --ecn-ip-ect num
564 This matches a particular IPv4/IPv6 ECT (ECN-Capable Transport).
565 You have to specify a number between `0' and `3'.
566 esp
568 This module matches the SPIs in ESP header of IPsec packets.
569 [!] --espspi spi[:spi]
571 eui64 (IPv6-specific)
573 This module matches the EUI-64 part of a stateless autoconfigured IPv6
574 address. It compares the EUI-64 derived from the source MAC address in
575 Ethernet frame with the lower 64 bits of the IPv6 source address. But
576 "Universal/Local" bit is not compared. This module doesn't match other
577 link layer frame, and is only valid in the PREROUTING, INPUT and FOR‐
578 WARD chains.
579 frag (IPv6-specific)
581 This module matches the parameters in Fragment header.
582 [!] --fragid id[:id]
584 Matches the given Identification or range of it.
585 [!] --fraglen length
587 This option cannot be used with kernel version 2.6.10 or later.
588 The length of Fragment header is static and this option doesn't
589 make sense.
590 --fragres
592 Matches if the reserved fields are filled with zero.
593 --fragfirst
595 Matches on the first fragment.
596 --fragmore
598 Matches if there are more fragments.
599 --fraglast
601 Matches if this is the last fragment.
602 hashlimit
604 hashlimit uses hash buckets to express a rate limiting match (like the
605 limit match) for a group of connections using a single iptables rule.
606 Grouping can be done per-hostgroup (source and/or destination address)
607 and/or per-port. It gives you the ability to express "N packets per
608 time quantum per group" or "N bytes per seconds" (see below for some
609 examples).
610 A hash limit option (--hashlimit-upto, --hashlimit-above) and --hash‐
612 limit-name are required.
613 --hashlimit-upto amount[/second|/minute|/hour|/day]
615 Match if the rate is below or equal to amount/quantum. It is
616 specified either as a number, with an optional time quantum suf‐
617 fix (the default is 3/hour), or as amountb/second (number of
618 bytes per second).
619 --hashlimit-above amount[/second|/minute|/hour|/day]
621 Match if the rate is above amount/quantum.
622 --hashlimit-burst amount
624 Maximum initial number of packets to match: this number gets
625 recharged by one every time the limit specified above is not
626 reached, up to this number; the default is 5. When byte-based
627 rate matching is requested, this option specifies the amount of
628 bytes that can exceed the given rate. This option should be
629 used with caution -- if the entry expires, the burst value is
630 reset too.
631 --hashlimit-mode {srcip|srcport|dstip|dstport},...
633 A comma-separated list of objects to take into consideration. If
634 no --hashlimit-mode option is given, hashlimit acts like limit,
635 but at the expensive of doing the hash housekeeping.
636 --hashlimit-srcmask prefix
638 When --hashlimit-mode srcip is used, all source addresses
639 encountered will be grouped according to the given prefix length
640 and the so-created subnet will be subject to hashlimit. prefix
641 must be between (inclusive) 0 and 32. Note that --hashlimit-src‐
642 mask 0 is basically doing the same thing as not specifying srcip
643 for --hashlimit-mode, but is technically more expensive.
644 --hashlimit-dstmask prefix
646 Like --hashlimit-srcmask, but for destination addresses.
647 --hashlimit-name foo
649 The name for the /proc/net/ipt_hashlimit/foo entry.
650 --hashlimit-htable-size buckets
652 The number of buckets of the hash table
653 --hashlimit-htable-max entries
655 Maximum entries in the hash.
656 --hashlimit-htable-expire msec
658 After how many milliseconds do hash entries expire.
659 --hashlimit-htable-gcinterval msec
661 How many milliseconds between garbage collection intervals.
662 --hashlimit-rate-match
664 Classify the flow instead of rate-limiting it. This acts like a
665 true/false match on whether the rate is above/below a certain
666 number
667 --hashlimit-rate-interval sec
669 Can be used with --hashlimit-rate-match to specify the interval
670 at which the rate should be sampled
671 Examples:
673 matching on source host
675 "1000 packets per second for every host in 192.168.0.0/16" => -s
676 192.168.0.0/16 --hashlimit-mode srcip --hashlimit-upto 1000/sec
677 matching on source port
679 "100 packets per second for every service of 192.168.1.1" => -s
680 192.168.1.1 --hashlimit-mode srcport --hashlimit-upto 100/sec
681 matching on subnet
683 "10000 packets per minute for every /28 subnet (groups of 8
684 addresses) in 10.0.0.0/8" => -s 10.0.0.0/8 --hashlimit-mask 28
685 --hashlimit-upto 10000/min
686 matching bytes per second
688 "flows exceeding 512kbyte/s" => --hashlimit-mode
689 srcip,dstip,srcport,dstport --hashlimit-above 512kb/s
690 matching bytes per second
692 "hosts that exceed 512kbyte/s, but permit up to 1Megabytes with‐
693 out matching" --hashlimit-mode dstip --hashlimit-above 512kb/s
694 --hashlimit-burst 1mb
695 hbh (IPv6-specific)
697 This module matches the parameters in Hop-by-Hop Options header
698 [!] --hbh-len length
700 Total length of this header in octets.
701 --hbh-opts type[:length][,type[:length]...]
703 numeric type of option and the length of the option data in
704 octets.
705 helper
707 This module matches packets related to a specific conntrack-helper.
708 [!] --helper string
710 Matches packets related to the specified conntrack-helper.
711 string can be "ftp" for packets related to a ftp-session on
713 default port. For other ports append -portnr to the value, ie.
714 "ftp-2121".
715 Same rules apply for other conntrack-helpers.
717 hl (IPv6-specific)
719 This module matches the Hop Limit field in the IPv6 header.
720 [!] --hl-eq value
722 Matches if Hop Limit equals value.
723 --hl-lt value
725 Matches if Hop Limit is less than value.
726 --hl-gt value
728 Matches if Hop Limit is greater than value.
729 icmp (IPv4-specific)
731 This extension can be used if `--protocol icmp' is specified. It pro‐
732 vides the following option:
733 [!] --icmp-type {type[/code]|typename}
735 This allows specification of the ICMP type, which can be a
736 numeric ICMP type, type/code pair, or one of the ICMP type names
737 shown by the command
738 iptables -p icmp -h
739 icmp6 (IPv6-specific)
741 This extension can be used if `--protocol ipv6-icmp' or `--protocol
742 icmpv6' is specified. It provides the following option:
743 [!] --icmpv6-type type[/code]|typename
745 This allows specification of the ICMPv6 type, which can be a
746 numeric ICMPv6 type, type and code, or one of the ICMPv6 type
747 names shown by the command
748 ip6tables -p ipv6-icmp -h
749 iprange
751 This matches on a given arbitrary range of IP addresses.
752 [!] --src-range from[-to]
754 Match source IP in the specified range.
755 [!] --dst-range from[-to]
757 Match destination IP in the specified range.
758 ipv6header (IPv6-specific)
760 This module matches IPv6 extension headers and/or upper layer header.
761 --soft Matches if the packet includes any of the headers specified with
763 --header.
764 [!] --header header[,header...]
766 Matches the packet which EXACTLY includes all specified headers.
767 The headers encapsulated with ESP header are out of scope. Pos‐
768 sible header types can be:
769 hop|hop-by-hop
771 Hop-by-Hop Options header
772 dst Destination Options header
774 route Routing header
776 frag Fragment header
778 auth Authentication header
780 esp Encapsulating Security Payload header
782 none No Next header which matches 59 in the 'Next Header field' of
784 IPv6 header or any IPv6 extension headers
785 prot which matches any upper layer protocol header. A protocol name
787 from /etc/protocols and numeric value also allowed. The number
788 255 is equivalent to prot.
789 ipvs
791 Match IPVS connection properties.
792 [!] --ipvs
794 packet belongs to an IPVS connection
795 Any of the following options implies --ipvs (even negated)
797 [!] --vproto protocol
799 VIP protocol to match; by number or name, e.g. "tcp"
800 [!] --vaddr address[/mask]
802 VIP address to match
803 [!] --vport port
805 VIP port to match; by number or name, e.g. "http"
806 --vdir {ORIGINAL|REPLY}
808 flow direction of packet
809 [!] --vmethod {GATE|IPIP|MASQ}
811 IPVS forwarding method used
812 [!] --vportctl port
814 VIP port of the controlling connection to match, e.g. 21 for FTP
815 length
817 This module matches the length of the layer-3 payload (e.g. layer-4
818 packet) of a packet against a specific value or range of values.
819 [!] --length length[:length]
821 limit
823 This module matches at a limited rate using a token bucket filter. A
824 rule using this extension will match until this limit is reached. It
825 can be used in combination with the LOG target to give limited logging,
826 for example.
827 xt_limit has no negation support - you will have to use -m hashlimit !
829 --hashlimit rate in this case whilst omitting --hashlimit-mode.
830 --limit rate[/second|/minute|/hour|/day]
832 Maximum average matching rate: specified as a number, with an
833 optional `/second', `/minute', `/hour', or `/day' suffix; the
834 default is 3/hour.
835 --limit-burst number
837 Maximum initial number of packets to match: this number gets
838 recharged by one every time the limit specified above is not
839 reached, up to this number; the default is 5.
840 mac
842 [!] --mac-source address
843 Match source MAC address. It must be of the form
844 XX:XX:XX:XX:XX:XX. Note that this only makes sense for packets
845 coming from an Ethernet device and entering the PREROUTING, FOR‐
846 WARD or INPUT chains.
847 mark
849 This module matches the netfilter mark field associated with a packet
850 (which can be set using the MARK target below).
851 [!] --mark value[/mask]
853 Matches packets with the given unsigned mark value (if a mask is
854 specified, this is logically ANDed with the mask before the com‐
855 parison).
856 mh (IPv6-specific)
858 This extension is loaded if `--protocol ipv6-mh' or `--protocol mh' is
859 specified. It provides the following option:
860 [!] --mh-type type[:type]
862 This allows specification of the Mobility Header(MH) type, which
863 can be a numeric MH type, type or one of the MH type names shown
864 by the command
865 ip6tables -p mh -h
866 multiport
868 This module matches a set of source or destination ports. Up to 15
869 ports can be specified. A port range (port:port) counts as two ports.
870 It can only be used in conjunction with one of the following protocols:
871 tcp, udp, udplite, dccp and sctp.
872 [!] --source-ports,--sports port[,port|,port:port]...
874 Match if the source port is one of the given ports. The flag
875 --sports is a convenient alias for this option. Multiple ports
876 or port ranges are separated using a comma, and a port range is
877 specified using a colon. 53,1024:65535 would therefore match
878 ports 53 and all from 1024 through 65535.
879 [!] --destination-ports,--dports port[,port|,port:port]...
881 Match if the destination port is one of the given ports. The
882 flag --dports is a convenient alias for this option.
883 [!] --ports port[,port|,port:port]...
885 Match if either the source or destination ports are equal to one
886 of the given ports.
887 nfacct
889 The nfacct match provides the extended accounting infrastructure for
890 iptables. You have to use this match together with the standalone
891 user-space utility nfacct(8)
892 The only option available for this match is the following:
894 --nfacct-name name
896 This allows you to specify the existing object name that will be
897 use for accounting the traffic that this rule-set is matching.
898 To use this extension, you have to create an accounting object:
900 nfacct add http-traffic
902 Then, you have to attach it to the accounting object via iptables:
904 iptables -I INPUT -p tcp --sport 80 -m nfacct --nfacct-name
906 http-traffic
907 iptables -I OUTPUT -p tcp --dport 80 -m nfacct --nfacct-name
909 http-traffic
910 Then, you can check for the amount of traffic that the rules match:
912 nfacct get http-traffic
914 { pkts = 00000000000000000156, bytes = 00000000000000151786 } =
916 http-traffic;
917 You can obtain nfacct(8) from http://www.netfilter.org or, alterna‐
919 tively, from the git.netfilter.org repository.
920 osf
922 The osf module does passive operating system fingerprinting. This mod‐
923 ules compares some data (Window Size, MSS, options and their order,
924 TTL, DF, and others) from packets with the SYN bit set.
925 [!] --genre string
927 Match an operating system genre by using a passive fingerprint‐
928 ing.
929 --ttl level
931 Do additional TTL checks on the packet to determine the operat‐
932 ing system. level can be one of the following values:
933 · 0 - True IP address and fingerprint TTL comparison. This generally
935 works for LANs.
936 · 1 - Check if the IP header's TTL is less than the fingerprint one.
938 Works for globally-routable addresses.
939 · 2 - Do not compare the TTL at all.
941 --log level
943 Log determined genres into dmesg even if they do not match the
944 desired one. level can be one of the following values:
945 · 0 - Log all matched or unknown signatures
947 · 1 - Log only the first one
949 · 2 - Log all known matched signatures
951 You may find something like this in syslog:
953 Windows [2000:SP3:Windows XP Pro SP1, 2000 SP3]: 11.22.33.55:4024 ->
955 11.22.33.44:139 hops=3 Linux [2.5-2.6:] : 1.2.3.4:42624 -> 1.2.3.5:22
956 hops=4
957 OS fingerprints are loadable using the nfnl_osf program. To load fin‐
959 gerprints from a file, use:
960 nfnl_osf -f /usr/share/xtables/pf.os
962 To remove them again,
964 nfnl_osf -f /usr/share/xtables/pf.os -d
966 The fingerprint database can be downlaoded from http://www.open‐
968 bsd.org/cgi-bin/cvsweb/src/etc/pf.os .
969 owner
971 This module attempts to match various characteristics of the packet
972 creator, for locally generated packets. This match is only valid in the
973 OUTPUT and POSTROUTING chains. Forwarded packets do not have any socket
974 associated with them. Packets from kernel threads do have a socket, but
975 usually no owner.
976 [!] --uid-owner username
978 [!] --uid-owner userid[-userid]
980 Matches if the packet socket's file structure (if it has one) is
981 owned by the given user. You may also specify a numerical UID,
982 or an UID range.
983 [!] --gid-owner groupname
985 [!] --gid-owner groupid[-groupid]
987 Matches if the packet socket's file structure is owned by the
988 given group. You may also specify a numerical GID, or a GID
989 range.
990 [!] --socket-exists
992 Matches if the packet is associated with a socket.
993 physdev
995 This module matches on the bridge port input and output devices
996 enslaved to a bridge device. This module is a part of the infrastruc‐
997 ture that enables a transparent bridging IP firewall and is only useful
998 for kernel versions above version 2.5.44.
999 [!] --physdev-in name
1001 Name of a bridge port via which a packet is received (only for
1002 packets entering the INPUT, FORWARD and PREROUTING chains). If
1003 the interface name ends in a "+", then any interface which
1004 begins with this name will match. If the packet didn't arrive
1005 through a bridge device, this packet won't match this option,
1006 unless '!' is used.
1007 [!] --physdev-out name
1009 Name of a bridge port via which a packet is going to be sent
1010 (for bridged packets entering the FORWARD and POSTROUTING
1011 chains). If the interface name ends in a "+", then any inter‐
1012 face which begins with this name will match.
1013 [!] --physdev-is-in
1015 Matches if the packet has entered through a bridge interface.
1016 [!] --physdev-is-out
1018 Matches if the packet will leave through a bridge interface.
1019 [!] --physdev-is-bridged
1021 Matches if the packet is being bridged and therefore is not
1022 being routed. This is only useful in the FORWARD and POSTROUT‐
1023 ING chains.
1024 pkttype
1026 This module matches the link-layer packet type.
1027 [!] --pkt-type {unicast|broadcast|multicast}
1029 policy
1031 This modules matches the policy used by IPsec for handling a packet.
1032 --dir {in|out}
1034 Used to select whether to match the policy used for decapsula‐
1035 tion or the policy that will be used for encapsulation. in is
1036 valid in the PREROUTING, INPUT and FORWARD chains, out is valid
1037 in the POSTROUTING, OUTPUT and FORWARD chains.
1038 --pol {none|ipsec}
1040 Matches if the packet is subject to IPsec processing. --pol none
1041 cannot be combined with --strict.
1042 --strict
1044 Selects whether to match the exact policy or match if any rule
1045 of the policy matches the given policy.
1046 For each policy element that is to be described, one can use one or
1048 more of the following options. When --strict is in effect, at least one
1049 must be used per element.
1050 [!] --reqid id
1052 Matches the reqid of the policy rule. The reqid can be specified
1053 with setkey(8) using unique:id as level.
1054 [!] --spi spi
1056 Matches the SPI of the SA.
1057 [!] --proto {ah|esp|ipcomp}
1059 Matches the encapsulation protocol.
1060 [!] --mode {tunnel|transport}
1062 Matches the encapsulation mode.
1063 [!] --tunnel-src addr[/mask]
1065 Matches the source end-point address of a tunnel mode SA. Only
1066 valid with --mode tunnel.
1067 [!] --tunnel-dst addr[/mask]
1069 Matches the destination end-point address of a tunnel mode SA.
1070 Only valid with --mode tunnel.
1071 --next Start the next element in the policy specification. Can only be
1073 used with --strict.
1074 quota
1076 Implements network quotas by decrementing a byte counter with each
1077 packet. The condition matches until the byte counter reaches zero.
1078 Behavior is reversed with negation (i.e. the condition does not match
1079 until the byte counter reaches zero).
1080 [!] --quota bytes
1082 The quota in bytes.
1083 rateest
1085 The rate estimator can match on estimated rates as collected by the
1086 RATEEST target. It supports matching on absolute bps/pps values, com‐
1087 paring two rate estimators and matching on the difference between two
1088 rate estimators.
1089 For a better understanding of the available options, these are all pos‐
1091 sible combinations:
1092 · rateest operator rateest-bps
1094 · rateest operator rateest-pps
1096 · (rateest minus rateest-bps1) operator rateest-bps2
1098 · (rateest minus rateest-pps1) operator rateest-pps2
1100 · rateest1 operator rateest2 rateest-bps(without rate!)
1102 · rateest1 operator rateest2 rateest-pps(without rate!)
1104 · (rateest1 minus rateest-bps1) operator (rateest2 minus rateest-
1106 bps2)
1107 · (rateest1 minus rateest-pps1) operator (rateest2 minus rateest-
1109 pps2)
1110 --rateest-delta
1112 For each estimator (either absolute or relative mode), calculate
1113 the difference between the estimator-determined flow rate and the
1114 static value chosen with the BPS/PPS options. If the flow rate is
1115 higher than the specified BPS/PPS, 0 will be used instead of a neg‐
1116 ative value. In other words, "max(0, rateest#_rate - rateest#_bps)"
1117 is used.
1118 [!] --rateest-lt
1120 Match if rate is less than given rate/estimator.
1121 [!] --rateest-gt
1123 Match if rate is greater than given rate/estimator.
1124 [!] --rateest-eq
1126 Match if rate is equal to given rate/estimator.
1127 In the so-called "absolute mode", only one rate estimator is used and
1129 compared against a static value, while in "relative mode", two rate
1130 estimators are compared against another.
1131 --rateest name
1133 Name of the one rate estimator for absolute mode.
1134 --rateest1 name
1136 --rateest2 name
1138 The names of the two rate estimators for relative mode.
1139 --rateest-bps [value]
1141 --rateest-pps [value]
1143 --rateest-bps1 [value]
1145 --rateest-bps2 [value]
1147 --rateest-pps1 [value]
1149 --rateest-pps2 [value]
1151 Compare the estimator(s) by bytes or packets per second, and
1152 compare against the chosen value. See the above bullet list for
1153 which option is to be used in which case. A unit suffix may be
1154 used - available ones are: bit, [kmgt]bit, [KMGT]ibit, Bps,
1155 [KMGT]Bps, [KMGT]iBps.
1156 Example: This is what can be used to route outgoing data connections
1158 from an FTP server over two lines based on the available bandwidth at
1159 the time the data connection was started:
1160 # Estimate outgoing rates
1162 iptables -t mangle -A POSTROUTING -o eth0 -j RATEEST --rateest-name
1164 eth0 --rateest-interval 250ms --rateest-ewma 0.5s
1165 iptables -t mangle -A POSTROUTING -o ppp0 -j RATEEST --rateest-name
1167 ppp0 --rateest-interval 250ms --rateest-ewma 0.5s
1168 # Mark based on available bandwidth
1170 iptables -t mangle -A balance -m conntrack --ctstate NEW -m helper
1172 --helper ftp -m rateest --rateest-delta --rateest1 eth0 --rateest-bps1
1173 2.5mbit --rateest-gt --rateest2 ppp0 --rateest-bps2 2mbit -j CONNMARK
1174 --set-mark 1
1175 iptables -t mangle -A balance -m conntrack --ctstate NEW -m helper
1177 --helper ftp -m rateest --rateest-delta --rateest1 ppp0 --rateest-bps1
1178 2mbit --rateest-gt --rateest2 eth0 --rateest-bps2 2.5mbit -j CONNMARK
1179 --set-mark 2
1180 iptables -t mangle -A balance -j CONNMARK --restore-mark
1182 realm (IPv4-specific)
1184 This matches the routing realm. Routing realms are used in complex
1185 routing setups involving dynamic routing protocols like BGP.
1186 [!] --realm value[/mask]
1188 Matches a given realm number (and optionally mask). If not a
1189 number, value can be a named realm from /etc/iproute2/rt_realms
1190 (mask can not be used in that case).
1191 recent
1193 Allows you to dynamically create a list of IP addresses and then match
1194 against that list in a few different ways.
1195 For example, you can create a "badguy" list out of people attempting to
1197 connect to port 139 on your firewall and then DROP all future packets
1198 from them without considering them.
1199 --set, --rcheck, --update and --remove are mutually exclusive.
1201 --name name
1203 Specify the list to use for the commands. If no name is given
1204 then DEFAULT will be used.
1205 [!] --set
1207 This will add the source address of the packet to the list. If
1208 the source address is already in the list, this will update the
1209 existing entry. This will always return success (or failure if !
1210 is passed in).
1211 --rsource
1213 Match/save the source address of each packet in the recent list
1214 table. This is the default.
1215 --rdest
1217 Match/save the destination address of each packet in the recent
1218 list table.
1219 --mask netmask
1221 Netmask that will be applied to this recent list.
1222 [!] --rcheck
1224 Check if the source address of the packet is currently in the
1225 list.
1226 [!] --update
1228 Like --rcheck, except it will update the "last seen" timestamp
1229 if it matches.
1230 [!] --remove
1232 Check if the source address of the packet is currently in the
1233 list and if so that address will be removed from the list and
1234 the rule will return true. If the address is not found, false is
1235 returned.
1236 --seconds seconds
1238 This option must be used in conjunction with one of --rcheck or
1239 --update. When used, this will narrow the match to only happen
1240 when the address is in the list and was seen within the last
1241 given number of seconds.
1242 --reap This option can only be used in conjunction with --seconds.
1244 When used, this will cause entries older than the last given
1245 number of seconds to be purged.
1246 --hitcount hits
1248 This option must be used in conjunction with one of --rcheck or
1249 --update. When used, this will narrow the match to only happen
1250 when the address is in the list and packets had been received
1251 greater than or equal to the given value. This option may be
1252 used along with --seconds to create an even narrower match
1253 requiring a certain number of hits within a specific time frame.
1254 The maximum value for the hitcount parameter is given by the
1255 "ip_pkt_list_tot" parameter of the xt_recent kernel module.
1256 Exceeding this value on the command line will cause the rule to
1257 be rejected.
1258 --rttl This option may only be used in conjunction with one of --rcheck
1260 or --update. When used, this will narrow the match to only hap‐
1261 pen when the address is in the list and the TTL of the current
1262 packet matches that of the packet which hit the --set rule. This
1263 may be useful if you have problems with people faking their
1264 source address in order to DoS you via this module by disallow‐
1265 ing others access to your site by sending bogus packets to you.
1266 Examples:
1268 iptables -A FORWARD -m recent --name badguy --rcheck --seconds
1270 60 -j DROP
1271 iptables -A FORWARD -p tcp -i eth0 --dport 139 -m recent --name
1273 badguy --set -j DROP
1274 /proc/net/xt_recent/* are the current lists of addresses and informa‐
1276 tion about each entry of each list.
1277 Each file in /proc/net/xt_recent/ can be read from to see the current
1279 list or written two using the following commands to modify the list:
1280 echo +addr >/proc/net/xt_recent/DEFAULT
1282 to add addr to the DEFAULT list
1283 echo -addr >/proc/net/xt_recent/DEFAULT
1285 to remove addr from the DEFAULT list
1286 echo / >/proc/net/xt_recent/DEFAULT
1288 to flush the DEFAULT list (remove all entries).
1289 The module itself accepts parameters, defaults shown:
1291 ip_list_tot=100
1293 Number of addresses remembered per table.
1294 ip_pkt_list_tot=20
1296 Number of packets per address remembered.
1297 ip_list_hash_size=0
1299 Hash table size. 0 means to calculate it based on ip_list_tot,
1300 default: 512.
1301 ip_list_perms=0644
1303 Permissions for /proc/net/xt_recent/* files.
1304 ip_list_uid=0
1306 Numerical UID for ownership of /proc/net/xt_recent/* files.
1307 ip_list_gid=0
1309 Numerical GID for ownership of /proc/net/xt_recent/* files.
1310 rpfilter
1312 Performs a reverse path filter test on a packet. If a reply to the
1313 packet would be sent via the same interface that the packet arrived on,
1314 the packet will match. Note that, unlike the in-kernel rp_filter,
1315 packets protected by IPSec are not treated specially. Combine this
1316 match with the policy match if you want this. Also, packets arriving
1317 via the loopback interface are always permitted. This match can only
1318 be used in the PREROUTING chain of the raw or mangle table.
1319 --loose
1321 Used to specify that the reverse path filter test should match
1322 even if the selected output device is not the expected one.
1323 --validmark
1325 Also use the packets' nfmark value when performing the reverse
1326 path route lookup.
1327 --accept-local
1329 This will permit packets arriving from the network with a source
1330 address that is also assigned to the local machine.
1331 --invert
1333 This will invert the sense of the match. Instead of matching
1334 packets that passed the reverse path filter test, match those
1335 that have failed it.
1336 Example to log and drop packets failing the reverse path filter test:
1338 iptables -t raw -N RPFILTER
1340 iptables -t raw -A RPFILTER -m rpfilter -j RETURN
1342 iptables -t raw -A RPFILTER -m limit --limit 10/minute -j NFLOG
1344 --nflog-prefix "rpfilter drop"
1345 iptables -t raw -A RPFILTER -j DROP
1347 iptables -t raw -A PREROUTING -j RPFILTER
1349 Example to drop failed packets, without logging:
1351 iptables -t raw -A RPFILTER -m rpfilter --invert -j DROP
1353 rt (IPv6-specific)
1355 Match on IPv6 routing header
1356 [!] --rt-type type
1358 Match the type (numeric).
1359 [!] --rt-segsleft num[:num]
1361 Match the `segments left' field (range).
1362 [!] --rt-len length
1364 Match the length of this header.
1365 --rt-0-res
1367 Match the reserved field, too (type=0)
1368 --rt-0-addrs addr[,addr...]
1370 Match type=0 addresses (list).
1371 --rt-0-not-strict
1373 List of type=0 addresses is not a strict list.
1374 sctp
1376 [!] --source-port,--sport port[:port]
1377 [!] --destination-port,--dport port[:port]
1379 [!] --chunk-types {all|any|only} chunktype[:flags] [...]
1381 The flag letter in upper case indicates that the flag is to
1382 match if set, in the lower case indicates to match if unset.
1383 Chunk types: DATA INIT INIT_ACK SACK HEARTBEAT HEARTBEAT_ACK
1385 ABORT SHUTDOWN SHUTDOWN_ACK ERROR COOKIE_ECHO COOKIE_ACK
1386 ECN_ECNE ECN_CWR SHUTDOWN_COMPLETE ASCONF ASCONF_ACK FORWARD_TSN
1387 chunk type available flags
1389 DATA I U B E i u b e
1390 ABORT T t
1391 SHUTDOWN_COMPLETE T t
1392 (lowercase means flag should be "off", uppercase means "on")
1394 Examples:
1396 iptables -A INPUT -p sctp --dport 80 -j DROP
1398 iptables -A INPUT -p sctp --chunk-types any DATA,INIT -j DROP
1400 iptables -A INPUT -p sctp --chunk-types any DATA:Be -j ACCEPT
1402 set
1404 This module matches IP sets which can be defined by ipset(8).
1405 [!] --match-set setname flag[,flag]...
1407 where flags are the comma separated list of src and/or dst spec‐
1408 ifications and there can be no more than six of them. Hence the
1409 command
1410 iptables -A FORWARD -m set --match-set test src,dst
1412 will match packets, for which (if the set type is ipportmap) the
1414 source address and destination port pair can be found in the
1415 specified set. If the set type of the specified set is single
1416 dimension (for example ipmap), then the command will match pack‐
1417 ets for which the source address can be found in the specified
1418 set.
1419 --return-nomatch
1421 If the --return-nomatch option is specified and the set type
1422 supports the nomatch flag, then the matching is reversed: a
1423 match with an element flagged with nomatch returns true, while a
1424 match with a plain element returns false.
1425 ! --update-counters
1427 If the --update-counters flag is negated, then the packet and
1428 byte counters of the matching element in the set won't be
1429 updated. Default the packet and byte counters are updated.
1430 ! --update-subcounters
1432 If the --update-subcounters flag is negated, then the packet and
1433 byte counters of the matching element in the member set of a
1434 list type of set won't be updated. Default the packet and byte
1435 counters are updated.
1436 [!] --packets-eq value
1438 If the packet is matched an element in the set, match only if
1439 the packet counter of the element matches the given value too.
1440 --packets-lt value
1442 If the packet is matched an element in the set, match only if
1443 the packet counter of the element is less than the given value
1444 as well.
1445 --packets-gt value
1447 If the packet is matched an element in the set, match only if
1448 the packet counter of the element is greater than the given
1449 value as well.
1450 [!] --bytes-eq value
1452 If the packet is matched an element in the set, match only if
1453 the byte counter of the element matches the given value too.
1454 --bytes-lt value
1456 If the packet is matched an element in the set, match only if
1457 the byte counter of the element is less than the given value as
1458 well.
1459 --bytes-gt value
1461 If the packet is matched an element in the set, match only if
1462 the byte counter of the element is greater than the given value
1463 as well.
1464 The packet and byte counters related options and flags are ignored when
1466 the set was defined without counter support.
1467 The option --match-set can be replaced by --set if that does not clash
1469 with an option of other extensions.
1470 Use of -m set requires that ipset kernel support is provided, which,
1472 for standard kernels, is the case since Linux 2.6.39.
1473 socket
1475 This matches if an open TCP/UDP socket can be found by doing a socket
1476 lookup on the packet. It matches if there is an established or non-zero
1477 bound listening socket (possibly with a non-local address). The lookup
1478 is performed using the packet tuple of TCP/UDP packets, or the original
1479 TCP/UDP header embedded in an ICMP/ICPMv6 error packet.
1480 --transparent
1482 Ignore non-transparent sockets.
1483 --nowildcard
1485 Do not ignore sockets bound to 'any' address. The socket match
1486 won't accept zero-bound listeners by default, since then local
1487 services could intercept traffic that would otherwise be for‐
1488 warded. This option therefore has security implications when
1489 used to match traffic being forwarded to redirect such packets
1490 to local machine with policy routing. When using the socket
1491 match to implement fully transparent proxies bound to non-local
1492 addresses it is recommended to use the --transparent option
1493 instead.
1494 Example (assuming packets with mark 1 are delivered locally):
1496 -t mangle -A PREROUTING -m socket --transparent -j MARK
1498 --set-mark 1
1499 --restore-skmark
1501 Set the packet mark to the matching socket's mark. Can be com‐
1502 bined with the --transparent and --nowildcard options to
1503 restrict the sockets to be matched when restoring the packet
1504 mark.
1505 Example: An application opens 2 transparent (IP_TRANSPARENT) sockets
1507 and sets a mark on them with SO_MARK socket option. We can filter
1508 matching packets:
1509 -t mangle -I PREROUTING -m socket --transparent --restore-skmark
1511 -j action
1512 -t mangle -A action -m mark --mark 10 -j action2
1514 -t mangle -A action -m mark --mark 11 -j action3
1516 state
1518 The "state" extension is a subset of the "conntrack" module. "state"
1519 allows access to the connection tracking state for this packet.
1520 [!] --state state
1522 Where state is a comma separated list of the connection states
1523 to match. Only a subset of the states unterstood by "conntrack"
1524 are recognized: INVALID, ESTABLISHED, NEW, RELATED or UNTRACKED.
1525 For their description, see the "conntrack" heading in this man‐
1526 page.
1527 statistic
1529 This module matches packets based on some statistic condition. It sup‐
1530 ports two distinct modes settable with the --mode option.
1531 Supported options:
1533 --mode mode
1535 Set the matching mode of the matching rule, supported modes are
1536 random and nth.
1537 [!] --probability p
1539 Set the probability for a packet to be randomly matched. It only
1540 works with the random mode. p must be within 0.0 and 1.0. The
1541 supported granularity is in 1/2147483648th increments.
1542 [!] --every n
1544 Match one packet every nth packet. It works only with the nth
1545 mode (see also the --packet option).
1546 --packet p
1548 Set the initial counter value (0 <= p <= n-1, default 0) for the
1549 nth mode.
1550 string
1552 This modules matches a given string by using some pattern matching
1553 strategy. It requires a linux kernel >= 2.6.14.
1554 --algo {bm|kmp}
1556 Select the pattern matching strategy. (bm = Boyer-Moore, kmp =
1557 Knuth-Pratt-Morris)
1558 --from offset
1560 Set the offset from which it starts looking for any matching. If
1561 not passed, default is 0.
1562 --to offset
1564 Set the offset up to which should be scanned. That is, byte off‐
1565 set-1 (counting from 0) is the last one that is scanned. If not
1566 passed, default is the packet size.
1567 [!] --string pattern
1569 Matches the given pattern.
1570 [!] --hex-string pattern
1572 Matches the given pattern in hex notation.
1573 --icase
1575 Ignore case when searching.
1576 Examples:
1578 # The string pattern can be used for simple text characters.
1580 iptables -A INPUT -p tcp --dport 80 -m string --algo bm --string
1581 'GET /index.html' -j LOG
1582 # The hex string pattern can be used for non-printable charac‐
1584 ters, like |0D 0A| or |0D0A|.
1585 iptables -p udp --dport 53 -m string --algo bm --from 40 --to 57
1586 --hex-string '|03|www|09|netfilter|03|org|00|'
1587 tcp
1589 These extensions can be used if `--protocol tcp' is specified. It pro‐
1590 vides the following options:
1591 [!] --source-port,--sport port[:port]
1593 Source port or port range specification. This can either be a
1594 service name or a port number. An inclusive range can also be
1595 specified, using the format first:last. If the first port is
1596 omitted, "0" is assumed; if the last is omitted, "65535" is
1597 assumed. The flag --sport is a convenient alias for this
1598 option.
1599 [!] --destination-port,--dport port[:port]
1601 Destination port or port range specification. The flag --dport
1602 is a convenient alias for this option.
1603 [!] --tcp-flags mask comp
1605 Match when the TCP flags are as specified. The first argument
1606 mask is the flags which we should examine, written as a comma-
1607 separated list, and the second argument comp is a comma-sepa‐
1608 rated list of flags which must be set. Flags are: SYN ACK FIN
1609 RST URG PSH ALL NONE. Hence the command
1610 iptables -A FORWARD -p tcp --tcp-flags SYN,ACK,FIN,RST SYN
1611 will only match packets with the SYN flag set, and the ACK, FIN
1612 and RST flags unset.
1613 [!] --syn
1615 Only match TCP packets with the SYN bit set and the ACK,RST and
1616 FIN bits cleared. Such packets are used to request TCP connec‐
1617 tion initiation; for example, blocking such packets coming in an
1618 interface will prevent incoming TCP connections, but outgoing
1619 TCP connections will be unaffected. It is equivalent to
1620 --tcp-flags SYN,RST,ACK,FIN SYN. If the "!" flag precedes the
1621 "--syn", the sense of the option is inverted.
1622 [!] --tcp-option number
1624 Match if TCP option set.
1625 tcpmss
1627 This matches the TCP MSS (maximum segment size) field of the TCP
1628 header. You can only use this on TCP SYN or SYN/ACK packets, since the
1629 MSS is only negotiated during the TCP handshake at connection startup
1630 time.
1631 [!] --mss value[:value]
1633 Match a given TCP MSS value or range. If a range is given, the
1634 second value must be greater than or equal to the first value.
1635 time
1637 This matches if the packet arrival time/date is within a given range.
1638 All options are optional, but are ANDed when specified. All times are
1639 interpreted as UTC by default.
1640 --datestart YYYY[-MM[-DD[Thh[:mm[:ss]]]]]
1642 --datestop YYYY[-MM[-DD[Thh[:mm[:ss]]]]]
1644 Only match during the given time, which must be in ISO 8601 "T"
1645 notation. The possible time range is 1970-01-01T00:00:00 to
1646 2038-01-19T04:17:07.
1647 If --datestart or --datestop are not specified, it will default
1649 to 1970-01-01 and 2038-01-19, respectively.
1650 --timestart hh:mm[:ss]
1652 --timestop hh:mm[:ss]
1654 Only match during the given daytime. The possible time range is
1655 00:00:00 to 23:59:59. Leading zeroes are allowed (e.g. "06:03")
1656 and correctly interpreted as base-10.
1657 [!] --monthdays day[,day...]
1659 Only match on the given days of the month. Possible values are 1
1660 to 31. Note that specifying 31 will of course not match on
1661 months which do not have a 31st day; the same goes for 28- or
1662 29-day February.
1663 [!] --weekdays day[,day...]
1665 Only match on the given weekdays. Possible values are Mon, Tue,
1666 Wed, Thu, Fri, Sat, Sun, or values from 1 to 7, respectively.
1667 You may also use two-character variants (Mo, Tu, etc.).
1668 --contiguous
1670 When --timestop is smaller than --timestart value, match this as
1671 a single time period instead distinct intervals. See EXAMPLES.
1672 --kerneltz
1674 Use the kernel timezone instead of UTC to determine whether a
1675 packet meets the time regulations.
1676 About kernel timezones: Linux keeps the system time in UTC, and always
1678 does so. On boot, system time is initialized from a referential time
1679 source. Where this time source has no timezone information, such as the
1680 x86 CMOS RTC, UTC will be assumed. If the time source is however not in
1681 UTC, userspace should provide the correct system time and timezone to
1682 the kernel once it has the information.
1683 Local time is a feature on top of the (timezone independent) system
1685 time. Each process has its own idea of local time, specified via the TZ
1686 environment variable. The kernel also has its own timezone offset vari‐
1687 able. The TZ userspace environment variable specifies how the UTC-based
1688 system time is displayed, e.g. when you run date(1), or what you see on
1689 your desktop clock. The TZ string may resolve to different offsets at
1690 different dates, which is what enables the automatic time-jumping in
1691 userspace. when DST changes. The kernel's timezone offset variable is
1692 used when it has to convert between non-UTC sources, such as FAT
1693 filesystems, to UTC (since the latter is what the rest of the system
1694 uses).
1695 The caveat with the kernel timezone is that Linux distributions may
1697 ignore to set the kernel timezone, and instead only set the system
1698 time. Even if a particular distribution does set the timezone at boot,
1699 it is usually does not keep the kernel timezone offset - which is what
1700 changes on DST - up to date. ntpd will not touch the kernel timezone,
1701 so running it will not resolve the issue. As such, one may encounter a
1702 timezone that is always +0000, or one that is wrong half of the time of
1703 the year. As such, using --kerneltz is highly discouraged.
1704 EXAMPLES. To match on weekends, use:
1706 -m time --weekdays Sa,Su
1708 Or, to match (once) on a national holiday block:
1710 -m time --datestart 2007-12-24 --datestop 2007-12-27
1712 Since the stop time is actually inclusive, you would need the following
1714 stop time to not match the first second of the new day:
1715 -m time --datestart 2007-01-01T17:00 --datestop
1717 2007-01-01T23:59:59
1718 During lunch hour:
1720 -m time --timestart 12:30 --timestop 13:30
1722 The fourth Friday in the month:
1724 -m time --weekdays Fr --monthdays 22,23,24,25,26,27,28
1726 (Note that this exploits a certain mathematical property. It is not
1728 possible to say "fourth Thursday OR fourth Friday" in one rule. It is
1729 possible with multiple rules, though.)
1730 Matching across days might not do what is expected. For instance,
1732 -m time --weekdays Mo --timestart 23:00 --timestop 01:00 Will
1734 match Monday, for one hour from midnight to 1 a.m., and then
1735 again for another hour from 23:00 onwards. If this is unwanted,
1736 e.g. if you would like 'match for two hours from Montay 23:00
1737 onwards' you need to also specify the --contiguous option in the
1738 example above.
1739 tos
1741 This module matches the 8-bit Type of Service field in the IPv4 header
1742 (i.e. including the "Precedence" bits) or the (also 8-bit) Priority
1743 field in the IPv6 header.
1744 [!] --tos value[/mask]
1746 Matches packets with the given TOS mark value. If a mask is
1747 specified, it is logically ANDed with the TOS mark before the
1748 comparison.
1749 [!] --tos symbol
1751 You can specify a symbolic name when using the tos match for
1752 IPv4. The list of recognized TOS names can be obtained by call‐
1753 ing iptables with -m tos -h. Note that this implies a mask of
1754 0x3F, i.e. all but the ECN bits.
1755 ttl (IPv4-specific)
1757 This module matches the time to live field in the IP header.
1758 [!] --ttl-eq ttl
1760 Matches the given TTL value.
1761 --ttl-gt ttl
1763 Matches if TTL is greater than the given TTL value.
1764 --ttl-lt ttl
1766 Matches if TTL is less than the given TTL value.
1767 u32
1769 U32 tests whether quantities of up to 4 bytes extracted from a packet
1770 have specified values. The specification of what to extract is general
1771 enough to find data at given offsets from tcp headers or payloads.
1772 [!] --u32 tests
1774 The argument amounts to a program in a small language described
1775 below.
1776 tests := location "=" value | tests "&&" location "=" value
1778 value := range | value "," range
1780 range := number | number ":" number
1782 a single number, n, is interpreted the same as n:n. n:m is interpreted
1784 as the range of numbers >=n and <=m.
1785 location := number | location operator number
1787 operator := "&" | "<<" | ">>" | "@"
1789 The operators &, <<, >> and && mean the same as in C. The = is really
1791 a set membership operator and the value syntax describes a set. The @
1792 operator is what allows moving to the next header and is described fur‐
1793 ther below.
1794 There are currently some artificial implementation limits on the size
1796 of the tests:
1797 * no more than 10 of "=" (and 9 "&&"s) in the u32 argument
1799 * no more than 10 ranges (and 9 commas) per value
1801 * no more than 10 numbers (and 9 operators) per location
1803 To describe the meaning of location, imagine the following machine that
1805 interprets it. There are three registers:
1806 A is of type char *, initially the address of the IP header
1808 B and C are unsigned 32 bit integers, initially zero
1810 The instructions are:
1812 number B = number;
1814 C = (*(A+B)<<24) + (*(A+B+1)<<16) + (*(A+B+2)<<8) + *(A+B+3)
1816 &number C = C & number
1818 << number C = C << number
1820 >> number C = C >> number
1822 @number A = A + C; then do the instruction number
1824 Any access of memory outside [skb->data,skb->end] causes the match to
1826 fail. Otherwise the result of the computation is the final value of C.
1827 Whitespace is allowed but not required in the tests. However, the char‐
1829 acters that do occur there are likely to require shell quoting, so it
1830 is a good idea to enclose the arguments in quotes.
1831 Example:
1833 match IP packets with total length >= 256
1835 The IP header contains a total length field in bytes 2-3.
1837 --u32 "0 & 0xFFFF = 0x100:0xFFFF"
1839 read bytes 0-3
1841 AND that with 0xFFFF (giving bytes 2-3), and test whether that
1843 is in the range [0x100:0xFFFF]
1844 Example: (more realistic, hence more complicated)
1846 match ICMP packets with icmp type 0
1848 First test that it is an ICMP packet, true iff byte 9 (protocol)
1850 = 1
1851 --u32 "6 & 0xFF = 1 && ...
1853 read bytes 6-9, use & to throw away bytes 6-8 and compare the
1855 result to 1. Next test that it is not a fragment. (If so, it
1856 might be part of such a packet but we cannot always tell.) N.B.:
1857 This test is generally needed if you want to match anything
1858 beyond the IP header. The last 6 bits of byte 6 and all of byte
1859 7 are 0 iff this is a complete packet (not a fragment). Alterna‐
1860 tively, you can allow first fragments by only testing the last 5
1861 bits of byte 6.
1862 ... 4 & 0x3FFF = 0 && ...
1864 Last test: the first byte past the IP header (the type) is 0.
1866 This is where we have to use the @syntax. The length of the IP
1867 header (IHL) in 32 bit words is stored in the right half of byte
1868 0 of the IP header itself.
1869 ... 0 >> 22 & 0x3C @ 0 >> 24 = 0"
1871 The first 0 means read bytes 0-3, >>22 means shift that 22 bits
1873 to the right. Shifting 24 bits would give the first byte, so
1874 only 22 bits is four times that plus a few more bits. &3C then
1875 eliminates the two extra bits on the right and the first four
1876 bits of the first byte. For instance, if IHL=5, then the IP
1877 header is 20 (4 x 5) bytes long. In this case, bytes 0-1 are (in
1878 binary) xxxx0101 yyzzzzzz, >>22 gives the 10 bit value
1879 xxxx0101yy and &3C gives 010100. @ means to use this number as a
1880 new offset into the packet, and read four bytes starting from
1881 there. This is the first 4 bytes of the ICMP payload, of which
1882 byte 0 is the ICMP type. Therefore, we simply shift the value 24
1883 to the right to throw out all but the first byte and compare the
1884 result with 0.
1885 Example:
1887 TCP payload bytes 8-12 is any of 1, 2, 5 or 8
1889 First we test that the packet is a tcp packet (similar to ICMP).
1891 --u32 "6 & 0xFF = 6 && ...
1893 Next, test that it is not a fragment (same as above).
1895 ... 0 >> 22 & 0x3C @ 12 >> 26 & 0x3C @ 8 = 1,2,5,8"
1897 0>>22&3C as above computes the number of bytes in the IP header.
1899 @ makes this the new offset into the packet, which is the start
1900 of the TCP header. The length of the TCP header (again in 32 bit
1901 words) is the left half of byte 12 of the TCP header. The
1902 12>>26&3C computes this length in bytes (similar to the IP
1903 header before). "@" makes this the new offset, which is the
1904 start of the TCP payload. Finally, 8 reads bytes 8-12 of the
1905 payload and = checks whether the result is any of 1, 2, 5 or 8.
1906 udp
1908 These extensions can be used if `--protocol udp' is specified. It pro‐
1909 vides the following options:
1910 [!] --source-port,--sport port[:port]
1912 Source port or port range specification. See the description of
1913 the --source-port option of the TCP extension for details.
1914 [!] --destination-port,--dport port[:port]
1916 Destination port or port range specification. See the descrip‐
1917 tion of the --destination-port option of the TCP extension for
1918 details.
1919
1921 iptables can use extended target modules: the following are included in
1922 the standard distribution.
1923 AUDIT
1925 This target allows to create audit records for packets hitting the tar‐
1926 get. It can be used to record accepted, dropped, and rejected packets.
1927 See auditd(8) for additional details.
1928 --type {accept|drop|reject}
1930 Set type of audit record.
1931 Example:
1933 iptables -N AUDIT_DROP
1935 iptables -A AUDIT_DROP -j AUDIT --type drop
1937 iptables -A AUDIT_DROP -j DROP
1939 CHECKSUM
1941 This target allows to selectively work around broken/old applications.
1942 It can only be used in the mangle table.
1943 --checksum-fill
1945 Compute and fill in the checksum in a packet that lacks a check‐
1946 sum. This is particularly useful, if you need to work around
1947 old applications such as dhcp clients, that do not work well
1948 with checksum offloads, but don't want to disable checksum off‐
1949 load in your device.
1950 CLASSIFY
1952 This module allows you to set the skb->priority value (and thus clas‐
1953 sify the packet into a specific CBQ class).
1954 --set-class major:minor
1956 Set the major and minor class value. The values are always
1957 interpreted as hexadecimal even if no 0x prefix is given.
1958 CLUSTERIP (IPv4-specific)
1960 This module allows you to configure a simple cluster of nodes that
1961 share a certain IP and MAC address without an explicit load balancer in
1962 front of them. Connections are statically distributed between the
1963 nodes in this cluster.
1964 --new Create a new ClusterIP. You always have to set this on the
1966 first rule for a given ClusterIP.
1967 --hashmode mode
1969 Specify the hashing mode. Has to be one of sourceip, sour‐
1970 ceip-sourceport, sourceip-sourceport-destport.
1971 --clustermac mac
1973 Specify the ClusterIP MAC address. Has to be a link-layer multi‐
1974 cast address
1975 --total-nodes num
1977 Number of total nodes within this cluster.
1978 --local-node num
1980 Local node number within this cluster.
1981 --hash-init rnd
1983 Specify the random seed used for hash initialization.
1984 CONNMARK
1986 This module sets the netfilter mark value associated with a connection.
1987 The mark is 32 bits wide.
1988 --set-xmark value[/mask]
1990 Zero out the bits given by mask and XOR value into the ctmark.
1991 --save-mark [--nfmask nfmask] [--ctmask ctmask]
1993 Copy the packet mark (nfmark) to the connection mark (ctmark)
1994 using the given masks. The new nfmark value is determined as
1995 follows:
1996 ctmark = (ctmark & ~ctmask) ^ (nfmark & nfmask)
1998 i.e. ctmask defines what bits to clear and nfmask what bits of
2000 the nfmark to XOR into the ctmark. ctmask and nfmask default to
2001 0xFFFFFFFF.
2002 --restore-mark [--nfmask nfmask] [--ctmask ctmask]
2004 Copy the connection mark (ctmark) to the packet mark (nfmark)
2005 using the given masks. The new ctmark value is determined as
2006 follows:
2007 nfmark = (nfmark & ~nfmask) ^ (ctmark & ctmask);
2009 i.e. nfmask defines what bits to clear and ctmask what bits of
2011 the ctmark to XOR into the nfmark. ctmask and nfmask default to
2012 0xFFFFFFFF.
2013 --restore-mark is only valid in the mangle table.
2015 The following mnemonics are available for --set-xmark:
2017 --and-mark bits
2019 Binary AND the ctmark with bits. (Mnemonic for --set-xmark
2020 0/invbits, where invbits is the binary negation of bits.)
2021 --or-mark bits
2023 Binary OR the ctmark with bits. (Mnemonic for --set-xmark
2024 bits/bits.)
2025 --xor-mark bits
2027 Binary XOR the ctmark with bits. (Mnemonic for --set-xmark
2028 bits/0.)
2029 --set-mark value[/mask]
2031 Set the connection mark. If a mask is specified then only those
2032 bits set in the mask are modified.
2033 --save-mark [--mask mask]
2035 Copy the nfmark to the ctmark. If a mask is specified, only
2036 those bits are copied.
2037 --restore-mark [--mask mask]
2039 Copy the ctmark to the nfmark. If a mask is specified, only
2040 those bits are copied. This is only valid in the mangle table.
2041 CONNSECMARK
2043 This module copies security markings from packets to connections (if
2044 unlabeled), and from connections back to packets (also only if unla‐
2045 beled). Typically used in conjunction with SECMARK, it is valid in the
2046 security table (for backwards compatibility with older kernels, it is
2047 also valid in the mangle table).
2048 --save If the packet has a security marking, copy it to the connection
2050 if the connection is not marked.
2051 --restore
2053 If the packet does not have a security marking, and the connec‐
2054 tion does, copy the security marking from the connection to the
2055 packet.
2056 CT
2059 The CT target allows to set parameters for a packet or its associated
2060 connection. The target attaches a "template" connection tracking entry
2061 to the packet, which is then used by the conntrack core when initializ‐
2062 ing a new ct entry. This target is thus only valid in the "raw" table.
2063 --notrack
2065 Disables connection tracking for this packet.
2066 --helper name
2068 Use the helper identified by name for the connection. This is
2069 more flexible than loading the conntrack helper modules with
2070 preset ports.
2071 --ctevents event[,...]
2073 Only generate the specified conntrack events for this connec‐
2074 tion. Possible event types are: new, related, destroy, reply,
2075 assured, protoinfo, helper, mark (this refers to the ctmark, not
2076 nfmark), natseqinfo, secmark (ctsecmark).
2077 --expevents event[,...]
2079 Only generate the specified expectation events for this connec‐
2080 tion. Possible event types are: new.
2081 --zone-orig {id|mark}
2083 For traffic coming from ORIGINAL direction, assign this packet
2084 to zone id and only have lookups done in that zone. If mark is
2085 used instead of id, the zone is derived from the packet nfmark.
2086 --zone-reply {id|mark}
2088 For traffic coming from REPLY direction, assign this packet to
2089 zone id and only have lookups done in that zone. If mark is used
2090 instead of id, the zone is derived from the packet nfmark.
2091 --zone {id|mark}
2093 Assign this packet to zone id and only have lookups done in that
2094 zone. If mark is used instead of id, the zone is derived from
2095 the packet nfmark. By default, packets have zone 0. This option
2096 applies to both directions.
2097 --timeout name
2099 Use the timeout policy identified by name for the connection.
2100 This is provides more flexible timeout policy definition than
2101 global timeout values available at /proc/sys/net/netfil‐
2102 ter/nf_conntrack_*_timeout_*.
2103 DNAT
2105 This target is only valid in the nat table, in the PREROUTING and OUT‐
2106 PUT chains, and user-defined chains which are only called from those
2107 chains. It specifies that the destination address of the packet should
2108 be modified (and all future packets in this connection will also be
2109 mangled), and rules should cease being examined. It takes the follow‐
2110 ing options:
2111 --to-destination [ipaddr[-ipaddr]][:port[-port]]
2113 which can specify a single new destination IP address, an inclu‐
2114 sive range of IP addresses. Optionally a port range, if the rule
2115 also specifies one of the following protocols: tcp, udp, dccp or
2116 sctp. If no port range is specified, then the destination port
2117 will never be modified. If no IP address is specified then only
2118 the destination port will be modified. In Kernels up to 2.6.10
2119 you can add several --to-destination options. For those kernels,
2120 if you specify more than one destination address, either via an
2121 address range or multiple --to-destination options, a simple
2122 round-robin (one after another in cycle) load balancing takes
2123 place between these addresses. Later Kernels (>= 2.6.11-rc1)
2124 don't have the ability to NAT to multiple ranges anymore.
2125 --random
2127 If option --random is used then port mapping will be randomized
2128 (kernel >= 2.6.22).
2129 --persistent
2131 Gives a client the same source-/destination-address for each
2132 connection. This supersedes the SAME target. Support for per‐
2133 sistent mappings is available from 2.6.29-rc2.
2134 IPv6 support available since Linux kernels >= 3.7.
2136 DNPT (IPv6-specific)
2138 Provides stateless destination IPv6-to-IPv6 Network Prefix Translation
2139 (as described by RFC 6296).
2140 You have to use this target in the mangle table, not in the nat table.
2142 It takes the following options:
2143 --src-pfx [prefix/length]
2145 Set source prefix that you want to translate and length
2146 --dst-pfx [prefix/length]
2148 Set destination prefix that you want to use in the translation
2149 and length
2150 You have to use the SNPT target to undo the translation. Example:
2152 ip6tables -t mangle -I POSTROUTING -s fd00::/64 -o vboxnet0 -j
2154 SNPT --src-pfx fd00::/64 --dst-pfx 2001:e20:2000:40f::/64
2155 ip6tables -t mangle -I PREROUTING -i wlan0 -d
2157 2001:e20:2000:40f::/64 -j DNPT --src-pfx 2001:e20:2000:40f::/64
2158 --dst-pfx fd00::/64
2159 You may need to enable IPv6 neighbor proxy:
2161 sysctl -w net.ipv6.conf.all.proxy_ndp=1
2163 You also have to use the NOTRACK target to disable connection tracking
2165 for translated flows.
2166 DSCP
2168 This target allows to alter the value of the DSCP bits within the TOS
2169 header of the IPv4 packet. As this manipulates a packet, it can only
2170 be used in the mangle table.
2171 --set-dscp value
2173 Set the DSCP field to a numerical value (can be decimal or hex)
2174 --set-dscp-class class
2176 Set the DSCP field to a DiffServ class.
2177 ECN (IPv4-specific)
2179 This target allows to selectively work around known ECN blackholes. It
2180 can only be used in the mangle table.
2181 --ecn-tcp-remove
2183 Remove all ECN bits from the TCP header. Of course, it can only
2184 be used in conjunction with -p tcp.
2185 HL (IPv6-specific)
2187 This is used to modify the Hop Limit field in IPv6 header. The Hop
2188 Limit field is similar to what is known as TTL value in IPv4. Setting
2189 or incrementing the Hop Limit field can potentially be very dangerous,
2190 so it should be avoided at any cost. This target is only valid in man‐
2191 gle table.
2192 Don't ever set or increment the value on packets that leave your local
2194 network!
2195 --hl-set value
2197 Set the Hop Limit to `value'.
2198 --hl-dec value
2200 Decrement the Hop Limit `value' times.
2201 --hl-inc value
2203 Increment the Hop Limit `value' times.
2204 HMARK
2206 Like MARK, i.e. set the fwmark, but the mark is calculated from hashing
2207 packet selector at choice. You have also to specify the mark range and,
2208 optionally, the offset to start from. ICMP error messages are inspected
2209 and used to calculate the hashing.
2210 Existing options are:
2212 --hmark-tuple tuple
2214 Possible tuple members are: src meaning source address (IPv4,
2215 IPv6 address), dst meaning destination address (IPv4, IPv6
2216 address), sport meaning source port (TCP, UDP, UDPlite, SCTP,
2217 DCCP), dport meaning destination port (TCP, UDP, UDPlite, SCTP,
2218 DCCP), spi meaning Security Parameter Index (AH, ESP), and ct
2219 meaning the usage of the conntrack tuple instead of the packet
2220 selectors.
2221 --hmark-mod value (must be > 0)
2223 Modulus for hash calculation (to limit the range of possible
2224 marks)
2225 --hmark-offset value
2227 Offset to start marks from.
2228 For advanced usage, instead of using --hmark-tuple, you can specify
2230 custom
2231 prefixes and masks:
2232 --hmark-src-prefix cidr
2234 The source address mask in CIDR notation.
2235 --hmark-dst-prefix cidr
2237 The destination address mask in CIDR notation.
2238 --hmark-sport-mask value
2240 A 16 bit source port mask in hexadecimal.
2241 --hmark-dport-mask value
2243 A 16 bit destination port mask in hexadecimal.
2244 --hmark-spi-mask value
2246 A 32 bit field with spi mask.
2247 --hmark-proto-mask value
2249 An 8 bit field with layer 4 protocol number.
2250 --hmark-rnd value
2252 A 32 bit random custom value to feed hash calculation.
2253 Examples:
2255 iptables -t mangle -A PREROUTING -m conntrack --ctstate NEW
2257 -j HMARK --hmark-tuple ct,src,dst,proto --hmark-offset 10000
2258 --hmark-mod 10 --hmark-rnd 0xfeedcafe
2259 iptables -t mangle -A PREROUTING -j HMARK --hmark-offset 10000 --hmark-
2261 tuple src,dst,proto --hmark-mod 10 --hmark-rnd 0xdeafbeef
2262 IDLETIMER
2264 This target can be used to identify when interfaces have been idle for
2265 a certain period of time. Timers are identified by labels and are cre‐
2266 ated when a rule is set with a new label. The rules also take a time‐
2267 out value (in seconds) as an option. If more than one rule uses the
2268 same timer label, the timer will be restarted whenever any of the rules
2269 get a hit. One entry for each timer is created in sysfs. This
2270 attribute contains the timer remaining for the timer to expire. The
2271 attributes are located under the xt_idletimer class:
2272 /sys/class/xt_idletimer/timers/<label>
2274 When the timer expires, the target module sends a sysfs notification to
2276 the userspace, which can then decide what to do (eg. disconnect to save
2277 power).
2278 --timeout amount
2280 This is the time in seconds that will trigger the notification.
2281 --label string
2283 This is a unique identifier for the timer. The maximum length
2284 for the label string is 27 characters.
2285 LED
2287 This creates an LED-trigger that can then be attached to system indica‐
2288 tor lights, to blink or illuminate them when certain packets pass
2289 through the system. One example might be to light up an LED for a few
2290 minutes every time an SSH connection is made to the local machine. The
2291 following options control the trigger behavior:
2292 --led-trigger-id name
2294 This is the name given to the LED trigger. The actual name of
2295 the trigger will be prefixed with "netfilter-".
2296 --led-delay ms
2298 This indicates how long (in milliseconds) the LED should be left
2299 illuminated when a packet arrives before being switched off
2300 again. The default is 0 (blink as fast as possible.) The special
2301 value inf can be given to leave the LED on permanently once
2302 activated. (In this case the trigger will need to be manually
2303 detached and reattached to the LED device to switch it off
2304 again.)
2305 --led-always-blink
2307 Always make the LED blink on packet arrival, even if the LED is
2308 already on. This allows notification of new packets even with
2309 long delay values (which otherwise would result in a silent pro‐
2310 longing of the delay time.)
2311 Example:
2313 Create an LED trigger for incoming SSH traffic:
2315 iptables -A INPUT -p tcp --dport 22 -j LED --led-trigger-id ssh
2316 Then attach the new trigger to an LED:
2318 echo netfilter-ssh >/sys/class/leds/ledname/trigger
2319 LOG
2321 Turn on kernel logging of matching packets. When this option is set
2322 for a rule, the Linux kernel will print some information on all match‐
2323 ing packets (like most IP/IPv6 header fields) via the kernel log (where
2324 it can be read with dmesg(1) or read in the syslog).
2325 This is a "non-terminating target", i.e. rule traversal continues at
2327 the next rule. So if you want to LOG the packets you refuse, use two
2328 separate rules with the same matching criteria, first using target LOG
2329 then DROP (or REJECT).
2330 --log-level level
2332 Level of logging, which can be (system-specific) numeric or a
2333 mnemonic. Possible values are (in decreasing order of prior‐
2334 ity): emerg, alert, crit, error, warning, notice, info or debug.
2335 --log-prefix prefix
2337 Prefix log messages with the specified prefix; up to 29 letters
2338 long, and useful for distinguishing messages in the logs.
2339 --log-tcp-sequence
2341 Log TCP sequence numbers. This is a security risk if the log is
2342 readable by users.
2343 --log-tcp-options
2345 Log options from the TCP packet header.
2346 --log-ip-options
2348 Log options from the IP/IPv6 packet header.
2349 --log-uid
2351 Log the userid of the process which generated the packet.
2352 MARK
2354 This target is used to set the Netfilter mark value associated with the
2355 packet. It can, for example, be used in conjunction with routing based
2356 on fwmark (needs iproute2). If you plan on doing so, note that the mark
2357 needs to be set in the PREROUTING chain of the mangle table to affect
2358 routing. The mark field is 32 bits wide.
2359 --set-xmark value[/mask]
2361 Zeroes out the bits given by mask and XORs value into the packet
2362 mark ("nfmark"). If mask is omitted, 0xFFFFFFFF is assumed.
2363 --set-mark value[/mask]
2365 Zeroes out the bits given by mask and ORs value into the packet
2366 mark. If mask is omitted, 0xFFFFFFFF is assumed.
2367 The following mnemonics are available:
2369 --and-mark bits
2371 Binary AND the nfmark with bits. (Mnemonic for --set-xmark
2372 0/invbits, where invbits is the binary negation of bits.)
2373 --or-mark bits
2375 Binary OR the nfmark with bits. (Mnemonic for --set-xmark
2376 bits/bits.)
2377 --xor-mark bits
2379 Binary XOR the nfmark with bits. (Mnemonic for --set-xmark
2380 bits/0.)
2381 MASQUERADE
2383 This target is only valid in the nat table, in the POSTROUTING chain.
2384 It should only be used with dynamically assigned IP (dialup) connec‐
2385 tions: if you have a static IP address, you should use the SNAT target.
2386 Masquerading is equivalent to specifying a mapping to the IP address of
2387 the interface the packet is going out, but also has the effect that
2388 connections are forgotten when the interface goes down. This is the
2389 correct behavior when the next dialup is unlikely to have the same
2390 interface address (and hence any established connections are lost any‐
2391 way).
2392 --to-ports port[-port]
2394 This specifies a range of source ports to use, overriding the
2395 default SNAT source port-selection heuristics (see above). This
2396 is only valid if the rule also specifies one of the following
2397 protocols: tcp, udp, dccp or sctp.
2398 --random
2400 Randomize source port mapping If option --random is used then
2401 port mapping will be randomized (kernel >= 2.6.21).
2402 --random-fully
2404 Full randomize source port mapping If option --random-fully is
2405 used then port mapping will be fully randomized (kernel >=
2406 3.13).
2407 IPv6 support available since Linux kernels >= 3.7.
2409 NETMAP
2411 This target allows you to statically map a whole network of addresses
2412 onto another network of addresses. It can only be used from rules in
2413 the nat table.
2414 --to address[/mask]
2416 Network address to map to. The resulting address will be con‐
2417 structed in the following way: All 'one' bits in the mask are
2418 filled in from the new `address'. All bits that are zero in the
2419 mask are filled in from the original address.
2420 IPv6 support available since Linux kernels >= 3.7.
2422 NFLOG
2424 This target provides logging of matching packets. When this target is
2425 set for a rule, the Linux kernel will pass the packet to the loaded
2426 logging backend to log the packet. This is usually used in combination
2427 with nfnetlink_log as logging backend, which will multicast the packet
2428 through a netlink socket to the specified multicast group. One or more
2429 userspace processes may subscribe to the group to receive the packets.
2430 Like LOG, this is a non-terminating target, i.e. rule traversal contin‐
2431 ues at the next rule.
2432 --nflog-group nlgroup
2434 The netlink group (0 - 2^16-1) to which packets are (only appli‐
2435 cable for nfnetlink_log). The default value is 0.
2436 --nflog-prefix prefix
2438 A prefix string to include in the log message, up to 64 charac‐
2439 ters long, useful for distinguishing messages in the logs.
2440 --nflog-range size
2442 This option has never worked, use --nflog-size instead
2443 --nflog-size size
2445 The number of bytes to be copied to userspace (only applicable
2446 for nfnetlink_log). nfnetlink_log instances may specify their
2447 own range, this option overrides it.
2448 --nflog-threshold size
2450 Number of packets to queue inside the kernel before sending them
2451 to userspace (only applicable for nfnetlink_log). Higher values
2452 result in less overhead per packet, but increase delay until the
2453 packets reach userspace. The default value is 1.
2454 NFQUEUE
2456 This target passes the packet to userspace using the nfnetlink_queue
2457 handler. The packet is put into the queue identified by its 16-bit
2458 queue number. Userspace can inspect and modify the packet if desired.
2459 Userspace must then drop or reinject the packet into the kernel.
2460 Please see libnetfilter_queue for details. nfnetlink_queue was added
2461 in Linux 2.6.14. The queue-balance option was added in Linux 2.6.31,
2462 queue-bypass in 2.6.39.
2463 --queue-num value
2465 This specifies the QUEUE number to use. Valid queue numbers are
2466 0 to 65535. The default value is 0.
2467 --queue-balance value:value
2469 This specifies a range of queues to use. Packets are then bal‐
2470 anced across the given queues. This is useful for multicore
2471 systems: start multiple instances of the userspace program on
2472 queues x, x+1, .. x+n and use "--queue-balance x:x+n". Packets
2473 belonging to the same connection are put into the same nfqueue.
2474 --queue-bypass
2476 By default, if no userspace program is listening on an NFQUEUE,
2477 then all packets that are to be queued are dropped. When this
2478 option is used, the NFQUEUE rule behaves like ACCEPT instead,
2479 and the packet will move on to the next table.
2480 --queue-cpu-fanout
2482 Available starting Linux kernel 3.10. When used together with
2483 --queue-balance this will use the CPU ID as an index to map
2484 packets to the queues. The idea is that you can improve perfor‐
2485 mance if there's a queue per CPU. This requires --queue-balance
2486 to be specified.
2487 NOTRACK
2489 This extension disables connection tracking for all packets matching
2490 that rule. It is equivalent with -j CT --notrack. Like CT, NOTRACK can
2491 only be used in the raw table.
2492 RATEEST
2494 The RATEEST target collects statistics, performs rate estimation calcu‐
2495 lation and saves the results for later evaluation using the rateest
2496 match.
2497 --rateest-name name
2499 Count matched packets into the pool referred to by name, which
2500 is freely choosable.
2501 --rateest-interval amount{s|ms|us}
2503 Rate measurement interval, in seconds, milliseconds or microsec‐
2504 onds.
2505 --rateest-ewmalog value
2507 Rate measurement averaging time constant.
2508 REDIRECT
2510 This target is only valid in the nat table, in the PREROUTING and OUT‐
2511 PUT chains, and user-defined chains which are only called from those
2512 chains. It redirects the packet to the machine itself by changing the
2513 destination IP to the primary address of the incoming interface
2514 (locally-generated packets are mapped to the localhost address,
2515 127.0.0.1 for IPv4 and ::1 for IPv6).
2516 --to-ports port[-port]
2518 This specifies a destination port or range of ports to use:
2519 without this, the destination port is never altered. This is
2520 only valid if the rule also specifies one of the following pro‐
2521 tocols: tcp, udp, dccp or sctp.
2522 --random
2524 If option --random is used then port mapping will be randomized
2525 (kernel >= 2.6.22).
2526 IPv6 support available starting Linux kernels >= 3.7.
2528 REJECT (IPv6-specific)
2530 This is used to send back an error packet in response to the matched
2531 packet: otherwise it is equivalent to DROP so it is a terminating TAR‐
2532 GET, ending rule traversal. This target is only valid in the INPUT,
2533 FORWARD and OUTPUT chains, and user-defined chains which are only
2534 called from those chains. The following option controls the nature of
2535 the error packet returned:
2536 --reject-with type
2538 The type given can be icmp6-no-route, no-route, icmp6-adm-pro‐
2539 hibited, adm-prohibited, icmp6-addr-unreachable, addr-unreach,
2540 or icmp6-port-unreachable, which return the appropriate ICMPv6
2541 error message (icmp6-port-unreachable is the default). Finally,
2542 the option tcp-reset can be used on rules which only match the
2543 TCP protocol: this causes a TCP RST packet to be sent back.
2544 This is mainly useful for blocking ident (113/tcp) probes which
2545 frequently occur when sending mail to broken mail hosts (which
2546 won't accept your mail otherwise). tcp-reset can only be used
2547 with kernel versions 2.6.14 or later.
2548 REJECT (IPv4-specific)
2550 This is used to send back an error packet in response to the matched
2551 packet: otherwise it is equivalent to DROP so it is a terminating TAR‐
2552 GET, ending rule traversal. This target is only valid in the INPUT,
2553 FORWARD and OUTPUT chains, and user-defined chains which are only
2554 called from those chains. The following option controls the nature of
2555 the error packet returned:
2556 --reject-with type
2558 The type given can be icmp-net-unreachable, icmp-host-unreach‐
2559 able, icmp-port-unreachable, icmp-proto-unreachable,
2560 icmp-net-prohibited, icmp-host-prohibited, or icmp-admin-prohib‐
2561 ited (*), which return the appropriate ICMP error message
2562 (icmp-port-unreachable is the default). The option tcp-reset
2563 can be used on rules which only match the TCP protocol: this
2564 causes a TCP RST packet to be sent back. This is mainly useful
2565 for blocking ident (113/tcp) probes which frequently occur when
2566 sending mail to broken mail hosts (which won't accept your mail
2567 otherwise).
2568 (*) Using icmp-admin-prohibited with kernels that do not support
2570 it will result in a plain DROP instead of REJECT
2571 SECMARK
2573 This is used to set the security mark value associated with the packet
2574 for use by security subsystems such as SELinux. It is valid in the
2575 security table (for backwards compatibility with older kernels, it is
2576 also valid in the mangle table). The mark is 32 bits wide.
2577 --selctx security_context
2579 SET
2581 This module adds and/or deletes entries from IP sets which can be
2582 defined by ipset(8).
2583 --add-set setname flag[,flag...]
2585 add the address(es)/port(s) of the packet to the set
2586 --del-set setname flag[,flag...]
2588 delete the address(es)/port(s) of the packet from the set
2589 --map-set setname flag[,flag...]
2591 [--map-mark] [--map-prio] [--map-queue] map packet properties
2592 (firewall mark, tc priority, hardware queue)
2593 where flag(s) are src and/or dst specifications and there can be
2595 no more than six of them.
2596 --timeout value
2598 when adding an entry, the timeout value to use instead of the
2599 default one from the set definition
2600 --exist
2602 when adding an entry if it already exists, reset the timeout
2603 value to the specified one or to the default from the set defi‐
2604 nition
2605 --map-set set-name
2607 the set-name should be created with --skbinfo option --map-mark
2608 map firewall mark to packet by lookup of value in the set
2609 --map-prio map traffic control priority to packet by lookup of
2610 value in the set --map-queue map hardware NIC queue to packet by
2611 lookup of value in the set
2612 The --map-set option can be used from the mangle table only. The
2614 --map-prio and --map-queue flags can be used in the OUTPUT, FOR‐
2615 WARD and POSTROUTING chains.
2616 Use of -j SET requires that ipset kernel support is provided, which,
2618 for standard kernels, is the case since Linux 2.6.39.
2619 SNAT
2621 This target is only valid in the nat table, in the POSTROUTING and
2622 INPUT chains, and user-defined chains which are only called from those
2623 chains. It specifies that the source address of the packet should be
2624 modified (and all future packets in this connection will also be man‐
2625 gled), and rules should cease being examined. It takes the following
2626 options:
2627 --to-source [ipaddr[-ipaddr]][:port[-port]]
2629 which can specify a single new source IP address, an inclusive
2630 range of IP addresses. Optionally a port range, if the rule also
2631 specifies one of the following protocols: tcp, udp, dccp or
2632 sctp. If no port range is specified, then source ports below
2633 512 will be mapped to other ports below 512: those between 512
2634 and 1023 inclusive will be mapped to ports below 1024, and other
2635 ports will be mapped to 1024 or above. Where possible, no port
2636 alteration will occur. In Kernels up to 2.6.10, you can add
2637 several --to-source options. For those kernels, if you specify
2638 more than one source address, either via an address range or
2639 multiple --to-source options, a simple round-robin (one after
2640 another in cycle) takes place between these addresses. Later
2641 Kernels (>= 2.6.11-rc1) don't have the ability to NAT to multi‐
2642 ple ranges anymore.
2643 --random
2645 If option --random is used then port mapping will be randomized
2646 through a hash-based algorithm (kernel >= 2.6.21).
2647 --random-fully
2649 If option --random-fully is used then port mapping will be fully
2650 randomized through a PRNG (kernel >= 3.14).
2651 --persistent
2653 Gives a client the same source-/destination-address for each
2654 connection. This supersedes the SAME target. Support for per‐
2655 sistent mappings is available from 2.6.29-rc2.
2656 Kernels prior to 2.6.36-rc1 don't have the ability to SNAT in the INPUT
2658 chain.
2659 IPv6 support available since Linux kernels >= 3.7.
2661 SNPT (IPv6-specific)
2663 Provides stateless source IPv6-to-IPv6 Network Prefix Translation (as
2664 described by RFC 6296).
2665 You have to use this target in the mangle table, not in the nat table.
2667 It takes the following options:
2668 --src-pfx [prefix/length]
2670 Set source prefix that you want to translate and length
2671 --dst-pfx [prefix/length]
2673 Set destination prefix that you want to use in the translation
2674 and length
2675 You have to use the DNPT target to undo the translation. Example:
2677 ip6tables -t mangle -I POSTROUTING -s fd00::/64 -o vboxnet0 -j
2679 SNPT --src-pfx fd00::/64 --dst-pfx 2001:e20:2000:40f::/64
2680 ip6tables -t mangle -I PREROUTING -i wlan0 -d
2682 2001:e20:2000:40f::/64 -j DNPT --src-pfx 2001:e20:2000:40f::/64
2683 --dst-pfx fd00::/64
2684 You may need to enable IPv6 neighbor proxy:
2686 sysctl -w net.ipv6.conf.all.proxy_ndp=1
2688 You also have to use the NOTRACK target to disable connection tracking
2690 for translated flows.
2691 SYNPROXY
2693 This target will process TCP three-way-handshake parallel in netfilter
2694 context to protect either local or backend system. This target requires
2695 connection tracking because sequence numbers need to be translated.
2696 --mss maximum segment size
2698 Maximum segment size announced to clients. This must match the
2699 backend.
2700 --wscale window scale
2702 Window scale announced to clients. This must match the backend.
2703 --sack-perm
2705 Pass client selective acknowledgement option to backend (will be
2706 disabled if not present).
2707 --timestamps
2709 Pass client timestamp option to backend (will be disabled if not
2710 present, also needed for selective acknowledgement and window
2711 scaling).
2712 Example:
2714 Determine tcp options used by backend, from an external system
2716 tcpdump -pni eth0 -c 1 'tcp[tcpflags] == (tcp-syn|tcp-ack)'
2718 port 80 &
2719 telnet 192.0.2.42 80
2720 18:57:24.693307 IP 192.0.2.42.80 > 192.0.2.43.48757:
2721 Flags [S.], seq 360414582, ack 788841994, win 14480,
2722 options [mss 1460,sackOK,
2723 TS val 1409056151 ecr 9690221,
2724 nop,wscale 9],
2725 length 0
2726 Switch tcp_loose mode off, so conntrack will mark out-of-flow packets
2728 as state INVALID.
2729 echo 0 > /proc/sys/net/netfilter/nf_conntrack_tcp_loose
2731 Make SYN packets untracked
2733 iptables -t raw -A PREROUTING -i eth0 -p tcp --dport 80
2735 --syn -j CT --notrack
2736 Catch UNTRACKED (SYN packets) and INVALID (3WHS ACK packets) states and
2738 send them to SYNPROXY. This rule will respond to SYN packets with
2739 SYN+ACK syncookies, create ESTABLISHED for valid client response (3WHS
2740 ACK packets) and drop incorrect cookies. Flags combinations not
2741 expected during 3WHS will not match and continue (e.g. SYN+FIN,
2742 SYN+ACK).
2743 iptables -A INPUT -i eth0 -p tcp --dport 80
2745 -m state --state UNTRACKED,INVALID -j SYNPROXY
2746 --sack-perm --timestamp --mss 1460 --wscale 9
2747 Drop invalid packets, this will be out-of-flow packets that were not
2749 matched by SYNPROXY.
2750 iptables -A INPUT -i eth0 -p tcp --dport 80 -m state --state
2752 INVALID -j DROP
2753 TCPMSS
2755 This target allows to alter the MSS value of TCP SYN packets, to con‐
2756 trol the maximum size for that connection (usually limiting it to your
2757 outgoing interface's MTU minus 40 for IPv4 or 60 for IPv6, respec‐
2758 tively). Of course, it can only be used in conjunction with -p tcp.
2759 This target is used to overcome criminally braindead ISPs or servers
2761 which block "ICMP Fragmentation Needed" or "ICMPv6 Packet Too Big"
2762 packets. The symptoms of this problem are that everything works fine
2763 from your Linux firewall/router, but machines behind it can never
2764 exchange large packets:
2765 1. Web browsers connect, then hang with no data received.
2767 2. Small mail works fine, but large emails hang.
2769 3. ssh works fine, but scp hangs after initial handshaking.
2771 Workaround: activate this option and add a rule to your firewall con‐
2773 figuration like:
2774 iptables -t mangle -A FORWARD -p tcp --tcp-flags SYN,RST SYN
2776 -j TCPMSS --clamp-mss-to-pmtu
2777 --set-mss value
2779 Explicitly sets MSS option to specified value. If the MSS of the
2780 packet is already lower than value, it will not be increased
2781 (from Linux 2.6.25 onwards) to avoid more problems with hosts
2782 relying on a proper MSS.
2783 --clamp-mss-to-pmtu
2785 Automatically clamp MSS value to (path_MTU - 40 for IPv4; -60
2786 for IPv6). This may not function as desired where asymmetric
2787 routes with differing path MTU exist — the kernel uses the path
2788 MTU which it would use to send packets from itself to the source
2789 and destination IP addresses. Prior to Linux 2.6.25, only the
2790 path MTU to the destination IP address was considered by this
2791 option; subsequent kernels also consider the path MTU to the
2792 source IP address.
2793 These options are mutually exclusive.
2795 TCPOPTSTRIP
2797 This target will strip TCP options off a TCP packet. (It will actually
2798 replace them by NO-OPs.) As such, you will need to add the -p tcp
2799 parameters.
2800 --strip-options option[,option...]
2802 Strip the given option(s). The options may be specified by TCP
2803 option number or by symbolic name. The list of recognized
2804 options can be obtained by calling iptables with -j TCPOPTSTRIP
2805 -h.
2806 TEE
2808 The TEE target will clone a packet and redirect this clone to another
2809 machine on the local network segment. In other words, the nexthop must
2810 be the target, or you will have to configure the nexthop to forward it
2811 further if so desired.
2812 --gateway ipaddr
2814 Send the cloned packet to the host reachable at the given IP
2815 address. Use of 0.0.0.0 (for IPv4 packets) or :: (IPv6) is
2816 invalid.
2817 To forward all incoming traffic on eth0 to an Network Layer logging
2819 box:
2820 -t mangle -A PREROUTING -i eth0 -j TEE --gateway 2001:db8::1
2822 TOS
2824 This module sets the Type of Service field in the IPv4 header (includ‐
2825 ing the "precedence" bits) or the Priority field in the IPv6 header.
2826 Note that TOS shares the same bits as DSCP and ECN. The TOS target is
2827 only valid in the mangle table.
2828 --set-tos value[/mask]
2830 Zeroes out the bits given by mask (see NOTE below) and XORs
2831 value into the TOS/Priority field. If mask is omitted, 0xFF is
2832 assumed.
2833 --set-tos symbol
2835 You can specify a symbolic name when using the TOS target for
2836 IPv4. It implies a mask of 0xFF (see NOTE below). The list of
2837 recognized TOS names can be obtained by calling iptables with -j
2838 TOS -h.
2839 The following mnemonics are available:
2841 --and-tos bits
2843 Binary AND the TOS value with bits. (Mnemonic for --set-tos
2844 0/invbits, where invbits is the binary negation of bits. See
2845 NOTE below.)
2846 --or-tos bits
2848 Binary OR the TOS value with bits. (Mnemonic for --set-tos
2849 bits/bits. See NOTE below.)
2850 --xor-tos bits
2852 Binary XOR the TOS value with bits. (Mnemonic for --set-tos
2853 bits/0. See NOTE below.)
2854 NOTE: In Linux kernels up to and including 2.6.38, with the exception
2856 of longterm releases 2.6.32 (>=.42), 2.6.33 (>=.15), and 2.6.35
2857 (>=.14), there is a bug whereby IPv6 TOS mangling does not behave as
2858 documented and differs from the IPv4 version. The TOS mask indicates
2859 the bits one wants to zero out, so it needs to be inverted before
2860 applying it to the original TOS field. However, the aformentioned ker‐
2861 nels forgo the inversion which breaks --set-tos and its mnemonics.
2862 TPROXY
2864 This target is only valid in the mangle table, in the PREROUTING chain
2865 and user-defined chains which are only called from this chain. It redi‐
2866 rects the packet to a local socket without changing the packet header
2867 in any way. It can also change the mark value which can then be used in
2868 advanced routing rules. It takes three options:
2869 --on-port port
2871 This specifies a destination port to use. It is a required
2872 option, 0 means the new destination port is the same as the
2873 original. This is only valid if the rule also specifies -p tcp
2874 or -p udp.
2875 --on-ip address
2877 This specifies a destination address to use. By default the
2878 address is the IP address of the incoming interface. This is
2879 only valid if the rule also specifies -p tcp or -p udp.
2880 --tproxy-mark value[/mask]
2882 Marks packets with the given value/mask. The fwmark value set
2883 here can be used by advanced routing. (Required for transparent
2884 proxying to work: otherwise these packets will get forwarded,
2885 which is probably not what you want.)
2886 TRACE
2888 This target marks packets so that the kernel will log every rule which
2889 match the packets as those traverse the tables, chains, rules.
2890 A logging backend, such as ip(6)t_LOG or nfnetlink_log, must be loaded
2892 for this to be visible. The packets are logged with the string prefix:
2893 "TRACE: tablename:chainname:type:rulenum " where type can be "rule" for
2894 plain rule, "return" for implicit rule at the end of a user defined
2895 chain and "policy" for the policy of the built in chains.
2896 It can only be used in the raw table.
2897 TTL (IPv4-specific)
2899 This is used to modify the IPv4 TTL header field. The TTL field deter‐
2900 mines how many hops (routers) a packet can traverse until it's time to
2901 live is exceeded.
2902 Setting or incrementing the TTL field can potentially be very danger‐
2904 ous, so it should be avoided at any cost. This target is only valid in
2905 mangle table.
2906 Don't ever set or increment the value on packets that leave your local
2908 network!
2909 --ttl-set value
2911 Set the TTL value to `value'.
2912 --ttl-dec value
2914 Decrement the TTL value `value' times.
2915 --ttl-inc value
2917 Increment the TTL value `value' times.
2918 ULOG (IPv4-specific)
2920 This is the deprecated ipv4-only predecessor of the NFLOG target. It
2921 provides userspace logging of matching packets. When this target is
2922 set for a rule, the Linux kernel will multicast this packet through a
2923 netlink socket. One or more userspace processes may then subscribe to
2924 various multicast groups and receive the packets. Like LOG, this is a
2925 "non-terminating target", i.e. rule traversal continues at the next
2926 rule.
2927 --ulog-nlgroup nlgroup
2929 This specifies the netlink group (1-32) to which the packet is
2930 sent. Default value is 1.
2931 --ulog-prefix prefix
2933 Prefix log messages with the specified prefix; up to 32 charac‐
2934 ters long, and useful for distinguishing messages in the logs.
2935 --ulog-cprange size
2937 Number of bytes to be copied to userspace. A value of 0 always
2938 copies the entire packet, regardless of its size. Default is 0.
2939 --ulog-qthreshold size
2941 Number of packet to queue inside kernel. Setting this value to,
2942 e.g. 10 accumulates ten packets inside the kernel and transmits
2943 them as one netlink multipart message to userspace. Default is
2944 1 (for backwards compatibility).
2945iptables 1.8.0 iptables-extensions(8)