設定員工身分聯盟

員工身分聯盟可讓員工使用外部身分識別資訊提供者 (IdP) 存取 Google Cloud 服務和資源。您可以使用支援 OpenID Connect (OIDC) 或安全宣告標記語言 (SAML) 2.0 的任何 IdP 設定聯盟。

如需特定供應商的操作說明,請參閱「設定以 Microsoft Entra ID 為基礎的員工身分聯盟」或「設定以 Okta 為基礎的員工身分聯盟」。

事前準備

  1. 確認您已設定 Google Cloud 組織。
  2. 安裝 Google Cloud CLI。 安裝完成後, 請執行下列指令,初始化 Google Cloud CLI:

    gcloud init

    若您採用的是外部識別資訊提供者 (IdP),請先使用聯合身分登入 gcloud CLI。

  3. 啟用 Identity and Access Management (IAM) 和 Resource Manager API (如果尚未啟用)。

    啟用 API 所需的角色

    如要啟用 API,您必須具備 serviceusage.services.enable 權限。如果您建立了專案,可能已透過擁有者角色 (roles/owner) 取得這項權限。否則,您可以透過 Service Usage 管理員角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。

    啟用 API

  4. 如要登入,IdP 必須提供已簽署的驗證資訊:OIDC IdP 必須提供 JWT,且 SAML IdP 回應必須經過簽署。
  5. 如要接收有關組織或Google Cloud 產品異動的重要資訊,請務必提供重要聯絡人。詳情請參閱「員工身分聯盟總覽」。

費用

員工身分聯盟是免付費功能。不過,員工身分聯盟的詳細稽核記錄會使用 Cloud Logging。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。

必要的角色

如要取得設定員工身分聯盟所需的權限,請要求管理員授予您組織的員工身分集區管理員 (roles/iam.workforcePoolAdmin) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色,取得必要權限。

或者,擁有者基本角色 (roles/owner) 也包含設定員工身分聯盟的權限。請勿在正式環境中授予基本角色,但可以在開發或測試環境中授予。

設定員工身分聯盟

如要設定員工身分聯盟,請建立員工身分集區和員工身分集區提供者。

建立員工身分集區

執行下列指令來建立集區:

gcloud

如要建立員工身分集區,請執行下列指令:

gcloud iam workforce-pools create WORKFORCE_POOL_ID \
    --organization=ORGANIZATION_ID \
    --display-name="DISPLAY_NAME" \
    --description="DESCRIPTION" \
    --session-duration=SESSION_DURATION \
    --location=global

更改下列內容:

  • WORKFORCE_POOL_ID:您選擇用來代表 Google Cloud 員工集區的 ID。集區 ID 在 Google Cloud的所有員工身分集區中不得重複。如要瞭解如何設定 ID 格式,請參閱 API 說明文件的「查詢參數」一節。
  • ORGANIZATION_ID:員工身分集區所屬 Google Cloud 組織的數值組織 ID。員工身分集區適用於組織中的所有專案和資料夾。
  • DISPLAY_NAME:選用。員工身分集區的顯示名稱。
  • DESCRIPTION:選用。員工身分集區說明。
  • SESSION_DURATION:選用。工作階段持續時間,以數字加上 s 表示,例如 3600s。工作階段持續時間決定了 Google Cloud 存取權杖、控制台 (聯合) 登入工作階段,以及這個員工集區的 gcloud CLI 登入工作階段的有效時間。工作階段持續時間預設為一小時 (3600 秒)。工作階段持續時間值必須介於 15 分鐘 (900 秒) 至 12 小時 (43200 秒) 之間。

控制台

如要建立工作團隊身分集區,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區) 頁面:

    前往「Workforce Identity Pools」(員工身分集區) 頁面

  2. 選取員工身分集區所屬的組織。員工身分集區適用於組織中的所有專案和資料夾。

  3. 按一下「Create pool」(建立集區),然後執行下列操作:

    1. 在「Name」(名稱) 欄位中,輸入集區的顯示名稱。系統會根據您輸入的名稱自動產生集區 ID,並顯示在「Name」(名稱) 欄位下方。如要更新集區 ID,請按一下集區 ID 旁的「Edit」(編輯)。

    2. 選用:在「Description」(說明) 中輸入集區說明。

    3. 如要建立員工身分集區,請按「Next」(下一步)。

員工身分集區的工作階段持續時間預設為一小時 (3600 秒)。工作階段持續時間決定了這個工作團隊集區的 Google Cloud 存取權杖、控制台 (聯合) 和 gcloud CLI 登入工作階段的有效時間。建立集區後,您可以更新集區,設定自訂工作階段持續時間。工作階段持續時間必須介於 15 分鐘 (900 秒) 至 12 小時 (43,200 秒) 之間。

建立工作團隊身分集區提供者

本節說明如何建立員工身分集區提供者,讓 IdP 使用者存取 Google Cloud。您可以將提供者設為使用 OIDC 或 SAML 通訊協定。

建立 OIDC 工作團隊集區提供者

