A comprehensive cybersecurity lab for creating and testing detection rules, simulating attacks, and training analysts
Get Started »

View Demo · Report Bug · Request Feature

📋 Table of Contents

1. What is PurpleLab?
2. Installation
   • Requirements
   • Installation Steps
   • Accounts Setup
   • ELK Configuration
   • VM Logs Configuration
3. Usage
   • Home Page
   • Hunting Page
   • MITRE ATT&CK Page
   • Malware Page
   • Sharing Page
   • Sigma Page
   • Rule Lifecycle Page
   • Health Page
   • Admin Page
4. Splunk App
5. Cortex Analyzer
6. API Documentation

🚀 What is PurpleLab ?

PurpleLab is a cybersecurity laboratory that enables security professionals to easily deploy an entire testing environment for creating and validating detection rules, simulating realistic attack scenarios, and training security analysts.

🏗️ Architecture Components

The lab includes:

• 🌐 Web Interface - Complete frontend for controlling all features
• 💻 VirtualBox Environment - Ready-to-use Windows server 2019 with sysmon and opensearch collector
• ⚙️ Flask Backend - Robust API and application logic
• 🗄️ PostgreSQL Database - Secure data storage
• 🔍 Opensearch Server - Advanced log analysis and search capabilities

(⬆️ back to top)

🔧 Installation procedure

⚠️ Important: For a completely clean installation, follow ALL chapters of the installation procedure from requirements to accounts configuration.

⚠️ Security Notice: This lab has not been hardened and runs with basic credentials. Do not connect it to production networks or secure it with proper PKI and authentication systems.

Requirements

Minimum Hardware Resources:

• Storage: 200GB available space
• CPU: 8 cores minimum
• RAM: 13GB minimum

Software Requirements:

• Clean installation of Ubuntu Server 22.04 - Download Here

⚠️ Note: Ubuntu Server 23.10 may cause issues with Python library installation.

⚠️ Hardware Virtualization Setup:

VMware Workstation:

1. Go to VM settings → Processors → Virtualization engine
2. Enable "Virtualize Intel VT-x/EPT or AMD-V/RVI"

VirtualBox:

1. Select VM → Right-click → Settings → System → Processor
2. Check "Enable Nested VT-x/AMD-V"

Physical Machine (Host):

1. Access BIOS/UEFI settings
2. Enable hardware virtualization (VT-x/AMD-V)
3. Save changes and restart

Download Repository:

git clone https://github.com/Krook9d/PurpleLab.git && mv PurpleLab/install.sh .

Installation

Execute the installation script:

sudo bash install.sh

The script will automatically:

1. Install all components: OpenSearch, PostgreSQL, VirtualBox, and web interface
2. Configure the Windows Server VM: Set up monitoring and security tools
3. Generate credentials: Save all login information to admin.txt

Accounts

👤 Admin Account

A default admin account is automatically created and stored in ~/admin.txt with the format:

admin@local.com:password

👥 User Account Setup

1. Access the application using your server's IP address
2. Click "Register" button
3. Fill required fields:
   • First Name: Your first name
   • Last Name: Your last name
   • Analyst Level: Your analyst level (N1/N2/N3)
   • Avatar: Select an avatar (< 1MB)
   • Password: Must contain at least 8 characters with uppercase, lowercase, number, and special character

(⬆️ back to top)

💡 Usage

Start the Flask server:

sudo python3 /home/$(logname)/app.py

🪟 Windows Server 2019 Sandbox VM

The automatically configured VM includes:

• Windows Server 2019 with admin user oem/oem
• Sysmon with SwiftOnSecurity configuration for advanced logging
• Winlogbeat OSS 7.12.1 automatically sending logs to OpenSearch
• Atomic Red Team with full test suite for attack simulation
• Python environment and Chocolatey package manager
• PowerShell-YAML module for YAML file processing
• Pre-configured directories: samples, malware_upload, and upload folders
• Windows Defender exclusions for testing scenarios

Home Page 🏠

The dashboard displays key performance indicators from OpenSearch:

• Event Count from Windows Server VM
• Unique IP Addresses detected in logs
• MITRE ATT&CK techniques and sub-techniques count
• Log Distribution from VM collection

Hunting Page 🎯

Direct access to OpenSearch Dashboards for log analysis. Navigate to Discover to examine:

• Automatically collected VM logs from Windows Server sandbox
• Simulated log data and security events
• Real-time monitoring of system activities
• Sysmon events with detailed process and network information

Mitre Att&ck Page 🛡️

Interactive MITRE ATT&CK framework interface for:

🔍 Technique Discovery:

