# 0xflux/sanctum architecture

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

- Interactive diagram: https://gitdiagram.com/0xflux/sanctum
- Repository: https://github.com/0xflux/sanctum

## Overview

Sanctum EDR is an experimental Windows endpoint detection and response platform. Its principal workflow is: the GUI sends scan, settings, process, or driver requests through IPC; the usermode engine coordinates scanning and driver communication; the kernel driver observes processes, threads, registry/filesystem activity, and syscall behavior; resulting telemetry is queued and returned to the GUI. A Protected Process Light service separately starts ETW Threat Intelligence tracing. The graph emphasizes runtime components supported by the tree, README, and sampled code; unsampled integrations are shown conservatively.

Main entry points: [`driver/src/lib.rs`](https://github.com/0xflux/sanctum/blob/main/driver/src/lib.rs) (Kernel Driver), [`um_engine/src/engine.rs`](https://github.com/0xflux/sanctum/blob/main/um_engine/src/engine.rs) (Engine Runtime), [`um_engine/src/core/core.rs`](https://github.com/0xflux/sanctum/blob/main/um_engine/src/core/core.rs) (Engine Core), [`gui/src-tauri/src/ipc.rs`](https://github.com/0xflux/sanctum/blob/main/gui/src-tauri/src/ipc.rs) (GUI IPC)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_presentation["User Interface"]
  node_gui["Tauri GUI<br/>[main.rs]"]
  node_gui_ipc["GUI IPC<br/>[ipc.rs]"]
end

subgraph group_engine["Usermode Engine"]
  node_engine_main["Engine Runtime<br/>[engine.rs]"]
  node_engine_core["Engine Core<br/>[core.rs]"]
  node_driver_manager["Driver Manager<br/>[driver_manager.rs]"]
  node_file_scanner["File Scanner<br/>[filescanner.rs]"]
  node_settings["Settings<br/>[settings.rs]"]
end

subgraph group_kernel["Kernel Detection"]
  node_kernel_driver["Kernel Driver<br/>[lib.rs]"]
  node_syscall_intercept["Syscall Interception"]
  node_process_callbacks["Process Callbacks"]
  node_system_monitors["System Monitors<br/>[filesystem.rs]"]
  node_ghost_hunting["Ghost Hunting<br/>[ghost_hunting.rs]"]
end

subgraph group_telemetry["ETW Telemetry"]
  node_ppl_service["PPL ETW Service<br/>[main.rs]"]
  node_etw_trace["Threat Intel Trace<br/>[tracing.rs]"]
end

subgraph group_shared["Shared State"]
  node_event_queue["Kernel Event Queue<br/>[driver_manager.rs]"]
end

node_user(("Operator"))

node_user -->|"uses"| node_gui
node_gui -->|"dispatches"| node_gui_ipc
node_gui_ipc -->|"sends requests"| node_engine_main
node_engine_main -->|"starts"| node_engine_core
node_engine_main -->|"creates"| node_driver_manager
node_engine_main -->|"creates"| node_file_scanner
node_engine_main -->|"loads"| node_settings
node_engine_core -->|"talks to"| node_driver_manager
node_driver_manager -->|"controls"| node_kernel_driver
node_kernel_driver -->|"dispatches"| node_syscall_intercept
node_kernel_driver -->|"registers"| node_process_callbacks
node_kernel_driver -->|"registers"| node_system_monitors
node_kernel_driver -->|"detects"| node_ghost_hunting
node_kernel_driver -->|"queues events"| node_event_queue
node_engine_core -->|"reads events"| node_event_queue
node_engine_core -->|"returns results"| node_gui_ipc
node_ppl_service -->|"starts tracing"| node_etw_trace

click node_gui "https://github.com/0xflux/sanctum/blob/main/gui/src-tauri/src/main.rs"
click node_gui_ipc "https://github.com/0xflux/sanctum/blob/main/gui/src-tauri/src/ipc.rs"
click node_engine_main "https://github.com/0xflux/sanctum/blob/main/um_engine/src/engine.rs"
click node_engine_core "https://github.com/0xflux/sanctum/blob/main/um_engine/src/core/core.rs"
click node_driver_manager "https://github.com/0xflux/sanctum/blob/main/um_engine/src/driver_manager/driver_manager.rs"
click node_file_scanner "https://github.com/0xflux/sanctum/blob/main/um_engine/src/filescanner.rs"
click node_settings "https://github.com/0xflux/sanctum/blob/main/um_engine/src/settings.rs"
click node_kernel_driver "https://github.com/0xflux/sanctum/blob/main/driver/src/lib.rs"
click node_syscall_intercept "https://github.com/0xflux/sanctum/blob/main/driver/src/core/syscall_processing.rs"
click node_process_callbacks "https://github.com/0xflux/sanctum/blob/main/driver/src/core/process_callbacks.rs"
click node_system_monitors "https://github.com/0xflux/sanctum/blob/main/driver/src/core/filesystem.rs"
click node_ghost_hunting "https://github.com/0xflux/sanctum/blob/main/shared_no_std/src/ghost_hunting.rs"
click node_ppl_service "https://github.com/0xflux/sanctum/blob/main/sanctum_ppl_runner/src/main.rs"
click node_etw_trace "https://github.com/0xflux/sanctum/blob/main/sanctum_ppl_runner/src/tracing.rs"
click node_event_queue "https://github.com/0xflux/sanctum/blob/main/shared_std/src/driver_manager.rs"

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_gui,node_gui_ipc toneBlue
class node_engine_main,node_engine_core,node_driver_manager,node_file_scanner,node_settings toneAmber
class node_kernel_driver,node_syscall_intercept,node_process_callbacks,node_system_monitors,node_ghost_hunting toneMint
class node_ppl_service,node_etw_trace toneRose
class node_event_queue,node_user toneIndigo
```

## Components

### User Interface

- [Tauri GUI](https://github.com/0xflux/sanctum/blob/main/gui/src-tauri/src/main.rs): `gui/src-tauri/src/main.rs`
- [GUI IPC](https://github.com/0xflux/sanctum/blob/main/gui/src-tauri/src/ipc.rs): `gui/src-tauri/src/ipc.rs`

### Usermode Engine

- [Engine Runtime](https://github.com/0xflux/sanctum/blob/main/um_engine/src/engine.rs): `um_engine/src/engine.rs`
- [Engine Core](https://github.com/0xflux/sanctum/blob/main/um_engine/src/core/core.rs): `um_engine/src/core/core.rs`
- [Driver Manager](https://github.com/0xflux/sanctum/blob/main/um_engine/src/driver_manager/driver_manager.rs): `um_engine/src/driver_manager/driver_manager.rs`
- [File Scanner](https://github.com/0xflux/sanctum/blob/main/um_engine/src/filescanner.rs): `um_engine/src/filescanner.rs`
- [Settings](https://github.com/0xflux/sanctum/blob/main/um_engine/src/settings.rs): `um_engine/src/settings.rs`

### Kernel Detection

- [Kernel Driver](https://github.com/0xflux/sanctum/blob/main/driver/src/lib.rs): `driver/src/lib.rs`
- [Syscall Interception](https://github.com/0xflux/sanctum/blob/main/driver/src/core/syscall_processing.rs): `driver/src/core/syscall_processing.rs`
- [Process Callbacks](https://github.com/0xflux/sanctum/blob/main/driver/src/core/process_callbacks.rs): `driver/src/core/process_callbacks.rs`
- [System Monitors](https://github.com/0xflux/sanctum/blob/main/driver/src/core/filesystem.rs): `driver/src/core/filesystem.rs`
- [Ghost Hunting](https://github.com/0xflux/sanctum/blob/main/shared_no_std/src/ghost_hunting.rs): `shared_no_std/src/ghost_hunting.rs`

### ETW Telemetry

- [PPL ETW Service](https://github.com/0xflux/sanctum/blob/main/sanctum_ppl_runner/src/main.rs): `sanctum_ppl_runner/src/main.rs`
- [Threat Intel Trace](https://github.com/0xflux/sanctum/blob/main/sanctum_ppl_runner/src/tracing.rs): `sanctum_ppl_runner/src/tracing.rs`

### Shared State

- [Kernel Event Queue](https://github.com/0xflux/sanctum/blob/main/shared_std/src/driver_manager.rs): `shared_std/src/driver_manager.rs`

### Other components

- **Operator**

## Connections

- Operator → Tauri GUI: uses
- Tauri GUI → GUI IPC: dispatches
- GUI IPC → Engine Runtime: sends requests
- Engine Runtime → Engine Core: starts
- Engine Runtime → Driver Manager: creates
- Engine Runtime → File Scanner: creates
- Engine Runtime → Settings: loads
- Engine Core → Driver Manager: talks to
- Driver Manager → Kernel Driver: controls
- Kernel Driver → Syscall Interception: dispatches
- Kernel Driver → Process Callbacks: registers
- Kernel Driver → System Monitors: registers
- Kernel Driver → Ghost Hunting: detects
- Kernel Driver → Kernel Event Queue: queues events
- Engine Core → Kernel Event Queue: reads events
- Engine Core → GUI IPC: returns results
- PPL ETW Service → Threat Intel Trace: starts tracing
