You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Beelzebub offers a wide range of features to enhance your honeypot environment:
18
+
19
+
- Low-code configuration: YAML-based, modular service definition
20
+
- 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.
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.
33
+
34
+
### What We Do
35
+
36
+
***Automated Testing:**
37
+
Both unit and integration tests are run on every pull request to catch regressions and ensure stability.
19
38
20
-
## Telegram Bot for Real-Time Attacks
39
+
***Static Analysis:**
40
+
We use tools like Go Report Card and CodeQL to automatically check for code quality, style, and security issues.
21
41
22
-
Stay updated on real-time attacks by joining our dedicated Telegram channel: [Telegram Channel](https://t.me/beelzebubhoneypot)
42
+
***Code Coverage:**
43
+
Our test coverage is monitored with [Codecov](https://codecov.io/gh/mariocandela/beelzebub), and we aim for extensive coverage of all core components.
23
44
24
-
## Examples
45
+
***Continuous Integration:**
46
+
Every commit triggers automated CI pipelines on GitHub Actions, which run all tests and quality checks.
25
47
26
-
To better understand the capabilities of Beelzebub, you can explore our example repository: [mariocandela/beelzebub-example](https://github.com/mariocandela/beelzebub-example)
48
+
***Code Reviews:**
49
+
All new contributions undergo peer review to maintain consistency and high standards across the project.
27
50
28
51
## Quick Start
29
52
30
-
We provide two quick start options for build and run Beelzebub: using Docker Compose or the Go compiler.
53
+
You can run Beelzebub via Docker, Go compiler(cross device), or Helm (Kubernetes).
31
54
32
55
### Using Docker Compose
33
56
@@ -43,6 +66,7 @@ We provide two quick start options for build and run Beelzebub: using Docker Com
43
66
$ docker-compose up -d
44
67
```
45
68
69
+
46
70
### Using Go Compiler
47
71
48
72
1. Download the necessary Go modules:
@@ -78,55 +102,86 @@ We provide two quick start options for build and run Beelzebub: using Docker Com
78
102
```bash
79
103
$ helm upgrade beelzebub ./beelzebub-chart
80
104
```
81
-
## Testing
82
105
83
-
We provide two types of tests: unit tests and integration tests.
106
+
## Example Configuration
84
107
85
-
### Unit Tests
108
+
Beelzebub allows easy configuration for different services and ports. Simply create a new file for each service/port within the `/configurations/services` directory.
86
109
87
-
To run unit tests:
110
+
To execute Beelzebub with your custom path, use the following command:
Here are some example configurations for different honeypot scenarios:
96
117
97
-
```bash
98
-
$ make test.dependencies.start
99
-
$ make test.integration
100
-
$ make test.dependencies.down
101
-
```
118
+
### MCP Honeypot
102
119
103
-
##Key Features
120
+
#### Why choose an MCP Honeypot?
104
121
105
-
Beelzebub offers a wide range of features to enhance your honeypot environment:
122
+
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:
106
123
107
-
- Support for Ollama
108
-
- Support for OpenAI
109
-
- SSH Honeypot
110
-
- HTTP Honeypot
111
-
- TCP Honeypot
112
-
- Prometheus openmetrics integration
113
-
- Docker integration
114
-
- RabbitMQ integration
115
-
- kubernetes
124
+
***Real-time detection of guardrail bypass attempts.**
125
+
126
+
Instantly identify when a prompt injection attack successfully convinces the agent to invoke a restricted tool.
127
+
***Automatic collection of real attack prompts for guardrail fine-tuning.**
128
+
129
+
Every activation logs genuine malicious prompts, enabling continuous improvement of your filtering mechanisms.
130
+
***Continuous monitoring of attack trends through key metrics (HAR, TPR, MTP).**
131
+
132
+
Track exploit frequency and system resilience using objective, actionable measurements.
116
133
117
-
## Example Configuration
134
+
#####Example MCP Honeypot Configuration
118
135
119
-
Beelzebub allows easy configuration for different services and ports. Simply create a new file for each service/port within the `/configurations/services` directory.
136
+
###### mcp-8000.yaml
120
137
121
-
To execute Beelzebub with your custom path, use the following command:
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."
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!
368
+
369
+
### Unit Tests
370
+
371
+
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:
372
+
373
+
```bash
374
+
$ make test.unit
375
+
```
376
+
377
+
### Integration Tests
378
+
379
+
To run integration tests:
380
+
381
+
```bash
382
+
$ make test.dependencies.start
383
+
$ make test.integration
384
+
$ make test.dependencies.down
385
+
```
386
+
387
+
310
388
## Roadmap
311
389
312
390
Our future plans for Beelzebub include developing it into a robust PaaS platform.
0 commit comments