mirror of
https://github.com/mariocandela/beelzebub.git
synced 2025-07-01 18:47:26 -04:00
Feat: add MCP honeypot support (#199)
* Add MCP honeypot * Add http headers in plain text * Improve code coverage * Refactor README.md
This commit is contained in:
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -45,7 +45,7 @@ jobs:
|
|||||||
echo "Quality Gate: checking test coverage is above threshold ..."
|
echo "Quality Gate: checking test coverage is above threshold ..."
|
||||||
echo "Threshold : $TESTCOVERAGE_THRESHOLD %"
|
echo "Threshold : $TESTCOVERAGE_THRESHOLD %"
|
||||||
# Excluded the concrete strategy from the unit test coverage, because covered by integration tests
|
# Excluded the concrete strategy from the unit test coverage, because covered by integration tests
|
||||||
cat coverage.tmp.out | grep -v "ssh.go" | grep -v "http.go" | grep -v "tcp.go" | grep -v "builder.go" | grep -v "director.go" > coverage.out
|
cat coverage.tmp.out | grep -v "mcp.go" | grep -v "ssh.go" | grep -v "http.go" | grep -v "tcp.go" | grep -v "builder.go" | grep -v "director.go" > coverage.out
|
||||||
totalCoverage=`go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+'`
|
totalCoverage=`go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+'`
|
||||||
echo "Current test coverage : $totalCoverage %"
|
echo "Current test coverage : $totalCoverage %"
|
||||||
if (( $(echo "$totalCoverage $TESTCOVERAGE_THRESHOLD" | awk '{print ($1 > $2)}') )); then
|
if (( $(echo "$totalCoverage $TESTCOVERAGE_THRESHOLD" | awk '{print ($1 > $2)}') )); then
|
||||||
|
168
README.md
168
README.md
@ -12,22 +12,45 @@ Beelzebub is an advanced honeypot framework designed to provide a highly secure
|
|||||||
|
|
||||||
<img src="https://beelzebub.netlify.app/go-beelzebub.png" alt="Beelzebub Logo" width="200"/>
|
<img src="https://beelzebub.netlify.app/go-beelzebub.png" alt="Beelzebub Logo" width="200"/>
|
||||||
|
|
||||||
## LLM Honeypot
|
## Key Features
|
||||||
|
|
||||||
|
Beelzebub offers a wide range of features to enhance your honeypot environment:
|
||||||
|
|
||||||
|
- Low-code configuration: YAML-based, modular service definition
|
||||||
|
- LLM integration: The LLM convincingly simulates a real system, creating high-interaction honeypot experiences, while actually maintaining low-interaction architecture for enhanced security and easy management.
|
||||||
|
- Multi-protocol support: SSH, HTTP, TCP, MCP(Detect prompt injection against LLM agents)
|
||||||
|
- Prometheus metrics & observability
|
||||||
|
- Docker & Kubernetes ready
|
||||||
|
- ELK stack ready, docs: [Official ELK integration](https://www.elastic.co/docs/reference/integrations/beelzebub)
|
||||||
|
|
||||||
|
## LLM SSH Honeypot Demo
|
||||||
|
|
||||||
[](https://asciinema.org/a/665295)
|
[](https://asciinema.org/a/665295)
|
||||||
|
|
||||||
|
## Code Quality
|
||||||
|
|
||||||
## Telegram Bot for Real-Time Attacks
|
We are strongly committed to maintaining high code quality in the Beelzebub project. Our development workflow includes comprehensive testing, code reviews, static analysis, and continuous integration to ensure the reliability and maintainability of the codebase.
|
||||||
|
|
||||||
Stay updated on real-time attacks by joining our dedicated Telegram channel: [Telegram Channel](https://t.me/beelzebubhoneypot)
|
### What We Do
|
||||||
|
|
||||||
## Examples
|
* **Automated Testing:**
|
||||||
|
Both unit and integration tests are run on every pull request to catch regressions and ensure stability.
|
||||||
|
|
||||||
To better understand the capabilities of Beelzebub, you can explore our example repository: [mariocandela/beelzebub-example](https://github.com/mariocandela/beelzebub-example)
|
* **Static Analysis:**
|
||||||
|
We use tools like Go Report Card and CodeQL to automatically check for code quality, style, and security issues.
|
||||||
|
|
||||||
|
* **Code Coverage:**
|
||||||
|
Our test coverage is monitored with [Codecov](https://codecov.io/gh/mariocandela/beelzebub), and we aim for extensive coverage of all core components.
|
||||||
|
|
||||||
|
* **Continuous Integration:**
|
||||||
|
Every commit triggers automated CI pipelines on GitHub Actions, which run all tests and quality checks.
|
||||||
|
|
||||||
|
* **Code Reviews:**
|
||||||
|
All new contributions undergo peer review to maintain consistency and high standards across the project.
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
We provide two quick start options for build and run Beelzebub: using Docker Compose or the Go compiler.
|
You can run Beelzebub via Docker, Go compiler(cross device), or Helm (Kubernetes).
|
||||||
|
|
||||||
### Using Docker Compose
|
### Using Docker Compose
|
||||||
|
|
||||||
@ -43,6 +66,7 @@ We provide two quick start options for build and run Beelzebub: using Docker Com
|
|||||||
$ docker-compose up -d
|
$ docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Using Go Compiler
|
### Using Go Compiler
|
||||||
|
|
||||||
1. Download the necessary Go modules:
|
1. Download the necessary Go modules:
|
||||||
@ -78,41 +102,6 @@ We provide two quick start options for build and run Beelzebub: using Docker Com
|
|||||||
```bash
|
```bash
|
||||||
$ helm upgrade beelzebub ./beelzebub-chart
|
$ helm upgrade beelzebub ./beelzebub-chart
|
||||||
```
|
```
|
||||||
## Testing
|
|
||||||
|
|
||||||
We provide two types of tests: unit tests and integration tests.
|
|
||||||
|
|
||||||
### Unit Tests
|
|
||||||
|
|
||||||
To run unit tests:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make test.unit
|
|
||||||
```
|
|
||||||
|
|
||||||
### Integration Tests
|
|
||||||
|
|
||||||
To run integration tests:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make test.dependencies.start
|
|
||||||
$ make test.integration
|
|
||||||
$ make test.dependencies.down
|
|
||||||
```
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
|
|
||||||
Beelzebub offers a wide range of features to enhance your honeypot environment:
|
|
||||||
|
|
||||||
- Support for Ollama
|
|
||||||
- Support for OpenAI
|
|
||||||
- SSH Honeypot
|
|
||||||
- HTTP Honeypot
|
|
||||||
- TCP Honeypot
|
|
||||||
- Prometheus openmetrics integration
|
|
||||||
- Docker integration
|
|
||||||
- RabbitMQ integration
|
|
||||||
- kubernetes
|
|
||||||
|
|
||||||
## Example Configuration
|
## Example Configuration
|
||||||
|
|
||||||
@ -126,7 +115,73 @@ $ ./beelzebub --confCore ./configurations/beelzebub.yaml --confServices ./config
|
|||||||
|
|
||||||
Here are some example configurations for different honeypot scenarios:
|
Here are some example configurations for different honeypot scenarios:
|
||||||
|
|
||||||
#### Example HTTP Honeypot on Port 80
|
### MCP Honeypot
|
||||||
|
|
||||||
|
#### Why choose an MCP Honeypot?
|
||||||
|
|
||||||
|
An MCP honeypot is a **decoy tool** that the agent should never invoke under normal circumstances. Integrating this strategy into your agent pipeline offers three key benefits:
|
||||||
|
|
||||||
|
* **Real-time detection of guardrail bypass attempts.**
|
||||||
|
|
||||||
|
Instantly identify when a prompt injection attack successfully convinces the agent to invoke a restricted tool.
|
||||||
|
* **Automatic collection of real attack prompts for guardrail fine-tuning.**
|
||||||
|
|
||||||
|
Every activation logs genuine malicious prompts, enabling continuous improvement of your filtering mechanisms.
|
||||||
|
* **Continuous monitoring of attack trends through key metrics (HAR, TPR, MTP).**
|
||||||
|
|
||||||
|
Track exploit frequency and system resilience using objective, actionable measurements.
|
||||||
|
|
||||||
|
##### Example MCP Honeypot Configuration
|
||||||
|
|
||||||
|
###### mcp-8000.yaml
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apiVersion: "v1"
|
||||||
|
protocol: "mcp"
|
||||||
|
address: ":8000"
|
||||||
|
description: "MCP Honeypot"
|
||||||
|
tools:
|
||||||
|
- name: "tool:user-account-manager"
|
||||||
|
description: "Tool for querying and modifying user account details. Requires administrator privileges."
|
||||||
|
params:
|
||||||
|
- name: "user_id"
|
||||||
|
description: "The ID of the user account to manage."
|
||||||
|
- name: "action"
|
||||||
|
description: "The action to perform on the user account, possible values are: get_details, reset_password, deactivate_account"
|
||||||
|
handler: |
|
||||||
|
{
|
||||||
|
"tool_id": "tool:user-account-manager",
|
||||||
|
"status": "completed",
|
||||||
|
"output": {
|
||||||
|
"message": "Tool 'tool:user-account-manager' executed successfully. Results are pending internal processing and will be logged.",
|
||||||
|
"result": {
|
||||||
|
"operation_status": "success",
|
||||||
|
"details": "email: kirsten@gmail.com, role: admin, last-login: 02/07/2025"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
- name: "tool:system-log"
|
||||||
|
description: "Tool for querying system logs. Requires administrator privileges."
|
||||||
|
params:
|
||||||
|
- name: "filter"
|
||||||
|
description: "The input used to filter the logs."
|
||||||
|
handler: |
|
||||||
|
{
|
||||||
|
"tool_id": "tool:system-log",
|
||||||
|
"status": "completed",
|
||||||
|
"output": {
|
||||||
|
"message": "Tool 'tool:system-log' executed successfully. Results are pending internal processing and will be logged.",
|
||||||
|
"result": {
|
||||||
|
"operation_status": "success",
|
||||||
|
"details": "Info: email: kirsten@gmail.com, last-login: 02/07/2025"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Invoke remotely: beelzebub:port/mcp (Streamable HTTPServer).
|
||||||
|
|
||||||
|
### HTTP Honeypot
|
||||||
|
|
||||||
###### http-80.yaml
|
###### http-80.yaml
|
||||||
|
|
||||||
@ -191,7 +246,7 @@ commands:
|
|||||||
statusCode: 404
|
statusCode: 404
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example HTTP Honeypot on Port 8080
|
### HTTP Honeypot
|
||||||
|
|
||||||
###### http-8080.yaml
|
###### http-8080.yaml
|
||||||
|
|
||||||
@ -209,7 +264,7 @@ commands:
|
|||||||
statusCode: 401
|
statusCode: 401
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Example SSH Honeypot
|
### SSH Honeypot
|
||||||
|
|
||||||
###### LLM Honeypots
|
###### LLM Honeypots
|
||||||
|
|
||||||
@ -273,7 +328,7 @@ plugin:
|
|||||||
prompt: "You will act as an Ubuntu Linux terminal. The user will type commands, and you are to reply with what the terminal should show. Your responses must be contained within a single code block."
|
prompt: "You will act as an Ubuntu Linux terminal. The user will type commands, and you are to reply with what the terminal should show. Your responses must be contained within a single code block."
|
||||||
```
|
```
|
||||||
|
|
||||||
###### SSH Honeypot on Port 22
|
###### SSH Honeypot
|
||||||
|
|
||||||
###### ssh-22.yaml
|
###### ssh-22.yaml
|
||||||
|
|
||||||
@ -307,6 +362,29 @@ passwordRegex: "^(root|qwerty|Smoker666)$"
|
|||||||
deadlineTimeoutSeconds: 60
|
deadlineTimeoutSeconds: 60
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Maintaining excellent code quality is essential for security-focused projects like Beelzebub. We welcome all contributors who share our commitment to robust, readable, and reliable code!
|
||||||
|
|
||||||
|
### Unit Tests
|
||||||
|
|
||||||
|
For contributor, we have a comprehensive suite of unit/integration tests that cover the core functionality of Beelzebub. To run the unit tests, use the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make test.unit
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integration Tests
|
||||||
|
|
||||||
|
To run integration tests:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make test.dependencies.start
|
||||||
|
$ make test.integration
|
||||||
|
$ make test.dependencies.down
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
Our future plans for Beelzebub include developing it into a robust PaaS platform.
|
Our future plans for Beelzebub include developing it into a robust PaaS platform.
|
||||||
|
@ -3,6 +3,7 @@ package builder
|
|||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/mariocandela/beelzebub/v3/protocols/strategies/MCP"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
@ -112,6 +113,7 @@ Honeypot Framework, happy hacking!`)
|
|||||||
secureShellStrategy := &SSH.SSHStrategy{}
|
secureShellStrategy := &SSH.SSHStrategy{}
|
||||||
hypertextTransferProtocolStrategy := &HTTP.HTTPStrategy{}
|
hypertextTransferProtocolStrategy := &HTTP.HTTPStrategy{}
|
||||||
transmissionControlProtocolStrategy := &TCP.TCPStrategy{}
|
transmissionControlProtocolStrategy := &TCP.TCPStrategy{}
|
||||||
|
modelContextProtocolStrategy := &MCP.MCPStrategy{}
|
||||||
|
|
||||||
// Init Tracer strategies, and set the trace strategy default HTTP
|
// Init Tracer strategies, and set the trace strategy default HTTP
|
||||||
protocolManager := protocols.InitProtocolManager(b.traceStrategy, hypertextTransferProtocolStrategy)
|
protocolManager := protocols.InitProtocolManager(b.traceStrategy, hypertextTransferProtocolStrategy)
|
||||||
@ -139,6 +141,8 @@ Honeypot Framework, happy hacking!`)
|
|||||||
protocolManager.SetProtocolStrategy(secureShellStrategy)
|
protocolManager.SetProtocolStrategy(secureShellStrategy)
|
||||||
case "tcp":
|
case "tcp":
|
||||||
protocolManager.SetProtocolStrategy(transmissionControlProtocolStrategy)
|
protocolManager.SetProtocolStrategy(transmissionControlProtocolStrategy)
|
||||||
|
case "mcp":
|
||||||
|
protocolManager.SetProtocolStrategy(modelContextProtocolStrategy)
|
||||||
default:
|
default:
|
||||||
log.Fatalf("protocol %s not managed", beelzebubServiceConfiguration.Protocol)
|
log.Fatalf("protocol %s not managed", beelzebubServiceConfiguration.Protocol)
|
||||||
}
|
}
|
||||||
|
41
configurations/services/mcp-8000.yaml
Normal file
41
configurations/services/mcp-8000.yaml
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
apiVersion: "v1"
|
||||||
|
protocol: "mcp"
|
||||||
|
address: ":8000"
|
||||||
|
description: "MCP Honeypot"
|
||||||
|
tools:
|
||||||
|
- name: "tool:user-account-manager"
|
||||||
|
description: "Tool for querying and modifying user account details. Requires administrator privileges."
|
||||||
|
params:
|
||||||
|
- name: "user_id"
|
||||||
|
description: "The ID of the user account to manage."
|
||||||
|
- name: "action"
|
||||||
|
description: "The action to perform on the user account, possible values are: get_details, reset_password, deactivate_account"
|
||||||
|
handler: |
|
||||||
|
{
|
||||||
|
"tool_id": "tool:user-account-manager",
|
||||||
|
"status": "completed",
|
||||||
|
"output": {
|
||||||
|
"message": "Tool 'tool:user-account-manager' executed successfully. Results are pending internal processing and will be logged.",
|
||||||
|
"result": {
|
||||||
|
"operation_status": "success",
|
||||||
|
"details": "email: kirsten_12345@gmail.com, role: admin, last-login: 02/07/2025"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
- name: "tool:system-log"
|
||||||
|
description: "Tool for querying system logs. Requires administrator privileges."
|
||||||
|
params:
|
||||||
|
- name: "filter"
|
||||||
|
description: "The input used to filter the logs."
|
||||||
|
handler: |
|
||||||
|
{
|
||||||
|
"tool_id": "tool:system-log",
|
||||||
|
"status": "completed",
|
||||||
|
"output": {
|
||||||
|
"message": "Tool 'tool:system-log' executed successfully. Results are pending internal processing and will be logged.",
|
||||||
|
"result": {
|
||||||
|
"operation_status": "success",
|
||||||
|
"details": "Info: email: kirsten_12345@gmail.com, last-login: 02/07/2025"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
3
go.mod
3
go.mod
@ -26,6 +26,7 @@ require (
|
|||||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||||
github.com/kr/fs v0.1.0 // indirect
|
github.com/kr/fs v0.1.0 // indirect
|
||||||
github.com/kr/text v0.2.0 // indirect
|
github.com/kr/text v0.2.0 // indirect
|
||||||
|
github.com/mark3labs/mcp-go v0.32.0 // indirect
|
||||||
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
|
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
|
||||||
github.com/pkg/errors v0.9.1 // indirect
|
github.com/pkg/errors v0.9.1 // indirect
|
||||||
github.com/pkg/sftp v1.13.5 // indirect
|
github.com/pkg/sftp v1.13.5 // indirect
|
||||||
@ -33,6 +34,8 @@ require (
|
|||||||
github.com/prometheus/client_model v0.6.1 // indirect
|
github.com/prometheus/client_model v0.6.1 // indirect
|
||||||
github.com/prometheus/common v0.62.0 // indirect
|
github.com/prometheus/common v0.62.0 // indirect
|
||||||
github.com/prometheus/procfs v0.15.1 // indirect
|
github.com/prometheus/procfs v0.15.1 // indirect
|
||||||
|
github.com/spf13/cast v1.7.1 // indirect
|
||||||
|
github.com/yosida95/uritemplate/v3 v3.0.2 // indirect
|
||||||
golang.org/x/net v0.38.0 // indirect
|
golang.org/x/net v0.38.0 // indirect
|
||||||
golang.org/x/sys v0.33.0 // indirect
|
golang.org/x/sys v0.33.0 // indirect
|
||||||
google.golang.org/protobuf v1.36.5 // indirect
|
google.golang.org/protobuf v1.36.5 // indirect
|
||||||
|
6
go.sum
6
go.sum
@ -28,6 +28,8 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
|||||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||||
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
|
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
|
||||||
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
|
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
|
||||||
|
github.com/mark3labs/mcp-go v0.32.0 h1:fgwmbfL2gbd67obg57OfV2Dnrhs1HtSdlY/i5fn7MU8=
|
||||||
|
github.com/mark3labs/mcp-go v0.32.0/go.mod h1:rXqOudj/djTORU/ThxYx8fqEVj/5pvTuuebQ2RC7uk4=
|
||||||
github.com/maxatome/go-testdeep v1.14.0 h1:rRlLv1+kI8eOI3OaBXZwb3O7xY3exRzdW5QyX48g9wI=
|
github.com/maxatome/go-testdeep v1.14.0 h1:rRlLv1+kI8eOI3OaBXZwb3O7xY3exRzdW5QyX48g9wI=
|
||||||
github.com/maxatome/go-testdeep v1.14.0/go.mod h1:lPZc/HAcJMP92l7yI6TRz1aZN5URwUBUAfUNvrclaNM=
|
github.com/maxatome/go-testdeep v1.14.0/go.mod h1:lPZc/HAcJMP92l7yI6TRz1aZN5URwUBUAfUNvrclaNM=
|
||||||
github.com/melbahja/goph v1.4.0 h1:z0PgDbBFe66lRYl3v5dGb9aFgPy0kotuQ37QOwSQFqs=
|
github.com/melbahja/goph v1.4.0 h1:z0PgDbBFe66lRYl3v5dGb9aFgPy0kotuQ37QOwSQFqs=
|
||||||
@ -54,10 +56,14 @@ github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjR
|
|||||||
github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
|
github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
|
||||||
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
|
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
|
||||||
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
|
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
|
||||||
|
github.com/spf13/cast v1.7.1 h1:cuNEagBQEHWN1FnbGEjCXL2szYEXqfJPbP2HNUaca9Y=
|
||||||
|
github.com/spf13/cast v1.7.1/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
|
||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
||||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||||
|
github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
|
||||||
|
github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
|
||||||
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
||||||
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
|
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
|
||||||
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
|
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
|
||||||
|
@ -63,6 +63,7 @@ type BeelzebubServiceConfiguration struct {
|
|||||||
Protocol string `yaml:"protocol"`
|
Protocol string `yaml:"protocol"`
|
||||||
Address string `yaml:"address"`
|
Address string `yaml:"address"`
|
||||||
Commands []Command `yaml:"commands"`
|
Commands []Command `yaml:"commands"`
|
||||||
|
Tools []Tool `yaml:"tools"`
|
||||||
FallbackCommand Command `yaml:"fallbackCommand"`
|
FallbackCommand Command `yaml:"fallbackCommand"`
|
||||||
ServerVersion string `yaml:"serverVersion"`
|
ServerVersion string `yaml:"serverVersion"`
|
||||||
ServerName string `yaml:"serverName"`
|
ServerName string `yaml:"serverName"`
|
||||||
@ -86,6 +87,20 @@ type Command struct {
|
|||||||
Name string `yaml:"name"`
|
Name string `yaml:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Tool is the struct that contains the configurations of the MCP Honeypot
|
||||||
|
type Tool struct {
|
||||||
|
Name string `yaml:"name"`
|
||||||
|
Description string `yaml:"description"`
|
||||||
|
Params []Param `yaml:"params"`
|
||||||
|
Handler string `yaml:"handler"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Param is the struct that contains the configurations of the parameters of the tools
|
||||||
|
type Param struct {
|
||||||
|
Name string `yaml:"name"`
|
||||||
|
Description string `yaml:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
type configurationsParser struct {
|
type configurationsParser struct {
|
||||||
configurationsCorePath string
|
configurationsCorePath string
|
||||||
configurationsServicesDirectory string
|
configurationsServicesDirectory string
|
||||||
|
@ -52,6 +52,15 @@ protocol: "http"
|
|||||||
address: ":8080"
|
address: ":8080"
|
||||||
tlsCertPath: "/tmp/cert.crt"
|
tlsCertPath: "/tmp/cert.crt"
|
||||||
tlsKeyPath: "/tmp/cert.key"
|
tlsKeyPath: "/tmp/cert.key"
|
||||||
|
tools:
|
||||||
|
- name: "tool:user-account-manager"
|
||||||
|
description: "Tool for querying and modifying user account details. Requires administrator privileges."
|
||||||
|
params:
|
||||||
|
- name: "user_id"
|
||||||
|
description: "The ID of the user account to manage."
|
||||||
|
- name: "action"
|
||||||
|
description: "The action to perform on the user account, possible values are: get_details, reset_password, deactivate_account"
|
||||||
|
handler: "reset_password ok"
|
||||||
commands:
|
commands:
|
||||||
- regex: "wp-admin"
|
- regex: "wp-admin"
|
||||||
handler: "login"
|
handler: "login"
|
||||||
@ -154,6 +163,14 @@ func TestReadConfigurationsServicesValid(t *testing.T) {
|
|||||||
assert.Equal(t, firstBeelzebubServiceConfiguration.Plugin.Prompt, "hello world")
|
assert.Equal(t, firstBeelzebubServiceConfiguration.Plugin.Prompt, "hello world")
|
||||||
assert.Equal(t, firstBeelzebubServiceConfiguration.TLSCertPath, "/tmp/cert.crt")
|
assert.Equal(t, firstBeelzebubServiceConfiguration.TLSCertPath, "/tmp/cert.crt")
|
||||||
assert.Equal(t, firstBeelzebubServiceConfiguration.TLSKeyPath, "/tmp/cert.key")
|
assert.Equal(t, firstBeelzebubServiceConfiguration.TLSKeyPath, "/tmp/cert.key")
|
||||||
|
assert.Equal(t, firstBeelzebubServiceConfiguration.TLSKeyPath, "/tmp/cert.key")
|
||||||
|
assert.Equal(t, len(firstBeelzebubServiceConfiguration.Tools), 1)
|
||||||
|
assert.Equal(t, firstBeelzebubServiceConfiguration.Tools[0].Name, "tool:user-account-manager")
|
||||||
|
assert.Equal(t, firstBeelzebubServiceConfiguration.Tools[0].Description, "Tool for querying and modifying user account details. Requires administrator privileges.")
|
||||||
|
assert.Equal(t, len(firstBeelzebubServiceConfiguration.Tools[0].Params), 2)
|
||||||
|
assert.Equal(t, firstBeelzebubServiceConfiguration.Tools[0].Params[0].Name, "user_id")
|
||||||
|
assert.Equal(t, firstBeelzebubServiceConfiguration.Tools[0].Params[0].Description, "The ID of the user account to manage.")
|
||||||
|
assert.Equal(t, firstBeelzebubServiceConfiguration.Tools[0].Handler, "reset_password ok")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGelAllFilesNameByDirName(t *testing.T) {
|
func TestGelAllFilesNameByDirName(t *testing.T) {
|
||||||
|
@ -138,7 +138,8 @@ func traceRequest(request *http.Request, tr tracer.Tracer, command parser.Comman
|
|||||||
HostHTTPRequest: request.Host,
|
HostHTTPRequest: request.Host,
|
||||||
UserAgent: request.UserAgent(),
|
UserAgent: request.UserAgent(),
|
||||||
Cookies: mapCookiesToString(request.Cookies()),
|
Cookies: mapCookiesToString(request.Cookies()),
|
||||||
Headers: request.Header,
|
Headers: mapHeaderToString(request.Header),
|
||||||
|
HeadersMap: request.Header,
|
||||||
Status: tracer.Stateless.String(),
|
Status: tracer.Stateless.String(),
|
||||||
RemoteAddr: request.RemoteAddr,
|
RemoteAddr: request.RemoteAddr,
|
||||||
SourceIp: host,
|
SourceIp: host,
|
||||||
@ -155,6 +156,18 @@ func traceRequest(request *http.Request, tr tracer.Tracer, command parser.Comman
|
|||||||
tr.TraceEvent(event)
|
tr.TraceEvent(event)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func mapHeaderToString(headers http.Header) string {
|
||||||
|
headersString := ""
|
||||||
|
|
||||||
|
for key := range headers {
|
||||||
|
for _, values := range headers[key] {
|
||||||
|
headersString += fmt.Sprintf("[Key: %s, values: %s],", key, values)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return headersString
|
||||||
|
}
|
||||||
|
|
||||||
func mapCookiesToString(cookies []*http.Cookie) string {
|
func mapCookiesToString(cookies []*http.Cookie) string {
|
||||||
cookiesString := ""
|
cookiesString := ""
|
||||||
|
|
||||||
|
86
protocols/strategies/MCP/mcp.go
Normal file
86
protocols/strategies/MCP/mcp.go
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
package MCP
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
"github.com/mariocandela/beelzebub/v3/parser"
|
||||||
|
"github.com/mariocandela/beelzebub/v3/tracer"
|
||||||
|
"github.com/mark3labs/mcp-go/mcp"
|
||||||
|
"github.com/mark3labs/mcp-go/server"
|
||||||
|
log "github.com/sirupsen/logrus"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type remoteAddrCtxKey struct{}
|
||||||
|
|
||||||
|
type MCPStrategy struct {
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mcpStrategy *MCPStrategy) Init(servConf parser.BeelzebubServiceConfiguration, tr tracer.Tracer) error {
|
||||||
|
mcpServer := server.NewMCPServer(
|
||||||
|
servConf.Description,
|
||||||
|
"1.0.0",
|
||||||
|
server.WithToolCapabilities(false),
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, toolConfig := range servConf.Tools {
|
||||||
|
if toolConfig.Params == nil || len(toolConfig.Params) == 0 {
|
||||||
|
log.Errorf("Tool %s has no parameters defined", toolConfig.Name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
opts := []mcp.ToolOption{
|
||||||
|
mcp.WithDescription(toolConfig.Description),
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, param := range toolConfig.Params {
|
||||||
|
opts = append(opts,
|
||||||
|
mcp.WithString(
|
||||||
|
param.Name,
|
||||||
|
mcp.Required(),
|
||||||
|
mcp.Description(param.Description),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
tool := mcp.NewTool(toolConfig.Name, opts...)
|
||||||
|
|
||||||
|
mcpServer.AddTool(tool, func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
||||||
|
host, port, _ := net.SplitHostPort(ctx.Value(remoteAddrCtxKey{}).(string))
|
||||||
|
|
||||||
|
tr.TraceEvent(tracer.Event{
|
||||||
|
Msg: "New MCP tool invocation",
|
||||||
|
Protocol: tracer.MCP.String(),
|
||||||
|
Status: tracer.Stateless.String(),
|
||||||
|
RemoteAddr: ctx.Value(remoteAddrCtxKey{}).(string),
|
||||||
|
SourceIp: host,
|
||||||
|
SourcePort: port,
|
||||||
|
ID: uuid.New().String(),
|
||||||
|
Description: servConf.Description,
|
||||||
|
Command: fmt.Sprintf("%s|%s", request.Params.Name, request.Params.Arguments),
|
||||||
|
CommandOutput: toolConfig.Handler,
|
||||||
|
})
|
||||||
|
return mcp.NewToolResultText(toolConfig.Handler), nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
httpServer := server.NewStreamableHTTPServer(
|
||||||
|
mcpServer,
|
||||||
|
server.WithHTTPContextFunc(func(ctx context.Context, r *http.Request) context.Context {
|
||||||
|
return context.WithValue(ctx, remoteAddrCtxKey{}, r.RemoteAddr)
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
if err := httpServer.Start(servConf.Address); err != nil {
|
||||||
|
log.Errorf("Failed to start MCP server on %s: %v", servConf.Address, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
log.WithFields(log.Fields{
|
||||||
|
"port": servConf.Address,
|
||||||
|
"description": servConf.Description,
|
||||||
|
}).Infof("Init service %s", servConf.Protocol)
|
||||||
|
return nil
|
||||||
|
}
|
@ -10,7 +10,6 @@ import (
|
|||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Workers is the number of workers that will
|
|
||||||
const Workers = 5
|
const Workers = 5
|
||||||
|
|
||||||
type Event struct {
|
type Event struct {
|
||||||
@ -26,7 +25,8 @@ type Event struct {
|
|||||||
User string
|
User string
|
||||||
Password string
|
Password string
|
||||||
Client string
|
Client string
|
||||||
Headers map[string][]string
|
Headers string
|
||||||
|
HeadersMap map[string][]string
|
||||||
Cookies string
|
Cookies string
|
||||||
UserAgent string
|
UserAgent string
|
||||||
HostHTTPRequest string
|
HostHTTPRequest string
|
||||||
@ -49,10 +49,11 @@ const (
|
|||||||
HTTP Protocol = iota
|
HTTP Protocol = iota
|
||||||
SSH
|
SSH
|
||||||
TCP
|
TCP
|
||||||
|
MCP
|
||||||
)
|
)
|
||||||
|
|
||||||
func (protocol Protocol) String() string {
|
func (protocol Protocol) String() string {
|
||||||
return [...]string{"HTTP", "SSH", "TCP"}[protocol]
|
return [...]string{"HTTP", "SSH", "TCP", "MCP"}[protocol]
|
||||||
}
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@ -79,6 +80,7 @@ type tracer struct {
|
|||||||
eventsSSHTotal prometheus.Counter
|
eventsSSHTotal prometheus.Counter
|
||||||
eventsTCPTotal prometheus.Counter
|
eventsTCPTotal prometheus.Counter
|
||||||
eventsHTTPTotal prometheus.Counter
|
eventsHTTPTotal prometheus.Counter
|
||||||
|
eventsMCPTotal prometheus.Counter
|
||||||
}
|
}
|
||||||
|
|
||||||
var lock = &sync.Mutex{}
|
var lock = &sync.Mutex{}
|
||||||
@ -113,6 +115,11 @@ func GetInstance(defaultStrategy Strategy) *tracer {
|
|||||||
Name: "http_events_total",
|
Name: "http_events_total",
|
||||||
Help: "The total number of HTTP events",
|
Help: "The total number of HTTP events",
|
||||||
}),
|
}),
|
||||||
|
eventsMCPTotal: promauto.NewCounter(prometheus.CounterOpts{
|
||||||
|
Namespace: "beelzebub",
|
||||||
|
Name: "mcp_events_total",
|
||||||
|
Help: "The total number of MCP events",
|
||||||
|
}),
|
||||||
}
|
}
|
||||||
|
|
||||||
for i := 0; i < Workers; i++ {
|
for i := 0; i < Workers; i++ {
|
||||||
@ -149,6 +156,8 @@ func (tracer *tracer) updatePrometheusCounters(protocol string) {
|
|||||||
tracer.eventsSSHTotal.Inc()
|
tracer.eventsSSHTotal.Inc()
|
||||||
case TCP.String():
|
case TCP.String():
|
||||||
tracer.eventsTCPTotal.Inc()
|
tracer.eventsTCPTotal.Inc()
|
||||||
|
case MCP.String():
|
||||||
|
tracer.eventsMCPTotal.Inc()
|
||||||
}
|
}
|
||||||
tracer.eventsTotal.Inc()
|
tracer.eventsTotal.Inc()
|
||||||
}
|
}
|
||||||
|
@ -106,6 +106,7 @@ func TestUpdatePrometheusCounters(t *testing.T) {
|
|||||||
eventsSSHTotal: mockCounter{},
|
eventsSSHTotal: mockCounter{},
|
||||||
eventsTCPTotal: mockCounter{},
|
eventsTCPTotal: mockCounter{},
|
||||||
eventsHTTPTotal: mockCounter{},
|
eventsHTTPTotal: mockCounter{},
|
||||||
|
eventsMCPTotal: mockCounter{},
|
||||||
}
|
}
|
||||||
|
|
||||||
tracer.updatePrometheusCounters(SSH.String())
|
tracer.updatePrometheusCounters(SSH.String())
|
||||||
@ -116,4 +117,7 @@ func TestUpdatePrometheusCounters(t *testing.T) {
|
|||||||
|
|
||||||
tracer.updatePrometheusCounters(TCP.String())
|
tracer.updatePrometheusCounters(TCP.String())
|
||||||
assert.Equal(t, 6, counter)
|
assert.Equal(t, 6, counter)
|
||||||
|
|
||||||
|
tracer.updatePrometheusCounters(MCP.String())
|
||||||
|
assert.Equal(t, 8, counter)
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user