How gustavoolsantos/sentry works
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: ScanService.java Scan orchestration · App.jsx App shell · FindingFactory.java Finding factory · NmapScanEngine.java Nmap engine
Components 27
Web interface
- App shell
frontend/src/App.jsx - Route configuration
frontend/src/app/routes/index.jsx - Public routes
frontend/src/app/routes/public.routes.jsx - Home view
frontend/src/features/home/index.jsx - Not found view
frontend/src/features/not-found/index.jsx - API client
frontend/src/services/api.js
Scanning
- Scan endpoint
backend/src/main/java/br/uva/tcc/sentry/scan/controller/ScanController.java - Scan orchestration
backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java - Scanner interface
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/ScanEngine.java - Nmap engine
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java - Nmap command builder
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapCommandBuilder.java - Nmap process executor
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapProcessExecutor.java - Nmap result parser
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapResultParser.java - Scan results and hosts
backend/src/main/java/br/uva/tcc/sentry/scan/domain/ScanResult.java - Assets and services
backend/src/main/java/br/uva/tcc/sentry/Asset/domain/Asset.java
Security analysis
- Configuration checks
backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigFindingService.java - Check strategies
backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigCheck.java - Database port check
backend/src/main/java/br/uva/tcc/sentry/finding/checker/ExposedDatabasePortCheck.java - Finding factory
backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java - Findings
backend/src/main/java/br/uva/tcc/sentry/finding/domain/Finding.java - Policy rules
backend/src/main/java/br/uva/tcc/sentry/policy/domain/PolicyRule.java
Vulnerability lookup
- Vulnerability lookup
backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/VulnerabilityLookupService.java - NVD client
backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/NvdClient.java - Vulnerabilities
backend/src/main/java/br/uva/tcc/sentry/vulnerability/domain/Vulnerability.java
Other components
- User
- NVD service
- Nmap executable
Connections 26
- User → App shell: uses
- App shell → Route configuration: renders
frontend/src/App.jsx - App shell → Home view: renders header
frontend/src/App.jsx - App shell → Not found view: renders footer
frontend/src/App.jsx - Route configuration → Public routes: configures
frontend/src/app/routes/index.jsx - Public routes → Home view: routes to
frontend/src/app/routes/public.routes.jsx - Public routes → Not found view: routes to
frontend/src/app/routes/public.routes.jsx - Scan endpoint → Scan orchestration: delegates to
backend/src/main/java/br/uva/tcc/sentry/scan/controller/ScanController.java - Scan orchestration → Scanner interface: runs scan
backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java - Nmap engine → Nmap command builder: builds command
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java - Nmap engine → Nmap process executor: executes command
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapScanEngine.java - Nmap engine → Nmap result parser: parses output
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
backend/src/main/java/br/uva/tcc/sentry/scan/scanner/nmap/NmapResultParser.java - Scan orchestration → Scan results and hosts: processes results
backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java - Scan orchestration → Configuration checks: checks hosts
backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java - Configuration checks → Check strategies: dispatches checks
backend/src/main/java/br/uva/tcc/sentry/finding/checker/ConfigFindingService.java - Check strategies → Database port check: implemented by
backend/src/main/java/br/uva/tcc/sentry/finding/checker/ExposedDatabasePortCheck.java - Scan orchestration → Vulnerability lookup: looks up CPEs
backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java - Vulnerability lookup → NVD client: delegates lookup
backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/VulnerabilityLookupService.java - NVD client → NVD service: queries
- NVD client → Vulnerabilities: maps results
backend/src/main/java/br/uva/tcc/sentry/vulnerability/nvd/NvdClient.java - Scan orchestration → Finding factory: creates findings
backend/src/main/java/br/uva/tcc/sentry/scan/services/ScanService.java - Finding factory → Findings: constructs
backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java - Finding factory → Policy rules: uses rule
backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java - Finding factory → Vulnerabilities: attaches vulnerability
backend/src/main/java/br/uva/tcc/sentry/finding/factory/FindingFactory.java