# qyvora/qyvora-shaka architecture

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

- Interactive diagram: https://gitdiagram.com/qyvora/qyvora-shaka
- Repository: https://github.com/qyvora/qyvora-shaka

## Overview

SHAKA is a terminal-first framework for authorized, read-only Active Directory assessment. The principal workflow gates and selects a target, runs a configurable assessment through discovery, enumeration, graph correlation, analysis, findings, and risk scoring, then saves and renders the session. The graph also includes live LDAP and offline simulation, evidence-backed rules, events, and reporting. Relationships follow the README and SOURCE INDEX references; unsampled implementation details are represented at their documented subsystem paths rather than inferred as calls.

Main entry points: [`internal/orchestration/orchestration.go`](https://github.com/qyvora/qyvora-shaka/blob/main/internal/orchestration/orchestration.go) (Stage orchestration), [`internal/cli/app.go`](https://github.com/qyvora/qyvora-shaka/blob/main/internal/cli/app.go) (CLI and console), [`internal/directory/directory.go`](https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/directory.go) (Directory service), [`internal/assess/assess.go`](https://github.com/qyvora/qyvora-shaka/blob/main/internal/assess/assess.go) (Assessment runner)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Operator interface"]
  node_cli["CLI and console<br/>[app.go]"]
  node_authorization["Authorization gate<br/>[authorization.go]"]
  node_target["Target manager<br/>[manager.go]"]
end

subgraph group_run["Assessment workflow"]
  node_assessment["Assessment runner<br/>[assess.go]"]
  node_orchestration["Stage orchestration<br/>[orchestration.go]"]
  node_discovery["Domain discovery<br/>[discovery.go]"]
  node_enumeration["Object enumeration<br/>[enumeration.go]"]
  node_deepening["Verification and deepening<br/>[deepening.go]"]
  node_correlation["Relationship graph<br/>[build.go]"]
end

subgraph group_directory["Directory access"]
  node_directory_service["Directory service<br/>[directory.go]"]
  node_normalization["Entry normalization<br/>[normalize.go]"]
  node_simulation["Offline simulator<br/>[demo.go]"]
  node_ldap_service["LDAP client<br/>[ldap.go]"]
end

subgraph group_analysis["Security analysis"]
  node_analysis["Identity and trust analysis<br/>[identity.go]"]
  node_attack_paths["Attack path analysis<br/>[attackpath.go]"]
  node_rules["Built-in detection rules<br/>[builtin.go]"]
  node_risk["Risk scoring<br/>[risk.go]"]
end

subgraph group_results["Session and output"]
  node_evidence[("Evidence store<br/>[store.go]")]
  node_session[("Session persistence<br/>[session.go]")]
  node_reporting["Report rendering<br/>[reporting.go]"]
  node_events["JSONL events<br/>[events.go]"]
end

node_operator(("Operator"))

node_operator -->|"runs commands"| node_cli
node_cli -->|"confirms scope"| node_authorization
node_cli -->|"selects target"| node_target
node_cli -->|"starts assessment"| node_assessment
node_assessment -->|"builds and runs"| node_orchestration
node_orchestration -->|"runs stage"| node_discovery
node_orchestration -->|"runs stage"| node_enumeration
node_orchestration -.->|"runs stage"| node_deepening
node_orchestration -->|"runs stage"| node_correlation
node_discovery -->|"queries directory"| node_directory_service
node_enumeration -->|"searches objects"| node_directory_service
node_directory_service -->|"normalizes entries"| node_normalization
node_directory_service -->|"uses LDAP client"| node_ldap_service
node_simulation -->|"provides offline service"| node_directory_service
node_correlation -->|"supports path analysis"| node_attack_paths
node_orchestration -->|"runs analysis stage"| node_analysis
node_orchestration -->|"runs detection"| node_rules
node_orchestration -->|"scores findings"| node_risk
node_assessment -->|"creates evidence store"| node_evidence
node_assessment -->|"configures event stream"| node_events
node_cli -->|"persists session"| node_session
node_cli -->|"renders reports"| node_reporting
node_session -->|"supplies saved session"| node_reporting

click node_cli "https://github.com/qyvora/qyvora-shaka/blob/main/internal/cli/app.go"
click node_authorization "https://github.com/qyvora/qyvora-shaka/blob/main/internal/cli/authorization.go"
click node_target "https://github.com/qyvora/qyvora-shaka/blob/main/internal/target/manager.go"
click node_assessment "https://github.com/qyvora/qyvora-shaka/blob/main/internal/assess/assess.go"
click node_orchestration "https://github.com/qyvora/qyvora-shaka/blob/main/internal/orchestration/orchestration.go"
click node_discovery "https://github.com/qyvora/qyvora-shaka/blob/main/internal/discovery/discovery.go"
click node_enumeration "https://github.com/qyvora/qyvora-shaka/blob/main/internal/enumeration/enumeration.go"
click node_deepening "https://github.com/qyvora/qyvora-shaka/blob/main/internal/deepening/deepening.go"
click node_correlation "https://github.com/qyvora/qyvora-shaka/blob/main/internal/pipeline/build.go"
click node_directory_service "https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/directory.go"
click node_normalization "https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/normalize.go"
click node_simulation "https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/demo.go"
click node_ldap_service "https://github.com/qyvora/qyvora-shaka/blob/main/internal/ldap/ldap.go"
click node_analysis "https://github.com/qyvora/qyvora-shaka/blob/main/internal/analysis/identity.go"
click node_attack_paths "https://github.com/qyvora/qyvora-shaka/blob/main/internal/analysis/attackpath.go"
click node_rules "https://github.com/qyvora/qyvora-shaka/blob/main/internal/rules/builtin/builtin.go"
click node_risk "https://github.com/qyvora/qyvora-shaka/blob/main/internal/risk/risk.go"
click node_evidence "https://github.com/qyvora/qyvora-shaka/blob/main/internal/evidence/store.go"
click node_session "https://github.com/qyvora/qyvora-shaka/blob/main/internal/session/session.go"
click node_reporting "https://github.com/qyvora/qyvora-shaka/blob/main/internal/reporting/reporting.go"
click node_events "https://github.com/qyvora/qyvora-shaka/blob/main/internal/events/events.go"

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_authorization,node_target toneBlue
class node_assessment,node_orchestration,node_discovery,node_enumeration,node_deepening,node_correlation toneAmber
class node_directory_service,node_normalization,node_simulation,node_ldap_service toneMint
class node_analysis,node_attack_paths,node_rules,node_risk toneRose
class node_evidence,node_session,node_reporting,node_events,node_operator toneIndigo
```

## Components

### Operator interface

- [CLI and console](https://github.com/qyvora/qyvora-shaka/blob/main/internal/cli/app.go): `internal/cli/app.go`
- [Authorization gate](https://github.com/qyvora/qyvora-shaka/blob/main/internal/cli/authorization.go): `internal/cli/authorization.go`
- [Target manager](https://github.com/qyvora/qyvora-shaka/blob/main/internal/target/manager.go): `internal/target/manager.go`

### Assessment workflow

- [Assessment runner](https://github.com/qyvora/qyvora-shaka/blob/main/internal/assess/assess.go): `internal/assess/assess.go`
- [Stage orchestration](https://github.com/qyvora/qyvora-shaka/blob/main/internal/orchestration/orchestration.go): `internal/orchestration/orchestration.go`
- [Domain discovery](https://github.com/qyvora/qyvora-shaka/blob/main/internal/discovery/discovery.go): `internal/discovery/discovery.go`
- [Object enumeration](https://github.com/qyvora/qyvora-shaka/blob/main/internal/enumeration/enumeration.go): `internal/enumeration/enumeration.go`
- [Verification and deepening](https://github.com/qyvora/qyvora-shaka/blob/main/internal/deepening/deepening.go): `internal/deepening/deepening.go`
- [Relationship graph](https://github.com/qyvora/qyvora-shaka/blob/main/internal/pipeline/build.go): `internal/pipeline/build.go`

### Directory access

- [Directory service](https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/directory.go): `internal/directory/directory.go`
- [Entry normalization](https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/normalize.go): `internal/directory/normalize.go`
- [Offline simulator](https://github.com/qyvora/qyvora-shaka/blob/main/internal/directory/demo.go): `internal/directory/demo.go`
- [LDAP client](https://github.com/qyvora/qyvora-shaka/blob/main/internal/ldap/ldap.go): `internal/ldap/ldap.go`

### Security analysis

- [Identity and trust analysis](https://github.com/qyvora/qyvora-shaka/blob/main/internal/analysis/identity.go): `internal/analysis/identity.go`
- [Attack path analysis](https://github.com/qyvora/qyvora-shaka/blob/main/internal/analysis/attackpath.go): `internal/analysis/attackpath.go`
- [Built-in detection rules](https://github.com/qyvora/qyvora-shaka/blob/main/internal/rules/builtin/builtin.go): `internal/rules/builtin/builtin.go`
- [Risk scoring](https://github.com/qyvora/qyvora-shaka/blob/main/internal/risk/risk.go): `internal/risk/risk.go`

### Session and output

- [Evidence store](https://github.com/qyvora/qyvora-shaka/blob/main/internal/evidence/store.go): `internal/evidence/store.go`
- [Session persistence](https://github.com/qyvora/qyvora-shaka/blob/main/internal/session/session.go): `internal/session/session.go`
- [Report rendering](https://github.com/qyvora/qyvora-shaka/blob/main/internal/reporting/reporting.go): `internal/reporting/reporting.go`
- [JSONL events](https://github.com/qyvora/qyvora-shaka/blob/main/internal/events/events.go): `internal/events/events.go`

### Other components

- **Operator**

## Connections

- Operator → CLI and console: runs commands (evidence: `README.md`)
- CLI and console → Authorization gate: confirms scope (evidence: `internal/cli/authorization.go`)
- CLI and console → Target manager: selects target (evidence: `internal/cli/app.go`)
- CLI and console → Assessment runner: starts assessment (evidence: `README.md`)
- Assessment runner → Stage orchestration: builds and runs (evidence: `internal/assess/assess.go`)
- Stage orchestration → Domain discovery: runs stage (evidence: `README.md`)
- Stage orchestration → Object enumeration: runs stage (evidence: `README.md`)
- Stage orchestration → Verification and deepening: runs stage
- Stage orchestration → Relationship graph: runs stage (evidence: `README.md`)
- Domain discovery → Directory service: queries directory (evidence: `internal/discovery/discovery.go`)
- Object enumeration → Directory service: searches objects (evidence: `internal/enumeration/enumeration.go`)
- Directory service → Entry normalization: normalizes entries (evidence: `internal/directory/normalize.go`)
- Directory service → LDAP client: uses LDAP client (evidence: `README.md`)
- Offline simulator → Directory service: provides offline service (evidence: `README.md`)
- Relationship graph → Attack path analysis: supports path analysis (evidence: `internal/analysis/attackpath.go`)
- Stage orchestration → Identity and trust analysis: runs analysis stage (evidence: `README.md`)
- Stage orchestration → Built-in detection rules: runs detection (evidence: `README.md`)
- Stage orchestration → Risk scoring: scores findings (evidence: `README.md`)
- Assessment runner → Evidence store: creates evidence store (evidence: `internal/assess/assess.go`)
- Assessment runner → JSONL events: configures event stream (evidence: `internal/assess/assess.go`)
- CLI and console → Session persistence: persists session (evidence: `internal/cli/app.go`)
- CLI and console → Report rendering: renders reports (evidence: `README.md`)
- Session persistence → Report rendering: supplies saved session (evidence: `README.md`)
