文件

OpenID Connect 存取管理

MinIO 支援使用與 OpenID Connect (OIDC) 相容的身分識別提供者 (IDP),例如 Okta、KeyCloak、Dex、Google 或 Facebook 來進行使用者身分識別的外部管理。

對於由外部 OpenID Connect (OIDC) 相容提供者管理的身分識別,MinIO 可以使用兩種方法之一來將政策指派給已驗證的使用者。

  1. 使用作為 OIDC 驗證流程一部分傳回的 JSON Web Token 宣告來識別要指派給已驗證使用者的 政策

  2. 使用授權請求中指定的 RoleArn 來指派附加到提供者 RolePolicy 的政策。

MinIO 預設拒絕存取未經使用者已指派或繼承的 政策 明確允許的所有動作或資源。由 OIDC 提供者管理的使用者必須指定必要的政策作為 JWT 宣告的一部分。如果使用者 JWT 宣告沒有符合的 MinIO 政策,則該使用者沒有權限存取 MinIO 部署上的任何動作或資源。

MinIO 尋找的特定宣告是作為使用 OIDC 身分識別管理部署叢集的一部分進行設定的。此頁面重點在建立 MinIO 政策以符合已設定的 OIDC 宣告。

驗證和授權流程

MinIO 支援兩種 OIDC 驗證和授權流程

  1. RolePolicy 流程會在 MinIO 組態中設定已驗證使用者的已指派政策。

    MinIO 建議使用 RolePolicy 方法向 OpenID 提供者驗證。

  2. JWT 流程會在 OIDC 組態中設定已驗證使用者的已指派政策。

MinIO 支援多個 OIDC 提供者組態。但是,每個部署您只能設定 一個 基於 JWT 宣告的 OIDC 提供者。所有其他提供者都必須使用 RolePolicy。

RolePolicy 和 RoleArn

使用 RolePolicy,所有使用給定 RoleArn 產生 STS 憑證的用戶端都會收到與該 RoleArn 的 RolePolicy 組態相關聯的 政策或政策

您可以使用 OpenID 政策變數來建立以程式方式管理每個個別使用者有權存取的內容的政策。

使用 OIDC 憑證和 RolePolicy 宣告流程的應用程式的登入流程如下

  1. 建立 OIDC 組態。

  2. 在建立時或在 MinIO 啟動時記錄指派給組態的 RoleArn。將此 RoleArn 與 AssumeRoleWithWebIdentity STS API 一起使用。

  3. 建立要與 RoleArn 一起使用的 RolePolicy。使用 MINIO_IDENTITY_OPENID_ROLE_POLICY 環境變數或 identity_openid role_policy 組態設定來定義要用於提供者的政策清單

  4. 使用者在登入 MinIO 時選取已設定的 OIDC 提供者。

  5. 使用者完成向已設定的 OIDC 提供者的驗證,並重新導向回 MinIO。

    MinIO 僅支援 OpenID 授權碼流程。不支援使用隱含流程的驗證。

  6. MinIO 會驗證 API 呼叫中的 RoleArn,並檢查要使用的 RolePolicy。任何帶有 RoleArn 的身份驗證請求都會收到相同的政策存取權限。

  7. MinIO 會在 STS API 回應中以存取金鑰、密碼金鑰和會話權杖的形式傳回臨時憑證。這些憑證的權限會與 RolePolicy 中指定的政策相符。

  8. 應用程式會使用 STS 端點傳回的臨時憑證,在 MinIO 上執行經過身份驗證的 S3 操作。

JSON Web Token 宣告

使用 JSON Web Token 可讓您個別指派政策。然而,使用 Web Token 也會增加為不同宣告管理多個政策的成本。

使用 OIDC 憑證的應用程式搭配 JSON Web Token 宣告流程的登入流程如下:

  1. 向已設定的 OIDC 提供者進行身份驗證,並擷取 JSON Web Token (JWT)

    MinIO 僅支援 OpenID 授權碼流程。不支援使用隱含流程的驗證。

  2. JWT 指定給 MinIO 安全性權杖服務 (STS) AssumeRoleWithWebIdentity API 端點。

    MinIO 會針對已設定的 OIDC 提供者驗證 JWT

    如果 JWT 有效,MinIO 會檢查是否有 宣告,其中指定要指派給已驗證使用者的一或多個 政策 的清單。MinIO 預設會檢查 policy 宣告。

  3. MinIO 會在 STS API 回應中以存取金鑰、密碼金鑰和會話權杖的形式傳回臨時憑證。這些憑證的權限會與 JWT 宣告中指定的政策相符。

  4. 應用程式會使用 STS 端點傳回的臨時憑證,在 MinIO 上執行經過身份驗證的 S3 操作。

