Public | Automated Build

Last pushed: a month ago
Short Description
The first all-round open source Web security protection system, more protection than others
Full Description

Name

OpenWAF

Web application security protection system based on openresty

Table of Contents

Version

This document describes OpenWAF v0.0.3.170103_beta released on 03 Jan 2017.

Docker Version

  1. titansec/openwaf:0.0.1.161130_beta
      SHA: 596dee9d2b9ce44d59dc445141f72b3607f9fbe6
      https://github.com/titansec/OpenWAF/tree/596dee9d2b9ce44d59dc445141f72b3607f9fbe6
  2. titansec/openwaf:0.0.3.170103_beta(titansec/openwaf:latest)
      SHA: 28ce1556250301f26f31b46d9cd9dde5a3b3f03f
      https://github.com/titansec/OpenWAF/tree/28ce1556250301f26f31b46d9cd9dde5a3b3f03f

Synopsis

    #nginx.conf
    lua_package_path '/twaf/?.lua;;';

    init_by_lua_file /twaf/app/twaf_init.lua;

    lua_shared_dict twaf_shm 50m;

    upstream test {
        server 0.0.0.1; #just an invalid address as a place holder
        balancer_by_lua_file twaf_balancer.lua;
    }

    server {
        listen 443 ssl;
        server_name _;

        ssl_certificate_by_lua_file  twaf_ssl_cert.lua;
        rewrite_by_lua_file          /twaf/app/twaf_rewrite.lua;
        access_by_lua_file           /twaf/app/twaf_access.lua;
        header_filter_by_lua_file    /twaf/app/twaf_header_filter.lua;
        body_filter_by_lua_file      /twaf/app/twaf_body_filter.lua
        log_by_lua_file              /twaf/app/twaf_log.lua;

        set $twaf_https 1;
        set $twaf_upstream_server "";

        ssl_certificate nginx.crt;
        ssl_certificate_key nginx.key;

        location / {
            lua_need_request_body on;
            proxy_pass $twaf_upstream_server;
        }
    }

    server {
        listen      80;
        server_name  _;

        rewrite_by_lua_file       /twaf/app/twaf_rewrite.lua;
        access_by_lua_file        /twaf/app/twaf_access.lua;
        header_filter_by_lua_file /twaf/app/twaf_header_filter.lua;
        body_filter_by_lua_file   /twaf/app/twaf_body_filter.lua
        log_by_lua_file           /twaf/app/twaf_log.lua;

        set $twaf_upstream_server "";

        location / {
            lua_need_request_body on;
            proxy_pass $twaf_upstream_server;
        }
    }
    #default_config-json

    #main_safe_policy-json

Back to TOC

Description

OpenWAF是基于openresty的Web应用防护系统(WAF),他基于nginx_lua API分析HTTP请求信息。OpenWAF由行为分析引擎和规则引擎两大功能引擎构成。其中规则引擎主要对单个请求进行分析,行为分析引擎主要负责跨请求信息追踪。

规则引擎的启发来自modsecurityfreewaf(lua-resty-waf),将ModSecurity的规则机制用lua实现。基于规则引擎可以进行协议规范,自动工具,注入攻击,跨站攻击,信息泄露,异常请求等安全防护,支持动态添加规则,及时修补漏洞。

行为分析引擎包含基于频率的模糊识别,防恶意爬虫,人机识别等防探测模块,防CSRF,防CC,防提权,文件上传防护等防攻击模块,cookie防篡改,防盗链,自定义响应头,攻击响应页面等防信息泄露模块。

除了两大引擎之外,还包含统计,日志,攻击响应页面,接入规则等基础模块。除了已有的功能模块,OpenWAF还支持动态修改配置,
动态添加第三方模块,使得在不重启引擎中断业务的条件下,升级防护。

OpenWAF支持将上述功能封装为策略,不同的web application应用不同的策略来防护。策略还可分享供他人参考。

基础模块如下:

功能模块如下:

详细配置文档及示例请看上述各模块文档

Back to TOC

Installation

若用docker安装,可省略步骤1-3

1. 下载openresty
   详见 https://openresty.org/en/installation.html

   1.1 cd /opt
   1.2 wget -c https://openresty.org/download/openresty-1.11.2.1.tar.gz
   1.3 tar -xzvf openresty-1.11.2.1.tar.gz

