Skip to content

Commit

Permalink
Cleaned up readme (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
josephlewis42 authored Dec 21, 2023
1 parent f676f3f commit 68abab3
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Honey SSH
# 🍯 HoneySSH

A medium-interaction honeypot in the spirit of
[Kippo](https://www.honeynet.org/projects/old/kippo/).
HoneySSH is a medium interaction honeypot that provides attackers a fully simulated
Linux shell to play in.

All commands are simulated and run in a per-session sandbox that's destroyed on
disconnect.

Features include:

* Interactive shell with 50+ built-in commands
* Download saving (via `scp` and `wget`)
* Session recording and playback
* Custom base file systems
* In-memory interactive file system
* Report generator
* Machine-readable JSON log
* A relistic interactive shell.
* 50+ built-in POSIX commands.
* Payloads are captured with the fake `scp`, `wget` and `curl` commands for later analysis.
* Asciicast compatible session keystroke recording and playback.
* In-memory interactive file system.
* Reporting capabilities.
* Machine-readable JSON event log.

## Documentation

Expand Down Expand Up @@ -115,3 +118,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).

Additional licenses can be found in the `third_party/` and `vendor/`
directories.

## Credits

* Inspired by the now defunct [Kippo](https://www.honeynet.org/projects/old/kippo/) project.

0 comments on commit 68abab3

Please sign in to comment.