管理消费者凭据
消费者是使用你的 API 的应用程序或开发者。在服务上启用身份验证后,消费者必须先取得凭据才能访问 API。
服务上启用的身份验证插件就像 API 的锁,消费者凭据则是开锁的钥匙。在 API7 企业版中,配置消费者需要一个唯一的用户名和至少一个凭据。
消费者可以使用多个不同类型的凭据。进行身份验证时,系统对这些凭据一视同仁。
本教程介绍如何创建消费者并配置身份验证凭据。
前提条件
配置 Key Authentication 凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击 + 新增消费者。
- 在对话框中完成以下操作。
- 在名称字段中输入
Alice。 - 点击新增。
- 在凭据选项卡下,点击 + 新增 Key Authentication 凭据。
- 在对话框中完成以下操作。
- 在名称字段中输入
primary-key。 - 在 Key 字段中输入
alice-primary-key。 - 点击新增。
- 再添加一个名为
backup-key的 Key Authentication 凭据,将 Key 设置为alice-backup-key。这两个凭据均有效,可以互换使用来进行 API 身份验证。
以下互动演示介绍如何在 API7 企业版中配置 Key Authentication 凭据。
adc-consumer.yaml
consumers:
- username: Alice
credentials:
- name: primary-key
type: key-auth
config:
key: alice-primary-key
- name: backup-key
type: key-auth
config:
key: alice-backup-key
将配置同步到 API7 企业版。
adc sync -f adc-consumer.yaml
Ingress Controller 目前不支持凭据和匿名消费者。
验证
请参阅为 API 启用 Key Authentication,在服务级别启用 Key Auth 插件。
然后按照验证 Key Authentication中的步骤进行验证。
配置 Basic Authentication 凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击新增消费者。
- 在对话框中完成以下操作。
- 在名称字段中输入
Alice。 - 点击新增。
- 在凭据选项卡下,选择 Basic Authentication,然后点击新增 Basic Authentication 凭据。
- 在对话框中完成以下操作。
- 在名称字段中输入
primary-basic。 - 在用户名字段中输入
Alice。 - 在密码字段中输入
alice-password。 - 点击新增。
- 再添加一个名为
backup-basic的 Basic Authentication 凭据,用户名为Alice-backup,密码为alice-backup-password。这两个凭据均有效,可以互换使用来进行 API 身份验证。
即将推出。
Ingress Controller 目前不支持凭据和匿名消费者。
验证
请参阅为 API 启用 Basic Authentication,在服务级别启用 Key Auth 插件。
然后按照验证 Basic Authentication中的步骤进行验证。
配置不同的身份验证凭据
消费者可以拥有多个不同类型的凭据,但已发布服务中的每条路由应只配置一个身份验证插件。这样,消费者就能用自己偏好的身份验证方式访问不同的路由。
以下互动演示介绍如何在 API7 企业版中配置不同类型的身份验证凭据。
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击 + 新增消费者。
- 在对话框中完成以下操作。
- 在名称字段中输入
John。 - 点击新增。
- 在凭据选项卡下,点击新增 Key Authentication 凭据。
- 在对话框中完成以下操作。
- 在名称字段中输入
key-auth。 - 在密钥字段中选择手动输入,然后输入
john-key-auth。 - 点击新增。
- 在凭据选项卡下,选择 Basic Authentication,然后点击新增 Basic Authentication 凭据。
- 在对话框中完成以下操作。
- 在名称字段中输入
basic-auth。 - 在用户名字段中输入
john。 - 在密码字段中选择手动输入,然后输入
john-password。 - 点击新增。
- 在凭据选项卡下,选择 JWT,然后点击新增 JWT 凭据。
- 在对话框中完成以下操作。
- 在名称字段中输入
jwt-auth。 - 在密钥字段中输入
john-jwt-key。 - 在算法字段中选择
RS256。 - 在公钥字段中选择手动输入,然后输入你的公钥。
- 点击新增。
- 在凭据选项卡下,选择 HMAC 认证,然后点击新增 HMAC 认证凭据。
- 在对话框中完成以下操作。
- 在名称字段中输入
hmac-auth。 - 在密钥 ID 字段中输入
john-key。 - 在密钥字段中选择手动输入,然后输入
john-hmac-key。 - 点击新增。
即将推出。
Ingress Controller 目前不支持凭据和匿名消费者。
相关阅读
- 核心概念
- API 安全
- API 消费
- 插件中心