Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lockblock-dev/minepot
Minecraft server honeypot
https://github.com/lockblock-dev/minepot
golang honeypot minecraft minecraft-protocol
Last synced: about 2 months ago
JSON representation
Minecraft server honeypot
- Host: GitHub
- URL: https://github.com/lockblock-dev/minepot
- Owner: LockBlock-dev
- License: agpl-3.0
- Created: 2023-03-12T11:42:58.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T15:51:36.000Z (6 months ago)
- Last Synced: 2024-08-20T05:54:22.649Z (5 months ago)
- Topics: golang, honeypot, minecraft, minecraft-protocol
- Language: Go
- Homepage:
- Size: 66.4 KB
- Stars: 18
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# MinePot
[](https://github.com/LockBlock-dev/MinePot/stargazers)
MinePot is a Minecraft Server Honeypot made in Golang. Its goal is to catch Minecraft Server Scanners by listening for [Handshake](https://wiki.vg/Protocol#Handshake) and [Ping](https://wiki.vg/Protocol#Status) packets.
See the [changelog](/CHANGELOG.md) for the latest updates.
## Table of content
- [**Features**](#features)
- [**Installation**](#installation)
- [**Compiling from source**](#compiling-from-source)
- [**Configuring MinePot**](#configuring-minepot)
- [**Config details**](#config-details)
- [**FAQ**](#faq)
- [**Credits**](#credits)
- [**Copyright**](#copyright)
## Features
- Listen on any TCP port for incoming Minecraft packets
- Answer [Handshake](https://wiki.vg/Protocol#Handshake) packets
- Answer [Ping](https://wiki.vg/Protocol#Status) packets
- Artificial random ping
- Custom Status Response :
- Custom version or version mirroring (send the received protocol/version)
- Fake players
- Custom MOTD
- Custom favicon
- Random protocol/version
- IP reporting to [Abuse IP DB](https://www.abuseipdb.com/)
- IP reporting to a Discord Webhook
- History as a [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) formatted .history file
## Installation
You can use Docker or install MinePot manually. Here's how:
- Download [go](https://go.dev/dl/) (go 1.20 required).
- Download or clone the project.
- Download the binary from the [Releases](../../releases) or [build it](#compiling-from-source) yourself.
- [Configure MinePot](#configuring-minepot).
- Edit the `ExecStart` line in [`minepot.service`](/minepot.service) to the MinePot binary location.
e.g.: `ExecStart=/home/YOUR_USERNAME/MinePot/MinePot`
- Install MinePot by using [`install.sh`](/install.sh). It will setup the tool and start it as a service for you.
## Compiling from source
- Use [`build.sh`](/build.sh) or use `go build`
## Configuring MinePot
If you already used [`install.sh`](/install.sh), the config can be found in `/etc/minepot/config.json`.
- Open the [`config`](/config.json) in your favorite editor.
- Enable the features you want to use. See [Config details](#config-details) for in-depth explanations.
- Edit the Status Response as you want. You can use [mctools MOTD creator](https://mctools.org/motd-creator) for the MOTD.
- Change the `faviconPath` to any PNG image you want to use.
## Config details
| Item | Values | Meaning |
| ------------------ | ---------------------------------------------------------- | ------------------------------------------------------------------- |
| debug | `boolean` | Enable debug logs |
| writeLogs | `boolean` | Enable logs file |
| logFile | `text` | Path to the logs file |
| writeHistory | `boolean` | Enable history file |
| historyFile | `text` | Path to the history file |
| port | `number` | TCP port to listen on |
| pingDelayMinMs | `number` | Minimum artificial server ping (in milliseconds) |
| pingDelayMaxMs | `number` | Maximum artificial server ping (in milliseconds) |
| idleTimeoutS | `number` | Time to wait before the connection times out |
| reportThreshold | `number` | Amount of packets before being reported |
| abuseIPDBReport | `boolean` | Enable Abuse IP DB reports |
| abuseIPDBKey | `text` | Abuse IP DB API key |
| abuseIPDBCooldownH | `number` | Cooldown between each reports (in hours) |
| webhookReport | `boolean` | Enable Discord webhook reports |
| webhookUrl | `text` | Discord webhook URL |
| webhookCooldownH | `number` | Cooldown between each reports (in hours) |
| webhookEmbedColor | `text` | Embed hex color |
| randomVersion | `boolean` | Enable random Minecraft version and protocol in the status response |
| statusResponse | `boolean` | Enable Status Response |
| statusResponseData | [`JSON`](https://wiki.vg/Server_List_Ping#Status_Response) | Minecraft Status Reponse data |
| faviconPath | `text` | Path to the favicon PNG image |
## FAQ
- Q: Do you plan to release a Windows version?
A: No.
## Credits
- [Wiki.vg](https://wiki.vg) Minecraft protocol documentation
- [go-mc](https://github.com/Tnze/go-mc) Minecraft protocol implementation
## Copyright
See the [license](/LICENSE).