# jxwaf

**Repository Path**: tomdev/jxwaf

## Basic Information

- **Project Name**: jxwaf
- **Description**: jxwaf (锦衣盾)是一款基于 openresty(nginx+lua) 开发的下一代 web 应用防火墙，独创的业务逻辑防护引擎和机器学习引擎可以有效对业务安全风险进行防护，解
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 11
- **Created**: 2018-04-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# jxwaf


[![Django](https://img.shields.io/badge/centos-7-brightgreen.svg)](https://www.centos.org/)
[![Python3](https://img.shields.io/badge/openresty-1.11.2.5-brightgreen.svg)](http://openresty.org/en/)

jxwaf(锦衣盾)是一款基于openresty(nginx+lua)开发的下一代web应用防火墙，独创的业务逻辑防护引擎和机器学习引擎可以有效对业务安全风险进行防护，解决传统WAF无法对业务安全进行防护的痛点。内置的语义分析引擎配合机器学习引擎可以避免传统WAF规则叠加太多导致速度变慢的问题，同时增强检测精准性（低误报、低漏报）。

### Feature 功能
  - 基础攻击防护 
    - SQL注入攻击
    - XSS攻击
    - 目录遍历漏洞
    - 命令注入攻击
    - WebShell上传防护
    - 扫描器攻击等...
  - 机器学习
    - 支持向量机(SVM)
  - 语义分析
    - SQL注入语义分析
    - XSS攻击语义分析  
  - 业务逻辑漏洞防护
    - 短信炸弹防护
    - 越权漏洞防护
    - 短信验证码校验绕过防护等...
  - 高级CC攻击防护
    - 可针对不同URL，不同请求参数单独设置不同防护变量
    - 人机识别
  - Cookie安全防护
  - 前端参数加密防护
    - 支持AES加解密
    - 支持DES加解密
    - 支持RSA加解密
  - 透明部署动态口令功能
    - 可对后台管理系统和网站用户提供动态口令(OTP)功能
  - 检测缓存功能
    - 对已经过WAF检测请求进行MD5缓存，提高检测效率
  - 支持协议
    - HTTP/HTTPS 
  - 性能&可靠性
     -  毫秒级响应，请求处理时间小于一毫秒
     -  支持主备部署，避免单点故障
     -  支持集群反向代理模式部署，可处理超大数据流量
     -  支持嵌入式部署，无需改变原有网络拓扑结构
     -  支持云模式部署
  - 管理功能
    - 基础配置
    - 规则配置
    - 报表展示
    - 告警配置

### Architecture 架构

jxwaf(锦衣盾)由jxwaf与jxwaf管理中心组成:
  - [jxwaf](https://github.com/jx-sec/jxwaf) : 基于openresty(nginx+lua)开发
  - [jxwaf管理中心](http://www.jxwaf.com)：http://www.jxwaf.com


### Environment 环境

  - jxwaf 
    - Centos 7
    - Openresty 1.11.2.4

###  Install 安装 (已包含openresty安装包)
将代码下载到/tmp目录，运行install_waf.sh文件，jxwaf将安装在/opt/jxwaf目录，具体如下:

   1. $ cd /tmp
   2. $ git clone https://github.com/jx-sec/jxwaf.git
   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


### Usage 使用

```

http {
    include       mime.types;
    default_type  application/octet-stream;
    sendfile        on;
    keepalive_timeout  65;
#start
    resolver  114.114.114.114;
    init_by_lua_file /opt/jxwaf/lualib/resty/jxwaf/init.lua;
    init_worker_by_lua_file /opt/jxwaf/lualib/resty/jxwaf/init_worker.lua;
    rewrite_by_lua_file /opt/jxwaf/lualib/resty/jxwaf/rewrite.lua;
    access_by_lua_file /opt/jxwaf/lualib/resty/jxwaf/access.lua;
    header_filter_by_lua_file /opt/jxwaf/lualib/resty/jxwaf/header_filter.lua;
    log_by_lua_file /opt/jxwaf/lualib/resty/jxwaf/log.lua;
    lua_code_cache on;
#end
    upstream http://1.1.1.1 {
                server 1.1.1.1;
     }
    server {
        listen       80;
        server_name  localhost;
        location / {
            root   html;
            index  index.html index.htm;
                proxy_pass  http://1.1.1.1;
        }
    }
}

```



 


### Docs 文档
   * [JXWAF使用说明](docs/JXWAF使用说明.md)
   * [基于Openresty实现业务安全防护 ](http://www.freebuf.com/vuls/150571.html)
   * [基于Openresty实现透明部署动态口令功能](http://www.freebuf.com/articles/network/150959.html)
   * [WAF开发之Cookie安全防护  ](http://www.freebuf.com/articles/web/164232.html) 
    

### Contributor 贡献者
- [chenjc](https://github.com/jx-sec)  安全工程师
- [jiongrizi](https://github.com/jiongrizi) 前端开发工程师


### BUG&Requirement BUG&需求

- github 提交BUG题或需求
- QQ群 730947092
- 邮箱 jx-sec@outlook.com