Skip to content

Commit cde0a21

Browse files
authored
Update README.md
1 parent a83fa0c commit cde0a21

File tree

1 file changed

+210
-2
lines changed

1 file changed

+210
-2
lines changed

README.md

Lines changed: 210 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,210 @@
1-
# DefroxPot
2-
DefroxPot is a honeypot project designed to detect, monitor, and analyze malicious activity in a controlled environment. This project aims to provide cybersecurity enthusiasts and professionals with a powerful tool to study attack patterns, improve defensive strategies, and enhance security awareness.
1+
<div align="center"><p>
2+
<h1>DefroxPot</h1>
3+
<img style="filter: brightness(200%)" src="https://user-images.githubusercontent.com/122822828/216810369-34904b5a-d063-48a9-a87d-11caf293243b.png" width="50%"><br>
4+
<img src="https://forthebadge.com/images/badges/made-with-python.svg">
5+
<img src="https://forthebadge.com/images/badges/built-with-love.svg">
6+
<br><br>
7+
<a href="https://github.com/TeamDefronix/DefroxPot/releases/latest">
8+
<img alt="Latest release" src="https://img.shields.io/github/v/release/TeamDefronix/DefroxPot?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />
9+
</a>
10+
<a href="https://github.com/TeamDefronix/DefroxPot/pulse">
11+
<img alt="Last commit" src="https://img.shields.io/github/last-commit/TeamDefronix/DefroxPot?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41" />
12+
</a>
13+
<a href="https://github.com/TeamDefronix/DefroxPot/blob/main/LICENSE">
14+
<img alt="License" src="https://img.shields.io/github/license/TeamDefronix/DefroxPot?style=for-the-badge&logo=starship&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
15+
</a>
16+
<a href="https://github.com/TeamDefronix/DefroxPot/stargazers">
17+
<img alt="Stars" src="https://img.shields.io/github/stars/TeamDefronix/DefroxPot?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
18+
</a>
19+
<a href="https://github.com/TeamDefronix/DefroxPot/issues">
20+
<img alt="Issues" src="https://img.shields.io/github/issues/TeamDefronix/DefroxPot?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
21+
</a>
22+
<a href="https://github.com/TeamDefronix/DefroxPot">
23+
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/TeamDefronix/DefroxPot?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
24+
</a>
25+
<a href="https://twitter.com/intent/follow?screen_name=niteshlike123">
26+
<img alt="follow on Twitter" src="https://img.shields.io/twitter/follow/niteshlike123?style=for-the-badge&logo=twitter&color=8aadf3&logoColor=D9E0EE&labelColor=302D41" />
27+
</a>
28+
<a href="https://discord.gg/defronix">
29+
<img alt="Discord" src="https://img.shields.io/discord/1072407436348112896?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41"/>
30+
</a>
31+
</p>
32+
<p align="center">
33+
<img src="https://stars.medv.io/TeamDefronix/Cyberonix.svg", title="commits"/>
34+
</p>
35+
36+
<h1 align="left">Description</h1>
37+
38+
<p align="left">
39+
DefroxPot is a honeypot project designed to detect, monitor, and analyze malicious activity in a controlled environment. This project aims to provide cybersecurity enthusiasts and professionals with a powerful tool to study attack patterns, improve defensive strategies, and enhance security awareness.
40+
</p>
41+
42+
43+
---
44+
45+
**[<kbd> <br> Variants <br> </kbd>][Variants]**
46+
**[<kbd> <br> Install <br> </kbd>][Install]**
47+
**[<kbd> <br> Dependencies <br> </kbd>][Dependencies]**
48+
**[<kbd> <br> Usage <br> </kbd>][Usage]**
49+
**[<kbd> <br> Screenshots <br> </kbd>][ScreenShots]**
50+
**[<kbd> <br> Contributors <br> </kbd>][Contributors]**
51+
52+
---
53+
54+
[Variants]: #Variants
55+
[Install]: #Installation
56+
[Dependencies]: #Dependencies
57+
[Usage]: #Usage
58+
[Screenshots]: #Screenshots
59+
[Contributors]: #Contributors
60+
61+
</div>
62+
63+
# Variants
64+
65+
### Web Honeypot
66+
67+
The Web Honeypot simulates a vulnerable website to attract and analyze web-based attacks.
68+
69+
#### Features
70+
71+
**Web Logging**
72+
- Records all HTTP requests and responses
73+
- Logs IP addresses, session details, user agents, user IDs, and paths visited
74+
- Captures keystrokes through the website
75+
76+
**File Analysis**
77+
- Analyzes files uploaded by attackers to check for malicious content
78+
- Extracts metadata from the uploaded files
79+
80+
**Dashboard**
81+
- Provides a dashboard for real-time monitoring
82+
83+
### Network Honeypot
84+
85+
The Network Honeypot mimics a network environment to detect, log and analyze network-based attacks.
86+
87+
#### Features
88+
89+
**Network Logging**
90+
- Captures and logs all network traffic
91+
- Records IP addresses and authentication attempts via FTP or SSH services (whichever you run)
92+
93+
**Deceptive Environment**
94+
- Creates a deceptive environment to trap attackers
95+
- Simulates various network services to attract malicious activity
96+
97+
# Installation
98+
99+
1. **Clone the repository:**
100+
```bash
101+
git clone https://github.com/repo/HoneyGuard.git
102+
cd honeypot
103+
```
104+
105+
2. **Install dependencies:**
106+
```bash
107+
pip install -r requirements.txt
108+
```
109+
110+
3. **Configure the honeypot:**
111+
```bash
112+
python manage.py migrate
113+
python manage.py createsuperuser
114+
```
115+
**Note**: `python manage.py createsuperuser` is required to create for managing the DefroxPot tool
116+
117+
4. **Start the honeypot:**
118+
119+
```bash
120+
python manage.py runserver
121+
```
122+
You will receive a URL with port 8000. Open this URL in your browser to access the admin panel.
123+
124+
# Dependencies
125+
- Apart from what is in `requirements.txt` ExifTool is also required to extract metadata from images. You can visit the official website [https://exiftool.org]
126+
- Virus total has been used to check malicious content if uploaded by an attacker [https://www.virustotal.com]
127+
128+
**You can visit the following URLs to check software authenticity.**
129+
130+
`exiftool.exe` (Windows): https://www.virustotal.com/gui/file/e9bfbb1ae99f3b5587f926393c3e9ccd86ad7e03a779a06f5e68601a6a85a714 <br>
131+
`exiftool` (Linux): https://www.virustotal.com/gui/file/4827ade560b85f0877c635fd7e32144e9196f4fa256cc504c42f8593cc79a32b
132+
133+
# Technology Stack
134+
135+
### Essential Python Libraries
136+
137+
`Django`: A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
138+
139+
`Flask`: A lightweight WSGI web application framework in Python.
140+
141+
`paramiko`: A library for making SSH2 connections.
142+
143+
`pyftpdlib`: A library for creating FTP servers.
144+
145+
`bcrypt`: Library for hashing passwords in a secure manner.
146+
147+
`blinker`: Provides support for creating signals and listening to them, often used in Flask applications.
148+
149+
`certifi`: Provides Mozilla’s CA Bundle, useful for SSL verification.
150+
151+
`cryptography`: Provides cryptographic recipes and primitives.
152+
153+
`itsdangerous`: Provides various helpers to pass trusted data to untrusted environments.
154+
155+
`pycparser`: A C parser and AST generator written in Python.
156+
157+
`PyNaCl`: Python binding to the Networking and Cryptography (NaCl) library.
158+
159+
160+
# Usage
161+
### Website
162+
- Navigate to the `Setup` tab and launch the web setup. You will receive a URL with port 5000 that is intended to be accessed by an attacker.
163+
- `File Analysis`, `Photo`, `Keylogger` and `Website` tabs belong to Web honeypot. You can navigate to check logs.
164+
165+
### Network
166+
- Navigate to the `Setup` tab and launch the network setup. The `ssh` and `ftp` will be started that is intended to be accessed by an attacker.
167+
- `Network` tabs belong to network honeypot. You can navigate to check logs.
168+
169+
# Screenshots
170+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/38dbccda-b44e-4bf0-8a80-3dd6e553a2b1)
171+
172+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/9e38b989-4179-46d7-a830-0544284b5340)
173+
174+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/ea94fe79-2bd3-4c7b-b940-f3d9a15d21c2)
175+
176+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/cf11e27e-cca1-4ceb-9939-aba62996fe48)
177+
178+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/d9f527a1-febc-41e5-8a03-237fadc0309c)
179+
180+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/e8f1a06a-bb38-4838-94a5-207e8445b4be)
181+
182+
![image](https://github.com/incoggeek/DefroxPot/assets/145888193/c12bab45-ce72-4b23-8e7c-b6734889f39b)
183+
184+
185+
# Contacts
186+
187+
<p align="left">
188+
<a href="https://github.com/TeamDefronix"><img src="https://github.com/gauravghongde/social-icons/raw/master/SVG/Color/Github.svg" width="64" height="64" alt="Github Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://www.facebook.com/defronix"><img src="https://raw.githubusercontent.com/gauravghongde/social-icons/master/SVG/Color/Facebook.svg" width="64" height="64" alt="Facebook Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://twitter.com/teamdefronix"><img src="https://github.com/gauravghongde/social-icons/raw/master/SVG/Color/Twitter.svg" width="64" height="64" alt="Twitter Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/>
189+
<a href="https://instagram.com/teamdefronix"><img src="https://github.com/gauravghongde/social-icons/raw/master/SVG/Color/Instagram.svg" width="64" height="64" alt="Instagram Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/>
190+
<a href="https://whatsapp.com/channel/0029VaGltobEKyZ8eX8Ki82w"><img src="https://github.com/gauravghongde/social-icons/raw/master/SVG/Color/WhatsApp.svg" width="64" height="64" alt="WhatsApp Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/>
191+
<a href="https://youtube.com/@defronix"><img src="https://github.com/gauravghongde/social-icons/raw/master/SVG/Color/Youtube.svg" width="64" height="64" alt="Youtube Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/>
192+
<a href="https://www.linkedin.com/company/defronix/"><img src="https://github.com/gauravghongde/social-icons/raw/master/SVG/Color/LinkedIN.svg" width="64" height="64" alt="LinkedIN Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/>
193+
</p>
194+
195+
# Support
196+
197+
<p><a href="https://www.buymeacoffee.com/metaxone" target="_blank"> <img align="left" src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="50" width="210" alt="Buymeacoffee" /></a></p><br><br><br>
198+
<p><a href="https://paypal.me/niteshsinghhacker" target="_blank"> <img align="left" src="https://raw.githubusercontent.com/andreostrovsky/donate-with-paypal/master/blue.svg" height="70" width="210" alt="Donate with paypal" /></a></p><br><br><br>
199+
<p><a href="https://tools.apgy.in/upi/Nitesh+Singh/niteshkumar5@ybl/" target="_blank"> <img align="left" style="border-radius:8px" src="https://user-images.githubusercontent.com/122822828/216837693-3480fcd2-b4fc-40ff-94f8-c5d7d4b82ad5.png" height="50" width="210" alt="Donate with paypal" /></a></p><br><br><br>
200+
<p><a href="https://razorpay.me/@technicalnavigator" target="_blank"> <img align="left" src="https://user-images.githubusercontent.com/122822828/216838288-a946ef91-f215-4286-926f-afa71d0c3760.png" height="50" width="210" alt="Donate with paypal" /></a></p><br><be>
201+
<br>
202+
203+
*This tool is currently a prototype and can be further improved. If you have more context or specific improvements in mind, We can tailor the further requirements to fit your needs*
204+
<div align="center">
205+
<h1 id="Contributors">Thanks To All Contributors</h1>
206+
207+
<a href="https://github.com/TeamDefronix/DefroxPot/graphs/contributors">
208+
<img src="https://contrib.rocks/image?repo=TeamDefronix/DefroxPot" />
209+
</a>
210+
</div>

0 commit comments

Comments
 (0)