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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Tests for the path helper."""
from __future__ import unicode_literals
import os
import unittest
from dfvfs.lib import definitions as dfvfs_definitions
from dfvfs.path import factory as path_spec_factory
from plaso.containers import artifacts
from plaso.engine import path_helper
from tests import test_lib as shared_test_lib
class PathHelperTest(shared_test_lib.BaseTestCase):
"""Tests for the path helper."""
# pylint: disable=protected-access
def testExpandUsersHomeDirectoryPathSegments(self):
"""Tests the _ExpandUsersHomeDirectoryPathSegments function."""
user_account_artifact1 = artifacts.UserAccountArtifact(
user_directory='/home/Test1', username='Test1')
user_account_artifact2 = artifacts.UserAccountArtifact(
user_directory='/Users/Test2', username='Test2')
user_account_artifact3 = artifacts.UserAccountArtifact(username='Test3')
user_accounts = [
user_account_artifact1, user_account_artifact2, user_account_artifact3]
path_segments = ['%%users.homedir%%', '.bashrc']
expanded_paths = (
path_helper.PathHelper._ExpandUsersHomeDirectoryPathSegments(
path_segments, '/', user_accounts))
expected_expanded_paths = [
'/home/Test1/.bashrc',
'/Users/Test2/.bashrc']
self.assertEqual(expanded_paths, expected_expanded_paths)
user_account_artifact1 = artifacts.UserAccountArtifact(
path_separator='\\', user_directory='C:\\Users\\Test1',
username='Test1')
user_account_artifact2 = artifacts.UserAccountArtifact(
path_separator='\\', user_directory='%SystemDrive%\\Users\\Test2',
username='Test2')
user_accounts = [user_account_artifact1, user_account_artifact2]
path_segments = ['%%users.userprofile%%', 'Profile']
expanded_paths = (
path_helper.PathHelper._ExpandUsersHomeDirectoryPathSegments(
path_segments, '\\', user_accounts))
expected_expanded_paths = [
'\\Users\\Test1\\Profile',
'\\Users\\Test2\\Profile']
self.assertEqual(expanded_paths, expected_expanded_paths)
path_segments = ['C:', 'Temp']
expanded_paths = (
path_helper.PathHelper._ExpandUsersHomeDirectoryPathSegments(
path_segments, '\\', user_accounts))
expected_expanded_paths = ['\\Temp']
self.assertEqual(expanded_paths, expected_expanded_paths)
path_segments = ['C:', 'Temp', '%%users.userprofile%%']
expanded_paths = (
path_helper.PathHelper._ExpandUsersHomeDirectoryPathSegments(
path_segments, '\\', user_accounts))
expected_expanded_paths = ['\\Temp\\%%users.userprofile%%']
self.assertEqual(expanded_paths, expected_expanded_paths)
def testExpandUsersVariablePathSegments(self):
"""Tests the _ExpandUsersVariablePathSegments function."""
user_account_artifact1 = artifacts.UserAccountArtifact(
identifier='1000', path_separator='\\',
user_directory='C:\\Users\\Test1', username='Test1')
user_account_artifact2 = artifacts.UserAccountArtifact(
identifier='1001', path_separator='\\',
user_directory='%SystemDrive%\\Users\\Test2', username='Test2')
user_accounts = [user_account_artifact1, user_account_artifact2]
path_segments = ['%%users.appdata%%', 'Microsoft', 'Windows', 'Recent']
expanded_paths = path_helper.PathHelper._ExpandUsersVariablePathSegments(
path_segments, '\\', user_accounts)
expected_expanded_paths = [
'\\Users\\Test1\\AppData\\Roaming\\Microsoft\\Windows\\Recent',
'\\Users\\Test1\\Application Data\\Microsoft\\Windows\\Recent',
'\\Users\\Test2\\AppData\\Roaming\\Microsoft\\Windows\\Recent',
'\\Users\\Test2\\Application Data\\Microsoft\\Windows\\Recent']
self.assertEqual(sorted(expanded_paths), expected_expanded_paths)
path_segments = ['C:', 'Windows']
expanded_paths = path_helper.PathHelper._ExpandUsersVariablePathSegments(
path_segments, '\\', user_accounts)
expected_expanded_paths = ['\\Windows']
self.assertEqual(sorted(expanded_paths), expected_expanded_paths)
def testIsWindowsDrivePathSegment(self):
"""Tests the _IsWindowsDrivePathSegment function."""
result = path_helper.PathHelper._IsWindowsDrivePathSegment('C:')
self.assertTrue(result)
result = path_helper.PathHelper._IsWindowsDrivePathSegment('%SystemDrive%')
self.assertTrue(result)
result = path_helper.PathHelper._IsWindowsDrivePathSegment(
'%%environ_systemdrive%%')
self.assertTrue(result)
result = path_helper.PathHelper._IsWindowsDrivePathSegment('Windows')
self.assertFalse(result)
def testExpandGlobStars(self):
"""Tests the ExpandGlobStars function."""
paths = path_helper.PathHelper.ExpandGlobStars('/etc/sysconfig/**', '/')
self.assertEqual(len(paths), 10)
expected_paths = sorted([
'/etc/sysconfig/*',
'/etc/sysconfig/*/*',
'/etc/sysconfig/*/*/*',
'/etc/sysconfig/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*/*/*'])
self.assertEqual(sorted(paths), expected_paths)
# Test globstar with recursion depth of 4.
paths = path_helper.PathHelper.ExpandGlobStars('/etc/sysconfig/**4', '/')
self.assertEqual(len(paths), 4)
expected_paths = sorted([
'/etc/sysconfig/*',
'/etc/sysconfig/*/*',
'/etc/sysconfig/*/*/*',
'/etc/sysconfig/*/*/*/*'])
self.assertEqual(sorted(paths), expected_paths)
# Test globstar with unsupported recursion depth of 99.
paths = path_helper.PathHelper.ExpandGlobStars('/etc/sysconfig/**99', '/')
self.assertEqual(len(paths), 10)
expected_paths = sorted([
'/etc/sysconfig/*',
'/etc/sysconfig/*/*',
'/etc/sysconfig/*/*/*',
'/etc/sysconfig/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*/*/*'])
self.assertEqual(sorted(paths), expected_paths)
# Test globstar with prefix.
paths = path_helper.PathHelper.ExpandGlobStars('/etc/sysconfig/my**', '/')
self.assertEqual(len(paths), 1)
self.assertEqual(paths, ['/etc/sysconfig/my**'])
# Test globstar with suffix.
paths = path_helper.PathHelper.ExpandGlobStars('/etc/sysconfig/**.exe', '/')
self.assertEqual(len(paths), 1)
self.assertEqual(paths, ['/etc/sysconfig/**.exe'])
def testExpandUsersVariablePath(self):
"""Tests the ExpandUsersVariablePath function."""
user_account_artifact1 = artifacts.UserAccountArtifact(
path_separator='\\', user_directory='C:\\Users\\Test1',
username='Test1')
user_account_artifact2 = artifacts.UserAccountArtifact(
path_separator='\\', user_directory='%SystemDrive%\\Users\\Test2',
username='Test2')
user_accounts = [user_account_artifact1, user_account_artifact2]
path = '%%users.appdata%%\\Microsoft\\Windows\\Recent'
expanded_paths = path_helper.PathHelper.ExpandUsersVariablePath(
path, '\\', user_accounts)
expected_expanded_paths = [
'\\Users\\Test1\\AppData\\Roaming\\Microsoft\\Windows\\Recent',
'\\Users\\Test1\\Application Data\\Microsoft\\Windows\\Recent',
'\\Users\\Test2\\AppData\\Roaming\\Microsoft\\Windows\\Recent',
'\\Users\\Test2\\Application Data\\Microsoft\\Windows\\Recent']
self.assertEqual(sorted(expanded_paths), expected_expanded_paths)
def testExpandWindowsPath(self):
"""Tests the ExpandWindowsPath function."""
environment_variables = []
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='SystemRoot', value='C:\\Windows')
environment_variables.append(environment_variable)
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'%SystemRoot%\\System32', environment_variables)
self.assertEqual(expanded_path, '\\Windows\\System32')
def testExpandWindowsPathSegments(self):
"""Tests the ExpandWindowsPathSegments function."""
environment_variables = []
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='allusersappdata',
value='C:\\Documents and Settings\\All Users\\Application Data')
environment_variables.append(environment_variable)
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='allusersprofile',
value='C:\\Documents and Settings\\All Users')
environment_variables.append(environment_variable)
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='SystemRoot', value='C:\\Windows')
environment_variables.append(environment_variable)
expected_expanded_path_segment = [
'', 'Documents and Settings', 'All Users', 'Application Data',
'Apache Software Foundation']
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%AllUsersAppData%', 'Apache Software Foundation'],
environment_variables)
self.assertEqual(expanded_path_segment, expected_expanded_path_segment)
expected_expanded_path_segment = [
'', 'Documents and Settings', 'All Users', 'Start Menu', 'Programs',
'Startup']
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%AllUsersProfile%', 'Start Menu', 'Programs', 'Startup'],
environment_variables)
self.assertEqual(expanded_path_segment, expected_expanded_path_segment)
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%SystemRoot%', 'System32'], environment_variables)
self.assertEqual(expanded_path_segment, ['', 'Windows', 'System32'])
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['C:', 'Windows', 'System32'], environment_variables)
self.assertEqual(expanded_path_segment, ['', 'Windows', 'System32'])
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%SystemRoot%', 'System32'], None)
self.assertEqual(expanded_path_segment, ['%SystemRoot%', 'System32'])
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%Bogus%', 'System32'], environment_variables)
self.assertEqual(expanded_path_segment, ['%Bogus%', 'System32'])
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%%environ_systemroot%%', 'System32'], environment_variables)
self.assertEqual(expanded_path_segment, ['', 'Windows', 'System32'])
# Test non-string environment variable.
environment_variables = []
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='SystemRoot', value=('bogus', 0))
environment_variables.append(environment_variable)
expanded_path_segment = path_helper.PathHelper.ExpandWindowsPathSegments(
['%SystemRoot%', 'System32'], environment_variables)
self.assertEqual(expanded_path_segment, ['%SystemRoot%', 'System32'])
def testGetDisplayNameForPathSpec(self):
"""Tests the GetDisplayNameForPathSpec function."""
test_path = self._GetTestFilePath(['syslog.gz'])
os_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=test_path)
expected_display_name = 'OS:{0:s}'.format(test_path)
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
os_path_spec)
self.assertEqual(display_name, expected_display_name)
gzip_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_GZIP, parent=os_path_spec)
expected_display_name = 'GZIP:{0:s}'.format(test_path)
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
gzip_path_spec)
self.assertEqual(display_name, expected_display_name)
test_path = self._GetTestFilePath(['syslog.bz2'])
os_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=test_path)
compressed_stream_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_COMPRESSED_STREAM,
compression_method=dfvfs_definitions.COMPRESSION_METHOD_BZIP2,
parent=os_path_spec)
expected_display_name = 'BZIP2:{0:s}'.format(test_path)
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
compressed_stream_path_spec)
self.assertEqual(display_name, expected_display_name)
test_path = self._GetTestFilePath(['syslog.xz'])
os_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=test_path)
compressed_stream_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_COMPRESSED_STREAM,
compression_method=dfvfs_definitions.COMPRESSION_METHOD_XZ,
parent=os_path_spec)
expected_display_name = 'XZ:{0:s}'.format(test_path)
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
compressed_stream_path_spec)
self.assertEqual(display_name, expected_display_name)
test_path = self._GetTestFilePath(['vsstest.qcow2'])
os_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=test_path)
qcow_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_QCOW, parent=os_path_spec)
vshadow_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_VSHADOW, location='/vss2',
store_index=1, parent=qcow_path_spec)
tsk_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_TSK, inode=35, location='/syslog.gz',
parent=vshadow_path_spec)
expected_display_name = 'VSS2:TSK:/syslog.gz'
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
tsk_path_spec)
self.assertEqual(display_name, expected_display_name)
expected_display_name = 'VSS2:TSK:C:/syslog.gz'
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
tsk_path_spec, text_prepend='C:')
self.assertEqual(display_name, expected_display_name)
test_path = self._GetTestFilePath(['vsstest.qcow2'])
os_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=test_path)
qcow_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_QCOW, parent=os_path_spec)
vshadow_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_VSHADOW, location='/vss2',
store_index=1, parent=qcow_path_spec)
ntfs_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_NTFS, mft_entry=35,
location='\\syslog.gz', parent=vshadow_path_spec)
expected_display_name = 'VSS2:NTFS:\\syslog.gz'
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
ntfs_path_spec)
self.assertEqual(display_name, expected_display_name)
expected_display_name = 'VSS2:NTFS:C:\\syslog.gz'
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(
ntfs_path_spec, text_prepend='C:')
self.assertEqual(display_name, expected_display_name)
# Test without path specification.
display_name = path_helper.PathHelper.GetDisplayNameForPathSpec(None)
self.assertIsNone(display_name)
# Test path specification without location
os_path_spec.location = None
qcow_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_QCOW, parent=os_path_spec)
self.assertIsNone(display_name)
def testGetRelativePathForPathSpec(self):
"""Tests the GetRelativePathForPathSpec function."""
test_path = self._GetTestFilePath(['syslog.gz'])
os_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_OS, location=test_path)
relative_path = path_helper.PathHelper.GetRelativePathForPathSpec(
os_path_spec)
self.assertEqual(relative_path, test_path)
# Test path specification with mount point.
mount_path = self._GetTestFilePath([])
relative_path = path_helper.PathHelper.GetRelativePathForPathSpec(
os_path_spec, mount_path=mount_path)
expected_relative_path = '{0:s}syslog.gz'.format(os.path.sep)
self.assertEqual(relative_path, expected_relative_path)
# Test path specification with incorrect mount point.
relative_path = path_helper.PathHelper.GetRelativePathForPathSpec(
os_path_spec, mount_path='/bogus')
self.assertEqual(relative_path, test_path)
# Test path specification with data stream.
os_path_spec.data_stream = 'MYDATA'
expected_relative_path = '{0:s}:MYDATA'.format(test_path)
relative_path = path_helper.PathHelper.GetRelativePathForPathSpec(
os_path_spec)
self.assertEqual(relative_path, expected_relative_path)
# Test without path specification.
display_name = path_helper.PathHelper.GetRelativePathForPathSpec(None)
self.assertIsNone(display_name)
# Test path specification without location.
os_path_spec.location = None
qcow_path_spec = path_spec_factory.Factory.NewPathSpec(
dfvfs_definitions.TYPE_INDICATOR_QCOW, parent=os_path_spec)
display_name = path_helper.PathHelper.GetRelativePathForPathSpec(
qcow_path_spec)
self.assertIsNone(display_name)
if __name__ == '__main__':
unittest.main()
|
