Documentation

Comprehensive guides for the MSpread Platform and Simulation Engine.

MSpread Platform - User Guide

MSpread is a sophisticated cyber-security simulation tool designed to model and visualize how malware propagates through various network topologies. It allows security researchers and network administrators to simulate attack scenarios, test network resilience, and understand propagation patterns.

Workflow Phases

  1. Network Construction: Defining the infrastructure, devices, and topology.
  2. Payload Execution: Configuring the malware agent and releasing it into the environment.

Navigation & Interface

Sidebar Navigation

  • Simulation: Main dashboard for configuration.
  • Network: Real-time topology visualization.
  • Analytics: Post-simulation data charts.
  • Logs: Raw event stream.

Status Indicators

  • Engine Ready: Backend connected
  • Simulating: Active simulation
  • Offline: API disconnected

Phase 1: Network Architecture

Before attacking, you must build the environment.

Standard Node Network (Simple)

  • Node Count: 10-1000 devices.
  • Topology: Scale Free, Small World, Random, Complete.
  • OS Preset: Define OS for all nodes.
  • Security: Toggle Firewalls/Antivirus globally.

Segmented Node Network (Advanced)

  • Subnets (Zones): Create distinct zones (e.g., Server Farm, HR Dept).
  • Interconnects: Link zones to simulate routers/gateways.

Phase 2: Payload Configuration

Core Parameters

  • Patient Zero: Entry point node ID (e.g., "device_5").
  • Spread Logic: Random Walk, BFS (Fast), DFS (Stealthy).
  • Infection Rate: Probability (0-100%).

Advanced Vectors

  • Behavioral Evasion: Avoid Admin nodes, Require User Interaction.
  • Targeting: Restrict to specific OS or Device Type.
  • Exploits: Bypass Firewall, Zero-Day, CVE Only.

Analysis & Visualization

  • Network Graph: Force-directed layout. Green = Healthy, Red = Infected. Zoom/Pan supported.
  • Propagation Timeline: Area chart showing spread velocity.
  • Distribution: Metrics on total infected nodes and steps taken.

Quick Start: Your First Simulation

  1. Build Network: Go to Simulation tab. Set Nodes to 50, Topology to Scale Free. Click Build Network.
  2. Preview: Switch to Network tab to see the healthy cluster.
  3. Configure Malware: Return to Simulation. Select Worm, Infection Rate 0.5.
  4. Launch: Click Run Simulation.
  5. Analyze: Watch the graph turn red, then check Analytics for the timeline.

Troubleshooting

Offline Status

Ensure python main.py run is executing and port 8000 is open.

Laggy Visualization

Reduce node count (<200) or enable hardware acceleration.