-
Notifications
You must be signed in to change notification settings - Fork 485
Expand file tree
/
Copy pathlogontracer.py
More file actions
4954 lines (4188 loc) · 195 KB
/
logontracer.py
File metadata and controls
4954 lines (4188 loc) · 195 KB
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/env python
# -*- coding: utf-8 -*-
#
# LICENSE
# https://github.com/JPCERTCC/LogonTracer/blob/master/LICENSE.txt
#
import os
import re
import sys
import argparse
import datetime
import secrets
import threading
from functools import wraps
from logging import getLogger
from logging.config import dictConfig
# Lazy import flags - check availability without importing heavy modules
has_lxml = False
has_evtx = False
has_neo4j = False
has_numpy = False
has_changefinder = False
has_flask = False
has_pandas = False
has_hmmlearn = False
has_sklearn = False
has_es = False
has_pyyaml = False
has_flask_login = False
has_flask_sqlalchemy = False
has_flask_wtf = False
has_flask_limiter = False
has_git = False
has_sigma = False
def utc_now():
"""Return a timezone-aware UTC datetime."""
return datetime.datetime.now(datetime.timezone.utc)
def utc_now_naive():
"""Return a naive UTC datetime for legacy database fields."""
return utc_now().replace(tzinfo=None)
# Check availability of optional modules
try:
import importlib.util
has_lxml = importlib.util.find_spec("lxml") is not None
has_evtx = importlib.util.find_spec("evtx") is not None
has_neo4j = importlib.util.find_spec("neo4j") is not None
has_numpy = importlib.util.find_spec("numpy") is not None
has_changefinder = importlib.util.find_spec("changefinder") is not None
has_flask = importlib.util.find_spec("flask") is not None
has_pandas = importlib.util.find_spec("pandas") is not None
has_hmmlearn = importlib.util.find_spec("hmmlearn") is not None
has_sklearn = importlib.util.find_spec("joblib") is not None
has_es = importlib.util.find_spec("elasticsearch") is not None
has_pyyaml = importlib.util.find_spec("yaml") is not None
has_flask_login = importlib.util.find_spec("flask_login") is not None
has_flask_sqlalchemy = importlib.util.find_spec("flask_sqlalchemy") is not None
has_flask_wtf = importlib.util.find_spec("flask_wtf") is not None
has_flask_limiter = importlib.util.find_spec("flask_limiter") is not None
has_git = importlib.util.find_spec("git") is not None
has_sigma = importlib.util.find_spec("sigma") is not None
except:
# Fallback to try/except import if importlib.util is not available
try:
from lxml import etree
has_lxml = True
except ImportError:
pass
try:
from evtx import PyEvtxParser
has_evtx = True
except ImportError:
pass
try:
from neo4j import GraphDatabase
has_neo4j = True
except ImportError:
pass
try:
import numpy as np
has_numpy = True
except ImportError:
pass
try:
import changefinder
has_changefinder = True
except ImportError:
pass
try:
from flask import Flask
has_flask = True
except ImportError:
pass
try:
import pandas as pd
has_pandas = True
except ImportError:
pass
try:
from hmmlearn import hmm
has_hmmlearn = True
except ImportError:
pass
try:
import joblib
has_sklearn = True
except ImportError:
pass
try:
from elasticsearch import Elasticsearch
has_es = True
except ImportError:
pass
try:
import yaml
has_pyyaml = True
except ImportError:
pass
try:
from flask_login import UserMixin
has_flask_login = True
except ImportError:
pass
try:
from flask_sqlalchemy import SQLAlchemy
has_flask_sqlalchemy = True
except ImportError:
pass
try:
from flask_wtf import FlaskForm
has_flask_wtf = True
except ImportError:
pass
try:
from flask_limiter import Limiter
has_flask_limiter = True
except ImportError:
pass
try:
import git
has_git = True
except ImportError:
pass
try:
from sigma.rule import SigmaRule
from sigma.collection import SigmaCollection
from sigma.conditions import ConditionItem, ConditionAND, ConditionOR, ConditionNOT, ConditionFieldEqualsValueExpression
has_sigma = True
except ImportError:
pass
def ensure_neo4j_imported():
"""Ensure Neo4j modules are imported (lazy loading for web UI)"""
global GraphDatabase, ClientError, ServiceUnavailable, AuthError, ConfigurationError
if has_flask and GraphDatabase is None:
from neo4j import GraphDatabase as _GraphDatabase
from neo4j.exceptions import ClientError as _ClientError
from neo4j.exceptions import ServiceUnavailable as _ServiceUnavailable
from neo4j.exceptions import AuthError as _AuthError
from neo4j.exceptions import ConfigurationError as _ConfigurationError
GraphDatabase = _GraphDatabase
ClientError = _ClientError
ServiceUnavailable = _ServiceUnavailable
AuthError = _AuthError
ConfigurationError = _ConfigurationError
# Decorator to ensure Neo4j is imported before route execution
def with_neo4j(f):
@wraps(f)
def decorated_function(*args, **kwargs):
ensure_neo4j_imported()
return f(*args, **kwargs)
return decorated_function
sys.modules.setdefault('logontracer', sys.modules[__name__])
# Check Event Id
EVENT_ID = [4624, 4625, 4662, 4768, 4769, 4776, 4672, 4720, 4726, 4728, 4729, 4732, 4733, 4756, 4757, 4719, 5137, 5141]
# EVTX Header
EVTX_HEADER = b"\x45\x6C\x66\x46\x69\x6C\x65\x00"
# String Check list
UCHECK = r"[%*+=\[\]\\/|;:\"<>?,&]"
HCHECK = r"[*\\/|:\"<>?&]"
# Username allowed characters: letters, digits, underscore, hyphen only
USERNAME_PATTERN = re.compile(r'^[a-zA-Z0-9_-]+$')
# Neo4j identifier pattern: only alphanumeric and underscore (for database names, usernames, roles)
NEO4J_IDENTIFIER_PATTERN = re.compile(r'^[a-zA-Z0-9_]+$')
# IPv4 regex
IPv4_PATTERN = re.compile(r"\A\d+\.\d+\.\d+\.\d+\Z", re.DOTALL)
# IPv6 regex
IPv6_PATTERN = re.compile(r"\A(::(([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})){0,5})?|([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(::(([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})){0,4})?|:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(::(([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})){0,3})?|:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(::(([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})){0,2})?|:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(::(([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(:([0-9a-f]|[1-9a-f][0-9a-f]{1,3}))?)?|:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})(::([0-9a-f]|[1-9a-f][0-9a-f]{1,3})?|(:([0-9a-f]|[1-9a-f][0-9a-f]{1,3})){3}))))))\Z", re.DOTALL)
# Allowed character patterns (whitelist approach)
ALLOWED_FILENAME_PATTERN = re.compile(r'^[a-zA-Z0-9_\-. ]+$') # alphanumeric, underscore, dash, dot, space
ALLOWED_PATH_PATTERN = re.compile(r'^[a-zA-Z0-9_\-./]+$') # alphanumeric, underscore, dash, dot, slash
ALLOWED_EVTX_FILENAME_PATTERN = re.compile(r'^[a-zA-Z0-9_\-. ]+\.evtx$', re.IGNORECASE) # EVTX files only
# LogonTracer folder path
FPATH = os.path.dirname(os.path.abspath(__file__))
# CategoryId
CATEGORY_IDs = {
"%%8280": "Account_Logon",
"%%8270": "Account_Management",
"%%8276": "Detailed_Tracking",
"%%8279": "DS_Access",
"%%8273": "Logon/Logoff",
"%%8274": "Object_Access",
"%%8277": "Policy_Change",
"%%8275": "Privilege_Use",
"%%8272": "System"}
# Auditing Constants
AUDITING_CONSTANTS = {
"{0cce9210-69ae-11d9-bed3-505054503030}": "SecurityStateChange",
"{0cce9211-69ae-11d9-bed3-505054503030}": "SecuritySubsystemExtension",
"{0cce9212-69ae-11d9-bed3-505054503030}": "Integrity",
"{0cce9213-69ae-11d9-bed3-505054503030}": "IPSecDriverEvents",
"{0cce9214-69ae-11d9-bed3-505054503030}": "Others",
"{0cce9215-69ae-11d9-bed3-505054503030}": "Logon",
"{0cce9216-69ae-11d9-bed3-505054503030}": "Logoff",
"{0cce9217-69ae-11d9-bed3-505054503030}": "AccountLockout",
"{0cce9218-69ae-11d9-bed3-505054503030}": "IPSecMainMode",
"{0cce9219-69ae-11d9-bed3-505054503030}": "IPSecQuickMode",
"{0cce921a-69ae-11d9-bed3-505054503030}": "IPSecUserMode",
"{0cce921b-69ae-11d9-bed3-505054503030}": "SpecialLogon",
"{0cce921c-69ae-11d9-bed3-505054503030}": "Others",
"{0cce921d-69ae-11d9-bed3-505054503030}": "FileSystem",
"{0cce921e-69ae-11d9-bed3-505054503030}": "Registry",
"{0cce921f-69ae-11d9-bed3-505054503030}": "Kernel",
"{0cce9220-69ae-11d9-bed3-505054503030}": "Sam",
"{0cce9221-69ae-11d9-bed3-505054503030}": "CertificationServices",
"{0cce9222-69ae-11d9-bed3-505054503030}": "ApplicationGenerated",
"{0cce9223-69ae-11d9-bed3-505054503030}": "Handle",
"{0cce9224-69ae-11d9-bed3-505054503030}": "Share",
"{0cce9225-69ae-11d9-bed3-505054503030}": "FirewallPacketDrops",
"{0cce9226-69ae-11d9-bed3-505054503030}": "FirewallConnection",
"{0cce9227-69ae-11d9-bed3-505054503030}": "Other",
"{0cce9228-69ae-11d9-bed3-505054503030}": "Sensitive",
"{0cce9229-69ae-11d9-bed3-505054503030}": "NonSensitive",
"{0cce922a-69ae-11d9-bed3-505054503030}": "Others",
"{0cce922b-69ae-11d9-bed3-505054503030}": "ProcessCreation",
"{0cce922c-69ae-11d9-bed3-505054503030}": "ProcessTermination",
"{0cce922d-69ae-11d9-bed3-505054503030}": "DpapiActivity",
"{0cce922e-69ae-11d9-bed3-505054503030}": "RpcCall",
"{0cce922f-69ae-11d9-bed3-505054503030}": "AuditPolicy",
"{0cce9230-69ae-11d9-bed3-505054503030}": "AuthenticationPolicy",
"{0cce9231-69ae-11d9-bed3-505054503030}": "AuthorizationPolicy",
"{0cce9232-69ae-11d9-bed3-505054503030}": "MpsscvRulePolicy",
"{0cce9233-69ae-11d9-bed3-505054503030}": "WfpIPSecPolicy",
"{0cce9234-69ae-11d9-bed3-505054503030}": "Others",
"{0cce9235-69ae-11d9-bed3-505054503030}": "UserAccount",
"{0cce9236-69ae-11d9-bed3-505054503030}": "ComputerAccount",
"{0cce9237-69ae-11d9-bed3-505054503030}": "SecurityGroup",
"{0cce9238-69ae-11d9-bed3-505054503030}": "DistributionGroup",
"{0cce9239-69ae-11d9-bed3-505054503030}": "ApplicationGroup",
"{0cce923a-69ae-11d9-bed3-505054503030}": "Others",
"{0cce923b-69ae-11d9-bed3-505054503030}": "DSAccess",
"{0cce923c-69ae-11d9-bed3-505054503030}": "AdAuditChanges",
"{0cce923d-69ae-11d9-bed3-505054503030}": "Replication",
"{0cce923e-69ae-11d9-bed3-505054503030}": "DetailedReplication",
"{0cce923f-69ae-11d9-bed3-505054503030}": "CredentialValidation",
"{0cce9240-69ae-11d9-bed3-505054503030}": "Kerberos",
"{0cce9241-69ae-11d9-bed3-505054503030}": "Others",
"{0cce9242-69ae-11d9-bed3-505054503030}": "KerbCredentialValidation",
"{0cce9243-69ae-11d9-bed3-505054503030}": "NPS"}
# Kerberos Ticket Encryption Types conversion table
# Based on Microsoft documentation: https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/event-4768
TICKET_ENCRYPTION_TYPES = {
# Hex formats (lowercase with 0x)
"0x1": "DES-CBC-CRC",
"0x3": "DES-CBC-MD5",
"0x11": "AES128-CTS-HMAC-SHA1-96",
"0x12": "AES256-CTS-HMAC-SHA1-96",
"0x17": "RC4-HMAC",
"0x18": "RC4-HMAC-EXP",
"0xffffffff": "-",
}
# Load logging config
import yaml
with open(FPATH + "/config/logging.yml", 'r') as logging_open:
logging_data = yaml.safe_load(logging_open)
dictConfig(logging_data)
logger = getLogger("agent_logger")
# Flask instance
if not has_flask:
# Logger already initialized above
logger.error("[!] Flask must be installed for this script.")
sys.exit(1)
else:
# Import Flask modules at startup (Flask itself is lightweight)
from flask import Flask, render_template, request, redirect, session, jsonify, flash, url_for, abort
from flask_login import UserMixin, LoginManager, login_user, logout_user, current_user
from markupsafe import Markup, escape
from flask_sqlalchemy import SQLAlchemy
from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField, BooleanField, TextAreaField, SelectField, IntegerField, FloatField
from wtforms.validators import DataRequired, Length, EqualTo, Optional, ValidationError, Regexp
from flask_wtf.csrf import CSRFProtect, generate_csrf
if has_flask_limiter:
from flask_limiter import Limiter
from flask_limiter.util import get_remote_address
# Import common modules needed by web interface
import csv
import json
import glob
import pickle
import shutil
import subprocess
import asyncio
from ssl import create_default_context
# Neo4j will be imported lazily in functions that need it
# This keeps startup time fast for CLI operations
GraphDatabase = None
ClientError = None
ServiceUnavailable = None
AuthError = None
ConfigurationError = None
app = Flask(__name__)
parser = argparse.ArgumentParser(description="Visualizing and analyzing active directory Windows logon event logs.")
parser.add_argument("-r", "--run", action="store_true", default=False,
help="Start web application.")
parser.add_argument("-o", "--port", dest="port", action="store", type=int, metavar="PORT",
help="Port number to be started web application. (default: 8080).")
parser.add_argument("--host", dest="host", action="store", type=str, metavar="HOST",
help="Host address to bind the web application. (default: 0.0.0.0).")
parser.add_argument("-e", "--evtx", dest="evtx", nargs="*", action="store", type=str, metavar="EVTX",
help="Import to the AD EVTX file. (multiple files OK)")
parser.add_argument("-x", "--xml", dest="xmls", nargs="*", action="store", type=str, metavar="XML",
help="Import to the XML file for event log. (multiple files OK)")
parser.add_argument("-s", "--server", dest="server", action="store", type=str, metavar="SERVER",
help="Neo4j server. (default: localhost)")
parser.add_argument("-u", "--user", dest="user", action="store", type=str, metavar="USERNAME",
help="Neo4j account name. (default: neo4j)")
parser.add_argument("-p", "--password", dest="password", action="store", type=str, metavar="PASSWORD",
help="Neo4j password. (default: password).")
parser.add_argument("--wsport", dest="wsport", action="store", type=str, metavar="PORT",
help="Neo4j websocket port number. (default: 7687).")
parser.add_argument("-l", "--learn", action="store_true", default=False,
help="Machine learning event logs using Hidden Markov Model.")
parser.add_argument("--sigma", action="store_true", default=False,
help="Scan using Sigma rule. (default: False)")
parser.add_argument("--sigma-only", dest="sigma_only", action="store_true", default=False,
help="Sigma scan only mode. Scan EVTX file with Sigma rules without Neo4j processing. (default: False)")
parser.add_argument("--sigma-rules", dest="sigma_rules_path", action="store", type=str, metavar="PATH",
help="Path to Sigma rules folder. (default: sigma)")
parser.add_argument("--es-server", dest="esserver", action="store", type=str, metavar="ESSERVER",
help="Elastic Search server address. (default: localhost:9200)")
parser.add_argument("--es-index", dest="esindex", action="store", type=str, metavar="ESINDEX",
help="Elastic Search index to search. (default: winlogbeat-*)")
parser.add_argument("--es-prefix", dest="esprefix", action="store", type=str, metavar="ESPREFIX",
help="Elastic Search event object prefix. (default: winlog)")
parser.add_argument("--es-user", dest="esuser", action="store", type=str, metavar="ESUSER",
help="Elastic Search ssl authentication user. (default: elastic)")
parser.add_argument("--es-pass", dest="espassword", action="store", type=str, metavar="ESPASSWORD",
help="Elastic Search ssl authentication password.")
parser.add_argument("--es-cafile", dest="escafile", action="store", type=str, metavar="ESCAFILE",
help="Elastic Search ssl cert file.")
parser.add_argument("--es", action="store_true", default=False,
help="Import data from Elastic Search. (default: False)")
parser.add_argument("--postes", action="store_true", default=False,
help="Post data to Elastic Search. (default: False)")
parser.add_argument("-z", "--timezone", dest="timezone", action="store", type=int, metavar="UTC",
help="Event log time zone. (for example: +9) (default: GMT)")
parser.add_argument("-f", "--from", dest="fromdate", action="store", type=str, metavar="DATE",
help="Parse Security Event log from this time. (for example: 2017-01-01T00:00:00)")
parser.add_argument("-t", "--to", dest="todate", action="store", type=str, metavar="DATE",
help="Parse Security Event log to this time. (for example: 2017-02-28T23:59:59)")
parser.add_argument("-c", "--config", dest="config", action="store", type=str, metavar="FILE",
help="Configuration file path. (default: config/config.yml)")
parser.add_argument("--case", dest="case", action="store", type=str, metavar="CASE_NAME",
help="[for Neo4j Enterprise] Case management option. If you want to manage each EVTX files in case. (default: neo4j)")
parser.add_argument("--create_user", dest="create_user", action="store", type=str, metavar="USER",
help="Create a new Neo4j user.")
parser.add_argument("--create_password", dest="create_password", action="store", type=str, metavar="PASSWORD",
help="Create a new Neo4j password.")
parser.add_argument("--role", dest="role", action="store", type=str, metavar="ROLE",
help="[for Neo4j Enterprise] User role option [admin, architect, reader]. (default: reader)")
parser.add_argument("--delete_user", dest="delete_user", action="store", type=str, metavar="USER",
help="Delete a Neo4j user.")
parser.add_argument("--add", action="store_true", default=False,
help="Add additional data to Neo4j database. (default: False)")
parser.add_argument("--delete", action="store_true", default=False,
help="Delete all nodes and relationships from this Neo4j database. (default: False)")
args = parser.parse_args()
statement_user = """
MERGE (user:Username{ user: $user })
SET user.rights = $rights, user.sid = $sid, user.rank = $rank, user.status = $status,
user.counts = $counts, user.counts4624 = $counts4624, user.counts4625 = $counts4625,
user.counts4768 = $counts4768, user.counts4769 = $counts4769, user.counts4776 = $counts4776,
user.detect = $detect
RETURN user
"""
statement_ip = """
MERGE (ip:IPAddress{ IP: $IP })
SET ip.rank = $rank, ip.hostname = $hostname
RETURN ip
"""
statement_r = """
MATCH (user:Username{ user: $user })
MATCH (ip:IPAddress{ IP: $IP })
CREATE (ip)-[event:Event]->(user)
SET event.id = $id, event.logintype = $logintype, event.status = $status,
event.count = $count, event.authname = $authname, event.servicename = $servicename,
event.ticketencryptiontype = $ticketencryptiontype, event.date = $date
RETURN user, ip
"""
statement_date = """
MERGE (date:Date{ date: $Daterange })
SET date.start = $start, date.end = $end
RETURN date
"""
statement_domain = """
MERGE (domain:Domain{ domain: $domain })
RETURN domain
"""
statement_dr = """
MATCH (domain:Domain{ domain: $domain })
MATCH (user:Username{ user: $user })
CREATE (user)-[group:Group]->(domain)
RETURN user, domain
"""
statement_del = """
MERGE (date:Deletetime{ date: $deletetime })
SET date.user = $user, date.domain = $domain
RETURN date
"""
statement_pl = """
MERGE (id:ID{ id: $id })
SET id.changetime = $changetime, id.category = $category, id.sub = $sub
RETURN id
"""
statement_pr = """
MATCH (id:ID{ id: $id })
MATCH (user:Username{ user: $user })
CREATE (user)-[group:Policy]->(id)
SET group.date = $date
RETURN user, id
"""
statement_cd = """
CREATE DATABASE {case};
"""
statement_dd = """
DROP DATABASE {case};
"""
statement_cu = """
CREATE USER {username} SET PASSWORD $password CHANGE NOT REQUIRED;
"""
# for Neo4j enterprise edition
#statement_cu = """
# CREATE USER {username} SET PASSWORD $password CHANGE NOT REQUIRED SET STATUS ACTIVE;
# """
statement_au = """
ALTER CURRENT USER SET PASSWORD FROM $oldPassword TO $newPassword;
"""
statement_du = """
DROP USER {username};
"""
statement_su = """
ALTER USER {username} SET STATUS {action};
"""
statement_role_add = """
CREATE OR REPLACE ROLE {username}_role AS COPY OF {role};
"""
statement_role_revoke = """
REVOKE ACCESS ON DATABASE {database} FROM {username}_role;
"""
statement_role_set = """
GRANT ROLE {username}_role TO {username};
"""
statement_role_set_admin = """
GRANT ROLE admin TO {username};
"""
statement_default_db_access = """
GRANT ACCESS ON DATABASE neo4j TO {username}_role;
"""
statement_db_access = """
GRANT ACCESS ON DATABASE {database} TO {username}_role;
"""
es_doc_user = """
{{"@timestamp":"{datetime}", "user":"{user}", "rights":"{rights}", "sid":"{sid}", "status":"{status}", "rank":{rank}}}
"""
es_doc_ip = """
{{"@timestamp":"{datetime}", "IP":"{IP}", "hostname":"{hostname}", "rank":{rank}}}
"""
if not has_flask_login:
logger.error("[!] flask-login must be installed for this script.")
sys.exit(1)
if not has_flask_sqlalchemy:
logger.error("[!] flask-sqlalchemy must be installed for this script.")
sys.exit(1)
if not has_pyyaml:
logger.error("[!] pyyaml must be installed for this script.")
sys.exit(1)
if not has_flask_wtf:
logger.error("[!] flask_wtf must be installed for this script.")
sys.exit(1)
if args.config:
config_path = args.config
else:
config_path = FPATH + "/config/config.yml"
with open(config_path, 'r') as config_open:
config_data = yaml.safe_load(config_open)["settings"]
# neo4j password
NEO4J_PASSWORD = config_data["neo4j"]["NEO4J_PASSWORD"]
# neo4j user name
NEO4J_USER = config_data["neo4j"]["NEO4J_USER"]
# neo4j server
NEO4J_SERVER = config_data["neo4j"]["NEO4J_SERVER"]
# neo4j HTTP port (for legacy compatibility)
NEO4J_HTTP_PORT = config_data["neo4j"]["NEO4J_PORT"]
# neo4j Bolt port (for driver connections)
NEO4J_PORT = config_data["neo4j"]["WS_PORT"]
# Web application port
WEB_PORT = config_data["logontracer"]["WEB_PORT"]
# Web application address
WEB_HOST = config_data["logontracer"]["WEB_HOST"]
# Flag for SESSION_COOKIE_SECURE
USE_HTTPS = config_data["logontracer"]["SESSION_COOKIE_SECURE"]
# Websocket port
WS_PORT = config_data["neo4j"]["WS_PORT"]
# Elastic Search server
ES_SERVER = config_data["elastic"]["ES_SERVER"]
# Elastic index
ES_INDEX = config_data["elastic"]["ES_INDEX"]
# Elastic prefix
ES_PREFIX = config_data["elastic"]["ES_PREFIX"]
# Elastic auth user
ES_USER = config_data["elastic"]["ES_USER"]
# logontracer default user
default_user = config_data["logontracer"]["default_user"]
# logontracer default password
default_password = config_data["logontracer"]["default_password"]
# logontracer user info database
database_name = config_data["logontracer"]["database_name"]
# Default neo4j database name
CASE_NAME = config_data["logontracer"]["default_case"]
# Sigma rules url
SIGMA_URL = config_data["sigma"]["git_url"]
# Sigma scan result file
SIGMA_RESULTS_FILE = config_data["sigma"]["results"]
if args.user:
NEO4J_USER = args.user
if args.password:
NEO4J_PASSWORD = args.password
if args.server:
NEO4J_SERVER = args.server
if args.port:
WEB_PORT = args.port
if args.host:
WEB_HOST = args.host
if args.wsport:
WS_PORT = args.wsport
if args.esserver:
ES_SERVER = args.esserver
if args.esindex:
ES_INDEX = args.esindex
if args.esprefix:
ES_PREFIX = args.esprefix
if args.esuser:
ES_USER = args.esuser
if args.espassword:
ES_PASSWORD = args.espassword
if args.escafile:
ES_CAFILE = args.escafile
if args.case:
CASE_NAME = args.case
# Setup login user
app.config["SESSION_COOKIE_SECURE"] = USE_HTTPS
app.config["SESSION_COOKIE_HTTPONLY"] = True
app.config["SESSION_COOKIE_SAMESITE"] = "Lax"
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///" + database_name
# Persist SECRET_KEY across restarts
_secret_key_file = os.path.join(FPATH, '.secret_key')
if os.path.exists(_secret_key_file):
with open(_secret_key_file, 'rb') as _f:
_secret_key = _f.read()
else:
_secret_key = os.urandom(32)
with open(_secret_key_file, 'wb') as _f:
_f.write(_secret_key)
os.chmod(_secret_key_file, 0o600)
app.config["SECRET_KEY"] = _secret_key
app.permanent_session_lifetime = datetime.timedelta(minutes=60)
# Initialize SQLAlchemy
db = SQLAlchemy()
db.init_app(app)
# Server-side credential cache (opaque token in session, credentials in memory)
_cred_cache = {}
_cred_cache_lock = threading.Lock()
def store_neo4j_creds(username, password):
"""Store Neo4j credentials server-side; save only opaque key in session."""
cache_key = secrets.token_urlsafe(32)
expires = utc_now() + datetime.timedelta(minutes=60)
with _cred_cache_lock:
_cred_cache[cache_key] = {"username": username, "password": password, "expires": expires}
session["neo4j_cache_key"] = cache_key
def get_neo4j_creds():
"""Retrieve Neo4j credentials from server-side cache."""
cache_key = session.get("neo4j_cache_key")
if not cache_key:
return None, None
with _cred_cache_lock:
entry = _cred_cache.get(cache_key)
if entry is None:
return None, None
if entry["expires"] < utc_now():
_cred_cache.pop(cache_key, None)
return None, None
return entry["username"], entry["password"]
def invalidate_neo4j_creds():
"""Remove credentials from server-side cache on logout."""
cache_key = session.get("neo4j_cache_key")
if cache_key:
with _cred_cache_lock:
_cred_cache.pop(cache_key, None)
session.pop("neo4j_cache_key", None)
# Initialize CSRF protection
csrf = CSRFProtect(app)
@app.after_request
def set_csrf_cookie(response):
response.set_cookie('csrf_token', generate_csrf(), samesite='Lax')
return response
@app.after_request
def set_security_headers(response):
"""Add security headers to every response."""
response.headers['X-Content-Type-Options'] = 'nosniff'
response.headers['X-Frame-Options'] = 'DENY'
response.headers['X-XSS-Protection'] = '1; mode=block'
response.headers['Referrer-Policy'] = 'strict-origin-when-cross-origin'
if USE_HTTPS:
response.headers['Strict-Transport-Security'] = 'max-age=31536000; includeSubDomains'
# Content-Security-Policy: allow inline scripts (required for current templates),
# CDN resources (Bootstrap, jQuery, Cytoscape, Chart.js, DataTables, Font Awesome, etc.),
# and Neo4j bolt connections via connect-src
_cdn = (
"https://cdn.jsdelivr.net "
"https://cdnjs.cloudflare.com "
"https://ajax.googleapis.com "
"https://cdn.datatables.net "
"https://maxcdn.bootstrapcdn.com "
"https://use.fontawesome.com"
)
response.headers['Content-Security-Policy'] = (
"default-src 'self'; "
"script-src 'self' 'unsafe-inline' 'unsafe-eval' " + _cdn + "; "
"style-src 'self' 'unsafe-inline' " + _cdn + "; "
"img-src 'self' data: blob:; "
"font-src 'self' data: " + _cdn + "; "
"connect-src 'self' bolt: bolts: bolt+ssc: wss: ws:; "
"frame-ancestors 'none'"
)
return response
# Initialize rate limiter
if has_flask_limiter:
limiter = Limiter(
get_remote_address,
app=app,
default_limits=[],
storage_uri="memory://"
)
else:
# No-op limiter stub when flask-limiter is not installed
class _NoopLimiter:
def limit(self, *args, **kwargs):
return lambda f: f
limiter = _NoopLimiter()
# Initialize LoginManager
login_manager = LoginManager()
login_manager.init_app(app)
# Define User model
class User(UserMixin, db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(50), nullable=False, unique=True)
urole = db.Column(db.String(20))
def __init__(self, username, urole):
self.username = username
self.urole = urole
def get_id(self):
return self.id
def get_username(self):
return self.username
def get_urole(self):
return self.urole
class SettingForm(FlaskForm):
password1 = PasswordField('Password', validators=[DataRequired(), EqualTo('password2', message='Passwords must match.'), Length(min=3, max=20)])
password2 = PasswordField('Password (again)', validators=[DataRequired(), Length(min=3, max=20)])
class LoginForm(FlaskForm):
username = StringField('Username', validators=[
DataRequired(),
Length(min=3, max=50),
Regexp(r'^[a-zA-Z0-9_-]+$',
message='Username can only contain letters, numbers, underscores, and hyphens.')
])
password = PasswordField('Password', validators=[DataRequired(), Length(min=3, max=20)])
class RegistrationForm(FlaskForm):
username = StringField('Username', validators=[
DataRequired(),
Length(min=3, max=50),
Regexp(r'^[a-zA-Z0-9_-]+$',
message='Username can only contain letters, numbers, underscores, and hyphens.')
])
password1 = PasswordField('Password', validators=[DataRequired(), EqualTo('password2', message='Passwords must match.'), Length(min=3, max=20)])
password2 = PasswordField('Password (again)', validators=[DataRequired(), Length(min=3, max=20)])
def validate_username(self, username):
user = User.query.filter_by(username=username.data).first()
if user is not None:
raise ValidationError('This username is already registered.')
class CaseForm(FlaskForm):
case = StringField('Case', validators=[DataRequired()])
class AISettingForm(FlaskForm):
ai_enabled = BooleanField('Enable AI Analysis')
openai_api_key = StringField('OpenAI API Key', validators=[Optional()])
openai_model = SelectField('OpenAI Model',
choices=[('gpt-5', 'GPT-5'),
('gpt-5-mini', 'GPT-5 Mini'),
('gpt-5.1', 'GPT-5.1'),
('gpt-5.2', 'GPT-5.2'),
('gpt-5.4', 'GPT-5.4'),
('gpt-5.4-mini', 'GPT-5.4 Mini'),],
default='gpt-5-mini')
max_completion_tokens = IntegerField('Max Completion Tokens', default=8000, validators=[Optional()])
temperature = FloatField('Temperature', default=1, validators=[Optional()])
agent_max_iterations = IntegerField('Agent Max Iterations', default=10, validators=[Optional()])
response_language = SelectField('Response Language',
choices=[('en', 'English'),
('ja', '日本語 (Japanese)'),
('fr', 'Français (French)')],
default='en')
class AISetting(db.Model):
id = db.Column(db.Integer, primary_key=True)
ai_enabled = db.Column(db.Boolean, default=True) # default Enable
openai_api_key = db.Column(db.String(255), nullable=True)
openai_model = db.Column(db.String(50), default='gpt-5-mini')
max_completion_tokens = db.Column(db.Integer, default=8000)
temperature = db.Column(db.Float, default=1)
agent_max_iterations = db.Column(db.Integer, default=10)
response_language = db.Column(db.String(10), default='en') # Language for AI responses
created_at = db.Column(db.DateTime, default=utc_now_naive)
updated_at = db.Column(db.DateTime, default=utc_now_naive, onupdate=utc_now_naive)
# Initialize database tables and default user
with app.app_context():
db.create_all()
user_query = User.query.filter_by(username=default_user).first()
if user_query is None:
create_user = User(username=default_user, urole="ADMIN")
db.session.add(create_user)
db.session.commit()
@login_manager.user_loader
def load_user(user_id):
return db.session.get(User, int(user_id))
@login_manager.unauthorized_handler
def unauthorized():
return redirect('/login')
# Web application logging decorater
def http_request_logging(f):
@wraps(f)
def decorated_function(*args, **kwargs):
try:
app.logger.info('%s - %s - %s - %s', request.remote_addr, request.method, request.url, request.query_string)
except Exception as e:
app.logger.exception(e)
pass
return f(*args, **kwargs)
return decorated_function
def is_safe_path(base_dir, user_path):
"""
Validate that a user-provided path is within the allowed base directory.
Args:
base_dir: The allowed base directory (absolute path)
user_path: The user-provided path to validate
Returns:
bool: True if the path is safe, False otherwise
"""
# Resolve both paths to absolute, normalized paths
base_dir = os.path.realpath(base_dir)
full_path = os.path.realpath(os.path.join(base_dir, user_path))
# Check if the resolved path is within the base directory
return full_path.startswith(base_dir + os.sep) or full_path == base_dir
def sanitize_filename(filename, file_type=None):
"""
Sanitize a filename. Only allows alphanumeric characters and safe punctuation.
Args:
filename: The filename to sanitize
file_type: Optional file type restriction ('evtx', 'xml', etc.)
Returns:
tuple: (sanitized_filename or None, error_message or None)
"""
if not filename or not isinstance(filename, str):
return None, "Filename is required"
# Check length limit
if len(filename) > 255:
return None, "Filename too long (max 255 characters)"
dangerous_patterns = ['..', '\x00', '\n', '\r', '\t', '/', '\\', '|', ';', '&', '$', '`', '>', '<', '\'', '"']
for pattern in dangerous_patterns:
if pattern in filename:
return None, f"Filename contains forbidden characters"
# Whitelist check on ORIGINAL input: Only allow alphanumeric, dash, underscore, dot, and space
if not ALLOWED_FILENAME_PATTERN.match(filename):
return None, "Filename contains invalid characters (only alphanumeric, dash, underscore, dot, and space allowed)"
# Now safe to use basename (should be same as input since no path separators allowed)
filename = os.path.basename(filename)
# Check for empty filename after basename
if not filename:
return None, "Invalid filename"
# Check for file type restriction
if file_type:
if file_type.lower() == 'evtx':
if not ALLOWED_EVTX_FILENAME_PATTERN.match(filename):
return None, "Only .evtx files are allowed"
elif file_type.lower() == 'xml':
if not filename.lower().endswith('.xml'):
return None, "Only .xml files are allowed"
# Prevent hidden files (starting with dot)
if filename.startswith('.'):
return None, "Hidden files are not allowed"
return filename, None
def validate_relative_path(path, allowed_prefixes=None):
"""
Validate a relative path for security.
Uses whitelist approach - only allows specific characters.
Args:
path: The path to validate
allowed_prefixes: List of allowed path prefixes (e.g., ['sigma', 'upload'])
Returns:
tuple: (is_valid, error_message)
"""
if not path or not isinstance(path, str):
return False, "Path is required"
# Check length limit
if len(path) > 500:
return False, "Path too long (max 500 characters)"
# Check for null bytes and control characters
if '\x00' in path or any(ord(c) < 32 for c in path):
return False, "Invalid characters in path"
# Reject parent directory references
if '..' in path:
return False, "Directory traversal not allowed"
# Check for absolute paths
if path.startswith('/') or (len(path) > 1 and path[1] == ':'):
return False, "Absolute paths not allowed"
# Whitelist: Only allow alphanumeric, underscore, dash, dot, and forward slash
if not ALLOWED_PATH_PATTERN.match(path):
return False, "Path contains invalid characters (only alphanumeric, underscore, dash, dot, and slash allowed)"
# Check for double slashes
if '//' in path:
return False, "Invalid path format"
# Check allowed prefixes if specified
if allowed_prefixes:
if not any(path == prefix or path.startswith(prefix + '/') for prefix in allowed_prefixes):
return False, f"Path must start with one of: {', '.join(allowed_prefixes)}"
return True, None
def validate_input_string(value, field_name, max_length=200, allowed_pattern=None):
"""
Generic input validation for string values.
Args:
value: The input value to validate
field_name: Name of the field (for error messages)
max_length: Maximum allowed length