MinIO 提供範例 Go 應用程式 web-identity.go,可處理完整的登入流程。

OIDC 使用者也可以建立 存取金鑰。存取金鑰是長期有效的憑證,可繼承其父使用者的權限。父使用者可以在建立存取金鑰時進一步限制這些權限。若要建立新的存取金鑰,請使用 OIDC 管理的使用者憑證登入 MinIO 主控台。從左側導覽的 身分 區段中,選取 存取金鑰,然後按下 建立存取金鑰 + 按鈕。

識別 JWT 宣告值

MinIO 會使用 OIDC 身份驗證流程中傳回的 JWT 權杖,來識別要指派給已驗證使用者的特定政策。

您可以使用 JWT 除錯工具來解碼傳回的 JWT 權杖,並驗證使用者屬性是否包含必要的宣告。

請參閱 RFC 7519:JWT 宣告,以取得有關 JWT 宣告的更多資訊。

請參閱您偏好的 OIDC 提供者的文件,以取得設定使用者宣告的相關指示。

建立符合宣告的政策

請使用 MinIO 主控台 mc admin policy 命令來建立符合一或多個宣告值的政策。

OIDC 政策變數

下表列出授權 OIDC 管理的使用者 時所支援的政策變數。

每個變數都對應到做為已驗證使用者 JWT 權杖一部分傳回的宣告

變數

描述

jwt:sub

傳回使用者的 sub 宣告。

jwt:iss

從 ID 權杖傳回簽發者識別碼宣告。

jwt:aud

從 ID 權杖傳回對象宣告。

jwt:jti

從用戶端身份驗證資訊傳回 JWT ID 宣告。

jwt:upn

從用戶端身份驗證資訊傳回使用者主體名稱宣告。

jwt:name

傳回使用者的 name 宣告。

jwt:groups

傳回使用者的 groups 宣告。

jwt:given_name

傳回使用者的 given_name 宣告。

jwt:family_name

傳回使用者的 family_name 宣告。

jwt:middle_name

傳回使用者的 middle_name 宣告。

jwt:nickname

傳回使用者的 nickname 宣告。

jwt:preferred_username

傳回使用者的 preferred_username 宣告。

jwt:profile

傳回使用者的 profile 宣告。

jwt:picture

傳回使用者的 picture 宣告。

jwt:website

傳回使用者的 website 宣告。

jwt:email

傳回使用者的 email 宣告。

jwt:gender

傳回使用者的 gender 宣告。

jwt:birthdate

傳回使用者的 birthdate 宣告。

jwt:phone_number

傳回使用者的 phone_number 宣告。

jwt:address

傳回使用者的 address 宣告。

jwt:scope

傳回使用者的 scope 宣告。

jwt:client_id

傳回使用者的 client_id 宣告。

請參閱 OpenID Connect Core 1.0 文件,以取得有關這些範圍的更多資訊。您選擇的 OIDC 提供者可能有更詳細的文件。

例如,下列政策使用變數來取代已驗證使用者的 preferred_username 作為 Resource 欄位的一部分,以便使用者只能存取符合其使用者名稱的前綴。

{
"Version": "2012-10-17",
"Statement": [
      {
         "Action": ["s3:ListBucket"],
         "Effect": "Allow",
         "Resource": ["arn:aws:s3:::mybucket"],
         "Condition": {"StringLike": {"s3:prefix": ["${jwt:preferred_username}/*"]}}
      },
      {
         "Action": [
         "s3:GetObject",
         "s3:PutObject"
         ],
         "Effect": "Allow",
         "Resource": ["arn:aws:s3:::mybucket/${jwt:preferred_username}/*"]
      }
   ]
}

MinIO 會將 Resource 欄位中的 ${jwt:preferred_username} 變數,取代為 JWT 權杖中 preferred_username 的值。然後,MinIO 會評估政策,並授與或撤銷對所請求 API 和資源的存取權。