Update README.md

This commit is contained in:
Sebastian Lenzlinger 2023-06-13 13:05:00 +02:00 committed by GitHub
parent b59c659553
commit 33eb3c6fb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,6 +5,8 @@ It can detect processes reading from ```/dev/input/event*``` devices and kernel
# Dependencies # Dependencies
* [Python](https://www.python.org/downloads/) * [Python](https://www.python.org/downloads/)
* [SystemTap](https://sourceware.org/systemtap/wiki) * [SystemTap](https://sourceware.org/systemtap/wiki)
* [```fuser```](https://www.man7.org/linux/man-pages/man1/fuser.1.html)
* Utilities that come with [Fedora](https://fedoraproject.org/) like ```which```.
# Setup # Setup
Download or clone this repository: Download or clone this repository:
@ -45,6 +47,12 @@ To run just kernel module detection
``` ```
# ./kernel_detector.py # ./kernel_detector.py
``` ```
# Warning
Running any part if this program in a lightheaded manner may break your system.
Killing processes and unloading modules should be done with caution. We suggest testing it an a VM.
If one runs the KLDetect with the kernel module keylogger detection option set. Make sure to update the [whitelist.txt](https://github.com/sebaschi/keylogger-detector/blob/main/src/whitelist.txt)
with kernel modules that you know you have on your system. Altough KLDetect should not unload any kernel modules currently used, better safe than sorry.
# Developers # Developers
Copyright 2023 [Michel Romancuk](https://github.com/SoulKindred), [Sebastian Lenzlinger](https://github.com/sebaschi) Copyright 2023 [Michel Romancuk](https://github.com/SoulKindred), [Sebastian Lenzlinger](https://github.com/sebaschi)