# epi052/feroxbuster architecture

> Architecture diagram of the GitHub repository epi052/feroxbuster, 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/epi052/feroxbuster
- Repository: https://github.com/epi052/feroxbuster

## Overview

feroxbuster is a Rust forced-browsing tool: users provide targets and a wordlist, then it probes paths, reports accessible resources, and can recursively discover links. The map preserves configuration, request/scan management, response analysis, filtering, extraction, terminal handlers, and statistics. Some core files are indexed but not excerpted; their components are included, while uncertain runtime connections are omitted rather than inferred.

Main entry points: [`src/scan_manager/scan_container.rs`](https://github.com/epi052/feroxbuster/blob/main/src/scan_manager/scan_container.rs) (Scan manager), [`src/scanner/ferox_scanner.rs`](https://github.com/epi052/feroxbuster/blob/main/src/scanner/ferox_scanner.rs) (Directory scanner), [`src/scanner/requester.rs`](https://github.com/epi052/feroxbuster/blob/main/src/scanner/requester.rs) (HTTP requester), [`src/event_handlers`](https://github.com/epi052/feroxbuster/tree/main/src/event_handlers) (Event handlers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Configuration"]
  node_config["Configuration<br/>[container.rs]"]
  node_client["HTTP client setup<br/>[client.rs]"]
  node_parser["Argument parsing<br/>[parser.rs]"]
end

subgraph group_runtime["Scanning"]
  node_manager["Scan manager<br/>[scan_container.rs]"]
  node_scan["Scan state<br/>[scan.rs]"]
  node_scanner["Directory scanner<br/>[ferox_scanner.rs]"]
  node_requester["HTTP requester<br/>[requester.rs]"]
  node_url["URL handling<br/>[url.rs]"]
end

subgraph group_analysis["Response analysis"]
  node_extractor["Link extraction<br/>[container.rs]"]
  node_heuristics["Response heuristics<br/>[heuristics.rs]"]
  node_response["Response model<br/>[response.rs]"]
  node_filters["Response filters"]
  node_nlp["TF-IDF analysis"]
end

subgraph group_operations["Runtime services"]
  node_handlers["Event handlers"]
  node_stats["Statistics<br/>[container.rs]"]
  node_output["Terminal output<br/>[outputs.rs]"]
  node_sync["Dynamic semaphore"]
end

node_user(("User"))
node_targets["Targets and wordlist"]
node_web(("Target web servers"))
node_cli["CLI entry point<br/>[main.rs]"]

node_user -->|"runs"| node_cli
node_targets -->|"supplies targets"| node_cli
node_cli -.->|"parses options"| node_parser
node_config -->|"initializes"| node_client
node_requester -.->|"sends requests"| node_web
node_web -.->|"returns responses"| node_requester
node_extractor -->|"requests links"| node_client
node_extractor -->|"updates statistics"| node_handlers
node_manager -->|"manages scans"| node_scan
node_manager -->|"registers filters"| node_filters
node_manager -->|"uses handles"| node_handlers
node_manager -->|"uses semaphore"| node_sync
node_scanner -->|"uses requester"| node_requester
node_scanner -->|"uses heuristics"| node_heuristics
node_scanner -->|"applies filters"| node_filters
node_requester -->|"sends updates"| node_stats
node_heuristics -->|"uses filters"| node_filters
node_heuristics -->|"references scanner"| node_scanner
node_response -->|"references settings"| node_config
node_nlp -.->|"analyzes similarity"| node_response
node_handlers -->|"routes output"| node_output
node_handlers -->|"routes statistics"| node_stats

click node_cli "https://github.com/epi052/feroxbuster/blob/main/src/main.rs"
click node_config "https://github.com/epi052/feroxbuster/blob/main/src/config/container.rs"
click node_client "https://github.com/epi052/feroxbuster/blob/main/src/client.rs"
click node_parser "https://github.com/epi052/feroxbuster/blob/main/src/parser.rs"
click node_manager "https://github.com/epi052/feroxbuster/blob/main/src/scan_manager/scan_container.rs"
click node_scan "https://github.com/epi052/feroxbuster/blob/main/src/scan_manager/scan.rs"
click node_scanner "https://github.com/epi052/feroxbuster/blob/main/src/scanner/ferox_scanner.rs"
click node_requester "https://github.com/epi052/feroxbuster/blob/main/src/scanner/requester.rs"
click node_url "https://github.com/epi052/feroxbuster/blob/main/src/url.rs"
click node_extractor "https://github.com/epi052/feroxbuster/blob/main/src/extractor/container.rs"
click node_heuristics "https://github.com/epi052/feroxbuster/blob/main/src/heuristics.rs"
click node_response "https://github.com/epi052/feroxbuster/blob/main/src/response.rs"
click node_filters "https://github.com/epi052/feroxbuster/tree/main/src/filters"
click node_nlp "https://github.com/epi052/feroxbuster/tree/main/src/nlp"
click node_handlers "https://github.com/epi052/feroxbuster/tree/main/src/event_handlers"
click node_stats "https://github.com/epi052/feroxbuster/blob/main/src/statistics/container.rs"
click node_output "https://github.com/epi052/feroxbuster/blob/main/src/event_handlers/outputs.rs"
click node_sync "https://github.com/epi052/feroxbuster/blob/main/src/sync/dynamic_semaphore.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_config,node_client,node_parser,node_user toneBlue
class node_manager,node_scan,node_scanner,node_requester,node_url toneAmber
class node_extractor,node_heuristics,node_response,node_filters,node_nlp,node_web toneMint
class node_handlers,node_stats,node_output,node_sync toneRose
class node_targets toneIndigo
class node_cli toneTeal
```

## Components

### Configuration

- [Configuration](https://github.com/epi052/feroxbuster/blob/main/src/config/container.rs): `src/config/container.rs`
- [HTTP client setup](https://github.com/epi052/feroxbuster/blob/main/src/client.rs): `src/client.rs`
- [Argument parsing](https://github.com/epi052/feroxbuster/blob/main/src/parser.rs): `src/parser.rs`

### Scanning

- [Scan manager](https://github.com/epi052/feroxbuster/blob/main/src/scan_manager/scan_container.rs): `src/scan_manager/scan_container.rs`
- [Scan state](https://github.com/epi052/feroxbuster/blob/main/src/scan_manager/scan.rs): `src/scan_manager/scan.rs`
- [Directory scanner](https://github.com/epi052/feroxbuster/blob/main/src/scanner/ferox_scanner.rs): `src/scanner/ferox_scanner.rs`
- [HTTP requester](https://github.com/epi052/feroxbuster/blob/main/src/scanner/requester.rs): `src/scanner/requester.rs`
- [URL handling](https://github.com/epi052/feroxbuster/blob/main/src/url.rs): `src/url.rs`

### Response analysis

- [Link extraction](https://github.com/epi052/feroxbuster/blob/main/src/extractor/container.rs): `src/extractor/container.rs`
- [Response heuristics](https://github.com/epi052/feroxbuster/blob/main/src/heuristics.rs): `src/heuristics.rs`
- [Response model](https://github.com/epi052/feroxbuster/blob/main/src/response.rs): `src/response.rs`
- [Response filters](https://github.com/epi052/feroxbuster/tree/main/src/filters): `src/filters`
- [TF-IDF analysis](https://github.com/epi052/feroxbuster/tree/main/src/nlp): `src/nlp`

### Runtime services

- [Event handlers](https://github.com/epi052/feroxbuster/tree/main/src/event_handlers): `src/event_handlers`
- [Statistics](https://github.com/epi052/feroxbuster/blob/main/src/statistics/container.rs): `src/statistics/container.rs`
- [Terminal output](https://github.com/epi052/feroxbuster/blob/main/src/event_handlers/outputs.rs): `src/event_handlers/outputs.rs`
- [Dynamic semaphore](https://github.com/epi052/feroxbuster/blob/main/src/sync/dynamic_semaphore.rs): `src/sync/dynamic_semaphore.rs`

### Other components

- **User**
- **Targets and wordlist**
- **Target web servers**
- [CLI entry point](https://github.com/epi052/feroxbuster/blob/main/src/main.rs): `src/main.rs`

## Connections

- User → CLI entry point: runs (evidence: `README.md`)
- Targets and wordlist → CLI entry point: supplies targets (evidence: `README.md`)
- CLI entry point → Argument parsing: parses options
- Configuration → HTTP client setup: initializes (evidence: `src/config/container.rs`)
- HTTP requester → Target web servers: sends requests
- Target web servers → HTTP requester: returns responses
- Link extraction → HTTP client setup: requests links (evidence: `src/extractor/container.rs`)
- Link extraction → Event handlers: updates statistics (evidence: `src/extractor/container.rs`)
- Scan manager → Scan state: manages scans (evidence: `src/scan_manager/scan_container.rs`)
- Scan manager → Response filters: registers filters (evidence: `src/scan_manager/scan_container.rs`)
- Scan manager → Event handlers: uses handles (evidence: `src/scan_manager/scan_container.rs`)
- Scan manager → Dynamic semaphore: uses semaphore (evidence: `src/scan_manager/scan_container.rs`)
- Directory scanner → HTTP requester: uses requester (evidence: `src/scanner/ferox_scanner.rs`)
- Directory scanner → Response heuristics: uses heuristics (evidence: `src/scanner/ferox_scanner.rs`)
- Directory scanner → Response filters: applies filters (evidence: `src/scanner/ferox_scanner.rs`)
- HTTP requester → Statistics: sends updates (evidence: `src/scanner/requester.rs`)
- Response heuristics → Response filters: uses filters (evidence: `src/heuristics.rs`)
- Response heuristics → Directory scanner: references scanner (evidence: `src/heuristics.rs`)
- Response model → Configuration: references settings (evidence: `src/response.rs`)
- TF-IDF analysis → Response model: analyzes similarity
- Event handlers → Terminal output: routes output (evidence: `src/event_handlers/mod.rs`)
- Event handlers → Statistics: routes statistics (evidence: `src/event_handlers/mod.rs`)
