Skip to main content
Version: Next

Credential

描述#

Credential 存储与 Consumer 关联的认证插件配置。每个 Credential 最多包含一个已启用的认证插件，例如 basic-auth、hmac-auth、jwt-auth 或 key-auth。

一个 Consumer 可以拥有不同认证插件的 Credential，也可以为同一认证插件配置多个具有不同识别值的 Credential。例如，可以先创建第二个 key-auth Credential，将客户端切换到新密钥，再删除旧 Credential，以完成密钥轮换。Credential 详情独立存储，获取 Consumer 资源时不会返回这些详情。

配置选项#

定义 Credential 的字段如下：

名称必选项描述
desc否Credential 描述。
labels否Credential 标签。
plugins否最多包含一个认证插件配置。详细信息请参见 Plugins。
note

如需了解更多关于 Credential 对象的信息，你可以参考 Admin API Credential 资源介绍。

使用示例#

Consumer 使用示例 介绍了如何对 Consumer 配置认证插件，并介绍了如何配合其他插件使用。 在该示例中，该 Consumer 只有一个 key-auth 类型的凭证。 现在假设用户需要为该 Consumer 配置多个凭证，你可以使用 Credential 来支持这一点。

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')

  1. 创建 Consumer。不指定认证插件，而是稍后使用 Credential 来配置认证插件。

    curl http://127.0.0.1:9180/apisix/admin/consumers \
    -H "X-API-KEY: $admin_key" -X PUT -d '
    {
        "username": "jack"
    }'

  2. 为 Consumer 配置 2 个 启用 key-auth 的 Credential。

    curl http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials/key-auth-one \
    -H "X-API-KEY: $admin_key" -X PUT -d '
    {
        "plugins": {
            "key-auth": {
                "key": "auth-one"
            }
        }
    }'
    curl http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials/key-auth-two \
    -H "X-API-KEY: $admin_key" -X PUT -d '
    {
        "plugins": {
            "key-auth": {
                "key": "auth-two"
            }
        }
    }'

  3. 创建路由，设置路由规则和启用插件配置。

    curl http://127.0.0.1:9180/apisix/admin/routes/1 \
    -H "X-API-KEY: $admin_key" -X PUT -d '
    {
        "plugins": {
            "key-auth": {}
        },
        "upstream": {
            "nodes": {
                "127.0.0.1:1980": 1
            },
            "type": "roundrobin"
        },
        "uri": "/hello"
    }'

  4. 测试插件

    分别使用 auth-one 和 auth-two 两个 key 来测试请求，都响应正常。

    curl http://127.0.0.1:9080/hello -H 'apikey: auth-one' -I
    curl http://127.0.0.1:9080/hello -H 'apikey: auth-two' -I

    为该 Consumer 启用 limit-count 插件。

    curl http://127.0.0.1:9180/apisix/admin/consumers \
    -H "X-API-KEY: $admin_key" -X PUT -d '
    {
        "username": "jack",
        "plugins": {
            "limit-count": {
                "count": 2,
                "time_window": 60,
                "rejected_code": 503,
                "key": "remote_addr"
            }
        }
    }'

    分别使用这两个 key 连续 3 次以上请求该路由，测试返回 503，请求被限制。