tpotce/README.md

T-Pot 🍯 - The All-in-One Honeypot Platform

Table of Contents

1. Introduction
   1. Features and Benefits
   2. Architecture
   3. Supported Honeypots
   4. Tools Included
2. MacOs Installation
   1. Required Ports
   2. Uninstall T-Pot
3. Data Analysis and Insights
4. Conclusion

---

1. Introduction 🌍

T-Pot is an all-in-one honeypot platform designed by Deutsche Telekom. It supports multi-architectures (amd64, arm64) and offers a wide range of visualization options using the Elastic Stack, real-time animated attack maps, and numerous security tools to enhance the deception experience. 🍯

---

1.1 Features and Benefits 💡

T-Pot provides several key features that make it a powerful tool for cybersecurity professionals and researchers:

• Comprehensive Honeypot Integration: T-Pot combines over 20 honeypots, each designed to capture different types of malicious activity. This integration allows for monitoring and analyzing a wide variety of attack vectors.

• Elastic Stack Integration: The platform includes the ELK stack (Elasticsearch, Logstash, and Kibana), facilitating data collection, analysis, and visualization. This integration offers powerful tools for real-time threat intelligence.

• Docker and Docker Compose: Using Docker and Docker Compose, T-Pot simplifies deployment and management. Each honeypot runs in its own container, ensuring isolation and ease of maintenance.

• Advanced Visualization Tools: T-Pot provides tools like CyberChef, Elasticvue, and a real-time attack map, making it easy to interpret and understand the data collected by the honeypots.

• Scalability and Flexibility: T-Pot can be deployed on multiple Linux distributions, macOS, and Windows (with limited functionality). It can run on physical hardware, virtual machines, or cloud environments like AWS.

• Community Data Sharing: By default, T-Pot sends data to the Sicherheitstacho community backend, contributing to collective threat intelligence. This feature can be disabled if needed.

---

1.2 Architecture 🏗️

The core components of T-Pot have been moved into a Docker image called tpotinit. This change has made T-Pot compatible with multiple Linux distributions, macOS, and Windows (with some limitations due to Docker Desktop). T-Pot uses Docker and Docker Compose to run as many honeypots and tools as possible simultaneously, maximizing the host's hardware utilization.

---

1.3 Supported Honeypots 🛡️

T-Pot supports a wide range of honeypots, including:

1.3.1 Industrial and Medical Honeypots 🏭

1. Conpot: Simulates Industrial Control Systems (ICS) and protocols like Modbus, SNMP, and S7comm.
2. Dicompot: Emulates medical imaging systems (DICOM) to detect attacks on medical devices.
3. Medpot: Simulates medical data management systems, focusing on healthcare sector attacks.

1.3.2 Network and IoT Honeypots 🌐

1. Adbhoney: Simulates Android devices exposed via the ADB (Android Debug Bridge) protocol.
2. Ciscoasa: Emulates Cisco ASA devices to detect attacks on firewalls and VPNs.
3. Citrixhoneypot: Simulates known Citrix vulnerabilities, such as CVE-2019-19781.
4. Dionaea: Emulates vulnerable network services (e.g., SMB, FTP) to capture malware and exploits.
5. Endlessh: Simulates an SSH server that keeps connections open indefinitely, slowing down network scanners.
6. Ipphoney: Emulates IPP (Internet Printing Protocol) services to detect attacks on network printers.

1.3.3 Web and Application Honeypots 🌍

1. Cowrie: Emulates SSH and Telnet servers to capture brute-force attempts and malicious commands.
2. Hellpot: Simulates vulnerable HTTP servers to capture "log4shell" attacks (CVE-2021-44228).

1.3.4 DDoS and Anomaly Detection Honeypots ⚠️

1. Ddospot: Detects and analyzes DDoS attacks by simulating vulnerable services.
2. Honeytrap: Monitors network traffic and dynamically launches honeypots based on incoming requests.

1.3.5 Email and Communication Honeypots 📧

1. Mailoney: Emulates SMTP servers to capture spam and phishing attempts.
2. Heralding: Simulates authentication services (e.g., SSH, FTP) to capture stolen credentials.

1.3.6 Malware and Advanced Analysis Honeypots 🦠

