Update keylogger_detector.py

Fix Tabs in help messages

LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Sebastian Lenzlinger
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

doc/dev_journal.md

@@ -177,4 +177,6 @@ All in all, the main functionality works as intended. Basically now would be the
 ## Wednesday, 7, June 2023
 ### Michel
 
+
 I have written 1 systemtap scripts, that can detect, whenever a module registers at the Keyboard-notifier. The Script can currently detect whenever a module registers. My script cant detect which kernel module registered. Here comes Sebastians idea of writing a python script, that can unload all un-known modules and loads them back in, whilst the stap-script is running. Whenever a module is loaded in, and it triggers the stap-script, we know it is tracking key-strokes. Those modules will be shown to the user and the user then has to decide whether to unload and remove them, or keep them. My script is based on a redhat-script. The redhat-script is called funcall_tracer2.stp . The idea behind both scripts is the same. My script is simplyfied for the use with python. 
+

doc/research/acm_2390317.2390326.bib

@@ -0,0 +1,17 @@
+@inproceedings{10.1145/2390317.2390326,
+author = {Howard, Adam and Hu, Yi},
+title = {An Approach for Detecting Malicious Keyloggers},
+year = {2012},
+isbn = {9781450315388},
+publisher = {Association for Computing Machinery},
+address = {New York, NY, USA},
+url = {https://doi.org/10.1145/2390317.2390326},
+doi = {10.1145/2390317.2390326},
+abstract = {Keyloggers are applications that are installed onto computers with the intent of monitoring and storing keystrokes that are input by a user. These keystrokes can either be stored on a physical hard disk or transmitted via a network connection to a remote location. Because of their functions, keyloggers have a potential of being used for malicious purposes. In order to protect privacy, it is important to realize the threat that a keylogger application might pose and identify appropriate methods for detecting it. The method presented in this research provides a standardized approach to detect unknown keylogging software from a computer. We also conducted experiments on a variety of keyloggers to verify the effectiveness of the proposed approach.},
+booktitle = {Proceedings of the 2012 Information Security Curriculum Development Conference},
+pages = {53–56},
+numpages = {4},
+keywords = {rootkit, privacy, system hook, keylogger, malicious software},
+location = {Kennesaw, Georgia},
+series = {InfoSecCD '12}
+}

doc/research/acm_financial_losses_due_to_malware.bib

@@ -0,0 +1,17 @@
+@inproceedings{10.1145/2905055.2905362,
+author = {Amin, Maitri},
+title = {A Survey of Financial Losses Due to Malware},
+year = {2016},
+isbn = {9781450339629},
+publisher = {Association for Computing Machinery},
+address = {New York, NY, USA},
+url = {https://doi.org/10.1145/2905055.2905362},
+doi = {10.1145/2905055.2905362},
+abstract = {General survey stat that the main damage malware can cause is to slow down their PCs and perhaps crash some websites which is quite wrong, The Russian antivirus software developer teamed up with B2B International for a study worldwide recently, shown 36\% of users lose money online as a result of a malware attack. Currently malware can't be detected by traditional way based anti-malware tools due to their polymorphic and/or metamorphic nature. Here we have improvised a current detection technique of malware based on mining Application Programming Interface (API) calls and developed the first public dataset to promote malware research.• In survey of cyber-attacks 6.2\% financial attacks are due to malware which increase to 1.3 \% in 2013 compared to 2012.• Financial data theft causes 27.6\% to reach 28,400,000. Victims abused by this targeting malware countered 3,800,000, which is 18.6\% greater than previous year.• Finance-committed malware, associated with Bitcoin has demonstrated the most dynamic development. Where's, Zeus is still top listed for playing important roles to steal banking credentials.Solutionary study stats that companies are spending a staggering amount of money in the aftermath of damaging attack: DDoS attacks recover $6,500 per hour from malware and more than $3,000 each time for up to 30 days to moderate and improve from malware attacks. [1]},
+booktitle = {Proceedings of the Second International Conference on Information and Communication Technology for Competitive Strategies},
+articleno = {145},
+numpages = {4},
+keywords = {Malware, API, financial losses, Survey},
+location = {Udaipur, India},
+series = {ICTCS '16}
+}

doc/research/acm_risk_of_stolen_credentials.bib

@@ -0,0 +1,17 @@
+@inproceedings{10.1145/3133956.3134067,
+author = {Thomas, Kurt and Li, Frank and Zand, Ali and Barrett, Jacob and Ranieri, Juri and Invernizzi, Luca and Markov, Yarik and Comanescu, Oxana and Eranti, Vijay and Moscicki, Angelika and Margolis, Daniel and Paxson, Vern and Bursztein, Elie},
+title = {Data Breaches, Phishing, or Malware? Understanding the Risks of Stolen Credentials},
+year = {2017},
+isbn = {9781450349468},
+publisher = {Association for Computing Machinery},
+address = {New York, NY, USA},
+url = {https://doi.org/10.1145/3133956.3134067},
+doi = {10.1145/3133956.3134067},
+abstract = {In this paper, we present the first longitudinal measurement study of the underground ecosystem fueling credential theft and assess the risk it poses to millions of users. Over the course of March, 2016--March, 2017, we identify 788,000 potential victims of off-the-shelf keyloggers; 12.4 million potential victims of phishing kits; and 1.9 billion usernames and passwords exposed via data breaches and traded on blackmarket forums. Using this dataset, we explore to what degree the stolen passwords---which originate from thousands of online services---enable an attacker to obtain a victim's valid email credentials---and thus complete control of their online identity due to transitive trust. Drawing upon Google as a case study, we find 7--25\% of exposed passwords match a victim's Google account. For these accounts, we show how hardening authentication mechanisms to include additional risk signals such as a user's historical geolocations and device profiles helps to mitigate the risk of hijacking. Beyond these risk metrics, we delve into the global reach of the miscreants involved in credential theft and the blackhat tools they rely on. We observe a remarkable lack of external pressure on bad actors, with phishing kit playbooks and keylogger capabilities remaining largely unchanged since the mid-2000s.},
+booktitle = {Proceedings of the 2017 ACM SIGSAC Conference on Computer and Communications Security},
+pages = {1421–1434},
+numpages = {14},
+keywords = {keylogger, phishing, risk analysis, data breach, password reuse, authentication, phishing kit, password},
+location = {Dallas, Texas, USA},
+series = {CCS '17}
+}

doc/research/citation-strange-world-keyloggers.bib

@@ -0,0 +1,10 @@
+@article{article,
+author = {Creutzburg, Reiner},
+year = {2017},
+month = {01},
+pages = {139-148},
+title = {The strange world of keyloggers - an overview, Part I},
+volume = {2017},
+journal = {Electronic Imaging},
+doi = {10.2352/ISSN.2470-1173.2017.6.MOBMU-313}
+}

src/config.json

@@ -1,8 +1,8 @@
 {
     "white_listed_programs": [
         "systemd_logind",
-        "gnome-shell",
+        "systemd",
-        "systemd"
+        "gnome-shell"
     ],
     "auto_kill_programs": [],
     "kbd_names": [

src/funcall_trace.stp

@@ -0,0 +1,7 @@
+
+probe kernel.function("register_keyboard_notifier").call
+	{
+		print("[-]")
+		exit()
+	}
+

src/kernel_detector.py

@@ -0,0 +1,184 @@
+#!/usr/bin/env python3
+
+import subprocess
+import time
+import multiprocessing
+
+import threading
+
+import os
+import sys
+from io import TextIOWrapper, BytesIO
+
+pipe1, pipe2 = multiprocessing.Pipe()
+
+#==============================================================================================================
+#
+#Functions
+#
+#==============================================================================================================
+def list_modules(command):
+	result = subprocess.run(command, shell = True, capture_output=True, text=True)
+	
+	if result.returncode == 0:
+		return result.stdout.strip().split('\n')
+	else:
+		print(f"Failed with error:{result.stderr}")
+		return[]
+
+def get_whitelist(file_path):
+	try:
+		with open(file_path, 'r') as file:
+			lines = file.read().splitlines()
+			return lines
+	except IOError:
+		print(f'Error: Failed to load whitelist{file_path}')
+		
+def compare_mods(A, B):
+	setA = set(A)
+	setB = set(B)
+	
+	result = setB - setA
+	
+	return list(result)
+	
+def tidy_up(entries):
+	cleaned_entries = []
+	for entry in entries:
+		modules = entry.split()
+		if modules:
+			first_mod = modules[0]
+			cleaned_entries.append(first_mod)
+	return cleaned_entries
+			
+def unload_mod(modules):
+	tmp = []
+	for module in modules:
+		result = subprocess.run(['sudo','rmmod', module],capture_output = True, text = True)
+		if result.returncode == 0:
+			print(f"Unloaded module: {module}")
+		else:
+			print(f"Failed to unloaded module: {module}")
+			tmp.append(module)
+			print(result.stderr)
+	result_out = compare_mods(tmp, modules)
+	print(result_out)
+	return result_out
+			
+
+
+
+
+def stap_start():
+	print("starting sniffing")
+	process = subprocess.Popen(['stap','funcall_trace.stp', '-T', '15'], flush = True)
+	process.wait()
+	print("ended sniffing")
+
+	
+def load_mod(module):
+	print(module)
+	for i in range(2):
+		subprocess.Popen(['sudo','insmod', module])
+		time.sleep(1)
+		subprocess.Popen(['sudo','rmmod', module])
+		time.sleep(1)
+	subprocess.Popen(['sudo', 'insmod', module])
+	
+	
+def find_file(filename):
+    result = []
+    for root, dirs, files in os.walk("/"):
+        if filename in files:
+            file_path = os.path.join(root, filename)
+            result.append(file_path)
+    result_out = result
+    result_out = ''.join(result_out)
+    return result_out
+	
+def getpath(sus_modules):
+	for i in range(len(sus_modules)):
+		sus_modules[i] = find_file(sus_modules[i] + ".ko")
+	return sus_modules
+	
+def detect_logger(module):
+
+	
+	
+	print("starting sniffing")
+	process = subprocess.Popen(['stap','funcall_trace.stp', '-T', '10'], stdout=subprocess.PIPE, text=True)
+
+
+	for i in range(2):
+		subprocess.Popen(['sudo','insmod', module])
+		time.sleep(1)
+		print("-")
+		subprocess.Popen(['sudo','rmmod', module])
+		time.sleep(1)
+	subprocess.Popen(['sudo','insmod', module])
+	print("-")
+	out = process.communicate()[0]
+
+	
+
+
+	print("ended sniffing")
+
+	print(out)
+	if out == "[-]":
+		return module
+	print("FAILED")
+	return 0
+
+
+
+#==============================================================================================================
+#
+#Work
+#
+#==============================================================================================================
+
+whitelist = get_whitelist("whitelist.txt")
+
+lsmod_output = list_modules("lsmod");
+
+sus_modules = compare_mods(whitelist, lsmod_output)
+
+sus_modules = tidy_up(sus_modules)
+
+sus_modules = unload_mod(sus_modules)
+time.sleep(1)
+
+sus_modules = getpath(sus_modules)
+print(sus_modules)
+if len(sus_modules) == 0:
+    print("nothing to do")
+    print("ALL CLEAN")
+    
+
+
+suspects = []
+for module in sus_modules:
+    suspects.append(detect_logger(module))
+    time.sleep(1)
+
+
+
+print("Following modules are logging your keystrokes: ")
+for i in range(len(suspects)):
+    print( f"[{i}] {suspects[i]}")
+print("Enter the number of the module you want to remove: ")
+user_input = input().split()
+for j in user_input:
+    to_remove = suspects[int(j)]
+    subprocess.Popen(['sudo','rmmod', to_remove])
+    print(f"Removed {to_remove}")
+print("Finished")
+	
+	
+
+
+
+
+
+

src/keylogger_detector.py

@@ -3,6 +3,7 @@
 import sys
 from config import CONFIG_FILE, load_config, save_config
 from utils import (
+    check_platform,
     check_root,
     check_packages,
     get_keyboard_device_files,
@@ -21,6 +22,8 @@ safe_option = False
 add_white_list_option = False
 add_black_list_option = False
 debug_option = False
+kernel_detection_option = False
+
 
 # Functions
 def debug(option, to_print):
@@ -34,9 +37,10 @@ def print_help():
     print('  -v, --verbose\t\t\tVerbose mode. Informative information will be displayed duting execution')
     print('  -a, --auto-kill\t\tAutomatically kill blacklisted processes')
     print('  -s, --safe\t\t\tSafe mode. Asked to confirm before killing a process')
-    print('  -w, --add-white-list\t\t\tActivate prompt to add program names to the whitelist') #For some reason this line gets messed up in display 
+    print('  -w, --add-white-list\t\tActivate prompt to add program names to the whitelist') #For some reason this line gets messed up in display 
-    print('  -b, --add-black-list\t\t\tAutomatically add program names chosen to kill to the blacklist')
+    print('  -b, --add-black-list\t\tAutomatically add program names chosen to kill to the blacklist')
     print('  -d, --debug\t\t\tDebug mode. Print debug statements')
+    print(' -k, --kernel-detection\t\tRun the kernel keylogger detector, too. CURRENTLY NOT IMPLEMENTED TO DIRECTLY RUN KERNEL DETECTOR.')
 
 def set_input_options():
     """
@@ -49,7 +53,7 @@ def set_input_options():
     """
 
     global auto_kill_option, verbose_option, safe_option, add_white_list_option
-    global debug_option, add_black_list_option
+    global debug_option, add_black_list_option, kernel_detection_option
     if len(sys.argv) > 1:
         for arg in sys.argv[1:]:
             print(arg)
@@ -68,6 +72,8 @@ def set_input_options():
                 add_black_list_option = True
             elif arg == '-d' or arg == '--debug':
                 debug_option = True
+            elif arg == '-k' or arg == '--kernel-detection':
+                kernel_detection_option = True
    
 
 def confirm_kill_procces(process_name, times=0):
@@ -113,8 +119,9 @@ def detect_keyloggers():
     # 1. Setup and initialization
     ############################   
     debug(True, str(sys.argv)) # Set manually to debug if args are being read
-    global auto_kill_option, verbose_option, safe_option
+    check_platform()
-    global CONFIG_FILE
+
+    global auto_kill_option, verbose_option, safe_option, add_white_list_option, kernel_detection_option, debug_option
     set_input_options()
     if verbose_option:
         print('[Verbose] Input options set')
@@ -203,7 +210,8 @@ def detect_keyloggers():
     ############################
     if len(suspicious_processes) == 0:
         print("[+] No suspicious processes found")
-        sys.exit(0)
+        if not kernel_detection_option:
+            exit(0)
 
     ############################
     # 7. Prompt user to chose which processes (not covered by auto kill if set) to kill
@@ -282,6 +290,10 @@ def detect_keyloggers():
     
     print('[+] Program completed. Exiting.')
 
+
+    debug(debug_option, 'Kernel detection option: ' + str(kernel_detection_option))
+
+
 if __name__ == '__main__':
     detect_keyloggers()
     

src/utils.py

@@ -3,6 +3,20 @@ import subprocess # for executing shell commands
 import signal # for sending signals to processes
 import sys # for exit
 
+
+
+
+def check_platform():
+    """
+    Check if platform is Linux.
+
+    Raises:
+        SystemExit: If the platform isn not LInux.
+    """
+    if sys.platform != 'linux':
+        print("[-] This script only works on Linux.")
+
+
 def check_root():
     """
     Check if script is run as root(sudo).

src/whitelist.txt

@@ -0,0 +1,68 @@
+Module                  Size  Used by
+uinput                 20480  0
+isofs                  65536  1
+snd_seq_dummy          16384  0
+snd_hrtimer            16384  1
+vboxvideo              36864  0
+drm_vram_helper        24576  1 vboxvideo
+nf_conntrack_netbios_ns    16384  1
+nf_conntrack_broadcast    16384  1 nf_conntrack_netbios_ns
+nft_fib_inet           16384  1
+nft_fib_ipv4           16384  1 nft_fib_inet
+nft_fib_ipv6           16384  1 nft_fib_inet
+nft_fib                16384  3 nft_fib_ipv6,nft_fib_ipv4,nft_fib_inet
+nft_reject_inet        16384  6
+nf_reject_ipv4         16384  1 nft_reject_inet
+nf_reject_ipv6         24576  1 nft_reject_inet
+nft_reject             16384  1 nft_reject_inet
+nft_ct                 24576  16
+nft_chain_nat          16384  3
+nf_nat                 65536  1 nft_chain_nat
+nf_conntrack          192512  4 nf_nat,nft_ct,nf_conntrack_netbios_ns,nf_conntrack_broadcast
+nf_defrag_ipv6         24576  1 nf_conntrack
+nf_defrag_ipv4         16384  1 nf_conntrack
+ip_set                 65536  0
+nf_tables             352256  237 nft_ct,nft_reject_inet,nft_fib_ipv6,nft_fib_ipv4,nft_chain_nat,nft_reject,nft_fib,nft_fib_inet
+nfnetlink              20480  3 nf_tables,ip_set
+rfkill                 40960  3
+qrtr                   57344  4
+sunrpc                815104  1
+snd_intel8x0           57344  2
+snd_ac97_codec        200704  1 snd_intel8x0
+binfmt_misc            28672  1
+intel_rapl_msr         20480  0
+ac97_bus               16384  1 snd_ac97_codec
+intel_rapl_common      36864  1 intel_rapl_msr
+snd_seq               106496  7 snd_seq_dummy
+snd_seq_device         16384  1 snd_seq
+snd_pcm               184320  2 snd_intel8x0,snd_ac97_codec
+rapl                   24576  0
+snd_timer              53248  3 snd_seq,snd_hrtimer,snd_pcm
+snd                   143360  12 snd_seq,snd_seq_device,snd_intel8x0,snd_timer,snd_ac97_codec,snd_pcm
+joydev                 28672  0
+soundcore              16384  1 snd
+pcspkr 		       16453  0
+i2c_piix4              36864  0
+vboxguest              53248  6
+loop                   40960  0
+zram                   32768  2
+crct10dif_pclmul       16384  1
+crc32_pclmul           16384  0
+crc32c_intel           24576  3
+polyval_generic        16384  0
+vmwgfx                458752  2
+ghash_clmulni_intel    16384  0
+drm_ttm_helper         16384  3 vmwgfx,drm_vram_helper,vboxvideo
+sha512_ssse3           49152  0
+e1000                 188416  0
+ttm                   102400  3 vmwgfx,drm_vram_helper,drm_ttm_helper
+serio_raw              20480  0
+video                  73728  0
+wmi                    45056  1 video
+ata_generic            16384  0
+pata_acpi              16384  0
+ip6_tables             40960  0
+ip_tables              40960  0
+fuse                  212992  5
+end
+