manpages: do not include v4-only modules in ip6tables manpage
[jleu-iptables.git] / extensions / libxt_recent.man
blobe03d8ece58fc8344ec407ef69985184f51aef157
1 Allows you to dynamically create a list of IP addresses and then match against
2 that list in a few different ways.
3 .PP
4 For example, you can create a "badguy" list out of people attempting to connect
5 to port 139 on your firewall and then DROP all future packets from them without
6 considering them.
7 .TP
8 \fB\-\-name\fP \fIname\fP
9 Specify the list to use for the commands. If no name is given then
10 \fBDEFAULT\fR will be used.
11 .TP
12 [\fB!\fR] \fB\-\-set\fP
13 This will add the source address of the packet to the list. If the source
14 address is already in the list, this will update the existing entry. This will
15 always return success (or failure if \fB!\fR is passed in).
16 .TP
17 \fB\-\-rsource\fP
18 Match/save the source address of each packet in the recent list table. This
19 is the default.
20 .TP
21 \fB\-\-rdest\fP
22 Match/save the destination address of each packet in the recent list table.
23 .TP
24 [\fB!\fR] \fB\-\-rcheck\fP
25 Check if the source address of the packet is currently in the list.
26 .TP
27 [\fB!\fR] \fB\-\-update\fP
28 Like \fB\-\-rcheck\fP, except it will update the "last seen" timestamp if it
29 matches.
30 .TP
31 [\fB!\fR] \fB\-\-remove\fP
32 Check if the source address of the packet is currently in the list and if so
33 that address will be removed from the list and the rule will return true. If
34 the address is not found, false is returned.
35 .TP
36 [\fB!\fR] \fB\-\-seconds \fIseconds\fP
37 This option must be used in conjunction with one of \fB\-\-rcheck\fP or
38 \fB\-\-update\fP. When used, this will narrow the match to only happen when the
39 address is in the list and was seen within the last given number of seconds.
40 .TP
41 [\fB!\fR] \fB\-\-hitcount \fIhits\fP
42 This option must be used in conjunction with one of \fB\-\-rcheck\fP or
43 \fB\-\-update\fP. When used, this will narrow the match to only happen when the
44 address is in the list and packets had been received greater than or equal to
45 the given value. This option may be used along with \fB\-\-seconds\fP to create
46 an even narrower match requiring a certain number of hits within a specific
47 time frame.
48 .TP
49 \fB\-\-rttl\fP
50 This option may only be used in conjunction with one of \fB\-\-rcheck\fP or
51 \fB\-\-update\fP. When used, this will narrow the match to only happen when the
52 address is in the list and the TTL of the current packet matches that of the
53 packet which hit the \fB\-\-set\fP rule. This may be useful if you have problems
54 with people faking their source address in order to DoS you via this module by
55 disallowing others access to your site by sending bogus packets to you.
56 .PP
57 Examples:
58 .IP
59 iptables \-A FORWARD \-m recent \-\-name badguy \-\-rcheck \-\-seconds 60 \-j DROP
60 .IP
61 iptables \-A FORWARD \-p tcp \-i eth0 \-\-dport 139 \-m recent \-\-name badguy \-\-set \-j DROP
62 .PP
63 Steve's ipt_recent website (http://snowman.net/projects/ipt_recent/) also has
64 some examples of usage.
65 .PP
66 \fB/proc/net/xt_recent/*\fR are the current lists of addresses and information
67 about each entry of each list.
68 .PP
69 Each file in \fB/proc/net/xt_recent/\fR can be read from to see the current
70 list or written two using the following commands to modify the list:
71 .TP
72 \fBecho +\fR\fIaddr\fR\fB >/proc/net/xt_recent/DEFAULT\fR
73 to add \fIaddr\fR to the DEFAULT list
74 .TP
75 \fBecho \-\fP\fIaddr\fP\fB >/proc/net/xt_recent/DEFAULT\fP
76 to remove \fIaddr\fR from the DEFAULT list
77 .TP
78 \fBecho / >/proc/net/xt_recent/DEFAULT\fR
79 to flush the DEFAULT list (remove all entries).
80 .PP
81 The module itself accepts parameters, defaults shown:
82 .TP
83 \fBip_list_tot\fR=\fI100\fR
84 Number of addresses remembered per table.
85 .TP
86 \fBip_pkt_list_tot\fR=\fI20\fR
87 Number of packets per address remembered.
88 .TP
89 \fBip_list_hash_size\fR=\fI0\fR
90 Hash table size. 0 means to calculate it based on ip_list_tot, default: 512.
91 .TP
92 \fBip_list_perms\fR=\fI0644\fR
93 Permissions for /proc/net/xt_recent/* files.
94 .TP
95 \fBip_list_uid\fR=\fI0\fR
96 Numerical UID for ownership of /proc/net/xt_recent/* files.
97 .TP
98 \fBip_list_gid\fR=\fI0\fR
99 Numerical GID for ownership of /proc/net/xt_recent/* files.