/
mudpd.py
4037 lines (3356 loc) · 180 KB
/
mudpd.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
#!/usr/bin/python3
# Local Modules
from src.bidict import BiDict
from src.capture_database import CaptureDatabase, CaptureDigest
from src.lookup import lookup_mac
from src.generate_report import ReportGenerator
from src.multicolumn_listbox import MultiColumnListbox
from src.scrollable_frame import ScrollableFrame
import src.pcapng_comment as capMeta
# Muddy Modules
try:
from muddy.muddy.mud import MUD
from muddy.muddy.models import Direction, IPVersion, Protocol, MatchType
except ImportError:
try:
from .muddy.muddy.mud import MUD
from .muddy.muddy.models import Direction, IPVersion, Protocol, MatchType
except ImportError:
print("Cannot import muddy. Please be sure it has been installed within the MUD-PD directory")
exit(1)
# External Modules
import asyncio
from configparser import ConfigParser
from datetime import datetime, timedelta
import getversion
import hashlib
import IPy
from IPy import IP
import json
import logging
import logging.config
import multiprocessing as mp
import mysql.connector
from mysql.connector import errorcode
import os
from PIL import ImageTk, Image
import pyshark
import socket
import subprocess
import sys
import threading
import time
import tkinter as tk
from tkinter import font, messagebox, scrolledtext, ttk
from tkinter.filedialog import askopenfilename
field2db = BiDict({'File': 'fileName', 'Activity': 'activity', 'Notes (optional)': 'details',
'Lifecycle Phase': 'lifecyclePhase', 'Setup': 'setup', 'Normal Operation': 'normalOperation',
'Removal': 'removal',
'Internet': 'internet', 'Human Interaction': 'humanInteraction',
'Preferred DNS Enabled': 'preferredDNS', 'Isolated': 'isolated',
'Controller/Hub': 'controllerHub', 'Same Manufacturer': 'mfrSame',
'Full Network': 'fullNetwork', 'Notable Physical Changes': 'physicalChanges',
'Duration-based': 'durationBased', 'Duration': 'duration', 'Action-based': 'actionBased',
'Action': 'deviceAction',
'Date of Capture': 'capDate', 'Time of Capture': 'capTime',
'Manufacturer': 'mfr', 'MAC': 'mac_addr', 'Model': 'model', 'Internal Name': 'internalName',
'Category': 'deviceCategory', 'Notes': 'notes',
'MUD': 'mudCapable', 'WiFi': 'wifi', 'Ethernet': 'ethernet', 'Bluetooth': 'bluetooth',
'ZigBee': 'zigbee',
'ZWave': 'zwave', '3G': 'G3', '4G': 'G4', '5G': 'G5', 'Other': 'otherProtocols',
'Firmware Version': 'fw_ver', 'IP Address': 'ipv4_addr', 'IPv6 Address': 'ipv6_addr'})
dbFields = 'host', 'database', 'user', 'passwd'
dbNewFields = 'host', 'user', 'passwd', 'new database'
APIFields = 'api_key', "Don't show again"
captureFields = 'File', 'Notes (optional)'
lifecyclePhaseFields = 'Setup', 'Normal Operation', 'Removal'
captureEnvFields = 'Internet', 'Preferred DNS Enabled', \
'Isolated', 'Notable Physical Changes', \
'Full Network', 'Controller/Hub', \
'Same Manufacturer', 'Human Interaction'
captureTypeFields = 'Duration-based', 'Duration', 'Action-based', 'Action'
captureInfoFields = 'Date of Capture', 'Time of Capture'
deviceFields = 'Manufacturer', 'Model', 'MAC', 'Internal Name', 'Category', 'Notes', 'Capabilities'
deviceOptions = 'MUD', 'WiFi', 'Ethernet', 'Bluetooth', 'ZigBee', 'ZWave', '3G', '4G', '5G', 'Other'
# GUI Class for the MUD Capture Analysis
class MudCaptureApplication(tk.Frame):
def __init__(self, parent, *args, **kwargs):
self.logger = logging.getLogger('mudpd') # __name__) # 'mudpd')
tk.Frame.__init__(self, parent, *args, **kwargs)
self.parent = parent
self.parent.title("MUD-PD")
self.window_stack = []
self.yield_focus(self.parent)
# Multiprocessing
self.p_file = None
self.m = mp.Manager()
self.q = self.m.Queue()
self.filename_prev = ""
self.threads = {"capture_processing": list(),
"packet_processing": list()}
# ** Initialize class variables ** #
# TODO: Handle these variables better
# Future windows (i.e. set self.w_XXXX objects to None
self.w_about = None
self.w_cap = None
self.w_cap_dev = None
self.w_db = None
self.w_db_new = None
self.w_dev = None
self.w_dev_state = None
self.w_gen_mud = None
self.w_gen_report = None
self.w_progress = None
self.w_progress_pb = None
# Buttons for future windows
self.b_cap_dev_close = None
self.b_cap_dev_label = None
self.b_cap_dev_modify = None
self.b_import = None
self.b_cancel = None
self.b_mud_generate = None
self.b_mud_cancel = None
self.b_report_generate = None
self.b_report_close = None
# General Variables
# TODO: Turn all XXXX_entries into dictionary types rather than lists
self.db_handler = None
self.db_cnx_entries = None
self.api_key_entries = None
self.capture_entries = None
self.cap_envi_metadata = None
self.device_entries = None
self.device_state_entries = None
self.capture_devices_entries = None
self.dev_in_cap_data = None
self.dev_mac = None
self.labeled_title = None
self.labeled_title_var = None
self.labeled_dev_header = None
self.labeled_dev_list = None
self.labeled_dev_list_sel = None
self.labeledDevFrame = None
self.unlabeled_title = None
self.unlabeled_title_var = None
self.unlabeled_dev_header = None
self.unlabeled_dev_list = None
self.unlabeled_dev_list_sel = None
self.unlabeledDevFrame = None
self.cap_dev_title = None
self.topDevFrame = None
self.botDevFrame = None
self.device_id = None
self.gatewayID = None
self.gateway_mac = None
self.topMudDevFrame = None
self.midMudGateFrame = None
self.botMudPCAPFrame = None
self.mud_gateway = None
self.mud_device = None
self.mud_dev_title_var = None
self.mud_dev_title = None
self.mud_dev_header = None
self.mud_dev_list = None
self.mud_gate_title_var = None
self.mud_gate_title = None
self.mud_gate_header = None
self.mud_gate_list = None
self.mud_pcap_title_var = None
self.mud_pcap_title = None
self.mud_pcap_header = None
self.mud_pcap_list = None
self.mud_pcap_sel = None
self.mud_gen_obj = None
self.topReportDevFrame = None
self.botReportPCAPFrame = None
self.report_device = None
self.report_dev_title_var = None
self.report_dev_title = None
self.report_dev_header = None
self.report_dev_list = None
self.report_pcap_title_var = None
self.report_pcap_title = None
self.report_pcap_header = None
self.report_pcap_list = None
self.report_gen_obj = None
self.report_pcap_where = None
# Main menu bar
self.fileMenu = tk.Menu(self.parent)
self.parent.config(menu=self.fileMenu)
self.fileSubMenu = tk.Menu(self.fileMenu)
self.fileMenu.add_cascade(label="File", menu=self.fileSubMenu)
self.fileSubMenu.add_command(label="Connect to Database...", command=self.popup_connect2database)
self.fileSubMenu.add_command(label="Create New Database...", command=self.popup_create_new_database)
self.fileSubMenu.add_command(label="Import Capture File...", command=self.popup_import_capture)
self.fileSubMenu.add_command(label="Add Fingerbank API Key", command=self.popup_update_api_key)
self.fileSubMenu.add_command(label="Update Labeled Device Info", command=self.popup_update_labeled_device_info)
self.fileSubMenu.add_separator()
self.fileSubMenu.add_command(label="Quit", command=self.__exit__)
self.helpSubMenu = tk.Menu(self.fileMenu)
self.fileMenu.add_cascade(label="Help", menu=self.helpSubMenu)
self.helpSubMenu.add_command(label="About", command=self.popup_about)
# *** Main Window *** #
# Menu top
self.menuFrame = tk.Frame(self.parent, bd=1, bg="#dfdfdf") # , bg="#dfdfdf"
try:
icon_db_connect = tk.PhotoImage(file="data/icons/database_connect40px.png")
except tk.TclError:
self.logger.warning("tk.PhotoImage failed: Using Pillow (PIL) ImageTK and Image. The interface may not "
"look as intended. Please refer to README.md for updating tkinter")
icon_db_connect = ImageTk.PhotoImage(Image.open("data/icons/database_connect40px.png"))
self.b_main_db_connect = tk.Button(self.menuFrame, compound="top", image=icon_db_connect, width="40",
height="40", command=self.popup_connect2database, highlightthickness=0,
activebackground="black", bd=0)
self.b_main_db_connect.image = icon_db_connect
self.b_main_db_connect.pack(side="left")
try:
icon_db_new = tk.PhotoImage(file="data/icons/database_new40px.png")
except tk.TclError:
self.logger.warning("tk.PhotoImage failed: Using Pillow (PIL) ImageTK and Image. The interface may not "
"look as intended. Please refer to README.md for updating tkinter")
icon_db_new = ImageTk.PhotoImage(Image.open("data/icons/database_new40px.png"))
self.b_main_db_new = tk.Button(self.menuFrame, compound="top", image=icon_db_new, width="40", height="40",
command=self.popup_create_new_database, highlightthickness=0,
activebackground="black", bd=0)
self.b_main_db_new.image = icon_db_new
self.b_main_db_new.pack(side="left")
try:
icon_import = tk.PhotoImage(file="data/icons/import40px.png")
except tk.TclError:
self.logger.warning("tk.PhotoImage failed: Using Pillow (PIL) ImageTK and Image. The interface may not "
"look as intended. Please refer to README.md for updating tkinter")
icon_import = ImageTk.PhotoImage(Image.open("data/icons/import40px.png"))
self.b_main_import = tk.Button(self.menuFrame, compound="top", state='disabled', image=icon_import, width="40",
height="40", command=self.popup_import_capture, highlightthickness=0,
activebackground="black", bd=0)
self.b_main_import.image = icon_import
self.b_main_import.pack(side="left")
self.b_main_mud_wizard = tk.Button(self.menuFrame,
text="MUD Wizard",
wraplength=80,
state="disabled",
command=lambda p=self: MUDWizard(parent=p))
self.b_main_mud_wizard.pack(side="left")
self.b_main_generate_report = tk.Button(self.menuFrame,
text="Generate Report",
wraplength=80,
state="disabled",
command=self.generate_report_wizard)
self.b_main_generate_report.pack(side="left")
# *** Left (capture) frame *** #
self.capFrame = tk.Frame(self.parent, width=300, bd=1, bg="#eeeeee")
# title
self.cap_title_var = tk.StringVar()
self.cap_title_var.set("Captures")
self.cap_title = tk.Label(self.capFrame, textvariable=self.cap_title_var, bg="#eeeeee", bd=1, relief="flat")
self.cap_title.pack(side="top", fill=tk.X)
# capture list
self.cap_header = ["id", "Date", "Capture Name", "Activity", "Duration", "Details", "Capture File Location"]
self.cap_list = MultiColumnListbox(parent=self.capFrame, header=self.cap_header, input_list=list(),
keep_first=True, exclusion_list=["id"])
self.cap_list.bind("<<TreeviewSelect>>", self.update_dev_list)
'''
self.cap_list.bind("<Double-Button-1>>", (lambda idx=0, hd0=4, hd1=1
: self.popup_import_capture_devices(
CaptureDigest(self.cap_list.get(self.cap_list.selection()[idx])[hd0] + "/" +
self.cap_list.get(self.cap_list.selection()[idx])[hd1]))))
'''
self.b_main_inspect = tk.Button(self.capFrame, text="Inspect", command=self.pre_popup_import_capture_devices)
self.b_main_inspect.pack(side="right")
self.b_main_inspect.config(state="disabled")
self.cap = None
# *** Right Frame *** #
self.rightFrame = tk.Frame(self.parent, width=500, bd=1, bg="#dfdfdf")
# ** Top Right (device) frame ** #
self.devFrame = tk.Frame(self.rightFrame, width=500)
# title
self.dev_title_var = tk.StringVar()
self.dev_title_var.set("Devices")
self.dev_title = tk.Label(self.devFrame, textvariable=self.dev_title_var, bg="#eeeeee", bd=1, relief="flat")
self.dev_title.pack(fill=tk.X)
# device list
self.dev_header = ["id", "Manufacturer", "Model", "Internal Name", "MAC", "Category"]
self.dev_list = MultiColumnListbox(parent=self.devFrame, header=self.dev_header, input_list=list(),
keep_first=True, exclusion_list=["id"])
self.dev_list.bind("<<TreeviewSelect>>", self.update_comm_list)
self.devFrame.pack(side="top", fill="both", expand=True)
# ** Bottom Right (communication) frame ** #
self.commFrame = tk.Frame(self.rightFrame, width=500, bd=1, bg="#eeeeee")
# title
self.comm_title_var = tk.StringVar()
self.comm_title_var.set("Communication")
self.comm_title = tk.Label(self.commFrame, textvariable=self.comm_title_var, bg="#eeeeee", bd=1, relief="flat")
self.comm_title.pack(fill=tk.X)
# communication list
self.comm_header = ["id", "fileID", "Time", "MAC", "IPver", "Source", "Destination", "E/W",
"Protocol", "Transport Protocol", "Source Port",
# "Destination Port", "Length", "Direction", "Raw"] #Direction being NS or EW
# "Destination Port", "Length", "Raw"] #Direction being NS or EW
"Destination Port", "Length"] # Direction being NS or EW
self.comm_list = MultiColumnListbox(parent=self.commFrame, header=self.comm_header, input_list=list(),
exclusion_list=["id", "fileID"])
# To be added once packets have been added to the table
self.comm_state = "any"
self.b_ns = tk.Button(self.commFrame, text="N/S", command=(lambda s="ns": self.modify_comm_state(s)))
self.b_ew = tk.Button(self.commFrame, text="E/W", command=(lambda s="ew": self.modify_comm_state(s)))
self.status_comm_state = "Communication direction: " + self.comm_state
self.comm_dev_restriction = "none"
self.b_between = tk.Button(self.commFrame, text="Between",
command=(lambda r="between": self.modify_comm_dev_restriction(r)))
self.b_either = tk.Button(self.commFrame, text="Either",
command=(lambda r="either": self.modify_comm_dev_restriction(r)))
self.status_comm_restriction = "Communication restrictions: " + self.comm_dev_restriction
self.b_pkt10 = tk.Button(self.commFrame, text="10", command=(lambda n=10: self.modify_comm_num_pkts(n)))
self.b_pkt100 = tk.Button(self.commFrame, text="100", command=(lambda n=100: self.modify_comm_num_pkts(n)))
self.b_pkt1000 = tk.Button(self.commFrame, text="1000", command=(lambda n=1000: self.modify_comm_num_pkts(n)))
self.b_pkt10000 = tk.Button(self.commFrame, text="10000",
command=(lambda n=10000: self.modify_comm_num_pkts(n)))
self.b_ns.pack(side="left")
self.b_ew.pack(side="left")
self.b_between.pack(side="left")
self.b_either.pack(side="left")
self.b_pkt10000.pack(side="right")
self.b_pkt1000.pack(side="right")
self.b_pkt100.pack(side="right")
self.b_pkt10.pack(side="right")
self.comm_list_num_pkts = 100
# self.b_pkt100.config(state='disabled')
self.b_ns.config(state='disabled')
self.b_ew.config(state='disabled')
self.b_between.config(state='disabled')
self.b_either.config(state='disabled')
self.b_pkt10.config(state='disabled')
self.b_pkt100.config(state='disabled')
self.b_pkt1000.config(state='disabled')
self.b_pkt10000.config(state='disabled')
self.comm_list_all_pkts = []
# self.b_internal.pack(side="right")
self.commFrame.pack(side="top", fill="both", expand=True)
# *** Status Bar *** #
self.statusFrame = tk.Frame(self.parent)
self.status_database = "No database_connected..."
self.status_var = tk.StringVar()
self.status_var.set(self.status_database)
self.status = tk.Label(self.statusFrame, textvariable=self.status_var, bd=1, bg="#eeeeee", relief=tk.SUNKEN,
anchor=tk.W, padx=5)
self.status.pack(fill="both", expand=True)
# *** Grid Placement *** #
self.menuFrame.grid(row=0, column=0, columnspan=2, sticky="ew")
self.capFrame.grid(row=1, column=0, rowspan=2, sticky="nsew")
self.rightFrame.grid(row=1, column=1, rowspan=2, sticky="nsew")
self.statusFrame.grid(row=3, column=0, columnspan=2, sticky="ew")
# Grid configuration #
self.parent.grid_rowconfigure(1, weight=1)
self.parent.grid_columnconfigure(0, weight=1)
self.parent.grid_columnconfigure(1, weight=3)
# Check for Fingerbank API key
self.api_info = self.read_api_config()
if self.api_info is not None:
self.api_key = self.api_info.get('api_key')
self.logger.info("Fingerbank API Key: %s", self.api_key)
if (self.api_key is None or self.api_key == "") and self.api_info.get('prompt') in [None, 'True']:
self.api_info['prompt'] = 'True'
self.logger.info("Prompting for Fingerbank API Key.")
self.popup_update_api_key()
else:
self.logger.info("Fingerbank API Key prompt is disabled.")
else:
self.logger.info("No Fingerbank API Key present.")
self.logger.info("Prompting for Fingerbank API Key.")
self.api_info = {"api_key": "", "prompt": 'True'}
self.api_key = None
self.popup_update_api_key()
def yield_focus(self, window=None):
if len(self.window_stack) == 0:
if window is None:
self.logger.error("Problem with window management (yield_focus)")
else:
self.window_stack.append(window)
self.yield_focus()
elif window is None:
self.window_stack[-1].focus_set()
self.window_stack[-1].grab_set()
if self.window_stack[-1] != self.parent:
self.window_stack[-1].transient(self.parent)
self.window_stack[-1].lift()
self.window_stack[-1].attributes('-topmost', True)
self.window_stack[-1].attributes('-topmost', False)
elif self.window_stack[-1] != window:
# Previously top window yield status
self.window_stack[-1].attributes('-topmost', False)
self.window_stack[-1].grab_release()
# Push new window to the top of the stack
self.window_stack.append(window)
self.yield_focus()
# Wait for window to close before yielding focus to next in stack
self.window_stack[-2].wait_window(self.window_stack[-1])
self.window_stack[-1].grab_release()
self.window_stack.pop()
self.yield_focus()
def popup_connect2database(self):
self.logger.info("popup_connect2database window opening")
self.w_db = tk.Toplevel()
self.w_db.wm_title("Connect to Database")
self.make_form_database(dbFields)
self.bind('<Return>', (lambda event: self.connect_and_close))
b_connect = tk.Button(self.w_db, text='Connect',
command=self.connect_and_close)
b_cancel = tk.Button(self.w_db, text='Cancel', command=self.w_db.destroy)
if sys.platform == "win32":
b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
b_connect.pack(side=tk.RIGHT, padx=5, pady=5)
else:
b_connect.pack(side=tk.RIGHT, padx=5, pady=5)
b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
# Save checkbutton
checkvar = tk.IntVar()
ckb_save = tk.Checkbutton(self.w_db, text="Save", width=7, justify=tk.LEFT, variable=checkvar)
ckb_save.pack(side=tk.LEFT, anchor=tk.W, padx=5)
self.db_cnx_entries.append(("Save", checkvar))
self.yield_focus(self.w_db)
def make_form_database(self, fields):
db_handler_temp = DatabaseHandler()
self.db_cnx_entries = list()
for field in fields:
row = tk.Frame(self.w_db)
lab = tk.Label(row, width=12, text=field, anchor='w')
if field == "passwd":
ent = tk.Entry(row, show="\u2022", width=15)
else:
ent = tk.Entry(row)
ent.insert(10, db_handler_temp.config.get(field, "none"))
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=2)
lab.pack(side=tk.LEFT)
ent.pack(side=tk.RIGHT, expand=tk.YES, fill=tk.X)
self.db_cnx_entries.append((field, ent))
def popup_create_new_database(self):
self.logger.info("popup_create_new_database window opening")
self.w_db_new = tk.Toplevel()
self.w_db_new.wm_title("Create New Database")
self.make_form_new_database(dbNewFields)
self.bind('<Return>', (lambda event, c=True: self.connect_and_close(create=c)))
b_create = tk.Button(self.w_db_new, text='Create',
command=(lambda c=True: self.connect_and_close(create=c)))
b_cancel = tk.Button(self.w_db_new, text='Cancel', command=self.w_db_new.destroy)
if sys.platform == "win32":
b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
b_create.pack(side=tk.RIGHT, padx=5, pady=5)
else:
b_create.pack(side=tk.RIGHT, padx=5, pady=5)
b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
# Save checkbutton
checkvar = tk.IntVar()
ckb_save = tk.Checkbutton(self.w_db_new, text="Save", width=7, justify=tk.LEFT, variable=checkvar)
ckb_save.pack(side=tk.LEFT, anchor=tk.W, padx=5)
self.db_cnx_entries.append(("Save", checkvar))
messagebox.showinfo("CREATING a New Database",
"You are CREATING a new database.\n\n"
"You will need to use the existing mysql server password.")
self.yield_focus(self.w_db_new)
def make_form_new_database(self, fields):
db_handler_temp = DatabaseHandler()
self.db_cnx_entries = list()
for field in fields:
row = tk.Frame(self.w_db_new)
lab = tk.Label(row, width=12, text=field, anchor='w')
if field == "passwd":
ent = tk.Entry(row, show="\u2022", width=15)
skip_line = True
else:
ent = tk.Entry(row)
skip_line = False
ent.insert(10, db_handler_temp.config.get(field, "none"))
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=2)
lab.pack(side=tk.LEFT)
ent.pack(side=tk.RIGHT, expand=tk.YES, fill=tk.X)
self.db_cnx_entries.append((field, ent))
if skip_line:
xtra_row = tk.Frame(self.w_db_new)
xtra_lab = tk.Label(xtra_row, width=12, text=' ', anchor='w')
xtra_row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=2)
xtra_lab.pack(side=tk.LEFT)
def connect_and_close(self, create=False):
db_handler_temp = DatabaseHandler()
(save_name, save_var) = self.db_cnx_entries.pop()
save_val = save_var.get()
self.logger.info("Connecting to database")
if create:
(db_label, db_name) = self.db_cnx_entries.pop()
db_name = db_name.get()
db_handler_temp.db_connect(self.db_cnx_entries)
if not db_handler_temp.connected:
tk.messagebox.showerror("Error Connecting to Database",
"There was some error while connecting to the database.\n" +
"Please check all the data fields and try again.")
return
try:
db_handler_temp.db.init_new_database(db_name)
except mysql.connector.Error as err:
if err.errno == mysql.connector.errorcode.ER_DB_CREATE_EXISTS: # 1007
self.logger.error("Database already exists")
reinit = tk.messagebox.askyesno("Database Creation Error",
"Cannot create database '%s' because it already exists.\n\n"
% db_name + "Re-initialize the existing database?",
default='no')
if reinit:
confirm = tk.messagebox.askyesno("Overwrite Existing Database",
"Are you sure you want to overwrite the database '%s'?\n\n" %
db_name + "This action is IRREVERSIBLE and all existing data "
"will be LOST!",
default='no')
if confirm:
db_handler_temp.db.reinit_database(db_name)
else:
tk.messagebox.showinfo("Create New Database Name",
"Please choose a new database name")
return
else:
tk.messagebox.showinfo("Create New Database Name",
"Please choose a new database name")
return
else:
tk.messagebox.showerror("Error Creating Database",
"There was some error in creating the database.\n" +
"Please try again using a different name")
return
db_handler_temp.db_config['database'] = db_name
else:
db_handler_temp.db_connect(self.db_cnx_entries)
if db_handler_temp.connected:
self.db_handler = db_handler_temp
self.status_database = "Connected to " + self.db_handler.db_config.get("database", "none")
self.status_var.set(self.status_database)
self.populate_capture_list()
if save_val:
self.popup_confirm_save()
if create:
self.w_db_new.destroy()
else:
self.w_db.destroy()
# Enable main menu buttons
self.b_main_import.config(state='normal')
self.b_main_mud_wizard.config(state='normal')
self.b_main_generate_report.config(state='normal')
self.b_main_inspect.config(state="disabled")
self.b_ns.config(state='normal')
self.b_ew.config(state='normal')
self.b_between.config(state='disabled')
self.b_either.config(state='disabled')
self.b_pkt10.config(state='normal')
self.b_pkt100.config(state='disabled')
self.b_pkt1000.config(state='normal')
self.b_pkt10000.config(state='normal')
else:
tk.messagebox.showerror("Error", "Problem connecting to database")
self.db_cnx_entries.append((save_name, save_var))
def popup_update_labeled_device_info(self):
self.logger.info("popup_update_labeled_device_info window opening")
try:
self.db_handler.db.insert_protocol_device()
except AttributeError:
messagebox.showinfo("Failure", "Please make sure you are connected to a database and try again")
def make_form_api(self, fields):
self.api_key_entries = list()
row = tk.Frame(self.w_db_new)
lab = tk.Label(row, width=12, text=fields[0], anchor='w')
ent = tk.Entry(row)
if self.api_key is not None:
ent.insert(10, self.api_key)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=2)
lab.pack(side=tk.LEFT)
ent.pack(side=tk.RIGHT, expand=tk.YES, fill=tk.X)
self.api_key_entries.append((fields[0], ent))
def popup_update_api_key(self):
self.logger.info("popup_update_api_key window opening")
self.w_db_new = tk.Toplevel()
self.w_db_new.wm_title("Update Fingerbank API Key")
self.make_form_api(APIFields)
self.bind('<Return>', (lambda event: self.save_api_config))
if self.api_key is None or self.api_key == "":
if self.api_info.get('prompt') is not None and self.api_info['prompt'] == 'True':
v_no_prompt = tk.BooleanVar()
cb = tk.Checkbutton(self.w_db_new, text=APIFields[1], variable=v_no_prompt, anchor='w')
cb.pack(side=tk.LEFT)
self.api_key_entries.append((APIFields[1], v_no_prompt))
b_save = tk.Button(self.w_db_new, text='Save',
command=self.save_api_config)
b_cancel = tk.Button(self.w_db_new, text='Cancel', command=self.w_db_new.destroy)
if sys.platform == "win32":
b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
b_save.pack(side=tk.RIGHT, padx=5, pady=5)
else:
b_save.pack(side=tk.RIGHT, padx=5, pady=5)
b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
self.yield_focus(self.w_db_new)
def save_api_config(self, filename='config.ini', section='API_Fingerbank'):
parser = ConfigParser()
parser.read(filename)
api_info = dict()
for entry in self.api_key_entries:
field = entry[0]
text = entry[1].get()
if field == APIFields[1]:
field = "prompt"
text = not entry[1].get()
api_info[field] = text
parser[section] = api_info
with open(filename, 'w') as configfile:
parser.write(configfile)
self.api_key = api_info['api_key']
self.w_db_new.destroy()
def read_api_config(self, filename='config.ini', section='API_Fingerbank'):
parser = ConfigParser()
parser.read(filename)
api_info = dict()
if parser.has_section(section):
items = parser.items(section)
for item in items:
api_info[item[0]] = item[1]
else:
self.logger.info("Section %s not present", section)
return None
return api_info # ['api_key']
def popup_confirm_save(self):
self.logger.info("popup_confirm_save window opening")
confirm = tk.messagebox.askyesno("MUD-PD: Save Configuration",
"Are you sure you want to save this configuration?\n\n" +
"Any existing configuration will be OVERWRITTEN.\n\n" +
"For security purposes, the password will NOT be saved.",
default='no')
if confirm:
self.db_handler.save_db_config() # save_pwd=save_pwd)
return
def popup_import_capture(self):
self.logger.info("popup_import_capture window opening")
self.w_cap = tk.Toplevel()
self.w_cap.wm_title("Import Packet Capture")
self.make_form_capture(captureFields, lifecyclePhaseFields, captureEnvFields, captureTypeFields)
self.bind('<Return>', (lambda event: self.import_and_close))
self.b_import = tk.Button(self.w_cap, text='Import',
command=self.import_and_close)
self.b_cancel = tk.Button(self.w_cap, text='Cancel', command=self.w_cap.destroy)
if sys.platform == "win32":
self.b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
self.b_import.pack(side=tk.RIGHT, padx=5, pady=5)
else:
self.b_import.pack(side=tk.RIGHT, padx=5, pady=5)
self.b_cancel.pack(side=tk.RIGHT, padx=5, pady=5)
self.yield_focus(self.w_cap)
def open_file_callback(self, sv_entry):
tk.Tk().withdraw()
# show an "Open" dialog box and return the path to the selected file
filename = askopenfilename()
sv_entry.set(filename)
# Check if selected file is the previously selected one
if filename != self.filename_prev:
self.filename_prev = filename
if filename.lower().endswith(".pcapng"):
# Check for metadata embedded in the comment field
self.cap_envi_metadata = capMeta.extract_comment(filename)
if self.cap_envi_metadata is not None and len(self.cap_envi_metadata) > 0:
for i, (x, y) in enumerate(self.capture_entries):
# Skip first entry
if i:
if i == 2:
try:
phase = self.cap_envi_metadata.get( field2db[x.cget('text')])
if phase is not None:
phase = phase.lower()
if phase == "setup":
y.set(0)
elif phase == "normal operation":
y.set(1)
elif phase == "removal":
y.set(2)
else:
self.logger.warning("Writing pcapng environmental variables: "
"unexpected phase provided")
self.logger.debug("Phase %s %s", phase, y.get())
except:
self.logger.warning("Writing pcapng environmental variables: "
"Likely field missing in file comment")
else:
try:
if type(y) == tk.IntVar:
bool_val = self.cap_envi_metadata.get(field2db[x])
if bool_val is not None:
bool_val = bool_val.lower()
if bool_val == "true":
y.set(1)
elif bool_val == "false":
y.set(0)
else:
self.logger.warning("Writing pcapng environmental variables: "
"non boolean value provided")
elif type(y) == tk.StringVar:
str_val = self.cap_envi_metadata.get(field2db[x])
if str_val is not None:
y.set(str_val)
else:
self.logger.warning("Writing pcapng environmental variables: "
"unexpected variable type")
self.logger.debug("x: %s, field2db[x]: %s, y.get(): %s", x, field2db[x], y.get())
except:
self.logger.warning("Writing pcapng environmental variables: "
"Likely environmental variable missing")
else:
self.cap_envi_metadata = dict()
# Check if the file has already been imported (putting this after the autofill to allow the user to view
# the included metadata
if self.check_hash():
tk.Tk().withdraw()
self.logger.error("Capture file already imported into database")
messagebox.showerror("Error", "Capture file already imported into database")
return
# Todo: Figure out how to Kill any/all existing worker threads if a new file was selected.
# Currently just drops keeping track of the thread
for t in self.threads.get('capture_processing'):
# t.raise_exception()
self.threads['capture_processing'].remove(t)
# Restart worker threads to process file
self.logger.info("Getting a headstart on processing capture: %s", filename)
t = threading.Thread(target=self.headstart, args=(filename,))
self.threads['capture_processing'].append(t)
t.setDaemon(True)
t.start()
'''This headstart function speeds up the processing of the packet capture by beginning to import the packet capture
as soon as the file name is selected by the user.'''
def headstart(self, filename):
asyncio.set_event_loop(asyncio.new_event_loop())
self.cap = CaptureDigest(filename, api_key=self.api_key)
self.logger.info("Finished importing capture file")
def make_form_capture(self, fields_general, fields_phase, fields_env, fields_type):
self.capture_entries = list()
for i, field in enumerate(fields_general):
if i == 0:
row = tk.Frame(self.w_cap)
lab = tk.Label(row, width=4, text=field, anchor='w')
sv_ent = tk.StringVar()
ent = tk.Entry(row, textvariable=sv_ent)
b_open = tk.Button(row, text='...',
command=(lambda e=sv_ent: self.open_file_callback(e)))
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab.pack(side=tk.LEFT)
ent.pack(side=tk.LEFT, expand=tk.YES, fill=tk.X)
b_open.pack(side=tk.RIGHT, expand=tk.NO, fill=tk.X)
else:
row = tk.Frame(self.w_cap)
lab = tk.Label(row, width=15, text=field, anchor='w')
sv_ent = tk.StringVar()
ent = tk.Entry(row, textvariable=sv_ent)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab.pack(side=tk.LEFT)
ent.pack(side=tk.RIGHT, expand=tk.YES, fill=tk.X)
self.capture_entries.append((field, sv_ent))
# Device Phase (Setup, Normal Operation, Removal)
# lifecyclePhaseFields = 'Setup', 'Normal Operation', 'Removal'
row = tk.Frame(self.w_cap)
lab = tk.Label(row, width=15, text="Lifecycle Phase", font="Helvetica 14 bold") # , anchor='w')
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab.pack(side=tk.TOP) # LEFT)
row = tk.Frame(self.w_cap)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
v_phz = tk.IntVar(None, 1)
for i, field in enumerate(fields_phase):
if i == 1:
width = 16
else:
width = 10
b_phz = tk.Radiobutton(row, text=field, variable=v_phz, value=i, width=width)
b_phz.pack(side=tk.LEFT, fill=tk.X, padx=5, pady=5, anchor=tk.W) # , anchor=tk.W)
self.capture_entries.append((lab, v_phz))
# Environment Variables (Internet, Human Interaction, Preferred DNS Enabled, Isolated
# captureEnvFields = 'Internet', 'Human Interaction', 'Preferred DNS Enabled','Isolated'
row = tk.Frame(self.w_cap)
lab = tk.Label(row, width=20, text="Environmental Variables", font="Helvetica 14 bold") # , anchor='w'
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab.pack(side=tk.TOP) # LEFT
for i, field in enumerate(fields_env):
if i % 2 == 0:
row = tk.Frame(self.w_cap)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
if i < 2:
v_env = tk.IntVar(None, 1)
else:
v_env = tk.IntVar()
b_env = tk.Checkbutton(row, text=field, variable=v_env)
b_env.pack(side=tk.LEFT, padx=20, anchor=tk.W)
self.capture_entries.append((field, v_env))
# Capture Type (Duration-based, Duration, Action-based, Action)
# captureTypeFields = 'Duration-based', 'Duration', 'Action-based', 'Action'
row = tk.Frame(self.w_cap)
lab = tk.Label(row, width=15, text="Capture Type", font="Helvetica 14 bold") # anchor='w')
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab.pack(side=tk.TOP) # LEFT)
def activate_check_duration():
if v_dur.get() == 1: # whenever checked
e_dur.config(state='normal')
elif v_dur.get() == 0: # whenever unchecked
e_dur.config(state='disabled')
i = 0
# Duration-based
row = tk.Frame(self.w_cap)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
v_dur = tk.IntVar()
b_dur = tk.Checkbutton(row, text=fields_type[i], variable=v_dur, command=activate_check_duration)
b_dur.pack(side=tk.LEFT, fill=tk.X, padx=5, pady=5, anchor=tk.W)
self.capture_entries.append((fields_type[i], v_dur))
# Duration
i += 1
row = tk.Frame(self.w_cap)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab = tk.Label(row, padx=5, width=6, text=fields_type[i], anchor='w')
lab.pack(side=tk.LEFT)
sv_dur = tk.StringVar()
e_dur = tk.Entry(row, textvariable=sv_dur)
e_dur.pack(side=tk.LEFT, expand=tk.YES, fill=tk.X)
e_dur.config(state='disabled')
self.capture_entries.append((fields_type[i], sv_dur))
def activate_check_action():
if v_act.get() == 1: # whenever checked
e_act.config(state='normal')
elif v_act.get() == 0: # whenever unchecked
e_act.config(state='disabled')
# Action-based
i += 1
row = tk.Frame(self.w_cap)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
v_act = tk.IntVar()
b_act = tk.Checkbutton(row, text=fields_type[i], variable=v_act, command=activate_check_action)
b_act.pack(side=tk.LEFT, fill=tk.X, padx=5, pady=5, anchor=tk.W)
self.capture_entries.append((fields_type[i], v_act))
# Action
i += 1
row = tk.Frame(self.w_cap)
row.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
lab = tk.Label(row, padx=5, width=6, text=fields_type[i], anchor='w')
lab.pack(side=tk.LEFT)
sv_act = tk.StringVar()
e_act = tk.Entry(row, textvariable=sv_act)
e_act.pack(side=tk.LEFT, expand=tk.YES, fill=tk.X)
e_act.config(state='disabled')
self.capture_entries.append((fields_type[i], sv_act))
'''Check if capture is already in database (using sha256)'''
def check_hash(self):
file_path = self.capture_entries[0][1].get()
filehash = hashlib.sha256(open(file_path, 'rb').read()).hexdigest()
captures = self.db_handler.db.select_unique_captures()
if any(filehash in cap_hash for cap_hash in captures):
return True
else:
return False
def process_capture(self):
self.logger.info("Initiating capture processing from button press")
file_path = self.capture_entries[0][1].get()
self.cap = CaptureDigest(file_path, api_key=self.api_key)
self.logger.info("Finished importing capture file")
'''This function imports the user's pcap/pcap-ng file'''
def import_and_close(self):
if self.threads.get('capture_processing'):
self.logger.info("Capture processing already running. Waiting to finish")
else:
t = threading.Thread(target=self.process_capture)
self.threads['capture_processing'].append(t)
t.setDaemon(True)
t.start()
if self.threads['capture_processing'][-1].is_alive():
tk.messagebox.showinfo("Processing Packet Capture",
"The capture file is being processed. Depending on the file size, it may take a "
"while. Please hold...\n\n"
"If it takes a few minutes, it may be stuck. If this happens, you may need to close "
"MUD-PD and try again.\n\n"
"It may be worth splitting the file into a few smaller pieces first.")
# Starts progress bar
self.progress_bar()
for t in self.threads['capture_processing']:
while t.is_alive():
self.w_progress_pb.update()