2. 安装OpenWAF
   2.1 cd /opt
   2.2 获取OpenWAF源文件
       git clone https://github.com/titansec/OpenWAF.git
   2.3 移动配置文件
       mv /opt/OpenWAF/lib/openresty/ngx_openwaf.conf /etc
   2.4 覆盖openresty的configure文件
       mv /opt/OpenWAF/lib/openresty/configure /opt/openresty-1.11.2.1
   2.5 移动第三方模块至openresty中
       mv /opt/OpenWAF/lib/openresty/* /opt/openresty-1.11.2.1/bundle/
   2.6 删除OpenWAF/lib/openresty目录
       rm -rf /opt/OpenWAF/lib/openresty

3. 编译openresty
   3.1 cd /opt/openresty-1.11.2.1/
   3.2 ./configure --with-pcre-jit --with-ipv6 \
                   --with-http_stub_status_module \
                   --with-http_ssl_module \
                   --with-http_realip_module \
                   --with-http_sub_module
   3.3 make && make install

4. 编辑配置文件
   4.1 接入规则
       vi /opt/OpenWAF/conf/twaf_access_rule.json
       编辑域名,后端服务器地址等信息
   4.2 日志服务器
       vi /opt/OpenWAF/conf/twaf_default_conf.json
       配置twaf_log日志接收服务器地址

5. 启动引擎
   /usr/local/openresty/nginx/sbin/nginx -c /etc/ngx_openwaf.conf

Problems
1. nginx:[emerg] at least OpenSSL 1.0.2e required but found OpenSSL xxx
   更新OpenSSL版本至1.0.2e以上即可

   如:wget -c http://www.openssl.org/source/openssl-1.0.2h.tar.gz
      ./config
      make && make install

   PS: 
      1. 查看当前openssl版本命令: openssl version
      2. 若更新openssl后,版本未变,请详看http://www.cnblogs.com/songqingbo/p/5464620.html
      3. 若依然提示版本问题,编译openresty时带上--with-openssl=/path/to/openssl-xxx/

2. 提示找不到GeoIP.h

   apt-get install libgeoip-dev

3. 提示找不到swig

   apt-get install swig

4. 提示PCRE不支持JIT 

   编译pcre时,带上--enable-jit参数

Back to TOC

Docker

1. pull docker images from repository
   docker pull titansec/openwaf

2. start-up docker
   2.1 docker run, named openwaf
       docker run -d -p 22:22 -p 80:80 -p 443:443 --name openwaf titansec/openwaf
   2.2 enter openwaf
       docker exec -it openwaf /bin/bash

3. edit config
   3.1 edit access rule
       vi /opt/OpenWAF/conf/twaf_access_rule.json
   3.2 edit log server addr
       vi /opt/OpenWAF/conf/twaf_default_conf.json

4. start-up OpenWAF
    /usr/local/openresty/nginx/sbin/nginx -c /etc/ngx_openwaf.conf

PS:
#add bridge address, e.g. 192.168.39.12
    pipework br0 ContainerName ip/gateway
    如:
    pipework br0 openwaf 192.168.39.12/24@192.168.39.253

Problems
1. pipework: command not found

   git clone https://github.com/jpetazzo/pipework.git
   cp pipework/pipework /usr/local/bin/

2. Warning: arping not found; interface may not be immediately reachable

   apt-get install arping

Back to TOC

Community

English Mailing List

The OpenWAF-en mailing list is for English speakers.

Chinese Mailing List

The OpenWAF-cn mailing list is for Chinese speakers.

Personal QQ Mail

290557551@qq.com

Back to TOC

Bugs and Patches

Please submit bug reports, wishlists, or patches by

  1. creating a ticket on the GitHub Issue Tracker,
  2. or posting to the OpenWAF community.

Back to TOC

TODO

    1. 上传人机识别模块
    1. 上传防盗链模块
    1. 上传防CC模块
    1. 上传cookie防篡改模块
    1. 上传基于频率的模糊识别防探测模块
    1. 上传WebShell上传防护模块
    1. 上传防CSRF模块
    1. 上传OpenWAF docker
    1. 提供页面体验OpenWAF防护功能
    1. 放开动态配置规则引擎API
    1. 放开动态配置行为分析引擎API

Back to TOC

Changes

Time: 2016/12/05
Version: v0.0.2.161205_beta
  1. New Module - twaf_attack_response
    Return Custom response page When the request is rejected by OpenWAF
  2. Api - api/stat[/policy_uuid]
    Show statistical infomation

Time: 2016/12/05
Version: v0.0.1.161130_beta
  1. Docker
    build OpenWAF with docker

Time: 2016/12/05
Version: v0.0.1.161012_beta
  1. log module
    Send tcp/udp log
  2. reqstat module
    Statistics of request infomation
  3. access rule
    Publish applications
  4. rule engine
    Access Control

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2016-2016, by Jian "Miracle" Qi (齐健) miracleqi25@gmail.com, Titan Co.Ltd.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

Modules Configuration Directives

Back to TOC

twaf_access_rule

{
    "twaf_access_rule": [
        "rules": [                                 -- 注意先后顺序
            {                                      
                "client_ssl": false,               -- 客户端认证的开关,与ngx_ssl组成双向认证
                "client_ssl_cert": "path",         -- 客户端认证所需PEM证书地址
                "ngx_ssl": false,                  -- nginx认证的开关
                "ngx_ssl_cert": "path",            -- nginx认证所需PEM证书地址
                "ngx_ssl_key": "path",             -- nginx认证所需PEM私钥地址
                "host": "^1\\.1\\.1\\.1$",         -- 域名,正则匹配
                "port": 80,                        -- 端口号(缺省80)
                "path": "\/",                      -- 路径,正则匹配
                "server_ssl": false,               -- 后端服务器ssl开关
                "forward": "server_5",             -- 后端服务器upstream名称
                "forward_addr": "1.1.1.2",         -- 后端服务器ip地址
                "forward_port": "8080",            -- 后端服务器端口号(缺省80)
                "uuid": "access_567b067ff2060",    -- 用来标记此规则的uuid
                "policy": "policy_uuid"            -- 安全策略ID
            }
        ]
    }
}

###rules
syntax: "rules": table

default: none

context: twaf_access_rule

table类型,接入规则,顺序匹配

###client_ssl
syntax: "client_ssl": true|false

default: false

context: twaf_access_rule

客户端认证开关,与ngx_ssl组成双向认证,默认false

###client_ssl_cert
syntax: "client_ssl_cert": "path"

default: none

context: twaf_access_rule

string类型,客户端认证所需PEM证书地址,目前仅支持绝对地址

###ngx_ssl
syntax: "ngx_ssl": true|false

default: false

context: twaf_access_rule

boolean类型,服务器端(nginx)认证开关,与client_ssl组成双向认证,默认关闭

###ngx_ssl_cert
syntax: "ngx_ssl_cert": "path"

default: none

context: twaf_access_rule

string类型,服务器端(nginx)认证所需PEM证书地址,目前仅支持绝对地址

###ngx_ssl_key
syntax: "ngx_ssl_key": "path"

default: none

context: twaf_access_rule

string类型,服务器端(nginx)认证所需PEM私钥地址,目前仅支持绝对地址

###host
syntax: "host": "ip|domain name regex"

default: none

context: twaf_access_rule

string类型,域名,正则匹配

例如:

    "host": "^1\\.1\\.1\\.1$"
    "host": "test\\.com"
    "host": "^.*\\.com$"
    "host": "www.baidu.com"

###port
syntax: "port": number

default: 80

context: twaf_access_rule

number类型,端口号

###path
syntax: "path": "regex"

default: none

context: twaf_access_rule

string类型,路径,正则匹配

例如:

    "path": "/"
    "path": "/images"
    "path": "/[a|b]test"

###server_ssl
syntax: "server_ssl": true|false

default: false

context: twaf_access_rule

boolean类型,OpenWAF向后端服务器连接的ssl开关

例如:

    upstream test {
        server 1.1.1.1;
    }

    http {
        server {
            listen 80;
            server_name _;

            location / {
                #server_ssl为true,相当于proxy_pass后为https
                proxy_pass https://test;
                #server_ssl为false,相当于proxy_pass后为http
                #proxy_pass http://test;
            }
        }
    }

###forward
syntax: "forward": "upstream_uuid"

default: none

context: twaf_access_rule

string类型,forward表示后端服务器的uuid,即upstream的名称

    #如:forward值为test
    upstream test {
        server 1.1.1.1;
    }

###forward_addr
syntax: "forward_addr": "ip"

default: none

context: twaf_access_rule

string类型,forward_addr表示后端服务器的ip地址(TODO:支持域名)

    upstream test {
        #如:forward_addr值为1.1.1.1
        server 1.1.1.1;
    }

###forward_port
syntax: "forward_port": port

default: 80

context: twaf_access_rule

number类型,forward_port表示后端服务器端口号,默认80

    upstream test {
        #如:forward_port值为50001
        server 1.1.1.1:50001;
    }

###uuid
syntax: "uuid": "string"

default: none

context: twaf_access_rule

string类型,接入规则的唯一标识

###policy
syntax: "policy": "policy_uuid"

default: none

context: twaf_access_rule

string类型,满足此接入规则的请求,所使用安全策略的uuid

Back to twaf_access_rule

Back to TOC

twaf_anti_hotlink

{
    "twaf_anti_hotlink":{
        "state":false,
        "log_state":true,
        "event_id":"110001",
        "event_severity":"medium",
        "ct_state":false,
        "action_meta":403,
        "action":"DENY",
        "mode":"referer",
        "allow_noreferer":true,
        "cookie_name":"TWAF_AH",
        "uri_ext":["javascript", "css", "html", ""]
    }
}

###state
syntax: "state": true|false|"$dynamic_state"

default: false

context: twaf_anti_hotlink

###log_state
syntax: "log_state": true|false|"$dynamic_state"

default: true

context: twaf_anti_hotlink

###ct_state
syntax: "ct_state": true|false|"$dynamic_state"

default: false

context: twaf_anti_hotlink

###event_id
syntax: "event_id": "string"

default: "110001"

context: twaf_anti_hotlink

###event_severity
syntax: "event_severity": "string"

default: "medium"

context: twaf_anti_hotlink

###action
syntax: "action": "string"

default: "DENY"

context: twaf_anti_hotlink

###action_meta
syntax: "action_meta": "string"|number

default: 403

context: twaf_anti_hotlink

###mode
syntax: "mode": "string"

default: "referer"

context: twaf_anti_hotlink

###allow_noreferer
syntax: "allow_noreferer": true|false

default: true

context: twaf_anti_hotlink

###cookie_name
syntax: "cookie_name": "string"

default: TWAF_AH

context: twaf_anti_hotlink

cookie_name表示盗链模块发送COOKIE的名称,默认"TWAF_AH"

此配置只有mode为cookie模式下生效

###uri_ext
syntax: "uri_ext": array|exten|"all"

default: none

context: twaf_anti_hotlink

uri_ext表示对哪些资源进行盗链防护

     #对html类型资源进行盗链防护
     "uri_ext": "html"

     #对未知类型资源进行盗链防护,nginx无法解析出资源类型时为空字符串
     "uri_ext": ""

     #对html、css及未知类型资源进行盗链防护
     "uri_ext": ["html", "css", ""]

     #对所有资源进行盗链防护
     "uri_ext": "all"

Back to twaf_anti_hotlink

Back to TOC

twaf_anti_mal_crawler

{
    "state":false,
    "cookie_state":true,
    "log_state":true,
    "event_id":"710001",
    "event_severity":"high",
    "force_scan_robots_state":false,
    "shared_dict_key":["remote_addr", "http_user_agent"],
    "timeout":300,
    "crawler_cookie_name":"crawler",
    "mal_cookie_name":"mcrawler",
    "trap_uri":"/abc/abc.html",
    "trap_args":"id=1",
    "action":"DENY",
    "action_meta":403
}

###state
syntax: state true|false|$dynamic_state

default: false

context: twaf_anti_mal_crawler

模块开关,默认false(关闭),支持动态开关

Back to MCD

###cookie_state
syntax: cookie_state true|false|$dynamic_state

default: true

context: twaf_anti_mal_crawler

是否发送cookie,默认true(发送),支持动态开关

Back to MCD

###log_state
syntax: log_state true|false|$dynamic_state

default: true

context: twaf_anti_mal_crawler

安全日志开关, 默认true(记录),支持动态开关

Back to MCD

###event_id
syntax: event_id <string>

default: "710001"

context: twaf_anti_mal_crawler

记录安全日志时,显示的事件ID

Back to MCD

###event_severity
syntax: event_severity critical|high|medium|low

default: high

context: twaf_anti_mal_crawler

记录安全日志时,显示的事件等级

Back to twaf_anti_mal_crawler

Back to TOC

twaf_reqstat

    "twaf_reqstat": {
        "state":true,
        "safe_state":true,
        "access_state":true,
        "upstream_state":true,
        "shared_dict_name":"twaf_reqshm"
    }

###state
syntax: state true|false|$dynamic_state

default: true

context: twaf_reqstat

统计模块开关,支持动态开关,默认开启

###access_state
syntax: access_state true|false|$dynamic_state

default: true

context: twaf_reqstat

访问信息统计开关,支持动态开关,默认开启

###safe_state
syntax: safe_state true|false|$dynamic_state

default: true

context: twaf_reqstat

安全信息统计开关,支持动态开关,默认开启

###upstream_state
syntax: upstream_state true|false|$dynamic_state

default: true

context: twaf_reqstat

转发信息统计开关,支持动态开关,默认开启

###shared_dict_name
syntax: shared_dict_name string

default: openwaf_reqshm

context: twaf_reqstat

指定shared_dict名称,在这之前需在nginx配置文件中配置lua_shared_dict <name> <size>

默认shared_dict名称为openwaf_reqshm

Back to twaf_reqstat

Back to TOC

twaf_log

"twaf_log": {
        "access_log_state":false,     -- 访问日志开关
        "security_log_state":true,    -- 安全日志开关
        "sock_type":"udp",            -- 支持tcp和udp两种协议
        "content_type":"JSON",        -- 支持JSON和INFLUXDB两种日志格式
        "host":"127.0.0.1",           -- 日志服务器地址
        "port":60055,                 -- 日志服务器端口号
        "flush_limit":0,              -- 缓冲,当存储的日志大于阈值才发送
        "drop_limit":1048576,
        "max_retry_times":5,          -- 最大容错次数
        "ssl":false,                  -- 是否开启ssl协议
        "access_log":{}               -- 访问日志格式
        "security_log":{}             -- 安全日志格式
}

###access_log_state
syntax: "access_log_state": true|false

default: false

context: twaf_log

访问日志开关,默认关闭

###security_log_state
syntax: "security_log_state": true|false

default: true

context: twaf_log

安全事件日志开关,默认开启

###sock_type
syntax: "sock_type": tcp|udp

default: udp

context: twaf_log

日志传输协议,默认udp

###content_type
syntax: "content_type": JSON|INFLUXDB

default: JSON

context: twaf_log

日志格式,默认JSON

###host
syntax: "host": string

default: "127.0.0.1"

context: twaf_log

日志接收服务器的ip地址

###port
syntax: "port": number

default: 60055

context: twaf_log

日志接收服务器的端口号

###flush_limit
syntax: "flush_limit": number

default: 0

context: twaf_log

缓冲区大小,当存储的日志大于阈值才发送,默认值为0,即立即发送日志

###drop_limit
syntax: "drop_limit": number

default: 1048576

context: twaf_log

###max_retry_times
syntax: "max_retry_times": number

default: 5

context: twaf_log

最大容错次数

###ssl
syntax: "ssl": true|false

default: false

context: twaf_log

是否开启ssl协议,默认false

###access_log
syntax: "access_log": table

default: false

context: twaf_log

访问日志格式

###security_log
syntax: "security_log": table

default: false

context: twaf_log

安全事件日志格式

若content_type为JSON,则日志格式为

[
    variable_key_1, 
    variable_key_2, 
    ...
]

若content_type为INFLUXDB,则日志格式为

{
    "db":MEASUREMENT名称, 
    "tags":[variable_key_1, variable_key_2, ...], 
    "fileds"[variable_key_1, variable_key_2, ...],
    "time":true|false
}

变量名称详见规则引擎模块twaf_secrules

    #日志格式举例
        #JSON格式
        "security_log": [
            "remote_addr",
            "remote_port",
            "userid",
            "dev_uuid",
            "original_dst_addr",
            "original_dst_port",
            "remote_user",
            "time_local",
            "msec",
            "request_method",
            "request_uri",
            "request_protocol",
            "status",
            "bytes_sent",
            "http_referer",
            "http_user_agent",
            "gzip_ratio",
            "http_host",
            "raw_header"
        ]

        #INFLUXDB格式
        "security_log": {
            "db":"test",                  -- MEASUREMENT名称
            "tags":[],                    -- tags keys
            "fileds":[                    -- fileds keys
                "remote_addr",
                "remote_port",
                "userid",
                "dev_uuid",
                "original_dst_addr",
                "original_dst_port",
                "remote_user",
                "time_local",
                "msec",
                "request_method",
                "request_uri",
                "request_protocol",
                "status",
                "bytes_sent",
                "http_referer",
                "http_user_agent",
                "gzip_ratio",
                "http_host",
                "raw_header"
            ],
            "time":true                   -- 日志是否携带时间戳
        }

Back to twaf_log

Back to TOC

twaf_secrules

    "twaf_secrules":{
        "state": true,                                              -- 总开关
        "reqbody_state": true,                                      -- 请求体检测开关
        "header_filter_state": true,                                -- 响应头检测开关
        "body_filter_state": true,                                  -- 响应体检测开关
        "reqbody_limit":134217728,                                  -- 请求体检测阈值,大于阈值不检测
        "respbody_limit":524288,                                    -- 响应体检测阈值,大于阈值不检测
        "pre_path": "/opt/OpenWAF/",                                -- OpenWAF安装路径
        "path": "lib/twaf/inc/knowledge_db/twrules",                -- 特征规则库在OpenWAF中的路径
        "rules_id":{                                                -- 特征排除
            "111112": [{"REMOTE_HOST":"a.com", "URI":"^/ab"}]       -- 匹配中数组中信息则对应规则失效,数组中key为变量名称,值支持正则
            "111113": {}                                            -- 特征未被排除
            "111114": [{}]                                          -- 特征被无条件排除
        }
    }

###state
syntax: state true|false

default: true

context: twaf_secrules

规则引擎总开关

###reqbody_state
syntax: reqbody_state true|false

default: true

context: twaf_secrules

请求体检测开关

###header_filter_state
syntax: header_filter_state true|false

default: true

context: twaf_secrules

响应头检测开关

###body_filter_state
syntax: body_filter_state true|false

default: false

context: twaf_secrules

响应体检测开关,默认关闭,若开启需添加第三方模块[ngx_http_twaf_header_sent_filter_module暂未开源]

###reqbody_limit
syntax: reqbody_limit number

default: 134217728

context: twaf_secrules

请求体检测大小上限,默认134217728B(128MB),若请求体超过设置上限,则不检测

PS:reqbody_limit值要小于nginx中client_body_buffer_size的值才会生效

###respbody_limit
syntax: respbody_limit number

default: 134217728

context: twaf_secrules

响应体检测大小上限,默认134217728B(128MB),若响应体大小超过设置上限,则不检测

###pre_path
syntax: pre_path string

default: /opt/OpenWAF/

context: twaf_secrules

OpenWAF的安装路径

###path
syntax: path string

default: lib/twaf/inc/knowledge_db/twrules

context: twaf_secrules

特征规则库在OpenWAF中的路径

###rules_id
syntax: rules_id table

default: none

context: twaf_secrules

用于排除特征

Back to twaf_secrules

Back to TOC

Nginx Variables

###$twaf_https
syntax: set $twaf_https 0|1

default: 0

context: server

用于标记请求是否通过ssl加密

"set $twaf_https 1",则表示请求通过ssl加密

"set $twaf_https 1",则表示请求未通过ssl加密

server {
    listen 443 ssl;
    set $twaf_https 1;
    ...
}

server {
    listen 80;
    set $twaf_https 0;
    ...
}

###$twaf_upstream_server
syntax: set $twaf_upstream_server ""

default: none

context: server

用于指定后端服务器地址,只需初始化为空字符串即可,其值由"server_ssl"和"forward"确定

upstream server_1 {
    ...
}

upstream server_2 {
    ...
}

server {
    ...

    set $twaf_upstream_server "";
    location / {
        ...
        proxy_pass $twaf_upstream_server;
    }
}

若"server_ssl"值为true, "forward"值为"server_1"
等价于proxy_pass https://server_1;

若"server_ssl"值为false, "forward"值为"server_2"
等价于proxy_pass http://server_2;

Back to TOC

SecRules

Variables

Back to Var

Back to TOC

##ARGS

table类型,所有的请求参数,包含ARGS_GET和ARGS_POST

例如:POST http://www.baidu.com?name=miracle&age=5

请求体为:time=123456&day=365

ARGS变量值为{"name": "miracle", "age": "5", "time": "123456", "day": "365"}

Back to Var

Back to TOC

##ARGS_COMBINED_SIZE

number类型,请求参数总长度,只包含key和value的长度,不包含'&'或'='等符号

例如:GET http://www.baidu.com?name=miracle&age=5

ARGS_COMBINED_SIZE变量值为15,而不是18

Back to Var

Back to TOC

##ARGS_GET

table类型,querystring参数

例如:GET http://www.baidu.com?name=miracle&age=5

ARGS_GET变量值为{"name": "miracle", "age": "5"}

Back to Var

Back to TOC

##ARGS_GET_NAMES

table类型,querystring参数key值

例如:GET http://www.baidu.com?name=miracle&age=5

ARGS_GET_NAMES变量值为["name", "age"]

Back to Var

Back to TOC

##ARGS_NAMES

table类型,querystring参数key值及post参数key值

例如:POST http://www.baidu.com?name=miracle&age=5

请求体为:time=123456&day=365

ARGS_NAMES变量值为["name", "age", "time", "day"]

Back to Var

Back to TOC

##ARGS_POST

table类型,POST参数

例如:

POST http://www.baidu.com/login.html

请求体为:time=123456&day=365

ARGS_POST变量值为{"time": "123456", "day": "365"}

Back to Var

Back to TOC

##ARGS_POST_NAMES

table类型,POST参数key值

例如:

POST http://www.baidu.com/login.html

请求体为:time=123456&day=365

ARGS_POST_NAMES变量值为["time", "day"]

Back to Var

Back to TOC

##BYTES_IN

number类型,接收信息字节数

Back to Var

Back to TOC

##CONNECTION_REQUESTS

number类型,当前连接中的请求数

Back to Var

Back to TOC

##DURATION

string类型,处理事务用时时间,单位:微秒(μs)

Back to Var

Back to TOC

##FILES

table类型,从请求体中得到的原始文件名(带有文件后缀名)

Back to Var

Back to TOC

##FILES_NAMES

table类型,上传文件名称(不带有后缀名)

Back to Var

Back to TOC

##GEO

table类型,包含code3,code,id,continent,name等字段信息

Back to Var

Back to TOC

##GEO_CODE3

string类型,3个字母长度的国家缩写

Back to Var

Back to TOC

##GEO_CODE

string类型,2个字母长度的国家缩写

Back to Var

Back to TOC

##GEO_ID

number类型,国家ID

Back to Var

Back to TOC

##GEO_CONTINENT

string类型,国家所在大洲

Back to Var

Back to TOC

##GEO_NAME

string类型,国家全称

Back to Var

Back to TOC

##GZIP_RATIO

string类型,压缩比率

Back to Var

Back to TOC

##HTTP_COOKIE

string类型,请求头中的cookie字段

Back to Var

Back to TOC

##HTTP_HOST

string类型,请求头中的host字段值,既域名:端口(80缺省)

Back to Var

Back to TOC

##HTTP_REFERER

string类型,请求头中的referer字段

Back to Var

Back to TOC

##HTTP_USER_AGENT

string类型,请求头中的user-agent字段

Back to Var

Back to TOC

##IP_VERSION

string类型,IPv4 or IPv6

Back to Var

Back to TOC

##MATCHED_VAR

类型不定,当前匹配中的变量

Back to Var

Back to TOC

##MATCHED_VARS

table类型,单条规则匹配中的所有变量

Back to Var

Back to TOC

##MATCHED_VAR_NAME

string类型,当前匹配中的变量名称

Back to Var

Back to TOC

##MATCHED_VARS_NAMES

table类型,单条规则匹配中的所有变量名称

Back to Var

Back to TOC

##ORIGINAL_DST_ADDR

string类型,服务器地址,应用代理模式为WAF地址,透明模式为后端服务器地址

Back to Var

Back to TOC

##ORIGINAL_DST_PORT

string类型,服务器端口号,应用代理模式为WAF端口号,透明模式为后端服务器端口号

Back to Var

Back to TOC

##POLICYID

string类型,策略ID

Back to Var

Back to TOC

##QUERY_STRING

string类型,未解码的请求参数

Back to Var

Back to TOC

##RAW_HEADER

string类型,请求头信息,带请求行

Back to Var

Back to TOC

##RAW_HEADER_TRUE

string类型,请求头信息,不带请求行

Back to Var

Back to TOC

##REMOTE_ADDR

string类型,客户端地址

Back to Var

Back to TOC

##REMOTE_HOST

string类型,域名

Back to Var

Back to TOC

##REMOTE_PORT

number类型,端口号

Back to Var

Back to TOC

##REMOTE_USER

string类型,用于身份验证的用户名

Back to Var

Back to TOC

##REQUEST_BASENAME

string类型,请求的文件名

例如: GET http://www.baidu.com/test/login.php

REQUEST_BASENAME值为/login.php

Back to Var

Back to TOC

##REQUEST_BODY

类型不定,请求体

Back to Var

Back to TOC

##REQUEST_COOKIES

table类型,请求携带的cookie

Back to Var

Back to TOC

##REQUEST_COOKIES_NAMES

table类型,请求携带cookie的名称

Back to Var

Back to TOC

##REQUEST_FILENAME

string类型,relative request URL(相对请求路径)

例如: GET http://www.baidu.com/test/login.php

REQUEST_FILENAME值为/test/login.php

Back to Var

Back to TOC

##REQUEST_HEADERS

table类型,请求头信息

Back to Var

Back to TOC

##REQUEST_HEADERS_NAMES

table类型,请求头key值

Back to Var

Back to TOC

##REQUEST_LINE

string类型,请求行

Back to Var

Back to TOC

##REQUEST_METHOD

string类型,请求方法

Back to Var

Back to TOC

##REQUEST_PROTOCOL

string类型,http请求协议,如: HTTP/1.1

Back to Var

Back to TOC

##HTTP_VERSION

string类型,http请求协议版本,如: 1.1

Back to Var

Back to TOC

##URI

string类型,请求路径,既不带域名,也不带参数

例如: GET http://www.baid.com/test/login.php?name=miracle

URI变量值为/test/login.php

Back to Var

Back to TOC

##URL

string类型,统一资源定位符,SCHEME与HTTP_HOST与URI的拼接

例如: GET http://www.baid.com/test/login.php?name=miracle

URL变量值为http://www.baid.com/test/login.php

Back to Var

Back to TOC

##REQUEST_URI

string类型,请求路径,带参数,但不带有域名

例如: GET http://www.baid.com/test/login.php?name=miracle

REQUEST_URI变量值为/test/login.php?name=miracle

Back to Var

Back to TOC

##RESPONSE_BODY

string类型,响应体

Back to Var

Back to TOC

##RESPONSE_HEADERS

table类型,响应头信息

Back to Var

Back to TOC

##RESPONSE_STATUS

function类型,响应状态码

Back to Var

Back to TOC

##SCHEME

string类型,http or https

例如:GET http://www.baidu.com/

SCHEME变量值为http

Back to Var

Back to TOC

##SERVER_ADDR

string类型,服务器地址

Back to Var

Back to TOC

##SERVER_NAME

string类型,服务器名称

Back to Var

Back to TOC

##SERVER_PORT

number类型,服务器端口号

Back to Var

Back to TOC

##SESSION

table类型,第三方模块lua-resty-session提供的变量

Back to Var

Back to TOC

##SESSION_DATA

table类型,session信息,第三方模块lua-resty-session提供的变量

Back to Var

Back to TOC

##TIME

string类型,hour:minute:second

Back to Var

Back to TOC

##TIME_DAY

number类型,天(1-31)

Back to Var

Back to TOC

##TIME_EPOCH

number类型,时间戳,seconds since 1970

Back to Var

Back to TOC

##TIME_HOUR

number类型,小时(0-23)

Back to Var

Back to TOC

##TIME_MIN

number类型,分钟(0-59)

Back to Var

Back to TOC

##TIME_MON

number类型,月份(1-12)

Back to Var

Back to TOC

##TIME_SEC

number类型,秒(0-59)

Back to Var

Back to TOC

##TIME_WDAY

number类型,周(0-6)

Back to Var

Back to TOC

##TIME_YEAR

number类型,年份,four-digit,例如: 1997

Back to Var

Back to TOC

##TIME_LOCAL

string类型,当前时间,例如: 26/Aug/2016:01:32:16 -0400

Back to Var

Back to TOC

##TX

table类型,用于存储当前请求信息的变量,作用域仅仅是当前请求

Back to Var

Back to TOC

##UNIQUE_ID

string类型,ID标识,随机生成的字符串,可通过配置来控制随机字符串的长度

Back to Var

Back to TOC

##UPSTREAM_CACHE_STATUS

keeps the status of accessing a response cache (0.8.3). The status can be either “MISS”, “BYPASS”, “EXPIRED”, “STALE”, “UPDATING”, “REVALIDATED”, or “HIT”.

Back to Var

Back to TOC

##USERID

string类型,从接入规则配置得到的用于ID标识

Back to Var

Back to TOC

Transformation Functions

Back to TFF

Back to TOC

##base64_decode

Decodes a Base64-encoded string.

Note: 注意transform的执行顺序

例如:
{
   "id": "xxxx",
   ...
   "transform": ["base64_decode", "lowercase"],
   ...
}

先执行base64解码,然后字符串最小化,若顺序调换,会影响结果

Back to TFF

Back to TOC

##sql_hex_decode

Decode sql hex data.

Back to TFF

Back to TOC

##base64_encode

Encodes input string using Base64 encoding.

Back to TFF

Back to TOC

##counter

计数,相当于modsecurity中的'&'符号

Back to TFF

Back to TOC

##compress_whitespace

Converts any of the whitespace characters (0x20, \f, \t, \n, \r, \v, 0xa0) to spaces (ASCII 0x20), compressing multiple consecutive space characters into one.

Back to TFF

Back to TOC

##hex_decode

Decodes a string that has been encoded using the same algorithm as the one used in hexEncode

Back to TFF

Back to TOC

##hex_encode

Encodes string (possibly containing binary characters) by replacing each input byte with two hexadecimal characters.

Back to TFF

Back to TOC

##html_decode

Decodes the characters encoded as HTML entities.

Back to TFF

Back to TOC

##length

Looks up the length of the input string in bytes

Back to TFF

Back to TOC

##lowercase

Converts all characters to lowercase

Back to TFF

Back to TOC

##md5

Calculates an MD5 hash from the data in input. The computed hash is in a raw binary form and may need encoded into text to be printed (or logged). Hash functions are commonly used in combination with hex_encode (for example: "transform": ["md5", "hex_encode").

Back to TFF

Back to TOC

##normalise_path

Removes multiple slashes, directory self-references, and directory back-references (except when at the beginning of the input) from input string.

Back to TFF

Back to TOC

##remove_nulls

Removes all NUL bytes from input

Back to TFF

Back to TOC

##remove_whitespace

Removes all whitespace characters from input.

移除空白字符\s,包含水平定位字符 ('\t')、归位键('\r')、换行('\n')、垂直定位字符('\v')或翻页('\f')等

Back to TFF

Back to TOC

##replace_comments

用一个空格代替/.../注释内容

Back to TFF

Back to TOC

##remove_comments_char

Removes common comments chars (/, /, --, #).

Back to TFF

Back to TOC

##remove_comments

去掉/.../注释内容

Back to TFF

Back to TOC

##uri_decode

Unescape str as an escaped URI component.

例如: 
"b%20r56+7" 使用uri_decode转换后为 b r56 7

Back to TFF

Back to TOC

##uri_encode

Escape str as a URI component.

Back to TFF

Back to TOC

##sha1

Calculates a SHA1 hash from the input string. The computed hash is in a raw binary form and may need encoded into text to be printed (or logged). Hash functions are commonly used in combination with hex_encode (for example, "transform": ["sha1", "hex_encode"]).

Back to TFF

Back to TOC

##trim_left

Removes whitespace from the left side of the input string.

Back to TFF

Back to TOC

##trim_right

Removes whitespace from the right side of the input string.

Back to TFF

Back to TOC

##trim

Removes whitespace from both the left and right sides of the input string.

Back to TFF

Back to TOC

Operators

Back to OPERATORS

Back to TOC

##begins_with

Returns true if the parameter string is found at the beginning of the input.

Back to OPERATORS

Back to TOC

##contains

Returns true if the parameter string is found anywhere in the input.

operator为contains且pattern为数组,相当于modsecurity的pm

PS: modsecurity的pm忽略大小写,OpenWAF中contains不忽略大小写

例如:
{
    "id": "xxx",
    ...
    "operator": "contains",
    "pattern": ["abc", "def"],
    ...
}

Back to OPERATORS

Back to TOC

##contains_word

Returns true if the parameter string (with word boundaries) is found anywhere in the input.

Back to OPERATORS

Back to TOC

##detect_sqli

This operator uses LibInjection to detect SQLi attacks.

Back to OPERATORS

Back to TOC

##detect_xss

This operator uses LibInjection to detect XSS attacks.

Back to OPERATORS

Back to TOC

##ends_with

Returns true if the parameter string is found at the end of the input.

Back to OPERATORS

Back to TOC

##equal

Performs a string comparison and returns true if the parameter string is identical to the input string.

相当于modsecurity的eq和streq

例如:
{
    "id": "xxx",
    ...
    "operator": "equal",
    "pattern": [12345, "html", "23456"]
    ...
}

Back to OPERATORS

Back to TOC

##greater_eq

Performs numerical comparison and returns true if the input value is greater than or equal to the provided parameter.

return false, if a value is provided that cannot be converted to a number.

Back to OPERATORS

Back to TOC

##greater

Performs numerical comparison and returns true if the input value is greater than the operator parameter.

return false, if a value is provided that cannot be converted to a number.

Back to OPERATORS

Back to TOC

##ip_utils

Performs a fast ipv4 or ipv6 match of REMOTE_ADDR variable data. Can handle the following formats:

Full IPv4 Address: 192.168.1.100
Network Block/CIDR Address: 192.168.1.0/24
IPv4 Address Region: 1.1.1.1-2.2.2.2

ip_utils与pf的组合相当于modsecurity中的ipMatchF和ipMatchFromFile

例如:
规则如下:
{
    "id": "xxxx",
    ...
    "operator": "ip_utils",
    "pf": "/tmp/ip_blacklist.txt",
    ...
}
"/tmp/ip_blacklist.txt"文件内容如下:
192.168.1.100
192.168.1.0/24
1.1.1.1-2.2.2.2

Back to OPERATORS

Back to TOC

##less_eq

Performs numerical comparison and returns true if the input value is less than or equal to the operator parameter.

return false, if a value is provided that cannot be converted to a number.

Back to OPERATORS

Back to TOC

##less

Performs numerical comparison and returns true if the input value is less than to the operator parameter.

return false, if a value is provided that cannot be converted to a number.

Back to OPERATORS

Back to TOC

##pf

pattern是operator操作的参数

pf是指pattern from file,与pattern互斥(二者不可同时出现),目前仅支持绝对路径

pf与contains组合,相当于modsecurity的pmf或pmFromFile

pf与ip_utils组合,相当于modsecurity的ipMatchF或ipMatchFromFile

Back to OPERATORS

Back to TOC

##regex

Performs a regular expression match of the pattern provided as parameter.

regex还有modecurity的capture捕获功能

modsecurity有关capture的描述如下:
When used together with the regular expression operator (@rx), the capture action will create copies of the regular expression captures and place them into the transaction variable collection.

OpenWAF中无capture指令,但使用regex默认开启capture功能

例如:
{
    "id": "000031",
    "release_version": "858",
    "charactor_version": "001",
    "opts": {
        "nolog": false
    },
    "phase": "access",
    "action": "deny",
    "meta": 403,
    "severity": "low",
    "rule_name": "protocol.reqHeader.c",
    "desc": "协议规范性约束,检测含有不合规Range或Request-Range值的HTTP请求",
    "match": [
        {
            "vars": [
                {
                    "var": "REQUEST_HEADERS",
                    "parse": {
                        "specific": "Range"
                    }
                },
                {
                    "var": "REQUEST_HEADERS",
                    "parse": {
                        "specific": "Request-Range"
                    }
                }
            ],
            "operator": "regex",
            "pattern": "(\\d+)\\-(\\d+)\\,"
        },
        {
            "vars": [{
                "var": "TX",
                "parse": {
                    "specific": "2"
                }
            }],
            "operator": "greater_eq",
            "pattern": "%{TX.1}",
            "parse_pattern": true,
            "op_negated": true
        }
    ]
}

Back to OPERATORS

Back to TOC

##str_match

等同于contains

Back to OPERATORS

Back to TOC

##validate_url_encoding

Validates the URL-encoded characters in the provided input string.

Back to OPERATORS

Back to TOC

##num_range

判断是否在数字范围内

它与transform的length组合,相当于modsecurity的validateByteRange

{
    "id": "xxx",
    ...
    "operator": "num_range",
    "pattern": [10, "13", "32-126"],
    "transform": "length",
    ...
}

Back to OPERATORS

Back to TOC

##str_range

判断是否在字符串范围内

例如时间区间判断:
{
    "id": "xxx",
    ...
    "operator": "str_range",
    "pattern": ["01:42:00-04:32:00"],
    ...
}

Back to OPERATORS

Back to TOC

Others

Back to OTHERS

Back to TOC

##allow

Stops rule processing of the current phase on a successful match and allows the transaction to proceed.

"action": "allow"

Back to OTHERS

Back to TOC

##deny

Stops rule processing and intercepts transaction.

"action": "deny",
"meta": 403

Back to OTHERS

Back to TOC

##id

Stops rule processing and intercepts transaction.

"id": "xxxxxxx"

Back to OTHERS

Back to TOC

##nolog

不记录日志

"opts": {
    "nolog": true
}

Back to OTHERS

Back to TOC

##op_negated

对operator结果的取反

"match": [{
    "vars": [{
        "var": "HTTP_USER_AGENT"
    }],
    "transform": "length",
    "operator": "less_eq",
    "pattern": 50,
    "op_negated": true
}]

等价于

"match": [{
    "vars": [{
        "var": "HTTP_USER_AGENT"
    }],
    "transform": "length",
    "operator": "greater",
    "pattern": 50
}]

若请求头中user_agent字段长度大于50,则匹配中此条规则

Back to OTHERS

Back to TOC

##parse

对变量进一步解析

若请求GET http://www.baidu.com?name=miracle&age=5

"match": [{
    "vars": [{
        "var": "ARGS_GET"
    }],
    ...
}]
得到的值为{"name": "miracle", "age": "5"}


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "specific": "name"
        }
    }]
}]
得到的值为["miracle"]


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "specific": ["name", "age"]
        }
    }]
}]
得到的值为["miracle", "5"]


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "ignore": "name"
        }
    }]
}]
得到的值为{"age": "5"}


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "ignore": ["name", "age"]
        }
    }]
}]
得到的值为[]


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "keys": true
        }
    }]
}]
得到的值为["name", "age"]


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "values": true
        }
    }]
}]
得到的值为["miracle", "5"]


"match": [{
    "vars": [{
        "var": "ARGS_GET",
        "parse": {
            "all": true
        }
    }]
}]
得到的值为["name", "age", "miracle", "5"]

Back to OTHERS

Back to TOC

##pass

Continues processing with the next rule in spite of a successful match.

"action": "pass"

Back to OTHERS

Back to TOC

##phase

规则执行的阶段,取值可为"access","header_filter","body_filter"的组合

{
    "id": "xxx_01",
    "phase": "access",
    ...
}
"xxx_01"规则在access阶段执行

{
    "id": "xxx_02",
    "phase": ["access", "header_filter"],
    ...
}
"xxx_02规则在access阶段和"header_filter"阶段各执行一次

Back to OTHERS

Back to TOC

##proxy_cache

{
    ...
    phase = "header_filter",         -- 缓存开关需在header_filter阶段配置
    action = "pass",                 -- 无需拦截请求
    opts = {
        nolog = true,                -- 不需记录日志
        proxy_cache = {
            state = true|false,      -- 缓存开关
            expired = 600            -- 缓存时长(单位秒),默认600秒
        }
    }
    ...
}

若state为true,且得到的缓存状态为"MISS"或"EXPIRED",则对响应内容进行缓存,同时设置缓存时长
若state为false,则清除对应缓存键的缓存(包含其缓存文件)

举例如下:

# nginx.conf 有关proxy cache 配置如下
http {
    proxy_cache_path  /opt/cache/OpenWAF-proxy levels=2:2 keys_zone=twaf_cache:101m max_size=100m use_temp_path=off;
    proxy_cache_key $host$uri;
    proxy_cache twaf_cache;
    proxy_ignore_headers X-Accel-Expires Cache-Control Set-Cookie;
    proxy_no_cache $twaf_cache_flag;

    server {
        set $twaf_cache_flag 1;         #默认不缓存
    }
}

# lua 格式 配置
{ 
    id = "test_x01",                      -- id 全局唯一
    opts = {
        nolog = true,
        proxy_cache = {
            state = true,
            expired = 300
        }
    },
    phase = "header_filter", 
    action = "pass",
    match = {{
        vars = {{
            var = "URI"
        },{
            var = "REQUEST_HEADERS",
            parse = {
                specific = "Referer"
            }
        }},
        operator = "equal",
        pattern = {"/xampp/", "%{SCHEME}://%{HTTP_HOST}/xampp/"},
        parse_pattern = true
    }}
}
此规则将缓存URI为'/xampp/'的页面,更新时间为300秒

若match中过滤条件为响应码,则相当于Nginx的proxy_cache_valid指令
若match中过滤条件为请求方法,则相当于Nginx的proxy_cache_methods指令
若macth中过滤条件为资源类型,则相当于Nginx的proxy_cache_content_type指令

PS: proxy_cache_content_type指令为官方指令,是miracle Qi修改Nginx源码扩展的功能

Back to OTHERS

Back to TOC

##redirect

"action": "redirect",
"meta": "/index.html"

Back to OTHERS

Back to TOC

##charactor_version

指定此条规则的版本,同modsecurity中Action的rev功能

"charactor_version": "001"

Back to OTHERS

Back to TOC

##severity

Assigns severity to the rule in which it is used.

The data below is used by the OWASP ModSecurity Core Rule Set (CRS):

EMERGENCY: is generated from correlation of anomaly scoring data where there is an inbound attack and an outbound leakage.
ALERT: is generated from correlation where there is an inbound attack and an outbound application level error.
CRITICAL: Anomaly Score of 5. Is the highest severity level possible without correlation. It is normally generated by the web attack rules (40 level files).
ERROR: Error - Anomaly Score of 4. Is generated mostly from outbound leakage rules (50 level files).
WARNING: Anomaly Score of 3. Is generated by malicious client rules (35 level files).
NOTICE: Anomaly Score of 2. Is generated by the Protocol policy and anomaly files.
INFO
DEBUG

也可自定义严重等级,如:low,medium,high,critical等

"severity": "high"

Back to OTHERS

Back to TOC

##setvar

Creates, removes, or updates a variable.

{
    "id": "xxx_01",
    "opts":{
        "nolog": false,
        "setvar": [{
            "column": "TX",
            "key": "score",
            "value": 5,
            "incr": true
        }]
    },
    ...
}
"xxx_01"规则中,给变量TX中score成员的值加5,若TX中无score成员,则初始化为0,再加5

{
    "id": "xxx_02",
    "opts":{
        "nolog": false,
        "setvar": [{
            "column": "TX",
            "key": "score",
            "value": 5
        }]
    },
    ...
}

"xxx_02"规则中,给变量TX中score成员的值赋为5

Back to OTHERS

Back to TOC

##meta

"action"的附属信息

若"action"为"deny",则"meta"为响应码
"action": "deny",
"meta": 403

若"action"为"redirect",则"meta"为重定向地址
"action": "redirect",
"meta": "/index.html"

Back to OTHERS

Back to TOC

##transform

This action is used to specify the transformation pipeline to use to transform the value of each variable used in the rule before matching.

Back to OTHERS

Back to TOC

##tag

Assigns a tag (category) to a rule.

支持数组    "tag": ["xxx_1", "xxx_2"]
支持字符串  "tag": "xxx_3"

Back to OTHERS

Back to TOC

##release_version

规则集版本,等同于modsecurity中Action的ver功能

"release_version": "858"

Back to OTHERS

Back to TOC

##robot

人机识别

需提前配置人机识别模块配置,此功能暂未放开

"action": "robot"

Back to OTHERS

Back to TOC

##add_resp_headers

增删改响应头

例如隐藏server字段:
"opts": {
    "add"_resp_headers": {
        "server": ""
    }
}

Back to OTHERS

Back to TOC

Docker Pull Command
Owner
openwaf
Source Repository

Comments (0)