lewang321 / jxwaf

JXWAF(锦衣盾)是一款开源web应用防火墙

JXWAF

中文版 English

Introduced 介绍

JXWAF 是一款开源 WEB 应用防火墙

Notice 通知

• JXWAF 第三版正式发布(2020-10-01)

Feature 功能

• 应用安全防护
  • 语义防护引擎
  • Web 攻击 IP 处理
  • 自定义规则
  • 自定义拦截页面
• 流量安全防护
  • CC 攻击防护
  • CC 攻击 IP 处理
  • IP 黑白名单
• 业务安全防护
  • TODO

Architecture 架构

JXWAF 由 jxwaf 节点与 jxwaf 管理中心组成:

• [jxwaf 节点] : 基于 openresty 开发
• [jxwaf 管理中心]：jxwaf-mini-server

Environment 环境

• jxwaf 节点
  • Centos 7
  • Openresty 1.15.8.3
• jxwaf 管理中心
  • Centos 7
  • Python 2.7
  • Django 1.9.2

Quick Deploy 快速部署 (源代码部署)

环境依赖

• 服务器版本 Centos 7.4

管理中心部署

1. $ cd /opt
2. $ git clone https://github.com/jx-sec/jxwaf-mini-server.git
3. $ cd jxwaf-mini-server/
4. $ sh install.sh
5. $ pip install -r requirements.txt
6. $ python manage.py makemigrations
7. $ python manage.py migrate
8. $ nohup python manage.py runserver 0.0.0.0:80 &
9. 假设管理中心 IP 为 10.0.0.1,则打开网址 http://10.0.0.1 进行注册,注册完后登录账号,在 WAF 更新-> 语义引擎更新 中选择 语义引擎版本 加载。在 WAF 更新-> 人机识别更新 中 选择 人机识别版本 加载，同时点击 随机KEY 更新 加载人机识别对应的 KEY

节点部署

1. $ cd /tmp
2. $ git clone https://github.com/jx-sec/jxwaf.git

提示: 国内服务器github下载较慢，提供百度网盘下载，该资源不常更新
https://pan.baidu.com/s/1WAt077rrOSNZj1E4X1u6pw 提取码: vcgw

3. $ cd jxwaf
4. $ sh install_waf.sh
5. $ 运行后显示类似信息即安装成功:

nginx: the configuration file /opt/jxwaf/nginx/conf/nginx.conf syntax is ok
nginx: configuration file /opt/jxwaf/nginx/conf/nginx.conf test is successful

6. 假设管理中心 IP 为 10.0.0.1,则打开网址 http://10.0.0.1 进行注册,注册完后登录账号,在 WAF 管理下的全局配置页面获取"api key"和"api password"
7. $ cd tools
8. $ python jxwaf_local_init.py --api_key=a2dde899-96a7-40s2-88ba-31f1f75f1552 --api_password=653cbbde-1cac-11ea-978f-2e728ce88125 --waf_server=http://10.0.0.1
9. api_key 为全局配置页面中"api key"的值，api_password 为"api password"的值，运行完成后，显示类似信息即安装成功

config file:  /opt/jxwaf/nginx/conf/jxwaf/jxwaf_config.json
config result:
init success,access_id is d7b9fe12-606c-4ca8-bcb5-3dde9853e5f4,access_secret is af5cfc8d-d564-44dd-ba11-f1fecdf95706
auth result:
try to connect jxwaf server auth api_key and api_password,result is True

10. $ /opt/jxwaf/nginx/sbin/nginx
11. 启动 openresty,openresty 会在启动或者 reload 的时候自动到 jxwaf 管理中心拉取用户配置的最新规则,之后会定期同步配置,周期可在全局配置页面设置。

Quick Deploy 快速部署 (Docker部署)

环境依赖

• Docker

docker安装文档: https://docs.docker.com/get-docker/

管理中心部署

