SentinelX - Red/Blue/Purple Team Security Framework
Project description
SentinelX v2.2 - Red/Blue/Purple Team Framework
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:
- Fork & Clone the repo.
- Create a Branch.
- Ethical Use Only.
- Modular Design.
- Clean Code.
- Submit PR.
❤️ Support the Project
If SentinelX has helped you in your security operations or learning journey, consider supporting the development!
⚠️ 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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sentinelx-2.2.0.tar.gz.
File metadata
- Download URL: sentinelx-2.2.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
63632902567f8d40d594399a91ed5663b15948c29bd1977bda479b8b7b122e2b
|
|
| MD5 |
4b784ab9af1a1f694f42cd3232da8242
|
|
| BLAKE2b-256 |
a263819331bf1c165c8d7dcbdf8df62cc0598116fc04d7a234945876411b6d56
|
File details
Details for the file sentinelx-2.2.0-py3-none-any.whl.
File metadata
- Download URL: sentinelx-2.2.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a8047d10a6676f4288cdf07eaecf27da61d80d936cf1f5c81f286cbf601834de
|
|
| MD5 |
baf6ebedfd49d31e02791f874d34364b
|
|
| BLAKE2b-256 |
5b06abd3da93aaa3bbfb71241c71a01b339c5ed587eb5792dfe4681c6b388c81
|