使用 Keycloak 进行身份验证配置 MinIO

MinIO 部署

此过程假设运行 最新稳定版 MinIO 版本 的现有 MinIO 集群。有关新 MinIO 部署的更完整文档，请参阅 安装和部署 MinIO。

此过程可能适用于旧版本的 MinIO。

Keycloak 部署和 Realm 配置

此过程假设您拥有管理权限的现有 Keycloak 部署。具体来说，您必须有权在 Keycloak 部署上创建和配置 Realm、客户端、客户端范围、Realm 角色、用户和组。

此过程假设 Keycloak 和 MinIO 部署之间可以双向访问。

安装和配置 mc 并授予其访问 MinIO 集群的权限

此过程使用 mc 对 MinIO 集群执行操作。在具有访问集群网络的机器上安装 mc。

请参阅 mc 的 安装快速入门，了解有关下载和安装 mc 的说明。

此过程假设已为 MinIO 集群配置了 alias。

1) 配置或创建客户端以访问 Keycloak

对 Keycloak 管理控制台 进行身份验证，然后导航到 客户端。

选择 创建客户端，并按照说明为 MinIO 创建新的 Keycloak 客户端。填写以下指定的输入

Keycloak 会使用一组默认配置值来部署客户端。根据你的 Keycloak 设置和所需行为修改这些值。下表提供了一组用于配置的设置和值的基线。

2) 为 MinIO 客户端创建客户端范围

客户端范围允许 Keycloak 将用户属性作为 JSON Web 令牌 (JWT) 的一部分映射，该令牌在身份验证请求中返回。这允许 MinIO 在向用户分配策略时引用这些属性。此步骤创建了必要的客户端范围，以在成功完成 Keycloak 身份验证后支持 MinIO 授权。

导航到 客户端范围 视图并为 MinIO 授权创建一个新的客户端范围

创建后，从列表中选择范围，然后导航到 映射器。

选择 配置新映射器 以创建新的映射

创建后，将客户端范围分配给 MinIO 客户端。

1. 导航到 客户端 并选择 MinIO 客户端。

2. 选择 客户端范围，然后选择 添加客户端范围。

3. 选择之前创建的范围，并将 已分配类型 设置为 default。

3) 将必要的属性应用于 Keycloak 用户/组

你必须将名为 policy 的属性分配给 Keycloak 用户或组。将该值设置为 MinIO 部署中的任何 策略。

对于用户，导航到 用户 并选择或创建用户

对于组，导航到 组 并选择或创建组

你可以将用户分配到组，以便他们继承指定的 policy 属性。如果你将映射器设置设置为启用 聚合属性值，Keycloak 将聚合的策略数组作为已验证用户的 JWT 令牌的一部分包括在内。MinIO 在授权用户时可以使用此策略列表。

你可以使用 Keycloak API 测试用户的配置策略

curl -d "client_id=minio" \
     -d "client_secret=secretvalue" \
     -d "grant_type=password" \
     -d "username=minio-user-1" \
     -d "password=minio-user-1-password" \
     http://keycloak-url.example.net:8080/realms/REALM/protocol/openid-connect/token

如果成功，access_token 将包含使用 MinIO AssumeRoleWithWebIdentity STS API 生成 S3 凭据所需的 JWT。

你可以使用 JWT 解码器查看有效负载并确保它包含 policy 键，其中列出了一个或多个 MinIO 策略。

4) 为 Keycloak 身份验证配置 MinIO

MinIO 支持多种方法来配置 Keycloak 身份验证

• 使用 MinIO 控制台

• 使用终端/shell 和 mc idp openid 命令

• 使用在启动 MinIO 之前设置的环境变量

mc idp openid add ALIAS PRIMARY_IAM \
   client_id=MINIO_CLIENT \
   client_secret=MINIO_CLIENT_SECRET \
   config_url="https://keycloak-url.example.net:8080/realms/REALM/.well-known/openid-configuration" \
   display_name="SSO_IDENTIFIER"
   scopes="openid,email,preferred_username" \
   redirect_uri_dynamic="on"

MINIO_IDENTITY_OPENID_CONFIG_URL_PRIMARY_IAM="https://keycloak-url.example.net:8080/.well-known/openid-configuration"
MINIO_IDENTITY_OPENID_CLIENT_ID_PRIMARY_IAM="MINIO_CLIENT"
MINIO_IDENTITY_OPENID_CLIENT_SECRET_PRIMARY_IAM="MINIO_CLIENT_SECRET"
MINIO_IDENTITY_OPENID_DISPLAY_NAME_PRIMARY_IAM="SSO_IDENTIFIER"
MINIO_IDENTITY_OPENID_SCOPES_PRIMARY_IAM="openid,email,preferred_username"
MINIO_IDENTITY_OPENID_REDIRECT_URI_DYNAMIC_PRIMARY_IAM="on"

重新启动 MinIO 部署以使更改生效。

检查 MinIO 日志并验证启动是否成功，没有与 OIDC 配置相关的错误。

如果您尝试使用控制台登录，您现在应该看到一个使用配置的 显示名称 的 (SSO) 按钮。

指定一个已配置的用户并尝试登录。MinIO 应该会自动将您重定向到 Keycloak 登录入口。成功验证后，Keycloak 应该会将您重定向回 MinIO 控制台，使用原始控制台 URL *或* 配置的 重定向 URI。

5) 使用安全令牌服务 (STS) 生成应用程序凭据