如要使用 OIDC 通訊協定建立工作團隊身分集區提供者,請按照下列步驟操作:

  1. 在 OIDC IdP 中,為 Google Cloud員工身分聯盟註冊新的應用程式。記下 IdP 提供的用戶端 ID 和核發者 URI。您會在本文件中使用這些值。

  2. 如果您打算設定使用者對控制台的存取權,請將下列重新導向網址新增至 OIDC IdP:

    https://auth.cloud.google/signin-callback/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
    

    更改下列內容:

    • WORKFORCE_POOL_ID:員工身分集區 ID

    • WORKFORCE_PROVIDER_ID:您稍後在本文件中建立的員工身分集區提供者 ID。

    如要瞭解如何設定控制台 (聯合) 登入,請參閱「設定控制台 (聯合) 的使用者存取權」。

  3. 在 Google Cloud中,按照下列步驟建立提供者:

    gcloud

    代碼流程

    如要建立使用授權碼流程進行網頁登入的 OIDC 供應商,請執行下列指令:

    gcloud iam workforce-pools providers create-oidc WORKFORCE_PROVIDER_ID \
        --workforce-pool=WORKFORCE_POOL_ID \
        --display-name="DISPLAY_NAME" \
        --description="DESCRIPTION" \
        --issuer-uri="ISSUER_URI" \
        --client-id="OIDC_CLIENT_ID" \
    --client-secret-value="OIDC_CLIENT_SECRET" \ --web-sso-response-type="code" \ --web-sso-assertion-claims-behavior="merge-user-info-over-id-token-claims" \ --web-sso-additional-scopes="WEB_SSO_ADDITIONAL_SCOPES" \ --attribute-mapping="ATTRIBUTE_MAPPING" \ --attribute-condition="ATTRIBUTE_CONDITION" \ --jwk-json-path="JWK_JSON_PATH" \ --detailed-audit-logging \ --location=global

    替換下列內容:

    • WORKFORCE_PROVIDER_ID:不重複的工作團隊身分集區提供者 ID。前置字元 gcp- 為保留字,不得用於員工身分集區或員工身分集區提供者 ID。
    • WORKFORCE_POOL_ID:要連結 IdP 的員工身分集區 ID。
    • DISPLAY_NAME:提供者的選用容易使用顯示名稱,例如 idp-eu-employees。
    • DESCRIPTION:選用的工作團隊提供者說明,例如 IdP for Partner Example Organization employees。
    • ISSUER_URI:OIDC 核發者 URI,格式必須有效,且開頭為 https,例如 https://example.com/oidc。注意:基於安全考量,ISSUER_URI 必須使用 HTTPS 配置。
    • OIDC_CLIENT_ID:向 OIDC IdP 註冊的 OIDC 用戶端 ID;這個 ID 必須與 IdP 核發的 JWT aud 宣告相符。
    • OIDC_CLIENT_SECRET:OIDC 用戶端密鑰。
    • WEB_SSO_ADDITIONAL_SCOPES:選用的額外範圍,用於傳送至 OIDC IdP,以便透過控制台 (聯合) 或 gcloud CLI 瀏覽器登入。
    • ATTRIBUTE_MAPPING:屬性對應。 以下是屬性對應範例:
      google.subject=assertion.oid
      google.groups=assertion.groups,
      attribute.costcenter=assertion.costcenter
      這個範例會將 OIDC 聲明中的 IdP 屬性 assertion.oid、assertion.groups 和 assertion.costcenter 分別對應至 Google Cloud 屬性 google.subject、google.groups 和 attribute.costcenter。
    • ATTRIBUTE_CONDITION:屬性條件,例如 assertion.role == 'gcp-users'。這個範例條件可確保只有具備 gcp-users 角色的使用者,才能透過這個提供者登入。
    • JWK_JSON_PATH:在本機上傳的 OIDC JWK 選用路徑。如未提供這個參數, Google Cloud 會改用 IdP 的 /.well-known/openid-configuration 路徑,尋找含有公開金鑰的 JWK。如要進一步瞭解本機上傳的 OIDC JWK,請參閱「管理 OIDC JWK」。
    • 員工身分聯盟詳細稽核記錄會將從 IdP 收到的資訊記錄到 Logging。詳細的稽核記錄可協助您排解員工身分集區提供者設定問題。如要瞭解如何透過詳細的稽核記錄排解屬性對應錯誤,請參閱「一般屬性對應錯誤」。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。

      如要停用工作團隊身分集區提供者的詳細稽核記錄,請在執行 gcloud iam workforce-pools providers create 時省略 --detailed-audit-logging 旗標。如要停用詳細稽核記錄,您也可以更新供應商。

    --web-sso-assertion-claims-behavior 旗標可控管 OIDC 宣告如何納入用於屬性對應和屬性條件的 assertion 物件。如果是授權碼流程 (--web-sso-response-type="code"),您可以將這個旗標設為下列其中一個值:

    • merge-user-info-over-id-token-claims:將 OIDC UserInfo 端點的憑證資訊與 ID 權杖的憑證資訊合併。如果兩者包含相同的聲明名稱,系統會優先採用 UserInfo 聲明值。如果 IdP 從 UserInfo 端點傳回額外的使用者屬性或群組權杖附加資訊,請使用這個值。
    • only-id-token-claims:僅包含 ID 權杖中的要求。 如果屬性對應和條件所需的所有憑證資訊,都已存在於 ID 權杖中,請使用這個值。
    在指令回應中,POOL_RESOURCE_NAME 是集區名稱,例如 locations/global/workforcePools/enterprise-example-organization-employees。

    隱含流程

    如要建立使用隱含流程進行網頁登入程序的 OIDC 供應商,請執行下列指令:

    gcloud iam workforce-pools providers create-oidc WORKFORCE_PROVIDER_ID \
        --workforce-pool=WORKFORCE_POOL_ID \
        --display-name="DISPLAY_NAME" \
        --description="DESCRIPTION" \
        --issuer-uri="ISSUER_URI" \
        --client-id="OIDC_CLIENT_ID" \
        --web-sso-response-type="id-token" \
        --web-sso-assertion-claims-behavior="only-id-token-claims" \
        --web-sso-additional-scopes="WEB_SSO_ADDITIONAL_SCOPES" \
        --attribute-mapping="ATTRIBUTE_MAPPING" \
        --attribute-condition="ATTRIBUTE_CONDITION" \
        --jwk-json-path="JWK_JSON_PATH" \
        --detailed-audit-logging \
        --location=global
    

    替換下列內容:

    • WORKFORCE_PROVIDER_ID:不重複的工作團隊身分集區提供者 ID。前置字元 gcp- 為保留字,不得用於員工身分集區或員工身分集區提供者 ID。
    • WORKFORCE_POOL_ID:要連結 IdP 的員工身分集區 ID。
    • DISPLAY_NAME:提供者的選用容易使用顯示名稱,例如 idp-eu-employees。
    • DESCRIPTION:選用的工作團隊提供者說明,例如 IdP for Partner Example Organization employees。
    • ISSUER_URI:OIDC 核發者 URI,格式必須有效,且開頭為 https,例如 https://example.com/oidc。注意:基於安全考量,ISSUER_URI 必須使用 HTTPS 配置。
    • OIDC_CLIENT_ID:向 OIDC IdP 註冊的 OIDC 用戶端 ID;這個 ID 必須與 IdP 核發的 JWT aud 宣告相符。
    • WEB_SSO_ADDITIONAL_SCOPES:選用的額外範圍,用於傳送至 OIDC IdP,以便透過控制台 (聯合) 或 gcloud CLI 瀏覽器登入。
    • ATTRIBUTE_MAPPING:屬性對應。 以下是屬性對應範例:
      google.subject=assertion.oid
      google.groups=assertion.groups,
      attribute.costcenter=assertion.costcenter
      這個範例會將 OIDC 聲明中的 IdP 屬性 assertion.oid、assertion.groups 和 assertion.costcenter 分別對應至 Google Cloud 屬性 google.subject、google.groups 和 attribute.costcenter。
    • ATTRIBUTE_CONDITION:屬性條件,例如 assertion.role == 'gcp-users'。這個範例條件可確保只有具備 gcp-users 角色的使用者,才能透過這個提供者登入。
    • JWK_JSON_PATH:在本機上傳的 OIDC JWK 選用路徑。如未提供這個參數, Google Cloud 會改用 IdP 的 /.well-known/openid-configuration 路徑,尋找含有公開金鑰的 JWK。如要進一步瞭解本機上傳的 OIDC JWK,請參閱「管理 OIDC JWK」。
    • 員工身分聯盟詳細稽核記錄會將從 IdP 收到的資訊記錄到 Logging。詳細的稽核記錄可協助您排解員工身分集區提供者設定問題。如要瞭解如何透過詳細的稽核記錄排解屬性對應錯誤,請參閱「一般屬性對應錯誤」。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。

      如要停用工作團隊身分集區提供者的詳細稽核記錄,請在執行 gcloud iam workforce-pools providers create 時省略 --detailed-audit-logging 旗標。如要停用詳細稽核記錄,您也可以更新供應商。

    如果是隱含流程 (--web-sso-response-type="id-token"),您必須將 --web-sso-assertion-claims-behavior 旗標設為 only-id-token-claims,這只會包含 assertion 物件中 ID 權杖的宣告。隱含流程不支援 merge-user-info-over-id-token-claims 值。

    在指令回應中,POOL_RESOURCE_NAME 是集區名稱,例如 locations/global/workforcePools/enterprise-example-organization-employees。

    前置字元 gcp- 為保留字,不得用於員工身分集區或員工身分集區提供者 ID。

    如果是 OIDC 聯合,您可以使用 assertion.NAME:這個字串等於 ID 權杖酬載中同名宣告的值。

    控制台

    程式碼流程

    在 Google Cloud 控制台中,如要建立使用授權碼流程的 OIDC 供應商,請按照下列步驟操作:

    1. 前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區) 頁面:

      前往「Workforce Identity Pools」(員工身分集區) 頁面

    2. 在「Workforce Identity Pools」(員工身分集區) 表格中,選取要建立提供者的集區。
    3. 在「Providers」部分,按一下「 Add Provider」。
    4. 在「Select a Provider vendor」(選取提供者) 清單中,選取您的 IdP。

      如果清單中沒有您的識別資訊提供者,請選取「Generic Identity Provider」。

    5. 在「選取驗證通訊協定」部分,選取「OpenID Connect (OIDC)」。
    6. 在「Create a provider」(建立提供者) 部分,執行下列操作:
      1. 在「Name」中輸入供應商名稱。
      2. 在「Description」(說明) 中,輸入提供者的說明。
      3. 在「Issuer (URL)」中輸入核發者 URI。OIDC 核發者 URI 必須採用有效的 URI 格式,並以 https 開頭,例如 https://example.com/oidc。
      4. 在「Client ID」(用戶端 ID) 中,輸入向 OIDC IdP 註冊的 OIDC 用戶端 ID;該 ID 必須與 IdP 核發的 JWT aud 宣告相符。
      5. 如要建立已啟用的供應商,請確認「啟用供應商」已開啟。
      6. 按一下「繼續」。
    7. 在「Share your provider information with IdP」(與 IdP 分享提供者資訊) 部分,複製網址。在 IdP 中,將這個網址設為重新導向 URI,讓 IdP 知道登入後要將斷言權杖傳送至何處。
    8. 按一下「繼續」。
    9. 在「Configure OIDC Web Sign-in」(設定 OIDC 網頁登入功能) 部分,執行下列操作:
      1. 在「Flow type」(流程類型) 清單中,選取「Code」(程式碼)。
      2. 在「Assertion claims behavior」(斷言宣告行為) 清單中,選取下列其中一個選項:
        • 使用者資訊和 ID 權杖:合併 UserInfo 端點和 ID 權杖的憑證資訊,並優先採用 UserInfo 憑證資訊值 (如果憑證名稱相同)。如果 IdP 從 UserInfo 端點傳回額外的使用者屬性或群組宣告,請選取這個選項。
        • 僅限 ID 權杖:僅包含 ID 權杖中的要求。如果屬性對應和條件所需的所有宣告都已存在於 ID 權杖中,請選取這個選項。
      3. 在「Client secret」(用戶端密鑰) 欄位中,輸入 IdP 的用戶端密鑰。
      4. 選用:如果您選取「Okta」做為 IdP,請在「openid、profile 和 email 以外的額外範圍」欄位中新增任何額外的 OIDC 範圍。
    10. 按一下「繼續」。
    11. 在「Configure provider」(設定供應商) 部分,按一下「Detailed logging」(詳細記錄) 下方的「Enable attribute value audit logging」(啟用屬性值稽核記錄) 切換鈕。

      員工身分聯盟詳細稽核記錄會將從 IdP 收到的資訊記錄到 Logging。詳細的稽核記錄可協助您排解員工身分集區提供者設定問題。如要瞭解如何透過詳細的稽核記錄排解屬性對應錯誤,請參閱「一般屬性對應錯誤」。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。

      如要停用工作團隊身分集區提供者的詳細稽核記錄,請在建立提供者時,將「啟用屬性值稽核記錄」切換鈕設為關閉。如要停用詳細稽核記錄,您也可以更新供應商。

    12. 按一下「Submit」(提交),建立提供者。

    建立供應商後,系統會將您重新導向至供應商屬性頁面。

    如要設定屬性對應和條件,請按照下列步驟操作:

    1. 系統提示時,請登入外部 IdP,驗證預設屬性對應。
    2. 在提供者屬性頁面,查看及編輯屬性對應和條件:
      1. 如要新增或編輯屬性對應,請按照下列步驟操作:
        1. 按一下「新增對應」,即可新增對應或編輯現有對應。
        2. 在「Google n」欄位中 (n 為數字), 選取 Google Cloud支援的金鑰。
        3. 在對應的「OIDC n」欄位中,輸入 IdP 屬性名稱或 CEL 運算式。
      2. 如要新增屬性條件,請按照下列步驟操作:
        1. 按一下「新增條件」。
        2. 在「Attribute Conditions」(屬性條件) 欄位中,以 CEL 格式輸入條件,例如 assertion.role == 'gcp-users'。這個範例條件可確保只有具備 gcp-users 角色的使用者,才能使用這個提供者登入。
    3. 如要驗證對應關係,請按一下「Save and refetch token」(儲存並重新擷取權杖)。
    4. 按一下「儲存並結束」,完成設定。

    隱含流程

    在 Google Cloud 控制台中,如要建立使用隱含流程的 OIDC 供應商,請按照下列步驟操作:

    1. 前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區) 頁面:

      前往「Workforce Identity Pools」(員工身分集區) 頁面

    2. 在「Workforce Identity Pools」(員工身分集區) 表格中,選取要建立提供者的集區。
    3. 在「Providers」部分,按一下「 Add Provider」。
    4. 在「Select a Provider vendor」(選取提供者) 清單中,選取您的 IdP。

      如果清單中沒有您的識別資訊提供者,請選取「Generic Identity Provider」。

    5. 在「選取驗證通訊協定」部分,選取「OpenID Connect (OIDC)」。
    6. 在「Create a provider」(建立提供者) 部分,執行下列操作:
      1. 在「Name」中輸入供應商名稱。
      2. 在「Description」(說明) 中,輸入提供者的說明。
      3. 在「Issuer (URL)」中輸入核發者 URI。OIDC 核發者 URI 必須採用有效的 URI 格式,並以 https 開頭,例如 https://example.com/oidc。
      4. 在「Client ID」(用戶端 ID) 中,輸入向 OIDC IdP 註冊的 OIDC 用戶端 ID;該 ID 必須與 IdP 核發的 JWT aud 宣告相符。
      5. 如要建立已啟用的供應商,請確認「啟用供應商」已開啟。
      6. 按一下「繼續」。
    7. 在「Share your provider information with IdP」(與 IdP 分享提供者資訊) 部分,複製網址。在 IdP 中,將這個網址設為重新導向 URI,讓 IdP 知道登入後要將斷言權杖傳送至何處。
    8. 按一下「繼續」。
    9. 在「Configure OIDC Web Sign-in」(設定 OIDC 網頁登入功能) 部分,執行下列操作:
      1. 在「Flow type」(流程類型) 清單中,選取「ID Token」(ID 權杖)。
      2. 在「Assertion claims behavior」(斷言宣告行為) 清單中,選取「ID token」(ID 權杖)。
      3. 選用:如果您選取「Okta」做為 IdP,請在「Additional scopes beyond openid, profile, and email」(openid、profile 和 email 以外的額外範圍) 欄位中新增任何額外的 OIDC 範圍。
    10. 按一下「繼續」。
    11. 在「Configure provider」(設定供應商) 部分,按一下「Detailed logging」(詳細記錄) 中的「Enable attribute value audit logging」(啟用屬性值稽核記錄) 切換鈕。

      員工身分聯盟詳細稽核記錄會將從 IdP 收到的資訊記錄到 Logging。詳細的稽核記錄可協助您排解員工身分集區提供者設定問題。如要瞭解如何透過詳細的稽核記錄排解屬性對應錯誤,請參閱「一般屬性對應錯誤」。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。

      如要停用工作團隊身分集區提供者的詳細稽核記錄,請在建立提供者時,將「啟用屬性值稽核記錄」切換鈕設為關閉。如要停用詳細稽核記錄,您也可以更新供應商。

    12. 按一下「Submit」(提交),建立提供者。

    建立供應商後,系統會將您重新導向至供應商屬性頁面。

    如要設定屬性對應和條件,請按照下列步驟操作:

    1. 系統提示時,請登入外部 IdP,驗證預設屬性對應。
    2. 在提供者屬性頁面,查看及編輯屬性對應和條件:
      1. 如要新增或編輯屬性對應,請按照下列步驟操作:
        1. 按一下「新增對應」,即可新增對應或編輯現有對應。
        2. 在「Google n」欄位中 (n 為數字), 選取 Google Cloud支援的金鑰。
        3. 在對應的「OIDC n」欄位中,輸入 IdP 屬性名稱或 CEL 運算式。
      2. 如要新增屬性條件,請按照下列步驟操作:
        1. 按一下「新增條件」。
        2. 在「Attribute Conditions」(屬性條件) 欄位中,以 CEL 格式輸入條件,例如 assertion.role == 'gcp-users'。這個範例條件可確保只有具備 gcp-users 角色的使用者,才能使用這個提供者登入。
    3. 如要驗證對應關係,請按一下「Save and refetch token」(儲存並重新擷取權杖)。
    4. 按一下「儲存並結束」,完成設定。

