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
|
# -*- coding: utf-8 -*-
"""Analysis plugin related functions and classes for testing."""
from __future__ import unicode_literals
from plaso.analysis import mediator as analysis_mediator
from plaso.containers import artifacts
from plaso.containers import events
from plaso.containers import sessions
from plaso.engine import knowledge_base
from plaso.parsers import interface as parsers_interface
from plaso.parsers import mediator as parsers_mediator
from plaso.storage.fake import writer as fake_writer
from tests import test_lib as shared_test_lib
from tests.containers import test_lib as containers_test_lib
class AnalysisPluginTestCase(shared_test_lib.BaseTestCase):
"""The unit test case for an analysis plugin."""
def _AnalyzeEvents(
self, event_values_list, plugin, knowledge_base_values=None):
"""Analyzes events using the analysis plugin.
Args:
event_values_list (list[dict[str, object]]): list of event values.
plugin (AnalysisPlugin): plugin.
knowledge_base_values (Optional[dict[str, str]]): knowledge base values.
Returns:
FakeStorageWriter: storage writer.
"""
knowledge_base_object = self._SetUpKnowledgeBase(
knowledge_base_values=knowledge_base_values)
session = sessions.Session()
storage_writer = fake_writer.FakeStorageWriter(session)
storage_writer.Open()
test_events = []
for event, event_data, event_data_stream in (
containers_test_lib.CreateEventsFromValues(event_values_list)):
storage_writer.AddEventDataStream(event_data_stream)
event_data.SetEventDataStreamIdentifier(event_data_stream.GetIdentifier())
storage_writer.AddEventData(event_data)
event.SetEventDataIdentifier(event_data.GetIdentifier())
storage_writer.AddEvent(event)
test_events.append((event, event_data, event_data_stream))
mediator = analysis_mediator.AnalysisMediator(
storage_writer, knowledge_base_object)
for event, event_data, event_data_stream in test_events:
plugin.ExamineEvent(mediator, event, event_data, event_data_stream)
analysis_report = plugin.CompileReport(mediator)
storage_writer.AddAnalysisReport(analysis_report)
return storage_writer
def _ParseAndAnalyzeFile(
self, path_segments, parser, plugin, knowledge_base_values=None):
"""Parses and analyzes a file using the parser and analysis plugin.
Args:
path_segments (list[str]): path segments inside the test data directory.
parser (BaseParser): parser.
plugin (AnalysisPlugin): plugin.
knowledge_base_values (Optional[dict[str, str]]): knowledge base values.
Returns:
FakeStorageWriter: storage writer.
Raises:
SkipTest: if the path inside the test data directory does not exist and
the test should be skipped.
"""
knowledge_base_object = self._SetUpKnowledgeBase(
knowledge_base_values=knowledge_base_values)
storage_writer = self._ParseFile(
path_segments, parser, knowledge_base_object)
mediator = analysis_mediator.AnalysisMediator(
storage_writer, knowledge_base_object)
for event in storage_writer.GetSortedEvents():
event_data = None
event_data_identifier = event.GetEventDataIdentifier()
if event_data_identifier:
event_data = storage_writer.GetEventDataByIdentifier(
event_data_identifier)
event_data_stream = None
if event_data:
event_data_stream_identifier = event_data.GetEventDataStreamIdentifier()
if event_data_stream_identifier:
event_data_stream = storage_writer.GetEventDataStreamByIdentifier(
event_data_stream_identifier)
plugin.ExamineEvent(mediator, event, event_data, event_data_stream)
analysis_report = plugin.CompileReport(mediator)
storage_writer.AddAnalysisReport(analysis_report)
return storage_writer
def _ParseFile(self, path_segments, parser, knowledge_base_object):
"""Parses a file using the parser.
Args:
path_segments (list[str]): path segments inside the test data directory.
parser (BaseParser): parser.
knowledge_base_object (KnowledgeBase): knowledge base.
Returns:
FakeStorageWriter: storage writer.
Raises:
SkipTest: if the path inside the test data directory does not exist and
the test should be skipped.
"""
session = sessions.Session()
storage_writer = fake_writer.FakeStorageWriter(session)
storage_writer.Open()
parser_mediator = parsers_mediator.ParserMediator(
storage_writer, knowledge_base_object)
file_entry = self._GetTestFileEntry(path_segments)
parser_mediator.SetFileEntry(file_entry)
event_data_stream = events.EventDataStream()
parser_mediator.ProduceEventDataStream(event_data_stream)
if isinstance(parser, parsers_interface.FileEntryParser):
parser.Parse(parser_mediator)
elif isinstance(parser, parsers_interface.FileObjectParser):
file_object = file_entry.GetFileObject()
try:
parser.Parse(parser_mediator, file_object)
finally:
file_object.close()
else:
self.fail('Got unexpected parser type: {0!s}'.format(type(parser)))
return storage_writer
def _SetUpKnowledgeBase(self, knowledge_base_values=None):
"""Sets up a knowledge base.
Args:
knowledge_base_values (Optional[dict[str, str]]): knowledge base values.
Returns:
KnowledgeBase: knowledge base.
"""
knowledge_base_object = knowledge_base.KnowledgeBase()
if knowledge_base_values:
for identifier, value in knowledge_base_values.items():
if identifier == 'users':
self._SetUserAccounts(knowledge_base_object, value)
else:
knowledge_base_object.SetValue(identifier, value)
return knowledge_base_object
def _SetUserAccounts(self, knowledge_base_object, users):
"""Sets the user accounts in the knowledge base.
Args:
knowledge_base_object (KnowledgeBase): used to store information about
users.
users (list[dict[str, str])): users, for example [{'name': 'me',
'sid': 'S-1', 'uid': '1'}]
"""
for user in users:
identifier = user.get('sid', user.get('uid', None))
if not identifier:
continue
user_account_artifact = artifacts.UserAccountArtifact(
identifier=identifier, user_directory=user.get('path', None),
username=user.get('name', None))
knowledge_base_object.AddUserAccount(user_account_artifact)
|
