ua-restriction

Description

The ua-restriction Plugin allows you to restrict access to a Route or Service based on the User-Agent header with an allowlist and a denylist.

A common scenario is to set crawler rules. User-Agent is the identity of the client when sending requests to the server, and the user can allow or deny some crawler request headers in the ua-restriction Plugin.

Attributes

NameTypeRequiredDefaultValid valuesDescription
bypass_missingbooleanFalsefalseWhen set to true, bypasses the check when the User-Agent header is missing.
allowlistarray[string]FalseList of allowed User-Agent headers.
denylistarray[string]FalseList of denied User-Agent headers.
messagestringFalse“Not allowed”Message with the reason for denial to be added to the response.
ua-restriction - 图1note

allowlist and denylist can’t be configured at the same time.

Enable Plugin

You can enable the Plugin on a Route or a Service as shown below:

ua-restriction - 图2note

You can fetch the admin_key from config.yaml and save to an environment variable with the following command:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "upstream": {
  5.         "type": "roundrobin",
  6.         "nodes": {
  7.             "127.0.0.1:1980": 1
  8.         }
  9.     },
  10.     "plugins": {
  11.         "ua-restriction": {
  12.              "bypass_missing": true,
  13.              "denylist": [
  14.                  "my-bot2",
  15.                  "(Twitterspider)/(\\d+)\\.(\\d+)"
  16.              ],
  17.              "message": "Do you want to do something bad?"
  18.         }
  19.     }
  20. }'

Example usage

Send a request to the route:

  1. curl http://127.0.0.1:9080/index.html -i

You should receive an HTTP/1.1 200 OK response.

Now if the User-Agent header is in the denylist i.e the bot User-Agent:

  1. curl http://127.0.0.1:9080/index.html --header 'User-Agent: Twitterspider/2.0'

You should receive an HTTP/1.1 403 Forbidden response with the following message:

  1. {"message":"Do you want to do something bad?"}

Delete Plugin

To remove the ua-restriction Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {},
  5.     "upstream": {
  6.         "type": "roundrobin",
  7.         "nodes": {
  8.             "127.0.0.1:1980": 1
  9.         }
  10.     }
  11. }'