跳到主要内容
版本:3.8.x

引用 Kubernetes Secret 中的密钥

Kubernetes Secret 是存储密码、API Key 和 Token 等敏感数据的对象。它们可以作为 Pod 中的环境变量暴露,也可以作为密钥提供程序集成,以增强 API 安全性。

本教程演示如何将 Kubernetes 作为密钥提供程序与 API7 企业版 集成,以便安全地存储并引用 Kubernetes Secret 中的消费者凭证和插件配置。如果你使用 Ingress Controller,则无需将 Kubernetes 添加为密钥提供程序即可使用 Kubernetes Secret。

前提条件​

  1. 安装 API7 企业版。
  2. 确保网关组中至少有一个网关实例。
  3. 准备 Kubernetes 集群以存储密钥。
  4. 安装 cURL,以便向服务发送验证请求。

在网关组中添加密钥提供程序​

  1. 在侧边导航栏中选择网关组的 Secret Providers,然后点击 Add Secret Provider。
  2. 在对话框中执行以下操作:
  • 在 Secret Provider ID 字段中输入 my-kubernetes-secret。
  • 在 Secret Manager 字段中选择 Kubernetes。
  • 填写 API Server Address 字段,例如 http://127.0.0.1。
  • 填写 Token 字段。
  • 点击 Add。
  1. 复制 Secret Variable 以供后续使用。所有密钥引用均由其生成,例如 $secret://kubernetes/my-kubernetes-secret/$namespace/$secret_name/$key。

在 SSL 证书中引用密钥​

SSL 证书对象中的敏感字段 certificate 和 private key 可以安全地存储在外部密钥管理器(例如 HashiCorp Vault、AWS Secret Manager 或 Kubernetes Secret)中,并在 API7 Gateway 中引用。

存储密钥​

创建用于 SSL Secret 的 Kubernetes 清单文件:

ssl-secret.yaml
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: my-kubernetes-secret
type: kubernetes.io/tls
data: # Must use base64 value
tls.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNVakNDQWJzQ0FnMytNQTBHQ1NxR1NJYjNE
UUVCQlFVQU1JR2JNUXN3Q1FZRFZRUUdFd0pLVURFT01Bd0cKQTFVRUNCTUZWRzlyZVc4eEVEQU9C
Z05WQkFjVEIwTm9kVzh0YTNVeEVUQVBCZ05WQkFvVENFWnlZVzVyTkVSRQpNUmd3RmdZRFZRUUxF
dzlYWldKRFpYSjBJRk4xY0hCdmNuUXhHREFXQmdOVkJBTVREMFp5WVc1ck5FUkVJRmRsCllpQkRR
VEVqTUNFR0NTcUdTSWIzRFFFSkFSWVVjM1Z3Y0c5eWRFQm1jbUZ1YXpSa1pDNWpiMjB3SGhjTk1U
TXcKTVRFeE1EUTFNVE01V2hjTk1UZ3dNVEV3TURRMU1UTTVXakJMTVFzd0NRWURWUVFHREFKS1VE
RVBNQTBHQTFVRQpDQXdHWEZSdmEzbHZNUkV3RHdZRFZRUUtEQWhHY21GdWF6UkVSREVZTUJZR0Ex
VUVBd3dQZDNkM0xtVjRZVzF3CmJHVXVZMjl0TUlHYU1BMEdDU3FHU0liM0RRRUJBUVVBQTRHSUFE
Q0JoQUo5WThFaUhmeHhNL25PbjJTbkkxWHgKRHdPdEJEVDFKRjBReTliMVlKanV2YjdjaTEwZjVN
Vm1UQllqMUZTVWZNOU1vejJDVVFZdW4yRFljV29IcFA4ZQpqSG1BUFVrNVd5cDJRN1ArMjh1bklI
QkphVGZlQ09PekZSUFY2MEdTWWUzNmFScG04L3dVVm16eGFLOGtCOWVaCmhPN3F1TjdtSWQxL2pW
cTNKODhDQXdFQUFUQU5CZ2txaGtpRzl3MEJBUVVGQUFPQmdRQU1meTQzeE15OHh3QTUKVjF2T2NS
OEtyNWNaSXdtbFhCUU8xeFEzazlxSGtyNFlUY1JxTVQ5WjVKTm1rWHYxK2VSaGcwTi9WMW5NUTRZ
RgpnWXcxbnlESnBnOTduZUV4VzQyeXVlMFlHSDYyV1hYUUhyOVNVREgrRlowVnQvRGZsdklVTWRj
UUFEZjM4aU9zCjlQbG1kb3YrcE0vNCs5a1h5aDhSUEkzZXZ6OS9NQT09Ci0tLS0tRU5EIENFUlRJ
RklDQVRFLS0tLS0K
tls.key: RXhhbXBsZSBkYXRhIGZvciB0aGUgVExTIGNydCBmaWVsZA==

然后将其应用到 Kubernetes 集群:

kubectl apply -f ssl-secret.yaml

添加 SSL 证书​

  1. 在侧边导航栏中选择网关组的 Certificates,然后进入 SSL Certificates 标签页。
  2. 点击 Add SSL Certificate。
  3. 在对话框中执行以下操作:
  • 在 Name 字段中输入 Test SSL Certificate。
  • 在 Certificate 字段中输入 $secret://kubernetes/my-kubernetes-secret/api7/ssl/tls.crt。
  • 在 Private Key 字段中输入 $secret://kubernetes/my-kubernetes-secret/api7/ssl/tls.key。
  • 点击 Add。
  1. 如需完整使用和验证 SSL 证书,请参阅在客户端和 API7 Gateway 之间配置 mTLS。

