How iburres/otforge works
OTForge is an Electron-based ICS/SCADA training and research platform. Its main workflow is to author a layered industrial scenario, configure devices and control logic, deploy it as Docker containers, then interact with the live environment and inspect telemetry; scenarios can also be replayed deterministically. The graph includes the documented security-monitoring, attack, export, and PLC capabilities. Some implementation links are based on README statements because the relevant source was not excerpted; uncertain internal wiring is omitted.
Main entry points: App.tsx Application shell · ScadaCanvas.tsx SCADA canvas · compose-generator.ts Compose generator · icslab.ts Scenario schema
Components 24
Scenario authoring
- SCADA canvas
packages/app/src/renderer/src/canvas/ScadaCanvas.tsx - Device nodes
packages/app/src/renderer/src/canvas/DeviceNode.tsx - Canvas edges
packages/app/src/renderer/src/canvas/PipeEdge.tsx - Connection rules
packages/app/src/renderer/src/canvas/connectionRules.ts - Device palette
packages/app/src/renderer/src/palette/DevicePalette.tsx - Device icons
packages/app/src/renderer/src/icons/DeviceIcons.tsx - Device properties
packages/app/src/renderer/src/properties/PropertiesPanel.tsx - Controller settings
packages/app/src/renderer/src/properties/ControllerPanel.tsx - PLC IDE
packages/app/src/renderer/src/properties/PlcIdePanel.tsx - Scenario schema
packages/schema/src/icslab.ts - Scenario export
packages/app/src/renderer/src/export/ExportModal.tsx
Deployment and control
- Compose generator
packages/orchestrator/src/compose-generator.ts - PLC program generation
packages/orchestrator/src/plc-program-gen.ts - Docker lifecycle
packages/orchestrator/src/docker-client.ts
Simulated plant
- Process simulator
containers/process-sim/sim.py - Industrial protocol services
containers/modbus/server.py
Attack and monitoring
- Kali attack desktop
containers/workstation/iec61850-client.c - Monitoring dashboard
packages/app/src/renderer/src/monitor/MonitorPanel.tsx - Suricata rule validation
packages/orchestrator/src/suricata-rules.ts
Desktop application
- Application shell
packages/app/src/renderer/src/App.tsx - Saved sessions
packages/app/src/main/sessions.ts - Scenario pack manager
packages/app/src/renderer/src/packs/PackManagerModal.tsx - Network settings
packages/app/src/renderer/src/settings/SettingsModal.tsx
Other components
- Researcher / instructor
Connections 30
- Researcher / instructor → Application shell: authors and runs
README.md - Application shell → SCADA canvas: renders editor
packages/app/src/renderer/src/App.tsx - Application shell → Device palette: renders palette
packages/app/src/renderer/src/App.tsx - Application shell → Device properties: renders inspector
packages/app/src/renderer/src/App.tsx - Application shell → PLC IDE: opens IDE
packages/app/src/renderer/src/App.tsx - Application shell → Monitoring dashboard: opens monitor
packages/app/src/renderer/src/App.tsx - SCADA canvas → Device nodes: renders nodes
packages/app/src/renderer/src/canvas/ScadaCanvas.tsx - SCADA canvas → Canvas edges: renders edges
packages/app/src/renderer/src/canvas/ScadaCanvas.tsx - SCADA canvas → Connection rules: checks connections
packages/app/src/renderer/src/canvas/ScadaCanvas.tsx - Device palette → Device icons: uses icons
packages/app/src/renderer/src/palette/DevicePalette.tsx - Device properties → Controller settings: delegates settings
packages/app/src/renderer/src/properties/PropertiesPanel.tsx - SCADA canvas → Scenario schema: edits scenario
packages/app/src/renderer/src/canvas/ScadaCanvas.tsx - Device properties → Scenario schema: configures devices
packages/app/src/renderer/src/properties/PropertiesPanel.tsx - PLC IDE → Scenario schema: edits PLC config
packages/app/src/renderer/src/properties/PlcIdePanel.tsx - Scenario export → Scenario schema: exports scenario
packages/app/src/renderer/src/export/ExportModal.tsx - Researcher / instructor → Scenario export: exports lab
README.md - Scenario schema → Compose generator: defines deployment input
packages/orchestrator/src/compose-generator.ts - Compose generator → PLC program generation: generates PLC program
packages/orchestrator/src/compose-generator.ts - Researcher / instructor → Docker lifecycle: starts simulation
README.md - Docker lifecycle → Compose generator: deploys generated stack
packages/orchestrator/src/docker-client.ts - Compose generator → Industrial protocol services: defines device containers
README.md - Compose generator → Process simulator: includes process simulator
README.md - PLC program generation → Industrial protocol services: provides PLC control logic
README.md - Researcher / instructor → Kali attack desktop: attacks live lab
README.md - Industrial protocol services → Process simulator: exchanges process state
- Researcher / instructor → Monitoring dashboard: inspects telemetry
README.md - Monitoring dashboard → Suricata rule validation: shows security alerts
README.md - Researcher / instructor → Saved sessions: saves progress
packages/app/src/main/sessions.ts - Researcher / instructor → Scenario pack manager: manages scenario packs
README.md - Researcher / instructor → Network settings: configures networks
README.md