# gustavoolsantos/sentry architecture

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

- Interactive diagram: https://gitdiagram.com/gustavoolsantos/sentry
- Repository: https://github.com/gustavoolsantos/sentry

## Overview

Sentry is a network security scanner: a user submits targets through the frontend, and the backend runs scans, discovers hosts and services, checks configuration, looks up known vulnerabilities, and assembles findings. The graph also shows the frontend’s evidenced routing and the backend’s Nmap and finding layers. The README is empty, and the excerpts do not show frontend-to-backend wiring or NVD’s external request, so those relationships are omitted; unsampled capabilities are represented only where the source index supports them.

Main entry points: [`backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java) (Scan orchestration), [`frontend/src/App.jsx`](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/App.jsx) (App shell), [`backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java`](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java) (Finding factory), [`backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java`](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java) (Nmap engine)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Web interface"]
  node_app["App shell<br/>[App.jsx]"]
  node_routes["Route configuration<br/>[index.jsx]"]
  node_public_routes["Public routes<br/>[public.routes.jsx]"]
  node_home["Home view<br/>[index.jsx]"]
  node_not_found["Not found view<br/>[index.jsx]"]
  node_api_client["API client<br/>[api.js]"]
end

subgraph group_scan["Scanning"]
  node_scan_controller["Scan endpoint"]
  node_scan_service["Scan orchestration<br/>[ScanService.java]"]
  node_scan_engine["Scanner interface<br/>[ScanEngine.java]"]
  node_nmap_engine["Nmap engine"]
  node_nmap_builder["Nmap command builder"]
  node_nmap_executor["Nmap process executor"]
  node_nmap_parser["Nmap result parser"]
  node_scan_data["Scan results and hosts<br/>[ScanResult.java]"]
  node_asset_model["Assets and services<br/>[Asset.java]"]
end

subgraph group_analysis["Security analysis"]
  node_config_service["Configuration checks"]
  node_config_check["Check strategies<br/>[ConfigCheck.java]"]
  node_db_port_check["Database port check"]
  node_finding_factory["Finding factory"]
  node_finding_model["Findings<br/>[Finding.java]"]
  node_policy_rule["Policy rules<br/>[PolicyRule.java]"]
end

subgraph group_vulnerability["Vulnerability lookup"]
  node_lookup_service["Vulnerability lookup"]
  node_nvd_client["NVD client<br/>[NvdClient.java]"]
  node_vulnerability_model["Vulnerabilities<br/>[Vulnerability.java]"]
end

node_user(("User"))
node_nvd(("NVD service"))
node_nmap(("Nmap executable"))

node_user -->|"uses"| node_app
node_app -->|"renders"| node_routes
node_app -->|"renders header"| node_home
node_app -->|"renders footer"| node_not_found
node_routes -->|"configures"| node_public_routes
node_public_routes -->|"routes to"| node_home
node_public_routes -->|"routes to"| node_not_found
node_scan_controller -->|"delegates to"| node_scan_service
node_scan_service -->|"runs scan"| node_scan_engine
node_nmap_engine -->|"builds command"| node_nmap_builder
node_nmap_engine -->|"executes command"| node_nmap_executor
node_nmap_engine -->|"parses output"| node_nmap_parser
node_nmap_executor -.->|"runs process"| node_nmap
node_nmap_parser -->|"creates assets"| node_asset_model
node_scan_service -->|"processes results"| node_scan_data
node_scan_service -->|"checks hosts"| node_config_service
node_config_service -->|"dispatches checks"| node_config_check
node_config_check -.->|"implemented by"| node_db_port_check
node_scan_service -->|"looks up CPEs"| node_lookup_service
node_lookup_service -->|"delegates lookup"| node_nvd_client
node_nvd_client -.->|"queries"| node_nvd
node_nvd_client -->|"maps results"| node_vulnerability_model
node_scan_service -->|"creates findings"| node_finding_factory
node_finding_factory -->|"constructs"| node_finding_model
node_finding_factory -->|"uses rule"| node_policy_rule
node_finding_factory -->|"attaches vulnerability"| node_vulnerability_model

click node_app "https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/App.jsx"
click node_routes "https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/app/routes/index.jsx"
click node_public_routes "https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/app/routes/public.routes.jsx"
click node_home "https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/features/home/index.jsx"
click node_not_found "https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/features/not-found/index.jsx"
click node_api_client "https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/services/api.js"
click node_scan_controller "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/controller/ScanController.java"
click node_scan_service "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java"
click node_scan_engine "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/ScanEngine.java"
click node_nmap_engine "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java"
click node_nmap_builder "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapCommandBuilder.java"
click node_nmap_executor "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapProcessExecutor.java"
click node_nmap_parser "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapResultParser.java"
click node_scan_data "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/domain/ScanResult.java"
click node_asset_model "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/Asset/domain/Asset.java"
click node_config_service "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigFindingService.java"
click node_config_check "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigCheck.java"
click node_db_port_check "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/checker/ExposedDatabasePortCheck.java"
click node_finding_factory "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java"
click node_finding_model "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/domain/Finding.java"
click node_policy_rule "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/policy/domain/PolicyRule.java"
click node_lookup_service "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/VulnerabilityLookupService.java"
click node_nvd_client "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/NvdClient.java"
click node_vulnerability_model "https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/vulnerability/domain/Vulnerability.java"

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_app,node_routes,node_public_routes,node_home,node_not_found,node_api_client,node_user toneBlue
class node_scan_controller,node_scan_service,node_scan_engine,node_nmap_engine,node_nmap_builder,node_nmap_executor,node_nmap_parser,node_scan_data,node_asset_model toneAmber
class node_config_service,node_config_check,node_db_port_check,node_finding_factory,node_finding_model,node_policy_rule toneMint
class node_lookup_service,node_nvd_client,node_vulnerability_model toneRose
class node_nvd,node_nmap toneIndigo
```

## Components

### Web interface

- [App shell](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Route configuration](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/app/routes/index.jsx): `frontend/src/app/routes/index.jsx`
- [Public routes](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/app/routes/public.routes.jsx): `frontend/src/app/routes/public.routes.jsx`
- [Home view](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/features/home/index.jsx): `frontend/src/features/home/index.jsx`
- [Not found view](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/features/not-found/index.jsx): `frontend/src/features/not-found/index.jsx`
- [API client](https://github.com/gustavoolsantos/sentry/blob/main/frontend/src/services/api.js): `frontend/src/services/api.js`

### Scanning

- [Scan endpoint](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/controller/ScanController.java): `backend/src/main/java/br/uva/tcc/sentry/scan/controller/ScanController.java`
- [Scan orchestration](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java): `backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`
- [Scanner interface](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/ScanEngine.java): `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/ScanEngine.java`
- [Nmap engine](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java): `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java`
- [Nmap command builder](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapCommandBuilder.java): `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapCommandBuilder.java`
- [Nmap process executor](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapProcessExecutor.java): `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapProcessExecutor.java`
- [Nmap result parser](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapResultParser.java): `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapResultParser.java`
- [Scan results and hosts](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/scan/domain/ScanResult.java): `backend/src/main/java/br/uva/tcc/sentry/scan/domain/ScanResult.java`
- [Assets and services](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/Asset/domain/Asset.java): `backend/src/main/java/br/uva/tcc/sentry/Asset/domain/Asset.java`

### Security analysis

- [Configuration checks](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigFindingService.java): `backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigFindingService.java`
- [Check strategies](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigCheck.java): `backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigCheck.java`
- [Database port check](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/checker/ExposedDatabasePortCheck.java): `backend/src/main/java/br/uva/tcc/sentry/finding/checker/ExposedDatabasePortCheck.java`
- [Finding factory](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java): `backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java`
- [Findings](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/finding/domain/Finding.java): `backend/src/main/java/br/uva/tcc/sentry/finding/domain/Finding.java`
- [Policy rules](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/policy/domain/PolicyRule.java): `backend/src/main/java/br/uva/tcc/sentry/policy/domain/PolicyRule.java`

### Vulnerability lookup

- [Vulnerability lookup](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/VulnerabilityLookupService.java): `backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/VulnerabilityLookupService.java`
- [NVD client](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/NvdClient.java): `backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/NvdClient.java`
- [Vulnerabilities](https://github.com/gustavoolsantos/sentry/blob/main/backend/src/main/java/br/uva/tcc/sentry/vulnerability/domain/Vulnerability.java): `backend/src/main/java/br/uva/tcc/sentry/vulnerability/domain/Vulnerability.java`

### Other components

- **User**
- **NVD service**
- **Nmap executable**

## Connections

- User → App shell: uses
- App shell → Route configuration: renders (evidence: `frontend/src/App.jsx`)
- App shell → Home view: renders header (evidence: `frontend/src/App.jsx`)
- App shell → Not found view: renders footer (evidence: `frontend/src/App.jsx`)
- Route configuration → Public routes: configures (evidence: `frontend/src/app/routes/index.jsx`)
- Public routes → Home view: routes to (evidence: `frontend/src/app/routes/public.routes.jsx`)
- Public routes → Not found view: routes to (evidence: `frontend/src/app/routes/public.routes.jsx`)
- Scan endpoint → Scan orchestration: delegates to (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/controller/ScanController.java`)
- Scan orchestration → Scanner interface: runs scan (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`)
- Nmap engine → Nmap command builder: builds command (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java`)
- Nmap engine → Nmap process executor: executes command (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java`)
- Nmap engine → Nmap result parser: parses output (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java`)
- Nmap process executor → Nmap executable: runs process
- Nmap result parser → Assets and services: creates assets (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapResultParser.java`)
- Scan orchestration → Scan results and hosts: processes results (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`)
- Scan orchestration → Configuration checks: checks hosts (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`)
- Configuration checks → Check strategies: dispatches checks (evidence: `backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigFindingService.java`)
- Check strategies → Database port check: implemented by (evidence: `backend/src/main/java/br/uva/tcc/sentry/finding/checker/ExposedDatabasePortCheck.java`)
- Scan orchestration → Vulnerability lookup: looks up CPEs (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`)
- Vulnerability lookup → NVD client: delegates lookup (evidence: `backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/VulnerabilityLookupService.java`)
- NVD client → NVD service: queries
- NVD client → Vulnerabilities: maps results (evidence: `backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/NvdClient.java`)
- Scan orchestration → Finding factory: creates findings (evidence: `backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java`)
- Finding factory → Findings: constructs (evidence: `backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java`)
- Finding factory → Policy rules: uses rule (evidence: `backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java`)
- Finding factory → Vulnerabilities: attaches vulnerability (evidence: `backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java`)
