Skip to main content

SentinelX - Red/Blue/Purple Team Security Framework

Project description

SentinelX v2.0 - 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.

📦 Installation & Setup

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.0.0.tar.gz (2.2 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.0.0-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sentinelx-2.0.0.tar.gz
Algorithm Hash digest
SHA256 43c77f7c0491892705e60848a406581e199e3639f61ac16ddbe23743541f2f10
MD5 1f3c26a24d0483c35b95050c5cb3846e
BLAKE2b-256 04ce82271bd2d4e77c3b5948a8090f4735ab8967389d0923e9dd608162fdbdfa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentinelx-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.2 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8dfadd0641ae216c0931e80434ddbebd300560fc574299b40212e7f42b09b1a4
MD5 61fa8b39f9e7b06449ea511de03f6345
BLAKE2b-256 eb0f1f7451ee3c14739b48fa33a12f555fa850cf45937d590bfee2dc65586035

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