建立 SAML 工作團隊集區提供者

  1. 在 SAML IdP 中,註冊 Google Cloud員工身分聯盟的新應用程式。

  2. 設定 SAML 宣告的目標對象。通常是 IdP 設定中的「SP Entity ID」欄位。請務必將其設為下列網址:

    https://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
    
  3. 設定重新導向網址,也稱為宣告客戶服務 (ACS) 網址。如要設定重新導向網址,請在 SAML IdP 中找到重新導向網址欄位,然後執行下列任一操作:

    • 如要透過 Google Cloud 控制台或其他瀏覽器登入方式,設定瀏覽器登入功能,請輸入下列網址:

      https://auth.cloud.google/signin-callback/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
      

      更改下列內容:

      • WORKFORCE_POOL_ID:員工身分集區 ID

      • WORKFORCE_PROVIDER_ID:您稍後在本文件中建立的員工身分集區提供者 ID。

    • 如要透過 IdP 設定程式輔助登入,請輸入下列網址:

      localhost
      

    如要進一步瞭解如何設定控制台登入,請參閱「設定控制台的使用者存取權」。

  4. 在 Google Cloud中,使用 IdP 的 SAML 中繼資料文件,建立 SAML 員工身分集區提供者。您可以從 IdP 下載 SAML 中繼資料 XML 文件。文件至少須包含下列資訊:

    • IdP 服務的 SAML 實體 ID。
    • IdP 服務的單一登入網址。
    • 至少一個簽署公開金鑰。如要進一步瞭解簽署金鑰,請參閱本指南後續的「金鑰規定」一節。

