basic-auth

本文介绍了关于 APIX basic-auth 插件的基本信息及使用方法。

描述

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

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

属性

Consumer 端：

名称	类型	必选项	描述
username	string	是	Consumer 的用户名并且该用户名是唯一，如果多个 Consumer 使用了相同的 username，将会出现请求匹配异常。
password	string	是	用户的密码。该字段支持使用 APISIX Secret 资源，将值保存在 Secret Manager 中。

注意：schema 中还定义了 encrypt_fields = {"password"}，这意味着该字段将会被加密存储在 etcd 中。具体参考 加密存储字段。

Route 端：

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

启用插件

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

curl http://127.0.0.1:9180/apix/admin/consumers \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "username": "foo",
    "plugins": {
        "basic-auth": {
            "username": "foo",
            "password": "bar"
        }
    }
}'

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

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

curl http://127.0.0.1:9180/apix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/hello",
    "plugins": {
        "basic-auth": {}
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:8080": 1
        }
    }
}'

测试插件

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

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

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

HTTP/1.1 200 OK
...
hello, world

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

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

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

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

禁用插件

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

curl http://127.0.0.1:9180/apix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/hello",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:8080": 1
        }
    }
}'