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
|
#!/usr/bin/env python
# -*- 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."""
def testAppendPathEntries(self):
"""Tests the AppendPathEntries function."""
separator = '\\'
path = '\\Windows\\Test'
# Test depth of ten skipping first entry.
# The path will have 9 entries as the default depth for ** is 10, but the
# first entry is being skipped.
count = 10
skip_first = True
paths = path_helper.PathHelper.AppendPathEntries(
path, separator, count, skip_first)
# Nine paths returned
self.assertEqual(len(paths), 9)
# Nine paths in total, each one level deeper than the previous.
check_paths = sorted([
'\\Windows\\Test\\*\\*',
'\\Windows\\Test\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*\\*\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*\\*\\*\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*'])
self.assertEqual(sorted(paths), check_paths)
# Now test with skip_first set to False, but only a depth of 4.
# the path will have a total of 4 entries.
count = 4
skip_first = False
paths = path_helper.PathHelper.AppendPathEntries(
path, separator, count, skip_first)
# Four paths returned
self.assertEqual(len(paths), 4)
# Four paths in total, each one level deeper than the previous.
check_paths = sorted([
'\\Windows\\Test\\*',
'\\Windows\\Test\\*\\*',
'\\Windows\\Test\\*\\*\\*',
'\\Windows\\Test\\*\\*\\*\\*'])
self.assertEqual(sorted(paths), check_paths)
def testExpandRecursiveGlobs(self):
"""Tests the _ExpandRecursiveGlobs function."""
separator = '/'
# Test a path with a trailing /, which means first directory is skipped.
# The path will have 9 entries as the default depth for ** is 10, but the
# first entry is being skipped.
path = '/etc/sysconfig/**/'
paths = path_helper.PathHelper.ExpandRecursiveGlobs(path, separator)
# Nine paths returned
self.assertEqual(len(paths), 9)
# Nine paths in total, each one level deeper than the previous.
check_paths = sorted([
'/etc/sysconfig/*/*',
'/etc/sysconfig/*/*/*',
'/etc/sysconfig/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*/*',
'/etc/sysconfig/*/*/*/*/*/*/*/*/*/*'])
self.assertEqual(sorted(paths), check_paths)
# Now test with no trailing separator, but only a depth of 4.
# the path will have a total of 4 entries.
path = '/etc/sysconfig/**4'
paths = path_helper.PathHelper.ExpandRecursiveGlobs(path, separator)
# Four paths returned
self.assertEqual(len(paths), 4)
# Four paths in total, each one level deeper than the previous.
check_paths = sorted([
'/etc/sysconfig/*',
'/etc/sysconfig/*/*',
'/etc/sysconfig/*/*/*',
'/etc/sysconfig/*/*/*/*'])
self.assertEqual(sorted(paths), check_paths)
def testExpandUsersHomeDirectoryPath(self):
"""Tests the ExpandUsersHomeDirectoryPath function."""
user_account_artifact1 = artifacts.UserAccountArtifact(
user_directory='C:\\Users\\Test1', username='Test1')
user_account_artifact2 = artifacts.UserAccountArtifact(
user_directory='C:\\Users\\Test2', username='Test2')
path = '%%users.homedir%%\\Profile'
expanded_paths = path_helper.PathHelper.ExpandUsersHomeDirectoryPath(
path, '\\', [user_account_artifact1, user_account_artifact2])
expected_expanded_paths = [
'\\Users\\Test1\\Profile',
'\\Users\\Test2\\Profile']
self.assertEqual(expanded_paths, expected_expanded_paths)
path = 'C:\\Temp'
expanded_paths = path_helper.PathHelper.ExpandUsersHomeDirectoryPath(
path, '\\', [user_account_artifact1, user_account_artifact2])
expected_expanded_paths = ['\\Temp']
self.assertEqual(expanded_paths, expected_expanded_paths)
path = 'C:\\Temp\\%%users.homedir%%'
expanded_paths = path_helper.PathHelper.ExpandUsersHomeDirectoryPath(
path, '\\', [user_account_artifact1, user_account_artifact2])
expected_expanded_paths = ['\\Temp\\%%users.homedir%%']
self.assertEqual(expanded_paths, expected_expanded_paths)
def testExpandWindowsPath(self):
"""Tests the ExpandWindowsPath function."""
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='SystemRoot', value='C:\\Windows')
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'%SystemRoot%\\System32', [environment_variable])
self.assertEqual(expanded_path, 'C:\\Windows\\System32')
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'C:\\Windows\\System32', [environment_variable])
self.assertEqual(expanded_path, 'C:\\Windows\\System32')
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'%SystemRoot%\\System32', None)
self.assertEqual(expanded_path, '%SystemRoot%\\System32')
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'%Bogus%\\System32', [environment_variable])
self.assertEqual(expanded_path, '%Bogus%\\System32')
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'%%environ_systemroot%%\\System32', [environment_variable])
self.assertEqual(expanded_path, '\\Windows\\System32')
# Test non-string environment variable.
environment_variable = artifacts.EnvironmentVariableArtifact(
case_sensitive=False, name='SystemRoot', value=('bogus', 0))
expanded_path = path_helper.PathHelper.ExpandWindowsPath(
'%SystemRoot%\\System32', [environment_variable])
self.assertEqual(expanded_path, '%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(['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 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()
|
