# cmu-sei/pharos architecture

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

- Interactive diagram: https://gitdiagram.com/cmu-sei/pharos
- Repository: https://github.com/cmu-sei/pharos

## Overview

Pharos is a static binary-analysis framework and suite of analysis tools. The main workflow starts with an analyst selecting a binary and tool; the framework partitions and models the program, then tools perform focused analyses and report findings. Documented branches include API-call relationship searches, API parameter analysis, object-oriented recovery, path analysis, function hashing and YARA signature generation, and disassembly. The graph combines README-documented capabilities with source-index references; unsampled tool internals and some subsystem wiring are intentionally not inferred.

Main entry points: [`tools/apianalyzer/apianalyzer.cpp`](https://github.com/cmu-sei/pharos/blob/master/tools/apianalyzer/apianalyzer.cpp) (APIAnalyzer), [`tools/ooanalyzer/ooanalyzer.cpp`](https://github.com/cmu-sei/pharos/blob/master/tools/ooanalyzer/ooanalyzer.cpp) (OOAnalyzer), [`tools/pathanalyzer/pathanalyzer.cpp`](https://github.com/cmu-sei/pharos/blob/master/tools/pathanalyzer/pathanalyzer.cpp) (PathAnalyzer), [`libpharos/defuse.cpp`](https://github.com/cmu-sei/pharos/blob/master/libpharos/defuse.cpp) (Dataflow analysis)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_framework["Analysis framework"]
  node_partitioner["Program partitioner<br/>[partitioner.cpp]"]
  node_options["Options and config<br/>[options.hpp]"]
  node_descriptors["Program descriptors<br/>[descriptors.hpp]"]
  node_defuse["Dataflow analysis<br/>[defuse.cpp]"]
  node_stack["Stack tracking<br/>[sptrack.hpp]"]
end

subgraph group_api["API analysis"]
  node_api_tool["APIAnalyzer<br/>[apianalyzer.cpp]"]
  node_api_graph["API call graph<br/>[apigraph.cpp]"]
  node_api_database["API database<br/>[apidb.cpp]"]
  node_call_tool["CallAnalyzer<br/>[callanalyzer.cpp]"]
  node_api_lookup["APILookup<br/>[apilookup.cpp]"]
end

subgraph group_object["Object recovery"]
  node_oo_tool["OOAnalyzer<br/>[ooanalyzer.cpp]"]
  node_oo_recovery["Object recovery<br/>[ooanalyzer.cpp]"]
  node_oo_solver["Object solver<br/>[oosolver.cpp]"]
end

subgraph group_path["Path analysis"]
  node_path_tool["PathAnalyzer<br/>[pathanalyzer.cpp]"]
  node_path_analysis["Path analysis<br/>[path.cpp]"]
end

subgraph group_functions["Function analysis"]
  node_hash_tool["FN2Hash<br/>[fn2hash.cpp]"]
  node_yara_tool["FN2Yara<br/>[fn2yara.cpp]"]
  node_masm_tool["DumpMASM<br/>[dumpmasm.cpp]"]
end

node_analyst(("Analyst"))
node_binary["Binary program"]
node_findings["Analysis findings"]

node_analyst -->|"selects"| node_binary
node_analyst -->|"runs"| node_api_tool
node_analyst -->|"runs"| node_call_tool
node_analyst -->|"runs"| node_oo_tool
node_analyst -->|"runs"| node_path_tool
node_analyst -->|"runs"| node_hash_tool
node_analyst -->|"runs"| node_yara_tool
node_analyst -->|"runs"| node_masm_tool
node_partitioner -->|"reads"| node_options
node_partitioner -->|"uses"| node_descriptors
node_defuse -->|"uses"| node_stack
node_defuse -->|"uses"| node_descriptors
node_api_graph -->|"uses"| node_defuse
node_api_graph -->|"uses"| node_stack
node_api_tool -.->|"searches calls"| node_api_graph
node_api_tool -->|"reports sequences"| node_findings
node_call_tool -->|"reports parameters"| node_findings
node_api_lookup -.->|"queries"| node_api_database
node_oo_tool -.->|"recovers objects"| node_oo_recovery
node_oo_recovery -.->|"uses rules"| node_oo_solver
node_oo_tool -->|"reports classes"| node_findings
node_path_tool -.->|"analyzes paths"| node_path_analysis
node_path_tool -->|"reports paths"| node_findings
node_hash_tool -->|"generates hashes"| node_findings
node_yara_tool -->|"generates signatures"| node_findings
node_masm_tool -->|"dumps disassembly"| node_findings

click node_partitioner "https://github.com/cmu-sei/pharos/blob/master/libpharos/partitioner.cpp"
click node_options "https://github.com/cmu-sei/pharos/blob/master/libpharos/options.hpp"
click node_descriptors "https://github.com/cmu-sei/pharos/blob/master/libpharos/descriptors.hpp"
click node_defuse "https://github.com/cmu-sei/pharos/blob/master/libpharos/defuse.cpp"
click node_stack "https://github.com/cmu-sei/pharos/blob/master/libpharos/sptrack.hpp"
click node_api_tool "https://github.com/cmu-sei/pharos/blob/master/tools/apianalyzer/apianalyzer.cpp"
click node_api_graph "https://github.com/cmu-sei/pharos/blob/master/libpharos/apigraph.cpp"
click node_api_database "https://github.com/cmu-sei/pharos/blob/master/libpharos/apidb.cpp"
click node_call_tool "https://github.com/cmu-sei/pharos/blob/master/tools/callanalyzer/callanalyzer.cpp"
click node_api_lookup "https://github.com/cmu-sei/pharos/blob/master/tools/apilookup/apilookup.cpp"
click node_oo_tool "https://github.com/cmu-sei/pharos/blob/master/tools/ooanalyzer/ooanalyzer.cpp"
click node_oo_recovery "https://github.com/cmu-sei/pharos/blob/master/libpharos/ooanalyzer.cpp"
click node_oo_solver "https://github.com/cmu-sei/pharos/blob/master/libpharos/oosolver.cpp"
click node_path_tool "https://github.com/cmu-sei/pharos/blob/master/tools/pathanalyzer/pathanalyzer.cpp"
click node_path_analysis "https://github.com/cmu-sei/pharos/blob/master/libpharos/path.cpp"
click node_hash_tool "https://github.com/cmu-sei/pharos/blob/master/tools/fn2hash/fn2hash.cpp"
click node_yara_tool "https://github.com/cmu-sei/pharos/blob/master/tools/fn2yara/fn2yara.cpp"
click node_masm_tool "https://github.com/cmu-sei/pharos/blob/master/tools/dumpmasm/dumpmasm.cpp"

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_partitioner,node_options,node_descriptors,node_defuse,node_stack toneBlue
class node_api_tool,node_api_graph,node_api_database,node_call_tool,node_api_lookup toneAmber
class node_oo_tool,node_oo_recovery,node_oo_solver toneMint
class node_path_tool,node_path_analysis toneRose
class node_hash_tool,node_yara_tool,node_masm_tool,node_analyst,node_binary,node_findings toneIndigo
```

## Components

### Analysis framework

- [Program partitioner](https://github.com/cmu-sei/pharos/blob/master/libpharos/partitioner.cpp): `libpharos/partitioner.cpp`
- [Options and config](https://github.com/cmu-sei/pharos/blob/master/libpharos/options.hpp): `libpharos/options.hpp`
- [Program descriptors](https://github.com/cmu-sei/pharos/blob/master/libpharos/descriptors.hpp): `libpharos/descriptors.hpp`
- [Dataflow analysis](https://github.com/cmu-sei/pharos/blob/master/libpharos/defuse.cpp): `libpharos/defuse.cpp`
- [Stack tracking](https://github.com/cmu-sei/pharos/blob/master/libpharos/sptrack.hpp): `libpharos/sptrack.hpp`

### API analysis

- [APIAnalyzer](https://github.com/cmu-sei/pharos/blob/master/tools/apianalyzer/apianalyzer.cpp): `tools/apianalyzer/apianalyzer.cpp`
- [API call graph](https://github.com/cmu-sei/pharos/blob/master/libpharos/apigraph.cpp): `libpharos/apigraph.cpp`
- [API database](https://github.com/cmu-sei/pharos/blob/master/libpharos/apidb.cpp): `libpharos/apidb.cpp`
- [CallAnalyzer](https://github.com/cmu-sei/pharos/blob/master/tools/callanalyzer/callanalyzer.cpp): `tools/callanalyzer/callanalyzer.cpp`
- [APILookup](https://github.com/cmu-sei/pharos/blob/master/tools/apilookup/apilookup.cpp): `tools/apilookup/apilookup.cpp`

### Object recovery

- [OOAnalyzer](https://github.com/cmu-sei/pharos/blob/master/tools/ooanalyzer/ooanalyzer.cpp): `tools/ooanalyzer/ooanalyzer.cpp`
- [Object recovery](https://github.com/cmu-sei/pharos/blob/master/libpharos/ooanalyzer.cpp): `libpharos/ooanalyzer.cpp`
- [Object solver](https://github.com/cmu-sei/pharos/blob/master/libpharos/oosolver.cpp): `libpharos/oosolver.cpp`

### Path analysis

- [PathAnalyzer](https://github.com/cmu-sei/pharos/blob/master/tools/pathanalyzer/pathanalyzer.cpp): `tools/pathanalyzer/pathanalyzer.cpp`
- [Path analysis](https://github.com/cmu-sei/pharos/blob/master/libpharos/path.cpp): `libpharos/path.cpp`

### Function analysis

- [FN2Hash](https://github.com/cmu-sei/pharos/blob/master/tools/fn2hash/fn2hash.cpp): `tools/fn2hash/fn2hash.cpp`
- [FN2Yara](https://github.com/cmu-sei/pharos/blob/master/tools/fn2yara/fn2yara.cpp): `tools/fn2yara/fn2yara.cpp`
- [DumpMASM](https://github.com/cmu-sei/pharos/blob/master/tools/dumpmasm/dumpmasm.cpp): `tools/dumpmasm/dumpmasm.cpp`

### Other components

- **Analyst**
- **Binary program**
- **Analysis findings**

## Connections

- Analyst → Binary program: selects
- Analyst → APIAnalyzer: runs
- Analyst → CallAnalyzer: runs
- Analyst → OOAnalyzer: runs
- Analyst → PathAnalyzer: runs
- Analyst → FN2Hash: runs
- Analyst → FN2Yara: runs
- Analyst → DumpMASM: runs
- Program partitioner → Options and config: reads (evidence: `libpharos/partitioner.cpp`)
- Program partitioner → Program descriptors: uses
- Dataflow analysis → Stack tracking: uses (evidence: `libpharos/defuse.cpp`)
- Dataflow analysis → Program descriptors: uses
- API call graph → Dataflow analysis: uses (evidence: `libpharos/apigraph.cpp`)
- API call graph → Stack tracking: uses (evidence: `libpharos/apigraph.cpp`)
- APIAnalyzer → API call graph: searches calls
- APIAnalyzer → Analysis findings: reports sequences
- CallAnalyzer → Analysis findings: reports parameters
- APILookup → API database: queries
- OOAnalyzer → Object recovery: recovers objects
- Object recovery → Object solver: uses rules
- OOAnalyzer → Analysis findings: reports classes
- PathAnalyzer → Path analysis: analyzes paths
- PathAnalyzer → Analysis findings: reports paths
- FN2Hash → Analysis findings: generates hashes
- FN2Yara → Analysis findings: generates signatures
- DumpMASM → Analysis findings: dumps disassembly
