Merge to iptables-1.3.5
[iptables.git] / ip6tables.8
1 .TH IP6TABLES 8 "Jan 22, 2006" "" ""
2 .\"
3 .\" Man page written by Andras Kis-Szabo <kisza@sch.bme.hu>
4 .\" It is based on iptables man page.
5 .\"
6 .\" iptables page by Herve Eychenne <rv@wallfire.org>
7 .\" It is based on ipchains man page.
8 .\"
9 .\" ipchains page by Paul ``Rusty'' Russell March 1997
10 .\" Based on the original ipfwadm man page by Jos Vos <jos@xos.nl>
11 .\"
12 .\"     This program is free software; you can redistribute it and/or modify
13 .\"     it under the terms of the GNU General Public License as published by
14 .\"     the Free Software Foundation; either version 2 of the License, or
15 .\"     (at your option) any later version.
16 .\"
17 .\"     This program is distributed in the hope that it will be useful,
18 .\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
19 .\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 .\"     GNU General Public License for more details.
21 .\"
22 .\"     You should have received a copy of the GNU General Public License
23 .\"     along with this program; if not, write to the Free Software
24 .\"     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 .\"
26 .\"
27 .SH NAME
28 ip6tables \- IPv6 packet filter administration
29 .SH SYNOPSIS
30 .BR "ip6tables [-t table] -[AD] " "chain rule-specification [options]"
31 .br
32 .BR "ip6tables [-t table] -I " "chain [rulenum] rule-specification [options]"
33 .br
34 .BR "ip6tables [-t table] -R " "chain rulenum rule-specification [options]"
35 .br
36 .BR "ip6tables [-t table] -D " "chain rulenum [options]"
37 .br
38 .BR "ip6tables [-t table] -[LFZ] " "[chain] [options]"
39 .br
40 .BR "ip6tables [-t table] -N " "chain"
41 .br
42 .BR "ip6tables [-t table] -X " "[chain]"
43 .br
44 .BR "ip6tables [-t table] -P " "chain target [options]"
45 .br
46 .BR "ip6tables [-t table] -E " "old-chain-name new-chain-name"
47 .SH DESCRIPTION
48 .B Ip6tables
49 is used to set up, maintain, and inspect the tables of IPv6 packet
50 filter rules in the Linux kernel.  Several different tables
51 may be defined.  Each table contains a number of built-in
52 chains and may also contain user-defined chains.
53
54 Each chain is a list of rules which can match a set of packets.  Each
55 rule specifies what to do with a packet that matches.  This is called
56 a `target', which may be a jump to a user-defined chain in the same
57 table.
58
59 .SH TARGETS
60 A firewall rule specifies criteria for a packet, and a target.  If the
61 packet does not match, the next rule in the chain is the examined; if
62 it does match, then the next rule is specified by the value of the
63 target, which can be the name of a user-defined chain or one of the
64 special values 
65 .IR ACCEPT ,
66 .IR DROP ,
67 .IR QUEUE ,
68 or
69 .IR RETURN .
70 .PP
71 .I ACCEPT 
72 means to let the packet through.
73 .I DROP
74 means to drop the packet on the floor.
75 .I QUEUE
76 means to pass the packet to userspace.  (How the packet can be received
77 by a userspace process differs by the particular queue handler.  2.4.x
78 and 2.6.x kernels up to 2.6.13 include the 
79 .B
80 ip_queue
81 queue handler.  Kernels 2.6.14 and later additionally include the 
82 .B
83 nfnetlink_queue
84 queue handler.  Packets with a target of QUEUE will be sent to queue number '0'
85 in this case. Please also see the
86 .B
87 NFQUEUE
88 target as described later in this man page.)
89 .I RETURN
90 means stop traversing this chain and resume at the next rule in the
91 previous (calling) chain.  If the end of a built-in chain is reached
92 or a rule in a built-in chain with target
93 .I RETURN
94 is matched, the target specified by the chain policy determines the
95 fate of the packet.
96 .SH TABLES
97 There are currently two independent tables (which tables are present
98 at any time depends on the kernel configuration options and which
99 modules are present), as nat table has not been implemented yet.
100 .TP
101 .BI "-t, --table " "table"
102 This option specifies the packet matching table which the command
103 should operate on.  If the kernel is configured with automatic module
104 loading, an attempt will be made to load the appropriate module for
105 that table if it is not already there.
106
107 The tables are as follows:
108 .RS
109 .TP .4i
110 .BR "filter" :
111 This is the default table (if no -t option is passed).  It contains
112 the built-in chains
113 .B INPUT
114 (for packets coming into the box itself),
115 .B FORWARD
116 (for packets being routed through the box), and
117 .B OUTPUT
118 (for locally-generated packets).
119 .TP
120 .BR "mangle" :
121 This table is used for specialized packet alteration.  Until kernel
122 2.4.17 it had two built-in chains:
123 .B PREROUTING
124 (for altering incoming packets before routing) and
125 .B OUTPUT
126 (for altering locally-generated packets before routing).
127 Since kernel 2.4.18, three other built-in chains are also supported:
128 .B INPUT
129 (for packets coming into the box itself),
130 .B FORWARD
131 (for altering packets being routed through the box), and
132 .B POSTROUTING
133 (for altering packets as they are about to go out).
134 .TP
135 .BR "raw" :
136 This table is used mainly for configuring exemptions from connection
137 tracking in combination with the NOTRACK target.  It registers at the netfilter
138 hooks with higher priority and is thus called before nf_conntrack, or any other
139 IP6 tables.  It provides the following built-in chains:
140 .B PREROUTING
141 (for packets arriving via any network interface)
142 .B OUTPUT
143 (for packets generated by local processes)
144 .RE
145 .SH OPTIONS
146 The options that are recognized by
147 .B ip6tables
148 can be divided into several different groups.
149 .SS COMMANDS
150 These options specify the specific action to perform.  Only one of them
151 can be specified on the command line unless otherwise specified
152 below.  For all the long versions of the command and option names, you
153 need to use only enough letters to ensure that
154 .B ip6tables
155 can differentiate it from all other options.
156 .TP
157 .BI "-A, --append " "chain rule-specification"
158 Append one or more rules to the end of the selected chain.
159 When the source and/or destination names resolve to more than one
160 address, a rule will be added for each possible address combination.
161 .TP
162 .BI "-D, --delete " "chain rule-specification"
163 .ns
164 .TP
165 .BI "-D, --delete " "chain rulenum"
166 Delete one or more rules from the selected chain.  There are two
167 versions of this command: the rule can be specified as a number in the
168 chain (starting at 1 for the first rule) or a rule to match.
169 .TP
170 .B "-I, --insert"
171 Insert one or more rules in the selected chain as the given rule
172 number.  So, if the rule number is 1, the rule or rules are inserted
173 at the head of the chain.  This is also the default if no rule number
174 is specified.
175 .TP
176 .BI "-R, --replace " "chain rulenum rule-specification"
177 Replace a rule in the selected chain.  If the source and/or
178 destination names resolve to multiple addresses, the command will
179 fail.  Rules are numbered starting at 1.
180 .TP
181 .BR "-L, --list " "[\fIchain\fP]"
182 List all rules in the selected chain.  If no chain is selected, all
183 chains are listed.  As every other iptables command, it applies to the
184 specified table (filter is the default), so mangle rules get listed by
185 .nf
186  ip6tables -t mangle -n -L
187 .fi
188 Please note that it is often used with the
189 .B -n
190 option, in order to avoid long reverse DNS lookups.
191 It is legal to specify the
192 .B -Z
193 (zero) option as well, in which case the chain(s) will be atomically
194 listed and zeroed.  The exact output is affected by the other
195 arguments given. The exact rules are suppressed until you use
196 .nf
197  ip6tables -L -v
198 .fi
199 .TP
200 .BR "-F, --flush " "[\fIchain\fP]"
201 Flush the selected chain (all the chains in the table if none is given).
202 This is equivalent to deleting all the rules one by one.
203 .TP
204 .BR "-Z, --zero " "[\fIchain\fP]"
205 Zero the packet and byte counters in all chains.  It is legal to
206 specify the
207 .B "-L, --list"
208 (list) option as well, to see the counters immediately before they are
209 cleared. (See above.)
210 .TP
211 .BI "-N, --new-chain " "chain"
212 Create a new user-defined chain by the given name.  There must be no
213 target of that name already.
214 .TP
215 .BR "-X, --delete-chain " "[\fIchain\fP]"
216 Delete the optional user-defined chain specified.  There must be no references
217 to the chain.  If there are, you must delete or replace the referring
218 rules before the chain can be deleted.  If no argument is given, it
219 will attempt to delete every non-builtin chain in the table.
220 .TP
221 .BI "-P, --policy " "chain target"
222 Set the policy for the chain to the given target.  See the section
223 .B TARGETS
224 for the legal targets.  Only built-in (non-user-defined) chains can have
225 policies, and neither built-in nor user-defined chains can be policy
226 targets.
227 .TP
228 .BI "-E, --rename-chain " "old-chain new-chain"
229 Rename the user specified chain to the user supplied name.  This is
230 cosmetic, and has no effect on the structure of the table.
231 .TP
232 .B -h
233 Help.
234 Give a (currently very brief) description of the command syntax.
235 .SS PARAMETERS
236 The following parameters make up a rule specification (as used in the
237 add, delete, insert, replace and append commands).
238 .TP
239 .BR "-p, --protocol " "[!] \fIprotocol\fP"
240 The protocol of the rule or of the packet to check.
241 The specified protocol can be one of
242 .IR tcp ,
243 .IR udp ,
244 .IR icmpv6 ,
245 .IR esp ,
246 .IR all ,
247 or it can be a numeric value, representing one of these protocols or a
248 different one. A protocol name from /etc/protocols is also allowed.
249 But IPv6 extension headers except
250 .IR esp
251 are not allowed.
252 .IR esp ,
253 and
254 .IR ipv6-nonext
255 can be used with Kernel version 2.6.11 or later.
256 A "!" argument before the protocol inverts the
257 test.  The number zero is equivalent to
258 .IR all .
259 Protocol
260 .I all
261 will match with all protocols and is taken as default when this
262 option is omitted.
263 .TP
264 .BR "-s, --source " "[!] \fIaddress\fP[/\fImask\fP]"
265 Source specification.
266 .I Address
267 can be either a hostname (please note that specifying
268 any name to be resolved with a remote query such as DNS is a really bad idea),
269 a network IPv6 address (with /mask), or a plain IPv6 address.
270 (the network name isn't supported now).
271 The
272 .I mask
273 can be either a network mask or a plain number,
274 specifying the number of 1's at the left side of the network mask.
275 Thus, a mask of
276 .I 64
277 is equivalent to
278 .IR ffff:ffff:ffff:ffff:0000:0000:0000:0000 .
279 A "!" argument before the address specification inverts the sense of
280 the address. The flag
281 .B --src
282 is an alias for this option.
283 .TP
284 .BR "-d, --destination " "[!] \fIaddress\fP[/\fImask\fP]"
285 Destination specification. 
286 See the description of the
287 .B -s
288 (source) flag for a detailed description of the syntax.  The flag
289 .B --dst
290 is an alias for this option.
291 .TP
292 .BI "-j, --jump " "target"
293 This specifies the target of the rule; i.e., what to do if the packet
294 matches it.  The target can be a user-defined chain (other than the
295 one this rule is in), one of the special builtin targets which decide
296 the fate of the packet immediately, or an extension (see
297 .B EXTENSIONS
298 below).  If this
299 option is omitted in a rule, then matching the rule will have no
300 effect on the packet's fate, but the counters on the rule will be
301 incremented.
302 .TP
303 .BR "-i, --in-interface " "[!] \fIname\fP"
304 Name of an interface via which a packet is going to be received (only for
305 packets entering the 
306 .BR INPUT ,
307 .B FORWARD
308 and
309 .B PREROUTING
310 chains).  When the "!" argument is used before the interface name, the
311 sense is inverted.  If the interface name ends in a "+", then any
312 interface which begins with this name will match.  If this option is
313 omitted, any interface name will match.
314 .TP
315 .BR "-o, --out-interface " "[!] \fIname\fP"
316 Name of an interface via which a packet is going to be sent (for packets
317 entering the
318 .BR FORWARD 
319 and
320 .B OUTPUT
321 chains).  When the "!" argument is used before the interface name, the
322 sense is inverted.  If the interface name ends in a "+", then any
323 interface which begins with this name will match.  If this option is
324 omitted, any interface name will match.
325 .TP
326 .\" Currently not supported (header-based)
327 .\" 
328 .\" .B "[!] " "-f, --fragment"
329 .\" This means that the rule only refers to second and further fragments
330 .\" of fragmented packets.  Since there is no way to tell the source or
331 .\" destination ports of such a packet (or ICMP type), such a packet will
332 .\" not match any rules which specify them.  When the "!" argument
333 .\" precedes the "-f" flag, the rule will only match head fragments, or
334 .\" unfragmented packets.
335 .\" .TP
336 .B "-c, --set-counters " "PKTS BYTES"
337 This enables the administrator to initialize the packet and byte
338 counters of a rule (during
339 .B INSERT,
340 .B APPEND,
341 .B REPLACE
342 operations).
343 .SS "OTHER OPTIONS"
344 The following additional options can be specified:
345 .TP
346 .B "-v, --verbose"
347 Verbose output.  This option makes the list command show the interface
348 name, the rule options (if any), and the TOS masks.  The packet and
349 byte counters are also listed, with the suffix 'K', 'M' or 'G' for
350 1000, 1,000,000 and 1,000,000,000 multipliers respectively (but see
351 the
352 .B -x
353 flag to change this).
354 For appending, insertion, deletion and replacement, this causes
355 detailed information on the rule or rules to be printed.
356 .TP
357 .B "-n, --numeric"
358 Numeric output.
359 IP addresses and port numbers will be printed in numeric format.
360 By default, the program will try to display them as host names,
361 network names, or services (whenever applicable).
362 .TP
363 .B "-x, --exact"
364 Expand numbers.
365 Display the exact value of the packet and byte counters,
366 instead of only the rounded number in K's (multiples of 1000)
367 M's (multiples of 1000K) or G's (multiples of 1000M).  This option is
368 only relevant for the 
369 .B -L
370 command.
371 .TP
372 .B "--line-numbers"
373 When listing rules, add line numbers to the beginning of each rule,
374 corresponding to that rule's position in the chain.
375 .TP
376 .B "--modprobe=command"
377 When adding or inserting rules into a chain, use
378 .B command
379 to load any necessary modules (targets, match extensions, etc).
380 .SH MATCH EXTENSIONS
381 ip6tables can use extended packet matching modules.  These are loaded
382 in two ways: implicitly, when
383 .B -p
384 or
385 .B --protocol
386 is specified, or with the
387 .B -m
388 or
389 .B --match
390 options, followed by the matching module name; after these, various
391 extra command line options become available, depending on the specific
392 module.  You can specify multiple extended match modules in one line,
393 and you can use the
394 .B -h
395 or
396 .B --help
397 options after the module has been specified to receive help specific
398 to that module.
399
400 The following are included in the base package, and most of these can
401 be preceded by a
402 .B !
403 to invert the sense of the match.
404 .\" @MATCH@
405 .SS ah
406 This module matches the parameters in Authentication header of IPsec packets.
407 .TP
408 .BR "--ahspi " "[!] \fIspi\fP[:\fIspi\fP]"
409 Matches SPI.
410 .TP
411 .BR "--ahlen " "[!] \fIlength"
412 Total length of this header in octets.
413 .TP
414 .BI "--ahres"
415 Matches if the reserved field is filled with zero.
416 .SS condition
417 This matches if a specific /proc filename is '0' or '1'.
418 .TP
419 .BR "--condition " "[!] \fIfilename"
420 Match on boolean value stored in /proc/net/ip6t_condition/filename file
421 .SS dst
422 This module matches the parameters in Destination Options header
423 .TP
424 .BR "--dst-len " "[!] \fIlength"
425 Total length of this header in octets.
426 .TP
427 .BR "--dst-opts " "\fItype\fP[:\fIlength\fP][,\fItype\fP[:\fIlength\fP]...]"
428 numeric type of option and the length of the option data in octets.
429 .SS esp
430 This module matches the SPIs in ESP header of IPsec packets.
431 .TP
432 .BR "--espspi " "[!] \fIspi\fP[:\fIspi\fP]"
433 .SS eui64
434 This module matches the EUI-64 part of a stateless autoconfigured IPv6 address.
435 It compares the EUI-64 derived from the source MAC address in Ehternet frame
436 with the lower 64 bits of the IPv6 source address. But "Universal/Local"
437 bit is not compared. This module doesn't match other link layer frame, and
438 is only valid in the
439 .BR PREROUTING ,
440 .BR INPUT
441 and
442 .BR FORWARD
443 chains.
444 .SS frag
445 This module matches the parameters in Fragment header.
446 .TP
447 .BR "--fragid " "[!] \fIid\fP[:\fIid\fP]"
448 Matches the given Identification or range of it.
449 .TP
450 .BR "--fraglen " "[!] \fIlength\fP"
451 This option cannot be used with kernel version 2.6.10 or later. The length of
452 Fragment header is static and this option doesn't make sense.
453 .TP
454 .BR "--fragres "
455 Matches if the reserved fields are filled with zero.
456 .TP
457 .BR "--fragfirst "
458 Matches on the first fragment.
459 .TP
460 .BR "[--fragmore]"
461 Matches if there are more fragments.
462 .TP
463 .BR "[--fraglast]"
464 Matches if this is the last fragement.
465 .SS fuzzy
466 This module matches a rate limit based on a fuzzy logic controller [FLC]
467 .TP
468 .BI "--lower-limit " "number"
469 Specifies the lower limit (in packets per second).
470 .TP
471 .BI "--upper-limit " "number"
472 Specifies the upper limit (in packets per second).
473 .SS hbh
474 This module matches the parameters in Hop-by-Hop Options header
475 .TP
476 .BR "--hbh-len " "[!] \fIlength\fP"
477 Total length of this header in octets.
478 .TP
479 .BR "--hbh-opts " "\fItype\fP[:\fIlength\fP][,\fItype\fP[:\fIlength\fP]...]"
480 numeric type of option and the length of the option data in octets.
481 .SS hl
482 This module matches the Hop Limit field in the IPv6 header.
483 .TP
484 .BR "--hl-eq " "[!] \fIvalue\fP"
485 Matches if Hop Limit equals \fIvalue\fP.
486 .TP
487 .BI "--hl-lt " "value"
488 Matches if Hop Limit is less than \fIvalue\fP.
489 .TP
490 .BI "--hl-gt " "value"
491 Matches if Hop Limit is greater than \fIvalue\fP.
492 .SS icmpv6
493 This extension is loaded if `--protocol ipv6-icmp' or `--protocol icmpv6' is
494 specified. It provides the following option:
495 .TP
496 .BR "--icmpv6-type " "[!] \fItype\fP[/\fIcode\fP]|\fItypename\fP"
497 This allows specification of the ICMPv6 type, which can be a numeric
498 ICMPv6
499 .IR type ,
500 .IR type
501 and
502 .IR code ,
503 or one of the ICMPv6 type names shown by the command
504 .nf
505  ip6tables -p ipv6-icmp -h
506 .fi
507 .SS ipv6header
508 This module matches IPv6 extension headers and/or upper layer header.
509 .TP
510 .BR "--header " "[!] \fIheader\fP[,\fIheader\fP...]"
511 Matches the packet which EXACTLY includes all specified headers. The headers
512 encapsulated with ESP header are out of scope.
513 .IR header
514 can be
515 .IR hop | hop-by-hop
516 (Hop-by-Hop Options header),
517 .IR dst
518 (Destination Options header),
519 .IR route
520 (Routing header),
521 .IR frag
522 (Fragment header),
523 .IR auth
524 (Authentication header),
525 .IR esp
526 (Encapsulating Security Payload header),
527 .IR none
528 (No Next header) which matches 59 in the 'Next Header field' of IPv6 header or any IPv6 extension headers, or
529 .IR proto
530 which matches any upper layer protocol header. A protocol name from /etc/protocols and numeric value also allowed. The number 255 is equivalent to
531 .IR proto .
532 .TP
533 .BR "[--soft]"
534 Matches if the packet includes all specified headers with
535 .BR --header ,
536 AT LEAST.
537 .SS length
538 This module matches the length of the IPv6 payload in octets, or range of it.
539 IPv6 header itself isn't counted.
540 .TP
541 .BR "--length " "[!] \fIlength\fP[:\fIlength\fP]"
542 .SS limit
543 This module matches at a limited rate using a token bucket filter.
544 A rule using this extension will match until this limit is reached
545 (unless the `!' flag is used).  It can be used in combination with the
546 .B LOG
547 target to give limited logging, for example.
548 .TP
549 .BI "--limit " "rate"
550 Maximum average matching rate: specified as a number, with an optional
551 `/second', `/minute', `/hour', or `/day' suffix; the default is
552 3/hour.
553 .TP
554 .BI "--limit-burst " "number"
555 Maximum initial number of packets to match: this number gets
556 recharged by one every time the limit specified above is not reached,
557 up to this number; the default is 5.
558 .SS mac
559 .TP
560 .BR "--mac-source " "[!] \fIaddress\fP"
561 Match source MAC address.  It must be of the form XX:XX:XX:XX:XX:XX.
562 Note that this only makes sense for packets coming from an Ethernet device
563 and entering the
564 .BR PREROUTING ,
565 .B FORWARD
566 or
567 .B INPUT
568 chains.
569 .SS mark
570 This module matches the netfilter mark field associated with a packet
571 (which can be set using the
572 .B MARK
573 target below).
574 .TP
575 .BR "--mark " "\fIvalue\fP[/\fImask\fP]"
576 Matches packets with the given unsigned mark value (if a \fImask\fP is
577 specified, this is logically ANDed with the \fImask\fP before the
578 comparison).
579 .SS multiport
580 This module matches a set of source or destination ports.  Up to 15
581 ports can be specified.  A port range (port:port) counts as two
582 ports, but range isn't supported now. It can only be used in conjunction
583 with
584 .B "-p tcp"
585 or
586 .BR "-p udp" .
587 .TP
588 .BR "--source-ports " "\fI[!] port\fP[,\fIport\fP[,\fIport:port\fP...]]"
589 Match if the source port is one of the given ports.  The flag
590 .B --sports
591 is a convenient alias for this option.
592 .TP
593 .BR "--destination-ports " "\fI[!] port\fP[,\fIport\fP[,\fIport:port\fP...]]"
594 Match if the destination port is one of the given ports.  The flag
595 .B --dports
596 is a convenient alias for this option.
597 .TP
598 .BR "--ports " "\fI[!] port\fP[,\fIport\fP[,\fIport:port\fP...]]"
599 Match if the both the source and destination ports are equal to each
600 other and to one of the given ports.
601 .SS nth
602 This module matches every `n'th packet
603 .TP
604 .BI "--every " "value"
605 Match every `value' packet
606 .TP
607 .BI "[" "--counter " "num" "]"
608 Use internal counter number `num'.  Default is `0'.
609 .TP
610 .BI "[" "--start " "num" "]"
611 Initialize the counter at the number `num' insetad of `0'.  Most between `0'
612 and `value'-1.
613 .TP
614 .BI "[" "--packet " "num" "]"
615 Match on `num' packet.  Most be between `0' and `value'-1.
616 .SS owner
617 This module attempts to match various characteristics of the packet
618 creator, for locally-generated packets.  It is only valid in the
619 .B OUTPUT
620 chain, and even this some packets (such as ICMPv6 ping responses) may
621 have no owner, and hence never match.  This is regarded as experimental.
622 .TP
623 .BI "--uid-owner " "userid"
624 Matches if the packet was created by a process with the given
625 effective user id.
626 .TP
627 .BI "--gid-owner " "groupid"
628 Matches if the packet was created by a process with the given
629 effective group id.
630 .TP
631 .BI "--pid-owner " "processid"
632 Matches if the packet was created by a process with the given
633 process id.
634 .TP
635 .BI "--sid-owner " "sessionid"
636 Matches if the packet was created by a process in the given session
637 group.
638 .TP
639 .B NOTE: pid, sid and command matching are broken on SMP
640 .SS physdev
641 This module matches on the bridge port input and output devices enslaved
642 to a bridge device. This module is a part of the infrastructure that enables
643 a transparent bridging IP firewall and is only useful for kernel versions
644 above version 2.5.44.
645 .TP
646 .BR --physdev-in " [!] \fIname\fP"
647 Name of a bridge port via which a packet is received (only for
648 packets entering the
649 .BR INPUT ,
650 .B FORWARD
651 and
652 .B PREROUTING
653 chains). If the interface name ends in a "+", then any
654 interface which begins with this name will match. If the packet didn't arrive
655 through a bridge device, this packet won't match this option, unless '!' is used.
656 .TP
657 .BR --physdev-out " [!] \fIname\fP"
658 Name of a bridge port via which a packet is going to be sent (for packets
659 entering the
660 .BR FORWARD ,
661 .B OUTPUT
662 and
663 .B POSTROUTING
664 chains).  If the interface name ends in a "+", then any
665 interface which begins with this name will match. Note that in the
666 .BR nat " and " mangle
667 .B OUTPUT
668 chains one cannot match on the bridge output port, however one can in the
669 .B "filter OUTPUT"
670 chain. If the packet won't leave by a bridge device or it is yet unknown what
671 the output device will be, then the packet won't match this option, unless
672 '!' is used.
673 .TP
674 .RB "[!] " --physdev-is-in
675 Matches if the packet has entered through a bridge interface.
676 .TP
677 .RB "[!] " --physdev-is-out
678 Matches if the packet will leave through a bridge interface.
679 .TP
680 .RB "[!] " --physdev-is-bridged
681 Matches if the packet is being bridged and therefore is not being routed.
682 This is only useful in the FORWARD and POSTROUTING chains.
683 .SS policy
684 This modules matches the policy used by IPsec for handling a packet.
685 .TP
686 .BI "--dir " "in|out"
687 Used to select whether to match the policy used for decapsulation or the
688 policy that will be used for encapsulation.
689 .B in
690 is valid in the
691 .B PREROUTING, INPUT and FORWARD
692 chains,
693 .B out
694 is valid in the
695 .B POSTROUTING, OUTPUT and FORWARD
696 chains.
697 .TP
698 .BI "--pol " "none|ipsec"
699 Matches if the packet is subject to IPsec processing.
700 .TP
701 .BI "--strict"
702 Selects whether to match the exact policy or match if any rule of
703 the policy matches the given policy.
704 .TP
705 .BI "--reqid " "id"
706 Matches the reqid of the policy rule. The reqid can be specified with
707 .B setkey(8)
708 using
709 .B unique:id
710 as level.
711 .TP
712 .BI "--spi " "spi"
713 Matches the SPI of the SA.
714 .TP
715 .BI "--proto " "ah|esp|ipcomp"
716 Matches the encapsulation protocol.
717 .TP
718 .BI "--mode " "tunnel|transport"
719 Matches the encapsulation mode.
720 .TP
721 .BI "--tunnel-src " "addr[/mask]"
722 Matches the source end-point address of a tunnel mode SA.
723 Only valid with --mode tunnel.
724 .TP
725 .BI "--tunnel-dst " "addr[/mask]"
726 Matches the destination end-point address of a tunnel mode SA.
727 Only valid with --mode tunnel.
728 .TP
729 .BI "--next"
730 Start the next element in the policy specification. Can only be used with
731 --strict
732 .SS random
733 This module randomly matches a certain percentage of all packets.
734 .TP
735 .BI "--average " "percent"
736 Matches the given percentage.  If omitted, a probability of 50% is set. 
737 .SS rt
738 Match on IPv6 routing header
739 .TP
740 .BR "--rt-type" " [!] \fItype\fP"
741 Match the type (numeric).
742 .TP
743 .BR "--rt-segsleft" " [!] \fInum\fP[:\fInum\fP]"
744 Match the `segments left' field (range).
745 .TP
746 .BR "--rt-len" " [!] \fIlength\fP"
747 Match the length of this header.
748 .TP
749 .BR "--rt-0-res"
750 Match the reserved field, too (type=0)
751 .TP
752 .BR "--rt-0-addrs" " \fIADDR\fP[,\fIADDR\fP...]"
753 Match type=0 addresses (list).
754 .TP
755 .BR "--rt-0-not-strict"
756 List of type=0 addresses is not a strict list.
757 .SS tcp
758 These extensions are loaded if `--protocol tcp' is specified. It
759 provides the following options:
760 .TP
761 .BR "--source-port " "[!] \fIport\fP[:\fIport\fP]"
762 Source port or port range specification. This can either be a service
763 name or a port number. An inclusive range can also be specified,
764 using the format
765 .IR port : port .
766 If the first port is omitted, "0" is assumed; if the last is omitted,
767 "65535" is assumed.
768 If the second port greater then the first they will be swapped.
769 The flag
770 .B --sport
771 is a convenient alias for this option.
772 .TP
773 .BR "--destination-port " "[!] \fIport\fP[:\fIport\fP]"
774 Destination port or port range specification.  The flag
775 .B --dport
776 is a convenient alias for this option.
777 .TP
778 .BR "--tcp-flags " "[!] \fImask\fP \fIcomp\fP"
779 Match when the TCP flags are as specified.  The first argument is the
780 flags which we should examine, written as a comma-separated list, and
781 the second argument is a comma-separated list of flags which must be
782 set.  Flags are: 
783 .BR "SYN ACK FIN RST URG PSH ALL NONE" .
784 Hence the command
785 .nf
786  ip6tables -A FORWARD -p tcp --tcp-flags SYN,ACK,FIN,RST SYN
787 .fi
788 will only match packets with the SYN flag set, and the ACK, FIN and
789 RST flags unset.
790 .TP
791 .B "[!] --syn"
792 Only match TCP packets with the SYN bit set and the ACK and RST bits
793 cleared.  Such packets are used to request TCP connection initiation;
794 for example, blocking such packets coming in an interface will prevent
795 incoming TCP connections, but outgoing TCP connections will be
796 unaffected.
797 It is equivalent to \fB--tcp-flags SYN,RST,ACK SYN\fP.
798 If the "!" flag precedes the "--syn", the sense of the
799 option is inverted.
800 .TP
801 .BR "--tcp-option " "[!] \fInumber\fP"
802 Match if TCP option set.
803 .SS udp
804 These extensions are loaded if `--protocol udp' is specified.  It
805 provides the following options:
806 .TP
807 .BR "--source-port " "[!] \fIport\fP[:\fIport\fP]"
808 Source port or port range specification.
809 See the description of the
810 .B --source-port
811 option of the TCP extension for details.
812 .TP
813 .BR "--destination-port " "[!] \fIport\fP[:\fIport\fP]"
814 Destination port or port range specification.
815 See the description of the
816 .B --destination-port
817 option of the TCP extension for details.
818 .SH TARGET EXTENSIONS
819 ip6tables can use extended target modules: the following are included
820 in the standard distribution.
821 .\" @TARGET@
822 .SS HL
823 This is used to modify the Hop Limit field in IPv6 header. The Hop Limit field
824 is similar to what is known as TTL value in IPv4.  Setting or incrementing the
825 Hop Limit field can potentially be very dangerous, so it should be avoided at
826 any cost. This target is only valid in
827 .B mangle
828 table.
829 .TP
830 .B Don't ever set or increment the value on packets that leave your local network!
831 .TP
832 .BI "--hl-set " "value"
833 Set the Hop Limit to `value'.
834 .TP
835 .BI "--hl-dec " "value"
836 Decrement the Hop Limit `value' times.
837 .TP
838 .BI "--hl-inc " "value"
839 Increment the Hop Limit `value' times.
840 .SS LOG
841 Turn on kernel logging of matching packets.  When this option is set
842 for a rule, the Linux kernel will print some information on all
843 matching packets (like most IPv6 IPv6-header fields) via the kernel log
844 (where it can be read with
845 .I dmesg
846 or 
847 .IR syslogd (8)).
848 This is a "non-terminating target", i.e. rule traversal continues at
849 the next rule.  So if you want to LOG the packets you refuse, use two
850 separate rules with the same matching criteria, first using target LOG
851 then DROP (or REJECT).
852 .TP
853 .BI "--log-level " "level"
854 Level of logging (numeric or see \fIsyslog.conf\fP(5)).
855 .TP
856 .BI "--log-prefix " "prefix"
857 Prefix log messages with the specified prefix; up to 29 letters long,
858 and useful for distinguishing messages in the logs.
859 .TP
860 .B --log-tcp-sequence
861 Log TCP sequence numbers. This is a security risk if the log is
862 readable by users.
863 .TP
864 .B --log-tcp-options
865 Log options from the TCP packet header.
866 .TP
867 .B --log-ip-options
868 Log options from the IPv6 packet header.
869 .TP
870 .B --log-uid
871 Log the userid of the process which generated the packet.
872 .SS MARK
873 This is used to set the netfilter mark value associated with the
874 packet.  It is only valid in the
875 .B mangle
876 table.
877 .TP
878 .BI "--set-mark " "mark"
879 .SS NFQUEUE
880 This target is an extension of the QUEUE target. As opposed to QUEUE, it allows
881 you to put a packet into any specific queue, identified by its 16-bit queue
882 number.  
883 .TP
884 .BR "--queue-num " "\fIvalue"
885 This specifies the QUEUE number to use. Valud queue numbers are 0 to 65535. The default value is 0.
886 .TP
887 It can only be used with Kernel versions 2.6.14 or later, since it requires
888 the
889 .B
890 nfnetlink_queue
891 kernel support.
892 .SS REJECT
893 This is used to send back an error packet in response to the matched
894 packet: otherwise it is equivalent to 
895 .B DROP
896 so it is a terminating TARGET, ending rule traversal.
897 This target is only valid in the
898 .BR INPUT ,
899 .B FORWARD
900 and
901 .B OUTPUT
902 chains, and user-defined chains which are only called from those
903 chains.  The following option controls the nature of the error packet
904 returned:
905 .TP
906 .BI "--reject-with " "type"
907 The type given can be
908 .nf
909 .B " icmp6-no-route"
910 .B " no-route"
911 .B " icmp6-adm-prohibited"
912 .B " adm-prohibited"
913 .B " icmp6-addr-unreachable"
914 .B " addr-unreach"
915 .B " icmp6-port-unreachable"
916 .B " port-unreach"
917 .fi
918 which return the appropriate ICMPv6 error message (\fBport-unreach\fP is
919 the default). Finally, the option
920 .B tcp-reset
921 can be used on rules which only match the TCP protocol: this causes a
922 TCP RST packet to be sent back.  This is mainly useful for blocking 
923 .I ident
924 (113/tcp) probes which frequently occur when sending mail to broken mail
925 hosts (which won't accept your mail otherwise).
926 .B tcp-reset
927 can only be used with kernel versions 2.6.14 or latter.
928
929 .SS ROUTE
930 This is used to explicitly override the core network stack's routing decision.
931 .B mangle
932 table.
933 .TP
934 .BI "--oif " "ifname"
935 Route the packet through `ifname' network interface
936 .TP
937 .BI "--gw " "IPv6_address"
938 Route the packet via this gateway
939 .TP
940 .BI "--continue "
941 Behave like a non-terminating target and continue traversing the rules. Not valid in combination with `--tee'
942 .TP
943 .BI "--tee "
944 Make a copy of the packet, and route that copy to the given destination. For the original, uncopied packet, behave like a non-terminating target and continue traversing the rules.  Not valid in combination with `--continue'
945 .SS TRACE
946 This target has no options.  It just turns on 
947 .B packet tracing
948 for all packets that match this rule.
949 .SH DIAGNOSTICS
950 Various error messages are printed to standard error.  The exit code
951 is 0 for correct functioning.  Errors which appear to be caused by
952 invalid or abused command line parameters cause an exit code of 2, and
953 other errors cause an exit code of 1.
954 .SH BUGS
955 Bugs?  What's this? ;-)
956 Well... the counters are not reliable on sparc64.
957 .SH COMPATIBILITY WITH IPCHAINS
958 This 
959 .B ip6tables
960 is very similar to ipchains by Rusty Russell.  The main difference is
961 that the chains 
962 .B INPUT
963 and
964 .B OUTPUT
965 are only traversed for packets coming into the local host and
966 originating from the local host respectively.  Hence every packet only
967 passes through one of the three chains (except loopback traffic, which
968 involves both INPUT and OUTPUT chains); previously a forwarded packet
969 would pass through all three.
970 .PP
971 The other main difference is that 
972 .B -i
973 refers to the input interface;
974 .B -o
975 refers to the output interface, and both are available for packets
976 entering the
977 .B FORWARD
978 chain.
979 .\" .PP The various forms of NAT have been separated out; 
980 .\" .B iptables 
981 .\" is a pure packet filter when using the default `filter' table, with
982 .\" optional extension modules.  This should simplify much of the previous
983 .\" confusion over the combination of IP masquerading and packet filtering
984 .\" seen previously.  So the following options are handled differently:
985 .\" .br
986 .\" -j MASQ
987 .\" .br
988 .\" -M -S
989 .\" .br
990 .\" -M -L
991 .\" .br
992 There are several other changes in ip6tables.
993 .SH SEE ALSO
994 .BR ip6tables-save (8),
995 .BR ip6tables-restore(8),
996 .BR iptables (8),
997 .BR iptables-save (8),
998 .BR iptables-restore (8),
999 .BR libipq (3).
1000 .P
1001 The packet-filtering-HOWTO details iptables usage for
1002 packet filtering, the NAT-HOWTO details NAT,
1003 the netfilter-extensions-HOWTO details the extensions that are
1004 not in the standard distribution,
1005 and the netfilter-hacking-HOWTO details the netfilter internals.
1006 .br
1007 See
1008 .BR "http://www.netfilter.org/" .
1009 .SH AUTHORS
1010 Rusty Russell wrote iptables, in early consultation with Michael
1011 Neuling.
1012 .PP
1013 Marc Boucher made Rusty abandon ipnatctl by lobbying for a generic packet
1014 selection framework in iptables, then wrote the mangle table, the owner match,
1015 the mark stuff, and ran around doing cool stuff everywhere.
1016 .PP
1017 James Morris wrote the TOS target, and tos match.
1018 .PP
1019 Jozsef Kadlecsik wrote the REJECT target.
1020 .PP
1021 Harald Welte wrote the ULOG and NFQUEUE target, the new libiptc, aswell as TTL match+target and libipulog.
1022 .PP
1023 The Netfilter Core Team is: Marc Boucher, Martin Josefsson, Jozsef Kadlecsik,
1024 James Morris, Harald Welte and Rusty Russell.
1025 .PP
1026 ip6tables man page created by Andras Kis-Szabo, based on
1027 iptables man page written by Herve Eychenne <rv@wallfire.org>.
1028 .\" .. and did I mention that we are incredibly cool people?
1029 .\" .. sexy, too ..
1030 .\" .. witty, charming, powerful ..
1031 .\" .. and most of all, modest ..