5.2. 使用 Red Hat Single Sign-On 配置 Apicurio Registry 身份验证和授权
本节介绍如何为 Apicurio Registry 和 Red Hat Single Sign-On 手动配置身份验证和授权选项。
另外,有关如何自动配置这些设置的详情,请参考 第 5.1 节 “使用 Red Hat Single Sign-On Operator 保护 Apicurio Registry”。
Apicurio Registry web 控制台和核心 REST API 支持基于 OAuth 和 OpenID Connect (OIDC)的 Red Hat Single Sign-On 中的身份验证。相同的 Red Hat Single Sign-On 域和用户在 Apicurio Registry web 控制台和使用 OpenID Connect 中联合,以便您只需要一组凭证。
Apicurio Registry 为默认的 admin、write 和 read-only 用户角色提供基于角色的授权。Apicurio Registry 在 schema 或 API 级别提供基于内容的授权,其中只有 registry 工件的创建者才可以更新或删除它。Apicurio Registry 身份验证和授权设置默认禁用。
前提条件
- Red Hat Single Sign-On 已安装并运行。如需了解更多详细信息,请参阅 Red Hat Single Sign-On 用户文档。
- Apicurio Registry 已安装并运行。
流程
-
在 Red Hat Single Sign-On Admin 控制台中,为 Apicurio Registry 创建 Red Hat Single Sign-On 域。默认情况下,Apicurio Registry 需要一个
registry的域名称。有关创建域的详情,请查看 Red Hat Single Sign-On 用户文档。 为 Apicurio Registry API 创建 Red Hat Single Sign-On 客户端。默认情况下,Apicurio Registry 需要以下设置:
-
客户端 ID:
registry-api -
客户端协议 :
openid-connect 访问类型 :
bearer-only您可以将默认值用于其他客户端设置。
注意如果您使用 Red Hat Single Sign-On 服务帐户,客户端的 Access Type 必须是
confidential而不是bearer-only。
-
客户端 ID:
为 Apicurio Registry web 控制台创建一个 Red Hat Single Sign-On 客户端。默认情况下,Apicurio Registry 需要以下设置:
-
客户端 ID:
apicurio-registry -
客户端协议 :
openid-connect -
访问类型 :
public -
有效的重定向 URL:
http://my-registry-url:8080/* Web Origins:
+您可以将默认值用于其他客户端设置。
-
客户端 ID:
在 OpenShift 上的 Apicurio Registry 部署中,设置以下 Apicurio Registry 环境变量来使用 Red Hat Single Sign-On 配置身份验证:
Expand 表 5.2. 使用红帽单点登录配置 Apicurio Registry 身份验证 环境变量 描述 类型 默认 AUTH_ENABLED为 Apicurio Registry 启用身份验证。当设置为
true时,使用 Red Hat Single Sign-On 进行身份验证需要遵循的环境变量。字符串
falseKEYCLOAK_URLRed Hat Single Sign-On 身份验证服务器的 URL。例如:
http://localhost:8080。字符串
-
KEYCLOAK_REALMRed Hat Single Sign-On 域用于身份验证。例如,
registry。字符串
-
KEYCLOAK_API_CLIENT_IDApicurio Registry REST API 的客户端 ID。
字符串
registry-apiKEYCLOAK_UI_CLIENT_IDApicurio Registry web 控制台的客户端 ID。
字符串
apicurio-registry提示有关在 OpenShift 中设置环境变量的示例,请参阅 第 6.1 节 “在 OpenShift 上配置 Apicurio Registry 健康检查”。
将以下选项设置为
true,以在 Red Hat Single Sign-On 中启用 Apicurio Registry 用户角色:Expand 表 5.3. 配置 Apicurio Registry 基于角色的授权 环境变量 Java 系统属性 类型 默认值 ROLE_BASED_AUTHZ_ENABLEDregistry.auth.role-based-authorization布尔值
false启用 Apicurio Registry 用户角色时,您必须将 Apicurio Registry 用户分配给 Red Hat Single Sign-On 域中至少以下默认用户角色之一:
Expand 表 5.4. 用于 registry 身份验证和授权的默认用户角色 角色 读取工件 编写工件 全局规则 概述 sr-admin是
是
是
完全访问所有创建、读取、更新和删除操作。
sr-developer是
是
否
除了配置全局规则外,访问创建、读取、更新和删除操作。此角色可以配置特定于工件的规则。
sr-readonly是
否
否
只能访问读取和搜索操作。此角色无法配置任何规则。
将以下内容设置为
true,以启用仅限所有者的授权,以更新到 Apicurio Registry 中的 schema 和 API 工件:Expand 表 5.5. 配置仅所有者授权 环境变量 Java 系统属性 类型 默认值 REGISTRY_AUTH_OBAC_ENABLEDregistry.auth.owner-only-authorization布尔值
false