Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaned up readme #20

Merged
merged 3 commits into from
Dec 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.