File: test_records.py

package info (click to toggle)
python-evtx 0.6.1-1%2Bdeb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 4,768 kB
  • sloc: python: 3,082; makefile: 6
file content (343 lines) | stat: -rw-r--r-- 13,342 bytes parent folder | download | duplicates (3)
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
import textwrap

import pytest

import Evtx.Evtx as evtx
import Evtx.Nodes as e_nodes

from fixtures import *

try:
    import lxml
    no_lxml = False
except:
    no_lxml = True


def test_parse_records(system):
    '''
    regression test demonstrating that all record metadata can be parsed.

    Args:
      system (bytes): the system.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(system, 0x0)
    for i, chunk in enumerate(fh.chunks()):
        for j, record in enumerate(chunk.records()):
            assert record.magic() == 0x2a2a


def test_parse_records2(security):
    '''
    regression test demonstrating that all record metadata can be parsed.

    Args:
      security (bytes): the security.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(security, 0x0)
    for i, chunk in enumerate(fh.chunks()):
        for j, record in enumerate(chunk.records()):
            assert record.magic() == 0x2a2a


def one(iterable):
    '''
    fetch a single element from the given iterable.

    Args:
      iterable (iterable): a sequence of things.

    Returns:
      object: the first thing in the sequence.
    '''
    for i in iterable:
        return i


def extract_structure(node):
    '''
    given an evtx bxml node, generate a tree of all the nodes.
    each node has:
      - str: node type
      - str: (optional) value
      - list: (optional) children

    Args:
      node (evtx.Node): the root node.

    Returns:
      list: the tree representing the bxml structure.
    '''
    name = node.__class__.__name__

    if isinstance(node, e_nodes.BXmlTypeNode):
        # must go before is VariantTypeNode
        value = None
    elif isinstance(node, e_nodes.VariantTypeNode):
        value = node.string()
    elif isinstance(node, e_nodes.OpenStartElementNode):
        value = node.tag_name()
    elif isinstance(node, e_nodes.AttributeNode):
        value = node.attribute_name().string()
    else:
        value = None

    children = []
    if isinstance(node, e_nodes.BXmlTypeNode):
        children.append(extract_structure(node._root))
    elif isinstance(node, e_nodes.TemplateInstanceNode) and node.is_resident_template():
        children.append(extract_structure(node.template()))

    children.extend(list(map(extract_structure, node.children())))

    if isinstance(node, e_nodes.RootNode):
        substitutions = list(map(extract_structure, node.substitutions()))
        children.append(['Substitutions', None, substitutions])

    if children:
        return [name, value, children]
    elif value:
        return [name, value]
    else:
        return [name]


