SOC Detection Laboratory

A modern cybersecurity detection laboratory for threat hunting, adversary simulation, and SOC training

Portuguese (pt-BR): README.pt-BR.md · CONTRIBUTING.md · CODE_OF_CONDUCT.md

🎯 Overview

The SOC Detection Laboratory is a comprehensive, modern cybersecurity lab environment designed for:

• 🔍 Threat Detection - Advanced log analysis and security event monitoring
• 🎯 Threat Hunting - Proactive cybersecurity threat investigation
• ⚔️ Adversary Simulation - Attack simulation for detection testing
• 🎓 SOC Training - Security Operations Center analyst training
• 🔴 Red Team Exercises - Red team and purple team exercises

🏢 Organization

Uniao-Geek - Cybersecurity Research & Development

👥 Contributors

• mrhenrike - Lead Developer & Security Researcher
• bhbrandon - Contributor

🏗️ Lab Architecture

🖥️ Virtual Machines

VM	Operating System	IP Address	Primary Function
logger	Ubuntu 22.04 LTS	192.168.56.105	SIEM, Centralized Logging, Analysis
dc	Windows Server 2016	192.168.56.102	Domain Controller, Active Directory
wef	Windows Server 2016	192.168.56.103	Windows Event Forwarder
win10	Windows 10	192.168.56.104	Test Workstation

🛠️ Installed Tools

Logger VM (Ubuntu 22.04) - Analysis Center

• 🔍 Splunk Enterprise - Primary SIEM and log analysis
• 🌐 Zeek (Bro) - Advanced network traffic analysis
• 🛡️ Suricata - Intrusion detection system (IDS/IPS)
• 📊 Fleet (osquery) - Endpoint monitoring
• 🔬 Velociraptor - Digital forensics and incident response
• 🖥️ Apache Guacamole - Remote desktop gateway
• 🔗 OpenVSwitch - Advanced virtual switching

Windows VMs - Production Environment

• 📝 Windows Event Logging - System and application logs
• 👁️ Sysmon - Advanced process monitoring
• 📡 osquery - Endpoint telemetry
• 🔬 Velociraptor Client - Forensics client
• ⚔️ Red Team Tools - Testing and simulation tools

🚀 Quick Start

📋 Prerequisites

• VirtualBox 7.2.0+ (recommended) or VMware Workstation
• Vagrant 2.3+
• 8GB+ RAM (16GB recommended)
• 50GB+ disk space
• Windows 10/11 or Linux as host system

⚡ Quick Installation

1. Clone the repository:

   git clone https://github.com/Uniao-Geek/SOC-Detection-Lab.git
   cd SOC-Detection-Lab/Vagrant

2. Run the clean rebuild script:

   chmod +x rebuild-logger.sh
   ./rebuild-logger.sh

3. Wait for complete installation (30-60 minutes)

4. Access Splunk:

   • URL: https://192.168.56.105:8000
   • User: admin
   • Password: changeme

⚙️ Automatic Configurations

The system is automatically configured with:

• ✅ GRUB timeout: 5 seconds (fast boot)
• ✅ Hostname: logger
• ✅ Static IP: 192.168.56.105
• ✅ DNS: 8.8.8.8, 8.8.4.4, 192.168.56.102
• ✅ Timezone: UTC
• ✅ Network: Optimized lab configuration

🔧 Scripts & Tools

📜 Configuration Scripts

• scripts/initial-system-config.sh - Initial system configuration
• scripts/configure-grub.sh - GRUB bootloader configuration
• rebuild-logger.sh - Clean logger VM rebuild

🚀 Bootstrap Scripts

• logger_bootstrap_enhanced.sh - Complete logger VM installation

Available modes:

• main - Complete installation (default)
• splunk_only - Splunk Enterprise only
• zeek_only - Zeek Network Monitor only
• suricata_only - Suricata IDS only
• fleet_only - Fleet osquery only
• guacamole_only - Apache Guacamole only
• velociraptor_only - Velociraptor only
• fix_network_only - Network fix only

🌐 Access & URLs

🔗 Main URLs

Service	URL	Credentials
Splunk Web	https://192.168.56.105:8000	admin/changeme
Splunk Management API	https://192.168.56.105:8089	admin/changeme
Fleet osquery	https://192.168.56.105:8412	admin@detectionlab.network/Fl33tpassword!
Apache Guacamole	http://192.168.56.105:8080/guacamole	vagrant/vagrant