1. Beelzebub: Analyzes malware by emulating vulnerable services.
2. Snare / Tanner: Snare captures interactions, while Tanner analyzes attacker behavior.

1.3.7 Data Traps and Advanced Deception Honeypots 🎯

1. Elasticpot: Simulates an unprotected Elasticsearch server, often targeted for data breaches.
2. H0neytr4p: A generic honeypot for capturing interactions with exposed services.

---

1.4 Tools Included 🛠️

T-Pot also includes the following tools:

• Autoheal: Automatically restarts containers with failed health checks.
• CyberChef: A web app for encryption, encoding, compression, and data analysis.
• Elastic Stack: For beautifully visualizing all events captured by T-Pot.
• Elasticvue: A web frontend for browsing and interacting with an Elasticsearch cluster.
• Fatt: A PyShark-based script for extracting network metadata and fingerprints from PCAP files and live traffic.
• T-Pot Attack Map: A beautifully animated attack map for T-Pot.
• P0f: A tool for purely passive traffic fingerprinting.
• Spiderfoot: An open-source intelligence automation tool.
• Suricata: A Network Security Monitoring engine.

---

2. MacOs Installation 🍏

Sometimes it is just nice if you can spin up a T-Pot instance on macOS or Windows, i.e. for development, testing or just the fun of it. As Docker Desktop is rather limited not all honeypot types or T-Pot features are supported. Also remember, by default the macOS and Windows firewall are blocking access from remote, so testing is limited to the host. For production it is recommended to run T-Pot on Linux.
To get things up and running just follow these steps:

1. Install Docker Desktop for macOS or Windows.
2. Clone the GitHub repository: git clone https://github.com/telekom-security/tpotce (in Windows make sure the code is checked out with LF instead of CRLF!)
3. Go to: cd ~/tpotce
4. Copy cp compose/mac_win.yml ./docker-compose.yml
5. Create a WEB_USER by running ~/tpotce/genuser.sh (macOS) or ~/tpotce/genuserwin.ps1 (Windows)
6. Adjust the .env file by changing TPOT_OSTYPE=linux to either mac or win:
7. You have to ensure on your own there are no port conflicts keeping T-Pot from starting up.
8. Start T-Pot: docker compose up or docker compose up -d if you want T-Pot to run in the background.
9. Stop T-Pot: CTRL-C (it if was running in the foreground) and / or docker compose down -v to stop T-Pot entirely.

---

2.1 Required Ports 🔌

Besides the ports generally needed by the OS, i.e. obtaining a DHCP lease, DNS, etc. T-Pot will require the following ports for incoming / outgoing connections. Review the T-Pot Architecture for a visual representation. Also some ports will show up as duplicates, which is fine since used in different editions.

Port	Protocol	Direction	Description
80, 443	tcp	outgoing	T-Pot Management: Install, Updates, Logs (i.e. OS, GitHub, DockerHub, Sicherheitstacho, etc.
11434	tcp	outgoing	LLM based honeypots: Access your Ollama installation
64294	tcp	incoming	T-Pot Management: Sensor data transmission to hive (through NGINX reverse proxy) to 127.0.0.1:64305
64295	tcp	incoming	T-Pot Management: Access to SSH
64297	tcp	incoming	T-Pot Management Access to NGINX reverse proxy
5555	tcp	incoming	Honeypot: ADBHoney
22	tcp	incoming	Honeypot: Beelzebub (LLM required)
5000	udp	incoming	Honeypot: CiscoASA
8443	tcp	incoming	Honeypot: CiscoASA
443	tcp	incoming	Honeypot: CitrixHoneypot
80, 102, 502, 1025, 2404, 10001, 44818, 47808, 50100	tcp	incoming	Honeypot: Conpot
161, 623	udp	incoming	Honeypot: Conpot
22, 23	tcp	incoming	Honeypot: Cowrie
19, 53, 123, 1900	udp	incoming	Honeypot: Ddospot
11112	tcp	incoming	Honeypot: Dicompot
21, 42, 135, 443, 445, 1433, 1723, 1883, 3306, 8081	tcp	incoming	Honeypot: Dionaea
69	udp	incoming	Honeypot