引用 AWS Secrets Manager 中的密钥
AWS Secrets Manager 是一项完全托管的服务,你可以将其与 API7 Enterprise 集成,以安全地存储、管理和检索敏感信息,例如 API 密钥、密码和其他类型的凭据。它允许自动轮换密钥,从而降低凭据随时间推移而暴露的风险。
本教程演示了如何将 API7 Enterprise 与 AWS Secrets Manager 集成,使你能够安全地存储和引用消费者凭据和插件配置。
以下互动演示介绍如何使用 API7 Enterprise 在 AWS Secrets Manager 中存储和获取 key-auth 密钥。
前提条件
- 安装 API7 Enterprise。
- 在你的网关组中至少有一个网关实例。
- 拥有一个 AWS 账户,以访问 IAM 和 Secrets Manager 模块。
获取 IAM 访问密钥 ID 和 Secret 访问密钥
获取 IAM 用户访问密钥和 Secret 访问密钥,这些密钥将在下一步中配置到 API7 Enterprise 中以访问 AWS Secrets Manager。
请确保相应的权限已正确分配给用户,从而避免因权限不足导致验证失败的情况。
在网关组中新增 Secret 提供商
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的Secret 提供商,然后点击新增 Secret 提供商。
- 在对话框中,执行以下操作:
- Secret 提供商 ID ,输入
my-secrets-manager。 - Secret 管理服务,选择
AWS Secrets Manager。 - 区域,选择你的 AWS Secrets Manager 服务所在的区域。例如,
us-east-1。 - 使用上一步中获取的访问密钥和 Secret 访问密钥填写访问密钥 ID 和Secret 访问密钥字段。
- 点击新增。
- 复制 Secret 变量以供后续引用。所有密钥引用均由该变量生成,例如
$secret://aws/my-secrets-manager/$secret_name/$key。
不适用。
API7 Ingress Controller 目前不支持 Secret 提供商。
引用密钥配置 SSL 证书
SSL 证书对象中的敏感字段 certificate 和 private key 可以安全地存储在外部 Secret 管理服务(例如 HashiCorp Vault 或 AWS Secret Manager)中,并在 API7 网关中引用。
在 AWS Secrets Manager 中创建密钥
本节介绍如何创建密钥以存储用户 alice 的消费者凭据。你也可以参阅创建 AWS Secrets Manager 密钥。
- 在控制台中导航到 AWS Secrets Manager 并创建一个密钥。选择 Other type of secret 作为密钥类型,并在键值对中输入键名
crt和 base64 值。 - 在下一步中,将密钥名称配置为
ssl,并可选择添加描述。 - 点击下一步查看其余信息并完成密钥创建。你应该会在 AWS Secrets Manager 中看到创建好的密钥。
- 重复创建步骤,创建另一个键/值对:
private-key: {private key base64}。
新增 SSL 证书
- 从侧边栏选择网关组的证书,进入 SSL 证书选项卡。
- 点击新增 SSL 证书。
- 在对话框中,执行以下操作:
- 在名称字段中输入
Test SSL Certificate。 - 在证书字段中输入
$secret://aws/my-secrets-manager/ssl/crt。 - 在私钥字段中输入
$secret://aws/my-secrets-manager/ssl/private-key。 - 点击新增。
所有密钥引用均由 Secret 提供商的 Secret 变量生成:$secret://aws/my-secrets-manager/$secret_name/$key。
- 有关 SSL 证书的完整使用和验证步骤,请参阅在客户端与 API7 网关之间配置 mTLS。
引用密钥以创建消费者凭据
消费者凭据中的以下敏感字段可以存储在外部 Secret 管理服务(HashiCorp Vault、AWS Secrets Manager 等)中,并在 API7 Enterprise 中引用:
- Key Authentication 凭据中的
key - Basic Authentication 凭据中的
password - JWT 认证凭据中的
secret、public key - HMAC 认证凭据中的
secret_key
新增消费者
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 点击新增消费者。
- 在对话框中,执行以下操作:
- 名称,输入
Alice。 - 点击新增。
要使用 ADC 创建消费者,请添加以下配置:
consumers:
- username: Alice
API7 Ingress Controller 目前不支持 Secret 提供商。
在 AWS Secrets Manager 中创建密钥
本节介绍如何创建密钥以存储用户 alice 的消费者凭据。你也可以参阅创建 AWS Secrets Manager 密钥。
- 在控制台中导航到 AWS Secrets Manager 并创建一个密钥。选择 Other type of secret 作为密钥类型,并在键值对中输入键
alice-key-auth和值alice-key。 - 在下一步中,将密钥名称配置为
alice-credentials,并可选择新增描述。 - 点击下一步查看其余信息并完成密钥创建。你应该会在 AWS Secrets Manager 中看到创建好的密钥。
- 重复创建步骤,使用以下键/值对创建其他消费者凭据:
- Basic Authentication 凭据:
password: alice-password。 - JWT 认证凭据:
secret: alice-secret。 - HMAC 认证凭据:
secret-key: alice-secret-key。
新增 Key Authentication 凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 选择你的目标消费者,例如,
Alice。 - 凭据选项卡下,点击新增 Key Authentication 凭据。
- 在对话框中,执行以下操作:
- 名称,输入
primary-key。 - Key,输入
$secret://aws/my-secrets-manager/alice-credentials/alice-key-auth。 - 点击新增。
要使用 ADC 创建具有 key-auth 凭据的消费者,请更新配置:
consumers:
- username: Alice
credentials:
- name: primary-key
type: key-auth
config:
key: $secret://aws/my-secrets-manager/alice-credentials/alice-key-auth
API7 Ingress Controller 目前不支持 Secret 提供商。
新增 Basic Authentication 凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 选择你的目标消费者,例如,
Alice。 - 凭据选项卡下,点击Basic Authentication选项卡,然后点击新增 Basic Authentication 凭据。
- 在对话框中,执行以下操作:
- 名称,输入
primary-basic。 - 用户名,输入
alice。 - 密码,输入
$secret://aws/my-secrets-manager/alice-credentials/password。 - 点击新增。
要使用 ADC 创建具有 basic-auth 凭据的消费者,请更新配置:
consumers:
- username: Alice
credentials:
- name: primary-basic
type: basic-auth
config:
password: $secret://aws/my-secrets-manager/alice-credentials/password
username: Alice
API7 Ingress Controller 目前不支持 Secret 提供商。
新增 JWT 认证凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 选择你的目标消费者,例如,
Alice。 - 凭据选项卡下,点击JWT选项卡,然后点击新增 JWT 凭据。
- 在对话框中,执行以下操作:
- 名称,输入
primary-jwt。 - Key,输入
alice-key。 - 算法,选择
HS256。 - Secret,输入
$secret://aws/my-secrets-manager/alice-credentials/secret。 - 点击新增。
要使用 ADC 创建具有 jwt-auth 凭据的消费者,请更新配置:
consumers:
- username: Alice
credentials:
- name: primary-jwt
type: jwt-auth
config:
algorithm: HS256
key: alice-key
secret: $secret://aws/my-secrets-manager/alice-credentials/secret
API7 Ingress Controller 目前不支持 Secret 提供商。
新增 HMAC 认证凭据
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的消费者。
- 选择你的目标消费者,例如,
Alice。 - 凭据选项卡下,点击HMAC 认证选项卡,然后点击新增 HMAC 认证凭据。
- 在对话框中,执行以下操作:
- 名称,输入
primary-hmac。 - Key ID ,输入
alice-keyid。 - Secret Key,输入
$secret://aws/my-secrets-manager/alice-credentials/secret-key。 - 点击新增。
要使用 ADC 创建具有 hmac-auth 凭据的消费者,请更新配置:
consumers:
- username: Alice
credentials:
- name: primary-hmac
type: hmac-auth
config:
key_id: alice-keyid
secret_key: $secret://aws/my-secrets-manager/alice-credentials/secret-key
API7 Ingress Controller 目前不支持 Secret 提供商。
验证
有关说明,请参阅为 API 启用 Key Authentication,并在服务级别启用 Key Auth 插件。
使用有效凭据向该路由发送请求:
curl -i "http://127.0.0.1:9080/ip" -H 'apikey: alice-key'
你应该收到 HTTP/1.1 200 OK 的响应。
alice-key 是你在 AWS Secrets Manager 中创建的键值对的值,而不是键名。
- 使用
password: alice-password验证 Basic Authentication 凭据。 - 使用
secret: alice-secret验证 JWT 认证凭据。 - 使用
secret-key: alice-secret-key验证 HMAC 认证凭据。
引用密钥以启用插件
插件配置中的以下敏感字段可以存储在外部 Secret 管理服务(HashiCorp Vault、AWS Secrets Manager 等)中,并在 API7 网关中引用:
| 插件 | 字段 |
|---|---|
| Limit Count | redis_username、redis_password |
| Authz-Casdoor | client_id、client_secret |
| Wolf RBAC | appid |
| LDAP 认证 | user_dn |
本节以配置 limit-count 插件为例。
创建密钥
在你的 AWS Secrets Manager 中,使用键/值对 username:api7 和 password:redis-api7 在密钥名称 redis 下创建密钥。
配置 Limit Count 插件
有关 limit-count 插件的启用位置和方式,请参阅为 API 配置限流。
- 控制台
- ADC
- Ingress Controller
将以下配置新增到JSON 编辑器:
{
"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://aws/my-secrets-manager/redis/username",
"redis_password": "$secret://aws/my-secrets-manager/redis/password",
"redis_database": 1,
"redis_timeout": 1001,
"allow_degradation": false,
"show_limit_quota_header": true
}
以下示例仅包含插件配置,无法作为完整配置文件进行同步。有关使用 ADC 启用 Limit Count 插件的位置和方式,请参阅为 API 配置限流。
limit-count:
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://aws/my-secrets-manager/redis/username
redis_password: $secret://aws/my-secrets-manager/redis/password
redis_database: 1
redis_timeout: 1001
allow_degradation: false
show_limit_quota_header: true
API7 Ingress Controller 目前不支持 Secret 提供商。