basic-auth

描述

使用 basic-auth 插件可以将 Basic_access_authentication 添加到 Route 或 Service 中。

该插件需要与 Consumer 一起使用。API 的消费者可以将它们的密钥添加到请求头中以验证其请求。

属性

Consumer 端：

名称类型必选项描述
usernamestring是Consumer 的用户名并且该用户名是唯一，如果多个 Consumer 使用了相同的 username，将会出现请求匹配异常。
passwordstring是用户的密码。

Route 端：

名称类型必选项默认值描述
hide_credentialsboolean否false该参数设置为 true 时，则会将 Authorization 请求头传递给 Upstream。

启用插件

如果需要启用插件，就必须创建一个具有身份验证配置的 Consumer：

  1. curl http://127.0.0.1:9080/apisix/admin/consumers \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "username": "foo",
  5.     "plugins": {
  6.         "basic-auth": {
  7.             "username": "foo",
  8.             "password": "bar"
  9.         }
  10.     }
  11. }'

你也可以通过 APISIX Dashboard 完成上述操作。

创建 Consumer 后，就可以通过配置 Route 或 Service 来验证插件，以下是配置 Route 的命令：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/hello",
  6.     "plugins": {
  7.         "basic-auth": {}
  8.     },
  9.     "upstream": {
  10.         "type": "roundrobin",
  11.         "nodes": {
  12.             "127.0.0.1:8080": 1
  13.         }
  14.     }
  15. }'

测试插件

通过上述命令启用插件后，可以通过以下方法测试插件。

  1. curl -i -ufoo:bar http://127.0.0.1:9080/hello

如果配置成功则返回如下结果：

  1. HTTP/1.1 200 OK
  2. ...
  3. hello, world

如果请求未授权，则返回如下结果：

  1. HTTP/1.1 401 Unauthorized
  2. ...
  3. {"message":"Missing authorization in request"}

如果用户名和密码错则返回如下结果：

  1. HTTP/1.1 401 Unauthorized
  2. ...
  3. {"message":"Invalid user authorization"}

禁用插件

当你需要禁用 basic-auth 插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/hello",
  6.     "plugins": {},
  7.     "upstream": {
  8.         "type": "roundrobin",
  9.         "nodes": {
  10.             "127.0.0.1:8080": 1
  11.         }
  12.     }
  13. }'