# mrhenrike/industrialxpl-forge architecture

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

- Interactive diagram: https://gitdiagram.com/mrhenrike/industrialxpl-forge
- Repository: https://github.com/mrhenrike/industrialxpl-forge

## Overview

IndustrialXPL-Forge is an OT/ICS security assessment and exploitation framework. Its principal workflow is an operator using the interactive shell to find and load a module, run checks or an authorized exploit against industrial assets, and generate reports. Major product branches also cover protocol- and vendor-specific modules, MITRE ATT&CK for ICS, passive detection and compliance assessment, and malware research in lab settings. The graph reflects documented capabilities and indexed source references; unsampled module internals and their wiring are not inferred.

Main entry points: [`industrialxpl/interpreter.py`](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/interpreter.py) (Interactive Shell), [`industrialxpl/modules`](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules) (OT Modules), [`industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py`](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py) (Malware Lab Pipeline), [`industrialxpl/core/exploit/utils.py`](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/utils.py) (Module Discovery)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interaction["Operator Interface"]
  node_shell["Interactive Shell<br/>[interpreter.py]"]
  node_api["REST API<br/>[server.py]"]
end

subgraph group_modules["Module Runtime"]
  node_search["Module Search<br/>[engine.py]"]
  node_loader["Module Discovery<br/>[utils.py]"]
  node_exploit_runtime["Exploit Runtime<br/>[exploit.py]"]
  node_safety["Safety Gate<br/>[safety.py]"]
  node_module_catalog["OT Modules"]
  node_cve_modules["CVE Modules"]
  node_credential_modules["Credential Modules"]
  node_reporting["Report Generation<br/>[reporter.py]"]
end

subgraph group_assessment["Assessment"]
  node_assessment_modules["Risk and Compliance"]
  node_detection_modules["Detection Analysis"]
  node_mitre_sweep["MITRE ICS Sweep<br/>[sweeper.py]"]
  node_mitre_tactics["MITRE Techniques<br/>[tactics.py]"]
end

subgraph group_protocols["OT Protocols"]
  node_protocol_clients["Protocol Clients"]
  node_protocols["Protocol Implementations"]
end

subgraph group_malware["Malware Research"]
  node_malware_pipeline["Malware Lab Pipeline"]
  node_malware_core["Malware Operations"]
  node_c2["C2 Services<br/>[c2_server.py]"]
  node_c2_database[("C2 State<br/>[db_init.py]")]
end

node_operator(("Operator"))
node_target{{"OT/ICS Assets"}}

node_operator -->|"issues commands"| node_shell
node_operator -.->|"uses API"| node_api
node_shell -->|"searches modules"| node_search
node_shell -->|"loads modules"| node_loader
node_loader -->|"indexes modules"| node_module_catalog
node_shell -->|"runs modules"| node_exploit_runtime
node_shell -->|"checks actions"| node_safety
node_exploit_runtime -->|"probes or exploits"| node_target
node_shell -->|"generates reports"| node_reporting
node_module_catalog -.->|"includes CVEs"| node_cve_modules
node_module_catalog -.->|"includes credentials"| node_credential_modules
node_operator -->|"runs assessments"| node_assessment_modules
node_operator -->|"analyzes traffic"| node_detection_modules
node_operator -->|"runs ATT&amp;CK sweep"| node_mitre_sweep
node_mitre_sweep -->|"uses techniques"| node_mitre_tactics
node_operator -->|"runs protocol checks"| node_protocol_clients
node_protocol_clients -.->|"communicates with"| node_target
node_operator -->|"runs lab research"| node_malware_pipeline
node_malware_pipeline -->|"orchestrates operations"| node_malware_core
node_malware_pipeline -->|"starts C2"| node_c2
node_c2 -->|"initializes schema"| node_c2_database

