-
Notifications
You must be signed in to change notification settings - Fork 223
/
Noriben.py
executable file
·1438 lines (1215 loc) · 56.5 KB
/
Noriben.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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Noriben Malware Analysis Sandbox
#
# Directions:
# Just copy Noriben.py to a Windows-based VM alongside the SysInternals Procmon.exe
#
# Run Noriben.py, then run your executable.
# When the executable has completed its processing, stop Noriben and view a
# clean text report and timeline
#
# Changelog:
# Version 2.0.0 - August 2023
# Major changes to NoribenSandbox host script
# Updated many of the functions, such as properly deleting files in guest
# Remove unneeded or obtuse options
# Move everything to all major settings to a configuration file
# Many formatting changes
#
# Version 1.8.8 - 20 Jan 23
# Replaced subprocess .wait() to .communicate() due to known process exec issue
# which causes deadlocks in a small amount of cases
# Added hardcoded timeout period for cases where it hangs
# Thanks to Roman Hussy of abuse.ch for identifying and suggesting fix
# Version 1.8.7 - 30 Aug 22
# Replaced csv.reader with csv.DictReader to have better forward and backward
# compatibility. Small changes in style, PEP8
# Version 1.8.6 - 26 May 21
# Fixed a long-standing bug that crashed the script when encountering certain
# binary data in a registry key
# Version 1.8.5 - 02 May 21
# Changed terminology from whitelist to approvelist. Updated filters. Added quick
# fix related to issue #29/#44 for errant ticks in data
# Version 1.8.4 - 22 Nov 19
# Minor updates. Added ability to run a non-executable, such as a Word document
# Version 1.8.3 - 26 Nov 18
# Fixed minor bugs in reading hash files and in sleeping between VirusTotal queries
# Version 1.8.2 - 28 Jun 18
# Fixed minor bug that would crash upon writing out CSV
# Version 1.8.1 - 14 Jun 18
# Added additional config options, such as output_folder. Added value
# global_whitelist_append to allow additional filters
# Version 1.8.0 - 9 Jun 18
# Really, truly, dropping Python 2 support now. Added --config file option to load
# global variables from external files. Now uses CSV library. Code cleanup
# Version 1.7.6 - 12 Apr 18 -
# Some auto PEP-8 formatting. Fixed bug where specific output dir wouldn't add
# to files when specifying a PML or CSV file. Added configuration of new txt
# extension in cases where ransomware was encrypting files. CSV, however, cannot
# be changed due to limitations in ProcMon
# Version 1.7.5 - 10 Mar 18 -
# Another bug fix related to global use of renamed procmon binary. Edge case fix
# Version 1.7.4 - 28 Feb 18 -
# More bug fixes related to global use of renamed procmon binary. Added filters
# Version 1.7.3b - 7 Jan 18 -
# Implemented --troubleshoot option to pause the program upon exit so that the
# error messages can be seen manually
# Version 1.7.3 - 26 Dec 17 -
# Fixed bug where a changed procmon binary was not added to the whitelist, and
# would therefore be included in the output
# Version 1.7.2 - 21 Apr 17 -
# Fixed Debug output to go to a log file continually, so output is stored if
# unexpected exit. Check for PML and Config file between executions to account
# for destructive malware that erases during runtime. Added headless option for
# automated runs, so that screenshot can be grabbed w/o output on screen
# Version 1.7.1 - 3 Apr 17 -
# Small updates. Change --filter to not find default if a bad one is specified
# Version 1.7.0 - 4 Feb 17 -
# Default hash method is now SHA256. An argument and global var allow to
# override hash. Numerous filters added. PEP8 cleanup, multiple small fixes to
# code and implementation styles
# Version 1.6.4 - 7 Dec 16 -
# A handful of bug fixes related to bad Internet access. Small variable updates.
# Version 1.6.3 - 13 Jan 16 -
# Bug fixes to handle path joining. Bug fixes for spaces in all directory
# names. Added support to find default PMC from script working directory.
# Version 1.6.2 - 9 Apr 15 -
# Created debug output to file. This now includes full VirusTotal dumps.
# Currently Noriben only displays number of hits, but additional meta is now
# dumped for further analysis by users.
# Version 1.6.1 - 16 Mar 15 -
# Soft fails on Requests import. Lack of module now just disables VirusTotal.
# Added better YARA handling. Instead of failing over a single error, it
# will skip the offending file. You can now hard-set the YARA signature
# folder in the script.
# Version 1.6 - 14 Mar 15 -
# Long delayed and now forked release. This will be the final release for
# Python 2.X except for updated rules. Now requires 3rd party libraries.
# VirusTotal API scanning implemented. Added better filters.
# Added controls for some registry writes that had size but no data.
# Added whitelist for MD5 hashes and --hash option for hash file.
# Renamed 'blacklist' to 'whitelist' because it's supposed to be. LOL
# Change file handling due to 'read entire file' bug in FileInput.
# Version 1.5b - 1 Oct 13 -
# Ninja edits to fix a few small bug fixes and change path generalization
# to an ordered list instead of an unordered dictionary. This lets you
# prioritize resolutions.
# Version 1.5 - 28 Sep 13 -
# Standardized to single quotes, added YARA scanning of resident files,
# reformatted function comments to match appropriate docstring format,
# fixed bug with generalize paths - now generalizes after getting MD5
# Version 1.4 - 16 Sep 13 -
# Fixed string generalization on file rename and now supports ()'s in
# environment name (for 64-bit systems), added ability to Ctrl-C from
# a timeout, added specifying malware file from command line, added an
# output directory
# Version 1.3 - 13 Sep 13 -
# Option to generalize file paths in output, option to use a timeout
# instead of Ctrl-C to end monitoring, only writes RegSetValue entries
# if Length > 0
# Version 1.2 - 28 May 13 -
# Now reads CSV files line-by-line to handle large files, keep
# unsuccessful registry deletes, compartmentalize sections, creates CSV
# timeline, can reparse PMLs, can specify alternative PMC filters,
# changed command line arguments, added global approvelist
# Version 1.1a - 1 May 13 -
# Revamped regular expression support. Added Python 3.x forward
# compatibility
# Version 1.1 - 21 Apr 13 -
# Much improved filters and filter parsing
# Version 1.0 - 10 Apr 13 - @bbaskin - brian [@] thebaskins.com
# Gracious edits, revisions, and corrections by Daniel Raygoza
#
import argparse
import codecs
import csv
import datetime
import hashlib
import json
import os
import re
import subprocess
import string
import sys
import time
import traceback
try:
import yara # pip yara-python
has_yara = True
except ImportError:
yara = None
has_yara = False
try:
import requests
import json
has_internet = True
except ImportError:
json = None
has_internet = False
try:
import configparser
except ImportError:
print('[!] Python module "configparser" not found. Python 3 required.')
configparser = None
# Below are global internal variables. Do not edit these. ################
__VERSION__ = '2.0.0'
use_pmc = False
use_virustotal = False
vt_results = {}
vt_dump = []
debug_messages = []
exe_cmdline = ''
time_exec = 0
time_process = 0
script_cwd = ''
debug_file = ''
config = {}
global_approvelist = ''
reg_approvelist = ''
file_approvelist = ''
cmd_approvelist = ''
net_approvelist = ''
hash_approvelist = ''
path_general_list = []
valid_hash_types = ['MD5', 'SHA1', 'SHA256']
##########################################################################
noriben_errors = {
0: 'Successful execution',
1: 'PML file was not found',
2: 'Unable to find procmon.exe',
3: 'Unable to create output directory',
4: 'Windows is refusing execution based upon permissions',
5: 'Could not create CSV',
6: 'Could not find malware file',
7: 'Error converting PML to CSV',
8: 'Error creating PML',
9: 'Unknown error',
10: 'Invalid arguments given',
11: 'Missing Python module',
12: 'Error in host module configuration',
13: 'Required file not found',
14: 'Configuration issue',
50: 'General error'
}
def get_error(code):
"""
Looks up a given code in dictionary set of errors of noriben_errors.
Arguments:
code: Integer that corresponds to a pre-set entry
Returns:
string value of a error code
"""
if code in noriben_errors:
return noriben_errors[code]
return 'Unexpected Error'
def read_config(config_filename):
"""
Parse an external configuration file.
Arguments:
config_filename: String of filename, predetermined if exists
Returns:
none
"""
global use_virustotal
global global_approvelist, reg_approvelist, file_approvelist, cmd_approvelist
global net_approvelist, hash_approvelist
config = {}
try:
file_config = configparser.ConfigParser(inline_comment_prefixes=('#', ';'))
with codecs.open(config_filename, 'r', encoding='utf-8') as f:
file_config.read_file(f)
config = {}
options = file_config.options('Noriben')
for option in options:
config[option] = file_config.get('Noriben', option)
if config[option].lower() in ['true', 'false']:
config[option] = file_config.getboolean('Noriben', option)
if config[option] == -1:
print('[*] Invalid configuration option detected: {}'.format(option))
global_approvelist = file_config.get('Filters', 'global_approvelist').replace('\n','').split(',')
reg_approvelist = file_config.get('Filters', 'reg_approvelist').replace('\n','').split(',')
file_approvelist = file_config.get('Filters', 'file_approvelist').replace('\n','').split(',')
cmd_approvelist = file_config.get('Filters', 'cmd_approvelist').replace('\n','').split(',')
net_approvelist = file_config.get('Filters', 'net_approvelist').replace('\n','').split(',')
hash_approvelist = file_config.get('Filters', 'hash_approvelist').replace('\n','').split(',')
# Throwing a large one in here to ignore anything that the configured procmon executable creates
global_approvelist.append(config['procmon'])
global_approvelist.append(config['procmon'].split('.')[0] + '64.exe') # Procmon drops embed as <name>+64
except configparser.MissingSectionHeaderError:
print('[!] Error found in reading config file. Invalid section header detected.')
sys.exit(12)
except Exception as e:
print(e)
time.sleep(5)
sys.exit(12)
return config
def human():
"""
Implemented basic human emulation code. This performs minor interaction
with the OS that could help bypass anti-analysis in some malware families
Arguments:
none
Returns:
none
"""
try:
import pyautogui
except ImportError:
return None
screenwidth, screenheight = pyautogui.size()
x_pos = screenwidth/2
y_pos = screenheight/2
log_debug('[*] Performing human mouse emulation. Starting coordinates: {}, {}'.format(x_pos, y_pos))
for i in range(5):
pyautogui.moveTo(x_pos, y_pos, duration = 0.1)
pyautogui.moveTo(x_pos+250, y_pos+250, duration = 0.1)
pyautogui.moveTo(x_pos-250, y_pos, duration = 0.1)
pyautogui.moveTo(x_pos-500, y_pos, duration = 0.1)
pyautogui.moveTo(x_pos-250, y_pos+500, duration = 0.1)
def terminate_self(error):
"""
Implemented for better troubleshooting.
Arguments:
error: Int of error code to return to system parent
Returns:
none
"""
if error != 0:
print(f'[*] Exiting with error code: {error}: {get_error(error)}')
if config['troubleshoot']:
errormsg = '[*] Configured to pause for troubleshooting. Press enter to close Noriben.'
input(errormsg)
sys.exit(error)
def log_debug(msg, override=False):
"""
Logs a passed message. Results are printed and stored in
a list for later writing to the debug log.
Arguments:
msg: Text string of message
override: optional value that forces the output even if debug is not set
Returns:
none
"""
global debug_messages
if msg and (config['debug'] or override):
if debug_file:
if debug_messages: # If buffer, write and erase buffer
with open(debug_file, 'a', encoding='utf-8') as debug_file_handle:
for item in debug_messages:
debug_file_handle.write(item)
debug_messages = []
else:
open(debug_file, 'a', encoding='utf-8').write(f'{msg}\n')
else:
debug_messages.append(msg + '\r\n')
def generalize_vars_init():
"""
Initialize a dictionary with the local system's environment variables.
Returns via a global variable, path_general_list
Arguments:
none
Returns:
none
"""
envvar_list = [r'%AllUsersProfile%',
r'%LocalAppData%',
r'%AppData%',
r'%CommonProgramFiles%',
r'%ProgramData%',
r'%ProgramFiles%',
r'%ProgramFiles(x86)%',
r'%Public%',
r'%Temp%',
r'%UserProfile%',
r'%WinDir%']
global path_general_list
log_debug('[*] Enabling Windows string generalization.')
for env in envvar_list:
try:
# ProgramFiles is handled specially in 64-bit environments
# It's real value is in ProgramW6432
if env == '%ProgramFiles%':
resolved = os.path.expandvars('%ProgramW6432%').replace("\\", "\\\\")
else:
resolved = os.path.expandvars(env).replace("\\", "\\\\")
path_general_list.append([env, resolved])
except TypeError:
if resolved in locals():
log_debug('[!] generalize_vars_init(): Unable to parse var: {}'.format(resolved))
continue
def generalize_var(path_string):
"""
Generalize a given string to include its environment variable
Arguments:
path_string: string value to generalize
Returns:
string value of a generalized string
"""
if path_general_list:
generalize_vars_init() # For edge cases when this isn't previously called.
for item in path_general_list:
path_string = re.sub(item[1], item[0], path_string)
return path_string
def read_hash_file(hash_filename):
"""
Read a given file of SHA256 hashes and add them to the hash approvelist.
Arguments:
hash_filename: path to a text file containing hashes (either flat or sha256deep)
"""
global hash_approvelist
hash_file_handle = open(hash_filename, newline='', encoding='utf-8')
reader = csv.DictReader(hash_file_handle)
for hash_line in reader:
hashval = hash_line[0]
try:
if int(hashval, 16) and (len(hashval) == 32 or len(hashval) == 40 or len(hashval) == 64):
hash_approvelist.append(hashval)
except (TypeError, ValueError):
pass
def virustotal_upload_file(path):
"""
Submit a given file to VirusTotal to retrieve number of alerts
Arguments:
path: string path to the file to be queried
"""
global vt_results
global vt_dump
if not has_internet:
return False
vt_url = 'https://www.virustotal.com/vtapi/v2/file/scan'
data = open(path, 'rb').read()
response = requests.post(vt_url, files={'file': (path, data)}, params={'apikey': config['virustotal_api_key']})
log_debug('[*] VirusTotal upload results for hash {}'.format(path))
if response.json()['response_code'] != 1:
log_debug('[!] Error uploading file to VirusTotal: {}'.format(response['verbose_msg']))
return False
return True
def virustotal_query_hash(hashval, path):
"""
Submit a given hash to VirusTotal to retrieve number of alerts
Arguments:
hashval: string of SHA256 hash to a given file
path: string path to the file to be queried
"""
global vt_results
global vt_dump
VT_NOT_EXIST = 0
VT_SUCCESS = 1
VT_IN_POST_QUEUE = -1
VT_IN_QUEUE = -2
VT_DELETED = -3
VT_UNSUPPORTED_FILE = -4
VT_UNAVAILABLE = -5
VT_REP_MALICIOUS = -6
VT_REP_HARMLESS = -7
VT_REP_SUSPICIOUS = -8
VT_REP_UNDECTEED = -9
VT_ERROR = -10
result = ''
if not has_internet:
return ''
try:
if not (int(hashval, 16) and (len(hashval) == 32 or len(hashval) == 40 or len(hashval) == 64)):
return ''
except (TypeError, ValueError):
pass
try:
previous_result = vt_results[hashval]
log_debug('[*] VT scan already performed for {}. Returning previous: {}'.format(hashval, previous_result))
return previous_result
except KeyError:
pass
vt_query_url = 'https://www.virustotal.com/vtapi/v2/file/report'
post_params = {'apikey': config['virustotal_api_key'],
'resource': hashval}
log_debug('[*] Querying VirusTotal for hash: {}'.format(hashval))
data = {}
try:
http_response = requests.post(vt_query_url, post_params)
except requests.exceptions.RequestException:
return '' # null string to append to output
if http_response.status_code == 204:
print('[!] VirusTotal Rate Limit Exceeded. Sleeping for 60 seconds.')
time.sleep(60)
return virustotal_query_hash(hashval, path)
elif http_response.status_code == 404:
log_debug('[*] File not available on VirusTotal. Submitting.')
upload_complete = virustotal_upload_file(path)
if not upload_complete:
return ''
return virustotal_query_hash(hashval, path)
elif http_response.status_code == 200:
try:
data = http_response.json()
except ValueError:
result = 'Error'
if data['response_code'] == VT_IN_QUEUE:
print('[*] {} queued by VT for analysis. Retrying in 30 seconds.'.format(hashval))
time.sleep(30)
return virustotal_query_hash(hashval, path)
elif data['response_code'] == VT_NOT_EXIST:
log_debug('[*] File not available on VirusTotal. Submitting.')
upload_complete = virustotal_upload_file(path)
time.sleep(10)
return virustotal_query_hash(hashval, path)
elif data['response_code'] == VT_SUCCESS:
if data['total']:
vt_dump.append(data)
result = ' [VT: {}/{}]'.format(data['positives'], data['total'])
else:
result = ' [VT: Unknown Error {}]'.format(data['response_code'])
vt_results[hashval] = result
log_debug('[*] VirusTotal result for hash {}: {}'.format(hashval, result))
return result
else:
# Unknown return status code
# TODO
return False
def yara_rule_check(yara_files):
"""
Scan a dictionary of YARA rule files to determine
which are valid for compilation.
Arguments:
yara_files: path to folder containing rules
"""
result = {}
for yara_id in yara_files:
fname = yara_files[yara_id]
try:
yara.compile(filepath=fname)
result[yara_id] = fname
except yara.SyntaxError:
log_debug('[!] Syntax Error found in YARA file: {}'.format(fname))
log_debug(traceback.format_exc())
return result
def yara_import_rules(yara_path):
"""
Import a folder of YARA rule files
Arguments:
yara_path: path to folder containing rules
Returns:
rules: a yara.Rules structure of available YARA rules
"""
yara_files = {}
if not yara_path[-1] == '\\':
yara_path += '\\'
print('[*] Loading YARA rules from folder: {}'.format(yara_path))
files = os.listdir(yara_path)
for file_name in files:
file_extension = os.path.splitext(file_name)[1]
if '.yar' in file_extension:
yara_files[file_name.split(os.sep)[-1]] = os.path.join(yara_path, file_name)
yara_files = yara_rule_check(yara_files)
rules = ''
if yara_files:
try:
rules = yara.compile(filepaths=yara_files)
print('[*] YARA rules loaded. Total files imported: {}'.format(len(yara_files)))
except yara.SyntaxError:
print('[!] YARA: Unknown Syntax Errors found.')
print('[!] YARA rules disabled until all Syntax Errors are fixed.')
log_debug('[!] YARA: Unknown Syntax Errors found.')
log_debug('[!] YARA rules disabled until all Syntax Errors are fixed.')
return rules
def yara_filescan(file_path, rules):
"""
Scan a given file to see if it matches a given set of YARA rules
Arguments:
file_path: full path to a file to scan
rules: a yara.Rules structure of available YARA rules
Returns:
results: a string value that's either null (no hits)
or formatted with hit results
"""
if not rules:
return ''
if os.path.isdir(file_path):
return ''
try:
matches = rules.match(file_path)
except yara.Error: # If can't open file
log_debug('[!] YARA can\'t open file: {}'.format(file_path))
return ''
if matches:
results = '\t[YARA: {}]'.format(', '.join(str(x) for x in matches))
else:
results = ''
return results
def open_file_with_assoc(fname):
"""
Opens the specified file with its associated application
Arguments:
fname: full path to a file to open
Returns:
integer value for command return code
"""
log_debug('[*] Opening with OS associated application: {}'.format(fname))
if os.name == 'mac':
return subprocess.call(('open', fname))
if os.name == 'nt':
# os.startfile(fname)
return subprocess.call(('start', fname), shell=True)
if os.name == 'posix':
return subprocess.call(('open', fname))
return None
def file_exists(fname):
"""
Determine if a file exists
Arguments:
fname: path to a file
Returns:
boolean value if file exists
"""
log_debug('[*] Checking for existence of file: {}'.format(fname))
return os.path.exists(fname) and os.access(fname, os.F_OK) and not os.path.isdir(fname)
def check_procmon():
"""
Finds the local path to Procmon
Returns:
folder path to procmon executable
"""
log_debug('[*] Checking for procmon in the following location: {}'.format(config['procmon']))
procmon_exe = config['procmon']
if file_exists(procmon_exe):
return procmon_exe
for path in os.environ['PATH'].split(os.pathsep):
if file_exists(os.path.join(path.strip('"'), procmon_exe)):
return os.path.join(path, procmon_exe)
if file_exists(os.path.join(script_cwd, procmon_exe)):
return os.path.join(script_cwd, procmon_exe)
return ''
def hash_file(fname):
"""
Given a filename, returns the hex hash value
Arguments:
fname: path to a file
Returns:
hex hash value of file's contents as a string
"""
log_debug('[*] Performing {} hash on file: {}'.format(config['hash_type'], fname))
if config['hash_type'] == 'MD5':
return hashlib.md5(codecs.open(fname, 'rb').read()).hexdigest()
if config['hash_type'] == 'SHA1':
return hashlib.sha1(codecs.open(fname, 'rb').read()).hexdigest()
if config['hash_type'] == 'SHA256':
return hashlib.sha256(codecs.open(fname, 'rb').read()).hexdigest()
return ''
def get_session_name():
"""
Returns current date and time stamp for file name
Returns:
string value of a current timestamp to apply to log file names
"""
return datetime.datetime.now().strftime('%d_%b_%y__%H_%M_%f')
def protocol_replace(text):
"""
Replaces text name resolutions from domain names
Arguments:
text: string of domain with resolved port name
Returns:
string value with resolved port name in decimal format
"""
replacements = [(':https', ':443'),
(':http', ':80'),
(':domain', ':53')]
for find, replace in replacements:
text = text.replace(find, replace)
return text
def approvelist_scan(approvelist, data):
"""
Given a approvelist and data string, see if data is in approvelist
Arguments:
approvelist: list of items to ignore
data: string value to compare against approvelist
Returns:
boolean value of if item exists in approvelist
"""
for event in data.values():
for bad in approvelist + global_approvelist:
bad = os.path.expandvars(bad).replace('\\', '\\\\')
try:
search_result = re.search(bad, event, flags=re.IGNORECASE)
if search_result:
return True
except re.error:
log_debug('[!] Error found while processing filters.\r\nFilter:\t{}\r\nEvent:\t{}'.format(bad, event))
log_debug(traceback.format_exc())
return False
return False
def process_pml_to_csv(procmonexe, pml_file, pmc_file, csv_file):
"""
Uses Procmon to convert the PML to a CSV file
Arguments:
procmonexe: path to Procmon executable
pml_file: path to Procmon PML output file
pmc_file: path to PMC filter file
csv_file: path to output CSV file
Returns:
None
"""
global time_process
time_convert_start = time.time()
log_debug('[*] Converting session to CSV: {}'.format(csv_file))
if not file_exists(pml_file):
print('[!] Error detected. PML file was not found: {}'.format(pml_file))
terminate_self(1)
cmdline = '"{}" /OpenLog "{}" /SaveApplyFilter /saveas "{}"'.format(procmonexe, pml_file, csv_file)
if use_pmc and file_exists(pmc_file):
cmdline += ' /LoadConfig "{}"'.format(pmc_file)
log_debug('[*] Running cmdline: {}'.format(cmdline))
process = subprocess.Popen(cmdline, stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
time_convert_end = time.time()
time_process = time_convert_end - time_convert_start
def launch_procmon_capture(procmonexe, pml_file, pmc_file):
"""
Launch Procmon to begin capturing data
Arguments:
procmonexe: path to Procmon executable
pml_file: path to Procmon PML output file
pmc_file: path to PMC filter file
Returns:
None
"""
global time_exec
time_exec = time.time()
cmdline = '"{}" /BackingFile "{}" /Quiet /Minimized'.format(procmonexe, pml_file)
if use_pmc and file_exists(pmc_file):
cmdline += ' /LoadConfig "{}"'.format(pmc_file)
log_debug('[*] Running cmdline: {}'.format(cmdline))
subprocess.Popen(cmdline)
time.sleep(3)
def terminate_procmon(procmonexe):
"""
Terminate Procmon cleanly
Arguments:
procmonexe: path to Procmon executable
Returns:
None
"""
global time_exec
time_exec = time.time() - time_exec
cmdline = '"{}" /Terminate'.format(procmonexe)
log_debug('[*] Running cmdline: {}'.format(cmdline))
process = subprocess.Popen(cmdline, stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
try:
process.wait(timeout=600)
except subprocess.TimeoutExpired:
process.kill()
stdout, stderr = process.communicate()
def parse_csv(csv_file, report, timeline):
"""
Given the location of CSV and TXT files, parse the CSV for notable items
Arguments:
csv_file: path to csv output to parse
report: OUT string text containing the entirety of the text report
timeline: OUT string text containing the entirety of the CSV report
"""
log_debug('[*] Processing CSV: {}'.format(csv_file))
process_output = []
file_output = []
reg_output = []
net_output = []
error_output = []
remote_servers = []
if config['yara_folder'] and has_yara:
yara_rules = yara_import_rules(config['yara_folder'])
else:
yara_rules = ''
time_parse_csv_start = time.time()
csv_file_handle = open(csv_file, newline='', encoding='utf-8-sig')
reader = csv.DictReader(csv_file_handle)
for original_line in reader:
server = ''
field = original_line
# log_debug('[*] Parse line. Event: {}'.format(field['Operation'])
date_stamp = field['Time of Day'].split()[0].split('.')[0]
try:
if field['Operation'] == 'Process Create' and field['Result'] == 'SUCCESS':
if not approvelist_scan(cmd_approvelist, field):
cmdline = field['Detail'].split('Command line: ')[1]
log_debug('[*] CreateProcess: {}'.format(cmdline))
if config['generalize_paths']:
cmdline = generalize_var(cmdline)
child_pid = field['Detail'].split('PID: ')[1].split(',')[0]
outputtext = '[CreateProcess] {}:{} > "{}"\t[Child PID: {}]'.format(
field['Process Name'], field['PID'], cmdline.replace('"', ''), child_pid)
tl_text = '{},Process,CreateProcess,{},{},{},{}'.format(date_stamp, field['Process Name'], field['PID'], cmdline.replace('"', ''), child_pid)
process_output.append(outputtext)
timeline.append(tl_text)
elif field['Operation'] == 'CreateFile' and field['Result'] == 'SUCCESS':
if not approvelist_scan(file_approvelist, field):
path = field['Path']
log_debug('[*] CreateFile: {}'.format(path))
yara_hits = ''
if config['yara_folder'] and yara_rules:
yara_hits = yara_filescan(path, yara_rules)
if os.path.isdir(path):
if config['generalize_paths']:
path = generalize_var(path)
outputtext = '[CreateFolder] {}:{} > {}'.format(field['Process Name'], field['PID'], path)
tl_text = '{},File,CreateFolder,{},{},{}'.format(date_stamp, field['Process Name'],
field['PID'], path)
file_output.append(outputtext)
timeline.append(tl_text)
else:
try:
hashval = hash_file(path)
if hashval in hash_approvelist:
log_debug('[_] Skipping hash: {}'.format(hashval))
continue
av_hits = ''
if use_virustotal and has_internet:
av_hits = virustotal_query_hash(hashval, path)
if config['generalize_paths']:
path = generalize_var(path)
outputtext = '[CreateFile] {}:{} > {}\t[{}: {}]{}{}'.format(field['Process Name'], field['PID'], path,
config['hash_type'], hashval,
yara_hits, av_hits)
tl_text = '{},File,CreateFile,{},{},{},{},{},{},{}'.format(date_stamp,
field['Process Name'], field['PID'], path,
config['hash_type'], hashval,
yara_hits, av_hits)
file_output.append(outputtext)
timeline.append(tl_text)
except (IndexError, IOError):
if config['generalize_paths']:
path = generalize_var(path)
outputtext = '[CreateFile] {}:{} > {}\t[File no longer exists]'.format(field['Process Name'], field['PID'],
path)
tl_text = '{},File,CreateFile,{},{},{},N/A'.format(date_stamp,
field['Process Name'], field['PID'], path)
file_output.append(outputtext)
timeline.append(tl_text)
elif field['Operation'] == 'SetDispositionInformationFile' and field['Result'] == 'SUCCESS':
if not approvelist_scan(file_approvelist, field):
path = field['Path']
log_debug('[*] DeleteFile: {}'.format(path))
if config['generalize_paths']:
path = generalize_var(path)
outputtext = '[DeleteFile] {}:{} > {}'.format(field['Process Name'], field['PID'], path)
tl_text = '{},File,DeleteFile,{},{},{}'.format(date_stamp, field['Process Name'],
field['PID'], path)
file_output.append(outputtext)
timeline.append(tl_text)
elif field['Operation'] == 'SetRenameInformationFile':
if not approvelist_scan(file_approvelist, field):
from_file = field['Path']
to_file = field['Detail'].split('FileName: ')[1].strip('"')
if config['generalize_paths']:
from_file = generalize_var(from_file)
to_file = generalize_var(to_file)
outputtext = '[RenameFile] {}:{} > {} => {}'.format(field['Process Name'], field['PID'], from_file, to_file)
tl_text = '{},File,RenameFile,{},{},{},{}'.format(date_stamp, field['Process Name'],
field['PID'], from_file, to_file)
file_output.append(outputtext)
timeline.append(tl_text)
elif field['Operation'] == 'RegCreateKey' and field['Result'] == 'SUCCESS':
if not approvelist_scan(reg_approvelist, field):
path = field['Path']
log_debug('[*] RegCreateKey: {}'.format(path))
outputtext = '[RegCreateKey] {}:{} > {}'.format(field['Process Name'], field['PID'], field['Path'])
if outputtext not in reg_output: # Ignore multiple CreateKeys. Only log the first.
tl_text = '{},Registry,RegCreateKey,{},{},{}'.format(date_stamp,
field['Process Name'], field['PID'], field['Path'])
reg_output.append(outputtext)
timeline.append(tl_text)
elif field['Operation'] == 'RegSetValue' and field['Result'] == 'SUCCESS':
if not approvelist_scan(reg_approvelist, field):
reg_length = field['Detail'].split('Length:')[1].split(',')[0].strip(string.whitespace + '"')
reg_length = reg_length.replace('’', '') # Addresses errant ticks found in some data samples
try:
if int(float(reg_length)):
if 'Data:' in field['Detail']:
data_field = ' = {}'.format(field['Detail'].split('Data:')[1].strip(string.whitespace + '"'))
if len(data_field.split(' ')) == 16:
data_field += ' ...'
elif 'Length:' in field['Detail']:
data_field = ''
else:
continue
outputtext = '[RegSetValue] {}:{} > {}{}'.format(field['Process Name'], field['PID'], field['Path'], data_field)
tl_text = '{},Registry,RegSetValue,{},{},{},{}'.format(date_stamp,
field['Process Name'], field['PID'], field['Path'],
data_field)
reg_output.append(outputtext)
timeline.append(tl_text)
except (IndexError, ValueError):
error_output.append(''.join(original_line))
elif field['Operation'] == 'RegDeleteValue': # and field['Result'] == 'SUCCESS':
# SUCCESS is commented out to allow all attempted deletions, whether or not the value exists
if not approvelist_scan(reg_approvelist, field):
outputtext = '[RegDeleteValue] {}:{} > {}'.format(field['Process Name'], field['PID'], field['Path'])
tl_text = '{},Registry,RegDeleteValue,{},{},{}'.format(date_stamp, field['Process Name'],
field['PID'], field['Path'])
reg_output.append(outputtext)
timeline.append(tl_text)
elif field['Operation'] == 'RegDeleteKey': # and field['Result'] == 'SUCCESS':
# SUCCESS is commented out to allow all attempted deletions, whether or not the value exists
if not approvelist_scan(reg_approvelist, field):
outputtext = '[RegDeleteKey] {}:{} > {}'.format(field['Process Name'], field['PID'], field['Path'])