使用 Keycloak 設定 MinIO 的身份驗證

MinIO Kubernetes Operator

確保您的目標 Kubernetes 叢集已正確且可正常運作地安裝 MinIO Kubernetes Operator。此文件假設使用最新的穩定 Operator 版本 6.0.4。

MinIO 租戶

此程序假設您的 Kubernetes 叢集有足夠的資源來部署新的 MinIO 租戶。

您也可以將此程序作為修改現有 MinIO 租戶以啟用 Keycloak 身份管理的指南。

Keycloak 部署和領域設定

此程序假設存在現有的 Keycloak 部署，您對該部署具有管理存取權限。具體而言，您必須具有在 Keycloak 部署上建立和設定領域、用戶端、用戶端範圍、領域角色、使用者和群組的權限。

對於與 MinIO 租戶位於相同 Kubernetes 叢集內的 Keycloak 部署，此程序假設 Keycloak 和 MinIO Pod/服務之間具有雙向存取權。

對於 Kubernetes 叢集外部的 Keycloak 部署，此程序假設存在一個現有的 Ingress、負載平衡器或類似的 Kubernetes 網路控制元件，用於管理進出 MinIO 租戶的網路存取。

安裝並設定 mc 以存取 MinIO 叢集

此程序使用 mc 來對 MinIO 叢集執行操作。在具有叢集網路存取權的機器上安裝 mc。

您的本機主機必須可以存取 MinIO 租戶，例如透過 Ingress、負載平衡器或類似的 Kubernetes 網路控制元件。

請參閱 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-service.keycloak-namespace.svc.cluster-domain.example/realms/REALM/protocol/openid-connect/token

如果成功，access_token 包含使用 MinIO AssumeRoleWithWebIdentity STS API 並產生 S3 憑證所需的 JWT。

您可以使用 JWT 解碼器來檢閱有效負載，並確保它包含具有列出一個或多個 MinIO 原則的 policy 索引鍵。

4) 設定 MinIO 以進行 Keycloak 驗證

MinIO 支援多種設定 Keycloak 驗證的方法

• 使用 MinIO 租戶主控台

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

kubectl describe svc/TENANT_NAME-console -n TENANT_NAMESPACE

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

重新啟動 MinIO 部署以套用變更。

檢查 MinIO 日誌，並確認啟動成功且沒有與 OIDC 設定相關的錯誤。

如果您嘗試使用 Console 登入，您現在應該會看到一個 (SSO) 按鈕，其使用已設定的 顯示名稱。

指定已設定的使用者並嘗試登入。MinIO 應該會自動將您重新導向至 Keycloak 登入入口。成功驗證後，Keycloak 應該會將您重新導向回 MinIO Console，使用原始 Console URL *或*已設定的 重新導向 URI。

5) 使用安全權杖服務 (STS) 產生應用程式憑證

使用與 S3 相容的 SDK 的應用程式必須以存取金鑰和密碼金鑰的形式指定憑證。MinIO 的 AssumeRoleWithWebIdentity API 會傳回必要的臨時憑證，包括使用 Keycloak 在驗證後傳回的 JWT 所需的工作階段權杖。

您可以使用以下 HTTP 呼叫順序和 curl 公用程式來測試此工作流程

1. 以 Keycloak 使用者身分驗證並擷取 JWT 權杖

   curl -X POST "https://keycloak-service.keycloak-namespace.svc.cluster-domain.example/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.minio-tenant.svc.cluster-domain.example" \
        -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.minio-tenant.svc.cluster-domain.example",
      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 Console 產生 存取金鑰，以便使用其 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"