OpenWAFダウンロードOpenWAFソースコードのダウンロード

名前

OpenWaf

最初のオールラウンドのオープンソースWebセキュリティ保護システムは、他のものよりも保護されています。

名前
バージョン
概要
説明
インストール
コミュニティ
- 英語のメーリングリスト
- 中国のメーリングリスト
- 個人QQメール
バグとパッチ
トト
変更
著作権とライセンス
モジュール構成ディレクティブ
nginx変数
Secrules
- 変数
- 変換関数
- オペレーター
- その他
寄付

バージョン

このドキュメントでは、2021年3月8日にリリースされたOpenWAF v1.1について説明しています。

DockerfileとDockerの画像は、2021年3月8日にバージョン1.1にアップグレードされました。

概要

    #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

TOCに戻ります

説明

OpenWAFは、HTTP要求情報のNGINX_LUA API分析に基づいた、最初の完全なオープンソースWebアプリケーション保護システム（WAF）です。 OpenWAFは、行動分析エンジンとルールエンジンの2つの機能エンジンで構成されています。ルールエンジンは主に個々のリクエストを分析し、動作分析エンジンは主にリクエスト情報の追跡に責任があります。
ModSecurityとFreeWaf（Lua-Resty-Waf）に触発されたルールエンジンは、LUAを使用して実装されます。ルールエンジンは、プロトコル仕様、自動ツール、噴射攻撃、クロスサイト攻撃、情報リーク、その他のセキュリティ例外要求に基づいて、動的ルールのサポート、タイムリーな修理脆弱性に基づいています。
周波数、アンチマルウェアクローラー、ヒューマンコンピューター識別抗検出モジュール、アンチCSRF、アンチCC、攻撃ファイルアップロードモジュール、クッキータフトチェーン、カスタムヘッダー、攻撃対応対応情報開示の証明モジュールへの保護に基づくファジー識別を含む行動分析エンジン。
2つのエンジンに加えて、統計、ログ、攻撃応答ページ、アクセスルール、その他の基本モジュールも含まれます。既存の機能モジュールに加えて、OpenWAFは、構成の動的な変更、サードパーティモジュールの動的な追加もサポートしているため、停止条件の下でエンジンが再起動しないように、保護をアップグレードします。
OpenWAFは、上記の機能を、さまざまな戦略を保護するためのさまざまなWebアプリケーションアプリケーションの戦略としてサポートしています。将来はクラウドプラットフォームを構築し、戦略は他の人のために共有することもできます。

基本モジュール：

openwaf_conf
openwaf_log
openwaf_reqstat
openwaf_core
openwaf_access_rule

安全なモジュール：

openwaf_rule_engine
openwaf_attack_response
openwaf_api
openwaf_anti_mal_crawler
openwaf_anti_cc

詳細な構成ドキュメントと例は、上記のモジュールのドキュメントを参照してください

TOCに戻ります

インストール

openwaf安装文档

TOCに戻ります

コミュニティ

英語のメーリングリスト

OpenWaf-enメーリングリストは、英語の話者向けです。

中国のメーリングリスト

OpenWAF-CNメーリングリストは、中国のスピーカー向けです。

個人QQメール

[email protected]

QQグループ

579790127

TOCに戻ります

バグとパッチ

バグレポート、ウィッシュリスト、またはパッチを提出してください

GitHub Issueトラッカーにチケットを作成し、
またはOpenWafコミュニティに投稿します。

TOCに戻ります

トト

Access_ruleモジュールの動的スイッチを追加します
SSOの接続をサポートします
ダイナミックトークン
Apisg（APIセキュリティゲートウェイ）
模擬

TOCに戻ります

変更

Changelog

TOCに戻ります

著作権とライセンス

このモジュールは、BSDライセンスの下でライセンスされています。

変更とバイナリ形式での再配布と使用は、変更を伴うまたは伴わない場合、次の条件が満たされている場合が許可されています。

ソースコードの再配布は、上記の著作権通知、この条件リスト、および次の免責事項を保持する必要があります。
バイナリ形式の再配布は、上記の著作権通知、この条件リスト、および分布に提供されたドキュメントおよび/またはその他の資料の次の免責事項を再現する必要があります。

このソフトウェアは、著作権所有者と貢献者によって「現状のまま」、および商品性と特定の目的に対する適合性の暗黙の保証を含むがこれらに限定されない明示的または黙示的な保証が否認されます。いかなる場合でも、著作権所有者または貢献者は、直接的、間接的、偶発的、特別な、例示的、または結果的な損害賠償（代替品またはサービスの調達を含むがこれらに限定されない）に対して責任を負いません。そのような損害の可能性の。

TOCに戻ります

モジュール構成ディレクティブ

twaf_access_rule
twaf_anti_hotlink
twaf_anti_mal_crawler
TWAF_REQSTAT
twaf_log
twaf_secrules
twaf_anti_cc

TOCに戻ります

twaf_access_rule

{
    "twaf_access_rule": {
        "rules": [                                 -- 注意先后顺序
            {                                      
                "user": "user_id",                 -- 用户名ID，非必填，默认值"-"
                "ngx_ssl": false,                  -- nginx认证的开关，非必填，默认值false
                "ngx_ssl_cert": "path",            -- nginx认证所需PEM证书地址
                "ngx_ssl_key": "path",             -- nginx认证所需PEM私钥地址
                "host": " ^ 1\.1\.1\.1 $ ",         -- 域名，支持正则匹配，支持字符串或数组，同时支持IPv4/IPv6
                "port": 80,                        -- 端口号。支持number或数组类型，非必填，默认值80或443
                "path": "/",                      -- 路径，支持正则匹配，非必填，默认值"/"
                "url_case_sensitive": false,       -- 路径区分大小写，boolean类型，非必填，默认值 false
                "server_ssl": false,               -- 后端服务器ssl开关，boolean类型，非必填，默认值 false
                "forward": "server_5",             -- 后端服务器upstream名称，string类型
                "forward_addr": "1.1.1.2",         -- 后端服务器ip地址，string类型
                "forward_port": "8080",            -- 后端服务器端口号，非必填，默认值80或443
                "uuid": "access_567b067ff2060",    -- 用来标记此规则的uuid，非必填，默认16位随机字符串
                "policy": "policy_uuid"            -- 安全策略ID，string类型，非必填，默认值twaf_default_conf
            }
        ]
    }
}

ルール

構文： 「ルール」：テーブル

デフォルト：なし

コンテキスト： twaf_access_rule

表类型、接入规则、顺序匹配

ユーザー

構文： 「ユーザー」：文字列

デフォルト： -

コンテキスト： twaf_access_rule：ルール

文字列类型。用户名ID。对应变量％{userid}。

非必填、默认值 " - "。

NGX_SSL

構文： "ngx_ssl"：true | false

デフォルト： false

コンテキスト： twaf_access_rule：ルール

boolean类型、服务器端（nginx）认证开关、可与client_ssl组成双向认证

