forked from jasonish/py-idstools
/
test_rulecat.py
296 lines (244 loc) · 15.2 KB
/
test_rulecat.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# Copyright (c) 2015 Jason Ish
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
from __future__ import print_function
import sys
import os
import unittest
import shlex
import re
import subprocess
import shutil
import idstools.rule
from idstools.scripts import rulecat
import idstools.rulecat.extract
class TestRulecat(unittest.TestCase):
def test_extract_tar(self):
files = idstools.rulecat.extract.extract_tar(
"tests/emerging.rules.tar.gz")
self.assertTrue(len(files) > 0)
def test_extract_zip(self):
files = idstools.rulecat.extract.extract_zip(
"tests/emerging.rules.zip")
self.assertTrue(len(files) > 0)
def test_try_extract(self):
files = idstools.rulecat.extract.try_extract(
"tests/emerging.rules.zip")
self.assertTrue(len(files) > 0)
files = idstools.rulecat.extract.try_extract(
"tests/emerging.rules.tar.gz")
self.assertTrue(len(files) > 0)
files = idstools.rulecat.extract.try_extract(
"tests/emerging-current_events.rules")
self.assertIsNone(files)
def test_run(self):
old_path = os.getcwd()
try:
os.chdir(os.path.dirname(os.path.realpath(__file__)))
if os.path.exists("./tmp"):
shutil.rmtree("tmp")
os.makedirs("./tmp")
subprocess.check_call(
[sys.executable,
"../bin/idstools-rulecat",
"--url",
"file://%s/emerging.rules.tar.gz" % (
os.getcwd()),
"--local", "./rule-with-unicode.rules",
"--temp-dir", "./tmp",
"--force",
"--merged", "./tmp/merged.rules",
"--output", "./tmp/rules/",
"--yaml-fragment", "./tmp/suricata-rules.yaml",
"--sid-msg-map", "./tmp/sid-msg.map",
"--sid-msg-map-2", "./tmp/sid-msg-v2.map",
],
stdout=open("./tmp/stdout", "wb"),
stderr=open("./tmp/stderr", "wb"),
)
shutil.rmtree("tmp")
except:
if os.path.exists("./tmp/stdout"):
print("STDOUT")
print(open("./tmp/stdout").read())
if os.path.exists("./tmp/stderr"):
print("STDERR")
print(open("./tmp/stderr").read())
raise
finally:
os.chdir(old_path)
class TestFetch(unittest.TestCase):
def test_check_checksum(self):
"""Test that we detect when the checksum are the same. This is mainly
to catch issues between Python 2 and 3.
"""
fetch = rulecat.Fetch(None)
url = "file://%s/emerging.rules.tar.gz" % (
os.path.dirname(os.path.realpath(__file__)))
local_file = "%s/emerging.rules.tar.gz" % (
os.path.dirname(os.path.realpath(__file__)))
r = fetch.check_checksum(local_file, url)
self.assertTrue(r)
class ThresholdProcessorTestCase(unittest.TestCase):
processor = rulecat.ThresholdProcessor()
def test_extract_regex(self):
processor = rulecat.ThresholdProcessor()
line = "suppress re:java"
self.assertEquals("java", processor.extract_regex(line))
line = 'suppress re:"vulnerable java version"'
self.assertEquals(
"vulnerable java version", processor.extract_regex(line))
line = "suppress re:java, track <by_src|by_dst>, ip <ip|subnet>"
self.assertEquals("java", processor.extract_regex(line))
line = 'suppress re:"vulnerable java version", track <by_src|by_dst>, ip <ip|subnet>'
self.assertEquals(
"vulnerable java version", processor.extract_regex(line))
line = 'threshold re:"vulnerable java version", type threshold, track by_dst, count 1, seconds 10'
self.assertEquals(
"vulnerable java version", processor.extract_regex(line))
def test_replace(self):
rule_string = """alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
rule = idstools.rule.parse(rule_string)
line = "suppress re:windows"
self.assertEquals(
"suppress gen_id 1, sig_id 2020757",
self.processor.replace(line, rule))
line = 'threshold re:"ET MALWARE Windows", type threshold, ' \
'track by_dst, count 1, seconds 10'
self.assertEquals("threshold gen_id 1, sig_id 2020757, type threshold, track by_dst, count 1, seconds 10", self.processor.replace(line, rule))
line = 'threshold re:malware, type threshold, track by_dst, count 1, ' \
'seconds 10'
self.assertEquals(
"threshold gen_id 1, sig_id 2020757, type threshold, "
"track by_dst, count 1, seconds 10",
self.processor.replace(line, rule))
class ModifyRuleFilterTestCase(unittest.TestCase):
rule_string = """alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
def test_id_match(self):
rule0 = idstools.rule.parse(self.rule_string)
line = '2020757 "\|0d 0a\|" "|ff ff|"'
rule_filter = rulecat.ModifyRuleFilter.parse(line)
self.assertTrue(rule_filter != None)
self.assertTrue(rule_filter.match(rule0))
rule1 = rule_filter.filter(rule0)
self.assertEqual(
str(rule1),
"""alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|ff ff|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)""")
def test_re_match(self):
rule0 = idstools.rule.parse(self.rule_string)
line = 're:classtype:trojan-activity "\|0d 0a\|" "|ff ff|"'
rule_filter = rulecat.ModifyRuleFilter.parse(line)
self.assertTrue(rule_filter != None)
self.assertTrue(rule_filter.match(rule0))
rule1 = rule_filter.filter(rule0)
self.assertEqual(
str(rule1),
"""alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|ff ff|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)""")
def test_re_backref_one(self):
rule0 = idstools.rule.parse(self.rule_string)
line = 're:classtype:trojan-activity "(alert)(.*)" "drop\\2"'
filter = rulecat.ModifyRuleFilter.parse(line)
self.assertTrue(filter != None)
self.assertTrue(filter.match(rule0))
rule1 = filter.filter(rule0)
expected = """drop http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
self.assertEqual(str(rule1), expected)
def test_re_backref_two(self):
rule0 = idstools.rule.parse(self.rule_string)
line = 're:classtype:trojan-activity "(alert)(.*)(from_server)(.*)" "drop\\2to_client\\4"'
filter = rulecat.ModifyRuleFilter.parse(line)
self.assertTrue(filter != None)
self.assertTrue(filter.match(rule0))
rule1 = filter.filter(rule0)
expected = """drop http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,to_client; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
self.assertEqual(str(rule1), expected)
def test_drop_to_alert(self):
rule_in = idstools.rule.parse(self.rule_string)
self.assertIsNotNone(rule_in)
f = rulecat.ModifyRuleFilter.parse(
'emerging-trojan.rules "^alert" "drop"')
self.assertIsNotNone(f)
rule_out = f.filter(rule_in)
self.assertTrue(rule_out.format().startswith("drop"))
def test_oinkmaster_backticks(self):
f = rulecat.ModifyRuleFilter.parse(
'* "^drop(.*)noalert(.*)" "alert${1}noalert${2}"')
rule_in ="""drop http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,to_client; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; noalert; classtype:trojan-activity; sid:2020757; rev:2;)"""
rule_out = f.filter(idstools.rule.parse(rule_in))
self.assertEqual("""alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,to_client; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; noalert; classtype:trojan-activity; sid:2020757; rev:2;)""", rule_out.format())
def test_oinkmaster_backticks_not_noalert(self):
f = rulecat.ModifyRuleFilter.parse(
'modifysid * "^drop(.*)noalert(.*)" | "alert${1}noalert${2}"')
rule_in ="""drop http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,to_client; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
rule_out = f.filter(idstools.rule.parse(rule_in))
self.assertEqual(rule_in, rule_out.format())
class GroupMatcherTestCase(unittest.TestCase):
rule_string = """alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
def test_match(self):
rule = idstools.rule.parse(self.rule_string, "rules/malware.rules")
matcher = rulecat.parse_rule_match("group: */malware.rules")
self.assertEquals(
matcher.__class__, idstools.scripts.rulecat.GroupMatcher)
self.assertTrue(matcher.match(rule))
class FilenameMatcherTestCase(unittest.TestCase):
rule_string = """alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
def test_match(self):
rule = idstools.rule.parse(self.rule_string, "rules/trojan.rules")
matcher = rulecat.parse_rule_match("trojan.rules")
self.assertEquals(
matcher.__class__, idstools.scripts.rulecat.FilenameMatcher)
self.assertTrue(matcher.match(rule))
class DropRuleFilterTestCase(unittest.TestCase):
rule_string = """alert http $EXTERNAL_NET any -> $HOME_NET any (msg:"ET MALWARE Windows executable sent when remote host claims to send an image 2"; flow: established,from_server; content:"|0d 0a|Content-Type|3a| image/jpeg|0d 0a 0d 0a|MZ"; fast_pattern:12,20; classtype:trojan-activity; sid:2020757; rev:2;)"""
def test_enabled_rule(self):
rule0 = idstools.rule.parse(self.rule_string, "rules/malware.rules")
id_matcher = rulecat.IdRuleMatcher.parse("2020757")
self.assertTrue(id_matcher.match(rule0))
drop_filter = rulecat.DropRuleFilter(id_matcher)
rule1 = drop_filter.filter(rule0)
self.assertEquals("drop", rule1.action)
self.assertTrue(rule1.enabled)
self.assertTrue(str(rule1).startswith("drop"))
def test_disabled_rule(self):
rule0 = idstools.rule.parse(
"# " + self.rule_string, "rules/malware.rules")
id_matcher = rulecat.IdRuleMatcher.parse("2020757")
self.assertTrue(id_matcher.match(rule0))
drop_filter = rulecat.DropRuleFilter(id_matcher)
rule1 = drop_filter.filter(rule0)
self.assertEquals("drop", rule1.action)
self.assertFalse(rule1.enabled)
self.assertTrue(str(rule1).startswith("# drop"))
def test_drop_noalert(self):
""" Test the rules with "noalert" are not marked as drop. """
rule_without_noalert = """alert tcp $HOME_NET any -> $EXTERNAL_NET any (msg:"ET TROJAN [CrowdStrike] ANCHOR PANDA Torn RAT Beacon Message Header Local"; flow:established, to_server; dsize:16; content:"|00 00 00 11 c8 00 00 00 00 00 00 00 00 00 00 00|"; depth:16; flowbits:set,ET.Torn.toread_header; reference:url,blog.crowdstrike.com/whois-anchor-panda/index.html; classtype:trojan-activity; sid:2016659; rev:2; metadata:created_at 2013_03_22, updated_at 2013_03_22;)"""
rule_with_noalert = """alert tcp $HOME_NET any -> $EXTERNAL_NET any (msg:"ET TROJAN [CrowdStrike] ANCHOR PANDA Torn RAT Beacon Message Header Local"; flow:established, to_server; dsize:16; content:"|00 00 00 11 c8 00 00 00 00 00 00 00 00 00 00 00|"; depth:16; flowbits:set,ET.Torn.toread_header; flowbits: noalert; reference:url,blog.crowdstrike.com/whois-anchor-panda/index.html; classtype:trojan-activity; sid:2016659; rev:2; metadata:created_at 2013_03_22, updated_at 2013_03_22;)"""
rule = idstools.rule.parse(rule_without_noalert)
matcher = rulecat.IdRuleMatcher.parse("2016659")
filter = rulecat.DropRuleFilter(matcher)
self.assertTrue(filter.match(rule))
rule = idstools.rule.parse(rule_with_noalert)
matcher = rulecat.IdRuleMatcher.parse("2016659")
filter = rulecat.DropRuleFilter(matcher)
self.assertFalse(filter.match(rule))