# igen-uk07/velric architecture

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

- Interactive diagram: https://gitdiagram.com/igen-uk07/velric
- Repository: https://github.com/igen-uk07/velric

## Overview

Velric is a static PE/ELF security analyzer. Its user workflow is to submit a binary through the CLI, parse its format and collect structural, capability, behavioral, YARA, and disassembly evidence, then normalize and correlate findings, score risk, enrich with ATT&CK metadata, and render a terminal or JSON report. The graph preserves the documented analysis branches and major analyzer modules. Some subsystem links come from README or SOURCE INDEX references; unsampled implementation details are not inferred beyond those references.

Main entry points: [`velric/core/analysis_engine.py`](https://github.com/igen-uk07/velric/blob/main/velric/core/analysis_engine.py) (Analysis Engine), [`velric/cli.py`](https://github.com/igen-uk07/velric/blob/main/velric/cli.py) (CLI), [`velric/disassembly/disassembler.py`](https://github.com/igen-uk07/velric/blob/main/velric/disassembly/disassembler.py) (Disassembly), [`velric/mitre/enricher.py`](https://github.com/igen-uk07/velric/blob/main/velric/mitre/enricher.py) (ATT&CK Enrichment)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User Interface"]
  node_cli["CLI<br/>[cli.py]"]
  node_engine["Analysis Engine<br/>[analysis_engine.py]"]
end

subgraph group_binary["Binary Analysis"]
  node_pe["PE Parser<br/>[pe_parser.py]"]
  node_elf["ELF Parser<br/>[elf_parser.py]"]
  node_importnorm["Import Normalizer"]
  node_disassembly["Disassembly<br/>[disassembler.py]"]
  node_instruction["Instruction Analysis"]
end

subgraph group_security["Security Findings"]
  node_capability["Capability Analysis"]
  node_network["Network Analysis"]
  node_strings["String Analysis<br/>[string_analyzer.py]"]
  node_entropy["Entropy Analysis"]
  node_packing["Packing Analysis"]
  node_instructionsec["Instruction Security"]
  node_yara["YARA Scanning<br/>[analyzer.py]"]
end

subgraph group_assessment["Finding Assessment"]
  node_normalizer["Finding Normalizer<br/>[normalizer.py]"]
  node_correlator["Behavior Correlator<br/>[correlator.py]"]
  node_risk["Risk Scoring<br/>[risk_engine.py]"]
  node_mitre["ATT&amp;CK Enrichment<br/>[enricher.py]"]
end

subgraph group_reporting["Results"]
  node_result["Analysis Result<br/>[analysis_result.py]"]
  node_terminal["Terminal Report"]
  node_json["JSON Report<br/>[json_reporter.py]"]
end

node_user(("Analyst"))

node_user -->|"submits binary"| node_cli
node_cli -->|"runs analysis"| node_engine
node_engine -->|"parses PE"| node_pe
node_engine -->|"parses ELF"| node_elf
node_engine -->|"normalizes imports"| node_importnorm
node_engine -->|"collects disassembly"| node_disassembly
node_disassembly -->|"analyzes instructions"| node_instruction
node_engine -->|"collects security"| node_capability
node_engine -->|"collects security"| node_network
node_engine -->|"extracts strings"| node_strings
node_engine -->|"collects security"| node_entropy
node_engine -->|"collects security"| node_packing
node_engine -->|"collects security"| node_instructionsec
node_engine -->|"scans binary"| node_yara
node_engine -->|"normalizes findings"| node_normalizer
node_engine -->|"correlates findings"| node_correlator
node_engine -->|"scores findings"| node_risk
node_engine -->|"enriches findings"| node_mitre
node_mitre -.->|"adds mappings"| node_result
node_cli -->|"prints report"| node_terminal
node_cli -->|"writes report"| node_json
node_engine -->|"builds result"| node_result

click node_cli "https://github.com/igen-uk07/velric/blob/main/velric/cli.py"
click node_engine "https://github.com/igen-uk07/velric/blob/main/velric/core/analysis_engine.py"
click node_pe "https://github.com/igen-uk07/velric/blob/main/velric/parsers/pe_parser.py"
click node_elf "https://github.com/igen-uk07/velric/blob/main/velric/parsers/elf_parser.py"
click node_importnorm "https://github.com/igen-uk07/velric/blob/main/velric/core/import_normalizer.py"
click node_disassembly "https://github.com/igen-uk07/velric/blob/main/velric/disassembly/disassembler.py"
click node_instruction "https://github.com/igen-uk07/velric/blob/main/velric/disassembly/instruction_analyzer.py"
click node_capability "https://github.com/igen-uk07/velric/blob/main/velric/analyzers/capability_analyzer.py"
click node_network "https://github.com/igen-uk07/velric/blob/main/velric/analyzers/network_analyzer.py"
click node_strings "https://github.com/igen-uk07/velric/blob/main/velric/analyzers/string_analyzer.py"
click node_entropy "https://github.com/igen-uk07/velric/blob/main/velric/analyzers/entropy_analyzer.py"
click node_packing "https://github.com/igen-uk07/velric/blob/main/velric/analyzers/packing_analyzer.py"
click node_instructionsec "https://github.com/igen-uk07/velric/blob/main/velric/analyzers/instruction_security_analyzer.py"
click node_yara "https://github.com/igen-uk07/velric/blob/main/velric/yara/analyzer.py"
click node_normalizer "https://github.com/igen-uk07/velric/blob/main/velric/risk/normalizer.py"
click node_correlator "https://github.com/igen-uk07/velric/blob/main/velric/risk/correlator.py"
click node_risk "https://github.com/igen-uk07/velric/blob/main/velric/risk/risk_engine.py"
click node_mitre "https://github.com/igen-uk07/velric/blob/main/velric/mitre/enricher.py"
click node_result "https://github.com/igen-uk07/velric/blob/main/velric/core/analysis_result.py"
click node_terminal "https://github.com/igen-uk07/velric/blob/main/velric/output/terminal_reporter.py"
click node_json "https://github.com/igen-uk07/velric/blob/main/velric/output/json_reporter.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_cli,node_engine toneBlue
class node_pe,node_elf,node_importnorm,node_disassembly,node_instruction toneAmber
class node_capability,node_network,node_strings,node_entropy,node_packing,node_instructionsec,node_yara toneMint
class node_normalizer,node_correlator,node_risk,node_mitre toneRose
class node_result,node_terminal,node_json,node_user toneIndigo
```

## Components

### User Interface

- [CLI](https://github.com/igen-uk07/velric/blob/main/velric/cli.py): `velric/cli.py`
- [Analysis Engine](https://github.com/igen-uk07/velric/blob/main/velric/core/analysis_engine.py): `velric/core/analysis_engine.py`

### Binary Analysis

- [PE Parser](https://github.com/igen-uk07/velric/blob/main/velric/parsers/pe_parser.py): `velric/parsers/pe_parser.py`
- [ELF Parser](https://github.com/igen-uk07/velric/blob/main/velric/parsers/elf_parser.py): `velric/parsers/elf_parser.py`
- [Import Normalizer](https://github.com/igen-uk07/velric/blob/main/velric/core/import_normalizer.py): `velric/core/import_normalizer.py`
- [Disassembly](https://github.com/igen-uk07/velric/blob/main/velric/disassembly/disassembler.py): `velric/disassembly/disassembler.py`
- [Instruction Analysis](https://github.com/igen-uk07/velric/blob/main/velric/disassembly/instruction_analyzer.py): `velric/disassembly/instruction_analyzer.py`

### Security Findings

- [Capability Analysis](https://github.com/igen-uk07/velric/blob/main/velric/analyzers/capability_analyzer.py): `velric/analyzers/capability_analyzer.py`
- [Network Analysis](https://github.com/igen-uk07/velric/blob/main/velric/analyzers/network_analyzer.py): `velric/analyzers/network_analyzer.py`
- [String Analysis](https://github.com/igen-uk07/velric/blob/main/velric/analyzers/string_analyzer.py): `velric/analyzers/string_analyzer.py`
- [Entropy Analysis](https://github.com/igen-uk07/velric/blob/main/velric/analyzers/entropy_analyzer.py): `velric/analyzers/entropy_analyzer.py`
- [Packing Analysis](https://github.com/igen-uk07/velric/blob/main/velric/analyzers/packing_analyzer.py): `velric/analyzers/packing_analyzer.py`
- [Instruction Security](https://github.com/igen-uk07/velric/blob/main/velric/analyzers/instruction_security_analyzer.py): `velric/analyzers/instruction_security_analyzer.py`
- [YARA Scanning](https://github.com/igen-uk07/velric/blob/main/velric/yara/analyzer.py): `velric/yara/analyzer.py`

### Finding Assessment

- [Finding Normalizer](https://github.com/igen-uk07/velric/blob/main/velric/risk/normalizer.py): `velric/risk/normalizer.py`
- [Behavior Correlator](https://github.com/igen-uk07/velric/blob/main/velric/risk/correlator.py): `velric/risk/correlator.py`
- [Risk Scoring](https://github.com/igen-uk07/velric/blob/main/velric/risk/risk_engine.py): `velric/risk/risk_engine.py`
- [ATT&CK Enrichment](https://github.com/igen-uk07/velric/blob/main/velric/mitre/enricher.py): `velric/mitre/enricher.py`

### Results

- [Analysis Result](https://github.com/igen-uk07/velric/blob/main/velric/core/analysis_result.py): `velric/core/analysis_result.py`
- [Terminal Report](https://github.com/igen-uk07/velric/blob/main/velric/output/terminal_reporter.py): `velric/output/terminal_reporter.py`
- [JSON Report](https://github.com/igen-uk07/velric/blob/main/velric/output/json_reporter.py): `velric/output/json_reporter.py`

### Other components

- **Analyst**

## Connections

- Analyst → CLI: submits binary (evidence: `README.md`)
- CLI → Analysis Engine: runs analysis (evidence: `velric/cli.py`)
- Analysis Engine → PE Parser: parses PE (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → ELF Parser: parses ELF (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → Import Normalizer: normalizes imports (evidence: `README.md`)
- Analysis Engine → Disassembly: collects disassembly (evidence: `velric/core/analysis_engine.py`)
- Disassembly → Instruction Analysis: analyzes instructions (evidence: `velric/core/collectors/disassembly_collector.py`)
- Analysis Engine → Capability Analysis: collects security
- Analysis Engine → Network Analysis: collects security
- Analysis Engine → String Analysis: extracts strings (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → Entropy Analysis: collects security
- Analysis Engine → Packing Analysis: collects security
- Analysis Engine → Instruction Security: collects security
- Analysis Engine → YARA Scanning: scans binary (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → Finding Normalizer: normalizes findings (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → Behavior Correlator: correlates findings (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → Risk Scoring: scores findings (evidence: `velric/core/analysis_engine.py`)
- Analysis Engine → ATT&CK Enrichment: enriches findings (evidence: `velric/core/analysis_engine.py`)
- ATT&CK Enrichment → Analysis Result: adds mappings
- CLI → Terminal Report: prints report (evidence: `velric/cli.py`)
- CLI → JSON Report: writes report (evidence: `velric/cli.py`)
- Analysis Engine → Analysis Result: builds result (evidence: `velric/core/analysis_engine.py`)