gcloud

如要使用 gcloud CLI 設定 SAML 供應商,請按照下列步驟操作:

  gcloud iam workforce-pools providers create-saml WORKFORCE_PROVIDER_ID \
      --workforce-pool=WORKFORCE_POOL_ID \
      --display-name="DISPLAY_NAME" \
      --description="DESCRIPTION" \
      --idp-metadata-path=METADATA_FILE_PATH \
      --attribute-mapping="ATTRIBUTE_MAPPING" \
      --attribute-condition="ATTRIBUTE_CONDITION" \
      --location=global

更改下列內容:

  • WORKFORCE_PROVIDER_ID:員工身分集區提供者 ID。
  • WORKFORCE_POOL_ID:員工身分集區 ID。
  • DISPLAY_NAME:供應商的顯示名稱,例如 idp-eu-employees。
  • DESCRIPTION:員工身分集區提供者的說明,例如 IdP for Partner Example Organization EU employees。
  • METADATA_FILE_PATH:SAML 中繼資料檔案的路徑。
  • ATTRIBUTE_MAPPING:屬性對應,例如:

    google.subject=assertion.subject
    attribute.costcenter=assertion.attributes.costcenter[0]
    這個範例會將 assertion.subject IdP 屬性對應至 google.subject,並將 assertion.attributes.costcenter[0] IdP 屬性對應至 attribute.costcenter。

  • ATTRIBUTE_CONDITION:屬性條件。 舉例來說,如要將 ipaddr 屬性限制在特定 IP 範圍,可以設定 assertion.attributes.ipaddr.startsWith('98.11.12.') 條件。這個範例條件可確保只有 IP 位址開頭為 98.11.12. 的使用者,才能透過這個工作團隊提供者登入。

