# iburres/otforge architecture

> Architecture diagram of the GitHub repository iburres/otforge, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/iburres/otforge
- Repository: https://github.com/iburres/otforge

## Overview

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: [`packages/app/src/renderer/src/App.tsx`](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/App.tsx) (Application shell), [`packages/app/src/renderer/src/canvas/ScadaCanvas.tsx`](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/ScadaCanvas.tsx) (SCADA canvas), [`packages/orchestrator/src/compose-generator.ts`](https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/compose-generator.ts) (Compose generator), [`packages/schema/src/icslab.ts`](https://github.com/iburres/otforge/blob/main/packages/schema/src/icslab.ts) (Scenario schema)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_author["Scenario authoring"]
  node_canvas["SCADA canvas<br/>[ScadaCanvas.tsx]"]
  node_device["Device nodes<br/>[DeviceNode.tsx]"]
  node_edges["Canvas edges<br/>[PipeEdge.tsx]"]
  node_rules["Connection rules<br/>[connectionRules.ts]"]
  node_palette["Device palette<br/>[DevicePalette.tsx]"]
  node_icons["Device icons<br/>[DeviceIcons.tsx]"]
  node_properties["Device properties"]
  node_controller["Controller settings"]
  node_plcide["PLC IDE<br/>[PlcIdePanel.tsx]"]
  node_schema["Scenario schema<br/>[icslab.ts]"]
  node_export["Scenario export<br/>[ExportModal.tsx]"]
end

subgraph group_deploy["Deployment and control"]
  node_compose["Compose generator"]
  node_plcgen["PLC program generation<br/>[plc-program-gen.ts]"]
  node_docker["Docker lifecycle<br/>[docker-client.ts]"]
end

subgraph group_plant["Simulated plant"]
  node_sim["Process simulator<br/>[sim.py]"]
  node_protocols["Industrial protocol services<br/>[server.py]"]
end

subgraph group_security["Attack and monitoring"]
  node_attack["Kali attack desktop<br/>[iec61850-client.c]"]
  node_monitor["Monitoring dashboard<br/>[MonitorPanel.tsx]"]
  node_suricata["Suricata rule validation<br/>[suricata-rules.ts]"]
end

subgraph group_desktop["Desktop application"]
  node_app["Application shell<br/>[App.tsx]"]
  node_sessions[("Saved sessions<br/>[sessions.ts]")]
  node_packs["Scenario pack manager"]
  node_settings["Network settings<br/>[SettingsModal.tsx]"]
end

node_researcher(("Researcher / instructor"))

node_researcher -->|"authors and runs"| node_app
node_app -->|"renders editor"| node_canvas
node_app -->|"renders palette"| node_palette
node_app -->|"renders inspector"| node_properties
node_app -->|"opens IDE"| node_plcide
node_app -->|"opens monitor"| node_monitor
node_canvas -->|"renders nodes"| node_device
node_canvas -->|"renders edges"| node_edges
node_canvas -->|"checks connections"| node_rules
node_palette -->|"uses icons"| node_icons
node_properties -->|"delegates settings"| node_controller
node_canvas -->|"edits scenario"| node_schema
node_properties -->|"configures devices"| node_schema
node_plcide -->|"edits PLC config"| node_schema
node_export -->|"exports scenario"| node_schema
node_researcher -->|"exports lab"| node_export
node_schema -->|"defines deployment input"| node_compose
node_compose -->|"generates PLC program"| node_plcgen
node_researcher -->|"starts simulation"| node_docker
node_docker -->|"deploys generated stack"| node_compose
node_compose -->|"defines device containers"| node_protocols
node_compose -->|"includes process simulator"| node_sim
node_plcgen -->|"provides PLC control logic"| node_protocols
node_researcher -->|"attacks live lab"| node_attack
node_protocols -.->|"exchanges process state"| node_sim
node_researcher -->|"inspects telemetry"| node_monitor
node_monitor -->|"shows security alerts"| node_suricata
node_researcher -->|"saves progress"| node_sessions
node_researcher -->|"manages scenario packs"| node_packs
node_researcher -->|"configures networks"| node_settings

click node_app "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/App.tsx"
click node_canvas "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/ScadaCanvas.tsx"
click node_device "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/DeviceNode.tsx"
click node_edges "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/PipeEdge.tsx"
click node_rules "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/connectionRules.ts"
click node_palette "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/palette/DevicePalette.tsx"
click node_icons "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/icons/DeviceIcons.tsx"
click node_properties "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/properties/PropertiesPanel.tsx"
click node_controller "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/properties/ControllerPanel.tsx"
click node_plcide "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/properties/PlcIdePanel.tsx"
click node_schema "https://github.com/iburres/otforge/blob/main/packages/schema/src/icslab.ts"
click node_export "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/export/ExportModal.tsx"
click node_compose "https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/compose-generator.ts"
click node_plcgen "https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/plc-program-gen.ts"
click node_docker "https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/docker-client.ts"
click node_sim "https://github.com/iburres/otforge/blob/main/containers/process-sim/sim.py"
click node_protocols "https://github.com/iburres/otforge/blob/main/containers/modbus/server.py"
click node_attack "https://github.com/iburres/otforge/blob/main/containers/workstation/iec61850-client.c"
click node_monitor "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/monitor/MonitorPanel.tsx"
click node_suricata "https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/suricata-rules.ts"
click node_sessions "https://github.com/iburres/otforge/blob/main/packages/app/src/main/sessions.ts"
click node_packs "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/packs/PackManagerModal.tsx"
click node_settings "https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/settings/SettingsModal.tsx"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_canvas,node_device,node_edges,node_rules,node_palette,node_icons,node_properties,node_controller,node_plcide,node_schema,node_export toneBlue
class node_compose,node_plcgen,node_docker toneAmber
class node_sim,node_protocols toneMint
class node_attack,node_monitor,node_suricata toneRose
class node_app,node_sessions,node_packs,node_settings,node_researcher toneIndigo
```

## Components

### Scenario authoring

- [SCADA canvas](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/ScadaCanvas.tsx): `packages/app/src/renderer/src/canvas/ScadaCanvas.tsx`
- [Device nodes](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/DeviceNode.tsx): `packages/app/src/renderer/src/canvas/DeviceNode.tsx`
- [Canvas edges](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/PipeEdge.tsx): `packages/app/src/renderer/src/canvas/PipeEdge.tsx`
- [Connection rules](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/canvas/connectionRules.ts): `packages/app/src/renderer/src/canvas/connectionRules.ts`
- [Device palette](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/palette/DevicePalette.tsx): `packages/app/src/renderer/src/palette/DevicePalette.tsx`
- [Device icons](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/icons/DeviceIcons.tsx): `packages/app/src/renderer/src/icons/DeviceIcons.tsx`
- [Device properties](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/properties/PropertiesPanel.tsx): `packages/app/src/renderer/src/properties/PropertiesPanel.tsx`
- [Controller settings](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/properties/ControllerPanel.tsx): `packages/app/src/renderer/src/properties/ControllerPanel.tsx`
- [PLC IDE](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/properties/PlcIdePanel.tsx): `packages/app/src/renderer/src/properties/PlcIdePanel.tsx`
- [Scenario schema](https://github.com/iburres/otforge/blob/main/packages/schema/src/icslab.ts): `packages/schema/src/icslab.ts`
- [Scenario export](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/export/ExportModal.tsx): `packages/app/src/renderer/src/export/ExportModal.tsx`

### Deployment and control

- [Compose generator](https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/compose-generator.ts): `packages/orchestrator/src/compose-generator.ts`
- [PLC program generation](https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/plc-program-gen.ts): `packages/orchestrator/src/plc-program-gen.ts`
- [Docker lifecycle](https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/docker-client.ts): `packages/orchestrator/src/docker-client.ts`

### Simulated plant

- [Process simulator](https://github.com/iburres/otforge/blob/main/containers/process-sim/sim.py): `containers/process-sim/sim.py`
- [Industrial protocol services](https://github.com/iburres/otforge/blob/main/containers/modbus/server.py): `containers/modbus/server.py`

### Attack and monitoring

- [Kali attack desktop](https://github.com/iburres/otforge/blob/main/containers/workstation/iec61850-client.c): `containers/workstation/iec61850-client.c`
- [Monitoring dashboard](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/monitor/MonitorPanel.tsx): `packages/app/src/renderer/src/monitor/MonitorPanel.tsx`
- [Suricata rule validation](https://github.com/iburres/otforge/blob/main/packages/orchestrator/src/suricata-rules.ts): `packages/orchestrator/src/suricata-rules.ts`

### Desktop application

- [Application shell](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/App.tsx): `packages/app/src/renderer/src/App.tsx`
- [Saved sessions](https://github.com/iburres/otforge/blob/main/packages/app/src/main/sessions.ts): `packages/app/src/main/sessions.ts`
- [Scenario pack manager](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/packs/PackManagerModal.tsx): `packages/app/src/renderer/src/packs/PackManagerModal.tsx`
- [Network settings](https://github.com/iburres/otforge/blob/main/packages/app/src/renderer/src/settings/SettingsModal.tsx): `packages/app/src/renderer/src/settings/SettingsModal.tsx`

### Other components

- **Researcher / instructor**

## Connections

- Researcher / instructor → Application shell: authors and runs (evidence: `README.md`)
- Application shell → SCADA canvas: renders editor (evidence: `packages/app/src/renderer/src/App.tsx`)
- Application shell → Device palette: renders palette (evidence: `packages/app/src/renderer/src/App.tsx`)
- Application shell → Device properties: renders inspector (evidence: `packages/app/src/renderer/src/App.tsx`)
- Application shell → PLC IDE: opens IDE (evidence: `packages/app/src/renderer/src/App.tsx`)
- Application shell → Monitoring dashboard: opens monitor (evidence: `packages/app/src/renderer/src/App.tsx`)
- SCADA canvas → Device nodes: renders nodes (evidence: `packages/app/src/renderer/src/canvas/ScadaCanvas.tsx`)
- SCADA canvas → Canvas edges: renders edges (evidence: `packages/app/src/renderer/src/canvas/ScadaCanvas.tsx`)
- SCADA canvas → Connection rules: checks connections (evidence: `packages/app/src/renderer/src/canvas/ScadaCanvas.tsx`)
- Device palette → Device icons: uses icons (evidence: `packages/app/src/renderer/src/palette/DevicePalette.tsx`)
- Device properties → Controller settings: delegates settings (evidence: `packages/app/src/renderer/src/properties/PropertiesPanel.tsx`)
- SCADA canvas → Scenario schema: edits scenario (evidence: `packages/app/src/renderer/src/canvas/ScadaCanvas.tsx`)
- Device properties → Scenario schema: configures devices (evidence: `packages/app/src/renderer/src/properties/PropertiesPanel.tsx`)
- PLC IDE → Scenario schema: edits PLC config (evidence: `packages/app/src/renderer/src/properties/PlcIdePanel.tsx`)
- Scenario export → Scenario schema: exports scenario (evidence: `packages/app/src/renderer/src/export/ExportModal.tsx`)
- Researcher / instructor → Scenario export: exports lab (evidence: `README.md`)
- Scenario schema → Compose generator: defines deployment input (evidence: `packages/orchestrator/src/compose-generator.ts`)
- Compose generator → PLC program generation: generates PLC program (evidence: `packages/orchestrator/src/compose-generator.ts`)
- Researcher / instructor → Docker lifecycle: starts simulation (evidence: `README.md`)
- Docker lifecycle → Compose generator: deploys generated stack (evidence: `packages/orchestrator/src/docker-client.ts`)
- Compose generator → Industrial protocol services: defines device containers (evidence: `README.md`)
- Compose generator → Process simulator: includes process simulator (evidence: `README.md`)
- PLC program generation → Industrial protocol services: provides PLC control logic (evidence: `README.md`)
- Researcher / instructor → Kali attack desktop: attacks live lab (evidence: `README.md`)
- Industrial protocol services → Process simulator: exchanges process state
- Researcher / instructor → Monitoring dashboard: inspects telemetry (evidence: `README.md`)
- Monitoring dashboard → Suricata rule validation: shows security alerts (evidence: `README.md`)
- Researcher / instructor → Saved sessions: saves progress (evidence: `packages/app/src/main/sessions.ts`)
- Researcher / instructor → Scenario pack manager: manages scenario packs (evidence: `README.md`)
- Researcher / instructor → Network settings: configures networks (evidence: `README.md`)
