From ec19a08e6334eb07fd1fce02fe6ca46c7e1972da Mon Sep 17 00:00:00 2001 From: Sebastian Lenzlinger <74497638+sebaschi@users.noreply.github.com> Date: Tue, 13 Jun 2023 12:56:15 +0200 Subject: [PATCH] Upate Readme --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8dfb2b0..6d8e5b8 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,12 @@ It can detect processes reading from ```/dev/input/event*``` devices and kernel # Setup Download or clone this repository: ``` -git clone https://github.com/sebaschi/keylogger-detector.git +$ git clone https://github.com/sebaschi/keylogger-detector.git +``` +Navigate into the src directory: +``` +$ cd keylogger-detector/src ``` - Run a keylogger. KLDetect has been tested and shown to work on the following keylogger. User progams: @@ -23,6 +26,25 @@ User progams: Kernel Module: * [spy](https://github.com/jarun/spy) +# Usage +The programm must be run as root (sudo). + +Running without options just runs userspace detection: +``` +\# ./kldetect.py +``` +To get a list of options: +``` +\# ./kldetect.py -h +``` +To run with kernel module detection: +``` +\# ./kldetect.py -k +``` +To run just kernel module detection +``` +\# ./kernel_detector.py +``` # Developers Copyright 2023 [Michel Romancuk](https://github.com/SoulKindred), [Sebastian Lenzlinger](https://github.com/sebaschi)