供應商可能需要幾分鐘才會開始接受要求。

如果是 SAML 聯盟,您可以在屬性對應和條件中使用下列關鍵字:

  • assertion.subject:與 SAML 宣告中的 NameID 屬性相等的字串。
  • assertion.attributes.NAME:字串清單,等於 SAML 斷言中同名屬性的值。

選用:接受來自 IdP 的加密 SAML 宣告

如要讓 SAML 2.0 IdP 產生員工身分聯盟可接受的加密 SAML 宣告,請按照下列步驟操作:

  • 在員工身分聯盟中,執行下列操作:
    • 為工作團隊身分集區提供者建立非對稱金鑰組。
    • 下載內含公開金鑰的憑證檔案。
    • 設定 SAML IdP,使用公開金鑰加密其核發的 SAML 宣告。
  • 在 IdP 中執行下列操作:
    • 啟用斷言加密 (也稱為權杖加密)。
    • 上傳您在員工身分聯盟中建立的公開金鑰。
    • 確認 IdP 會產生加密的 SAML 斷言。
請注意,即使已設定 SAML 加密提供者金鑰,員工身分聯盟仍可處理純文字斷言。

建立員工身分聯盟 SAML 斷言加密金鑰

本節將引導您建立非對稱金鑰組,讓員工身分聯盟接受加密的 SAML 斷言。

