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

密钥

在本文档中,你将了解 API7 网关中**密钥(Secrets)密钥提供者(Secret Providers)**的基本概念,以及为什么你可能需要它们。

探索文档末尾的附加资源以获取有关相关主题的更多信息。

概览

**密钥(Secret)对象是需要保护以免受未经授权访问的一段敏感信息;而密钥提供者(Secret Provider)**对象用于设置与外部密钥管理器(HashiCorp Vault、AWS Secret Manager 等)的集成,以便 API7 网关可以在运行时动态建立连接并从密钥管理器中获取密钥。

通过将密钥存储在专用的密钥管理服务中,你可以:

  • 降低数据泄露风险:最大程度地减少 API7 网关内敏感信息的暴露。
  • 简化管理:集中存储和检索密钥,简化配置和维护。
  • 增强安全性:利用外部密钥管理器的高级安全功能和审计功能。
  • 提高合规性:确保遵守行业法规和数据保护最佳实践。

使用场景

保护消费者凭证

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

  • Key 认证凭证中的 key
  • Basic 认证凭证中的 password
  • JWT 认证凭证中的 secretpublic key
  • HMAC 认证凭证中的 secret key

有关详细教程,请参阅管理消费者凭证

保护插件配置中的敏感字段

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

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

例如,请参阅为 API 应用速率限制并在插件配置中使用密钥。

附加资源