非必填、默认值false

NGX_SSL_CERT

構文： "NGX_SSL_CERT"：「パス」

デフォルト：なし

コンテキスト： twaf_access_rule：ルール

文字列类型、服务器端（nginx）认证所需ペム证书地址、目前仅支持绝对地址

ngx_ssl_key

構文： "ngx_ssl_key"： "path"

デフォルト：なし

コンテキスト： twaf_access_rule：ルール

文字列类型、服务器端（nginx）认证所需ペム私钥地址、目前仅支持绝对地址

ホスト

構文： 「ホスト」：「IP |ドメイン名REGEX」

デフォルト：なし

コンテキスト： twaf_access_rule：ルール

文字列或数组类型。发布域名。（从v1.0.0β版本开始支持数组）

支持正则表达式（匹配时、自动忽略大小写）。

同时支持IPv4/IPv6

例如：

    "host": "^1\.1\.1\.1$"
    "host": "test\.com"
    "host": "^.*\.com$"
    "host": "www.baidu.com"
    "host": ["www.baidu.com", "1.1.1.1", "8888::192.168.1.1"]

ポート

構文： 「ポート」：番号

デフォルト： 80 | 443

コンテキスト： twaf_access_rule：ルール

数字、端口号。（从v1.0.0β版本开始支持数组）

非必填、默认值80或443

若「ホスト」参数为数组时、 "ポート"也应为数组。例如：

    "host": ["www.baidu.com", "1.1.1.1", "8888::192.168.1.1"]
    "posrt": [80, 8088, 8099]

パス

構文： 「パス」：「regex」

デフォルト：なし

コンテキスト： twaf_access_rule：ルール

文字列类型、路径、支持正则匹配

非必填、默认值 "/"

例如：

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

url_case_sensitive

構文： 「url_case_sensitive」：「true | false」

デフォルト： false

コンテキスト： twaf_access_rule：ルール

boolean

非必填、默认值false（不区分大小写）

server_ssl

構文： "server_ssl"：true | false

デフォルト： false

コンテキスト： twaf_access_rule：ルール

Boolean类型、openwaf向后端服务器连接的SSL开关

非必填、默认值false

例如：

    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;
    	    }
    	}
    }

フォワード

構文： 「フォワード」：「upstream_uuid」

デフォルト：なし

コンテキスト： twaf_access_rule：ルール

文字列类型、前方表示后端服务器的uuid、即上流的名称

Openwaf提供的$ twaf_upstream_server变量、则 "forward"、 "forward_addr"、 "forward_port"

    #如：使用OpenWAF自带的$twaf_upstream_server变量，forward值为test
    upstream test {
        server 1.1.1.1;
    }
    
    server {
        ...
        location / {
            proxy_pass $twaf_upstream_server;
        }
    }
    
    ---------------------------------
    
    #如：未使用OpenWAF自带的$twaf_upstream_server变量，forward非必填
    server {
        ...
        location / {
            proxy_pass http://1.1.1.1;
        }
    }
    
    ---------------------------------
    
    #如：未使用OpenWAF自带的$twaf_upstream_server变量，forward非必填
    server {
        ...
        location / {
            root html;
            index index.htm;
        }
    }

Forward_addr

構文： "forward_addr"： "ip"

デフォルト：なし

コンテキスト： twaf_access_rule：ルール

文字列类型、forward_addr

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

Forward_port

構文： "forward_port"：ポート

デフォルト： 80 | 443

コンテキスト： twaf_access_rule：ルール

番号类型、Forward_port表示后端服务器端口号

非必填、默认值80或443

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

uuid

構文： "uuid"： "string"

デフォルト：ランダム（16）

コンテキスト： twaf_access_rule：ルール

文字列类型、接入规则的唯一标识

非必填、默认、16位随机字符串（从v1.0.0β版本开始默认16位随机字符串）

ポリシー

構文： 「ポリシー」：「policy_uuid」

デフォルト： TWAF_DEFAULT_CONF

コンテキスト： twaf_access_rule：ルール

文字列类型、满足此接入规则的请求、所使用安全策略的uuid

非必填、默认值twaf_default_conf

twaf_access_ruleに戻ります

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"：true | false | "$ dynamic_state"

デフォルト： false

コンテキスト： twaf_anti_hotlink

当前模块暂未开源

log_state

構文： "log_state"：true | false | "$ dynamic_state"

デフォルト： true

コンテキスト： twaf_anti_hotlink

CT_STATE

構文： "ct_state"：true | false | "$ dynamic_state"

デフォルト： false

コンテキスト： twaf_anti_hotlink

event_id

構文： "event_id"： "string"

デフォルト： 「110001」

コンテキスト： twaf_anti_hotlink

event_severity

構文： "event_severity"： "string"

デフォルト： 「中」

コンテキスト： twaf_anti_hotlink

アクション

構文： 「アクション」：「文字列」

デフォルト： 「拒否」

コンテキスト： twaf_anti_hotlink

action_meta

構文： "Action_meta"： "string" | number

デフォルト： 403

コンテキスト： twaf_anti_hotlink

モード

構文： 「モード」：「文字列」

デフォルト： 「参照者」

コンテキスト： twaf_anti_hotlink

Allow_noreferer

構文： "Allow_noreferer"：true | false

デフォルト： true

コンテキスト： twaf_anti_hotlink

cookie_name

構文： 「Cookie_Name」：「String」

デフォルト： TWAF_AH

コンテキスト： twaf_anti_hotlink

cookie_name

此配置只有モード为クッキー模式下生效

uri_ext

構文： 「uri_ext」：配列| exten | "all"

デフォルト：なし

コンテキスト： twaf_anti_hotlink

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

     #对html类型资源进行盗链防护
     "uri_ext": "html"
     
     #对未知类型资源进行盗链防护，nginx无法解析出资源类型时为空字符串
     "uri_ext": ""
     
     #对html、css及未知类型资源进行盗链防护
     "uri_ext": ["html", "css", ""]
     
     #对所有资源进行盗链防护
     "uri_ext": "all"

twaf_anti_hotlinkに戻ります

TOCに戻ります

twaf_anti_mal_crawler

{
    "state": false,                                            -- 模块开关，支持 true，false
    "log_state":true,                                          -- 日志开关

    "dict_state": false,                                       -- shared_dict 开关
    "shared_dict_name":"twaf_anti_mal_crawler",                -- shared_dict 名称,若为空，则值为 "twaf_global" 下的 "dict_name"
    "shared_dict_key": "remote_addr",                          -- shared_dict 键值
    "timeout":300,                                             -- shared_dict 保存状态有效时长（单位秒）
    "timer_flush_expired":200,                                 -- shared_dict 清除过期信息的间隔时间（单位秒）,若为空，则值为 "twaf_global" 下的 "timer_flush_expired"

    "cookie_state":true,                                       -- cookie机制开关
    "crawler_cookie_name":"TWAF_crawler",                      -- 爬虫cookie名称
    "mal_cookie_name":"TWAF_mcrawler",                         -- 恶意爬虫cookie名称

    "force_scan_robots_state":true,                            -- 页面注入诱捕路径的开关
    "force_scan_times": 3,                                     -- 注入诱捕路径的页面个数
    "trap_uri":"/abc/abc.html",                                -- 诱捕路径
    "trap_args":"id=1",                                        -- 诱捕参数

    "action":"DENY",                                           -- 执行动作，支持 "ALLOW", "DENY", "REDIRECT", "ROBOT", "RESET_CONNECTION", "PASS" 等
    "action_meta": 403                                         -- 执行动作的附属信息，若 action 为 DENY，action_meta为响应码，若 action 为 REDIRECT，action_meta 为重定向 url
}

州

構文： State True | False | $ dynamic_state

デフォルト： false

コンテキスト： twaf_anti_mal_crawler

模块开关、默认、false （关闭）、支持动态开关

MCDに戻ります

log_state

構文： log_state true | false | $ dynamic_state

デフォルト： true

コンテキスト： twaf_anti_mal_crawler

安全日志开关、默认、true （记录）、支持动态开关

MCDに戻ります

dict_state

構文： dict_state true | false

デフォルト： false

コンテキスト： twaf_anti_mal_crawler

shared_dict dict_state为true、某ip被此模块拦截、会被记录在内存中、在タイムアウト时间内访问会被拦截（且重置タイムアウト）

MCDに戻ります

shared_dict_name

構文： shared_dict_name

デフォルト： nil

コンテキスト： twaf_anti_mal_crawler

shared_dict名称。对应nginx中的配置项、不可轻易修改

若为空、则值为「Twaf_global "下的" dict_name "

MCDに戻ります

shared_dict_key

構文： shared_dict_key |

デフォルト： remote_addr

コンテキスト： twaf_anti_mal_crawler

shared_dict键值。支持数组

MCDに戻ります

タイムアウト

構文：タイムアウト

デフォルト： 300

コンテキスト： twaf_anti_mal_crawler

shared_dict 保存状态有效时长（单位秒）

MCDに戻ります

timer_flush_expired

構文：タイムアウト

デフォルト： 200

コンテキスト： twaf_anti_mal_crawler

shared_dict 清除过期信息的间隔时间（单位秒）、若为空、则值为 "twaf_global"下的 "timer_flush_expired"

MCDに戻ります

cookie_state

構文： cookie_state true | false | $ dynamic_state

デフォルト： true

コンテキスト： twaf_anti_mal_crawler

Cookie、默认true （发送）、支持动态开关

MCDに戻ります

crawler_cookie_name

構文： crawler_cookie_name

デフォルト： 「twaf_crawler」

コンテキスト： twaf_anti_mal_crawler

爬虫クッキー名称

MCDに戻ります

mal_cookie_name

構文： mal_cookie_name

デフォルト： twaf_mcrawler

コンテキスト： twaf_anti_mal_crawler

恶意爬虫クッキー名称

MCDに戻ります

force_scan_robots_state

構文： force_scan_robots_state true | false

デフォルト： true

コンテキスト： twaf_anti_mal_crawler

页面注入诱捕路径的开关

某些扫描工具不会去访问 /robots.txt、因此在他访问的页面中插入禁爬目录的暗链

MCDに戻ります

force_scan_times

構文： force_scan_times

デフォルト： 3

コンテキスト： twaf_anti_mal_crawler

注入诱捕路径的页面数

MCDに戻ります

trap_uri

構文： trap_uri

デフォルト： /abc/abc.html

コンテキスト： twaf_anti_mal_crawler

诱捕路径、访问此路径、被标识为恶意爬虫

MCDに戻ります

trap_args

構文： trap_args

デフォルト： ID = 1

コンテキスト： twaf_anti_mal_crawler

诱捕参数。携带此参数访问诱捕路径、不会标识为攻击

MCDに戻ります

twaf_anti_mal_crawlerに戻ります

TOCに戻ります

TWAF_REQSTAT

    "twaf_reqstat": {
        "state":true,                       -- 统计模块总开关
        "safe_state":true,                  -- 安全信息统计开关
        "access_state":true,                -- 访问信息统计开关
        "upstream_state":true,              -- upstream信息统计开关
        "shared_dict_name":"twaf_reqstat",  -- shm名称
        "shared_dict_key":"policy_id"       -- shm键值。依据此值进行分类统计
    }
    
    PS: 当前统计模块是全局模块，仅支持在twaf_default_conf中进行全局配置，不支持在自定义策略中进行配置

州

構文： State True | False | $ dynamic_state

デフォルト： true

コンテキスト： TWAF_REQSTAT

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

Access_State

構文： Access_State True | False | $ dynamic_state

デフォルト： true

コンテキスト： TWAF_REQSTAT

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

SAFE_STATE

構文： safe_state true | false | $ dynamic_state

デフォルト： true

コンテキスト： TWAF_REQSTAT

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

upstream_state

構文： upstream_state true | false | $ dynamic_state

デフォルト： true

コンテキスト： TWAF_REQSTAT

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

shared_dict_name

構文： shared_dict_name文字列

デフォルト： TWAF_REQSTAT

コンテキスト： TWAF_REQSTAT

指定shared_dict名称、在这之前需在nginx配置文件中配置lua_shared_dict

shared_dict_key

構文： shared_dict_key文字列

デフォルト： PolicyID

コンテキスト： TWAF_REQSTAT

文字列类型。指定shm键值。依据此值进行分类统计。

如：值设为policyid、则统计每一个策略相关的アクセス、安全和上流信息。

如：值设为ユーザーID、则统计每一个用户相关的アクセス、安全和上流

如：值设为アクセス_id、则统计每一个接入规则相关的アクセス、安全和上流信息。

twaf_reqstatに戻ります

TOCに戻ります

twaf_log

"twaf_log": {
        "access_log_state":true,                         -- 访问日志总开关
        "security_log_state":true,                       -- 安全日志总开关
        "flush_limit":32768,                             -- 缓冲，当存储的日志大于阈值时发送日志
        "size_limit": 200,                               -- 控制日志中每一项的字符上限，如'raw_header'或请求体响应体，可能会使udp日志报错
        "drop_limit":65507,                              -- 缓冲上限，达到此值，丢弃当前日志，发送缓存并清空缓存，当sock_type为udp时，drop_limit值最大为65507（65508会报错message too long）
        "periodic_flush": 2,                             -- flush间隔周期。单位：秒。日志会在达到flush_limit或periodic_flush时输出
        "max_retry_times":5,                             -- 最大容错次数
                                                      -- -- 以下为socket输出日志配置
        "socket_access_log_state": true,                 -- socket模式的访问日志开关
        "socket_security_log_state": true,               -- socket模式的安全日志开关
        "sock_type":"udp",                               -- 支持tcp和udp两种协议
        "content_type":"JSON",                           -- sock支持JSON和INFLUXDB两种日志格式
        "host":"127.0.0.1",                              -- 日志服务器地址
        "port":60055,                                    -- 日志服务器端口号
        "ssl":false,                                     -- 是否开启ssl协议
        "access_log":{},                                 -- 访问日志格式
        "security_log":{},                               -- 安全日志格式
                                                      -- -- 以下为file输出日志配置
        "file_access_log_state": true,                   -- file模式的访问日志开关
        "file_security_log_state": true,                 -- file模式的安全日志开关
        "file_flush": false,                             -- 是否实时写入文件
        "file_content_type": "W3C",                      -- file模式时日志格式，当前仅支持W3C
        "file_access_log_path": "/var/log/openwaf_access.log",      -- file模式的访问日志路径
        "file_security_log_path": "/var/log/openwaf_security.log",  -- file模式的安全日志路径
        "access_log_w3c": "",                            -- file模式访问日志的w3c格式
        "security_log_w3c": ""                           -- file模式安全日志的w3c格式
}

Access_log_state

構文： "Access_log_state"：true | false

デフォルト： false

コンテキスト： twaf_log

ブール类型、访问日志总开关、默认关闭。

security_log_state

構文： "security_log_state"：true | false

デフォルト： true

コンテキスト： twaf_log

ブール类型、安全事件日志总开关、默认开启

flush_limit

構文： "flush_limit"：number

デフォルト： 32768

コンテキスト： twaf_log

番号类型。缓冲区大小、当存储的日志大于阈值才发送、默认值为32768

v0.0.6及之前版本默认值为0、即立刻发送日志、不进行缓存。

v1.0.0βe、默认值为32768。

日志输出控制条件、还与riveric_flush参数有关。

size_limit

構文： "size_limit"：number

デフォルト： 200

コンテキスト： twaf_log

番号类型。控制日志中每一项的字符上限。单位：字节。

若 'raw_header'或请求体响应体过长、可能会使udp日志报错

drop_limit

構文： "drop_limit"：number

デフォルト： 65507

コンテキスト： twaf_log

番号类型。缓冲上限、达到此值、丢弃当前日志、发送缓存并清空缓存、当sock_type udp

riveric_flush

構文： "riperic_flush"：number

デフォルト： 2

コンテキスト： twaf_log

番号类型。日志フラッシュ间隔周期。单位：秒。

日志会在满足flush_limit或ripuring_flush条件时输出

max_retry_times

構文： "max_retry_times"：number

デフォルト： 5

コンテキスト： twaf_log

番号类型。最大容错次数

socket_access_log_state

構文： "socket_access_log_state"：true | false

デフォルト： true

コンテキスト： twaf_log

ブール类型、ソケット模式的访问日志开关

socket_security_log_state

構文： "socket_security_log_state"：true | false

デフォルト： true

コンテキスト： twaf_log

ブール类型、ソケット模式的安全日志开关

sock_type

構文： "sock_type"：tcp | udp

デフォルト： UDP

コンテキスト： twaf_log

日志传输协议、默认udp

content_type

構文： "content_type"：json | influxdb

デフォルト： JSON

コンテキスト： twaf_log

日志格式、默认json

ホスト

構文： 「ホスト」：文字列

デフォルト： 「127.0.0.1」

コンテキスト： twaf_log

日志接收服务器的IP地址

ポート

構文： 「ポート」：番号

デフォルト： 60055

コンテキスト： twaf_log

日志接收服务器的端口号

SSL

構文： "SSL"：true | false

デフォルト： false

コンテキスト： twaf_log

是否开启ssl协议、false

Access_log

構文： "Access_log"：テーブル

デフォルト： false

コンテキスト： twaf_log

表类型。访问日志格式。格式详见security_log说明。

security_log

構文： "Security_log"：テーブル

デフォルト： false

コンテキスト： twaf_log

安全事件日志格式

若Content_Type

 [
    variable_key_1, 
    variable_key_2, 
    ...
]

content_type

 {
    "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",
            "%{request_headers.host}"
        ]

        #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",
                "%{request_headers.host}"
            ],
            "time":true                   -- 日志是否携带时间戳
        }
        
    PS: JSON 和 INFLUXDB 格式的 access_log 和 security_log 支持自定义变量
        如上述举例，为了获取到 request_headers 中的 host 值，因此配置 "%{request_headers.host}"

file_access_log_state

構文： "file_access_log_state"：true | false

デフォルト： true

コンテキスト： twaf_log

ブール类型。ファイル模式的访问日志开关

file_security_log_state

構文： "file_security_log_state"：true | false

デフォルト： true

コンテキスト： twaf_log

ブール类型。ファイル模式的安全日志开关

file_flush

構文： "file_flush"：true | false

デフォルト： false

コンテキスト： twaf_log

ブール类型。是否实时写入文件

file_content_type

構文： "file_content_type"：w3c

デフォルト： W3C

コンテキスト： twaf_log

文字列类型。file模式时日志格式、当前仅支持w3c

file_access_log_path

構文： "file_access_log_path"：パス

デフォルト： "/var/log/openwaf_access.log"

コンテキスト： twaf_log

文字列类型。ファイル模式的访问日志路径

file_security_log_path

構文： "file_security_log_path"：パス

デフォルト： "/var/log/openwaf_security.log"

コンテキスト： twaf_log

文字列类型。ファイル模式的安全日志路径

Access_log_w3c

構文： "Access_log_w3c"：string

デフォルト：详见说明

コンテキスト： twaf_log

文字列类型。file

默认值为："%{remote_addr} - %{remote_user} [%{time_local}] "%{request_method} %{request_uri} %{request_protocol}" %{response_status} %{bytes_sent} "%{http_referer}" "%{http_user_agent}" %{userid} %{server_addr}:%{server_port} "%{http_host}" %{request_time} %{policyid} %{unique_id} %{api_id}"

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

security_log_w3c

構文： "security_log_w3c"：string

デフォルト：详见说明

コンテキスト： twaf_log

文字列类型。file

默认值为："%{remote_addr} - %{remote_user} [%{time_local}] "%{request_method} %{request_uri} %{request_protocol}" %{response_status} %{bytes_sent} "%{http_referer}" "%{http_user_agent}" %{userid} %{server_addr}:%{server_port} "%{http_host}" %{request_time} %{policyid} %{category} %{severity} %{action} %{id} %{rule_name} %{unique_id} %{api_id}"

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

twaf_logに戻ります

TOCに戻ります

twaf_secrules

    "twaf_secrules":{
        "state": true,                                              -- 总开关
        "reqbody_state": true,                                      -- 请求体检测开关
        "header_filter_state": true,                                -- 响应头检测开关
        "body_filter_state": true,                                  -- 响应体检测开关
        "system_rules_state": true,                                 -- 系统规则集检测开关
        "reqbody_limit":134217728,                                  -- 请求体检测阈值，大于阈值不检测
        "respbody_limit":524288,                                    -- 响应体检测阈值，大于阈值不检测
        "pre_path": "/opt/OpenWAF/",                                -- OpenWAF安装路径
        "path": "lib/twaf/inc/knowledge_db/twrules",                -- 特征规则库在OpenWAF中的路径
        "user_defined_rules":[ ],                                   -- 用户自定义规则，数组
        "rules_id":{                                                -- 特征排除
            "111112": [{"REMOTE_HOST":"a.com", "URI":" ^ /ab"}],      -- 匹配中数组中信息则对应规则失效，数组中key为变量名称，值支持正则
            "111113": {},                                           -- 特征未被排除
            "111114": [{}]                                          -- 特征被无条件排除
        },
        "ruleset_ids": [                                            -- 规则集引用。若 ruleset_ids 值为空，则默认所有的规则都生效(用于兼容无ruleset_ids的旧版本)
            "set_123456789",
            "set_987654321"
        ]
    }

州

構文：状態true | false

デフォルト： true

コンテキスト： TWAF_SECRULES

规则引擎总开关

reqbody_state

構文： reqbody_state true | false

デフォルト： true

コンテキスト： TWAF_SECRULES

请求体检测开关

header_filter_state

構文： header_filter_state true | false

デフォルト： true

コンテキスト： TWAF_SECRULES

响应头检测开关

body_filter_state

構文： body_filter_state true | false

デフォルト： false

コンテキスト： TWAF_SECRULES

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

System_rules_state

構文： System_rules_state true | false

デフォルト： true

コンテキスト： TWAF_SECRULES

系统规则集检测开关

lib/twaf/inc/knowledge_db/twrules目录下的规则、都是系统规则

除了系统规则外、还有twaf_secrules模块下user_defined_rules

系统规则一般很少改动、而用户自定义规则却随着业务而增减、如动态配置缓存、压缩、时域控制和黑白名单等。

reqbody_limit

構文： reqbody_limit番号

デフォルト： 134217728

コンテキスト： TWAF_SECRULES

请求体检测大小上限、默认134217728b（128MB）、若请求体超过设置上限、则不检测

PS：reqbody_limit

respody_limit

構文： respbody_limit番号

デフォルト： 134217728

コンテキスト： TWAF_SECRULES

响应体检测大小上限、默认134217728b（128MB）、若响应体大小超过设置上限、则不检测

pre_path

構文： pre_path文字列

デフォルト： /opt/openwaf/

コンテキスト： TWAF_SECRULES

OpenWaf的安装路径

パス

構文：パス文字列

デフォルト： LIB/TWAF/INC/KNOWLEWS_DB/TWRULES

コンテキスト： TWAF_SECRULES

openwaf中的路径

user_defined_rules

構文： user_defined_rules

デフォルト： []

コンテキスト： TWAF_SECRULES

策略下的用户自定义特征规则

先执行用户自定义规则、再执行系统规则

系统特征规则适用于所有的策略、在引擎启动时通过加载特征库或通过api加载系统特征规则、系统特征规则一般不会动态更改

用户自定义特征在策略下生效、一般用于变动较大的特征规则、如：时域控制、修改响应头等临时性规则

 "user_defined_rules" :[
    {
        "id" : " 1000001 " ,
        "release_version" : " 858 " ,
        "charactor_version" : " 001 " ,
        "disable" : false ,
        "opts" : {
            "nolog" : false
        },
        "phase" : " access " ,
        "action" : " deny " ,
        "meta" : 403 ,
        "severity" : " high " ,
        "rule_name" : " relative time " ,
        "desc" : "周一至周五的8点至18点，禁止访问/test目录" ,
        "match" : [{
            "vars" : [{
                "var" : " URI "
            }],
            "operator" : " begins_with " ,
            "pattern" : " /test "
        },
        {
            "vars" : [{
                "var" : " TIME_WDAY "
            }],
            "operator" : " equal " ,
            "pattern" : [ " 1 " , " 2 " , " 3 " , " 4 " , " 5 " ]
        },
        {
            "vars" : [{
                "var" : " TIME "
            }],
            "operator" : " str_range " ,
            "pattern" : [ " 08:00:00-18:00:00 " ]
        }]
    },
    {
        "id" : " 1000002 " ,
        "release_version" : " 858 " ,
        "charactor_version" : " 001 " ,
        "disable" : false ,
        "opts" : {
            "nolog" : false
        },
        "phase" : " access " ,
        "action" : " deny " ,
        "meta" : 403 ,
        "severity" : " high " ,
        "rule_name" : " iputil " ,
        "desc" : "某ip段内不许访问" ,
        "match" : [{
            "vars" : [{
               "var" : " REMOTE_ADDR "
            }],
            "operator" : " ip_utils " ,
            "pattern" : [ " 1.1.1.0/24 " , " 2.2.2.2-2.2.20.2 " ]
        }]
    }
]

rules_id

構文： rules_idテーブル

デフォルト：なし

コンテキスト： TWAF_SECRULES

用于排除特征

ruleet_ids

構文： Ruleset_Idsテーブル

デフォルト：なし

コンテキスト： TWAF_SECRULES

表类型。规则集引用、用于不同策略加载不同的规则进行防护。从v1.0.0β版本开始引入规则集。

若ruleet_ids值为空、则默认引用所有加载的规则。

若ruleet_ids值为空数组、则无任何规则生效。

    "ruleset_ids": [       -- 有序引用 set_123456789 与 set_987654321 两个规则集。
        "set_123456789",
        "set_987654321"
    ]
    
    PS： 当前规则集有关具体配置仅支持通过rule_set API进行配置

twaf_secrulesに戻ります

TOCに戻ります

twaf_anti_cc

{
    "twaf_limit_conn": {
        "state":false,                                       -- CC防护模块开关
        "log_state":true,                                    -- CC日志开关
        "trigger_state":true,                                -- 触发开关
        "clean_state":true,                                  -- 清洗开关
        "trigger_thr":{                                      -- 触发阈值（关系为“或”）
            "req_flow_max":1073741824,                       -- 每秒请求流量，单位B
            "req_count_max":10000                            -- 每秒请求数
        },
        "clean_thr":{                                        -- 清洗阈值
            "new_conn_max":40,                               -- 单一源ip每秒新建连接数
            "conn_max":100,                                  -- 单一源ip防护期间内连接总数
            "req_max":50,                                    -- 单一源ip每秒请求总数
            "uri_frequency_max":3000                         -- 单一路径每秒请求总数
        },
        "attacks": 1,                                        -- 在一次CC攻击过程中，某ip触发清洗值的次数大于attacks，则此ip会一直被拦截，直到CC攻击结束
        "timer_flush_expired":10,                            -- 清理shared_dict过期数据的时间间隔
        "interval":10,                                       -- 进入CC防护后发送日志的时间间隔，单位秒
        "shared_dict_name":"twaf_limit_conn",                -- 存放其他信息的shared_dict
        "shared_dict_key": "remote_addr",                    -- shared_dict的键值
        "action":"DENY",                                     -- 触发CC防护执行的动作
        "action_meta":403,
        "timeout":30                                         -- 清洗时长（当再次触发清洗值时，重置）
    }
}

ルール

構文： 「状態」：true | false

デフォルト： false

コンテキスト： twaf_limit_conn

ブール类型、cc防护模块总开关、默认关闭

log_state

構文： "log_state"：true | false

デフォルト： true

コンテキスト： twaf_limit_conn

ブール类型、cc防护模块日志开关、默认开启

trigger_state

構文： "trigger_state"：true | false

デフォルト： true

コンテキスト： twaf_limit_conn

ブール类型、cc防护模块的触发开关、默认开启

若关闭、则触发机制关闭、时刻进入cc清洗状态

clean_state

構文： "clean_state"：true | false

デフォルト： true

コンテキスト： twaf_limit_conn

ブール类型、cc防护模块总开关、默认开启

若关闭（仅用于测试）、则清洗机制关闭、cc模块将无法拦截请求

trigger_thr

構文： "trigger_thr"：テーブル

デフォルト： {"req_flow_max"：1073741824、 "req_count_max"：10000}

コンテキスト： twaf_limit_conn

表类型、触发阈值

当达到其中一个触发阈值、进入cc清洗状态

当前有两个触发阈值

    "trigger_thr":{                                      -- 触发阈值（关系为“或”）
        "req_flow_max":1073741824,                       -- 每秒请求流量，单位B，默认1GB/s
        "req_count_max":10000                            -- 每秒请求数，默认10000个/秒
    }

clean_thr

構文： "Clean_thr"：テーブル

デフォルト： {"new_conn_max"：40、 "conn_max"：100、 "req_max"：50、 "uri_frequency_max"：3000}

コンテキスト： twaf_limit_conn

表类型、清洗阈值

当进入cc清洗状态、达到其中一个清洗阈值、则执行相应动作

当前有四个清洗阈值

    "clean_thr":{                                        -- 清洗阈值（关系为“或”）
        "new_conn_max":40,                               -- 单一源ip每秒新建连接数，默认40个/秒
        "conn_max":100,                                  -- 单一源ip防护期间内连接总数，默认100个
        "req_max":50,                                    -- 单一源ip每秒请求总数，默认50个/秒
        "uri_frequency_max":3000                         -- 单一路径每秒请求总数，默认3000个/秒
    }

攻撃

構文： 「攻撃」：番号

デフォルト： 1

コンテキスト： twaf_limit_conn

在一次CC攻击过程中、某IP触发清洗阈值的次数大于攻撃、则此IP会一直被拦截、直到CC攻击结束

此前、在一次、cc攻击过程中、当达到清洗阈值时、才会进行拦截。若未达到清洗阈值、即使之前被拦截过、也可正常访问后端服务器

正确设置此参数、可以大大提升cc防护性能

若想恢复以前的CC防护机制、只需攻撃设为0即可

openwaf-0.0.6版本、twaf_anti_cc的0.0.3版本

timer_flush_expired

構文： "Timer_flush_expired"：number

デフォルト： 10

コンテキスト： twaf_limit_conn

番号类型、清理shared_dict过期数据的时间间隔、默认10秒

間隔

構文： 「間隔」：番号

デフォルト： 10

コンテキスト： twaf_limit_conn

番号类型、进入cc防护后发送日志的时间间隔、默认10秒

shared_dict_name

構文： "shared_dict_name"：string

デフォルト： 「twaf_limit_conn」

コンテキスト： twaf_limit_conn

文字列类型、存放当前cc防护信息的shared_dict名称

shared_dict_key

構文： "shared_dict_key"：string | table

デフォルト： 「remote_addr」

コンテキスト： twaf_limit_conn

文字列或テーブル类型、shared_dict的键值、支持nginx变量

支持字符串类型和数组类型

    "shared_dict_key": "remote_addr"
    
    "shared_dict_key": ["remote_addr", "http_user_agent"]

アクション

構文： 「アクション」：文字列

デフォルト： 「拒否」

コンテキスト： twaf_limit_conn

文字列类型、触发cc防护执行的动作、默认「否定」

action_meta

構文： "Action_meta"：number | string

デフォルト： 403

コンテキスト： twaf_limit_conn

文字列或番号类型、执行动作的附属信息、默认403

タイムアウト

構文： 「タイムアウト」：番号

デフォルト： 30

コンテキスト： twaf_limit_conn

番号类型、清洗时长、n秒内不再达到触发阈值、则退出cc清洗状态

在清洗过程中、再次达到触发阈值、则时间重置为30秒

TOCに戻ります

nginx変数

$ twaf_https

構文： $ twaf_https 0 | 1を設定します

デフォルト： 0

コンテキスト：サーバー

ssl加密

「$ twaf_https 1をセット」、则表示请求通过ssl加密

「$ twaf_https 0をセット」、则表示请求未通过ssl加密

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

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

$ twaf_upstream_server

構文： $ twaf_upstream_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;

TOCに戻ります

Secrules

変数

args
args_combined_size
args_get
args_get_names
args_names
args_post
args_post_names
bytes_in
connection_requests
間隔
ファイル
files_names
ジオ
geo_code3
geo_code3
geo_id
Geo_Continent
geo_name
gzip_ratio
http_cookie
http_host
http_referer
http_user_agent
ip_version
matched_var
matched_vars
matched_var_name
matched_vars_names
original_dst_addr
original_dst_port
PolicyId
query_string
raw_header
raw_header_true
remote_addr
remote_host
remote_port
remote_user
request_basename
request_body
request_cookies
request_cookies_names
request_fileName
request_headers
request_headers_names
request_line
request_method
request_protocol
http_version
uri
URL
request_uri
Response_body
Response_headers
Response_status
スキーム
server_addr
server_name
server_port
セッション
session_data
時間
time_day
time_epoch
time_hour
time_min
time_mon
Time_Sec
time_wday
time_year
time_local
TX
unique_id
upstream_cache_status
ユーザーID

varに戻る

TOCに戻ります

args

表类型、所有的请求参数、包含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"}

varに戻る

TOCに戻ります

args_combined_size

番号类型、请求参数总长度、只包含キー和値的长度、不包含 '＆'或 '='等符号

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

ARGS_COMBINED_SIZE变量值为15，而不是18

varに戻る

TOCに戻ります

args_get

表类型、QueryString参数

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

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

varに戻る

TOCに戻ります

args_get_names

表类型、QueryString参数キー值

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

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

varに戻る

TOCに戻ります

args_names

表类型、QueryString

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

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

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

varに戻る

TOCに戻ります

args_post

表类型、ポスト参数

例如：

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

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

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

varに戻る

TOCに戻ります

args_post_names

表类型、ポスト参数キー值

例如：

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

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

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

varに戻る

TOCに戻ります

bytes_in

番号类型、接收信息字节数

varに戻る

TOCに戻ります

connection_requests

番号类型、当前连接中的请求数

varに戻る

TOCに戻ります

間隔

文字列类型、处理事务用时时间、单位：微秒（μs）

varに戻る

TOCに戻ります

ファイル

表类型、从请求体中得到的原始文件名（带有文件后缀名）

varに戻る

TOCに戻ります

files_names

表类型、上传文件名称（不带有后缀名）

varに戻る

TOCに戻ります

ジオ

表类型、包含コード3、コード、ID、大陸、名前等字段信息

varに戻る

TOCに戻ります

geo_code3

文字列类型、3个字母长度的国家缩写

varに戻る

TOCに戻ります

geo_code

文字列类型、2个字母长度的国家缩写

varに戻る

TOCに戻ります

geo_id

番号类型、国家ID

varに戻る

TOCに戻ります

Geo_Continent

文字列类型、国家所在大洲

varに戻る

TOCに戻ります

geo_name

文字列类型、国家全称

varに戻る

TOCに戻ります

gzip_ratio

文字列类型、压缩比率

varに戻る

TOCに戻ります

http_cookie

文字列类型、请求头中的クッキー字段

varに戻る

TOCに戻ります

http_host

文字列类型、请求头中的ホスト字段值、既域名：端口（80缺省）

varに戻る

TOCに戻ります

http_referer

文字列类型、请求头中的参照者字段

varに戻る

TOCに戻ります

http_user_agent

文字列类型、请求头中的ユーザーエージェント字段

varに戻る

TOCに戻ります

ip_version

文字列类型、IPv4またはIPv6

varに戻る

TOCに戻ります

matched_var

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

varに戻る

TOCに戻ります

matched_vars

表类型、单条规则匹配中的所有变量

varに戻る

TOCに戻ります

matched_var_name

文字列类型、当前匹配中的变量名称

varに戻る

TOCに戻ります

matched_vars_names

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

varに戻る

TOCに戻ります

original_dst_addr

文字列类型、服务器地址、应用代理模式为waf地址、透明模式为后端服务器地址

varに戻る

TOCに戻ります

original_dst_port

文字列类型、服务器端口号、应用代理模式为waf端口号、透明模式为后端服务器端口号

varに戻る

TOCに戻ります

PolicyId

文字列类型、策略ID

varに戻る

TOCに戻ります

query_string

文字列类型、未解码的请求参数

varに戻る

TOCに戻ります

raw_header

文字列类型、请求头信息、带请求行

varに戻る

TOCに戻ります

raw_header_true

文字列类型、请求头信息、不带请求行

varに戻る

TOCに戻ります

remote_addr

文字列类型、客户端地址

varに戻る

TOCに戻ります

remote_host

文字列类型、域名

varに戻る

TOCに戻ります

remote_port

番号类型、端口号

varに戻る

TOCに戻ります

remote_user

文字列类型、用于身份验证的用户名

varに戻る

TOCに戻ります

request_basename

文字列类型、请求的文件名

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

REQUEST_BASENAME值为/login.php

varに戻る

TOCに戻ります

request_body

类型不定、请求体

varに戻る

TOCに戻ります

request_cookies

表类型、请求携带的クッキー

varに戻る

TOCに戻ります

request_cookies_names

表类型、请求携带クッキー的名称

varに戻る

TOCに戻ります

request_fileName

文字列类型、相対リクエストURL（相对请求路径）

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

REQUEST_FILENAME值为/test/login.php

varに戻る

TOCに戻ります

request_headers

表类型、请求头信息

varに戻る

TOCに戻ります

request_headers_names

表类型、请求头キー值

varに戻る

TOCに戻ります

request_line

文字列类型、请求行

varに戻る

TOCに戻ります

request_method

文字列类型、请求方法

varに戻る

TOCに戻ります

request_protocol

文字列类型、http请求协议、如：http/1.1

varに戻る

TOCに戻ります

http_version

番号类型、http请求协议版本、如：1、1.1、2

varに戻る

TOCに戻ります

uri

文字列类型、请求路径、既不带域名、也不带参数

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

URI变量值为/test/login.php

varに戻る

TOCに戻ります

URL

文字列类型、统一资源定位符、スキーム与http_host与uri的拼接

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

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

varに戻る

TOCに戻ります

request_uri

文字列类型、请求路径、带参数、但不带有域名

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

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

varに戻る

TOCに戻ります

Response_body

文字列类型、响应体

varに戻る

TOCに戻ります

Response_headers

表类型、响应头信息

varに戻る

TOCに戻ります

Response_status

関数类型、响应状态码

varに戻る

TOCに戻ります

スキーム

文字列类型、httpまたはhttps

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

SCHEME变量值为http

varに戻る

TOCに戻ります

server_addr

文字列类型、服务器地址

varに戻る

TOCに戻ります

server_name

文字列类型、服务器名称

varに戻る

TOCに戻ります

server_port

番号类型、服务器端口号

varに戻る

TOCに戻ります

セッション

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

varに戻る

TOCに戻ります

session_data

表类型、セッション信息、第三方模块lua-resty-session提供的变量

varに戻る

TOCに戻ります

時間

文字列类型、時間：分：秒

varに戻る

TOCに戻ります

time_day

番号类型、天（1-31）

varに戻る

TOCに戻ります

time_epoch

数字、时间戳、1970年以来秒

varに戻る

TOCに戻ります

time_hour

番号类型、小时（0-23）

varに戻る

TOCに戻ります

time_min

番号类型、分钟（0-59）

varに戻る

TOCに戻ります

time_mon

番号类型、月份（1-12）

varに戻る

TOCに戻ります

Time_Sec

番号类型、秒（0-59）

varに戻る

TOCに戻ります

time_wday

番号类型、周（0-6）

varに戻る

TOCに戻ります

time_year

数字、年份、4桁、例如：1997

varに戻る

TOCに戻ります

time_local

文字列类型、当前时间、例如：26/8月/2016：01：32：16 -0400

varに戻る

TOCに戻ります

TX

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

varに戻る

TOCに戻ります

unique_id

文字列类型、id标识、随机生成的字符串、可通过配置来控制随机字符串的长度

从v1.0.0β版本开始、默认34位自定义随机字符串ngx.request_id变量获取的16/32位随机字符串

varに戻る

TOCに戻ります

upstream_cache_status

応答キャッシュにアクセスするステータスを保持します（0.8.3）。ステータスは、「ミス」、「バイパス」、「期限切れ」、「陳腐」、「更新」、「revalidated」、または「hit」のいずれかです。

varに戻る

TOCに戻ります

ユーザーID

文字列类型、从接入规则配置得到的用于id标识

varに戻る

TOCに戻ります

変換関数

base64_decode
sql_hex_decode
base64_encode
カウンタ
compress_whitespace
hex_decode
hex_encode
html_decode
長さ
小文字
MD5
normorise_path
remove_nulls
remove_whitespace
replace_comments
remove_comments_char
remove_comments
uri_decode
uri_encode
SHA1
TRIM_LEFT
TRIM_RIGHT
トリム

TFFに戻ります

TOCに戻ります

base64_decode

base64エンコードされた文字列をデコードします。

注：注意変換的执行顺序

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

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

TFFに戻ります

TOCに戻ります

sql_hex_decode

SQL HEXデータをデコードします。

TFFに戻ります

TOCに戻ります

base64_encode

base64エンコーディングを使用して入力文字列をエンコードします。

TFFに戻ります

TOCに戻ります

カウンタ

计数、相当于modsecurity '＆'符号

TFFに戻ります

TOCに戻ります

compress_whitespace

空白文字のいずれか（0x20、 f、 t、 n、 r、 v、0xa0）を空間（ASCII 0x20）に変換し、複数の連続したスペース文字を1つに圧縮します。

TFFに戻ります

TOCに戻ります

hex_decode

HexenCodeで使用されているアルゴリズムと同じアルゴリズムを使用してエンコードされた文字列をデコードする

TFFに戻ります

TOCに戻ります

hex_encode

各入力バイトを2つの16進文字に置き換えることにより、文字列（おそらくバイナリ文字を含む）をエンコードします。

TFFに戻ります

TOCに戻ります

html_decode

HTMLエンティティとしてエンコードされた文字を解読します。

TFFに戻ります

TOCに戻ります

長さ

入力文字列の長さをバイト単位で検索します

TFFに戻ります

TOCに戻ります

小文字

すべての文字を小文字に変換します

TFFに戻ります

TOCに戻ります

MD5

入力のデータからMD5ハッシュを計算します。計算されたハッシュは生のバイナリ形式であり、印刷する（またはログ）テキストにエンコードされる必要がある場合があります。ハッシュ関数は、一般的にhex_encodeと組み合わせて使用されます（たとえば、 "transform"：["md5"、 "hex_encode"）。

TFFに戻ります

TOCに戻ります

normorise_path

入力文字列から複数のスラッシュ、ディレクトリの自己参照、およびディレクトリバックリファレンス（入力の先頭を除く）を削除します。

TFFに戻ります

TOCに戻ります

remove_nulls

入力からすべてのnulバイトを削除します

TFFに戻ります

TOCに戻ります

remove_whitespace

入力からすべての空白文字を削除します。

移除空白字符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

トリム

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

Back to TFF

Back to TOC

オペレーター

begins_with
含む
contains_word
detect_sqli
detect_xss
ends_with
等しい
greater_eq
大きい
ip_utils
less_eq
少ない
num_range
正規表現
str_match
str_range
validate_url_encoding

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

含む

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

等しい

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

大きい

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

从 v1.0.0β 版本开始支持 IPv6，如8888::192.168.1.1

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
8888::192.168.1.1
8888::1:1

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

少ない

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](#table-of-contents

num_range

判断是否在数字范围内

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

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

Back to OPERATORS

Back to TOC

正規表現

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

regex 等于 rx + capture，即 regex 同时包含 modsecurity 的 rx 功能和 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

str_range

判断是否在字符串范围内

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

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

その他

許可する
allow_phase
拒否
id
nolog
op_negated
解析
合格
警告
監査
段階
proxy_cache
pf
pset
リダイレクト
charactor_version
重大度
setvar
メタ
ngx_var
変身
タグ
release_version
ロボット
add_resp_headers

Back to OTHERS

Back to TOC

許可する

Stops processing of the current phase but also skipping over all other phases.

 "action": "allow"

一旦执行此动作，则后面的防护规则及其他安全模块均不进行安全检测，此动作一般用于白名单

Back to OTHERS

Back to TOC

allow_phase

Stops processing of the current phase.

 "action": "allow_phase"

Back to OTHERS

Back to TOC

拒否

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

解析

对变量进一步解析

若请求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

合格

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

 "action": "pass"

Back to OTHERS

Back to TOC

警告

like 'pass'

 "action": "warn"

Back to OTHERS

Back to TOC

監査

like 'pass'

 "action": "audit"

Back to OTHERS

Back to TOC

段階

规则执行的阶段，取值可为"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

pf

pattern是operator操作的参数

pf是指pattern from file，与pattern和pset互斥（三者不可同时出现），目前仅支持绝对路径

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

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

Back to OTHERS

Back to TOC

pset

集合。pattern、pf 和 pset 互斥(只能同时出现一个)。

暂不支持数组。

使用方法详见 https://github.com/titansec/openwaf_api#pset_post

Back to OTHERS

Back to TOC

リダイレクト

 "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

重大度

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

メタ

"action"的附属信息

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

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

Back to OTHERS

Back to TOC

ngx_var

为 nginx 变量赋值，支持赋值字符串

v1.0.0β版本之后支持赋值变量%{}

如在 nginx.conf 中 set $twaf_test "";

可在 secrules 中基于条件动态赋值
"opts": {
    "ngx_var": {
        "twaf_test": "1.1.1.1"      -- 也可赋值变量，如 "twaf_test": "%{remote_addr}"
    }
}

Back to OTHERS

Back to TOC

変身

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

release_version

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

 "release_version": "858"

Back to OTHERS

Back to TOC

ロボット

人机识别

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

 "action": "robot"

Back to OTHERS

Back to TOC

add_resp_headers

增删改响应头

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

Back to OTHERS

Back to TOC

寄付

PayPal

通过 PayPal 来支持 OpenWAF

アリパイ

wechat

Back to TOC

拡大する

OpenWAF

名前

目次

バージョン

概要

説明

インストール

コミュニティ

英語のメーリングリスト

中国のメーリングリスト

個人QQメール

QQグループ

バグとパッチ

トト

変更

著作権とライセンス

モジュール構成ディレクティブ

twaf_access_rule

ルール

ユーザー

NGX_SSL

NGX_SSL_CERT

ngx_ssl_key

ホスト

ポート

パス

url_case_sensitive

server_ssl

フォワード

Forward_addr

Forward_port

uuid

ポリシー

twaf_anti_hotlink

州

log_state

CT_STATE

event_id

event_severity

アクション

action_meta

モード

Allow_noreferer

cookie_name

uri_ext

twaf_anti_mal_crawler

州

log_state

dict_state

shared_dict_name

shared_dict_key

タイムアウト

timer_flush_expired

cookie_state

crawler_cookie_name

mal_cookie_name

force_scan_robots_state

force_scan_times

trap_uri

trap_args

TWAF_REQSTAT

州

Access_State

SAFE_STATE

upstream_state

shared_dict_name

shared_dict_key

twaf_log

Access_log_state

security_log_state

flush_limit

size_limit

drop_limit

riveric_flush

max_retry_times

socket_access_log_state

socket_security_log_state

sock_type

content_type

ホスト