• Search using technique IDs (e.g., "T1070")
• Browse sub-techniques and detailed information
• Access comprehensive technique documentation

⚡ Payload Execution:

• Execute Atomic Red Team payloads
• Simulate real attack scenarios
• Generate detection-worthy events

📊 Database Management:

• Update MITRE ATT&CK database with latest data
• Maintain current threat intelligence

Reference: Atomic Red Team Tests

Malware Page 🦠

Comprehensive malware management platform with dual functionality:

📥 Malware Downloader

• Search & Download: Enter malware types (e.g., "Trojan")
• Auto-Integration: Automatically uploads to Windows VM
• Batch Processing: Downloads 10 latest samples from Malware Bazaar
• Execution Control: Run malware with single-click execution

📤 Malware Uploader

• Custom Uploads: Upload your own executables and scripts
• Supported Formats: .exe, .dll, .bin, .py, .ps1
• Inventory Management: List and manage uploaded malware

Storage Location: /var/www/html/Downloaded/malware_upload/

Sharing Page ✏️

Collaborative knowledge sharing platform:

• Query Sharing: Publish effective detection queries
• Rule Exchange: Share custom detection rules
• Community Benefit: Learn from other analysts' discoveries

Sigma Page 🛡️

Advanced Sigma rule management:

🔍 Search Capabilities

• Keyword Search: Find rules by technique IDs or keywords (e.g., "powershell")
• Rule Display: View complete Sigma rule details
• Format Conversion: Convert rules to Splunk or Lucene syntax

🔄 Conversion Features

• Splunk Format: One-click conversion to Splunk queries
• Lucene Format: Transform to Elasticsearch-compatible syntax

Rule Lifecycle Page ⚙️

Advanced rule lifecycle management system for connecting and managing security rules across multiple SIEM platforms:

🔌 Connectors Management

• Splunk Integration: Configure connections to Splunk instances with SSL support
• OpenSearch Integration: Connect to OpenSearch clusters for rule synchronization
• Connection Testing: Validate configurations before deployment
• Status Monitoring: Real-time connector health and connectivity status

📋 Rules & Payloads

• Rule Synchronization: Automatically fetch detection rules from connected SIEM platforms
• Payload Association: Link PowerShell payloads to specific detection rules
• Custom Payload Creation: Build and edit PowerShell scripts for rule testing
• Rule Filtering: Filter rules by payload status and connector type
• Last Sync Tracking: Monitor synchronization timestamps and rule freshness

⚡ Execution & Results

• Payload Execution: Run individual or batch payloads against associated rules
• Result Analysis: View detailed execution outputs and error messages
• Status Filtering: Filter results by triggered/not triggered/error states
• Time-based Filtering: Analyze executions over different time periods
• Batch Operations: Execute all payloads for displayed rules simultaneously

(⬆️ back to top)

Health Page 🩺

Comprehensive system monitoring dashboard:

🖥️ Component Status

• Opensearch Dashboard - Web interface status
• Postgres - Database
• Opensearch - Search engine status
• VirtualBox - Virtualization platform
• Flask Backend - Application server

📊 Resource Monitoring

• RAM Usage - Memory utilization
• Disk Usage - Storage consumption

🔧 VM Management

• Status Monitoring - Current VM state
• IP Information - Network configuration
• Snapshot Control - Restore points management

Note: Snapshot restoration may show errors even when successful - verify by connecting to the VM.

Admin Page 🔐

Administrative control center for system configuration:

🔑 Key Features

• LDAP Configuration: Centralized authentication setup
• API Key Generation: Secure API access management
• AlienVault OTX API Key: Configure threat intelligence integration for enhanced KPIs
• System Settings: Core configuration management

🔐 Access Requirements

Login with administrator account: admin@local.com

(⬆️ back to top)

🔌 Splunk App

Repository: TA-Purplelab-Splunk

Features

• 🚀 Atomic Red Team Integration: Execute tests directly from Splunk
• 🔍 Threat Hunting Dashboard: Dedicated hunting interface
• 🔗 Seamless Integration: Easy PurpleLab-Splunk connectivity

Demo

Ta-purplelab.mp4

🔍 Cortex Analyzer

Repository: PurpleLab-Cortex-Analyzer

Capabilities

• 📤 Automated Uploads: Seamless executable transfer to PurpleLab
• 💥 Detonation Analysis: Automated malware execution and analysis
• 🔗 TheHive Integration: Enhanced incident response workflows

Demo

analyzer.purplelab.mp4

(⬆️ back to top)

📚 API documentation

For comprehensive API usage and integration details, see our complete documentation:

📖 API Documentation

(⬆️ back to top)