透過員工身分聯盟,您可以使用 PingFederate 做為識別資訊提供者 (IdP),驗證員工對 Google Cloud的存取權。設定安全宣告標記語言 (SAML) 2.0 整合後,聯合使用者就能登入支援員工身分聯盟的 Google Cloud 服務。
事前準備
- 請務必設定 Google Cloud 組織。
-
安裝 Google Cloud CLI。 安裝完成後,請執行下列指令,初始化 Google Cloud CLI:
gcloud init若您採用的是外部識別資訊提供者 (IdP),請先使用聯合身分登入 gcloud CLI。
- 如要登入,IdP 必須提供已簽署的驗證資訊:SAML IdP 回應必須經過簽署。
- 如要接收有關組織或Google Cloud 產品異動的重要資訊,請務必提供重要聯絡人。詳情請參閱「員工身分聯盟總覽」。
費用
員工身分聯盟是免付費功能。不過,員工身分聯盟的詳細稽核記錄會使用 Cloud Logging。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。
必要的角色
如要取得設定員工身分聯盟所需的權限,請要求管理員授予您組織的 IAM 工作團隊集區管理員 (roles/iam.workforcePoolAdmin) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。
如果您是在開發或測試環境 (而非正式環境) 中設定權限,可以授予 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 秒) 之間。
控制台
如要建立員工身分集區,請按照下列步驟操作:
前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區) 頁面:
選取員工身分集區所屬的組織。員工身分集區適用於組織中的所有專案和資料夾。
按一下「Create pool」(建立集區),然後執行下列操作:
在「Name」(名稱) 欄位中,輸入集區的顯示名稱。系統會根據您輸入的名稱自動產生集區 ID,並顯示在「Name」(名稱) 欄位下方。如要更新集區 ID,請按一下集區 ID 旁的「Edit」(編輯)。
選用:在「Description」(說明) 中輸入集區說明。
如要建立員工身分集區,請按「Next」(下一步)。
員工身分集區的工作階段持續時間預設為一小時 (3600 秒)。工作階段持續時間決定了這個工作團隊集區的 Google Cloud 存取權杖、控制台 (聯合) 和 gcloud CLI 登入工作階段的有效時間。建立集區後,您可以更新集區,設定自訂工作階段持續時間。工作階段持續時間必須介於 15 分鐘 (900 秒) 至 12 小時 (43,200 秒) 之間。
建立 PingFederate 應用程式
本節說明如何建立 PingFederate Application Integration。
如要設定使用 SAML 2.0 通訊協定的 PingFederate 應用程式,請在 PingFederate 中執行下列操作:
- 設定 PingFederate IdP 的 SAML 2.0 實體 ID。詳情請參閱「指定聯合資訊」。
建立 SAML 2.0 SP 連線,請參閱「Choosing an SP connection type」(選擇 SP 連線類型),並執行下列操作:
- 在「Connection Type」部分,選取「Browser SSO Profiles」和「SAML 2.0 protocol」。
- 在「匯入中繼資料」中,選取「無」。
在「一般資訊」中,將「合作夥伴的實體 ID (連線 ID)」設為下列值:
https://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID在「SAML Profiles」中,啟用「SP-initiated SSO」。如果您也打算使用 IdP 啟動的單一登入 (SSO) 服務,也可以啟用這項功能。
在「Attribute Contract」中,定義要在斷言中傳遞的自訂屬性 (例如電子郵件和群組)。這些屬性可用於 Google Cloud ,以便日後建立存取管理政策。
在「Attribute Contract Fulfillment」中,確認
SAML_SUBJECT已對應至每位使用者專屬值的欄位。舉例來說,電子郵件地址通常是每位使用者專屬,不會變更,且常用於在 Google Cloud 存取權管理政策中參照特定使用者。如要設定控制台 (聯合) 登入程序,請在「Assertion Consumer Service URL」中新增下列端點網址:
https://auth.cloud.google/signin-callback/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID更改下列內容:
WORKFORCE_POOL_ID:先前建立的工作團隊集區 ID。WORKFORCE_PROVIDER_ID:您稍後建立的工作團隊提供者 ID。
將這個端點的「Binding」設為「POST」。
如要啟用控制台 (聯合) 登入,請在「Allowable SAML Bindings」中選取「Redirect」。
在「Signature Policy」部分,選取「Sign Response As Required」。
儲存並啟用連線。
使用屬性
本節說明如何使用 SAML 斷言中的屬性。
使用屬性合約,在產生的 SAML 聲明中指定自訂屬性。設定屬性後,您可以在 Google Cloud 中使用這些屬性建立存取管理政策。如要進一步瞭解屬性合約,請參閱 PingFederate 伺服器說明文件中的「屬性合約」。
舉例來說,在本指南中,我們使用 PingOne 做為 PingFederate 的資料儲存庫,並使用 PingOne 資料儲存庫中的使用者屬性對應 email、firstName 和 groups 屬性合約,如下所示:
| 屬性合約 | 值 |
|---|---|
email |
email |
firstName |
name.given |
groups |
memberOfGroupIDs |
建立 PingFederate 員工身分集區提供者
本節說明如何建立員工身分集區提供者,讓 IdP 使用者存取 Google Cloud。您可以將提供者設為使用 SAML 通訊協定。
建立 SAML 2.0 員工身分集區提供者
如要設定 SAML 應用程式,請按照下列步驟操作:
gcloud
如要建立 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="XML_METADATA_PATH" \ --attribute-mapping="ATTRIBUTE_MAPPING" \ --attribute-condition="ATTRIBUTE_CONDITION" \ --location=global更改下列內容:
WORKFORCE_PROVIDER_ID:供應商 ID。WORKFORCE_POOL_ID:員工身分集區 ID。DISPLAY_NAME:顯示名稱。DESCRIPTION:說明。XML_METADATA_PATH:PingFederate 中 XML 格式中繼資料檔案的路徑。ATTRIBUTE_MAPPING:屬性對應,例如google.subject=assertion.subject,google.groups=assertion.attributes.groups,attribute.department=assertion.attributes.department[0]。ATTRIBUTE_CONDITION:選用的屬性條件。舉例來說,如要將ipaddr屬性限制在特定 IP 範圍,請將條件設為assertion.ipaddr.startsWith('98.11.12.')。
這個指令會將 SAML 聲明中的
subject、groups和department分別指派給google.subject、google.groups和attribute.department屬性。屬性條件也確保只有特定 IP 範圍內的使用者,才能透過這個工作團隊提供者登入。控制台
如要使用 Google Cloud 控制台設定 SAML 供應商,請按照下列步驟操作:
- 前往 Google Cloud 控制台的「Workforce Identity Pools」(員工身分集區) 頁面: 前往「Workforce Identity Pools」(員工身分集區) 頁面
- 在「Workforce Identity Pools」(員工身分集區) 表格中,選取要建立提供者的集區。
- 在「Providers」部分,按一下「 Add Provider」。
- 在「Select a Provider vendor」清單中,選取「Generic Identity Provider」。
- 在「選取驗證通訊協定」中,選取「SAML」。
- 在「Create a provider」(建立提供者) 部分,執行下列操作:
- 在「Name」中輸入供應商名稱。
- 選用:在「Description」(說明) 中輸入供應商說明。
- 在「IdP metadata file (XML)」中,選取 PingFederate 的中繼資料 XML 檔案。
- 如要建立已啟用的提供者,請確認「啟用提供者」已開啟。
- 按一下「繼續」。
- 在「分享供應商資訊」部分,按一下「繼續」。
- 選用:如要啟用詳細稽核記錄,請在「設定供應商」部分的「詳細記錄」中,按一下「啟用屬性值稽核記錄」切換鈕。
員工身分聯盟詳細稽核記錄會將從 IdP 收到的資訊記錄到 Logging。詳細的稽核記錄可協助您排解工作團隊身分集區提供者設定問題。如要瞭解如何透過詳細的稽核記錄排解屬性對應錯誤,請參閱「一般屬性對應錯誤」。如要瞭解 Logging 定價,請參閱「Google Cloud Observability 定價」。
如要停用工作團隊身分集區提供者的詳細稽核記錄,請在建立提供者時,將「啟用屬性值稽核記錄」切換鈕設為關閉。如要停用詳細稽核記錄,您也可以更新供應商。
- 按一下「Submit」(提交),建立提供者。
建立供應商後,系統會將您重新導向至供應商屬性頁面。
如要設定屬性對應和條件,請按照下列步驟操作:
- 系統提示時,請登入外部 IdP,驗證預設屬性對應。
在提供者屬性頁面,查看及編輯屬性對應和條件:
如要新增或編輯屬性對應,請按照下列步驟操作:
- 按一下「新增對應」,即可新增對應或編輯現有對應。
- 在「Google n」欄位中 (n 為數字),選取 Google Cloud支援的金鑰。
在對應的「SAML n」欄位中,輸入 IdP 屬性名稱或 CEL 運算式,例如:
google.subject=assertion.subject, google.groups=assertion.attributes['https://example.com/aliases'], attribute.costcenter=assertion.attributes.costcenter[0]
如要新增屬性條件,請按照下列步驟操作:
- 按一下「新增條件」。
- 在「Attribute Conditions」(屬性條件) 欄位中,以 CEL 格式輸入條件,例如
assertion.ipaddr.startsWith('98.11.12.')。
如要驗證對應關係,請按一下「Save and refetch token」(儲存並重新擷取權杖)。
按一下「儲存並結束」,完成設定。
管理 Google Cloud 資源的存取權
本節說明如何管理 PingFederate 使用者的 Google Cloud 資源存取權。
本指南使用的範例專案,可能與您用來設定員工身分聯盟的專案不同。
您可以管理單一身分、一組身分或整個集區的角色。詳情請參閱「允許政策的工作團隊主體 ID」。
使用對應的部門屬性
如要將 Storage 管理員角色 (roles/storage.admin) 授予特定部門內的所有身分,以便存取 TEST_PROJECT_ID 專案,請執行下列指令:
gcloud projects add-iam-policy-binding TEST_PROJECT_ID \
--role="roles/storage.admin" \
--member="principalSet://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/attribute.department/DEPARTMENT_VALUE"
更改下列內容:
TEST_PROJECT_ID:專案 ID。WORKFORCE_POOL_ID:員工身分集區 ID。DEPARTMENT_VALUE:對應的attribute.department值。
使用對應群組
如要將 Storage 管理員角色 (roles/storage.admin) 授予 TEST_PROJECT_ID 專案中 GROUP_ID 群組內的所有身分,請執行下列指令:
gcloud projects add-iam-policy-binding TEST_PROJECT_ID \
--role="roles/storage.admin" \
--member="principalSet://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/group/GROUP_ID"
更改下列內容:
TEST_PROJECT_ID:專案 ID。WORKFORCE_POOL_ID:員工身分集區 ID。GROUP_ID:對應google.groups附加資訊中的群組。
登入並測試存取權
在本節中,您將以工作團隊身分集區使用者身分登入,並測試存取權。
登入
控制台 (聯合) 登入
如要登入 Google Cloud 員工身分聯盟控制台 (又稱聯合控制台),請按照下列步驟操作:
-
前往控制台 (聯合) 登入頁面。
-
輸入提供者名稱,格式如下:
locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID
在系統提示時輸入 PingFederate 憑證。
gcloud CLI 瀏覽器登入
如要使用瀏覽器登入流程登入 gcloud CLI,請按照下列步驟操作:
執行下列指令,建立登入設定檔:
Linux 和 macOS
gcloud iam workforce-pools create-login-config \ locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID \ --output-file=LOGIN_CONFIG_PATH
Windows (PowerShell)
gcloud iam workforce-pools create-login-config ` locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID ` --output-file=LOGIN_CONFIG_PATH
更改下列內容:
WORKFORCE_POOL_ID:員工身分聯盟集區 ID。WORKFORCE_PROVIDER_ID:員工身分聯盟提供者 ID。-
LOGIN_CONFIG_PATH:寫入登入設定檔 的路徑。例如:login-config.json。
登入設定檔包含 gcloud CLI 使用的端點,可啟用瀏覽器型驗證流程,並將目標對象設為員工身分集區提供者中設定的 IdP。檔案不含機密資訊。
登入設定檔內容大致如下:
{ "universe_domain": "googleapis.com", "universe_cloud_web_domain": "cloud.google", "type": "external_account_authorized_user_login_config", "audience": "//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID", "auth_url": "https://auth.cloud.google/authorize", "token_url": "https://sts.googleapis.com/v1/oauthtoken", "token_info_url": "https://sts.googleapis.com/v1/introspect" }
使用環境變數、有效 gcloud CLI 設定中的屬性,指向登入設定檔,或直接搭配 gcloud auth login 指令使用:
環境變數
如要搭配環境變數使用登入設定檔,請完成下列操作說明:
-
將
CLOUDSDK_AUTH_LOGIN_CONFIG_FILE環境變數設為登入設定檔的路徑。 -
執行下列指令:
gcloud auth login
- gcloud CLI 會參照環境變數來尋找登入設定檔,然後啟動驗證程序。按照瀏覽器流程進行驗證,並授權 gcloud CLI 代表您存取資源,以便日後執行指令。
如要停止使用 gcloud auth login 指令的登入設定檔,請清除 CLOUDSDK_AUTH_LOGIN_CONFIG_FILE 環境變數。
gcloud CLI 設定
如要搭配使用登入設定檔和 gcloud CLI 設定屬性,請完成下列操作:
-
使用下列指令,將有效 gcloud CLI 設定的
auth/login_config_file屬性設為登入設定檔的路徑:gcloud config set auth/login_config_file LOGIN_CONFIG_PATH
-
執行下列指令:
gcloud auth login
- gcloud CLI 會參照設定屬性來尋找登入設定檔,然後啟動驗證程序。按照瀏覽器流程進行驗證,並授權 gcloud CLI 代表您存取資源,以便日後執行指令。
如要停止使用 gcloud auth login 指令的登入設定檔,請使用下列指令取消設定屬性:
gcloud config unset auth/login_config_file
gcloud auth login
如要直接搭配 gcloud auth login 指令使用登入設定檔,請完成下列操作說明:
-
如果您在建立登入設定檔時使用了
--activate旗標,請執行下列指令:gcloud auth login
-
如果您在建立登入設定檔時未使用
--activate旗標,請執行下列指令:Linux 和 macOS
gcloud auth login \ --login-config=LOGIN_CONFIG_PATH
Windows (PowerShell)
gcloud auth login ` --login-config=LOGIN_CONFIG_PATH
將 LOGIN_CONFIG_PATH 替換為登入設定檔的路徑。
gcloud auth login 指令會將存取憑證儲存在主目錄中。通過驗證的主體會成為 gcloud CLI 有效設定中的有效主體。除非遭到覆寫,否則 gcloud CLI 會使用這些儲存的憑證存取 Google Cloud。
gcloud CLI 無頭登入
如要使用 SAML 通訊協定,透過 gcloud CLI 登入 PingFederate,請按照下列步驟操作:
- 讓使用者登入 PingFederate 應用程式,並取得 SAML 回應。
- 將 PingFederate 傳回的 SAML 回應儲存在本機電腦的安全位置。將路徑儲存在環境變數中,例如:
SAML_ASSERTION_PATH=/path/to/assertion.xml。 產生設定檔:
gcloud iam workforce-pools create-cred-config \ locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID \ --subject-token-type=urn:ietf:params:oauth:token-type:saml2 \ --credential-source-file=SAML_ASSERTION_PATH \ --workforce-pool-user-project=PROJECT_ID \ --output-file=config.json更改下列內容:
SAML_ASSERTION_PATH:SAML 宣告檔案的路徑。PROJECT_ID:專案 ID。
產生的設定檔大致如下:
{ "type": "external_account", "audience": "//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/providers/WORKFORCE_PROVIDER_ID", "subject_token_type": "urn:ietf:params:oauth:token-type:saml2", "token_url": "https://sts.googleapis.com/v1/token", "credential_source": { "file": "SAML_ASSERTION_PATH" }, "workforce_pool_user_project": "PROJECT_ID" }如要使用權杖交換登入 gcloud CLI,請執行下列指令:
gcloud auth login --cred-file=config.jsongcloud接著會以透明方式將您的 PingFederate 憑證交換為暫時 Google Cloud 存取權杖,讓您能對 Google Cloud進行其他gcloud呼叫。輸出結果會與下列內容相似:Authenticated with external account user credentials for: [principal://iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID/subject/USER_ID].如要列出已驗證憑證的帳戶和使用中帳戶,請執行下列指令:
gcloud auth list
測試存取權
您可以使用支援員工身分聯盟,且您有權存取的 Google Cloud 服務。在本指南的前面部分,您已將 Storage 管理員角色授予專案 TEST_PROJECT_ID 中特定部門或群組內的所有身分。您可以列出 Cloud Storage bucket,測試是否具備存取權。
控制台 (聯合) 登入
如要在控制台 (聯合) 驗證存取權,請按照下列步驟操作:
gcloud CLI
如要列出您有權存取的專案 Cloud Storage bucket 和物件,請執行下列指令:
gcloud alpha storage ls --project="TEST_PROJECT_ID"
主體必須具備 gcloud CLI 工作階段中設定的專案 serviceusage.services.use 權限:PROJECT_ID。
後續步驟
- 刪除員工身分聯盟使用者及其資料。
- 撤銷員工身分聯盟使用者工作階段。
- 瞭解哪些 Google Cloud 產品支援員工身分聯盟。
- 設定使用者對控制台的存取權 (聯合)。