Request Header Related Primitives

req_header_key_in(key_list)

• Description: Judge if header key in matches configured patterns

• Parameters

Parameter	Description
key_list	String a list of header keys which are concatenated using | The header key should be in canonical form

• Example

// right：
req_header_key_in("Header-Test")

// wrong：
req_header_key_in("Header-test")
req_header_key_in("header-test")
req_header_key_in("header-Test")

req_header_value_in(header_name, value_list, case_insensitive)

• Description:

  • Judge if value of key in header matches configured patterns

• Parameters

Parameter	Description
header_name	String header name
value_list	String a list of header values which are concatenated using |
case_insensitive	Boolean case insensitive

• Example

req_header_value_in("Referer", "https://example.org/login", true)

req_header_value_prefix_in(header_name, value_prefix_list, case_insensitive)

• Description: Judge if value prefix of key in header matches configured patterns

• Parameters

Parameter	Description
header_name	String header name
value_prefix_list	String a list of values which are concatenated using |
case_insensitive	Boolean case insensitive

• Example

req_header_value_prefix_in("Referer", "https://example.org", true)

req_header_value_suffix_in(header_name, value_suffix_list, case_insensitive)

• Description: Judge if value suffix of key in header matches configured patterns

• Parameters

Parameter	Description
header_name	String header name
value_suffix_list	String a list of values which are concatenated using |
case_insensitive	Boolean case insensitive

• Example

req_header_value_suffix_in("User-Agent", "2.0.4", true)

req_header_value_hash_in(header_name, hash_value_list, case_insensitive)

• Description: Judge if hash value of specified header matches configured patterns (value range: 0～9999)

• Parameters

Parameter	Description
header_name	String header name
hash_value_list	String a list of hash values which are concatenated using |
case_insensitive	Boolean case insensitive

• Example

req_header_value_hash_in("X-Device-Id", "100-200|400", true)

req_header_value_contain(header_name, value_list, case_insensitive)

• Description: Judge if value of key in header contains any substring in configured patterns

• Parameters

Parameter	Description
header_name	String header name
value_list	String a list of value substrings which are concatenated using |
case_insensitive	Boolean case insensitive

• Example

req_header_value_contain("User-Agent", "Firefox|Chrome", true)

req_header_value_regmatch(header_name, reg_exp)

• Description: Judge if value of key in header matches configured regular expression

  • Note: It is recommended to use backticks to avoid escaping; inappropriate use can significantly affect performance

• Parameters

Parameter	Description
header_name	String header name
reg_exp	String a regular expression

• Example

req_header_value_regmatch("User-Agent", `Chrome/\d+`)

req_ua_regmatch(reg_exp)

• Description: Judge if the value of the User-Agent header matches configured regular expression

  • Note: It is recommended to use backticks to avoid escaping; inappropriate use can significantly affect performance

• Parameters

Parameter	Description
reg_exp	String a regular expression

• Example

req_ua_regmatch(`.*Bot.*`)