Skip to content

Repository files navigation

🛡️ Sentinel-V: Autonomous Cyber-Defense Framework

Tests Python Version License

Autonomous defense framework: an event-processing core that scores threats behaviorally, runs a deception network, and produces proportional, auditable responses. Response execution is simulation-safe by design — the engine logs and recommends actions; enforcement is left to integrations you control.

This repository also contains WHSE-01, a self-hosted warehouse inventory system, under warehouse-app/.

What's implemented

Working with only the base install (pip install -e .):

  • SentinelVSystem — orchestrates the full event pipeline: validate → deception check → threat scoring → response → federation
  • Adaptive threat matrix — behavioral anomaly scoring (port fan-out, sensitive-port pressure, repetition, sensor signals) with bounded memory and BENIGN / SUSPICIOUS / MALICIOUS / CRITICAL levels
  • Deception network — deterministic decoy allocation across a network range; any contact with a decoy is flagged and escalates
  • Response engine — graduated playbooks with capped escalation; every execution is recorded in an auditable history
  • Federation node — queues minimized threat intelligence (raw events never leave the node); transport is integration-defined
  • Hybrid crypto — X25519 + HKDF + AES-256-GCM behind a PQC-shaped interface
  • sentinel-v CLI — start, analyze, status, deploy-decoys, validate-config, export-sbom

Optional extras add research modules loaded lazily (the base package never imports them): ml (scikit-learn detector, federated learning), quantum (liboqs KEM), and a paramiko SSH honeypot.

Quick start

git clone https://github.com/DonkeypunchEX/Sentinel-V.git
cd Sentinel-V
pip install -e ".[dev,cli]"   # Python 3.10+
pytest tests/                 # 32 tests
python examples/basic_usage.py
from sentinel_v import SentinelVSystem

sentinel = SentinelVSystem({"system_mode": "production"})
assessment = sentinel.process_event(
    {
        "source_ip": "203.0.113.66",
        "dest_ip": "10.0.0.15",
        "dest_port": 22,
        "protocol": "tcp",
        "failed_auth": True,
    }
)
print(assessment["threat_level"], assessment["anomaly_score"])
sentinel.shutdown()

CLI equivalent:

sentinel-v status
sentinel-v analyze events.json --output results.json
sentinel-v deploy-decoys --network 10.0.0.0/24 --count 5

Configuration reference: config/sentinel.default.yaml. Docker: docker build -t sentinel-v . && docker run sentinel-v (mount your own config/ to override defaults).

Development

make dev-install   # editable install with dev tools
make test          # pytest
make lint          # flake8 + mypy + bandit (same gates as CI)
make security      # bandit + pip-audit
make format        # black

CI runs the same gates across Python 3.10–3.12 on every push and pull request; warehouse-app/ changes are gated by its own Node test suite instead.

License

MIT

About

Autonomous Cyber-defense framework

Resources

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages