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
|
# -*- coding: utf-8 -*-
"""Data files related functions and classes for testing."""
from __future__ import unicode_literals
from plaso.analysis import mediator as analysis_mediator
from plaso.analysis import tagging
from plaso.containers import events
from plaso.containers import sessions
from plaso.engine import knowledge_base
from plaso.lib import definitions
from plaso.storage.fake import writer as fake_writer
from tests import test_lib as shared_test_lib
class TaggingFileTestCase(shared_test_lib.BaseTestCase):
"""The unit test case for a tagging file."""
_TAG_FILE = None
_TEST_TIMESTAMP = shared_test_lib.CopyTimestampFromSring(
'2020-04-04 14:56:39')
def _CheckLabels(self, storage_writer, expected_labels):
"""Checks the labels of tagged events.
Args:
storage_writer (FakeStorageWriter): storage writer used for testing.
expected_labels (list[str]): expected labels.
"""
labels = []
for event_tag in storage_writer.GetEventTags():
labels.extend(event_tag.labels)
labels = set(labels)
expected_labels = set(expected_labels)
self.assertEqual(len(labels), len(expected_labels))
self.assertEqual(sorted(labels), sorted(expected_labels))
def _CheckTaggingRule(
self, event_data_class, attribute_values_per_name, expected_rule_names):
"""Tests a tagging rule.
Args:
event_data_class (type): class of the event data object to use in tests.
attribute_values_per_name (dict[str, list[str]): values of the event data
attribute values per name, to use for testing events that match the
tagging rule.
expected_rule_names (list[str]): expected rule names.
"""
event = events.EventObject()
event.timestamp = self._TEST_TIMESTAMP
event.timestamp_desc = definitions.TIME_DESCRIPTION_UNKNOWN
if not attribute_values_per_name:
event_data = event_data_class()
storage_writer = self._TagEvent(event, event_data, None)
self.assertEqual(
storage_writer.number_of_event_tags, len(expected_rule_names))
self._CheckLabels(storage_writer, expected_rule_names)
else:
maximum_number_of_attribute_values = max([
len(attribute_values)
for attribute_values in attribute_values_per_name.values()])
# Test if variations defined by the attribute_values_per_name match
# the tagging rule.
for test_index in range(maximum_number_of_attribute_values):
# Create the test event data and set the attributes to one of
# the test values.
event_data = event_data_class()
for attribute_name, attribute_values in (
attribute_values_per_name.items()):
attribute_value_index = min(test_index, len(attribute_values) - 1)
attribute_value = attribute_values[attribute_value_index]
setattr(event_data, attribute_name, attribute_value)
storage_writer = self._TagEvent(event, event_data, None)
self.assertEqual(
storage_writer.number_of_event_tags, len(expected_rule_names))
self._CheckLabels(storage_writer, expected_rule_names)
# Test if bogus variations on attribute_values_per_name do not match
# the tagging rule.
for test_attribute_name in attribute_values_per_name.keys():
# Create the test event data and set the attributes to one of
# the test values.
event_data = event_data_class()
for attribute_name, attribute_values in (
attribute_values_per_name.items()):
if attribute_name == test_attribute_name:
attribute_value = 'BOGUS'
else:
attribute_value = attribute_values[0]
setattr(event_data, attribute_name, attribute_value)
storage_writer = self._TagEvent(event, event_data, None)
self.assertEqual(storage_writer.number_of_event_tags, 0)
self._CheckLabels(storage_writer, [])
def _TagEvent(self, event, event_data, event_data_stream):
"""Tags an event.
Args:
event (Event): event.
event_data (EventData): event data.
event_data_stream (EventDataStream): event data stream.
Returns:
FakeStorageWriter: storage writer.
Raises:
SkipTest: if the tag file does not exist.
"""
tag_file_path = self._GetDataFilePath([self._TAG_FILE])
self._SkipIfPathNotExists(tag_file_path)
session = sessions.Session()
storage_writer = fake_writer.FakeStorageWriter(session)
storage_writer.Open()
if event_data_stream:
storage_writer.AddEventDataStream(event_data_stream)
storage_writer.AddEventData(event_data)
storage_writer.AddEvent(event)
knowledge_base_object = knowledge_base.KnowledgeBase()
mediator = analysis_mediator.AnalysisMediator(
storage_writer, knowledge_base_object)
plugin = tagging.TaggingAnalysisPlugin()
plugin.SetAndLoadTagFile(tag_file_path)
plugin.ExamineEvent(mediator, event, event_data, event_data_stream)
analysis_report = plugin.CompileReport(mediator)
storage_writer.AddAnalysisReport(analysis_report)
return storage_writer
|
