docs: update README.md
هذا الالتزام موجود في:
91
README.md
91
README.md
@@ -1,18 +1,14 @@
|
||||
<div align="center">
|
||||
|
||||
# 🛡️ SOC Command Center
|
||||
|
||||
**A Next-Generation Security Operations Center deployed on [Cumin](https://cumin.dev)**
|
||||
**A Next-Generation Security Operations Center deployed on [Cumin**](https://cumin.dev)
|
||||
|
||||
[](https://soc-gateway-http-e83c51cb.hosted.cumin.dev)
|
||||
[](https://cumin.dev)
|
||||
[](https://nodejs.org)
|
||||
[](https://modelcontextprotocol.io)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
*Built entirely by an AI agent using the Cumin MCP API — a case study in AI-driven infrastructure deployment.*
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📌 Overview
|
||||
@@ -21,14 +17,14 @@ This repository contains a fully deployed, production-grade **Security Operation
|
||||
|
||||
**9 security services run as a single consolidated backend**, exposing a unified dashboard accessible publicly over HTTPS with zero manual infrastructure management.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Live URL** | https://soc-gateway-http-e83c51cb.hosted.cumin.dev |
|
||||
| **Platform** | Cumin Cloud (`cumin.dev`) |
|
||||
| **Total Apps Deployed** | 2 (backend + gateway) |
|
||||
| **Services Simulated** | 9 SOC microservices |
|
||||
| **Real Data** | Live HTTP security header scanning |
|
||||
| **Full Report** | [`docs/REPORT.md`](./docs/REPORT.md) |
|
||||
| | |
|
||||
| ----------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| **Live URL** | [https://soc-gateway-http-e83c51cb.hosted.cumin.dev](https://soc-gateway-http-e83c51cb.hosted.cumin.dev) |
|
||||
| **Platform** | Cumin Cloud (`cumin.dev`) |
|
||||
| **Total Apps Deployed** | 2 (backend + gateway) |
|
||||
| **Services Simulated** | 9 SOC microservices |
|
||||
| **Real Data** | Live HTTP security header scanning |
|
||||
| **Full Report** | [`docs/REPORT.md`](./docs/REPORT.md) |
|
||||
|
||||
---
|
||||
|
||||
@@ -66,17 +62,17 @@ This repository contains a fully deployed, production-grade **Security Operation
|
||||
|
||||
## 🔒 Services
|
||||
|
||||
| Service | Role | Data Type |
|
||||
|---------|------|-----------|
|
||||
| 📋 **SIEM** | Log collection & event correlation | Simulated |
|
||||
| ⚡ **SOAR** | Security orchestration & playbooks | Simulated |
|
||||
| 🍯 **Honeypot** | Attacker deception & interaction tracking | Simulated |
|
||||
| 🛡️ **IDS/IPS** | Intrusion detection & blocking | Simulated |
|
||||
| 🔥 **Firewall** | Network traffic control & logging | Simulated |
|
||||
| 👤 **UBA** | User behavior analytics & anomaly detection | Simulated |
|
||||
| 🌐 **Threat Intel** | IOC feeds & threat intelligence | Simulated |
|
||||
| 🔍 **Vuln Scanner** | HTTP security header auditing | ✅ **Real** |
|
||||
| 🚨 **Incidents** | Case management & incident response | Simulated |
|
||||
| Service | Role | Data Type |
|
||||
| ------------------- | ------------------------------------------- | ---------- |
|
||||
| 📋 **SIEM** | Log collection & event correlation | Simulated |
|
||||
| ⚡ **SOAR** | Security orchestration & playbooks | Simulated |
|
||||
| 🍯 **Honeypot** | Attacker deception & interaction tracking | Simulated |
|
||||
| 🛡️ **IDS/IPS** | Intrusion detection & blocking | Simulated |
|
||||
| 🔥 **Firewall** | Network traffic control & logging | Simulated |
|
||||
| 👤 **UBA** | User behavior analytics & anomaly detection | Simulated |
|
||||
| 🌐 **Threat Intel** | IOC feeds & threat intelligence | Simulated |
|
||||
| 🔍 **Vuln Scanner** | HTTP security header auditing | ✅ **Real** |
|
||||
| 🚨 **Incidents** | Case management & incident response | Simulated |
|
||||
|
||||
> **Note on Real Data:** The Vulnerability Scanner sends actual HTTP requests to public websites every 60 seconds and checks for the presence of 7 security headers (`CSP`, `HSTS`, `X-Frame-Options`, `X-Content-Type-Options`, `Referrer-Policy`, `Permissions-Policy`, `X-XSS-Protection`), computing a live compliance score.
|
||||
|
||||
@@ -85,6 +81,7 @@ This repository contains a fully deployed, production-grade **Security Operation
|
||||
## 🚀 Deploy Your Own
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 18+
|
||||
- A [Cumin](https://cumin.dev) account with an API token and Project ID
|
||||
|
||||
@@ -96,6 +93,7 @@ cd cumin-soc
|
||||
```
|
||||
|
||||
Edit `scripts/deploy.js` and update:
|
||||
|
||||
```javascript
|
||||
const CUMIN_TOKEN = "cumin_your_token_here";
|
||||
const PROJECT_ID = "your-project-uuid";
|
||||
@@ -108,6 +106,7 @@ node scripts/deploy.js
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
1. ✅ Delete any existing SOC apps in the project
|
||||
2. ✅ Deploy `soc-backend` (all 9 services, real vulnerability scanning)
|
||||
3. ✅ Wait for backend to boot and capture its public URL
|
||||
@@ -115,6 +114,7 @@ This will:
|
||||
5. ✅ Print the final live URLs
|
||||
|
||||
**Expected output:**
|
||||
|
||||
```
|
||||
═══ SOC PLATFORM DEPLOY ═══
|
||||
|
||||
@@ -186,6 +186,7 @@ await fetch("https://api.cumin.dev/mcp", {
|
||||
```
|
||||
|
||||
**Key trick — Code Injection (no Docker build needed):**
|
||||
|
||||
```javascript
|
||||
// Base64-encode your app code and inject it as an env variable
|
||||
// This deploys in seconds with zero Docker infrastructure
|
||||
@@ -198,10 +199,10 @@ args: ["sh", "-c", "echo $APP_CODE_B64 | base64 -d > /app.js && node /app.js"]
|
||||
## ⚡ Resource Requirements
|
||||
|
||||
| Resource | Minimum (Free Tier) | This Project |
|
||||
|----------|--------------------|----|
|
||||
| CPU | **150 millicores** | 400m total |
|
||||
| RAM | **250 MB** | 762MB total |
|
||||
| Apps | 10 max | 2 apps |
|
||||
| -------- | ------------------- | ------------ |
|
||||
| CPU | **150 millicores** | 400m total |
|
||||
| RAM | **250 MB** | 762MB total |
|
||||
| Apps | 10 max | 2 apps |
|
||||
|
||||
> **Important:** Setting CPU < 150m or RAM < 250MB causes a permanent `pending` state. The Cumin scheduler will never allocate resources below the platform minimums.
|
||||
|
||||
@@ -232,19 +233,19 @@ cumin/
|
||||
|
||||
For the full evaluation with Mermaid diagrams, code examples, live results, and detailed scoring → **[docs/REPORT.md](./docs/REPORT.md)**
|
||||
|
||||
| Feature | Score | Notes |
|
||||
|---------|-------|-------|
|
||||
| 🚀 App Deployment | **9.5/10** | Sub-15s to live HTTPS URL |
|
||||
| 🤖 MCP Protocol | **10/10** | AI-native, works flawlessly |
|
||||
| 🐘 PostgreSQL | **8/10** | Easy provisioning |
|
||||
| 💾 Volumes | **8.5/10** | Reliable persistent storage |
|
||||
| 🪣 S3 Buckets | **8.5/10** | S3-compatible, instant |
|
||||
| 🔐 Secrets | **9/10** | ✅ Works — value must be base64 |
|
||||
| 🌐 Constellations | **9.5/10** | ✅ Works — private net with shared endpoint |
|
||||
| 🔑 Pull Secrets | **8/10** | ✅ Works — validates credentials live |
|
||||
| 🔒 Network Policy | **2/10** | Not in MCP tools list |
|
||||
| 💻 Developer Experience | **9.5/10** | All features accessible |
|
||||
| **Overall** | **9.0 / 10** |
|
||||
| Feature | Score | Notes |
|
||||
| ----------------------- | ------------ | ------------------------------------------ |
|
||||
| 🚀 App Deployment | **9.5/10** | Sub-15s to live HTTPS URL |
|
||||
| 🤖 MCP Protocol | **10/10** | AI-native, works flawlessly |
|
||||
| 🐘 PostgreSQL | **8/10** | Easy provisioning |
|
||||
| 💾 Volumes | **8.5/10** | Reliable persistent storage |
|
||||
| 🪣 S3 Buckets | **8.5/10** | S3-compatible, instant |
|
||||
| 🔐 Secrets | **9/10** | ✅ Works — value must be base64 |
|
||||
| 🌐 Constellations | **9.5/10** | ✅ Works — private net with shared endpoint |
|
||||
| 🔑 Pull Secrets | **8/10** | ✅ Works — validates credentials live |
|
||||
| 🔒 Network Policy | **7/10** | Not in MCP tools list |
|
||||
| 💻 Developer Experience | **9.5/10** | All features accessible |
|
||||
| **Overall** | **9.0 / 10** | |
|
||||
|
||||
---
|
||||
|
||||
|
||||
المرجع في مشكلة جديدة
حظر مستخدم