🔌 Forwarded Ports

Host Port	Guest Port	Service
5625	22	SSH Logger
8000	8000	Splunk Web UI
8089	8089	Splunk Management API

📊 Monitoring & Logs

📝 Important Logs

• /var/log/logger_provision_report.log - Complete provisioning report
• /var/log/soc-detection-lab-initial-config.log - Initial system configuration
• /opt/splunk/var/log/splunk/ - Splunk Enterprise logs
• /opt/zeek/logs/ - Zeek Network Monitor logs
• /var/log/suricata/ - Suricata IDS logs

💻 Useful Commands

# Status of main services
systemctl status splunkd zeek suricata fleet

# Check connectivity between VMs
ping -c 1 192.168.56.102  # DC
ping -c 1 192.168.56.103  # WEF
ping -c 1 192.168.56.104  # Win10

# Check system configurations
hostname
ip addr show eth1
grep GRUB_TIMEOUT /etc/default/grub

# Monitor logs in real-time
tail -f /var/log/logger_provision_report.log
journalctl -f

🛠️ Troubleshooting

❗ Common Issues

1. VM won't start:

   • Check if VirtualBox is working correctly
   • Run vagrant destroy -f and vagrant up again
   • Check VirtualBox logs

2. Network issues:

   • Check if IP 192.168.56.105 is free on the network
   • Run ./rebuild-logger.sh for clean rebuild
   • Check firewall settings

3. Splunk not accessible:

   • Wait 5-10 minutes after complete boot
   • Check logs: journalctl -u splunkd
   • Check if service is running: systemctl status splunkd

4. GRUB timeout:

   • Run scripts/configure-grub.sh manually
   • Check configuration: cat /etc/default/grub

🔍 Debug Logs

# Vagrant logs in real-time
vagrant ssh logger -c "tail -f /var/log/logger_provision_report.log"

# System logs
journalctl -f

# Status of all services
systemctl list-units --failed

# Check disk space
df -h

# Check memory usage
free -h

🚀 Deployment Platforms

Local Development

• Vagrant with VirtualBox/VMware
• Quick setup for testing and development

Cloud Platforms

• AWS - Deploy with Terraform
• Azure - Terraform + Ansible
• ESXi - Terraform + Ansible
• Proxmox - Terraform + Ansible

Enterprise

• HyperV - Windows Server environments
• Custom - Packer templates for custom builds

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the project
2. Create a feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📋 Contribution Guidelines

• Use descriptive commits
• Test your changes before submitting
• Keep documentation updated
• Follow existing code conventions

---

Aviso legal / legal notice

• Uso — Conteúdo para educação, pesquisa e testes explicitamente autorizados. Não utilize contra sistemas, redes ou dados sem permissão formal do responsável; cumpra leis e políticas aplicáveis.
• Sem garantia — Fornecido “no estado em que se encontra” (AS IS). Não há garantias de qualquer tipo (expressas ou implícitas), incluindo comercialização, adequação a um fim específico ou não violação de direitos.
• Limitação de responsabilidade — Na medida máxima permitida pela lei aplicável, o(s) autor(es) não respondem por danos diretos ou indiretos, perdas, uso indevido, reclamações de terceiros ou violação de termos de produtos de terceiros. O uso é por sua conta e risco.
• Atribuição e comunidade — Preserve avisos de copyright e créditos ao projeto original (incluindo o DetectionLab e outros upstreams). Contribuições via pull requests, melhorias e issues são bem-vindas.
• Licença — Consulte o ficheiro LICENSE na raiz do repositório para os termos completos (MIT).

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

This project is based on the original DetectionLab by Chris Long, with significant improvements and modifications for modern SOC operations.

🏆 Special Thanks

• Chris Long - Original DetectionLab creator
• Palantir - Windows Event Forwarding configurations
• Splunk - Enterprise SIEM platform
• osquery - Cross-platform endpoint visibility
• Suricata - Intrusion detection system
• Zeek - Network analysis framework
• Velociraptor - Digital forensics platform

📞 Support & Contact

For support and questions:

• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📚 Wiki: Complete Documentation

---

SOC Detection Laboratory - Building the future of cybersecurity threat detection 🛡️

Developed with ❤️ by Uniao-Geek