1. docker pull jxwaf/jxwaf-mini-server:v20201104
2. docker run -p 80:80 -d jxwaf/jxwaf-mini-server:v20201104
3. 假设管理中心 IP 为 10.0.0.1,则打开网址 http://10.0.0.1 进行注册,注册完后登录账号,在 WAF 更新-> 语义引擎更新 中选择 语义引擎版本 加载。在 WAF 更新-> 人机识别更新 中 选择 人机识别版本 加载，同时点击 随机KEY 更新 加载人机识别对应的 KEY

节点部署

1. docker pull jxwaf/jxwaf:v20201104
2. 假设管理中心 IP 为 10.0.0.1,则打开网址 http://10.0.0.1 进行注册,注册完后登录账号,在 WAF 管理下的全局配置页面获取"api key"和"api password"
3. docker run -p80:80 --env JXWAF_API_KEY=193b002d-5f3e-45a0-85d1-dba8f7c27b64 --env JXWAF_API_PASSWD=c7a648c3-48f3-459a-bc93-1bbc7932f60e --env WAF_UPDATE_WEBSITE=http://10.0.0.1 jxwaf/jxwaf:v20201104
4. JXWAF_API_KEY 为全局配置页面中"api key"JXWAF_API_PASSWD 为"api password"的值，WAF_UPDATE_WEBSITE为管理中心的地址，假设运行后的容器ID为efda21c02e72，则执行下面命令后显示类似信息即正常运行。
5. docker logs efda21c02e72

{
    "waf_api_key": "193b002d-5f3e-45a0-85d1-dba8f7c27b64",
    "waf_api_password": "c7a648c3-48f3-459a-bc93-1bbc7932f60e",
    "waf_update_website": "http://10.0.0.1/waf_update",
    "waf_monitor_website": "http://10.0.0.1/waf_monitor",
    "waf_local":"false",
    "server_info":"|efda21c02e72",
    "waf_node_monitor":"true"
}
nginx: [alert] [lua] waf.lua:647: init(): jxwaf init success,waf node uuid is ad7b29de-858a-4781-ba1c-53ca92506bfd
2020/11/02 17:01:44 [alert] 20#0: [lua] waf.lua:647: init(): jxwaf init success,waf node uuid is ad7b29de-858a-4781-ba1c-53ca92506bfd
2020/11/02 17:01:45 [alert] 23#0: *2 [lua] waf.lua:401: monitor report success, context: ngx.timer
2020/11/02 17:01:45 [error] 23#0: *4 [lua] waf.lua:483: bot check standard key count is 10, context: ngx.timer
2020/11/02 17:01:45 [error] 23#0: *4 [lua] waf.lua:484: bot check key image count is 10, context: ngx.timer
2020/11/02 17:01:45 [error] 23#0: *4 [lua] waf.lua:485: bot check key slipper count is 10, context: ngx.timer
2020/11/02 17:01:45 [alert] 23#0: *4 [lua] waf.lua:502: global config info md5 is 0f1515005b96d11464bbd130ceb6b902,update config info success, context: ngx.timer

Bast Practice 最佳实践

JXWAF 最佳实践

Articles 文章

请关注公众号 JXWAF

Contributor 贡献者

• chenjc 负责 WAF 引擎开发,管理中心开发
• jiongrizi 负责管理中心前端开发,人机识别功能开发,小程序 JXWAF 助手开发
• thankfly 负责日志,大数据分析平台及机器学习平台开发

BUG&Requirement BUG&需求

• github 提交 BUG 或需求
• QQ 群 730947092
• 邮箱 [email protected]
• 微信/QQ 574604532 添加请备注 jxwaf

Thanks 致谢

• P4NY([email protected]):发现 SQL 语义识别引擎一处绕过漏洞
• zhutougg(github):发现上传绕过漏洞
• Neo(236309539): 发现 SQL 语义识别引擎一处绕过漏洞
• 1249648969(QQ 号)：发现 openresty 通用绕过
• kulozzzz(Github): 对比测试 JXWAF 与某厂商语义引擎，发现 XSS 绕过