Chaitin WAF | Apache APISIX 与 API7 网关插件文档

参数

请参阅插件通用配置，了解所有插件通用的配置选项。

mode
string
默认值：block
有效值：
off、monitor 或 block
确定插件对匹配请求的行为模式。
在 off 模式下，跳过 WAF 检查。在 monitor 模式下，记录潜在威胁的请求但不阻止。在 block 模式下，具有威胁的请求将按照 WAF 服务的决定被阻止。
match
array[object]
匹配规则数组。插件使用这些规则来决定是否对请求执行 WAF 检查。如果列表为空，则处理所有请求。
- vars
  array[array]
  一个或多个匹配条件数组，格式为 APISIX 表达式，用于有条件地执行插件。
append_waf_resp_header
boolean
默认值：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
默认值：false
如果为 true，则在响应中添加调试头 X-APISIX-CHAITIN-WAF-ERROR 和 X-APISIX-CHAITIN-WAF-SERVER。仅当 append_waf_resp_header 为 true 时有效。
config
object
Chaitin WAF 服务配置。指定时，这些设置会覆盖相应的元数据默认值。
- connect_timeout
  integer
  默认值：1000
  到 WAF 服务的连接超时时间，单位为毫秒。
- send_timeout
  integer
  默认值：1000
  向 WAF 服务发送数据的超时时间，单位为毫秒。
- read_timeout
  integer
  默认值：1000
  从 WAF 服务接收数据的读取超时时间，单位为毫秒。
- req_body_size
  integer
  默认值：1024
  允许的最大请求体大小，单位为 KB。
- keepalive_size
  integer
  默认值：256
  可以并发维护的到 WAF 检测服务的最大空闲连接数。
- keepalive_timeout
  integer
  默认值：60000
  WAF 服务的空闲连接超时时间，单位为毫秒。
- real_client_ip
  boolean
  默认值：true
  如果为 true，则使用网关已解析的客户端 IP，其中包括受信任代理和 Real IP 配置的影响。如果为 false，则使用连接的直接对端地址。插件不会直接读取客户端提供的转发请求头。
- log_resp
  boolean
  如果为 true，在响应已经返回给客户端之后，除请求外还把响应一并上报给 WAF 检测服务。该上报仅供参考，不会阻断也不会修改响应。API7 企业版 3.9.20 和 3.10.7 起可用。
- resp_body_size
  integer
  上报的响应体最大大小，单位为 KB。设置为 0 表示只上报响应头。仅当 log_resp 为 true 时生效。API7 企业版 3.9.20 和 3.10.7 起可用。
- extra_ignored_content_types
  string
  以逗号分隔的额外响应 content type 列表，在内置忽略列表之外。命中的响应完全不会上报给 WAF 检测服务，响应头也不会上报。仅当 log_resp 为 true 时生效。API7 企业版 3.9.20 和 3.10.7 起可用。

插件元数据

nodes
array[object]
必填
Chaitin WAF 服务的地址数组。
- host
  string
  必填
  Chaitin WAF 服务地址。支持 IPv4、IPv6、Unix Socket 等。
- port
  integer
  默认值：80
  Chaitin WAF 服务端口。
mode
string
默认值：block
确定插件对匹配请求的行为模式。
在 off 模式下，跳过 WAF 检查。在 monitor 模式下，记录潜在威胁的请求但不阻止。在 block 模式下，具有威胁的请求将按照 WAF 服务的决定被阻止。
config
object
Chaitin WAF 服务配置。
- connect_timeout
  integer
  默认值：1000
  到 WAF 服务的连接超时时间，单位为毫秒。
- send_timeout
  integer
  默认值：1000
  向 WAF 服务发送数据的超时时间，单位为毫秒。
- read_timeout
  integer
  默认值：1000
  从 WAF 服务接收数据的读取超时时间，单位为毫秒。
- req_body_size
  integer
  默认值：1024
  允许的最大请求体大小，单位为 KB。
- keepalive_size
  integer
  默认值：256
  可以并发维护的到 WAF 检测服务的最大空闲连接数。
- keepalive_timeout
  integer
  默认值：60000
  WAF 服务的空闲连接超时时间，单位为毫秒。
- real_client_ip
  boolean
  默认值：true
  如果为 true，则使用网关已解析的客户端 IP，其中包括受信任代理和 Real IP 配置的影响。如果为 false，则使用连接的直接对端地址。插件不会直接读取客户端提供的转发请求头。
- log_resp
  boolean
  默认值：false
  如果为 true，在响应已经返回给客户端之后，除请求外还把响应一并上报给 WAF 检测服务。该上报仅供参考，不会阻断也不会修改响应。API7 企业版 3.9.20 和 3.10.7 起可用。
- resp_body_size
  integer
  默认值：4
  上报的响应体最大大小，单位为 KB。设置为 0 表示只上报响应头。仅当 log_resp 为 true 时生效。API7 企业版 3.9.20 和 3.10.7 起可用。
- extra_ignored_content_types
  string
  以逗号分隔的额外响应 content type 列表，在内置忽略列表之外。命中的响应完全不会上报给 WAF 检测服务，响应头也不会上报。仅当 log_resp 为 true 时生效。API7 企业版 3.9.20 和 3.10.7 起可用。

参数​

插件元数据​

参数

插件元数据