Google Cloud 會使用私密金鑰解密 IdP 核發的 SAML 宣告。如要建立非對稱金鑰組,用於 SAML 加密,請執行下列指令。詳情請參閱「支援的 SAML 加密演算法」。

gcloud iam workforce-pools providers keys create KEY_ID \
    --workforce-pool WORKFORCE_POOL_ID \
    --provider WORKFORCE_PROVIDER_ID \
    --location global \
    --use encryption \
    --spec KEY_SPECIFICATION

替換下列內容:

  • KEY_ID:您選擇的金鑰名稱
  • WORKFORCE_POOL_ID:集區 ID
  • WORKFORCE_PROVIDER_ID:員工身分集區提供者 ID
  • KEY_SPECIFICATION:金鑰規格,可以是 rsa-2048、rsa-3072 和 rsa-4096 其中之一。

建立金鑰組後,請執行下列指令,將公開金鑰下載至憑證檔案。只有員工身分聯盟可以存取私密金鑰。

gcloud iam workforce-pools providers keys describe KEY_ID \
    --workforce-pool WORKFORCE_POOL_ID \
    --provider WORKFORCE_PROVIDER_ID \
    --location global \
    --format "value(keyData.key)" \
    > CERTIFICATE_PATH

替換下列內容:

  • KEY_ID:金鑰名稱
  • WORKFORCE_POOL_ID:集區 ID
  • WORKFORCE_PROVIDER_ID:員工身分集區提供者 ID
  • CERTIFICATE_PATH:憑證的寫入路徑,例如 saml-certificate.cer 或 saml-certificate.pem

設定符合 SAML 2.0 規範的 IdP,以便核發加密的 SAML 宣告

設定 SAML IdP,使用上一步下載的公開憑證,加密其發出的 SAML 斷言。如需具體操作說明,請洽詢 IdP 團隊。

將 IdP 設為加密 SAML 斷言後,建議您檢查並確認 IdP 產生的斷言確實已加密。即使設定了 SAML 斷言加密,員工身分聯盟仍可處理明文斷言。

刪除員工身分聯盟加密金鑰

如要刪除 SAML 加密金鑰,請執行下列指令:
  gcloud iam workforce-pools providers keys delete KEY_ID \
      --workforce-pool WORKFORCE_POOL_ID \
      --provider WORKFORCE_PROVIDER_ID \
      --location global

替換下列內容:

  • KEY_ID:金鑰名稱
  • WORKFORCE_POOL_ID:集區 ID
  • WORKFORCE_PROVIDER_ID:員工身分集區提供者 ID

支援的 SAML 加密演算法

員工身分聯盟支援下列金鑰傳輸演算法:

員工身分聯盟支援下列區塊加密演算法:

SAML X.509 簽署金鑰規定

SAML X.509 簽署金鑰適用下列金鑰規格:

  • 包裝在 X.509 v3 憑證中的 RSA 公開金鑰。

  • 憑證效期規定:

    • notBefore:時間戳記,不得超過未來 7 天
    • notAfter:時間戳記,不得超過未來 25 年
  • 建議使用的演算法:

員工身分集區提供者最多可同時設定三個簽署金鑰。如果有多個金鑰, Google Cloud會逐一檢查,並嘗試使用每個未過期的金鑰來完成權杖交換要求。

為確保安全性,強烈建議您不要與其他服務重複使用相同的金鑰組。

金鑰管理

