External/patterns
1
0
Fork 0
mirror of https://github.com/fabriziosalmi/patterns.git synced 2025-12-17 09:45:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
fab 2024-12-21 09:14:46 +01:00 committed by GitHub
parent 4f238e10a2
commit 57a404ccf3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 67 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
README.md
View File

@ -1,17 +1,25 @@
# Patterns: OWASP CRS and Bad Bot Detection rules for web servers # 🔒 Patterns: OWASP CRS and Bad Bot Detection for Web Servers
Automate the scraping of **OWASP Core Rule Set (CRS)** patterns and convert them into **Apache, Nginx, Caddy, Traefik, and HAProxy** WAF configurations.
Automate the scraping of **OWASP Core Rule Set (CRS)** patterns and convert them into **Apache, Nginx, Caddy, Traefik and HaProxy** WAF configurations. Additionally, **Bad Bot/User-Agent detection** is integrated to block malicious web crawlers and scrapers. Additionally, **Bad Bot/User-Agent detection** is integrated to block malicious web crawlers and scrapers.
> [!NOTE] > 🚀 **Protect your servers against SQL Injection (SQLi), XSS, RCE, LFI, and malicious bots – with automated daily updates.**
> This project helps protect web servers against common web attacks like **SQL Injection (SQLi)**, **XSS**, **RCE**, **LFI**, and malicious bots – automatically updated and deployed!
--- ---
## 🚀 Project Overview ## 📌 Project Highlights
- **🎯 Goal**: Automate OWASP CRS rule collection and generate WAF configs for **Caddy, Nginx, and Apache**. - **🛡️ OWASP CRS Protection** – Leverages OWASP Core Rule Set for web application firewall (WAF) defense.
- **⚡ Automation**: GitHub Actions fetch rules **daily** and push updated configurations to the repository. - **🤖 Bad Bot Blocking** – Blocks known malicious bots using public bot lists.
- **🤖 Bad Bot Blocking**: Block harmful bots by generating WAF rules from **public bot lists**. - **⚙️ Multi-Web Server Support** – Generates WAF configs for **Apache, Nginx, Caddy, Traefik, and HAProxy**.
- **📄 Output**: WAF `.conf` files categorized by attack type (SQLi, XSS, LFI) and bot lists. - **🔄 Automatic Updates** – GitHub Actions fetch new rules **daily** and push updated configs.
---
## 🌐 Supported Web Servers
- **🔵 Nginx**
- **🟢 Caddy**
- **🟠 Apache (ModSecurity)**
- **🟣 Traefik**
- **🔴 HAProxy**
--- ---
@ -21,14 +29,21 @@ patterns/
├── waf_patterns/ # 🔧 Generated WAF config files ├── waf_patterns/ # 🔧 Generated WAF config files
│ ├── caddy/ # Caddy WAF configs │ ├── caddy/ # Caddy WAF configs
│ ├── nginx/ # Nginx WAF configs │ ├── nginx/ # Nginx WAF configs
│ └── apache/ # Apache WAF configs (ModSecurity) │ ├── apache/ # Apache WAF configs (ModSecurity)
│ ├── traefik/ # Traefik WAF configs
│ └── haproxy/ # HAProxy WAF configs
│── import_apache_waf.py
│── import_caddy_waf.py
│── import_haproxy_waf.py
│── import_nginx_waf.py
│── import_traefik_waf.py
├── owasp.py # 🕵️ OWASP scraper (fetch CRS rules) ├── owasp.py # 🕵️ OWASP scraper (fetch CRS rules)
├── owasp2caddy.py # 🔄 Convert OWASP JSON to Caddy WAF configs ├── owasp2caddy.py # 🔄 Convert OWASP JSON to Caddy WAF configs
├── owasp2nginx.py # 🔄 Convert OWASP JSON to Nginx WAF configs ├── owasp2nginx.py # 🔄 Convert OWASP JSON to Nginx WAF configs
├── owasp2apache.py # 🔄 Convert OWASP JSON to Apache ModSecurity configs ├── owasp2apache.py # 🔄 Convert OWASP JSON to Apache ModSecurity configs
├── badbots.py # 🔄 Generate WAF configs to block bad bots ├── owasp2haproxy.py # 🔄 Convert OWASP JSON to HAProxy WAF configs
├── owasp_rules.json # 📊 Fetched OWASP rules (raw) ├── badbots.py # 🤖 Generate WAF configs to block bad bots
├── requirements.txt # 🔄 Required tools ├── requirements.txt # 📄 Required dependencies
└── .github/workflows/ # 🤖 GitHub Actions for automation └── .github/workflows/ # 🤖 GitHub Actions for automation
└── update_patterns.yml └── update_patterns.yml
``` ```
@ -37,22 +52,19 @@ patterns/
## 🛠️ How It Works ## 🛠️ How It Works
### 🔹 1. Scraping OWASP Rules ### 🔹 1. Scraping OWASP Rules
- `owasp.py` scrapes the latest OWASP CRS patterns from GitHub. - **`owasp.py`** scrapes the latest OWASP CRS patterns from GitHub.
- Pulls attack patterns for **SQLi**, **XSS**, **RCE**, **LFI** from OWASP CRS `.conf` files. - Extracts **SQLi, XSS, RCE, LFI** patterns from OWASP CRS `.conf` files.
### 🔹 2. Multi-Platform WAF Config Generation ### 🔹 2. Generating WAF Configs for Each Platform
- **`owasp2caddy.py`** – Generates Caddy WAF configs using OWASP patterns. - **`owasp2caddy.py`** – Converts OWASP patterns into **Caddy WAF** rules.
- **`owasp2nginx.py`** – Converts OWASP patterns into Nginx WAF rules. - **`owasp2nginx.py`** – Generates **Nginx WAF** configurations.
- **`owasp2apache.py`** – Converts OWASP rules into Apache **ModSecurity** configurations. - **`owasp2apache.py`** – Outputs **Apache ModSecurity** rules.
- **`owasp2traefik.py`** – Creates **Traefik WAF** rules.
- **`owasp2haproxy.py`** – Builds **HAProxy ACL** files.
### 🔹 3. Bad Bot/User-Agent Detection ### 🔹 3. Bad Bot/User-Agent Detection
- `badbots.py` fetches **public bot lists** to block malicious crawlers. - **`badbots.py`** fetches public bot lists and generates bot-blocking configs.
- Fallback lists ensure bot detection works even if the main source fails. - Supports fallback lists to ensure reliable detection.
- Generates `.conf` files for Caddy, Nginx, and Apache.
### 🔹 4. Automation (GitHub Actions)
- GitHub Actions fetch new rules and bot lists **daily at midnight**.
- Automatically commits and pushes updated `.conf` files for all three platforms (Caddy, Nginx, Apache).
--- ---
@ -80,58 +92,24 @@ python badbots.py
--- ---
## 🚀 Usage (Web Server Integration) ## 🚀 Usage (Web Server Integration)
### 🔹 1. Caddy WAF Integration ### 🔹 1. Nginx WAF Integration
```bash ```bash
sudo cp waf_patterns/caddy/*.conf /etc/caddy/ sudo python3 import_nginx_waf.py
``` ```
Add to **Caddyfile**:
```caddy ### 🔹 2. Caddy WAF Integration
import waf_patterns/caddy/*.conf
```
Reload Caddy:
```bash ```bash
caddy reload sudo python3 import_caddy_waf.py
```
### 🔹 3. Apache WAF Integration
```bash
sudo python3 import_apache_waf.py
``` ```
--- ---
### 🔹 2. Nginx WAF Integration ## 🔧 Example Output (Bot Blocker – Nginx)
```bash
sudo cp waf_patterns/nginx/*.conf /etc/nginx/waf/
```
Modify Nginx config:
```nginx
server {
include /etc/nginx/waf/*.conf;
location / {
# Other configs...
}
}
```
Reload Nginx:
```bash
sudo nginx -s reload
```
---
### 🔹 3. Apache ModSecurity Integration
```bash
sudo cp waf_patterns/apache/*.conf /etc/modsecurity.d/
```
Add to Apache config:
```apache
IncludeOptional /etc/modsecurity.d/*.conf
```
Restart Apache:
```bash
sudo systemctl restart apache2
```
---
## 🧩 Example Output (Bot Blocker – Nginx WAF)
**Bot Blocking (waf_patterns/nginx/bots.conf)**:
```nginx ```nginx
map $http_user_agent $bad_bot { map $http_user_agent $bad_bot {
"~*AhrefsBot" 1; "~*AhrefsBot" 1;
@ -147,18 +125,17 @@ if ($bad_bot) {
--- ---
## 🤖 Automation (GitHub Workflow) ## 🤖 Automation (GitHub Workflow)
The GitHub Action (`.github/workflows/update_patterns.yml`) automates updates: - **🕛 Daily Updates** – GitHub Actions fetch the latest OWASP CRS rules every day.
- 🕛 **Runs Daily at Midnight (UTC)** - **🔄 Auto Deployment** – Pushes new `.conf` files directly to `waf_patterns/`.
- 🎯 **Manual Trigger Available** (from GitHub Actions tab) - **🎯 Manual Trigger** – Updates can also be triggered manually.
- 🚀 **Pushes Updated WAF Files** to `waf_patterns/`
--- ---
## 🔧 Contributing ## 🤝 Contributing
1. Fork the repository. 1. **Fork** the repository.
2. Create a feature branch (`feature/new-patterns`). 2. Create a **feature branch** (`feature/new-patterns`).
3. Commit and push changes. 3. **Commit** and push changes.
4. Open a pull request (PR). 4. Open a **Pull Request**.
--- ---
@ -168,14 +145,15 @@ See the [LICENSE](LICENSE) file for details.
--- ---
## 🌐 Resources ## 📞 Need Help?
- [OWASP CRS GitHub](https://github.com/coreruleset/coreruleset) - **Issues?** Open a ticket in the [Issues Tab](https://github.com/your-username/patterns/issues).
- [Caddy Web Server](https://caddyserver.com/) - **Questions?** Feel free to reach out via GitHub Discussions.
- [Nginx](https://nginx.org/)
- [Apache ModSecurity](https://modsecurity.org/)
- [MIT License](https://opensource.org/licenses/MIT)
--- ---
## 🚨 Issues ## 🌐 Resources
If you encounter any issues, please open a ticket in the [Issues Tab](https://github.com/your-username/patterns/issues). - [OWASP CRS](https://github.com/coreruleset/coreruleset)
- [Caddy Web Server](https://caddyserver.com/)
- [Nginx](https://nginx.org/)
- [Apache ModSecurity](https://modsecurity.org/)