|
1 | | -# ModSecurity-Whitelist-Generator |
| 1 | +# ModSecurity Whitelist Generator |
| 2 | + |
| 3 | +Ứng dụng web Next.js giúp tạo whitelist rules cho ModSecurity từ raw logs một cách dễ dàng và trực quan. |
| 4 | + |
| 5 | +## ✨ Tính năng |
| 6 | + |
| 7 | +- 📝 **Nhập Raw Log**: Paste ModSecurity error log trực tiếp vào giao diện |
| 8 | +- 🔍 **Phân Tích Log**: Tự động phân tích và trích xuất thông tin quan trọng |
| 9 | +- 🛡️ **Tạo Whitelist Rules**: Sinh ra nhiều mức độ whitelist rules khác nhau: |
| 10 | + - Global (disable toàn bộ rule) |
| 11 | + - Hostname-based (theo tên miền) |
| 12 | + - URI-based (theo đường dẫn) |
| 13 | + - Method-based (theo HTTP method) |
| 14 | + - IP-based (theo địa chỉ IP) |
| 15 | + - Combined rules (kết hợp nhiều điều kiện) |
| 16 | +- 📋 **Copy Rule**: Copy rule với một click |
| 17 | +- 🌐 **Song ngữ**: Hỗ trợ tiếng Việt và tiếng Anh |
| 18 | +- 🎨 **Giao diện đẹp**: Sử dụng shadcn/ui components với Tailwind CSS |
| 19 | +- ⚡ **Client-side Processing**: Tất cả xử lý diễn ra trên client, không cần server |
| 20 | +- 🚀 **GitHub Pages Ready**: Tự động deploy với GitHub Actions |
| 21 | + |
| 22 | +## 🚀 Cài đặt |
| 23 | + |
| 24 | +```bash |
| 25 | +# Clone repository |
| 26 | +git clone <repository-url> |
| 27 | +cd modsec |
| 28 | + |
| 29 | +# Cài đặt dependencies |
| 30 | +npm install |
| 31 | + |
| 32 | +# Chạy development server |
| 33 | +npm run dev |
| 34 | +``` |
| 35 | + |
| 36 | +Mở [http://localhost:3000](http://localhost:3000) để xem ứng dụng. |
| 37 | + |
| 38 | +## 📖 Hướng dẫn sử dụng |
| 39 | + |
| 40 | +1. **Nhập Log**: Paste raw log từ ModSecurity error log vào textarea hoặc sử dụng demo log |
| 41 | +2. **Phân Tích**: Click "Phân Tích Log" để xem thông tin chi tiết |
| 42 | +3. **Xem Rules**: Chuyển sang tab "Whitelist Rules" để xem các rule được tạo |
| 43 | +4. **Copy Rule**: Click nút "Copy" để copy rule cần thiết |
| 44 | +5. **Áp dụng**: Paste rule vào file cấu hình ModSecurity của bạn |
| 45 | + |
| 46 | +### 🔢 Rule ID Range |
| 47 | +Các whitelist rules được tạo ra sẽ có ID trong khoảng **88,000,000 - 89,999,999**. Khoảng ID này được chọn để: |
| 48 | +- ✅ Tránh xung đột với OWASP CRS rules (900,000 - 999,999) |
| 49 | +- ✅ Tránh xung đột với custom rules thông thường (< 1,000,000) |
| 50 | +- ✅ Dễ nhận biết và quản lý whitelist rules |
| 51 | +- ✅ Đủ lớn để chứa ~2 triệu rules khác nhau |
| 52 | + |
| 53 | +## 🛠️ Tech Stack |
| 54 | + |
| 55 | +- **Framework**: Next.js 14 (App Router) |
| 56 | +- **Language**: TypeScript |
| 57 | +- **Styling**: Tailwind CSS |
| 58 | +- **UI Components**: shadcn/ui |
| 59 | +- **Icons**: Lucide React |
| 60 | + |
| 61 | +## 📝 Ví dụ Log |
| 62 | + |
| 63 | +``` |
| 64 | +2025/10/30 10:22:36 [error] 36552#36552: *121 [client 206.189.2.13] ModSecurity: Access denied with code 403 (phase 2). Matched "Operator Ge' with parameter 5' against variable TX:BLOCKING_INBOUND_ANOMALY_SCORE' (Value: 5' ) [file "/etc/nginx/modsec/coreruleset/rules/REQUEST-949-BLOCKING-EVALUATION.conf"] [line "222"] [id "949110"] [rev ""] [msg "Inbound Anomaly Score Exceeded (Total Score: 5)"] [data ""] [severity "0"] [ver "OWASP_CRS/4.20.0-dev"] [maturity "0"] [accuracy "0"] [tag "anomaly-evaluation"] [tag "OWASP_CRS"] [hostname "dev.nginxwaf.me"] [uri "/config.json"] [unique_id "176181975684.311840"] [ref ""], client: 206.189.2.13, server: dev.nginxwaf.me, request: "GET /config.json HTTP/1.1", host: "dev.nginxwaf.me" |
| 65 | +``` |
| 66 | + |
| 67 | +## 🔧 Build & Deploy |
| 68 | + |
| 69 | +### Local Development |
| 70 | +```bash |
| 71 | +# Build cho production |
| 72 | +npm run build |
| 73 | + |
| 74 | +# Chạy production server |
| 75 | +npm start |
| 76 | +``` |
| 77 | + |
| 78 | +### Deploy lên GitHub Pages |
| 79 | + |
| 80 | +Ứng dụng này được cấu hình sẵn để deploy tự động lên GitHub Pages bằng GitHub Actions. |
| 81 | + |
| 82 | +#### Quick Start: |
| 83 | +1. Push code lên GitHub repository |
| 84 | +2. Vào **Settings** > **Pages** > chọn **Source: GitHub Actions** |
| 85 | +3. Push code lên branch `main` - website sẽ tự động deploy! |
| 86 | + |
| 87 | +#### Chi tiết: |
| 88 | +Xem file [DEPLOYMENT.md](./DEPLOYMENT.md) để biết hướng dẫn chi tiết về: |
| 89 | +- Cấu hình GitHub Pages |
| 90 | +- Deploy tự động với GitHub Actions |
| 91 | +- Cấu hình custom domain |
| 92 | +- Troubleshooting |
| 93 | + |
| 94 | +### Deploy lên Vercel/Netlify |
| 95 | +```bash |
| 96 | +# Vercel |
| 97 | +npx vercel |
| 98 | + |
| 99 | +# Netlify |
| 100 | +npx netlify deploy |
| 101 | +``` |
| 102 | + |
| 103 | +## 📄 License |
| 104 | + |
| 105 | +MIT |
| 106 | + |
| 107 | +## 🤝 Contributing |
| 108 | + |
| 109 | +Contributions, issues và feature requests đều được chào đón! |
0 commit comments