如要更新 IdP 的簽署金鑰,請按照下列步驟操作:

  1. 建立新的非對稱金鑰組,並使用該金鑰組設定 SAML 識別資訊提供者。一開始請先將其標示為停用,稍後再啟用。

  2. 從 IdP 下載 SAML 中繼資料 XML 文件。

  3. 使用 SAML 中繼資料文件,更新員工身分集區提供者資源。如果有多個金鑰, Google Cloud 會逐一檢查每個未過期的金鑰,並嘗試使用每個金鑰來完成權杖交換要求。

    如要使用 SAML 中繼資料更新工作團隊身分集區提供者,請執行下列指令。

    gcloud iam workforce-pools providers update-saml WORKFORCE_PROVIDER_ID \
        --workforce-pool=WORKFORCE_POOL_ID \
        --idp-metadata-path=SAML_METADATA_FILE_PATH \
        --location=global
    

    更改下列內容:

    • WORKFORCE_PROVIDER_ID:員工身分集區提供者 ID
    • WORKFORCE_POOL_ID:工作團隊身分集區 ID
    • SAML_METADATA_FILE_PATH:SAML 中繼資料檔案的路徑
  4. 等待上一個步驟傳回的作業完成 (作業會標示為完成),然後在 SAML IdP 中啟用新的簽署金鑰。舊的簽署金鑰會標示為停用。IdP 發布的斷言會使用新金鑰簽署。

下列步驟為選用,但建議您執行,以符合最佳做法:

  1. 從 IdP 刪除舊的簽署金鑰 (現已停用)。
  2. 從 IdP 下載 SAML 中繼資料 XML 文件。
  3. 使用 SAML 中繼資料文件更新員工身分集區提供者資源。 Google Cloud 會拒絕使用過期簽署金鑰簽署的宣告。如要更新文件,請執行下列指令:

    gcloud iam workforce-pools providers update-saml WORKFORCE_PROVIDER_ID \
        --workforce-pool=WORKFORCE_POOL_ID \
        --idp-metadata-path=SAML_METADATA_FILE_PATH \
        --location=global
    

    更改下列內容:

    • WORKFORCE_PROVIDER_ID:員工身分集區提供者 ID
    • WORKFORCE_POOL_ID:工作團隊身分集區 ID
    • SAML_METADATA_FILE_PATH:SAML 中繼資料路徑

金鑰刪除限制

Google Cloud 會拒絕使用已刪除金鑰簽署的斷言。

控制台

如要使用 Google Cloud 控制台設定 SAML 供應商,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區) 頁面:

    前往「Workforce Identity Pools」(員工身分集區) 頁面

  2. 在「Workforce Identity Pools」(員工身分集區) 表格中,選取要建立提供者的集區。
  3. 在「Providers」部分,按一下「 Add Provider」。
  4. 在「Select a Provider vendor」(選取提供者) 清單中,選取您的 IdP。

    如果清單中沒有您的識別資訊提供者,請選取「Generic Identity Provider」。

  5. 在「選取驗證通訊協定」中,選取「SAML」。
  6. 在「Create a provider」(建立提供者) 專區中,執行下列操作:
    1. 在「Name」部分,輸入供應商名稱。
    2. 選用:在「Description」(說明) 中輸入供應商說明。
    3. 在「IdP metadata file (XML)」中,選取您先前在本指南中產生的中繼資料 XML 檔案。
    4. 如要建立已啟用的供應商,請確認「啟用供應商」已開啟。
    5. 按一下「繼續」。
  7. 在「Share your provider information」部分,複製網址。在 IdP 中,將第一個網址設為實體 ID,以便向 IdP 識別應用程式。將另一個網址設為重新導向 URI,讓 IdP 知道登入後要將斷言權杖傳送至何處。
  8. 按一下「繼續」。
  9. 在「Configure provider」(設定供應商) 部分的「Detailed logging」(詳細記錄) 中,按一下「Enable attribute value audit logging」(啟用屬性值稽核記錄) 切換鈕。

    員工身分聯盟詳細稽核記錄會將從 IdP 收到的資訊記錄到 Logging。詳細的稽核記錄可協助您排解員工身分集區提供者設定問題。如要瞭解如何透過詳細的稽核記錄排解屬性對應錯誤,請參閱「一般屬性對應錯誤」。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。

    如要停用工作團隊身分集區提供者的詳細稽核記錄,請在建立提供者時,將「啟用屬性值稽核記錄」切換鈕設為關閉。如要停用詳細稽核記錄,您也可以更新供應商。

  10. 按一下「Submit」(提交),建立提供者。

建立供應商後,系統會將您重新導向至供應商屬性頁面。

如要設定屬性對應和條件,請按照下列步驟操作:

  1. 系統提示時,請登入外部 IdP,驗證預設屬性對應。
  2. 在提供者屬性頁面,查看及編輯屬性對應和條件:
    1. 如要新增或編輯屬性對應,請按照下列步驟操作:
      1. 按一下「Add mapping」(新增對應) 即可新增對應,或編輯現有對應。
      2. 在「Google n」欄位中 (n 為數字), 選取 Google Cloud 支援的金鑰。
      3. 在對應的「SAML n」欄位中, 輸入 IdP 屬性名稱或 CEL 運算式,例如:
        google.subject=assertion.subject
        attribute.costcenter=assertion.attributes.costcenter[0]
        這個範例會將 assertion.subject IdP 屬性對應至 google.subject,並將 assertion.attributes.costcenter[0] IdP 屬性對應至 attribute.costcenter。
    2. 如要新增屬性條件,請按照下列步驟操作:
      1. 按一下「新增條件」。
      2. 在「Attribute Conditions」(屬性條件) 欄位中,以 CEL 格式輸入條件,例如: 舉例來說,如要將 ipaddr 屬性限制在特定 IP 範圍,您可以設定 assertion.attributes.ipaddr.startsWith('98.11.12.') 條件。這個範例條件可確保只有 IP 位址開頭為 98.11.12. 的使用者,才能透過這個工作團隊提供者登入。
  3. 如要驗證對應關係,請按一下「Save and refetch token」(儲存並重新擷取權杖)。
  4. 按一下「儲存並結束」,完成設定。

