# jxwaf
**Repository Path**: endlesshh/jxwaf
## Basic Information
- **Project Name**: jxwaf
- **Description**: jxwaf (锦衣盾)是一款基于 openresty(nginx+lua) 开发的下一代 web 应用防火墙，独创的业务逻辑防护引擎和机器学习引擎可以有效对业务安全风险进行防护，解
- **Primary Language**: C/C++
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/jxwaf
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 11
- **Created**: 2025-03-29
- **Last Updated**: 2025-03-29
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# JXWAF
[中文版](https://github.com/jx-sec/jxwaf/blob/master/README.md)
[English](https://github.com/jx-sec/jxwaf/blob/master/English.md)
### Introduced 介绍
JXWAF 是一款开源 WEB 应用防火墙
### Notice 通知
- JXWAF4.4 发布
```
1、新增 扫描攻击防护
2、新增 网页防篡改
3、新增 IP黑名单
4、流量防护规则 支持状态统计
5、支持人机识别页面自定义
6、报表相关功能优化
注意: 本次更新新增了日志字段，旧版本升级需执行以下命令删除之前的日志数据库文件
# rm -rf /opt/jxwaf_data/clickhouse/
```
### Docs 文档
https://docs.jxwaf.com/
### Feature 功能
- 防护管理
- 网站防护
- 名单防护
- 基础组件
- 分析组件
- 运营中心
- 业务数据统计
- Web 安全报表
- 流量安全报表
- 攻击事件
- 日志查询
- 节点状态
- 系统管理
- 基础信息
- SSL 证书管理
- 日志传输配置
- 日志查询配置
- 拦截页面配置
- 配置备份&加载
### Architecture 架构
- JXWAF 系统由三个子系统组成
- jxwaf 控制台
- jxwaf 节点
- jxlog 日志系统
### Test Environment Deployment 测试环境部署
#### 环境要求
- 服务器系统 Centos 7.x
#### 快速部署
申请一台按量计费服务器，IP 地址为 119.45.234.74 ，完成下面部署步骤
```
# 安装docker，国内网络建议输入 curl -fsSL https://get.docker.com | sh -s -- --mirror Aliyun
curl -sSLk https://get.docker.com/ | bash
service docker start
# 下载docker compose文件,国内网络建议输入 git clone https://gitclone.com/github.com/jx-sec/jxwaf-docker-file.git
yum install git -y
git clone https://github.com/jx-sec/jxwaf-docker-file.git
# 启动容器，国内网络建议输入 cd jxwaf-docker-file/test_env_cn
cd jxwaf-docker-file/test_env
docker compose up -d
```
#### 效果验证
访问 控制台地址 http://119.45.234.74:8000 默认帐号为 test，密码为 123456
登录控制台后，在网站防护中点击新建网站，参考如下配置进行设置
配置完成后，回到服务器
```
[root@VM-0-11-centos test_env_cn]# pwd
/tmp/jxwaf-docker-file/test_env_cn
[root@VM-0-11-centos test_env_cn]# cd ../waf_test/
[root@VM-0-11-centos waf_test]# python waf_poc_test.py -u http://119.45.234.74
```
运行 waf 测试脚本后,即可在控制台中的运营中心查看防护效果
### Production Environment Deployment 生产环境部署
#### 环境要求
- 服务器系统 Centos 7.x
- 服务器推荐配置 4 核 8G 以上
#### jxwaf 控制台部署
服务器 IP 地址
- 公网地址: 175.27.128.142
- 内网地址: 10.206.0.10
```
# 安装docker，国内网络建议输入 curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
curl -sSLk https://get.docker.com/ | bash
service docker start
# 下载docker compose文件
yum install git -y
git clone https://github.com/jx-sec/jxwaf-docker-file.git
# 启动容器，国内网络建议输入 cd jxwaf-docker-file/prod_env_cn/jxwaf-mini-server
cd jxwaf-docker-file/prod_env/jxwaf-mini-server
docker compose up -d
```
部署完成后，访问控制台地址 http://175.27.128.142:8000 ， 第一次访问控制台会自动跳转到帐号注册页面 。 从安全性考虑，建议对访问控制台的IP地址进行限制，例如只允许办公网IP访问。
完成注册并登录控制台后，点击 系统配置 -> 基础信息 页面，查看 waf_auth，后续节点配置需要
#### jxwaf 节点部署
服务器 IP 地址
- 公网地址: 1.13.193.150
- 内网地址: 10.206.0.3
```
# 安装docker，国内网络建议输入 curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
curl -sSLk https://get.docker.com/ | bash
service docker start
# 下载docker compose文件
yum install git -y
git clone https://github.com/jx-sec/jxwaf-docker-file.git
# 启动容器，国内网络建议输入 cd jxwaf-docker-file/prod_env_cn/jxwaf
cd jxwaf-docker-file/prod_env/jxwaf
vim docker-compose.yml
```
修改文件中的 JXWAF_SERVER 和 WAF_AUTH
JXWAF_SERVER 的值为 jxwaf 控制台服务器地址，这里为 http://10.206.0.10:8000 ，注意这里地址不能带路径，即 http://10.206.0.10:8000/ 是错误输入
其中 WAF_AUTH 为 系统配置 -> 基础信息 中 waf_auth 的值
修改后如下
```
docker compose up -d
```
启动后，可以在 运营中心 -> 节点状态 查看节点是否上线
#### jxlog 部署
服务器 IP 地址
- 内网地址: 10.206.0.13
```
# 安装docker，国内网络建议输入 curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
curl -sSLk https://get.docker.com/ | bash
service docker start
# 下载docker compose文件
yum install git -y
git clone https://github.com/jx-sec/jxwaf-docker-file.git
# 启动容器，国内网络建议输入 cd jxwaf-docker-file/prod_env_cn/jxlog
cd jxwaf-docker-file/prod_env/jxlog
docker compose up -d
```
部署完成后，在控制台中 系统配置 -> 日志传输配置 完成如下配置
在 控制台 系统配置 -> 日志查询配置 完成如下配置，其中 ClickHouse 数据库的帐号密码可以在 docker-compose.yml 文件中修改
#### 效果验证
在控制台 防护管理 -> 网站配置 ，点击新建网站，参考如下配置进行设置
配置完成后，回到 jxlog 服务器
```
[root@VM-0-13-centos jxlog]# pwd
/root/jxwaf-docker-file/prod_env_cn/jxlog
[root@VM-0-13-centos jxlog]# cd ../../waf_test/
[root@VM-0-13-centos waf_test]# python waf_poc_test.py -u http://1.13.193.150
```
运行 waf 测试脚本后,即可在控制台中的 运营中心 -> 攻击事件 查看防护效果
### Performance Test 性能测试
#### 服务器
型号: 腾讯云计算型C6服务器
配置: 4核8G
#### wrk测试数据
```
[root@VM-16-11-centos wrk]# wrk -t8 -c5000 -d30s --timeout 10s http://172.16.16.3
Running 30s test @ http://172.16.16.3
8 threads and 5000 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 106.89ms 441.54ms 9.26s 97.44%
Req/Sec 6.72k 4.18k 26.67k 72.94%
1601765 requests in 30.04s, 1.42GB read
Socket errors: connect 0, read 1313, write 0, timeout 94
Requests/sec: 53326.48
Transfer/sec: 48.41MB
```
单机QPS大概为6000左右，可以满足大部分中小企业需求。
有更高性能需求可以增加服务器配置，或者集群部署。
### Contributor 贡献者
- [chenjc](https://github.com/jx-sec)
- [jiongrizi](https://github.com/jiongrizi)
- [thankfly](https://github.com/thankfly)
### BUG&Requirement BUG&需求
- 微信 574604532 添加请备注 jxwaf
- 微信群 不定期更新