使用与 S3 兼容的 SDK 的应用程序必须以访问密钥和密钥的形式指定凭据。MinIO AssumeRoleWithWebIdentity API 使用 Keycloak 验证后返回的 JWT 返回必要的临时凭据，包括必需的会话令牌。

您可以使用以下 HTTP 调用序列和 curl 实用程序测试此工作流程。

1. 以 Keycloak 用户身份进行身份验证并检索 JWT 令牌

   curl -X POST "https://keycloak-url.example.net:8080/realms/REALM/protocol/openid-connect/token" \
        -H "Content-Type: application/x-www-form-urlencoded" \
        -d "username=USER" \
        -d "password=PASSWORD" \
        -d "grant_type=password" \
        -d "client_id=CLIENT" \
        -d "client_secret=SECRET"
   

   • 将 USER 和 PASSWORD 替换为 REALM 上的 Keycloak 用户的凭据。

   • 将 CLIENT 和 SECRET 替换为 REALM 上特定于 MinIO 的 Keycloak 客户端的客户端 ID 和密钥。

   您可以使用 jq 或类似的 JSON 格式化实用程序处理结果。提取 access_token 字段以检索必要的访问令牌。注意 expires_in 字段以了解令牌过期前剩余的秒数。

2. 使用 AssumeRoleWithWebIdentity API 生成 MinIO 凭据

   curl -X POST "https://minio-url.example.net:9000" \
        -H "Content-Type: application/x-www-form-urlencoded" \
        -d "Action=AssumeRoleWithWebIdentity" \
        -d "Version=2011-06-15" \
        -d "DurationSeconds=86000" \
        -d "WebIdentityToken=TOKEN"
   

   将 TOKEN 替换为 Keycloak 返回的 access_token 值。

   API 成功返回包含以下键的 XML 文档

   • Credentials.AccessKeyId - Keycloak 用户的访问密钥

   • Credentials.SecretAccessKey - Keycloak 用户的密钥

   • Credentials.SessionToken - Keycloak 用户的会话令牌

   • Credentials.Expiration - 生成的凭据的过期日期

3. 测试凭据

   使用您喜欢的与 S3 兼容的 SDK 使用生成的凭据连接到 MinIO。

   例如，以下使用 MinIO Python SDK 的 Python 代码连接到 MinIO 部署并返回存储桶列表

   from minio import Minio
   
   client = MinIO(
      "minio-url.example.net:9000",
      access_key = "ACCESS_KEY",
      secret_key = "SECRET_KEY",
      session_token = "SESSION_TOKEN"
      secure = True
   )
   
   client.list_buckets()
   

下一步

应用程序应使用他们选择的 STS AssumeRoleWithWebIdentity 流。当 STS 凭据过期时，应用程序应该有逻辑到位以重新生成 JWT 令牌、STS 令牌和 MinIO 凭据，然后重试并继续操作。

或者，用户可以使用 MinIO 控制台生成 访问密钥，以便使用他们的 Keycloak 凭据创建持久性 API 密钥式访问。

1) 创建必要的客户端范围

导航到 客户端范围 视图并创建一个新的范围

导航到 客户端 并选择 MinIO 客户端

1. 从 服务帐户角色 中，选择 分配角色 并分配 admin 角色

2. 从 客户端范围 中，选择 添加客户端范围 并添加之前创建的范围

导航到 设置 并确保 身份验证流程 包含 服务 帐户 角色。

2) 验证管理员 API 访问

您可以使用具有 MinIO 客户端凭据的管理员 REST API 验证该功能，以检索承载令牌和用户数据。

1. 检索承载令牌

   curl -d "client_id=minio" \
        -d "client_secret=secretvalue" \
        -d "grant_type=password" \
        http://keycloak-url:port/admin/realms/REALM/protocol/openid-connect/token
   

2. 使用返回的值作为 access_token 访问管理员 API

   curl -H "Authentication: Bearer ACCESS_TOKEN_VALUE" \
        http://keycloak-url:port/admin/realms/REALM/users/UUID
   

   将 UUID 替换为您要检索的用户 的唯一 ID。响应应类似于以下内容

   {
      "id": "954de141-781b-4eaf-81bf-bf3751cdc5f2",
      "createdTimestamp": 1675866684976,
      "username": "minio-user-1",
      "enabled": true,
      "totp": false,
      "emailVerified": false,
      "firstName": "",
      "lastName": "",
      "attributes": {
         "policy": [
            "readWrite"
         ]
      },
      "disableableCredentialTypes": [],
      "requiredActions": [],
      "notBefore": 0,
      "access": {
         "manageGroupMembership": true,
         "view": true,
         "mapRoles": true,
         "impersonate": true,
         "manage": true
      }
   }
   

   如果返回的值具有 enabled: false 或 null（用户已从 Keycloak 中删除），MinIO 将撤销对经过身份验证用户的访问权限。

3) 在 MinIO 上启用 Keycloak 管理员支持

MinIO 支持多种方法来配置 Keycloak 管理员 API 支持

• 使用终端/shell 和 mc idp openid 命令

• 使用在启动 MinIO 之前设置的环境变量

mc idp openid update ALIAS KEYCLOAK_IDENTIFIER \
   vendor="keycloak" \
   keycloak_admin_url="https://keycloak-url:port/admin"
   keycloak_realm="REALM"

MINIO_IDENTITY_OPENID_VENDOR_PRIMARY_IAM="keycloak"
MINIO_IDENTITY_OPENID_KEYCLOAK_ADMIN_URL_PRIMARY_IAM="https://keycloak-url:port/admin"
MINIO_IDENTITY_OPENID_KEYCLOAK_REALM_PRIMARY_IAM="REALM"