click node_shell "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/interpreter.py"
click node_api "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/api/server.py"
click node_search "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/search/engine.py"
click node_loader "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/utils.py"
click node_exploit_runtime "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/exploit.py"
click node_safety "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/safety.py"
click node_module_catalog "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules"
click node_cve_modules "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/cve"
click node_credential_modules "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/creds"
click node_reporting "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/reporting/reporter.py"
click node_assessment_modules "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/assessment"
click node_detection_modules "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/assessment/detection"
click node_mitre_sweep "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/mitre/sweeper.py"
click node_mitre_tactics "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/mitre/tactics.py"
click node_protocol_clients "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/core/ics"
click node_protocols "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/protocols"
click node_malware_pipeline "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py"
click node_malware_core "https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/core/malware"
click node_c2 "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/malware/c2_server.py"
click node_c2_database "https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/malware/db_init.py"

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_shell,node_api toneBlue
class node_search,node_loader,node_exploit_runtime,node_safety,node_module_catalog,node_cve_modules,node_credential_modules,node_reporting toneAmber
class node_assessment_modules,node_detection_modules,node_mitre_sweep,node_mitre_tactics toneMint
class node_protocol_clients,node_protocols toneRose
class node_malware_pipeline,node_malware_core,node_c2,node_c2_database,node_operator,node_target toneIndigo
```

## Components

### Operator Interface

- [Interactive Shell](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/interpreter.py): `industrialxpl/interpreter.py`
- [REST API](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/api/server.py): `industrialxpl/api/server.py`

### Module Runtime

- [Module Search](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/search/engine.py): `industrialxpl/core/search/engine.py`
- [Module Discovery](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/utils.py): `industrialxpl/core/exploit/utils.py`
- [Exploit Runtime](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/exploit.py): `industrialxpl/core/exploit/exploit.py`
- [Safety Gate](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/exploit/safety.py): `industrialxpl/core/exploit/safety.py`
- [OT Modules](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules): `industrialxpl/modules`
- [CVE Modules](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/cve): `industrialxpl/modules/cve`
- [Credential Modules](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/creds): `industrialxpl/modules/creds`
- [Report Generation](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/reporting/reporter.py): `industrialxpl/core/reporting/reporter.py`

### Assessment

- [Risk and Compliance](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/assessment): `industrialxpl/modules/assessment`
- [Detection Analysis](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/modules/assessment/detection): `industrialxpl/modules/assessment/detection`
- [MITRE ICS Sweep](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/mitre/sweeper.py): `industrialxpl/core/mitre/sweeper.py`
- [MITRE Techniques](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/mitre/tactics.py): `industrialxpl/core/mitre/tactics.py`

### OT Protocols

- [Protocol Clients](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/core/ics): `industrialxpl/core/ics`
- [Protocol Implementations](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/protocols): `industrialxpl/protocols`

### Malware Research

- [Malware Lab Pipeline](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py): `industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py`
- [Malware Operations](https://github.com/mrhenrike/industrialxpl-forge/tree/master/industrialxpl/core/malware): `industrialxpl/core/malware`
- [C2 Services](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/malware/c2_server.py): `industrialxpl/core/malware/c2_server.py`
- [C2 State](https://github.com/mrhenrike/industrialxpl-forge/blob/master/industrialxpl/core/malware/db_init.py): `industrialxpl/core/malware/db_init.py`

### Other components

- **Operator**
- **OT/ICS Assets**

## Connections

- Operator → Interactive Shell: issues commands (evidence: `README.md`)
- Operator → REST API: uses API (evidence: `README.md`)
- Interactive Shell → Module Search: searches modules (evidence: `industrialxpl/interpreter.py`)
- Interactive Shell → Module Discovery: loads modules (evidence: `industrialxpl/interpreter.py`)
- Module Discovery → OT Modules: indexes modules (evidence: `industrialxpl/core/exploit/utils.py`)
- Interactive Shell → Exploit Runtime: runs modules (evidence: `industrialxpl/interpreter.py`)
- Interactive Shell → Safety Gate: checks actions (evidence: `industrialxpl/interpreter.py`)
- Exploit Runtime → OT/ICS Assets: probes or exploits (evidence: `README.md`)
- Interactive Shell → Report Generation: generates reports (evidence: `industrialxpl/interpreter.py`)
- OT Modules → CVE Modules: includes CVEs (evidence: `README.md`)
- OT Modules → Credential Modules: includes credentials (evidence: `README.md`)
- Operator → Risk and Compliance: runs assessments (evidence: `README.md`)
- Operator → Detection Analysis: analyzes traffic (evidence: `README.md`)
- Operator → MITRE ICS Sweep: runs ATT&CK sweep (evidence: `README.md`)
- MITRE ICS Sweep → MITRE Techniques: uses techniques
- Operator → Protocol Clients: runs protocol checks (evidence: `README.md`)
- Protocol Clients → OT/ICS Assets: communicates with (evidence: `README.md`)
- Operator → Malware Lab Pipeline: runs lab research (evidence: `README.md`)
- Malware Lab Pipeline → Malware Operations: orchestrates operations (evidence: `industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py`)
- Malware Lab Pipeline → C2 Services: starts C2 (evidence: `industrialxpl/modules/scanners/malware_research/malware_full_pipeline.py`)
- C2 Services → C2 State: initializes schema (evidence: `industrialxpl/core/malware/c2_server.py`)
