Skip to main content

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

PyPI - Version PyPI - Python Version License: MIT 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.

SentinelX Logo

   _____            _   _            _ __   __
  / ____|          | | (_)          | |\ \ / /
 | (___   ___ _ __ | |_ _ _ __   ___| | \ 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 with role-based colors and banners.
  • Live Dashboard: Dynamic, full-screen analytics dashboard (Option 5) showing tool status and system health.
  • Cumulative Session Reporting: Run multiple operations and generate a single unified report at the end of your session.
  • Ethical Authorization: Integrated first-run consent and per-session authorization prompts.
  • Intelligent PDF Engine: High-fidelity reporting with WeasyPrint, with an automatic fallback to ReportLab for Termux/Mobile environments.
  • Visual Identity: Built-in SVG Logo generator for professional branding.
  • MITRE ATT&CK Mapping: All modules map directly to industry-standard techniques.

📦 Installation & Setup

1. Install via Pip (PyPI)

pip install sentinelx

Note: For full PDF support on Linux, use pip install sentinelx[pdf].

2. Run the Tool

The tool is accessible globally via the sentinelX command:

sentinelX

3. Local Development / Manual Install

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

4. Virtual Environment (Recommended)

python3 -m venv venv
source venv/bin/activate
pip install .

🛠️ Module Ecosystem

🔴 Red Team (Offensive)

  • Recon: Nmap (Service/OS discovery), Amass (Subdomain enumeration).
  • Web: Nikto & Nuclei (Vulnerability scanning), SQLMap (Automated SQLi testing).
  • Auth: Hydra (Brute-force testing).
  • Payloads: MSFVenom helper for security payload generation.

🔵 Blue Team (Defensive)

  • Scanners: YARA (Malware patterns), Sigma (Threat detection rules).
  • Analytics: Automated log parsing for auth.log and Web server access.log.
  • IOCs: Automated Indicator of Compromise (IOC) scanning.

🟣 Purple Team (Simulation)

  • Correlation: Attack → Detection simulations.
  • Verification: Automatically validates if simulated attacks are captured in system logs.
  • Cumulative Reports: Merge multiple simulations into one professional PDF.

📊 Advanced Tools

Live Full-Screen Dashboard

Access the dynamic dashboard by selecting Option [5] from the main menu.

PDF Report Generation

Generate a professional security report:

python3 -m sentinelx.core.advanced_reporting

Supports automated fallback to ReportLab/Markdown if WeasyPrint dependencies (pycairo) are missing.


📄 Sample Reports

View a sample assessment report:


🗑️ Uninstallation

To completely remove SentinelX, including configuration and symlinks:

./sentinelx_uninstall.py

🤝 Contributing

We welcome contributions! Please follow these guidelines:

  1. Fork the repo.
  2. Create a feature branch.
  3. Ensure ethical usage.
  4. Submit a Pull Request.

❤️ Support the Project

If SentinelX has helped you, consider supporting the development!

Buy Me A Coffee


⚠️ Ethical Disclaimer

SentinelX is for authorized security testing and defensive validation only. Explicit permission is required to test any target system. Consent is recorded locally at ~/.sentinelx/.consent.

Metadata

Release files for sentinelx 2.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sentinelx 2.4.0
File Size Uploaded
sentinelx-2.4.0.tar.gz 4.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for sentinelx 2.4.0
File Interpreter ABI Platform
sentinelx-2.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.6 MB

Release files / sentinelx-2.4.0.tar.gz

Download URL sentinelx-2.4.0.tar.gz
Size 4.3 MB
Tags Source
SHA-256 checksum
How to use checksums
e72664749aef8f1c26e878b1a3efe8adcc47c6857d51ab639636cc52b4dc43d9
BLAKE2b-256 checksum
How to use checksums
43f9c28b214eb98c10a1be37e9473c279598625c69c555db58cf36b0d99e336e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / sentinelx-2.4.0-py3-none-any.whl

Download URL sentinelx-2.4.0-py3-none-any.whl
Size 4.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0b2fee329f21a0a10a7f386440e6d35db91f7900c4f126c5b791727abf60b0e0
BLAKE2b-256 checksum
How to use checksums
a5e122bfac9e2c1014da3ddcf18ebb982ceede276065dc773e8fc9bbf9d5c546
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release history Release notifications | RSS feed

This release

2.4.0 This release

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page