驗證提供者設定

測試使用者登入流程前,您可以確認提供者設定是否正確,以及 Google Cloud 是否能與 IdP 交換權杖。

Google Cloud 控制台的「Validate your provider attributes」(驗證供應商屬性) 頁面包含屬性檢視器,可讓您以互動方式測試設定,並對通用運算語言 (CEL) 運算式進行偵錯。您可以使用屬性檢視器執行下列操作:

  • 查看 IdP 斷言中傳送的原始屬性。
  • 確認屬性對應和條件能正確轉換這些屬性。
  • 即時偵錯複雜的 CEL 運算式。

如要驗證供應商設定,請按照下列步驟操作:

  1. 如要為員工身分聯盟啟用瀏覽器登入流程,請將 https://auth.cloud.google/signin-callback/locations/global/workforcePools/POOL_ID/providers/PROVIDER_ID 新增至 IdP 的允許重新導向 URI 清單。
  2. 前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區)。

    前往「Workforce Identity Pools」(員工身分集區) 頁面
  3. 在集區清單中,按一下要驗證的集區名稱。
  4. 在「Workforce pool details」(員工集區詳細資料) 頁面中,按一下要驗證的 IdP 名稱。
  5. 在「Provider Details」頁面中,按一下「Debug IdP token」。
  6. 在「Sign in」(登入) 對話方塊中,以測試使用者身分登入 IdP。

「Validate your provider attributes」(驗證提供者屬性) 頁面會顯示對應的屬性和屬性條件結果。

「Mapped attributes from your IdP token」(IdP 權杖中的對應屬性) 區段會根據對應設定,顯示 Google 屬性 (例如 google.subject) 如何從 IdP 權杖填入。如果對應不正確,系統會顯示錯誤圖示。

「Attribute condition」(屬性條件) 區段會顯示條件的布林值結果。如果條件評估結果為 false,系統就會封鎖登入。

如要查看完整斷言權杖,請點選「查看完整權杖」。這會顯示 IdP 的原始 JSON 物件。請使用 assertion.PROPERTY_NAME 格式,在對應中參照頂層屬性。

編輯提供者設定

如要修正錯誤,請編輯設定:

  1. 在「驗證提供者屬性」頁面,按一下「 編輯」。
  2. 進行必要變更。
  3. 如要開始新的測試並查看更新後的結果,請按一下「Save and refetch token」(儲存並重新擷取權杖)。

允許政策的工作團隊主體 ID

下表列出可用來將角色授予個別使用者和使用者群組的主體 ID。

身分 ID 格式
工作團隊身分集區中的單一身分 principal://iam.googleapis.com/locations/global/workforcePools/POOL_ID/subject/SUBJECT_ATTRIBUTE_VALUE
群組中的所有員工身分 principalSet://iam.googleapis.com/locations/global/workforcePools/POOL_ID/group/GROUP_ID
具有特定屬性值的所有員工身分 principalSet://iam.googleapis.com/locations/global/workforcePools/POOL_ID/attribute.ATTRIBUTE_NAME/ATTRIBUTE_VALUE
員工身分集區中的所有身分 principalSet://iam.googleapis.com/locations/global/workforcePools/POOL_ID/*

如需主體 ID 的完整清單,請參閱「主體 ID」。

將 IAM 角色授予主體

您可以將角色授予主體,例如單一身分、身分群組或整個集區。

如要將專案角色授予主體,請執行下列指令:

gcloud projects add-iam-policy-binding PROJECT_ID \
    --role="ROLE" \
    --member="PRINCIPAL"

更改下列內容:

  • PROJECT_ID:專案 ID
  • ROLE:要授予的角色
  • PRINCIPAL:主體;請參閱 Workforce 身分聯盟的主體 ID。

在以下範例中,指令會將 Storage 管理員角色 (roles/storage.admin) 授予群組 GROUP_ID 中的所有身分:

gcloud projects add-iam-policy-binding my-project \
    --role="roles/storage.admin" \
    --member="principalSet://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/group/GROUP_ID"

如要進一步瞭解主體格式,請參閱員工身分聯盟的主體 ID。

刪除使用者

員工身分聯盟會為聯合使用者身分建立使用者中繼資料和資源。如果您選擇刪除 IdP 中的使用者,也必須在 Google Cloud中明確刪除這些資源。如要這麼做,請參閱「刪除員工身分聯盟使用者及其資料」。

如要立即終止使用者的有效工作階段,可以撤銷工作階段。詳情請參閱「撤銷員工身分聯盟使用者工作階段」。

您可能會看到資源仍與已刪除的使用者相關聯。這是因為刪除使用者中繼資料和資源需要長時間執行的作業。在您啟動刪除使用者身分的程序後,使用者在刪除前啟動的程序可以繼續執行,直到程序完成或取消為止。

後續步驟