def test_parse_record(system):
    '''
    regression test demonstrating binary xml nodes getting parsed.

    Args:
      system (bytes): the system.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(system, 0x0)
    chunk = one(fh.chunks())
    record = one(chunk.records())

    # generated by hand, but matches the output of extract_structure.
    expected = \
      ['RootNode', None, [
        ['StreamStartNode'],
        ['TemplateInstanceNode', None, [
          ['TemplateNode', None, [
            ['StreamStartNode'],
            ['OpenStartElementNode', 'Event', [
              ['AttributeNode', 'xmlns', [
                ['ValueNode', None, [
                  ['WstringTypeNode', 'http://schemas.microsoft.com/win/2004/08/events/event']]]]],
              ['CloseStartElementNode'],
              ['OpenStartElementNode', 'System', [
                ['CloseStartElementNode'],
                ['OpenStartElementNode', 'Provider', [
                  ['AttributeNode', 'Name', [
                    ['ValueNode', None, [
                      ['WstringTypeNode', 'Microsoft-Windows-Eventlog']]]]],
                  ['AttributeNode', 'Guid', [
                    ['ValueNode', None, [
                      ['WstringTypeNode', '{fc65ddd8-d6ef-4962-83d5-6e5cfe9ce148}']]]]],
                  ['CloseEmptyElementNode']]],
                ['OpenStartElementNode', 'EventID', [
                  ['AttributeNode', 'Qualifiers', [
                    ['ConditionalSubstitutionNode']]],
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Version', [
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Level', [
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Task', [
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Opcode', [
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Keywords', [
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'TimeCreated', [
                  ['AttributeNode', 'SystemTime', [
                    ['ConditionalSubstitutionNode']]],
                  ['CloseEmptyElementNode']]],
                ['OpenStartElementNode', 'EventRecordID', [
                  ['CloseStartElementNode'],
                  ['ConditionalSubstitutionNode'],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Correlation', [
                  ['AttributeNode', 'ActivityID', [
                    ['ConditionalSubstitutionNode']]],
                  ['AttributeNode', 'RelatedActivityID', [
                    ['ConditionalSubstitutionNode']]],
                  ['CloseEmptyElementNode']]],
                ['OpenStartElementNode', 'Execution', [
                  ['AttributeNode', 'ProcessID', [
                    ['ConditionalSubstitutionNode']]],
                  ['AttributeNode', 'ThreadID', [
                    ['ConditionalSubstitutionNode']]],
                  ['CloseEmptyElementNode']]],
                ['OpenStartElementNode', 'Channel', [
                  ['CloseStartElementNode'],
                  ['ValueNode', None, [
                    ['WstringTypeNode', 'System']]],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Computer', [
                  ['CloseStartElementNode'],
                  ['ValueNode', None, [
                    ['WstringTypeNode', 'WKS-WIN764BITB.shieldbase.local']]],
                  ['CloseElementNode']]],
                ['OpenStartElementNode', 'Security', [
                  ['AttributeNode', 'UserID', [
                    ['ConditionalSubstitutionNode']]],
                  ['CloseEmptyElementNode']]],
                ['CloseElementNode']]],
              ['OpenStartElementNode', 'UserData', [
                ['CloseStartElementNode'],
                ['ConditionalSubstitutionNode'],
                ['CloseElementNode']]],
              ['CloseElementNode']]],
            ['EndOfStreamNode']]]]],
        ['Substitutions', None, [
          ['UnsignedByteTypeNode', '4'],
          ['UnsignedByteTypeNode', '0'],
          ['UnsignedWordTypeNode', '105'],
          ['UnsignedWordTypeNode', '105'],
          ['NullTypeNode'],
          ['Hex64TypeNode', '0x8000000000000000'],
          ['FiletimeTypeNode', '2012-03-14 04:17:43.354563'],
          ['NullTypeNode'],
          ['UnsignedDwordTypeNode', '820'],
          ['UnsignedDwordTypeNode', '2868'],
          ['UnsignedQwordTypeNode', '12049'],
          ['UnsignedByteTypeNode', '0'],
          ['NullTypeNode'],
          ['NullTypeNode'],
          ['NullTypeNode'],
          ['NullTypeNode'],
          ['NullTypeNode'],
          ['NullTypeNode'],
          ['NullTypeNode'],
          ['BXmlTypeNode', None, [
            ['RootNode', None, [
              ['StreamStartNode'],
              ['TemplateInstanceNode', None, [
                  ['TemplateNode', None, [
                    ['StreamStartNode'],
                    ['OpenStartElementNode', 'AutoBackup', [
                      ['AttributeNode', 'xmlns:auto-ns3', [
                        ['ValueNode', None, [
                          ['WstringTypeNode', 'http://schemas.microsoft.com/win/2004/08/events']]]]],
                      ['AttributeNode', 'xmlns', [
                        ['ValueNode', None, [
                          ['WstringTypeNode', 'http://manifests.microsoft.com/win/2004/08/windows/eventlog']]]]],
                      ['CloseStartElementNode'],
                      ['OpenStartElementNode', 'Channel', [
                        ['CloseStartElementNode'],
                        ['NormalSubstitutionNode'],
                        ['CloseElementNode']]],
                      ['OpenStartElementNode', 'BackupPath', [
                        ['CloseStartElementNode'],
                        ['NormalSubstitutionNode'],
                        ['CloseElementNode']]],
                      ['CloseElementNode']]],
                    ['EndOfStreamNode']]]]],
              ['Substitutions', None, [
                ['WstringTypeNode', 'System'],
                ['WstringTypeNode', 'C:\Windows\System32\Winevt\Logs\Archive-System-2012-03-14-04-17-39-932.evtx']]]]]]]]]]]

    assert extract_structure(record.root()) == expected


def test_render_record(system):
    '''
    regression test demonstrating formatting a record to xml.

    Args:
      system (bytes): the system.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(system, 0x0)
    chunk = one(fh.chunks())
    record = one(chunk.records())

    xml = record.xml() 
    assert xml == textwrap.dedent('''\
                                     <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event"><System><Provider Name="Microsoft-Windows-Eventlog" Guid="{fc65ddd8-d6ef-4962-83d5-6e5cfe9ce148}"></Provider>
                                     <EventID Qualifiers="">105</EventID>
                                     <Version>0</Version>
                                     <Level>4</Level>
                                     <Task>105</Task>
                                     <Opcode>0</Opcode>
                                     <Keywords>0x8000000000000000</Keywords>
                                     <TimeCreated SystemTime="2012-03-14 04:17:43.354563"></TimeCreated>
                                     <EventRecordID>12049</EventRecordID>
                                     <Correlation ActivityID="" RelatedActivityID=""></Correlation>
                                     <Execution ProcessID="820" ThreadID="2868"></Execution>
                                     <Channel>System</Channel>
                                     <Computer>WKS-WIN764BITB.shieldbase.local</Computer>
                                     <Security UserID=""></Security>
                                     </System>
                                     <UserData><AutoBackup xmlns:auto-ns3="http://schemas.microsoft.com/win/2004/08/events" xmlns="http://manifests.microsoft.com/win/2004/08/windows/eventlog"><Channel>System</Channel>
                                     <BackupPath>C:\\Windows\\System32\\Winevt\\Logs\\Archive-System-2012-03-14-04-17-39-932.evtx</BackupPath>
                                     </AutoBackup>
                                     </UserData>
                                     </Event>
                                     ''')


def test_render_records(system):
    '''
    regression test demonstrating formatting records to xml.

    Args:
      system (bytes): the system.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(system, 0x0)
    for chunk in fh.chunks():
        for record in chunk.records():
            assert record.xml() is not None


def test_render_records2(security):
    '''
    regression test demonstrating formatting records to xml.

    Args:
      security (bytes): the security.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(security, 0x0)
    for chunk in fh.chunks():
        for record in chunk.records():
            assert record.xml() is not None


@pytest.mark.skipif(no_lxml, reason='lxml not installed')
def test_render_records_lxml(system):
    '''
    regression test demonstrating formatting records to xml.

    Args:
      system (bytes): the system.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(system, 0x0)
    for i, chunk in enumerate(fh.chunks()):
        for j, record in enumerate(chunk.records()):
            assert record.lxml() is not None


@pytest.mark.skipif(no_lxml, reason='lxml not installed')
def test_render_records_lxml2(security):
    '''
    regression test demonstrating formatting records to xml.

    Args:
      security (bytes): the security.evtx test file contents. pytest fixture.
    '''
    fh = evtx.FileHeader(security, 0x0)
    for i, chunk in enumerate(fh.chunks()):
        for j, record in enumerate(chunk.records()):
            assert record.lxml() is not None