https://github.com/edoardottt/boggart
Highly customizable low-interaction experimental honeypot that mimics specific hosts.
https://github.com/edoardottt/boggart
attack-detection blue-team brute-force cyber-defense defense defensive-security dos-attack hacktoberfest honeypot honeypot-http honeypots log-analysis network network-analysis network-security network-security-monitoring security security-tools web-security
Last synced: 2 months ago
JSON representation
Highly customizable low-interaction experimental honeypot that mimics specific hosts.
- Host: GitHub
- URL: https://github.com/edoardottt/boggart
- Owner: edoardottt
- License: gpl-3.0
- Created: 2022-04-05T15:49:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T10:04:19.000Z (3 months ago)
- Last Synced: 2025-03-16T04:23:58.115Z (2 months ago)
- Topics: attack-detection, blue-team, brute-force, cyber-defense, defense, defensive-security, dos-attack, hacktoberfest, honeypot, honeypot-http, honeypots, log-analysis, network, network-analysis, network-security, network-security-monitoring, security, security-tools, web-security
- Language: Go
- Homepage: https://edoardottt.com/
- Size: 424 KB
- Stars: 32
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# boggart
Highly customizable low-interaction experimental honeypot that mimics specific hosts.
*'So, the first question we must ask ourselves is, what is a Boggart?'*
Hermione put up her hand.
*'It's a shape-shifter'*, she said. *'It can take the shape of whatever it think will frighten us most'*.
*'Couldn't have put it better myself'*, said Professor Lupin, and Hermione glowed.
*'So the Boggart sitting in the darkness within has not yet assumed a form. He does not yet know what will frighten the person on the other side of the door. Nobody knows what a Boggart looks like when he is alone, but when I let him out, he will immediately become whatever each of us most fears'*.
Harry Potter and the Prisoner of Azkaban
Installation 📡
-------
> *Disclaimer*: This is an ongoing and experimental project: there are features not yet available and features not (fully) tested. It is designed for home labs / home environments, not for professional or industrial purposes. Deploy in your network at your own risk.
[Docker](https://docs.docker.com/get-docker/) and [Docker compose](https://docs.docker.com/compose/install/) are needed.
```console
git clone https://github.com/edoardottt/boggart
```
Usage 💻
-------
- Edit the configuration file `config.yaml` setting up the machine you want to create
- Execute `make up` (inside the boggart folder)
Now you have three open ports on your local machine:
- [localhost:8092](http://localhost:8092/) - This is the actual honeypot
- [localhost:8093](http://localhost:8093/) - This is the dashboard (do not expose this !)
- [localhost:8094](http://localhost:8094/) - This is the API service (do not expose this !)
You must expose on the public Internet only the service hosted on port 8092.
Read the [docs](https://github.com/edoardottt/boggart/tree/main/docs) to understand how it works and how to configure your honeypot.
Changelog 📌
-------
Detailed changes for each release are documented in the [release notes](https://github.com/edoardottt/boggart/releases).
Contributing 🤝
------
If you want to contribute to this project, you can start opening an [issue](https://github.com/edoardottt/boggart/issues).
Before opening a pull request, download [golangci-lint](https://golangci-lint.run/usage/install/) and run
```bash
golangci-lint run
```
If there aren't errors, go ahead :)
License 📝
-------
This repository is under [GNU General Public License v3.0](https://github.com/edoardottt/boggart/blob/main/LICENSE).
[edoardottt.com](https://edoardottt.com/) to contact me.
Created with [gonesis](https://github.com/edoardottt/gonesis)❤️