管理消费者凭据
消费者是使用 API 的应用程序。在服务上启用身份认证后,可以要求消费者在访问 API 前获取凭据,从而控制访问。
服务上启用的身份认证插件相当于 API 的锁,而消费者凭据则是开锁的钥匙。在 API7 企业版中,创建消费者需要唯一的用户名和至少一个凭据。
消费者可以使用多个不同类型的凭据,在身份认证时,这些凭据的地位相同。
在实施基于消费者的凭据管理之前,请先考虑开发者是否是更合适的方案。
本教程介绍如何创建消费者并配置身份认证凭据。
前提条件
配置 Key Authentication 凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击 + 新增消费者。
- 在对话框中,执行以下操作:
- 在名称字段中输入
Alice。 - 点击新增。
- 在凭据选项卡下,点击 + 新增 Key Authentication 凭据。
- 在对话框中,执行以下操作:
- 在名称字段中输入
primary-key。 - 在 Key 字段中输入
alice-primary-key。- 如果希望从 Secret 提供商引用密钥,请参阅引用 HashiCorp Vault 中的密钥、引用 AWS Secrets Manager 中的密钥或引用 Kubernetes Secret 中的密钥。
- 点击新增。
- 再添加一个名为
backup-key的 Key Authentication 凭据,Key 为alice-backup-key。所有凭据都有效,可以互换用于 API 身份认证。
以下互动演示介绍如何使用 API7 企业版配置 Key Authentication 凭据。
更新 ADC 配置,添加具有 Key Authentication 凭据的消费者 Alice:
consumers:
- username: Alice
credentials:
- config:
key: alice-backup-key
name: backup-key
type: key-auth
- config:
key: alice-primary-key
name: primary-key
type: key-auth
将配置同步到 API7 企业版:
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
为使用 Key Authentication 的消费者 alice 创建 Kubernetes 清单文件,包含一个主密钥和一个备用密钥:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: alice
spec:
gatewayRef:
name: apisix
credentials:
- type: key-auth
name: primary-key
config:
key: alice-primary-key
- type: key-auth
name: backup-key
config:
key: alice-backup-key
也可以在配置凭据时使用 Kubernetes Secret:
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: key-auth-primary
data:
key: YWxpY2UtcHJpbWFyeS1rZXk=
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: key-auth-backup
data:
key: YWxpY2UtYmFja3VwLWtleQ==
---
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: alice
spec:
gatewayRef:
name: apisix
credentials:
- type: key-auth
name: key-auth-primary
secretRef:
name: key-auth-primary
- type: key-auth
name: key-auth-backup
secretRef:
name: key-auth-backup
❶ 对主密钥 alice-primary-key 进行 Base64 编码。
❷ 对备用密钥 alice-backup-key 进行 Base64 编码。
将配置应用到集群:
kubectl apply -f consumer-cred.yaml
ApisixConsumer CRD 目前不支持为同一个消费者关联多个相同类型的凭据。
为使用 Key Authentication 的消费者 alice 创建 Kubernetes 清单文件,包含一个密钥:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: alice
spec:
ingressClassName: apisix
authParameter:
keyAuth:
value:
key: alice-primary-key
也可以在配置凭据时使用 Kubernetes Secret:
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: key-auth-primary
data:
key: YWxpY2UtcHJpbWFyeS1rZXk=
---
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: alice
spec:
ingressClassName: apisix
authParameter:
keyAuth:
secretRef:
name: key-auth-primary
❶ 对主密钥 alice-primary-key 进行 Base64 编码。
将配置应用到集群:
kubectl apply -f consumer-cred.yaml
验证
参阅为 API 启用 Key Authentication,在服务级别启用 Key Auth 插件。
然后按照验证 Key Authentication的说明进行验证。
配置 Basic Authentication 凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击 + 新增消费者。
- 在对话框中,执行以下操作:
- 在名称字段中输入
Alice。 - 点击新增。
- 在凭据选项卡下选择 Basic Authentication 选项卡,然后点击新增 Basic Authentication 凭据。
- 在对话框中,执行以下操作:
- 在名称字段中输入
primary-basic。 - 在用户名字段中输入
alice。 - 在密码字段中输入
alice-password。- 如果希望从 Secret 提供商引用密钥,请参阅引用 HashiCorp Vault 中的密钥、引用 AWS Secrets Manager 中的密钥或引用 Kubernetes Secret 中的密钥。
- 点击新增。
- 再添加一个名为
backup-basic的 Basic Authentication 凭据,用户名为alice-backup,密码为alice-backup-password。所有凭据都有效,可以互换用于 API 身份认证。
更新 ADC 配置,添加具有 Basic Authentication 凭据的消费者 Alice:
consumers:
- username: Alice
credentials:
- config:
password: alice-backup-password
username: alice-backup
name: backup-basic
type: basic-auth
- config:
password: alice-password
username: alice
name: primary-basic
type: basic-auth
将配置同步到 API7 企业版:
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
为使用 Basic Authentication 的消费者 alice 创建 Kubernetes 清单文件,包含一个主凭据和一个备用凭据:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: alice
spec:
gatewayRef:
name: apisix
credentials:
- type: basic-auth
name: primary-basic
config:
username: alice
password: alice-password
- type: basic-auth
name: backup-basic
config:
username: alice-backup
password: alice-backup-password
也可以在配置凭据时使用 Kubernetes Secret:
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: basic-auth-primary
data:
username: YWxpY2U=
password: YWxpY2UtcGFzc3dvcmQ=
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: basic-auth-backup
data:
username: YWxpY2UtYmFja3Vw
password: YWxpY2UtYmFja3VwLXBhc3N3b3Jk
---
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: alice
spec:
gatewayRef:
name: apisix
credentials:
- type: basic-auth
name: basic-auth-primary
secretRef:
name: basic-auth-primary
- type: basic-auth
name: basic-auth-backup
secretRef:
name: basic-auth-backup
❶ 对用户名 alice 进行 Base64 编码。
❷ 对密码 alice-password 进行 Base64 编码。
❸ 对用户名 alice-backup 进行 Base64 编码。
❹ 对密码 alice-backup-password 进行 Base64 编码。
将配置应用到集群:
kubectl apply -f consumer-cred.yaml
ApisixConsumer CRD 目前不支持为同一个消费者关联多个相同类型的凭据。
为使用 Basic Authentication 的消费者 alice 创建 Kubernetes 清单文件,包含一个主凭据:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: alice
spec:
ingressClassName: apisix
authParameter:
basicAuth:
value:
username: alice
password: alice-password
也可以在配置凭据时使用 Kubernetes Secret:
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: basic-auth-primary
data:
username: YWxpY2U=
password: YWxpY2UtcGFzc3dvcmQ=
---
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: alice
spec:
ingressClassName: apisix
authParameter:
basicAuth:
secretRef:
name: basic-auth-primary
❶ 对用户名 alice 进行 Base64 编码。
❷ 对密码 alice-password 进行 Base64 编码。
将配置应用到集群:
kubectl apply -f consumer-cred.yaml
验证
参阅为 API 启用 Basic Authentication,在服务级别启用 Basic Auth 插件。
然后按照验证 Basic Authentication的说明进行验证。
配置不同类型的身份认证凭据
消费者可以具有多个不同类型的凭据,但已发布服务中的每条路由只应配置一个身份认证插件。这样,消费者可以使用各自偏好的身份认证方式访问多条路由。
以下互动演示介绍如何使用 API7 企业版配置不同类型的身份认证凭据。
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击 + 新增消费者。
- 在对话框中,执行以下操作:
- 在名称字段中输入
John。 - 点击新增。
- 在凭据选项卡下点击新增 Key Authentication 凭据。
- 在对话框中,执行以下操作:
- 在名称字段中输入
key-auth。 - 在 Key 字段中输入
john-key-auth。 - 点击新增。
- 在凭据选项卡下选择 Basic Authentication,然后点击新增 Basic Authentication 凭据。
- 在对话框中,执行以下操作:
- 在名称字段中输入
basic-auth。 - 在用户名字段中输入
john。 - 在密码字段中输入
john-password。 - 点击新增。
- 在凭据选项卡下选择 JWT,然后点击新增 JWT 凭据。
- 在对话框中,执行以下操作:
- 在名称字段中输入
jwt-auth。 - 在 Key 字段中输入
john-jwt-key。 - 在算法字段中选择
RS256。 - 在公钥字段中输入你的公钥。
- 点击新增。
- 在凭据选项卡下选择 HMAC Authentication,然后点击新增 HMAC Authentication 凭据。
- 在对话框中,执行以下操作:
- 在名称字段中输入
hmac-auth。 - 在 Key ID 字段中输入
john-key。 - 在 Secret Key 字段中输入
john-hmac-key。 - 点击新增。
更新 ADC 配置,添加具有多种身份认证凭据的消费者 John:
consumers:
- username: John
credentials:
- config:
key: john-key-auth
name: key-auth
type: key-auth
- config:
password: john-password
username: john
name: basic-auth
type: basic-auth
- config:
algorithm: RS256
key: john-jwt-key
public_key: "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
name: jwt-auth
type: jwt-auth
- config:
key_id: john-key
secret_key: john-hmac-key
name: hmac-auth
type: hmac-auth
将配置同步到 API7 企业版:
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
为具有多种身份认证凭据的消费者 john 创建 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: john
spec:
gatewayRef:
name: apisix
credentials:
- type: key-auth
name: key-auth
config:
key: john-key-auth
- type: basic-auth
name: basic-auth
config:
username: john
password: john-password
- type: jwt-auth
name: jwt-auth
config:
key: john-jwt-key
algorithm: RS256
public_key: "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----"
- type: hmac-auth
name: hmac-auth
config:
key_id: john-key
secret_key: john-hmac-key
也可以在配置凭据时使用 Kubernetes Secret:
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: key-auth-john
data:
key: am9obi1rZXktYXV0aA==
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: basic-auth-john
data:
username: am9obg==
password: am9obi1wYXNzd29yZA==
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: jwt-auth-john
data:
key: am9obi1qd3Qta2V5
algorithm: UlMyNTY=
public_key: LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS1cbi4uLlxuLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0t
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: hmac-auth-john
data:
key_id: am9obi1rZXk=
secret_key: am9obi1obWFjLWtleQ==
---
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
namespace: api7
name: john
spec:
gatewayRef:
name: apisix
credentials:
- type: key-auth
name: key-auth-john
secretRef:
name: key-auth-john
- type: basic-auth
name: basic-auth-john
secretRef:
name: basic-auth-john
- type: jwt-auth
name: jwt-auth-john
secretRef:
name: jwt-auth-john
- type: hmac-auth
name: hmac-auth-john
secretRef:
name: hmac-auth-john
为具有多种身份认证凭据的消费者 john 创建 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: john
spec:
ingressClassName: apisix
authParameter:
keyAuth:
value:
key: john-key-auth
basicAuth:
value:
username: john
password: john-password
jwtAuth:
value:
key: john-jwt-key
algorithm: RS256
public_key: |
-----BEGIN PUBLIC KEY-----
...
-----END PUBLIC KEY-----
也可以在配置凭据时使用 Kubernetes Secret:
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: key-auth-john
data:
key: am9obi1rZXktYXV0aA==
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: basic-auth-john
data:
username: am9obg==
password: am9obi1wYXNzd29yZA==
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: jwt-auth-john
data:
key: am9obi1qd3Qta2V5
algorithm: UlMyNTY=
public_key: LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS1cbi4uLlxuLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0t
---
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: hmac-auth-john
data:
key_id: am9obi1rZXk=
secret_key: am9obi1obWFjLWtleQ==
---
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
namespace: api7
name: john
spec:
ingressClassName: apisix
authParameter:
keyAuth:
secretRef:
name: key-auth-john
basicAuth:
secretRef:
name: basic-auth-john
jwtAuth:
secretRef:
name: jwt-auth-john
hmacAuth:
secretRef:
name: hmac-auth-john
配置中的编码内容如下:
key-auth:- Key 为
john-key-auth
- Key 为
basic-auth:- 用户名为
john - 密码为
john-password
- 用户名为
jwt-auth:- Key 为
john-jwt-key - 算法为
RS256 - 公钥为
-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----,请替换为实际公钥并重新编码
- Key 为
hmac-auth- Key ID 为
john-key - Secret Key 为
john-hmac-key
- Key ID 为
将配置应用到集群:
kubectl apply -f consumer-cred.yaml