|
11
|
1 <reference>
|
|
|
2 <title>@PACKAGE@</title>
|
|
|
3 <partintro>
|
|
|
4 <title>Packages</title>
|
|
|
5 <para>The various source and binary packages are available at <ulink
|
|
19
|
6 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>
|
|
12
|
7 The most recent documentation is available at <ulink
|
|
|
8 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>
|
|
11
|
9 </para>
|
|
|
10 </partintro>
|
|
|
11
|
|
|
12 <refentry id="@PACKAGE@.1">
|
|
|
13 <refentryinfo>
|
|
|
14 <date>2005-12-15</date>
|
|
|
15 </refentryinfo>
|
|
|
16
|
|
|
17 <refmeta>
|
|
|
18 <refentrytitle>@PACKAGE@</refentrytitle>
|
|
|
19 <manvolnum>1</manvolnum>
|
|
|
20 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo>
|
|
|
21 </refmeta>
|
|
|
22
|
|
|
23 <refnamediv id='name.1'>
|
|
|
24 <refname>@PACKAGE@</refname>
|
|
|
25 <refpurpose>a simple adaptive firewall</refpurpose>
|
|
|
26 </refnamediv>
|
|
|
27
|
|
|
28 <refsynopsisdiv id='synopsis.1'>
|
|
|
29 <title>Synopsis</title>
|
|
|
30 <cmdsynopsis>
|
|
|
31 <command>@PACKAGE@</command>
|
|
|
32 <arg><option>-c</option></arg>
|
|
|
33 <arg><option>-d <replaceable class="parameter">n</replaceable></option></arg>
|
|
|
34 </cmdsynopsis>
|
|
|
35 </refsynopsisdiv>
|
|
|
36
|
|
|
37 <refsect1 id='description.1'>
|
|
|
38 <title>Description</title>
|
|
12
|
39
|
|
|
40 <para><command>@PACKAGE@</command> is a simple adaptive firewall. It
|
|
|
41 maintains the INPUT chain of the <citerefentry>
|
|
|
42 <refentrytitle>iptables</refentrytitle> <manvolnum>1</manvolnum>
|
|
|
43 </citerefentry> firewall set based on syslog entries. These syslog
|
|
|
44 entries are typically generated by your hardware firewall, but they
|
|
|
45 could come from any source. Any syslog entry that contains a host name
|
|
|
46 or ip address can be used as input to this package.</para>
|
|
11
|
47
|
|
12
|
48 <para>The <citerefentry> <refentrytitle>@PACKAGE@.conf</refentrytitle>
|
|
|
49 <manvolnum>5</manvolnum> </citerefentry> file specifies the syslog files
|
|
|
50 to be monitored, and the regular expressions (<citerefentry>
|
|
|
51 <refentrytitle>regex</refentrytitle> <manvolnum>7</manvolnum>
|
|
|
52 </citerefentry>) to be applied to new lines in those files. Each
|
|
|
53 regular expression needs an index to specify the matching substring that
|
|
|
54 contains either an ip address or host name, and a bucket count which is
|
|
|
55 added to the leaky bucket for that ip address when a matching line is
|
|
|
56 read from that syslog file.</para>
|
|
11
|
57
|
|
12
|
58 <para>Each ip address has an associated leaky bucket, which leaks one
|
|
|
59 token per second. Once the bucket contains more than a configurable
|
|
|
60 threshold number of tokens, that ip address is added to the INPUT chain
|
|
|
61 with a DROP target. When the bucket is drained to zero, that ip address
|
|
|
62 is removed from the INPUT chain.</para>
|
|
|
63
|
|
|
64 <para>The discussion has focused on syslog files, but any ascii text
|
|
|
65 file can be used, so long as some other process appends lines to that
|
|
|
66 file, and those lines containing hostname or ip addresses can be matched
|
|
|
67 with some regular expression.</para>
|
|
|
68
|
|
|
69 <para>Considering syslog files in particular, these are normally rotated
|
|
|
70 via logrotate. <command>@PACKAGE@</command> properly detects and
|
|
|
71 handles this case by closing the old file, and reopening the newly
|
|
|
72 created file.</para>
|
|
11
|
73 </refsect1>
|
|
|
74
|
|
|
75 <refsect1 id='options.1'>
|
|
|
76 <title>Options</title>
|
|
|
77 <variablelist>
|
|
|
78 <varlistentry>
|
|
|
79 <term>-c</term>
|
|
|
80 <listitem>
|
|
|
81 <para>
|
|
|
82 Load the configuration file, print a cannonical form
|
|
|
83 of the configuration on stdout, and exit.
|
|
|
84 </para>
|
|
|
85 </listitem>
|
|
|
86 </varlistentry>
|
|
|
87 <varlistentry>
|
|
|
88 <term>-d <replaceable class="parameter">n</replaceable></term>
|
|
|
89 <listitem>
|
|
|
90 <para>
|
|
|
91 Set the debug level to <replaceable class="parameter">n</replaceable>.
|
|
|
92 </para>
|
|
|
93 </listitem>
|
|
|
94 </varlistentry>
|
|
|
95 </variablelist>
|
|
|
96 </refsect1>
|
|
|
97
|
|
16
|
98 <refsect1 id='usage.1'>
|
|
11
|
99 <title>Usage</title>
|
|
|
100 <para><command>@PACKAGE@</command> -d 2</para>
|
|
|
101 </refsect1>
|
|
|
102
|
|
16
|
103 <refsect1 id='configuration.1'>
|
|
11
|
104 <title>Configuration</title>
|
|
|
105 <para>
|
|
|
106 The configuration file is documented in <citerefentry>
|
|
|
107 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum>
|
|
12
|
108 </citerefentry>. Any change to the config file will cause it to be
|
|
|
109 reloaded within three minutes.
|
|
11
|
110 </para>
|
|
|
111 </refsect1>
|
|
|
112
|
|
24
|
113 <refsect1 id='todo.1'>
|
|
|
114 <title>TODO</title>
|
|
|
115 <para>
|
|
|
116 The following ideas are under consideration.
|
|
|
117 </para>
|
|
|
118 <para>
|
|
|
119 Add a global configuration option for the single iptables table
|
|
|
120 name, rather than the current fixed INPUT name.
|
|
|
121 </para>
|
|
|
122 <para>
|
|
|
123 Add a configuration option for the iptables table name in the
|
|
|
124 pattern statement. This implies handling multiple tables, so each
|
|
|
125 table needs its own map of ip addresses and bucket values.
|
|
|
126 </para>
|
|
|
127 </refsect1>
|
|
|
128
|
|
16
|
129 <refsect1 id='copyright.1'>
|
|
11
|
130 <title>Copyright</title>
|
|
|
131 <para>
|
|
|
132 Copyright (C) 2005 by 510 Software Group <carl@five-ten-sg.com>
|
|
|
133 </para>
|
|
|
134 <para>
|
|
|
135 This program is free software; you can redistribute it and/or modify it
|
|
|
136 under the terms of the GNU General Public License as published by the
|
|
|
137 Free Software Foundation; either version 2, or (at your option) any
|
|
|
138 later version.
|
|
|
139 </para>
|
|
|
140 <para>
|
|
|
141 You should have received a copy of the GNU General Public License along
|
|
|
142 with this program; see the file COPYING. If not, please write to the
|
|
|
143 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
144 </para>
|
|
|
145 </refsect1>
|
|
|
146 </refentry>
|
|
|
147
|
|
|
148
|
|
|
149 <refentry id="@PACKAGE@.conf.5">
|
|
|
150 <refentryinfo>
|
|
|
151 <date>2005-12-15</date>
|
|
|
152 </refentryinfo>
|
|
|
153
|
|
|
154 <refmeta>
|
|
|
155 <refentrytitle>@PACKAGE@.conf</refentrytitle>
|
|
|
156 <manvolnum>5</manvolnum>
|
|
|
157 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo>
|
|
|
158 </refmeta>
|
|
|
159
|
|
|
160 <refnamediv id='name.5'>
|
|
|
161 <refname>@PACKAGE@.conf</refname>
|
|
|
162 <refpurpose>configuration file for @PACKAGE@</refpurpose>
|
|
|
163 </refnamediv>
|
|
|
164
|
|
|
165 <refsynopsisdiv id='synopsis.5'>
|
|
|
166 <title>Synopsis</title>
|
|
|
167 <cmdsynopsis>
|
|
|
168 <command>@PACKAGE@.conf</command>
|
|
|
169 </cmdsynopsis>
|
|
|
170 </refsynopsisdiv>
|
|
|
171
|
|
|
172 <refsect1 id='description.5'>
|
|
|
173 <title>Description</title>
|
|
|
174 <para>The <command>@PACKAGE@.conf</command> configuration file is
|
|
27
|
175 specified by this partial bnf description. The entire config file
|
|
|
176 is case sensitive. All the keywords are lower case.
|
|
|
177 </para>
|
|
11
|
178
|
|
|
179 <literallayout class="monospaced"><![CDATA[
|
|
27
|
180 CONFIG := {THRESHOLD | ADD-CMD | REM-CMD | IGNORE | FILE}+
|
|
11
|
181 THRESHOLD := "threshold" THRESHOLD-INTEGER-VALUE ";"
|
|
27
|
182 ADD-CMD := "add_command" IPT-CMD ";"
|
|
|
183 REM-CMD := "remove_command" IPT-CMD ";"
|
|
11
|
184 IGNORE := "ignore" "{" IG-SINGLE+ "};"
|
|
|
185 IG-SINGLE := IP-ADDRESS "/" CIDR-BITS ";"
|
|
|
186 FILE := "file" FILENAME "{" PATTERN+ "};"
|
|
|
187 PATTERN := "pattern" REGULAR-EXPRESSION "{" {INDEX | BUCKET}+ "};"
|
|
|
188 INDEX := "index" REGEX-INTEGER-VALUE ";"
|
|
29
|
189 BUCKET := "bucket" BUCKET-ADD-INTEGER-VALUE ";"
|
|
27
|
190 IPT-CMD := string containing exactly one %s replacement token for
|
|
29
|
191 the ip address]]></literallayout>
|
|
11
|
192 </refsect1>
|
|
|
193
|
|
|
194 <refsect1 id='sample.5'>
|
|
|
195 <title>Sample</title>
|
|
|
196 <literallayout class="monospaced"><![CDATA[
|
|
|
197 threshold 550;
|
|
|
198
|
|
27
|
199 add_command "/sbin/iptables -I INPUT --src %s --jump DROP";
|
|
|
200 remove_command "/sbin/iptables -D INPUT --src %s --jump DROP";
|
|
|
201
|
|
11
|
202 ignore {
|
|
|
203 127.0.0.0/8; // localhost
|
|
|
204 };
|
|
|
205
|
|
|
206 file "/var/log/cisco.log" {
|
|
|
207 pattern "Internet_Firewall denied (tcp|udp) ([^(]*)" {
|
|
|
208 index 2; // zero based
|
|
|
209 bucket 200;
|
|
|
210 };
|
|
|
211 };
|
|
|
212
|
|
|
213 file "/var/log/secure" {
|
|
|
214 pattern "sshd.*Failed password .* from ::ffff:(.*) port" {
|
|
|
215 index 1; // zero based
|
|
|
216 bucket 400;
|
|
|
217 };
|
|
|
218 pattern "sshd.*Failed password .* from (.*) port" {
|
|
|
219 index 1; // zero based
|
|
|
220 bucket 400;
|
|
|
221 };
|
|
|
222 };]]></literallayout>
|
|
|
223 </refsect1>
|
|
|
224
|
|
|
225 </refentry>
|
|
|
226 </reference>
|
