Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,10 +1,46 @@
|
|
| 1 |
---
|
| 2 |
-
title: Kali
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Kali Remote Shell
|
| 3 |
+
emoji: 💀
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: green
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# 💀 Kali Remote Shell (HF Spaces Edition)
|
| 11 |
+
|
| 12 |
+
A high-performance, secure Remote Shell server based on **Kali Linux**, specifically optimized for Hugging Face Spaces. It provides a full interactive terminal, file management, and process monitoring with a built-in web UI.
|
| 13 |
+
|
| 14 |
+
## 🚀 Features
|
| 15 |
+
|
| 16 |
+
- **Full Interactive Terminal**: WebSocket-based PTY with `xterm.js` support.
|
| 17 |
+
- **Kali Linux Headless**: Pre-installed with core pentesting tools (nmap, masscan, sqlmap, ffuf, etc.).
|
| 18 |
+
- **Session Isolation**: Each agent/user gets a dedicated isolated workspace in `/tmp/remote-shell/<session_id>`.
|
| 19 |
+
- **File Manager**: Upload, download, read, write, and even extract ZIP files directly via API/UI.
|
| 20 |
+
- **Process Monitor**: Real-time process tree visualization and management.
|
| 21 |
+
- **Security**: Bearer token authentication and path-traversal protection.
|
| 22 |
+
|
| 23 |
+
## 🛠️ Deployment on HF Spaces
|
| 24 |
+
|
| 25 |
+
1. Create a new **Docker** Space.
|
| 26 |
+
2. Upload the following files: `server.py`, `Dockerfile`, and the `static/` directory.
|
| 27 |
+
3. Configure **Secrets** in Space Settings:
|
| 28 |
+
- `API_TOKEN`: Your custom access token.
|
| 29 |
+
4. Open the Space URL and start hacking!
|
| 30 |
+
|
| 31 |
+
## 📡 API Overview
|
| 32 |
+
|
| 33 |
+
| Endpoint | Method | Description |
|
| 34 |
+
|----------|--------|-------------|
|
| 35 |
+
| `/ws/terminal` | `WS` | Full interactive terminal |
|
| 36 |
+
| `/exec` | `GET` | Execute command and stream output |
|
| 37 |
+
| `/files` | `GET` | List files (session-aware) |
|
| 38 |
+
| `/files/upload-zip` | `POST` | Upload and extract ZIP to workspace |
|
| 39 |
+
| `/processes` | `GET` | Get hierarchical process tree |
|
| 40 |
+
|
| 41 |
+
## 🛡️ Security Note
|
| 42 |
+
|
| 43 |
+
This tool is designed for **security research and authorized testing only**. When running on Hugging Face Spaces, it operates within a secure sandbox environment. Always set a strong `API_TOKEN` to prevent unauthorized access.
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
Built with ❤️ for the security community.
|