Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/UHH-ISS/honeygrove

A multi-purpose, modular medium-interaction honeypot based on Twisted.
https://github.com/UHH-ISS/honeygrove

broker cybersecurity honeypot twisted

Last synced: 2 months ago
JSON representation

A multi-purpose, modular medium-interaction honeypot based on Twisted.

Lists

README

        

![Honeygrove](https://raw.githubusercontent.com/wiki/UHH-ISS/honeygrove/img/honeygrove_logo_v2.png)

Honeygrove is a modular honeypot based on Python that builds upon [Broker](https://github.com/zeek/broker) and the [Twisted Framework](https://twistedmatrix.com/trac/wiki).

## System Requirements

Honeygrove currently requires **Python 3.5+** and was tested on Ubuntu 16.4, Debian 9.1 and ArchLinux. However it should work on other distributions that provide a compatible Python distribution.
If the [`broker`](https://github.com/zeek/broker) communication library is not available, the honeypot itself can be used without it. Currently there is no possibility to communicate with the management-console or the monitoring stack without Broker.
If Honeygrove is configured to use the Siemens S7 protocol, the [`Snap7`](http://snap7.sourceforge.net/) library needs to be installed on the system.

## Quickstart Guide

* Clone the repository or download and unzip it
* Optional: Setup a virtualenv to contain the required dependencies
```shell
$ python3 -m venv .venv
$ source .venv/bin/activate
```
* Install the required python dependencies
```shell
$ pip3 install --upgrade -r requirements.txt
```
* Optional: Install [`broker`](https://github.com/zeek/broker) and the python bindings to communicate with a CIM
* Optional: Install [`Snap7`](http://snap7.sourceforge.net/) to make use of the Siemens S7 protocol
* Create the honeygrove main directory and some required subdirectories
```shell
$ mkdir -p /var/honeygrove/{logs,resources/{quarantine,honeytoken_files}}
```
* Copy the provided example resources to the main directory
```shell
$ cp -a resources /var/honeygrove
```
* Edit the configuration file to fit your needs
```shell
$ $EDITOR honeygrove/config.py
```
* Start honeygrove and verify everything works as expected
```shell
$ sudo python3 -m honeygrove
```

For further information see our [wiki](https://github.com/UHH-ISS/honeygrove/wiki) (currently only the user guide for honeygrove is available in english).

## Related Projects

Honeygrove is intended to be used with a Cyber Incident Monitor (CIM) ([honeygrove-cim](https://github.com/UHH-ISS/honeygrove-cim)) and can additionally be controlled through a management console ([honeygrove-console](https://github.com/UHH-ISS/honeygrove-console)) that communicates with honeygrove via `broker`.

## License

Honeygrove is licensed under the MIT license. See LICENSE for more details.