-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
Copy pathtest_wineventlog.py
307 lines (287 loc) · 10.4 KB
/
test_wineventlog.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
297
298
299
300
301
302
303
304
305
306
307
import sys
import time
import unittest
from winlogbeat import WriteReadTest
if sys.platform.startswith("win"):
import win32evtlog
import win32security
"""
Contains tests for reading from the Windows Event Log API (MS Vista and newer).
"""
@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
class Test(WriteReadTest):
@classmethod
def setUpClass(self):
self.api = "wineventlog"
super(WriteReadTest, self).setUpClass()
def test_read_one_event(self):
"""
wineventlog - Read one classic event
"""
msg = "Hello world!"
self.write_event_log(msg)
evts = self.read_events()
self.assertTrue(len(evts), 1)
self.assert_common_fields(evts[0], msg=msg, extra={
"keywords": ["Classic"],
"opcode": "Info",
})
def test_read_unknown_event_id(self):
"""
wineventlog - Read unknown event ID
"""
msg = "Unknown event ID"
event_id = 1111
self.write_event_log(msg, eventID=event_id)
evts = self.read_events()
self.assertTrue(len(evts), 1)
self.assert_common_fields(evts[0], eventID=event_id, extra={
"keywords": ["Classic"],
"opcode": "Info",
})
# Oddly, no rendering error is being given.
self.assertTrue("message_error" not in evts[0])
def test_read_unknown_sid(self):
"""
wineventlog - Read event with unknown SID
"""
# Fake SID that was made up.
accountIdentifier = "S-1-5-21-3623811015-3361044348-30300820-1013"
sid = win32security.ConvertStringSidToSid(accountIdentifier)
msg = "Unknown SID " + accountIdentifier
self.write_event_log(msg, sid=sid)
evts = self.read_events()
self.assertTrue(len(evts), 1)
self.assert_common_fields(evts[0], msg=msg, sid=accountIdentifier, extra={
"keywords": ["Classic"],
"opcode": "Info",
})
def test_fields_under_root(self):
"""
wineventlog - Add tags and custom fields under root
"""
msg = "Add tags and fields under root"
self.write_event_log(msg)
evts = self.read_events(config={
"tags": ["global"],
"fields": {"global": "field", "env": "prod", "level": "overwrite"},
"fields_under_root": True,
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"tags": ["local"],
"fields_under_root": True,
"fields": {"local": "field", "env": "dev"}
}
]
})
self.assertTrue(len(evts), 1)
self.assert_common_fields(evts[0], msg=msg, level="overwrite", extra={
"keywords": ["Classic"],
"opcode": "Info",
"global": "field",
"env": "dev",
"local": "field",
"tags": ["global", "local"],
})
def test_fields_not_under_root(self):
"""
wineventlog - Add custom fields (not under root)
"""
msg = "Add fields (not under root)"
self.write_event_log(msg)
evts = self.read_events(config={
"fields": {"global": "field", "env": "prod", "level": "overwrite"},
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"fields": {"local": "field", "env": "dev", "num": 1}
}
]
})
self.assertTrue(len(evts), 1)
self.assert_common_fields(evts[0], msg=msg, extra={
"keywords": ["Classic"],
"opcode": "Info",
"fields.global": "field",
"fields.env": "dev",
"fields.level": "overwrite",
"fields.local": "field",
"fields.num": 1,
})
self.assertTrue("tags" not in evts[0])
def test_include_xml(self):
"""
wineventlog - Include raw XML event
"""
msg = "Include raw XML event"
self.write_event_log(msg)
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"include_xml": True,
}
]
})
self.assertTrue(len(evts), 1)
self.assert_common_fields(evts[0], msg=msg)
self.assertTrue("xml" in evts[0])
def test_query_event_id(self):
"""
wineventlog - Query by event IDs
"""
msg = "event_id test case"
self.write_event_log(msg, eventID=10) # Excluded
self.write_event_log(msg, eventID=50)
self.write_event_log(msg, eventID=100)
self.write_event_log(msg, eventID=150) # Excluded
self.write_event_log(msg, eventID=175)
self.write_event_log(msg, eventID=200)
evts = self.read_events(config={
"tags": ["event_id"],
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"event_id": "50, 100-200, -150"
}
]
}, expected_events=4)
self.assertTrue(len(evts), 4)
self.assertEqual(evts[0]["event_id"], 50)
self.assertEqual(evts[1]["event_id"], 100)
self.assertEqual(evts[2]["event_id"], 175)
self.assertEqual(evts[3]["event_id"], 200)
def test_query_level_single(self):
"""
wineventlog - Query by level (warning)
"""
self.write_event_log("success", level=win32evtlog.EVENTLOG_SUCCESS)
self.write_event_log("error", level=win32evtlog.EVENTLOG_ERROR_TYPE)
self.write_event_log("warning", level=win32evtlog.EVENTLOG_WARNING_TYPE)
self.write_event_log("information", level=win32evtlog.EVENTLOG_INFORMATION_TYPE)
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"level": "warning"
}
]
})
self.assertTrue(len(evts), 1)
self.assertEqual(evts[0]["level"], "Warning")
def test_query_level_multiple(self):
"""
wineventlog - Query by level (error, warning)
"""
self.write_event_log("success", level=win32evtlog.EVENTLOG_SUCCESS) # Level 0, Info
self.write_event_log("error", level=win32evtlog.EVENTLOG_ERROR_TYPE) # Level 2
self.write_event_log("warning", level=win32evtlog.EVENTLOG_WARNING_TYPE) # Level 3
self.write_event_log("information", level=win32evtlog.EVENTLOG_INFORMATION_TYPE) # Level 4
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"level": "error, warning"
}
]
}, expected_events=2)
self.assertTrue(len(evts), 2)
self.assertEqual(evts[0]["level"], "Error")
self.assertEqual(evts[1]["level"], "Warning")
def test_query_ignore_older(self):
"""
wineventlog - Query by time (ignore_older than 2s)
"""
self.write_event_log(">=2 seconds old", eventID=20)
time.sleep(2)
self.write_event_log("~0 seconds old", eventID=10)
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"ignore_older": "2s"
}
]
})
self.assertTrue(len(evts), 1)
self.assertEqual(evts[0]["event_id"], 10)
def test_query_provider(self):
"""
wineventlog - Query by provider (event source)
"""
self.write_event_log("selected", source=self.otherAppName)
self.write_event_log("filtered")
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"provider": [self.otherAppName]
}
]
})
self.assertTrue(len(evts), 1)
self.assertEqual(evts[0]["source_name"], self.otherAppName)
def test_query_multi_param(self):
"""
wineventlog - Query by multiple params
"""
self.write_event_log("selected", source=self.otherAppName,
eventID=556, level=win32evtlog.EVENTLOG_ERROR_TYPE)
self.write_event_log("filtered", source=self.otherAppName, eventID=556)
self.write_event_log("filtered", level=win32evtlog.EVENTLOG_WARNING_TYPE)
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"event_id": "10-20, 30-40, -35, -18, 400-1000, -432",
"level": "warn, error",
"provider": [self.otherAppName]
}
]
})
self.assertTrue(len(evts), 1)
self.assertEqual(evts[0]["message"], "selected")
def test_unknown_eventlog_config(self):
"""
wineventlog - Unknown config parameter
"""
self.render_config_template(
event_logs=[
{
"name": self.providerName,
"api": self.api,
"invalid": "garbage"}
]
)
self.start_beat(extra_args=["-configtest"]).check_wait(exit_code=1)
assert self.log_contains("1 error: Invalid event log key 'invalid' found.")
def test_utf16_characters(self):
"""
wineventlog - UTF-16 characters
"""
msg = (u'\u89E3\u51CD\u3057\u305F\u30D5\u30A9\u30EB\u30C0\u306E'
u'\u30A4\u30F3\u30B9\u30C8\u30FC\u30EB\u30B9\u30AF\u30EA'
u'\u30D7\u30C8\u3092\u5B9F\u884C\u3057'
u'\u8C61\u5F62\u5B57')
self.write_event_log(msg)
evts = self.read_events(config={
"event_logs": [
{
"name": self.providerName,
"api": self.api,
"include_xml": True,
}
]
})
self.assertTrue(len(evts), 1)
self.assertEqual(evts[0]["message"], msg)