Skip to main content

SentinelX - Red/Blue/Purple Team Security Framework

Project description

SentinelX v2.2 - Red/Blue/Purple Team Framework

PyPI - Version PyPI - Python Version License Platform

SentinelX is a modular, production-ready CLI framework designed for authorized security testing, defensive validation, and Purple Team simulations. Built for Kali Linux and Termux, it provides a unified, immersive experience for security professionals.

   _____            _   _            _ __   __
  / ____|          | | (_)          | |\ \ / /
 | (___   ___ _ __ | |_ _ _ __   ___| | \ V / 
  \___ \ / _ \ "_ \| __| | "_ \ / _ \ |  > <  
  ____) |  __/ | | | |_| | | | |  __/ | / . \ 
 |_____/ \___|_| |_|\__|_|_| |_|\___|_|/_/ \_\\

      [ One Console. All Teams. ]

🚀 Key Features

  • Immersive CLI: Full-screen interface that clears the terminal on launch.
  • Team Modes: Dedicated Red, Blue, and Purple Team workflows.
  • Live Dashboard: Dynamic, full-screen analytics dashboard (Option 5).
  • Ethical Authorization: Integrated first-run consent and per-report authorization.
  • Advanced Reporting: Professional PDF generation with SVG logo support and table-based analytics.
  • Visual Identity: Built-in SVG Logo generator.
  • MITRE ATT&CK Mapping: All modules map to industry-standard techniques.

📱 Termux Support

SentinelX is fully optimized for Android via Termux:

  • JSON reports: Always generated.
  • HTML reports: Always generated.
  • PDF reports: Automatically disabled (Android limitation).

The tool will gracefully fallback to HTML + JSON output if PDF dependencies are missing or incompatible with the environment.

📦 Installation & Setup

🐧 System Dependencies (Linux)

To generate PDF reports (WeasyPrint/Cairo), you may need system-level libraries:

sudo apt update
sudo apt install -y pkg-config libcairo2-dev libpython3-dev

1. Install via Pip (PyPI)

The recommended way to install SentinelX is via pip:

pip install sentinelx

2. Run the Tool

The tool is accessible globally via the sentinelX command:

sentinelX

3. Local Development / Manual Install

If you downloaded the source code:

git clone https://github.com/hackura/SentinelX.git
cd SentinelX
pip install .

4. Virtual Environment (Recommended)

To keep your system clean, install SentinelX in a virtual environment:

# Create venv
python3 -m venv venv

# Activate venv
source venv/bin/activate

# Install SentinelX
pip install .

After installation, the sentinelX command will be available whenever the environment is active.


🛠️ Module Ecosystem

🔴 Red Team (Offensive)

  • Recon: Nmap, Amass.
  • Web: Nikto, Nuclei, SQLMap.
  • Auth: Hydra.
  • Payloads: MSFVenom helper.

🔵 Blue Team (Defensive)

  • Scanners: YARA, Sigma.
  • Analytics: Automated log parsing.
  • IOCs: IOC scanning.

🟣 Purple Team (Simulation)

  • Correlation: Attack → Detection simulations.
  • Verification: Validates simulated attacks in logs.
  • PDF Reports: Professional PDF generation.

📊 Advanced Tools

Live Full-Screen Dashboard

Select Option [5] from the main menu for a real-time overview.


### PDF Report Generation
Generate a professional security report (Requires `weasyprint` and `jinja2`):
```bash
python3 -m sentinelx.core.advanced_reporting

📄 Sample Reports

View a sample assessment report:


🗑️ Uninstallation

To completely remove SentinelX:

./sentinelx_uninstall.py

🤝 Contributing

We welcome contributions! Please follow these guidelines:

  1. Fork & Clone the repo.
  2. Create a Branch.
  3. Ethical Use Only.
  4. Modular Design.
  5. Clean Code.
  6. Submit PR.

❤️ Support the Project

If SentinelX has helped you in your security operations or learning journey, consider supporting the development!

Buy Me A Coffee


⚠️ Ethical Disclaimer

SentinelX is for authorized security testing and defensive validation only. The developers are not responsible for misuse. Explicit permission is required to test any target system.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sentinelx-2.3.0.tar.gz (4.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sentinelx-2.3.0-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

Details for the file sentinelx-2.3.0.tar.gz.

File metadata

  • Download URL: sentinelx-2.3.0.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for sentinelx-2.3.0.tar.gz
Algorithm Hash digest
SHA256 075475aba8e78a65467e4f933cc0b91647dcb8851c8295751f3897dc1040d47c
MD5 08682e9d6434bd031570477a0ece73f7
BLAKE2b-256 6a7dc665bc9f4c9e0530165328e918585d67fc3b7e08fb7540c5e789086ebfed

See more details on using hashes here.

File details

Details for the file sentinelx-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: sentinelx-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for sentinelx-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa4354e83e14e7609d92d05e2edc49bbb23988f387db7285778c457d48257a51
MD5 50b6f4bd098dc5953516fb4bd2f275df
BLAKE2b-256 197cce0bfaa3d6b8c4f57007c9e26b0e42e06d6e6688f295a1dddf74b5f6d414

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page