No description
- Python 99.7%
- Dockerfile 0.2%
Rebuild the Sentinel community (AGPL) edition from private source with every Pro/Enterprise-gated module shipped as a license-required ImportError stub. - Enterprise "Network topology & visualization": replace src/sentinel/visualization/topology.py and exporters.py with license-required ImportError stubs. visualization/__init__.py preserves the public names but the import now raises the licensing error; the API layer imports these lazily behind a sentinel:full entitlement check, so the community edition is unaffected. Removes tests/test_visualization.py (module-level gated import). - Pro AI agents (Guardian, Optimizer, Healer) and the Policy Enforcer remain license-required stubs; agents/__init__.py imports them opportunistically and degrades gracefully when absent. - Exclude fleet-coupled and internal artifacts (nexus_client, internal architecture/plan docs, .claude, FUNDING, egg-info). Community (free) tier — device discovery, scans, blocked IPs/quarantine — ships intact. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> |
||
|---|---|---|
| config | ||
| deploy | ||
| scripts | ||
| src/sentinel | ||
| tests | ||
| .env.example | ||
| .gitignore | ||
| config.example.yaml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| LICENSE | ||
| LICENSING.md | ||
| NOTICE | ||
| pyproject.toml | ||
| README.md | ||
| sentinel_gui.bat | ||
Sentinel Security Platform
AI-Native Security Platform with Zero-Trust Architecture and Autonomous Network Management
Sentinel is a comprehensive security platform that combines zero-trust architecture, intelligent network management, and AI-driven automation. It provides real-time network discovery, automatic segmentation, traffic optimization, and self-healing capabilities.
Features
- Zero-Trust Identity (Gatekeeper): Continuous authentication and authorization
- Credential Management (Keymaster): Certificate lifecycle and secrets management
- Network Fabric (NetMesh): Software-defined networking with automatic VLAN management
- Firewall (Shield): L3-L7 inspection with WAF capabilities
- Detection (Observer): SIEM/XDR with event correlation
- AI Agents: Autonomous network management with human-in-the-loop controls
AI Agents
| Agent | Purpose |
|---|---|
| Discovery | Network scanning and device classification |
| Optimizer | Traffic engineering and QoS management |
| Planner | Segmentation and VLAN automation |
| Orchestrator | Workload placement and scaling |
| Forecaster | Predictive analytics and capacity planning |
| Healer | Self-repair and automated failover |
| Guardian | Security policy enforcement |
Architecture
┌─────────────────────────────────────────────────────────────┐
│ SENTINEL CONTROL PLANE │
├─────────────────────────────────────────────────────────────┤
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────────┐ │
│ │ Gatekeeper │ │ Keymaster │ │ Policy Engine │ │
│ │ (Identity) │ │ (Credentials)│ │ (Zero-Trust) │ │
│ └──────────────┘ └──────────────┘ └──────────────────┘ │
│ │ │
│ ┌──────┴──────┐ │
│ │ AI Agents │ │
│ │ Council │ │
│ └──────┬──────┘ │
│ │ │
│ ┌──────────────┐ ┌──────┴──────┐ ┌──────────────────┐ │
│ │ NetMesh │ │ Shield │ │ Observer │ │
│ │ (Network) │ │ (Firewall) │ │ (SIEM) │ │
│ └──────────────┘ └─────────────┘ └──────────────────┘ │
└─────────────────────────────────────────────────────────────┘
Quick Start
Prerequisites
- Python 3.11+
- Docker and Docker Compose (for deployment)
- Network equipment with API access (OPNsense, UniFi, etc.)
- Ollama (for local AI inference)
Installation
# Clone the repository
git clone https://github.com/1450enterprises/sentinel.git
cd sentinel
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install dependencies
pip install -e ".[dev]"
# Copy and configure settings
cp config/default.yaml config/local.yaml
# Edit config/local.yaml with your settings
Running
# Start with local configuration
sentinel --config config/local.yaml
# Or run directly with Python
python -m sentinel.main --config config/local.yaml
# Run with Docker
docker-compose -f deploy/docker/docker-compose.prod.yml up -d
Configuration
See config/homelab.yaml for a complete configuration example. Key settings:
integrations:
router:
type: "opnsense"
host: "192.168.1.1"
api_key: "${ROUTER_API_KEY}"
switch:
type: "ubiquiti"
controller_url: "https://192.168.1.2:8443"
llm:
primary:
type: "ollama"
host: "http://localhost:11434"
model: "llama3.1:8b"
Project Structure
sentinel/
├── src/sentinel/
│ ├── core/ # Core engine and models
│ ├── agents/ # AI agents
│ ├── integrations/ # External system integrations
│ ├── api/ # REST API
│ └── cli/ # Command-line interface
├── tests/ # Test suite
├── config/ # Configuration files
├── deploy/ # Deployment configurations
└── docs/ # Documentation
Development
# Install dev dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run tests with coverage
pytest --cov=sentinel --cov-report=html
# Format code
black src tests
# Lint code
ruff check src tests
# Type checking
mypy src
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is dual-licensed under the GNU Affero General Public License v3.0 (LICENSE) for open-source use and a Commercial License for proprietary/SaaS use — see LICENSING.md for tiers and commercial terms.
Acknowledgments
Documentation: https://sentinel.1450enterprises.com/docs
Issues: https://github.com/1450enterprises/sentinel/issues