ae8c8573963988098c672ca50011b850e0e7c00c
[fwsnort.git] / fwsnort.8
1 .\" Process this file with
2 .\" groff -man -Tascii foo.1
3 .\"
4 .TH FWSNORT 8 "Jan, 2011" Linux
5 .SH NAME
6 .B fwsnort
7 \- Firewall Snort
8 .SH SYNOPSIS
9 .B fwsnort [options]
10 .SH DESCRIPTION
11 .B fwsnort
12 translates SNORT rules into iptables rules on Linux systems and generates a
13 corresponding iptables policy in iptables-save format.  This ruleset allows
14 network traffic that matches Snort signatures (i.e.  attacks and other suspicious
15 network behavior) to
16 be logged and/or dropped by iptables directly without putting an interface
17 into promiscuous mode or queuing packets from kernel to user space.  Note
18 that fwsnort can also build an iptables policy that combines the string
19 match extension with the NFQUEUE or QUEUE targets to allow the kernel to
20 perform preliminary string matches that are defined within Snort rules
21 before queuing matching packets to a userspace snort_inline instance.  Because the bulk of
22 network communications are not generallly malicious, this should provide a speedup
23 for snort_inline since the majority of packets do not then have to be
24 copied from kernel memory into user memory and subsequently inspected by
25 snort_inline.  There is a tradeoff here in terms of signature detection
26 however because snort_inline when deployed in this way does not have the
27 opportunity to see all packets associated with a session, so stream
28 reassembly and signature comparisons against a reassembled buffer do not
29 take place (the stream preprocessor should be disabled in the userspace
30 snort_inline instance).
31
32 As of
33 .B fwsnort-1.5
34 all iptables rules built by fwsnort are written out to the
35 .I /etc/fwsnort/fwsnort.save
36 file in iptables-save format.  This allows a long fwsnort policy (which may
37 contain thousands of iptables rules translated from a large Snort signature
38 set) to be quickly instantiated via the "iptables-restore" command.  A wrapper
39 script
40 .I /etc/fwsnort/fwsnort.sh
41 is also written out to make this easy.  Hence, the typical work flow for
42 fwsnort is to: 1) run fwsnort, 2) note the Snort rules that fwsnort was able
43 to successfully translate (the number of such rules is printed to stdout),
44 and then 3) execute the
45 .I /etc/fwsnort/fwsnort.sh
46 wrapper script to instantiate the policy in the running kernel.
47
48 .B fwsnort
49 (optionally) uses the IPTables::Parse CPAN module to parse
50 the iptables ruleset on the machine to determine which Snort rules are
51 applicable to the specific iptables policy.  After all, if iptables is
52 blocking all inbound http traffic from external addresses for example, it
53 is probably not of much use to try detecting inbound attacks against against
54 tcp/80.  By default fwsnort generates iptables rules that log Snort sid's
55 within a \-\-log-prefix to syslog where the messages can be analyzed with a
56 log analyzer such as
57 .B psad
58 (see http://www.cipherdyne.org/psad/).
59 .B fwsnort
60 relies on the iptables string match module to match Snort content fields
61 in the application portion of ip traffic.  Since Snort rules can contain
62 hex data in content fields (specified between pipe "|" characters), fwsnort
63 implements a patch against iptables (which has been accepted by the Netfilter
64 project as of iptables-1.2.7a) which adds a "\-\-hex-string" option.  This
65 allow iptables to accept content fields from Snort rules such as
66 "|0d0a5b52504c5d3030320d0a|" without any modification.
67 .B fwsnort
68 is able to translate approximately 60% of all rules from the Snort-2.3.3
69 IDS into equivalent iptables rules.  For more information about the
70 translation strategy as well as advantages/disadvantages of the method
71 used by fwsnort to obtain intrusion detection data, see the README
72 included with the fwsnort sources or browse to:
73 http://www.cipherdyne.org/fwsnort/
74
75 .B fwsnort
76 is able to apply Snort rules to IPv6 traffic by building an ip6tables policy
77 (see the "\-\-ip6tables" command line argument).
78 .SH OPTIONS
79 .TP
80 .BR \-c ", " \-\^\-config\ \<configuration\ file>
81 By default fwsnort makes use of the configuration file
82 .B /etc/fwsnort/fwsnort.conf
83 for almost all configuration parameters.  fwsnort can be made to
84 override this path by specifying a different file on the command
85 line with the \-\-config option.
86 .TP
87 .BR \-\^\-update-rules
88 Download the latest Emerging Threats rules from http://www.emergingthreats.net
89 This will overwrite the  emerging-all.rules file in the
90 /etc/fwsnort/snort_rules/ directory.  Note that the automatic downloading
91 of Snort rules from http://www.snort.org/ as of March, 2005 is only offered
92 as a pay service.
93 .TP
94 .BR \-\^\-rules-url\ \ <url>
95 Specify the URL to use when updating the Emerging Threats rule set (or any
96 other rule set).  The default URL is: http://rules.emergingthreats.net/open/snort-2.9.0/emerging-all.rules
97 .TP
98 .BR \-6 ", " \-\^\-ip6tables
99 Enable
100 .B ip6tables
101 mode so that the fwsnort rule set is built into an ip6tables policy instead
102 of the iptables policy.  This allows fwsnort controls to apply to IPv6
103 traffic.
104 .TP
105 .BR \-\^\-include-type\ \ <rules\ type>
106 Restrict to processing snort rules of <rules type>.  Example rule
107 types would include "ddos", "backdoor", and "web-attacks".  This option
108 also supports a comma-separated list of types, e.g. "ddos,backdoor".
109 .TP
110 .BR \-\^\-exclude-type\ \ <rules\ type>
111 Exclude all Snort rules from of type <rules type> from the translation
112 process.  For example, if you don't want any rules from the file
113 emerging-all.rules to be translated, then use "emerging-all" as the
114 argument to this option.  A comma-separated list of types to exclude can
115 be specified.
116 .TP
117 .BR \-\^\-include-regex\ \ <regex>
118 Only translate Snort rules that match the specified regular expression. This
119 is useful to build
120 .B fwsnort
121 policies for Snort rules that have a common characteristic (such as a string
122 match on the word "Storm" for the Storm worm for example).
123 .TP
124 .BR \-\^\-exclude-regex\ \ <regex>
125 Translate all Snort rules except those that match the specified regular
126 expression.  This is useful to omit Snort rules from
127 .B fwsnort
128 policies that have a common characteristic (such as a string
129 match on "HTTP_PORTS" for example).
130 .TP
131 .BR \-\^\-include-re-caseless
132 Make the rule matchine regular expression specified with
133 .I \-\-include\-regex
134 match case insensitively.
135 .TP
136 .BR \-\^\-exclude-re-caseless
137 Make the rule matchine regular expression specified with
138 .I \-\-exclude\-regex
139 match case insensitively.
140 .TP
141 .BR \-\^\-snort-rdir\ <snort-rules-directory>
142 Manually specify the directory where the snort rules files are located.
143 The default is
144 .B /etc/fwsnort/snort_rules.
145 Multiple directories are supported as a comma-separated list.
146 .TP
147 .BR \-\^\-snort-rfile\ <snort-rules-file>
148 Manually specify a Snort rules file to translated into iptables rules.
149 Multiple files are also supported as a comma-separated list.
150 .TP
151 .BR \-\^\-snort-sid\ \<sid>
152 Generate an iptables ruleset for a single snort rule specified by
153 <sid>.  A comma-separated list of sids can be specified, e.g. "2001842,1834".
154 .TP
155 .BR \-\^\-exclude-sid\ \<sid>
156 Provide a list of Snort ID's to be excluded from the translation process.
157 .TP
158 .BR \-\^\-include-perl-triggers
159 Include
160 .I 'perl -e "print ..."'
161 commands as comments in the
162 .I fwsnort.sh
163 script.  These commands allow payloads that are designed to trigger snort
164 rules to easily be built, and when combined with netcat (or other software
165 that can send bytes over the wire) it becomes possible to test whether an
166 fwsnort policy appropriately triggers on matching traffic.
167 .TP
168 .BR \-\^\-ipt-script\ \<script\ file>
169 Specify the path to the iptables script generated by fwsnort.  The
170 default location is /etc/fwsnort/fwsnort.sh.
171 .TP
172 .BR \-\^\-ipt-check-capabilities
173 Check iptables capabilities and exit.
174 .TP
175 .BR \-\^\-Last\-cmd
176 Run
177 .B fwsnort
178 with the same command line arguments as the previous execution.  This is a
179 convenient way of rebuilding the
180 .I /etc/fwsnort/fwsnort.sh
181 script without having to remember what the last command line args were.
182 .TP
183 .BR \-\^\-NFQUEUE
184 Build an
185 .B fwsnort
186 policy that sends packets that match Snort
187 .B content
188 or
189 .B uricontent
190 fields to userspace via the iptables NFQUEUE target for further analysis.  This is a
191 mechanism for reducing the signature inspection load placed on snort_inline.
192 A parallel set of Snort rules that are successfully translated are placed in
193 the /etc/fwsnort/snort_rules_queue directory.  This requires
194 CONFIG_NETFILTER_XT_TARGET_NFQUEUE support in the Linux kernel.
195 .TP
196 .BR \-\^\-QUEUE
197 Same as the
198 .B --NFQUEUE
199 command line argument except that the older QUEUE target is used instead of
200 the NFQUEUE target.  This requires CONFIG_IP_NF_QUEUE support in the Linux kernel.
201 .TP
202 .BR \-\^\-queue-num\ \<num>
203 Specify a queue number in \-\-NFQUEUE mode.
204 .TP
205 .BR \-\^\-queue-pre-match-max\ \<num>
206 In \-\-QUEUE or \-\-NFQUEUE mode, limit the number of content matches that are
207 performed within the kernel before sending a matching packet to a userspace
208 Snort instance.  This allows a level of tuning with respect to how much work
209 the kernel does to qualify a packet based on a signature match before having
210 Snort do the same thing.  The default is to perform all specified content
211 matches in the signature before queuing the packet to userspace because the
212 multiple in-kernel content matches is probably less expensive than sending a
213 packet to userspace by default.
214 .TP
215 .BR \-\^\-string-match-alg\ \<alg>
216 Specify the string matching algorithm to use with the kernel.  By default, this
217 is 'bm' for the 'Boyer-Moore' string matching algorithm, but 'kmp' may also be
218 specified (short for the 'Knuth–Morris–Pratt' algorithm).
219 .TP
220 .BR \-\^\-ipt-apply
221 Execute the iptables script generated by fwsnort.
222 .TP
223 .BR \-\^\-ipt-flush
224 Flush all
225 .B fwsnort
226 currently active iptables rules (flushes the fwsnort chains).
227 .TP
228 .BR \-\^\-ipt-list
229 List all
230 .B fwsnort
231 currently active iptables rules (lists the fwsnort chains).
232 .TP
233 .BR \-\^\-ipt-drop
234 For each logging rule generated by
235 .B fwsnort
236 add a corresponding DROP
237 rule.  Note that for TCP sessions using this option will cause retransmissions
238 as packets that are part of established sessions selectively dropped.
239 Remember that false positives are common occurrences for intrusion detection
240 systems, and so using this or the \-\-ipt-reject option may break things on
241 your network!  You have been warned.
242 .TP
243 .BR \-\^\-ipt-reject
244 For each logging rule generated by
245 .B fwsnort
246 add a corresponding REJECT rule.
247 Reset packets will be generated for TCP sessions through the use of
248 the "\-\-reject-with tcp-reset" option, and ICMP port unreachable messages will
249 be generated for UDP packets through the use of the
250 "\-\-reject-with icmp-port-unreachable" option.
251 .TP
252 .BR \-C ", " \-\^\-Conntrack-state\ \<state>
253 Specify a conntrack state in place of the "established" state that commonly
254 accompanies the Snort "flow" keyword.  By default, fwsnort uses the conntrack
255 state of "ESTABLISHED" for this.  In certain corner cases, it might be useful
256 to use "ESTABLISHED,RELATED" instead to apply application layer inspection to
257 things like ICMP port unreachable messages that are responses to real attempted
258 communications.
259 .TP
260 .BR \-\^\-no-ipt-log
261 By default fwsnort generates an iptables script that implements a logging
262 rule for each successfully translated snort rule.  This can be disabled
263 with the \-\-no-ipt-log option, but \-\-ipt-drop must also be specified.
264 .TP
265 .BR \-\^\-no-ipt-sync
266 This is a deprecated option since the default behavior is to translate as
267 many Snort rules into iptables rules as possible.  With
268 .B fwsnort
269 able to produce iptables rules in iptables\-save format, it is extremely fast
270 to instantiate a large set of translated Snort rules into an iptables policy.
271 A new \-\-ipt-sync option has been added to reverse this behavior (not
272 recommended).
273 .TP
274 .BR \-\^\-ipt-sync
275 Consult the iptables policy currently running on the machine
276 for applicable snort rules.
277 .TP
278 .BR \-\^\-no-ipt-test
279 Do not test the iptables build for existence of support for the LOG and
280 REJECT targets, and ascii and hex string matching.
281 .TP
282 .BR \-\^\-no-ipt-jumps
283 Do not jump packets from the built-in iptables INPUT, OUTPUT, and
284 FORWARD chains to the custom
285 .B fwsnort
286 chains.  This options is mostly useful to make it
287 easy to manually alter the placement of the jump rules in the iptables
288 ruleset.
289 .TP
290 .BR \-\^\-no-ipt-rule-nums
291 By default
292 .B fwsnort
293 includes the rule number within the logging prefix for each of the rules it
294 adds to the fwsnort chains.  E.g. the logging prefix for rule 34 would look
295 something like "[34] SID1242 ESTAB".  Use this option to not include the
296 rule number.
297 .TP
298 .BR \-\^\-no-ipt-comments
299 If the iptables "comment" match exists, then
300 .B fwsnort
301 puts the Snort "msg", "classtype", "reference", "priority", and "rev" fields
302 within a comment for each iptables rule.  Use this option to disable this.
303 .TP
304 .BR \-\^\-no-ipt-INPUT
305 Do not jump packets from the iptables INPUT chain to the
306 .B fwsnort
307 chains.
308 .TP
309 .BR \-\^\-no-ipt-OUTPUT
310 Do not jump packets from the iptables OUTPUT chain to the
311 .B fwsnort
312 chains.
313 .TP
314 .BR \-\^\-no-ipt-FORWARD
315 Do not jump packets from the iptables FORWARD chain to the
316 .B fwsnort
317 chains.
318 .TP
319 .BR \-\^\-no-fast-pattern-ordering
320 Cause
321 .B fwsnort
322 to not try to reorder pattern matches to process the longest pattern first.
323 The Snort
324 .I fast_pattern
325 keyword is also ignored if this option is specified.
326 .TP
327 .BR \-H ", " \-\^\-Home-net\ \<network/mask>
328 Specify the internal network instead of having
329 .B fwsnort
330 derive it from the HOME_NET keyword in the fwsnort.conf configuration
331 file.
332 .TP
333 .BR \-E ", " \-\^\-External-net\ \<network/mask>
334 Specify the external network instead of having
335 .B fwsnort
336 derive it from the EXTERNAL_NET keyword in the fwsnort.conf configuration
337 file.
338 .TP
339 .BR \-\^\-no-addresses
340 Disable all checks against the output of ifconfig for proper IP addresses.
341 This is useful if
342 .B fwsnort
343 is running on a bridging firewall.
344 .TP
345 .BR \-\^\-Dump-conf
346 Print the fwsnort configuration on STDOUT and exit.
347 .TP
348 .BR \-\^\-debug
349 Run in debug mode.  This will cause all parse errors which are normally
350 written to the fwsnort logfile
351 .B /var/log/fwsnort.log
352 to be written to STDOUT instead.
353 .TP
354 .BR \-\^\-strict
355 Run fwsnort in "strict" mode.  This will prevent fwsnort from translating
356 snort rules that contain the keywords "offset", "uricontent", and "depth".
357 .TP
358 .BR \-U ", " \-\^\-Ulog
359 Force the usage of the ULOG target for all log messages instead of the
360 default LOG target.
361 .TP
362 .BR \-\^\-ulog-nlgroup
363 Specify the netlink group for ULOG rules.  Such rules are only added for
364 Snort rules that have an action of "log", or when
365 .B fwsnort
366 is run in
367 .B --Ulog
368 mode.
369 .TP
370 .BR \-l ", " \-\^\-logfile\ <logfile>
371 By default fwsnort logs all parse errors to the logfile
372 .B /var/log/fwsnort.log.
373 This path can be manually changed with the \-\-logfile option.
374 .TP
375 .BR \-v ", " \-\^\-verbose
376 Run fwsnort in verbose mode.  This will cause fwsnort to add the original
377 snort rule as a comment to the fwsnort.sh script for each successfully
378 translated rule.
379 .TP
380 .BR \-V ", " \-\^\-Version
381 Print the fwsnort version and exit.
382 .TP
383 .BR \-h ", " \-\^\-help
384 Print usage information on STDOUT and exit.
385 .SH FILES
386 .B /etc/fwnort/fwsnort.conf
387 .RS
388 The fwsnort configuration file.  The path to this file can be
389 changed on the command line with \-\-config.
390 .RE
391
392 .B /etc/fwnort/fwsnort.sh
393 .RS
394 The iptables script generated by fwsnort.  The path can be manually
395 specified on the command line with the \-\-ipt-script option.
396 .SH FWSNORT CONFIGURATION VARIABLES
397 This section describes what each of the more important fwsnort configuration
398 variables do and how they can be tuned to meet your needs.  These variables
399 are located in the fwsnort configuration file
400 .B /etc/fwsnort/fwsnort.conf
401 .TP
402 .BR HOME_NET
403 .B fwsnort
404 uses the same HOME_NET and EXTERNAL_NET variables as defined in Snort rules,
405 and the same semantics are supported.  I.e., individual IP addresses or networks
406 in standard dotted-quad or CIDR notation can be specified, and comma separated
407 lists are also supported.
408 .TP
409 .BR EXTERNAL_NET
410 Defines the external network.  See the HOME_NET variable for more information.
411 .SH EXAMPLES
412 The following examples illustrate the command line arguments that could
413 be supplied to fwsnort in a few situations:
414 .PP
415 Script generation in logging mode, parse errors written to the fwsnort
416 logfile, and iptables policy checking are enabled by default without
417 having to specify any command line arguments:
418 .PP
419 .B # fwsnort
420 .PP
421 Generate ip6tables rules for attacks delivered over IPv6:
422 .PP
423 .B # fwsnort -6
424 .PP
425 Generate iptables rules for ddos and backdoor Snort rules only:
426 .PP
427 .B # fwsnort --include-type ddos,backdoor
428 .PP
429 Generate iptables rules for Snort ID's 2008475 and 2003268 (from emerging-all.rules):
430 .PP
431 .B fwsnort --snort-sid 2008475,2003268
432 .PP
433 Generate iptables rules for Snort ID's 1834 and 2001842 but queue them to userspace
434 via the NFQUEUE target and restrict exclude the INPUT and OUTPUT chains:
435 .PP
436 .B fwsnort --snort-sid 1834,2001842 --NFQUEUE --no-ipt-INPUT --no-ipt-OUTPUT
437 .PP
438 Instruct
439 .B fwsnort
440 to only inspect traffic that traverses the eth0 and eth1 interfaces:
441 .PP
442 .B # fwsnort --restrict-intf eth0,eth1
443 .PP
444 Generate iptables rules for Snort rules that appear to be allowed by the local
445 iptables policy, and write original snort rules to the iptables script as a comment:
446 .PP
447 .B # fwsnort --ipt-sync --verbose
448 .SH DEPENDENCIES
449 .B fwsnort
450 requires that the iptables string match module be compiled into the
451 kernel (or as a loadable kernel module) in order to be able to match
452 snort signatures that make use of the "content" keyword.  Note that
453 the \-\-no-opt-test option can be specified to have fwsnort generate an
454 iptables script even if the string match module is not compiled in.
455 .PP
456 .B fwsnort
457 also requires the IPTables::Parse CPAN module in order to parse
458 iptables policies.  This module is bundled with the fwsnort sources in
459 the deps/ directory for convenience.
460 .SH DIAGNOSTICS
461 The \-\-debug option can be used to display on STDOUT any errors that
462 are generated as fwsnort parses each snort rule.  Normally these
463 errors are written to the fwsnort logfile /var/log/fwsnort.log
464 .SH "SEE ALSO"
465 .BR psad (8),
466 .BR iptables (8),
467 .BR snort (8),
468 .BR nmap (1)
469 .SH AUTHOR
470 Michael Rash <mbr@cipherdyne.org>
471 .SH CONTRIBUTORS
472 Many people who are active in the open source community have contributed to fwsnort;
473 see the
474 .B CREDITS
475 file in the fwsnort sources, or visit
476 .B http://www.cipherdyne.org/fwsnort/docs/contributors.html
477 to view the online list of contributors.
478
479 .B fwsnort
480 is based on the original
481 .B snort2iptables
482 script written by William Stearns.
483 .SH BUGS
484 Send bug reports to mbr@cipherdyne.org. Suggestions and/or comments are
485 always welcome as well.
486 .SH DISTRIBUTION
487 .B fwsnort
488 is distributed under the GNU General Public License (GPLv2), and the latest
489 version may be downloaded from
490 .B http://www.cipherdyne.org/
491 Snort is a registered trademark of Sourcefire, Inc.