From 31f1318cafd2b8c0fd5916702ceaed2203d2bb9a Mon Sep 17 00:00:00 2001 From: fab Date: Sat, 25 Jan 2025 01:48:03 +0100 Subject: [PATCH] Create introduction.md --- docs/introduction.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/introduction.md diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..d4a3452 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,19 @@ +A robust, highly customizable, and feature-rich **Web Application Firewall (WAF)** middleware for the Caddy web server. This middleware provides **advanced protection** against a comprehensive range of web-based threats, seamlessly integrating with Caddy and offering flexible configuration options to secure your applications effectively. + +[![Tests (186) ](https://github.com/fabriziosalmi/caddy-waf/actions/workflows/go.yml/badge.svg)](https://github.com/fabriziosalmi/caddy-waf/actions/workflows/go.yml) [![CodeQL](https://github.com/fabriziosalmi/caddy-waf/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/fabriziosalmi/caddy-waf/actions/workflows/github-code-scanning/codeql) [![Build, Run and Validate](https://github.com/fabriziosalmi/caddy-waf/actions/workflows/build-run-validate.yml/badge.svg)](https://github.com/fabriziosalmi/caddy-waf/actions/workflows/build-run-validate.yml) + +## 🛡️ Core Protections + +* **Regex-Based Filtering:** Deep URL, data & header inspection using powerful regex rules. +* **Blacklisting:** Blocks malicious IPs, domains & optionally TOR exit nodes. +* **Geo-Blocking:** Restricts access by country using GeoIP. +* **Rate Limiting:** Prevents abuse via customizable IP request limits. +* **Anomaly Scoring:** Dynamically blocks requests based on cumulative rule matches. +* **Multi-Phase Inspection:** Analyzes traffic throughout the request lifecycle. +* **Sensitive Data Redaction:** Removes private info from logs. +* **Custom Response Handling:** Tailored responses for blocked requests. +* **Detailed Monitoring:** JSON endpoint for performance tracking & analysis. +* **Dynamic Config Reloads:** Seamless updates without restarts. +* **File Watchers:** Automatic reloads on rule/blacklist changes. + +