Skip to content

Commit

Permalink
Change description
Browse files Browse the repository at this point in the history
  • Loading branch information
XX committed Jul 30, 2018
1 parent e816057 commit d33ff25
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
Rust Keylogger
==============

This is a keylogger for Linux written in Rust, ported from my [original keylogger](https://github.com/gsingh93/simple-key-logger) in C. It works by reading directly from the keyboard device in `/dev/input/`. The keylogger attempts to detect the keyboard device upon startup, but if one cannot be detected or if multiple are detected, you must specify the path to the device file manually.
This is a keylogger for Linux written in Rust, the fork of [original keylogger](https://github.com/gsingh93/keylogger). It works by reading directly from the keyboard device in `/dev/input/`. The keylogger attempts to detect the keyboard device upon startup, but if one cannot be detected or if multiple are detected, you must specify the path to the device file manually.

Only the US keyboard layout is supported. See [input.rs](https://github.com/gsingh93/keylogger/blob/master/src/input.rs) if you are interested in adding mappings for other keyboard layouts.

I am not responsible for how you use this tool.

## Installation
To install Rust, run the following in your terminal, then follow the onscreen instructions.

```
curl https://sh.rustup.rs -sSf | sh
source $HOME/.cargo/env
```

Clone the repository:

```
$ git clone git@github.com:gsingh93/keylogger.git
$ git clone https://github.com/OpenSpaceCommunity/keylogger
$ cd keylogger
```

Expand All @@ -23,12 +27,10 @@ Build the code:
You can run the code with Cargo or directly from the target directory. Note that the keylogger must be run as the root user:

```
$ sudo cargo run --release -- -h
$ sudo ./target/release/keylogger -h
$ sudo ./target/release/keylogger
$ sudo cargo run --release
```

You can move the `keylogger` binary wherever you want. For example, you can put it in `/usr/local/bin` or in any other directory in your path.

## Usage

```
Expand All @@ -43,10 +45,10 @@ Options:
-f --file FILE specify the file to log to
```

If the `-f` flag is not specified, the file `keys.log` is used.
If the `-f` flag is not specified, the file `YYYY-MM-DD.log` is used.

If you would like to run the keylogger in the background, append an `&` to the end of the command. If you would like to run the keylogger as a daemon or at startup, use init script/service manager that comes with your distro. An example `systemd` file is provided.

## License

[MIT](https://github.com/gsingh93/keylogger/blob/master/LICENSE.txt)
[MIT](https://github.com/OpenSpaceCommunity/keylogger/blob/master/LICENSE.txt)

0 comments on commit d33ff25

Please sign in to comment.