edoardottt / boggart Goto Github PK

View Code? Open in Web Editor NEW

27.0 4.0 4.0 363 KB

Highly customizable low-interaction experimental honeypot that mimics specific hosts.

Home Page: https://edoardoottavianelli.it

License: GNU General Public License v3.0

Go 79.57% Dockerfile 0.64% HTML 16.70% Shell 1.31% Makefile 0.63% CSS 0.19% JavaScript 0.96%

honeypot honeypots blue-team defense defensive-security network security cyber-defense honeypot-http network-analysis

boggart's Introduction

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 and Docker compose are needed.

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 - This is the actual honeypot
localhost:8093 - This is the dashboard (do not expose this !)
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 to understand how it works and how to configure your honeypot.

Changelog 📌

Detailed changes for each release are documented in the release notes.

Contributing 🤝

If you want to contribute to this project, you can start opening an issue.

Before opening a pull request, download golangci-lint and run

golangci-lint run

If there aren't errors, go ahead :)

License 📝

This repository is under GNU General Public License v3.0.
edoardoottavianelli.it to contact me.

Created with gonesis❤️

boggart's People

Contributors

Stargazers

Watchers

Forkers

slooppe phuong39 sagar2395 aybeedee

boggart's Issues

Resolve wrapcheck linter issues

Run

golangci-lint run

Add shodan input support

Boggart now supports only raw input type, this means that it reads the honeypot configuration from the config.yaml file.

This feature should allow boggart to read the YAML config file with the type "shodan", read the IP address of the server we want to mimic and using the shodan.io API copies the behavior of the target server.

Let me know if you need more context / guidance. I'll be happy to help!

Resolve contextcheck linter issues

Run

golangci-lint run

Resolve gomnd linter issues

Run

golangci-lint run

Add Goreleaser

In resource-constrained environments we sometimes cannot afford to install full-blown Go + build packages with it: good practice is to have pre-packaged binary releases for each platform.

You can include this in a GitHub action workflow, by leveraging something like the https://github.com/marketplace/actions/go-release-binaries action which automates the process.

For reference: