参数
请参阅插件通用配置，了解所有插件可用的配置选项。
mode
string
default:
blockvaild vaule:
off,monitor, orblock确定插件对匹配请求的行为模式。
在
off模式下，跳过 WAF 检查。在monitor模式下，记录潜在威胁的请求但不阻止。在block模式下，具有威胁的请求将按照 WAF 服务的决定被阻止。match
array[object]
匹配规则数组。插件使用这些规则来决定是否对请求执行 WAF 检查。如果列表为空，则处理所有请求。
vars
append_waf_resp_header
boolean
default:
true如果为 true，则添加响应头
X-APISIX-CHAITIN-WAF、X-APISIX-CHAITIN-WAF-TIME、X-APISIX-CHAITIN-WAF-ACTION和X-APISIX-CHAITIN-WAF-STATUS。append_waf_debug_header
boolean
default:
false如果为 true，则在响应中添加调试头
X-APISIX-CHAITIN-WAF-ERROR和X-APISIX-CHAITIN-WAF-SERVER。仅当append_waf_resp_header为true时有效。config
object
Chaitin WAF 服务配置。指定时，这些设置会覆盖相应的元数据默认值。
connect_timeout
integer
default:
1000到 WAF 服务的连接超时时间，单位为毫秒。
send_timeout
integer
default:
1000向 WAF 服务发送数据的超时时间，单位为毫秒。
read_timeout
integer
default:
1000从 WAF 服务接收数据的读取超时时间，单位为毫秒。
req_body_size
integer
default:
1024允许的最大请求体大小，单位为 KB。
keepalive_size
integer
default:
256可以并发维护的到 WAF 检测服务的最大空闲连接数。
keepalive_timeout
integer
default:
60000WAF 服务的空闲连接超时时间，单位为毫秒。
real_client_ip
boolean
default:
true如果为 true，则从
X-Forwarded-For头获取客户端 IP。如果为 false，则插件使用连接中的客户端 IP。
插件元数据
nodes
array[object]
required
Chaitin WAF 服务的地址数组。
host
string
required
Chaitin WAF 服务地址。支持 IPv4、IPv6、Unix Socket 等。
port
integer
default:
80Chaitin WAF 服务端口。
mode
string
default:
block确定插件对匹配请求的行为模式。
在
off模式下，跳过 WAF 检查。在monitor模式下，记录潜在威胁的请求但不阻止。在block模式下，具有威胁的请求将按照 WAF 服务的决定被阻止。config
object
Chaitin WAF 服务配置。
connect_timeout
integer
default:
1000到 WAF 服务的连接超时时间，单位为毫秒。
send_timeout
integer
default:
1000向 WAF 服务发送数据的超时时间，单位为毫秒。
read_timeout
integer
default:
1000从 WAF 服务接收数据的读取超时时间，单位为毫秒。
req_body_size
integer
default:
1024允许的最大请求体大小，单位为 KB。
keepalive_size
integer
default:
256可以并发维护的到 WAF 检测服务的最大空闲连接数。
keepalive_timeout
integer
default:
60000WAF 服务的空闲连接超时时间，单位为毫秒。
real_client_ip
boolean
default:
true如果为 true，则从
X-Forwarded-For头获取客户端 IP。如果为 false，则插件使用连接中的客户端 IP。