-
Notifications
You must be signed in to change notification settings - Fork 70
/
filehunt.py
446 lines (338 loc) · 17.3 KB
/
filehunt.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
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
435
436
437
438
439
440
441
442
443
444
445
446
#! /usr/bin/env python
# -*- coding: UTF-8 -*-
#
# Copyright (c) 2014, Dionach Ltd. All rights reserved. See LICENSE file.
#
# filehunt: general file searching library for use by PANhunt and PassHunt
# By BB
import os, sys, zipfile, re, datetime, cStringIO, argparse, time, hashlib, unicodedata, codecs
import colorama
import progressbar
import pst # MS-PST files
import msmsg # MS-MSG files
TEXT_FILE_SIZE_LIMIT = 1073741824 # 1Gb
###################################################################################################################################
# ____ _
# / ___| | __ _ ___ ___ ___ ___
# | | | |/ _` / __/ __|/ _ \/ __|
# | |___| | (_| \__ \__ \ __/\__ \
# \____|_|\__,_|___/___/\___||___/
#
###################################################################################################################################
class AFile:
""" AFile: class for a file that can search itself"""
def __init__(self, filename, file_dir):
self.filename = filename
self.dir = file_dir
self.path = os.path.join(self.dir, self.filename)
self.root, self.ext = os.path.splitext(self.filename)
self.errors = []
self.type = None
self.matches = []
def __cmp__(self, other):
return cmp(self.path.lower(), other.path.lower())
def set_file_stats(self):
try:
stat = os.stat(self.path)
self.size = stat.st_size
self.accessed = self.dtm_from_ts(stat.st_atime)
self.modified = self.dtm_from_ts(stat.st_mtime)
self.created = self.dtm_from_ts(stat.st_ctime)
except: # WindowsError:
self.size = -1
self.set_error(sys.exc_info()[1])
def dtm_from_ts(self, ts):
try:
return datetime.datetime.fromtimestamp(ts)
except ValueError:
if ts == -753549904:
return datetime.datetime(1946, 2, 14, 8, 34, 56) # Mac OSX "while copying" thing
else:
self.set_error(sys.exc_info()[1])
def size_friendly(self):
return get_friendly_size(self.size)
def set_error(self, error_msg):
self.errors.append(error_msg)
print colorama.Fore.RED + unicode2ascii(u'ERROR %s on %s' % (error_msg, self.path)) + colorama.Fore.WHITE
def check_regexs(self, regexs, search_extensions):
"""Checks the file for matching regular expressions: if a ZIP then each file in the ZIP (recursively) or the text in a document"""
if self.type == 'ZIP':
try:
if zipfile.is_zipfile(self.path):
zf = zipfile.ZipFile(self.path)
self.check_zip_regexs(zf, regexs, search_extensions, '')
else:
self.set_error('Invalid ZIP file')
except IOError:
self.set_error(sys.exc_info()[1])
except:
self.set_error(sys.exc_info()[1])
elif self.type == 'TEXT':
try:
file_text = read_file(self.path, 'rb')
self.check_text_regexs(file_text, regexs, '')
#except WindowsError:
# self.set_error(sys.exc_info()[1])
except IOError:
self.set_error(sys.exc_info()[1])
except:
self.set_error(sys.exc_info()[1])
elif self.type == 'SPECIAL':
if get_ext(self.path) == '.msg':
try:
msg = msmsg.MSMSG(self.path)
if msg.validMSG:
self.check_msg_regexs(msg, regexs, search_extensions, '')
else:
self.set_error('Invalid MSG file')
msg.close()
except IOError:
self.set_error(sys.exc_info()[1])
except:
self.set_error(sys.exc_info()[1])
return self.matches
def check_pst_regexs(self, regexs, search_extensions, hunt_type, gauge_update_function=None):
""" Searches a pst file for regular expressions in messages and attachments using regular expressions"""
all_extensions = search_extensions['TEXT'] + search_extensions['ZIP'] + search_extensions['SPECIAL']
if not gauge_update_function:
pbar_widgets = ['%s Hunt %s: ' % (hunt_type, unicode2ascii(self.filename)), progressbar.Percentage(), ' ', progressbar.Bar(marker = progressbar.RotatingMarker()), ' ', progressbar.ETA(), progressbar.FormatLabel(' %ss:0' % hunt_type)]
pbar = progressbar.ProgressBar(widgets = pbar_widgets).start()
else:
gauge_update_function(caption = '%s Hunt: ' % hunt_type)
try:
apst = pst.PST(self.path)
if apst.header.validPST:
total_messages = apst.get_total_message_count()
total_attachments = apst.get_total_attachment_count()
total_items = total_messages + total_attachments
items_completed = 0
for folder in apst.folder_generator():
for message in apst.message_generator(folder):
if message.Subject:
message_path = os.path.join(folder.path, message.Subject)
else:
message_path = os.path.join(folder.path, u'[NoSubject]')
if message.Body:
self.check_text_regexs(message.Body, regexs, message_path)
if message.HasAttachments:
for subattachment in message.subattachments:
if get_ext(subattachment.Filename) in search_extensions['TEXT']+search_extensions['ZIP']:
attachment = message.get_attachment(subattachment)
self.check_attachment_regexs(attachment, regexs, search_extensions, message_path)
items_completed += 1
items_completed += 1
if not gauge_update_function:
pbar_widgets[6] = progressbar.FormatLabel(' %ss:%s' % (hunt_type, len(self.matches)))
pbar.update(items_completed * 100.0 / total_items)
else:
gauge_update_function(value = items_completed * 100.0 / total_items)
apst.close()
except IOError:
self.set_error(sys.exc_info()[1])
except pst.PSTException:
self.set_error(sys.exc_info()[1])
if not gauge_update_function:
pbar.finish()
return self.matches
def check_attachment_regexs(self, attachment, regexs, search_extensions, sub_path):
"""for PST and MSG attachments, check attachment for valid extension and then regexs"""
attachment_ext = get_ext(attachment.Filename)
if attachment_ext in search_extensions['TEXT']:
if attachment.data:
self.check_text_regexs(attachment.data, regexs, os.path.join(sub_path, attachment.Filename))
if attachment_ext in search_extensions['ZIP']:
if attachment.data:
try:
memory_zip = cStringIO.StringIO()
memory_zip.write(attachment.data)
zf = zipfile.ZipFile(memory_zip)
self.check_zip_regexs(zf, regexs, search_extensions, os.path.join(sub_path, attachment.Filename))
memory_zip.close()
except: #RuntimeError: # e.g. zip needs password
self.set_error(sys.exc_info()[1])
def check_msg_regexs(self, msg, regexs, search_extensions, sub_path):
if msg.Body:
self.check_text_regexs(msg.Body, regexs, sub_path)
if msg.attachments:
for attachment in msg.attachments:
self.check_attachment_regexs(attachment, regexs, search_extensions, sub_path)
def check_zip_regexs(self, zf, regexs, search_extensions, sub_path):
"""Checks a zip file for valid documents that are then checked for regexs"""
all_extensions = search_extensions['TEXT'] + search_extensions['ZIP'] + search_extensions['SPECIAL']
files_in_zip = [file_in_zip for file_in_zip in zf.namelist() if get_ext(file_in_zip) in all_extensions]
for file_in_zip in files_in_zip:
if get_ext(file_in_zip) in search_extensions['ZIP']: # nested zip file
try:
memory_zip = cStringIO.StringIO()
memory_zip.write(zf.open(file_in_zip).read())
nested_zf = zipfile.ZipFile(memory_zip)
self.check_zip_regexs(nested_zf, regexs, search_extensions, os.path.join(sub_path, decode_zip_filename(file_in_zip)))
memory_zip.close()
except: #RuntimeError: # e.g. zip needs password
self.set_error(sys.exc_info()[1])
elif get_ext(file_in_zip) in search_extensions['TEXT']: #normal doc
try:
file_text = zf.open(file_in_zip).read()
self.check_text_regexs(file_text, regexs, os.path.join(sub_path, decode_zip_filename(file_in_zip)))
except: # RuntimeError: # e.g. zip needs password
self.set_error(sys.exc_info()[1])
else: # SPECIAL
try:
if get_ext(file_in_zip) == '.msg':
memory_msg = cStringIO.StringIO()
memory_msg.write(zf.open(file_in_zip).read())
msg = msmsg.MSMSG(memory_msg)
if msg.validMSG:
self.check_msg_regexs(msg, regexs, search_extensions, os.path.join(sub_path, decode_zip_filename(file_in_zip)))
memory_msg.close()
except: #RuntimeError
self.set_error(sys.exc_info()[1])
###################################################################################################################################
# __ __ _ _ _____ _ _
# | \/ | ___ __| |_ _| | ___ | ___| _ _ __ ___| |_(_) ___ _ __ ___
# | |\/| |/ _ \ / _` | | | | |/ _ \ | |_ | | | | '_ \ / __| __| |/ _ \| '_ \/ __|
# | | | | (_) | (_| | |_| | | __/ | _|| |_| | | | | (__| |_| | (_) | | | \__ \
# |_| |_|\___/ \__,_|\__,_|_|\___| |_| \__,_|_| |_|\___|\__|_|\___/|_| |_|___/
#
###################################################################################################################################
def find_all_files_in_directory(AFileClass, root_dir, excluded_directories, search_extensions, gauge_update_function=None):
"""Recursively searches a directory for files. search_extensions is a dictionary of extension lists"""
global TEXT_FILE_SIZE_LIMIT
all_extensions = [ext for ext_list in search_extensions.values() for ext in ext_list]
extension_types = {}
for ext_type, ext_list in search_extensions.iteritems():
for ext in ext_list:
extension_types[ext] = ext_type
if not gauge_update_function:
pbar_widgets = ['Doc Hunt: ', progressbar.Percentage(), ' ', progressbar.Bar(marker = progressbar.RotatingMarker()), ' ', progressbar.ETA(), progressbar.FormatLabel(' Docs:0')]
pbar = progressbar.ProgressBar(widgets = pbar_widgets).start()
else:
gauge_update_function(caption = 'Doc Hunt: ')
doc_files = []
root_dir_dirs = None
root_items_completed = 0
docs_found = 0
for root, sub_dirs, files in os.walk(root_dir):
sub_dirs[:] = [check_dir for check_dir in sub_dirs if os.path.join(root, check_dir).lower() not in excluded_directories]
if not root_dir_dirs:
root_dir_dirs = [os.path.join(root, sub_dir) for sub_dir in sub_dirs]
root_total_items = len(root_dir_dirs) + len(files)
if root in root_dir_dirs:
root_items_completed += 1
if not gauge_update_function:
pbar_widgets[6] = progressbar.FormatLabel(' Docs:%s' % docs_found)
pbar.update(root_items_completed * 100.0 / root_total_items)
else:
gauge_update_function(value = root_items_completed * 100.0 / root_total_items)
for filename in files:
if root == root_dir:
root_items_completed += 1
afile = AFileClass(filename, root) # AFile or PANFile
if afile.ext.lower() in all_extensions:
afile.set_file_stats()
afile.type = extension_types[afile.ext.lower()]
if afile.type in ('TEXT','SPECIAL') and afile.size > TEXT_FILE_SIZE_LIMIT:
afile.type = 'OTHER'
afile.set_error('File size {1} over limit of {0} for checking'.format(get_friendly_size(TEXT_FILE_SIZE_LIMIT), afile.size_friendly()))
doc_files.append(afile)
if not afile.errors:
docs_found += 1
if not gauge_update_function:
pbar_widgets[6] = progressbar.FormatLabel(' Docs:%s' % docs_found)
pbar.update(root_items_completed * 100.0 / root_total_items)
else:
gauge_update_function(value = root_items_completed * 100.0 / root_total_items)
if not gauge_update_function:
pbar.finish()
return doc_files
def find_all_regexs_in_files(text_or_zip_files, regexs, search_extensions, hunt_type, gauge_update_function=None):
""" Searches files in doc_files list for regular expressions"""
if not gauge_update_function:
pbar_widgets = ['%s Hunt: ' % hunt_type, progressbar.Percentage(), ' ', progressbar.Bar(marker = progressbar.RotatingMarker()), ' ', progressbar.ETA(), progressbar.FormatLabel(' %ss:0' % hunt_type)]
pbar = progressbar.ProgressBar(widgets = pbar_widgets).start()
else:
gauge_update_function(caption = '%s Hunt: ' % hunt_type)
total_files = len(text_or_zip_files)
files_completed = 0
matches_found = 0
for afile in text_or_zip_files:
matches = afile.check_regexs(regexs, search_extensions)
matches_found += len(matches)
files_completed += 1
if not gauge_update_function:
pbar_widgets[6] = progressbar.FormatLabel(' %ss:%s' % (hunt_type, matches_found))
pbar.update(files_completed * 100.0 / total_files)
else:
gauge_update_function(value = files_completed * 100.0 / total_files)
if not gauge_update_function:
pbar.finish()
return total_files, matches_found
def find_all_regexs_in_psts(pst_files, regexs, search_extensions, hunt_type, gauge_update_function=None):
""" Searches psts in pst_files list for regular expressions in messages and attachments"""
total_psts = len(pst_files)
psts_completed = 0
matches_found = 0
for afile in pst_files:
matches = afile.check_pst_regexs(regexs, search_extensions, hunt_type, gauge_update_function)
matches_found += len(matches)
psts_completed += 1
return total_psts, matches_found
###################################################################################################################################
# _ _ _ _ _ _ _ _____ _ _
# | | | | |_(_) (_) |_ _ _ | ___| _ _ __ ___| |_(_) ___ _ __ ___
# | | | | __| | | | __| | | | | |_ | | | | '_ \ / __| __| |/ _ \| '_ \/ __|
# | |_| | |_| | | | |_| |_| | | _|| |_| | | | | (__| |_| | (_) | | | \__ \
# \___/ \__|_|_|_|\__|\__, | |_| \__,_|_| |_|\___|\__|_|\___/|_| |_|___/
# |___/
###################################################################################################################################
def save_object(fn, obj):
pkl_file = open(fn, 'wb')
pickle.dump(obj, pkl_file, -1)
pkl_file.close()
def load_object(fn):
pkl_file = open(fn, 'rb')
obj = pickle.load(pkl_file)
pkl_file.close()
return obj
def read_file(fn, open_mode="r"):
f = open(fn, open_mode)
s = f.read()
f.close()
return s
def write_file(fn,s):
f = open(fn,"w")
f.write(s)
f.close()
def read_unicode_file(fn):
f = codecs.open(fn, encoding='utf-8', mode='r')
s = f.read()
f.close()
return s
def write_unicode_file(fn,s):
f = codecs.open(fn, encoding='utf-8', mode='w')
f.write(s)
f.close()
def write_csv(fn,dlines):
f = open(fn,"w")
for d in dlines:
s = ','.join(['"%s"' % str(i).replace('"',"'") for i in d])
f.write('%s\n' % s)
f.close()
def unicode2ascii(unicode_str):
return unicodedata.normalize('NFKD', unicode_str).encode('ascii','ignore')
def decode_zip_filename(str):
if type(str) is unicode:
return str
else:
return str.decode('cp437')
def get_ext(file_name):
return os.path.splitext(file_name)[1].lower()
def get_friendly_size(size):
if size < 1024:
return '{0}B'.format(size)
elif size < 1024*1024:
return '{0}KB'.format(size/1024)
elif size < 1024*1024*1024:
return '{0}MB'.format(size/(1024*1024))
else:
return '{0:.1f}GB'.format(size*1.0/(1024.0*1024*1024))