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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Tests the event extraction worker."""
from __future__ import unicode_literals
import unittest
from dfvfs.lib import definitions as dfvfs_definitions
from dfvfs.resolver import context
from dfvfs.path import factory as path_spec_factory
from plaso.containers import sessions
from plaso.engine import configurations
from plaso.engine import knowledge_base
from plaso.engine import worker
from plaso.parsers import mediator as parsers_mediator
from plaso.storage.fake import writer as fake_writer
from tests.analyzers import manager as analyzers_manager_test
from tests import test_lib as shared_test_lib
class EventExtractionWorkerTest(shared_test_lib.BaseTestCase):
"""Tests for the event extraction worker."""
# pylint: disable=protected-access
def _TestProcessPathSpec(
self, storage_writer, path_spec, extraction_worker=None,
knowledge_base_values=None, process_archives=False):
"""Tests processing a path specification.
Args:
storage_writer (StorageWriter): storage writer.
path_spec (dfvfs.PathSpec): path specification.
extraction_worker (Optional[EventExtractorWorker]): worker to process the
pathspec. If None, a new worker will be created.
knowledge_base_values (Optional[dict]): knowledge base values.
process_archives (Optional[bool]): whether archive files should be
processed.
"""
knowledge_base_object = knowledge_base.KnowledgeBase()
if knowledge_base_values:
for identifier, value in iter(knowledge_base_values.items()):
knowledge_base_object.SetValue(identifier, value)
resolver_context = context.Context()
mediator = parsers_mediator.ParserMediator(
storage_writer, knowledge_base_object,
resolver_context=resolver_context)
if not extraction_worker:
configuration = configurations.ExtractionConfiguration()
configuration.process_archives = process_archives
extraction_worker = worker.EventExtractionWorker()
extraction_worker.SetExtractionConfiguration(configuration)
storage_writer.Open()
storage_writer.WriteSessionStart()
extraction_worker.ProcessPathSpec(mediator, path_spec)
event_source = storage_writer.GetFirstWrittenEventSource()
while event_source:
extraction_worker.ProcessPathSpec(mediator, event_source.path_spec)
event_source = storage_writer.GetNextWrittenEventSource()
storage_writer.WriteSessionCompletion()
storage_writer.Close()
@shared_test_lib.skipUnlessHasTestFile(['ímynd.dd'])
def testAnalyzeFileObject(self):
"""Tests the _AnalyzeFileObject function."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
storage_writer = fake_writer.FakeStorageWriter(session)
knowledge_base_object = knowledge_base.KnowledgeBase()
if knowledge_base_values:
for identifier, value in iter(knowledge_base_values.items()):
knowledge_base_object.SetValue(identifier, value)
resolver_context = context.Context()
mediator = parsers_mediator.ParserMediator(
storage_writer, knowledge_base_object, preferred_year=2016,
resolver_context=resolver_context)
extraction_worker = worker.EventExtractionWorker()
test_analyzer = analyzers_manager_test.TestAnalyzer()
self.assertEqual(len(test_analyzer.GetResults()), 0)
extraction_worker._analyzers = [test_analyzer]
file_entry = self._GetTestFileEntry(['ímynd.dd'])
mediator.SetFileEntry(file_entry)
file_object = file_entry.GetFileObject()
try:
extraction_worker._AnalyzeFileObject(mediator, file_object)
finally:
file_object.close()
self.assertEqual(len(mediator._extra_event_attributes), 1)
event_attribute = mediator._extra_event_attributes.get('test_result', None)
self.assertEqual(event_attribute, 'is_vegetable')
@shared_test_lib.skipUnlessHasTestFile(['syslog'])
def testProcessPathSpecFile(self):
"""Tests the ProcessPathSpec function on a file."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
path_spec = self._GetTestFilePathSpec(['syslog'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 19)
@shared_test_lib.skipUnlessHasTestFile(['syslog.gz'])
def testProcessPathSpecCompressedFileGZIP(self):
"""Tests the ProcessPathSpec function on a gzip compressed file."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
path_spec = self._GetTestFilePathSpec(['syslog.gz'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 16)
@shared_test_lib.skipUnlessHasTestFile(['syslog.bz2'])
def testProcessPathSpecCompressedFileBZIP2(self):
"""Tests the ProcessPathSpec function on a bzip2 compressed file."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
path_spec = self._GetTestFilePathSpec(['syslog.bz2'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 15)
@shared_test_lib.skipUnlessHasTestFile(['syslog.tar'])
def testProcessPathSpec(self):
"""Tests the ProcessPathSpec function on an archive file."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
source_path = self._GetTestFilePath(['syslog.tar'])
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=source_path)
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_TAR, location='/syslog',
parent=path_spec)
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 13)
# Process an archive file without "process archive files" mode.
path_spec = self._GetTestFilePathSpec(['syslog.tar'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 3)
# Process an archive file with "process archive files" mode.
path_spec = self._GetTestFilePathSpec(['syslog.tar'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values,
process_archives=True)
self.assertEqual(storage_writer.number_of_events, 16)
@shared_test_lib.skipUnlessHasTestFile(['syslog.tgz'])
def testProcessPathSpecCompressedArchive(self):
"""Tests the ProcessPathSpec function on a compressed archive file."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
source_path = self._GetTestFilePath(['syslog.tgz'])
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=source_path)
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_GZIP, parent=path_spec)
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_TAR, location='/syslog',
parent=path_spec)
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 13)
# Process an archive file with "process archive files" mode.
path_spec = self._GetTestFilePathSpec(['syslog.tgz'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values,
process_archives=True)
self.assertEqual(storage_writer.number_of_events, 17)
@shared_test_lib.skipUnlessHasTestFile(['image.vmdk'])
def testProcessPathSpecVMDK(self):
"""Tests the ProcessPathSpec function on a VMDK with symbolic links."""
knowledge_base_values = {'year': 2016}
session = sessions.Session()
source_path = self._GetTestFilePath(['image.vmdk'])
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=source_path)
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_VMDK, parent=path_spec)
path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_TSK, location='/',
parent=path_spec)
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, knowledge_base_values=knowledge_base_values)
self.assertEqual(storage_writer.number_of_events, 18)
@shared_test_lib.skipUnlessHasTestFile(['empty_file'])
def testExtractionWorkerHashing(self):
"""Test that the worker sets up and runs hashing code correctly."""
extraction_worker = worker.EventExtractionWorker()
extraction_worker._SetHashers('md5')
self.assertIn('hashing', extraction_worker.GetAnalyzerNames())
knowledge_base_values = {'year': 2016}
session = sessions.Session()
path_spec = self._GetTestFilePathSpec(['empty_file'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, extraction_worker=extraction_worker,
knowledge_base_values=knowledge_base_values)
storage_writer.Open()
empty_file_md5 = 'd41d8cd98f00b204e9800998ecf8427e'
for event in storage_writer.GetSortedEvents():
md5_hash = getattr(event, 'md5_hash', None)
self.assertEqual(md5_hash, empty_file_md5)
storage_writer.Close()
@shared_test_lib.skipUnlessHasTestFile(['yara.rules'])
@shared_test_lib.skipUnlessHasTestFile(['test_pe.exe'])
def testExtractionWorkerYara(self):
"""Tests that the worker applies Yara matching code correctly."""
extraction_worker = worker.EventExtractionWorker()
rule_path = self._GetTestFilePath(['yara.rules'])
with open(rule_path, 'r') as rule_file:
rule_string = rule_file.read()
extraction_worker._SetYaraRules(rule_string)
self.assertIn('yara', extraction_worker.GetAnalyzerNames())
knowledge_base_values = {'year': 2016}
session = sessions.Session()
path_spec = self._GetTestFilePathSpec(['test_pe.exe'])
storage_writer = fake_writer.FakeStorageWriter(session)
self._TestProcessPathSpec(
storage_writer, path_spec, extraction_worker=extraction_worker,
knowledge_base_values=knowledge_base_values)
storage_writer.Open()
expected_yara_match = 'PEfileBasic,PEfile'
for event in storage_writer.GetSortedEvents():
yara_match = getattr(event, 'yara_match', None)
self.assertEqual(yara_match, expected_yara_match)
storage_writer.Close()
if __name__ == '__main__':
unittest.main()
|
