使用 Keycloak 配置 MinIO 身份验证

MinIO 部署

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

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

Keycloak 部署和 Realm 配置

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

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

安装和配置 mc 以访问 MinIO 集群

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

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

此过程假设已配置了 MinIO 集群的 别名。

1) 配置或创建用于访问 Keycloak 的客户端

认证到 Keycloak 管理控制台 并导航到 客户端。

选择 创建客户端 并按照说明为 MinIO 创建一个新的 Keycloak 客户端。按如下所示填写指定的输入

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

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

客户端范围允许 Keycloak 将用户属性作为身份验证请求中返回的 JSON Web 令牌 (JWT) 的一部分进行映射。这允许 MinIO 在将策略分配给用户时引用这些属性。此步骤创建支持 MinIO 授权（在 Keycloak 身份验证成功后）所需的客户端范围。

导航到 客户端范围 视图并为 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) 配置 MinIO 以使用 Keycloak 身份验证

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()
   

后续步骤

应用程序应使用其选择的 SDK 实现 STS AssumeRoleWithWebIdentity 流程。当 STS 凭据过期时，应用程序应具有逻辑来重新生成 JWT 令牌、STS 令牌和 MinIO 凭据，然后再重试并继续操作。

或者，用户可以通过 MinIO 控制台生成 访问密钥，以便使用其 Keycloak 凭据创建长期存在的 API 密钥式访问。

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

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

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

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

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

导航到 设置 并确保 身份验证流程 包括 Service accounts roles。

2) 验证 Admin API 访问权限

您可以使用 Admin REST API 和 MinIO 客户端凭据检索承载令牌和用户数据来验证功能

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 访问 Admin 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 Admin 支持

MinIO 支持多种配置 Keycloak Admin 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"