Zhongkui-WAF 安装与配置指南

Zhongkui-WAF 安装与配置指南

zhongkui-wafWAF based on lua-nginx-module.项目地址:https://gitcode.com/gh_mirrors/zh/zhongkui-waf

1. 项目目录结构及介绍

主要目录

1. conf: 包含主要的配置文件，如 zhongkui.conf, admin.conf, sites.conf。
2. lua: 存放 Lua 脚本代码。
3. lib: 核心库文件，用于支持 WAF 功能。
4. admin: 管理界面相关的 Lua 脚本。
5. rules: 规则文件，包括 IP 黑名单 (ipBlackList) 和敏感信息过滤规则。
6. logs: 默认的日志存放目录。

文件介绍

• zhongkui.conf: WAF 的基本配置文件，设置全局参数。
• admin.conf: 管理界面的配置，如接口地址和认证信息。
• sites.conf: 网站特定的配置，可针对不同域名或路径定制规则。
• ipBlackList: IP 黑名单列表，可手动编辑或通过配置文件引入。
• sensitive.json: 敏感信息过滤规则。

2. 项目启动文件介绍

Zhongkui-WAF 是基于 Lua 和 Nginx 模块的，因此它的启动依赖于 Nginx 的配置。在 Nginx 的 http 模块下，你需要添加以下配置来启用 Zhongkui-WAF:

include /usr/local/openresty/zhongkui-waf/conf/waf.conf;
include /usr/local/openresty/zhongkui-waf/conf/admin.conf;
include /usr/local/openresty/zhongkui-waf/conf/sites.conf;

然后，启动 Nginx 服务器以运行 WAF，命令通常是：

sudo service nginx start 或 sudo systemctl start nginx

3. 项目配置文件介绍

3.1 zhongkui.conf

这是 WAF 的核心配置文件，包含了以下几个关键选项：

• waf: 设置为 "on" 启动 WAF。
• mode: "monitor" 仅记录日志，"protection" 则拦截攻击请求。
• rules_sort: "on" 开启规则自动排序。
• attackLog: "on" 开启攻击日志记录。
• logPath: 日志文件存储路径。
• geoip: "on" 启用 IP 地理位置识别，需要指定 geoip_db_file。

3.2 admin.conf

用于配置管理界面，可能包括 API 接口端点、认证方法等。

3.3 sites.conf

此文件允许你为不同的站点或路径设定特定的规则和策略。例如，你可以为每个域名或路径定义不同的 IP 黑名单、白名单以及自定义规则。

在 rules 目录下的文件（如 ipBlackList），可以直接修改这些文件来更新 IP 黑名单。

敏感信息过滤规则配置（sensitive.json）

这个 JSON 文件用来定义哪些信息应该被过滤或脱敏。例如，手机号码和密码信息。每个规则包含状态、动作、编码范围和匹配规则等字段。

---

以上即为 Zhongkui-WAF 的安装与配置简要指南。详细配置需根据实际需求进行调整，确保所有相关服务正常运行，并根据实际情况优化性能和安全策略。

zhongkui-wafWAF based on lua-nginx-module.项目地址:https://gitcode.com/gh_mirrors/zh/zhongkui-waf