引用密钥创建消费者凭证​

消费者凭证中的以下敏感字段可以存储在外部密钥管理器(HashiCorp Vault、AWS Secret Manager 或 Kubernetes Secret)中,并在 API7 Gateway 中引用:

  • Key Authentication 凭证中的 key
  • Basic Authentication 凭证中的 password
  • JWT Authentication 凭证中的 secret、public key
  • HMAC Authentication 凭证中的 secret key

添加消费者​

  1. 在侧边导航栏中选择网关组的 Consumers。
  2. 点击 Add Consumer。
  3. 在对话框中执行以下操作:
  • 在 Name 字段中输入 Alice。
  • 点击 Add。

存储密钥​

创建用于消费者 Alice 的密钥的 Kubernetes 清单文件:

alice-secret.yaml
apiVersion: v1
kind: Secret
metadata:
namespace: api7
name: alice
type: Opaque
stringData:
key: alice-key # for key auth
username: alice # for basic auth
password: alice-password # for basic auth
secret: alice-secret # for JWT auth
secret_key: alice-secret-key # for HMAC auth

然后将其应用到 Kubernetes 集群:

kubectl apply -f alice-secret.yaml

添加 Key Authentication 凭证​

  1. 在侧边导航栏中选择网关组的 Consumers。
  2. 选择目标消费者,例如 Alice。
  3. 在 Credentials 标签页中点击 Add Key Authentication Credential。
  4. 在对话框中执行以下操作:
  • 在 Name 字段中输入 primary-key。
  • 在 Key 字段中输入 $secret://kubernetes/my-kubernetes-secret/api7/alice/key。
  • 点击 Add。

添加 Basic Authentication 凭证​

  1. 在侧边导航栏中选择网关组的 Consumers。
  2. 选择目标消费者,例如 Alice。
  3. 在 Credentials 标签页中点击 Basic Authentication 标签页,然后点击 Add Basic Authentication Credential。
  4. 在对话框中执行以下操作:
  • 在 Name 字段中输入 primary-basic。
  • 在 Username 字段中输入 Alice。
  • 在 Password 字段中输入 $secret://kubernetes/my-kubernetes-secret/api7/alice/password。
  • 点击 Add。

添加 JWT Authentication 凭证​

  1. 在侧边导航栏中选择网关组的 Consumers。
  2. 选择目标消费者,例如 Alice。
  3. 在 Credentials 标签页中点击 JWT 标签页,然后点击 Add JWT Credential。
  4. 在对话框中执行以下操作:
  • 在 Name 字段中输入 primary-jwt。
  • 在 Key 字段中输入 alice-key。
  • 在 Algorithm 字段中选择 HS256。
  • 在 Secret 字段中输入 $secret://kubernetes/my-kubernetes-secret/api7/alice/secret。
  • 点击 Add。

添加 HMAC Authentication 凭证​

  1. 在侧边导航栏中选择网关组的 Consumers。
  2. 选择目标消费者,例如 Alice。
  3. 在 Credentials 标签页中点击 HMAC Authentication 标签页,然后点击 Add HMAC Authentication Credential。
  4. 在对话框中执行以下操作:
  • 在 Name 字段中输入 primary-hmac。
  • 在 Key ID 字段中输入 alice-keyid。
  • 在 Secret Key 字段中输入 $secret://kubernetes/my-kubernetes-secret/api7/alice/secret-key。
  • 点击 Add。

验证消费者凭证​

验证 Key Authentication​

参阅为 API 启用 Key Authentication,在服务级别启用 key-auth 插件,然后按照验证 Key Authentication进行验证。

验证 Basic Authentication​

参阅为 API 启用 Basic Authentication,在服务级别启用 basic-auth 插件,然后按照验证 Basic Authentication进行验证。

验证 JWT Authentication​

参阅为 API 启用 JWT Authentication,在服务级别启用 jwt-auth 插件,然后按照验证 JWT Authentication进行验证。

验证 HMAC Authentication​

参阅为 API 启用 HMAC Authentication,在服务级别启用 hmac-auth 插件,然后按照验证 HMAC Authentication进行验证。

引用密钥启用插件​

插件配置中的以下敏感字段可以存储在外部密钥管理器(HashiCorp Vault、AWS Secret Manager 或 Kubernetes Secret)中,并在 API7 Gateway 中引用:

插件字段
Limit Countredis_username, redis_password
Authz-Casdoorclient_id, client_secret
Wolf RBACappid
LDAP Authenticationuser_dn

本节以配置 Limit Count 插件为例。

存储密钥​

创建用于 Redis 用户名和密码的 Kubernetes 清单文件:

redis-secret.yaml
apiVersion: v1
kind: Secret
metadata:
namespace: api7
namespace: api7
name: redis
type: Opaque
stringData:
username: api7
password: redis-api7

然后将其应用到 Kubernetes 集群:

kubectl apply -f redis-secret.yaml

配置 Limit Count 插件​

有关在哪里以及如何启用 Limit Count 插件,请参阅为 API 应用限流。

在 JSON Editor 中添加以下配置:

{
"count": 3,
"time_window": 60,
"key_type": "var",
"rejected_code": 429,
"rejected_msg": "Too many requests",
"key": "remote_addr",
"policy": "redis",
"redis_host": "127.0.0.1",
"redis_port": 6379,
"redis_username": "$secret://kubernetes/my-kubernetes-secret/api7/redis/username",
"redis_password": "$secret://kubernetes/my-kubernetes-secret/api7/redis/password",
"redis_database": 1,
"redis_timeout": 1001,
"allow_degradation": false,
"show_limit_quota_header": true
}

其他资源​