murdok1982/Cyber-Asset-Attack-Surface-Management

## ⚠️ MANDATORY DISCLAIMER & RULES OF ENGAGEMENT ## ⚙️ ARCHITECTURE OVERVIEW The Internal CAASM Portal operates as a standalone, zero-container service focusing on rapid deployment: - **Core Engine:** FastAPI (Async Python) - **Database:** Local SQLite (via SQLAlchemy) - **Scanner:** Background `nmap` engine (`python-nmap`) - **Intelligence:** Placeholders for Hugging Face `transformers` (ViT Vision Models) and integrations for Analyst Copilots (LLMs). - **Frontend:** Glassmorphism UI built with Tailwind CSS via CDN and Vanilla JS (Served directly by FastAPI). ## 🛠️ INSTALLATION & QUICKSTART ### Prerequisites 1. **Windows OS** (or Linux/macOS with appropriate Python adjustments) 2. **Python 3.11+** installed and added to PATH. 3. **Nmap** installed and added to the system `Environment Variables (PATH)`. This is strictly required for the discovery engine to function. [Download Nmap here](https://nmap.org/download). ### Setup Instructions 1. **Clone/Download the repository** to your local machine (e.g., `C:\Users\USUARIO\Desktop\Inteligencia\caasm-portal`). 2. **Launch the Engine:** Double-click the included `start.bat` file in the root directory. *What `start.bat` does automatically:* - Activates the local Python virtual environment (`venv`). - Verifies SQLite structure based on `models.py`. - Starts the `uvicorn` web server serving both the REST API and the Frontend. 3. **Access the Command Center:** Open your browser and navigate to: http://127.0.0.1:8000 ## 🎯 USAGE GUIDE ### 1. The Dashboard Provides a realtime statistical overview of your authorized footprint. It indicates the total assets discovered, exposed services, and active scanning jobs in the background queue. Keep an eye on the *Analyst Copilot* panel for future AI-driven hardening insights. ### 2. Launching Scans Navigate to **`+ New Scan`** in the top navigation bar. Provide an internal loopback, IP, or CIDR range. - *Valid Target Examples:* `127.0.0.1`, `192.168.1.0/24`, `10.0.0.0/8` - The system will dispatch an asynchronous background task to perform discovery (Ping sweep -> Top 100 Port Scan -> Banner Grabbing) and populate the local SQLite database. ### 3. Service Discovery (Shodan-Style Search) Navigate to the **`Search Map`**. Use the filter syntax to hunt for specific internal exposures: - `port:80` (Finds all assets with HTTP port open) - `service:ssh` (Finds all assets with SSH service running)