From b11ee608b40e0ffd90999e59ea6729c8ddec60b2 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sun, 5 Apr 2026 03:22:03 +0000 Subject: [PATCH] docs: implement comprehensive polyglot documentation suite - Created docs/PREREQUISITES.md with exhaustive toolchain requirements. - Created docs/INSTALLATION.md with multi-stack setup guides. - Created docs/USER_GUIDE.md with functional feature documentation. - Created docs/ARCHITECTURE_DEEP_DIVE.md for technical reference. - Updated README.md with a Documentation Hub and Quick Tool-Check. - Ensured all paths match the Universal Polyglot directory structure. --- README.md | 75 +++++++++++++++++++++------------ docs/ARCHITECTURE_DEEP_DIVE.md | 32 ++++++++++++++ docs/INSTALLATION.md | 76 ++++++++++++++++++++++++++++++++++ docs/PREREQUISITES.md | 44 ++++++++++++++++++++ docs/USER_GUIDE.md | 39 +++++++++++++++++ 5 files changed, 239 insertions(+), 27 deletions(-) create mode 100644 docs/ARCHITECTURE_DEEP_DIVE.md create mode 100644 docs/INSTALLATION.md create mode 100644 docs/PREREQUISITES.md create mode 100644 docs/USER_GUIDE.md diff --git a/README.md b/README.md index d141621..9ffbfa0 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,68 @@ -# πŸ›‘οΈ AIP-HSD // THE HYPER-POLYGLOT SENTINEL (V1.5) +# πŸ›‘οΈ AIP-HSD // THE UNIVERSAL POLYGLOT SENTINEL (V1.5) ![Version](https://img.shields.io/badge/version-v1.5.0-red.svg) ![Languages](https://img.shields.io/badge/Stack-30+--Integrated--Tech-blueviolet.svg) -![Security](https://img.shields.io/badge/Mode-Autonomous--Red--Team-orange.svg) -![Compliance](https://img.shields.io/badge/XAI-Explainable--Security-brightgreen.svg) +![Release](https://img.shields.io/badge/Deployment-Docker--Universal-brightgreen.svg) +![Docs](https://img.shields.io/badge/Documentation-Complete-orange.svg) -**AIP-HSD** is now the world's most technologically advanced and diverse security platform. Supporting over 30 integrated languages and tools, it represents the ultimate convergence of legacy reliability, systems performance, and modern AI intelligence. +**AIP-HSD** is an elite, multi-stack security intelligence platform. Supporting over 30 integrated technologies, it bridges legacy mainframe reliability with cutting-edge AI and post-quantum cryptography. --- -## πŸš€ Phase 12: Hyper-Polyglot Mastery +## πŸ“š Documentation Hub -### πŸ”΄ Autonomous Red Team (Python) -Internal self-probing agents that safely simulate sophisticated attack vectors (SQLi, Lateral Movement) to stress-test detection pipelines in real-time. +Explore our comprehensive guides for setup, usage, and technical deep-dives: -### 🧠 Explainable AI (XAI) -Transparent reasoning for every critical security alert. The XAI engine generates human-readable reports detailing the specific telemetry and correlation paths that led to an AI decision. +- [**System Prerequisites**](./docs/PREREQUISITES.md) - Exhaustive list of toolchains and runtimes. +- [**Installation Guide**](./docs/INSTALLATION.md) - Step-by-step setup for every backend/frontend stack. +- [**User Guide**](./docs/USER_GUIDE.md) - Functional manual for SOC analysts and admins. +- [**Architecture Deep Dive**](./docs/ARCHITECTURE_DEEP_DIVE.md) - Technical overview of the intelligence loop and polyglot core. -### πŸ›οΈ Mainframe & Web3 Integration -- **COBOL**: Native legacy mainframe monitoring for enterprise Z/OS environments. -- **Solidity**: Automated smart contract auditing and decentralized asset risk scoring. -- **eBPF**: Kernel-level deep observability for zero-day process detection. +--- + +## πŸ› οΈ Quick Tool-Check -### πŸŒ€ 3D Cyber-Twin & WebXR -The "Sentinel Command" HUD now features a **Cyber-Twin** viewβ€”a real-time 3D digital twin of your organizational infrastructure for immersive incident response. +Before manual deployment, ensure the following core tools are available: +- **Core**: Python 3.12, Node.js 18, Go 1.21, Rust 1.75 +- **Deploy**: Docker & Docker Compose +- **Specialized**: Julia, Zig, Elixir (optional based on module) --- -## 🧩 The Universal Language Matrix (30+) +## 🌎 Choose Your Stack + +Mix and match any Backend with any Frontend. + +### βš™οΈ Backends +| Language | Framework | Package / Link | +| :--- | :--- | :--- | +| **Python** | FastAPI | `pip install aiphsd-python` | +| **Node.js** | Express | `npm install aiphsd-backend-nodejs` | +| **Go** | Gin | `go get github.com/yourusername/aiphsd-go` | +| **Rust** | Axum | `cargo install aiphsd-backend-rust` | + +### πŸ–₯️ Frontends +| Framework | Edition | Feature Highlight | +| :--- | :--- | :--- | +| **React-TS** | Enterprise | Immersive WebXR & 3D Cyber-Twin. | +| **Next.js** | Modern | SSR-capable, ultra-fast analytics. | +| **Static HTML** | Portable | Zero-dependency, lightweight HUD. | + +--- -| Domain | Technologies | -| :--- | :--- | -| **Main Systems** | Python (AI/RedTeam), Node.js, Go (Blockchain), Rust (PQC/HE) | -| **Scientific** | Julia (Forecast), Fortran (Sim), R (Stats), Scala (BigData), F# | -| **Low-level** | Zig (Packets), C++ (Sniffer), eBPF (Kernel), COBOL (Mainframe) | -| **Logic/Verify** | Elixir (Hub), Clojure (Rules), Haskell (Policy), Solidity (Web3) | -| **Web/Script** | React-TS, Next.js 14, Flutter (Dart), PHP, Ruby, Perl, Lua | -| **Infra/Ops** | Terraform, Ansible, Docker, AssemblyScript (Wasm), Inno Setup | +## πŸ•ΉοΈ Autonomous Capabilities +- **πŸ”΄ Autonomous Red Team**: Self-probing attack simulations. +- **🧠 Explainable AI (XAI)**: Decisions with transparent reasoning. +- **πŸ›‘οΈ Zero Trust Edge**: Sandboxed Wasm monitoring & dynamic trust scores. +- **πŸ§ͺ Malware Sandbox**: Behavioral analysis with MITRE ATT&CK mapping. --- -## πŸ•ΉοΈ Autonomous Command Center -The platform can now autonomously hunt, simulate attacks, explain its reasoning, and remediate threats across every layer of the corporate stackβ€”from the kernel to the cloud. +## 🚦 Getting Started +```bash +# Default Stack Deployment +docker-compose -f docker/docker-compose.yml up --build +``` --- -*Architected by Jules // The Hyper-Polyglot Sentinel.* +*Architected by Jules // The Universal Polyglot Sentinel.* diff --git a/docs/ARCHITECTURE_DEEP_DIVE.md b/docs/ARCHITECTURE_DEEP_DIVE.md new file mode 100644 index 0000000..7551feb --- /dev/null +++ b/docs/ARCHITECTURE_DEEP_DIVE.md @@ -0,0 +1,32 @@ +# πŸ—οΈ AIP-HSD // Architecture Deep Dive + +This document details the internal data flow, polyglot synchronization, and AI orchestration logic of the **AIP-HSD** platform. + +## 1. Unified Intelligence Loop +The platform operates on a continuous, cycle-based intelligence loop managed by the **AI Orchestrator**: +1. **Ingestion**: Python-based collectors gather global OSINT (RSS, Scraping, Search), while polyglot agents (Go, C++, Python) push internal telemetry via JSON/REST. +2. **Normalization**: Disparate logs are unified into a standard analysis-ready schema. +3. **Correlation**: The AI Hunter matches global threat indicators (IOCs) with internal system anomalies (Ports, Keywords, LATENCY). +4. **Math Delegation**: Heavy composite risk calculations and scientific forecasting are delegated to high-performance cores in **Rust**, **Julia**, and **Fortran**. +5. **Visualization**: Results are pushed to the React-TS/Next.js frontends via WebSockets or high-frequency polling. + +## 2. Polyglot Synchronization Layer +Standardization is achieved through: +- **Universal API Schema**: Every backend implementation (Python, Node, Go, Rust) adheres to the exact same REST API specification. +- **Common Event Format**: All agents emit a unified JSON schema for telemetry and alerts, ensuring cross-language compatibility. +- **Polyglot Messaging**: Critical alerts are distributed via an **Elixir Alert Hub**, leveraging the fault-tolerant Erlang VM. + +## 3. High-Security Core +Security is baked into the architecture: +- **Zero Trust Engine**: A Python-based engine evaluates every internal access request using multi-factor trust scores. +- **Quantum-Ready**: The Rust core includes PQC stubs for Kyber/Dilithium encryption, future-proofing platform communication. +- **Blockchain Audit**: Forensic event logging is implemented as a Go-based blockchain, creating an immutable ledger of security incidents. +- **Adversarial Shield**: A dedicated AI protection layer prevents prompt injection and malicious query patterns. + +## 4. Scalability & Deployment +- **Multi-Arch Containerization**: The stack is built for `amd64` and `arm64` using Docker Buildx. +- **Edge Compute**: Wasm-based monitors allow for sandboxed security logic execution directly on edge nodes. +- **Modular CI/CD**: Each language stack and platform binary has its own isolated GitHub Actions workflow. + +--- +*For development details, please refer to the individual language folders.* diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md new file mode 100644 index 0000000..cdd1f0b --- /dev/null +++ b/docs/INSTALLATION.md @@ -0,0 +1,76 @@ +# βš™οΈ AIP-HSD // Installation & Environment Setup + +This guide provides step-by-step instructions for deploying the **AIP-HSD** platform across its various language implementations. + +## 1. Fast Track (Docker) +The easiest way to get started is using Docker Compose. +```bash +docker-compose -f docker/docker-compose.yml up --build +``` + +## 2. Manual Backend Setup (Choose Your Language) + +### 🐍 Python (FastAPI) +```bash +cd backend/python +pip install -r requirements.txt +uvicorn main:app --host 0.0.0.0 --port 8000 +``` + +### 🟒 Node.js (Express) +```bash +cd backend/nodejs +npm install +node src/index.js +``` + +### 🐹 Go (Gin) +```bash +cd backend/go +go run cmd/main.go +``` + +### πŸ¦€ Rust (Axum) +```bash +cd backend/rust_server +cargo run --release +``` + +## 3. Manual Frontend Setup + +### βš›οΈ React-TS +```bash +cd frontend/react-ts +npm install +# Then run: npm start +``` + +### ⏭️ Next.js +```bash +cd frontend/nextjs +npm install +# Then run: npm run dev +``` + +## 4. Building Specialized Agents + +### ⚑ Zig Parser +```bash +cd agents/zig +zig build-exe parser.zig +``` + +### πŸ”΅ Go Native Collector +```bash +cd agents/go +go build -o collector +``` + +## 5. Running Simulations +```bash +export PYTHONPATH=$PYTHONPATH:$(pwd)/backend/python:$(pwd) +python3 ai_module/orchestrator.py +``` + +--- +*For troubleshooting, please refer to the specific language sub-directories.* diff --git a/docs/PREREQUISITES.md b/docs/PREREQUISITES.md new file mode 100644 index 0000000..0c136dc --- /dev/null +++ b/docs/PREREQUISITES.md @@ -0,0 +1,44 @@ +# πŸ› οΈ AIP-HSD // System Prerequisites & Toolchains + +To run the full-spectrum **AIP-HSD** platform, your system must have the following tools and runtimes installed. Due to the project's hyper-polyglot nature, we recommend using the Dockerized deployment to avoid manual environment setup. + +## 🐍 Primary Core +- **Python 3.12+**: Required for Backend (FastAPI), AI Logic, and SOAR engine. +- **Node.js 18+ (LTS)**: Required for React-TS/Next.js frontends and Node.js backend. +- **Go 1.21+**: Required for native agents and Blockchain audit chain. +- **Rust 1.75+ (Cargo)**: Required for Performance Core (PQC/HE/Malware Analysis). + +## πŸ”¬ Scientific & Specialized +- **Julia 1.9+**: Required for Risk Forecasting module. +- **Zig 0.11+**: Required for high-speed Packet Parser agent. +- **Elixir 1.15+ / OTP 26+**: Required for Real-time Alert Hub. +- **R 4.3+**: Required for Statistical Threat Modeling. +- **Gfortran 11+**: Required for Monte Carlo Risk Simulator. +- **.NET 6.0 SDK (F#)**: Required for Risk Validator module. + +## πŸ›οΈ Legacy & Logic +- **OpenCOBOL (GnuCOBOL)**: Required for Mainframe Security Monitor. +- **Perl 5.30+**: Required for Legacy Log Forensics. +- **Ruby 3.0+**: Required for Platform Maintenance tools. +- **PHP 8.1+**: Required for Legacy Reporting Portal. +- **Clojure CLI / Leiningen**: Required for Logic Rule Engine. +- **GHC (Haskell)**: Required for Formal Policy Verifier. + +## πŸ•ΈοΈ Web3 & Kernel +- **Solc (Solidity Compiler)**: Required for Smart Contract Auditor. +- **Clang/LLVM & Libbpf**: Required for eBPF Deep Observability agent. +- **AssemblyScript (asc)**: Required for Wasm Edge Monitor. + +## πŸ“± Mobile & UI +- **Flutter SDK (Dart)**: Required for Mobile Sentinel Dashboard. +- **Xcode (macOS)**: For iOS notification service compilation. +- **Android Studio / SDK**: For Android notification handler. + +## πŸ—οΈ Infrastructure +- **Docker & Docker Compose**: Recommended for all-in-one deployment. +- **Terraform 1.5+**: For cloud resource provisioning. +- **Ansible 2.14+**: For automated server configuration. +- **Inno Setup (Windows)**: For generating the Universal .exe Installer. + +--- +*If you lack these tools, use `docker-compose up` to run the pre-configured environment.* diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md new file mode 100644 index 0000000..84ef9da --- /dev/null +++ b/docs/USER_GUIDE.md @@ -0,0 +1,39 @@ +# πŸ“˜ AIP-HSD // Functional User Guide + +Welcome to the **AIP-HSD** command center. This guide explains how to navigate and utilize the platform's core security intelligence features. + +## 1. Dashboard Overview +The main HUD is divided into tactical zones: +- **Global Sentinel Map**: Interactive 3D/2D world map showing threat hotspots. Hover over regions for detailed risk metrics. +- **Risk Cards**: Real-time KPIs for Global/Internal threat levels and overall network health. +- **Live Feed**: A synchronized stream of global OSINT alerts and internal system anomalies. + +## 2. AI Intelligence System +### πŸ€– Natural Language Query +Use the search bar at the bottom to "Ask the AI." +* *Example*: "Show all ransomware activity in the last 24 hours." +* *Example*: "Explain the recent port scan on srv-web-01." + +### 🧠 Explainable AI (XAI) +When viewing critical alerts, click on "View Reasoning" to see the XAI breakdown. This report explains the telemetry, correlation paths, and confidence scores behind the AI's decision. + +## 3. Autonomous Modules +### 🏹 Threat Hunter +The AI Hunter runs in the background, matching global intelligence with your system's telemetry. Correlated threats appear in the **Threat Correlation Graph**. + +### πŸ§ͺ Malware Sandbox +Submit suspicious files for analysis. The sandbox generates a detailed behavioral report including: +- Risk score and classification. +- MITRE ATT&CK mapping. +- Automated remediation recommendations. + +## 4. Response & Remediation (SOAR) +### πŸ•ΉοΈ War Room (HITL) +High-severity remediation tasks (e.g., "Isolate Endpoint") require manual authorization in the **War Room**. Review the AI's suggestion and click **APPROVE** to execute the SOAR playbook. + +## 5. Security & Settings +- **Auth**: Use the profile icon to manage JWT-based sessions. +- **Policies**: Navigate to the Settings icon to enable/disable autonomous remediation and manage RBAC roles. + +--- +*For technical API documentation, please access the `/docs` endpoint on your chosen backend.*