README.md
Rama latest · réplica de lectura del repositorio original.
# Fail2Ban-Report
-gold?style=flat&logoColor=black)
## Please Update as soon as possible when you are using 0.5.0, 0.5.1 or other "legacy" version.
- see "- [## 🆕 What's New in v0.5.2 (Cumulative Security Release)](#-whats-new-in-v052-cumulative-security-release)" for Details!
- see " [https://github.com/SubleXBle/Fail2Ban-Report/security/advisories](https://github.com/SubleXBle/Fail2Ban-Report/security/advisories)" for full reports
- for single Server Version have a look at the [Docker-Version](https://github.com/SubleXBle/Fail2Ban-Report-Docker)
---
A lightweight web-based "multi-server dashboard" that transforms daily Fail2Ban logs into searchable and filterable JSON reports, while also providing centralized UFW IP blocklist management across all your servers through a pull-based client-side synchronization via secure HTTPS endpoints.
**Integration**
>Designed for easy integration on a wide range of Linux systems — from small Raspberry Pis to modest business setups — though it’s not (yet) targeted at large-scale enterprise environments.
High flexibility comes from the backend shell scripts, which you can adapt to your specific environment or log sources to provide the JSON data the web interface needs (daily JSON event files).
## 🛡️ **Note**: This tool is a visualization and management layer — it does **not** replace proper intrusion detection or access control. Deploy it behind IP restrictions or HTTP authentication only!
> ### ❗This version introduces **Authentication** and **Multi-Server Support** as core features.
>
>To enable these, significant parts of the application have been reworked to align with the new multi-server architecture and integrated authentication system. A new `/endpoint/` has also been added to synchronize your Fail2Ban servers with Fail2Ban-Report. If anything not working as expected, feel free to open an discussion or issue. As usual see the [changelog](changelog.md) for more detailed change information.
> For further details, see the [Syncronisation-Concept](Docs/Sync-Concept.md) and the [Chain of Trust](Docs/chain-of-trust.md) or the [Authentication System](Docs/Authentication-System.md) Documentations.
---
## 📑 Table of Contents
- [⚠️ Status of the Project](#️-status-of-the-project)
- [Syncronisation-Concept](Docs/Sync-Concept.md)
- [Chain of Trust](Docs/chain-of-trust.md)
- [📦 Features](#-features)
- [🖥️ Demo](#️-demo)
- [🛠️ Installation](#️-installation)
- [🧱 Architecture Overview](#-architecture-overview)
- [⚙️ Requirements](#️-requirements)
- [🗄️ Server](#️-server)
- [📡 Sync-Client](#-sync-client)
- [🆕 What's New in v0.5.2](#-whats-new-in-v052)
- [🪳 Bugfixes (History)](#-bugfixes-history)
- [👀 Outlook](#-outlook)
- [🖼️ Screenshots](#-screenshots)
- [👥 Discussions](#-discussions)
- [📄 Changelog](#-changelog)
- [⚡ Performance & Stress Test](#-performance--stress-test)
- [🛣️ Roadmap or "Things I will have to do - but I do them later"](#️-roadmap-or-things-i-will-have-to-do---but-i-do-them-later)
- [🐳 Docker Version](#-Docker-Version)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
---
## ⚠️ Status of the Project
**Current Status:**
> Fail2Ban-Report currently manages bans and unbans via UFW, providing a safe and persistent solution.
It does not modify Fail2Ban jails or existing Fail2Ban configurations directly, instead using UFW for its own "permanent jails".
> **Version 0.5.0 introduces multi-server support and role-based access:** Viewer accounts are read-only, while Admins can manage bans/unbans and blocklists across all connected servers via the dashboard.
**Future Direction:**
> A potential long-term enhancement could include **direct interaction with Fail2Ban jails** — for example, user-controlled bans and unbans per jail.
The existing structured `*.blocklist.json` format is already designed to support this, ensuring that any future manual ban management can remain "persistent", reviewable, and fully auditable.
**Syncronisation-Concept and Chain of Trust**
> you can read about the Syncronisation Concept in this Document [Sync-Concept](Docs/Sync-Concept.md) to get a better understanding of how it works
> you can read about the "Chain of Trust" between Server and Clients in this Document: [Chain of Trust](Docs/chain-of-trust.md)
Critical backend operations (like UFW updates) are executed via root cron scripts; ensure the server running Fail2Ban-Report is fully secured.
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 📦 Features
- 🌐 **Multi-server support** with HTTPS sync backend
- 🔐 **User authentication** with roles (Admin / Viewer)
- 🔍 Searchable & filterable event reports
- 📊 Aggregated statistics (today, yesterday, 7 days, 30 days)
- 📂 Jail- and server-specific blocklists
- 🔄 Firewall sync with UFW
- 🔐 Authentication with role separation
- ⚡ Lightweight: no database, no frameworks
- 🛠️ Setup scripts for installation, permissions, and user management
- 🧩 Modular structure
- 🪵 Optional backend logging for ban/unban actions
- 🔍 Optional integrations: (_Free API-KEYS_)
- [AbuseIPDB](https://www.abuseipdb.com/) for reputation lookups
- [IP-Info.io](https://ipinfo.io/) for region/provider checks
> 🧰 Works even on small setups (Raspberry Pi, etc.)
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🖥️ Demo
👀 Want to try out the look & feel?
There's a simple demo version available here – no backend, no real data:
👉 https://demo.suble.net/ 🔗
Username and Password for Website Access is : `admin`:`admin`
Username and Password for Blocklist manipulation is `admin`:`admin`
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🛠️ Installation
### Manual Installations:
> - [New Installation](Docs/Setup-Instructions.md)
> - [Upgrading fom 0.3.3 or above](Docs/update-existing-installation.md)
> - [Add Sync-Client](Docs/Adding-Clients.md)
> when your existing installation is older than Version 0.3.3 you can still do the upgrade installation, your Daily json Files will be fully compatible, you would have to rename you blockfile to *.blockfile.json to further use it. A fresh Install would be still recommended
### Auto-Installer
> - expected with 0.5.5
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🧱 Architecture Overview
**Backend (Shell scripts):**
- Parse Fail2Ban logs → generate daily JSON event files
- Maintain and update jail-specific blocklists (`*.blocklist.json`)
- Sync blocklists with `ufw`
- Provide HTTPS endpoint for multi-server synchronization
**Frontend (PHP Web Interface):**
- Event timeline with filtering and search
- Per-jail blocklist view
- Multi-server dropdown
- Bulk actions (ban/unban/report)
- Pending status for actions not yet applied
- Warning/critical indicators for activity spikes
- Authentication: viewer (read-only) / admin (ban/unban)
**Blocklists (JSON):**
- Stored per jail and per server
- Include metadata: jail, status, timestamps, source
- Modified only by authenticated admins
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## ⚙️ Requirements
### 🗄️ Server
- Fail2Ban with logging enabled
- UFW (for firewall integration)
- HTTPS-capable web server (Apache)
- PHP 7.4+ with JSON support
- `jq` - (https://jqlang.org/)
- `awk` - (https://en.wikipedia.org/wiki/AWK)
- `curl` - (https://curl.se/)
### 📡 Sync-Client
- Fail2Ban with logging enabled
- UFW (for firewall integration)
- `jq` - (https://jqlang.org/)
- `awk` - (https://en.wikipedia.org/wiki/AWK)
- `curl` - (https://curl.se/)
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🆕 What's New in v0.5.2 (Cumulative Security Release)
This is a critical security update that aggregates multiple major vulnerability fixes from versions 0.5.1 and 0.5.2. All operators are strongly urged to upgrade immediately and replace both their Web-UI files and fleet deployment/client scripts.
### 🔒 Security Fixes & Hardening
* **Fixed Stored Cross-Site Scripting (XSS) via Client Sync (0.5.1 Hotfix):** Resolved a critical vulnerability in `backsync.php` and `blocklist-overlay.js` where malicious or compromised sync clients could upload a manipulated JSON file containing arbitrary JavaScript payloads (e.g., inside the `ip` or `jail` fields). The UI has been refactored to ban `innerHTML` usage, shifting entirely to secure `textContent` and `createElement` DOM manipulation to neutralize any script execution hazards.
* **Fixed Authentication Bypass on Read Plane (0.5.2):** Resolved an architectural flaw where unauthenticated network sessions were automatically assigned a default `viewer` role, leaving sensitive firewall history, server configurations, and blocking aggregations open to anonymous actors. Access is now strictly guarded at the global gateway level.
* **Fixed Shell Command Injection in Helper Scripts (0.5.2):** Patched `manage_users.sh` and `manage-clients.sh` where user-supplied inputs containing specific shell characters (like apostrophes) were interpreted as executable PHP program text. Data payloads are now passed securely using isolated environment variables (`getenv()`).
* **Fixed Credentials Leak in Process Table (0.5.2):** Hardened the multi-server sync engine (`syncback.sh` and `fail2ban_log2json.sh`) to prevent sync passwords (`CLIENT_PASS`) from leaking into the host's public process listing (`argv`). Commands are now packaged dynamically inside localized, temporary configuration files (`chmod 600`).
* **Secured API Lookup Restrictions & Data Sanitization:** Overhauled `action_report-ip.php` to mandate active administrator verification before reaching outbound services, preventing blind exploitation of paid lookups (AbuseIPDB / IPinfo). Integrated native IP structure enforcement (`FILTER_VALIDATE_IP`).
### 🤝 Acknowledgements & Credits
We heavily appreciate the dedication of the security community in making Fail2Ban-Report safer. Special honors go out to:
1. **Aluri Hruthik** (reported by *darkknight268*) – For finding and demonstrating the critical Stored XSS vector in the client sync ecosystem.
2. **jaswanthsai1** – For uncovering the authentication bypasses, command injection paths, and credential leakage surfaces across the dashboard core.
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🪳 Bugfixes (History)
Found a bug? → [Open an issue](https://github.com/SubleXBle/Fail2Ban-Report/issues)
> - ✅ **Date filter** now correctly limits displayed events (0.1.2)
> - ✅ **Jail filter** now correctly shows only the jails present in the displayed event list. (0.2.1)
> - ✅ **File date filtering** fix to include today's JSON logs and ensure latest files are listed correctly. (0.2.2)
> - ✅ **Blocklist Path on unblocking** fixed a possible bug that could lead to not finding the blocklist.json when unblocking from the Blocklist view. (0.2.2)
→ Hotfixed on 05.08.2025 at 13:10 (UTC+2) directly in latest (0.2.3)
> - ✅ **Installer** should now ask if you want to delete and reclone repo when allready existing (0.3.1)
> - ✅ **Added FLOCK** to lock json files to not loose data when several write processes write at the same time (0.3.2)
- ✅ **Handling of "Increase Ban" Events** : will now processed correct by backend and is also visible in frontend via markers (0.4.0)
- Thanks to 👉 **`jbd7`** 👈 for reporting and debugging `issue #21` 👍.
- ⏳ **Copy to Clipboard** cannot copy the list when filtered by markers (0.5.0)
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 👀 Outlook
> next minor releases will focus on stability, security and usability, wider integration of authentication (Aka Loginpage) and smoother sync cycle, next major releases will focus more on statistics, integration of other firewalls and more fail2ban integration
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🖼️ Screenshots
### Main List
### Blocklist View
### Information Message
### Security Message (new)
### Ban Message
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 👥 Discussions
> If you want to join the conversation or have questions or ideas, visit the 💬 [Discussions page](https://github.com/SubleXBle/Fail2Ban-Report/discussions).
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 📄 Changelog
Details about all new features, improvements, and changed files can be found in the [Changelog](changelog.md).
This is especially useful if you want to manually patch or update individual files.
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## ⚡ Performance & Stress Test
Fail2Ban-Report has been tested under high-load conditions to verify stability, responsiveness, and reliable synchronization across multiple servers.
**Real Scenario:**
- **Duration: ~10 minutes**
- **Webserver events:** ~13,400 entries across several jails (mostly SSH)
- **Data per event:** date, action, marker, IP, jail
**Key Results:**
- Since each ban is triggered after 4 failed attempts, the actual number of incoming requests corresponds to roughly 53,600 login attempts over 10 minutes → about 5,360 requests per minute (≈ 89 requests per second).
- The WebUI loads all 13,480 daily JSON entries in about 1.5 seconds.
- Connected clients consistently pulled and pushed blocklists without any delay. Even when a blocklist update included 80+ new IP entries, the synchronization completed in a blink of an eye, with changes applied in both directions instantly.
- Switching between multiple servers in the dashboard remains smooth, typically under 2 seconds, even during attacks.
**Takeaway:**
Fail2Ban-Report maintains fast performance and reliable data synchronization, proving its suitability for multi-server setups and high-frequency event environments.
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🛣️ Roadmap or "Things I will have to do - but I do them later"
> I gave up the usual Roadmap - to have more freedom with development - Things like Multiserver was never on the Roadmap but allways in my mind.
- ⏳ Rework Blocklist Overlay
- ⏳ Rework Stylesheet
- ⏳ Rework Info Notices
> As I am using Fail2Ban-Report I think it has a lot of potential to become something nice for not just myself.
> Suggestions and Ideas still welcome at any time (see Discussions) - When you are using Fail2Ban-Report and you think "I would need to see .. " tell me, I am happy to see your Ideas!
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🐳 Docker Version
> Development of [Docker Version of Fail2Ban-Report](https://github.com/SubleXBle/Fail2Ban-Report-Docker) is expected with 0.5.1
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 🤝 Contributing
Pull requests, feature ideas and bug reports are very welcome!
- Found a bug? → [Open an issue](https://github.com/SubleXBle/Fail2Ban-Report/issues)
- Want to contribute? → please contact me first
- Have an idea? → Start a discussion or reach out directly : visit the 💬 [Discussions page](https://github.com/SubleXBle/Fail2Ban-Report/discussions)
> 💡 “Wouldn’t it be cool if it could also do XYZ?”
> Absolutely — I’m happy to hear your ideas.
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---
## 📄 License
This project is licensed under the **GPLv3**.
Feel free to use, modify and share — but please respect the license terms.
##### [↑ Table of Contents ↑](#-Table-of-Contents)
---