Description

request-block plugin implements a request blocking function based on request characteristics such as URL and request header. It can be used to protect internal resources from unauthorized access.

Configuration Fields

NameTypeRequirementDefault ValueDescription
block_urlsarray of stringOptional. Choose one from following: block_urls, block_headers, block_bodies-HTTP URLs to be blocked.
block_headersarray of stringOptional. Choose one from following: block_urls, block_headers, block_bodies-HTTP request headers to be blocked.
block_bodiesarray of stringOptional. Choose one from following: block_urls ,block_headers, block_bodies-HTTP request bodies to be blocked.
blocked_codenumberOptional403HTTP response status code to be sent when corresponding request is blocked.
blocked_messagestringOptional-HTTP response body to be sent when corresponding request is blocked.
case_sensitiveboolOptionaltrueWhether to use case-senstive comparison when matching. Enabled by default.

Configuration Samples

Block Specific Request URLs

  1. block_urls:
  2. - swagger.html
  3. - foo=bar
  4. case_sensitive: false

According to the configuration above, following requests will be blocked:

Block Specific Request Headers

  1. block_headers:
  2. - example-key
  3. - example-value

According to the configuration above, following requests will be blocked:

  1. curl http://example.com -H ‘example-key: 123’
  2. curl http://exmaple.com -H ‘my-header: example-value’

Block Specific Request Bodies

  1. block_bodies:
  2. - “hello world”
  3. case_sensitive: false

According to the configuration above, following requests will be blocked:

  1. curl http://example.com -d ‘Hello World’
  2. curl http://exmaple.com -d ‘hello world’

Only Enable for Specific Routes or Domains

  1. # Use rules field for fine-grained rule configurations
  2. rules:
  3. # Rule 1: Match by route name
  4. - match_route:
  5.   - route-a
  6.   - route-b
  7.   blockbodies:
  8.   - “hello world”
  9. # Rule 2: Match by domain
  10. - _match_domain:
  11.   - “*.example.com”
  12.   - test.com
  13.   block_urls:
  14.   - “swagger.html”
  15.   block_bodies:
  16.   - “hello world”

In the rule sample of _match_route_, route-a and route-b are the route names provided when creating a new gateway route. When the current route names matches the configuration, the rule following shall be applied. In the rule sample of _match_domain_, *.example.com and test.com are the domain names used for request matching. When the current domain name matches the configuration, the rule following shall be applied. All rules shall be checked following the order of items in the _rules_ field, The first matched rule will be applied. All remained will be ignored.

Maximum Request Body Size Limitation

When block_bodies is configured, body matching shall only be performed when its size is smaller than 32MB. If not, and no block_urls or block_headers configuration is matched, the request won’t be blocked. When block_bodies is configured, if the size of request body exceeds the global configuration of DownstreamConnectionBufferLimits, a 413 Payload Too Large response will be returned.