How gorkemguler/net-sentinel works
NetSentinel monitors a local network through scheduled sensor collectors, sends their reports to a hub over an authenticated API, and turns them into device inventory, DNS observations, events, and alerts. Operators review and acknowledge results in the dashboard or API; notifications and AbuseIPDB enrichment are optional. The graph reflects the documented two-role workflow and sampled calls. Housekeeping and some enrichment details are documented but their runtime wiring was not sampled, so uncertain links are omitted.
Main entry points: routes_api.py Hub REST API · client.py Hub client · runner.py Sensor scheduler · db.py SQLite store
Components 24
Sensor collection
- Sensor scheduler
src/netsentinel/sensor/runner.py - Device discovery
src/netsentinel/sensor/collectors/arp_discovery.py - Passive DNS
src/netsentinel/sensor/collectors/passive_dns.py - Port scanning
src/netsentinel/sensor/collectors/port_scan.py - Hub client
src/netsentinel/sensor/client.py
Hub processing
- Ingest contract
src/netsentinel/schemas.py - Hub REST API
src/netsentinel/hub/routes_api.py - Detection pipeline
src/netsentinel/hub/pipeline.py - Threat intelligence
src/netsentinel/threatintel.py - Vendor lookup
src/netsentinel/oui.py - Hub application
src/netsentinel/hub/app.py
State and configuration
- SQLite store
src/netsentinel/db.py - Persisted records
src/netsentinel/models.py - Runtime settings
src/netsentinel/config.py
Operator views and alerts
- CLI runtime
src/netsentinel/cli.py - Dashboard routes
src/netsentinel/hub/routes_dashboard.py - Dashboard views
src/netsentinel/hub/templates - Alert delivery
src/netsentinel/hub/alerts.py - Notification backends
src/netsentinel/notify.py - Authentication
src/netsentinel/security.py
Other components
- Network operator
- Local network
- Push services
- AbuseIPDB
Connections 35
- Network operator → CLI runtime: starts roles
README.md - Local network → Device discovery: provides hosts
README.md - Local network → Passive DNS: provides packets
README.md - Local network → Port scanning: provides subnet
README.md - CLI runtime → Sensor scheduler: starts sensor
src/netsentinel/cli.py - Sensor scheduler → Device discovery: schedules discovery
src/netsentinel/sensor/runner.py - Sensor scheduler → Passive DNS: schedules DNS flush
src/netsentinel/sensor/runner.py - Sensor scheduler → Port scanning: schedules scans
src/netsentinel/sensor/runner.py - Sensor scheduler → Hub client: sends reports
src/netsentinel/sensor/runner.py - Hub client → Hub REST API: POSTs batches
src/netsentinel/sensor/client.py - Hub client → Hub REST API: queries known devices
src/netsentinel/sensor/client.py - Hub REST API → Ingest contract: accepts batches
src/netsentinel/hub/routes_api.py - Hub client → Ingest contract: serializes batches
src/netsentinel/sensor/client.py - Hub REST API → Detection pipeline: processes ingest
src/netsentinel/hub/routes_api.py - Detection pipeline → Persisted records: creates records
src/netsentinel/hub/pipeline.py - Detection pipeline → Vendor lookup: looks up vendors
src/netsentinel/hub/pipeline.py - Detection pipeline → Threat intelligence: checks indicators
src/netsentinel/hub/pipeline.py - Hub REST API → SQLite store: queries and updates
src/netsentinel/hub/routes_api.py - Dashboard routes → SQLite store: queries views
src/netsentinel/hub/routes_dashboard.py - Dashboard routes → Dashboard views: renders pages
src/netsentinel/hub/routes_dashboard.py - Hub application → Hub REST API: registers routes
src/netsentinel/hub/app.py - Hub application → Dashboard routes: registers routes
src/netsentinel/hub/app.py - Hub application → SQLite store: initializes store
src/netsentinel/hub/app.py - Hub application → Alert delivery: starts alert service
src/netsentinel/hub/app.py - Alert delivery → Notification backends: delivers alerts
src/netsentinel/hub/alerts.py - Notification backends → Push services: sends notifications
src/netsentinel/notify.py - Threat intelligence → AbuseIPDB: enriches indicators
README.md - Network operator → Dashboard routes: reviews results
README.md - Network operator → Hub REST API: uses API
README.md - Network operator → Authentication: authenticates
- Hub client → Authentication: sends bearer token
src/netsentinel/sensor/client.py - SQLite store → Persisted records: stores tables
src/netsentinel/db.py - Runtime settings → SQLite store: configures connection
src/netsentinel/db.py - Runtime settings → Hub client: configures uplink
src/netsentinel/sensor/client.py - Runtime settings → Notification backends: selects backend
src/netsentinel/notify.py