# g0h4n/rusthound-ce architecture

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

- Interactive diagram: https://gitdiagram.com/g0h4n/rusthound-ce
- Repository: https://github.com/g0h4n/rusthound-ce

## Overview

RustHound-CE collects Active Directory data and emits BloodHound Community Edition JSON. The documented user workflow is to supply domain credentials and collection options, run the collector, and import its JSON output into BloodHound CE. The source index identifies LDAP/Kerberos transport, AD object models, JSON checking, and optional collection modules; the shown module orchestrator confirms session, ESC8, SYSVOL/GPO, local-group, and resolver branches. Several central links are not visible in the excerpts, so those are marked unverified rather than asserted as source-confirmed calls.

Main entry points: [`src/modules/mod.rs`](https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/mod.rs) (Module runner), [`src/api.rs`](https://github.com/g0h4n/rusthound-ce/blob/main/src/api.rs) (Collection API), [`src/objects`](https://github.com/g0h4n/rusthound-ce/tree/main/src/objects) (AD objects), [`src/main.rs`](https://github.com/g0h4n/rusthound-ce/blob/main/src/main.rs) (Program entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and orchestration"]
  node_options["CLI options<br/>[args.rs]"]
  node_runner["Program entry<br/>[main.rs]"]
  node_api["Collection API<br/>[api.rs]"]
  node_orchestrator["Module runner<br/>[mod.rs]"]
end

subgraph group_transport["Directory access"]
  node_ldap["LDAP transport<br/>[ldap.rs]"]
  node_kerberos["Kerberos auth<br/>[kerberos.rs]"]
  node_smb["SMB transport<br/>[smb.rs]"]
  node_storage[("LDAP storage")]
end

subgraph group_domain["AD data model"]
  node_ad_objects["AD objects"]
  node_acl_parser["ACL parsing<br/>[acl.rs]"]
  node_security_parser["Security descriptors<br/>[secdesc.rs]"]
end

subgraph group_extensions["Collection extensions"]
  node_sessions["Session collection<br/>[mod.rs]"]
  node_gpo["GPO and SYSVOL"]
  node_local_groups["Local groups<br/>[mod.rs]"]
  node_resolver["FQDN resolver"]
  node_adcs["ESC8 probing<br/>[esc8.rs]"]
end

subgraph group_output["Processing and output"]
  node_checker["JSON checking<br/>[common.rs]"]
  node_json_maker["JSON generation<br/>[common.rs]"]
end

node_operator(("Operator"))
node_bloodhound[("BloodHound CE")]

node_operator -->|"runs"| node_runner
node_operator -->|"configures"| node_options
node_runner -.->|"parses options"| node_options
node_runner -.->|"starts collection"| node_api
node_api -.->|"queries directory"| node_ldap
node_api -.->|"builds results"| node_ad_objects
node_api -.->|"runs extensions"| node_orchestrator
node_ldap -->|"uses storage"| node_storage
node_kerberos -.->|"authenticates SMB"| node_smb
node_ad_objects -->|"parses permissions"| node_acl_parser
node_ad_objects -->|"parses descriptors"| node_security_parser
node_orchestrator -->|"runs sessions"| node_sessions
node_orchestrator -->|"collects GPO"| node_gpo
node_orchestrator -->|"collects groups"| node_local_groups
node_orchestrator -->|"resolves hosts"| node_resolver
node_orchestrator -->|"probes ESC8"| node_adcs
node_sessions -->|"uses SMB"| node_smb
node_local_groups -->|"uses SMB"| node_smb
node_checker -->|"checks objects"| node_ad_objects
node_json_maker -->|"reads results"| node_api
node_api -.->|"validates collection"| node_checker
node_checker -.->|"prepares export"| node_json_maker
node_json_maker -->|"writes import JSON"| node_bloodhound

click node_options "https://github.com/g0h4n/rusthound-ce/blob/main/src/args.rs"
click node_runner "https://github.com/g0h4n/rusthound-ce/blob/main/src/main.rs"
click node_api "https://github.com/g0h4n/rusthound-ce/blob/main/src/api.rs"
click node_orchestrator "https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/mod.rs"
click node_ldap "https://github.com/g0h4n/rusthound-ce/blob/main/src/transport/ldap.rs"
click node_kerberos "https://github.com/g0h4n/rusthound-ce/blob/main/src/transport/kerberos.rs"
click node_smb "https://github.com/g0h4n/rusthound-ce/blob/main/src/transport/smb.rs"
click node_storage "https://github.com/g0h4n/rusthound-ce/tree/main/src/storage"
click node_ad_objects "https://github.com/g0h4n/rusthound-ce/tree/main/src/objects"
click node_acl_parser "https://github.com/g0h4n/rusthound-ce/blob/main/src/enums/acl.rs"
click node_security_parser "https://github.com/g0h4n/rusthound-ce/blob/main/src/enums/secdesc.rs"
click node_sessions "https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/session/mod.rs"
click node_gpo "https://github.com/g0h4n/rusthound-ce/tree/main/src/modules/gpo"
click node_local_groups "https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/localgroup/mod.rs"
click node_resolver "https://github.com/g0h4n/rusthound-ce/tree/main/src/modules/resolver"
click node_adcs "https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/adcs/esc8.rs"
click node_checker "https://github.com/g0h4n/rusthound-ce/blob/main/src/json/checker/common.rs"
click node_json_maker "https://github.com/g0h4n/rusthound-ce/blob/main/src/json/maker/common.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_options,node_runner,node_api,node_orchestrator toneBlue
class node_ldap,node_kerberos,node_smb,node_storage,node_bloodhound toneAmber
class node_ad_objects,node_acl_parser,node_security_parser toneMint
class node_sessions,node_gpo,node_local_groups,node_resolver,node_adcs toneRose
class node_checker,node_json_maker,node_operator toneIndigo
```

## Components

### Entry and orchestration

- [CLI options](https://github.com/g0h4n/rusthound-ce/blob/main/src/args.rs): `src/args.rs`
- [Program entry](https://github.com/g0h4n/rusthound-ce/blob/main/src/main.rs): `src/main.rs`
- [Collection API](https://github.com/g0h4n/rusthound-ce/blob/main/src/api.rs): `src/api.rs`
- [Module runner](https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/mod.rs): `src/modules/mod.rs`

### Directory access

- [LDAP transport](https://github.com/g0h4n/rusthound-ce/blob/main/src/transport/ldap.rs): `src/transport/ldap.rs`
- [Kerberos auth](https://github.com/g0h4n/rusthound-ce/blob/main/src/transport/kerberos.rs): `src/transport/kerberos.rs`
- [SMB transport](https://github.com/g0h4n/rusthound-ce/blob/main/src/transport/smb.rs): `src/transport/smb.rs`
- [LDAP storage](https://github.com/g0h4n/rusthound-ce/tree/main/src/storage): `src/storage`

### AD data model

- [AD objects](https://github.com/g0h4n/rusthound-ce/tree/main/src/objects): `src/objects`
- [ACL parsing](https://github.com/g0h4n/rusthound-ce/blob/main/src/enums/acl.rs): `src/enums/acl.rs`
- [Security descriptors](https://github.com/g0h4n/rusthound-ce/blob/main/src/enums/secdesc.rs): `src/enums/secdesc.rs`

### Collection extensions

- [Session collection](https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/session/mod.rs): `src/modules/session/mod.rs`
- [GPO and SYSVOL](https://github.com/g0h4n/rusthound-ce/tree/main/src/modules/gpo): `src/modules/gpo`
- [Local groups](https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/localgroup/mod.rs): `src/modules/localgroup/mod.rs`
- [FQDN resolver](https://github.com/g0h4n/rusthound-ce/tree/main/src/modules/resolver): `src/modules/resolver`
- [ESC8 probing](https://github.com/g0h4n/rusthound-ce/blob/main/src/modules/adcs/esc8.rs): `src/modules/adcs/esc8.rs`

### Processing and output

- [JSON checking](https://github.com/g0h4n/rusthound-ce/blob/main/src/json/checker/common.rs): `src/json/checker/common.rs`
- [JSON generation](https://github.com/g0h4n/rusthound-ce/blob/main/src/json/maker/common.rs): `src/json/maker/common.rs`

### Other components

- **Operator**
- **BloodHound CE**

## Connections

- Operator → Program entry: runs (evidence: `README.md`)
- Operator → CLI options: configures (evidence: `README.md`)
- Program entry → CLI options: parses options
- Program entry → Collection API: starts collection
- Collection API → LDAP transport: queries directory
- Collection API → AD objects: builds results
- Collection API → Module runner: runs extensions (evidence: `src/modules/mod.rs`)
- LDAP transport → LDAP storage: uses storage (evidence: `src/transport/ldap.rs`)
- Kerberos auth → SMB transport: authenticates SMB
- AD objects → ACL parsing: parses permissions (evidence: `src/objects/computer.rs`)
- AD objects → Security descriptors: parses descriptors (evidence: `src/objects/computer.rs`)
- Module runner → Session collection: runs sessions (evidence: `src/modules/mod.rs`)
- Module runner → GPO and SYSVOL: collects GPO (evidence: `src/modules/mod.rs`)
- Module runner → Local groups: collects groups (evidence: `src/modules/mod.rs`)
- Module runner → FQDN resolver: resolves hosts (evidence: `src/modules/mod.rs`)
- Module runner → ESC8 probing: probes ESC8 (evidence: `src/modules/mod.rs`)
- Session collection → SMB transport: uses SMB (evidence: `src/modules/session/mod.rs`)
- Local groups → SMB transport: uses SMB (evidence: `src/modules/localgroup/mod.rs`)
- JSON checking → AD objects: checks objects (evidence: `src/json/checker/mod.rs`)
- JSON generation → Collection API: reads results (evidence: `src/json/maker/common.rs`)
- Collection API → JSON checking: validates collection
- JSON checking → JSON generation: prepares export
- JSON generation → BloodHound CE: writes import JSON (evidence: `README.md`)
