使用自訂機構政策
Google Cloud 機構政策可讓您透過程式以集中方式控管機構的資源。身為機構政策管理員,您可以定義機構政策,也就是一組稱為限制的限制,適用於Google Cloud 資源和Google Cloud 資源階層中這些資源的子系。您可以在機構、資料夾或專案層級強制執行機構政策。
機構政策提供各種Google Cloud 服務的預先定義限制。不過,如要進一步自訂機構政策中受限制的特定欄位,您也可以建立自訂機構政策。
優點
您可以根據應用程式的安全、法規遵循或控管需求,使用自訂機構政策允許或拒絕對 Identity Platform 資源執行特定作業。舉例來說,您可以控管下列屬性:
- 您可以為貴機構的應用程式停用密碼登入選項,並要求使用者一律使用電子郵件登入。
- 您可以限制貴機構的應用程式,只能使用具有指定簽發者的 OIDC 識別資訊提供者 (IdP)。
- 您可以為貴機構的應用程式停用 OIDC 和 SAML IdP 選項。
- 您可以為機構中的應用程式停用多租戶選項。
政策繼承
根據預設,機構政策會由您強制執行政策的資源子系繼承。舉例來說,如果您對資料夾強制執行政策, Google Cloud 系統會對該資料夾中的所有專案強制執行政策。如要進一步瞭解這項行為及如何變更,請參閱「階層評估規則」。
定價
機構政策服務 (包括預先定義和自訂機構政策) 免費提供。
限制
為專案啟用 Identity Platform 時,系統會為該專案建立預設設定。專案啟用後,專案擁有者才能變更設定的預設值。在啟用專案前變更任何預設值,可能會導致啟用失敗。啟用後如要變更設定的預設值,請使用 updateConfig
方法。
事前準備
必要的角色
如要取得管理機構政策所需的權限,請要求管理員授予下列 IAM 角色:
-
機構政策管理員 (
roles/orgpolicy.policyAdmin
) 機構資源 -
Identity Toolkit 管理員 (
roles/identitytoolkit.admin
) Identity Platform 資源
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
這些預先定義角色具備管理機構政策所需的權限。如要查看確切的必要權限,請展開「必要權限」部分:
所需權限
如要管理組織政策,您必須具備下列權限:
-
orgpolicy.constraints.list
-
orgpolicy.policies.create
-
orgpolicy.policies.delete
-
orgpolicy.policies.list
-
orgpolicy.policies.update
-
orgpolicy.policy.get
-
orgpolicy.policy.set
建立自訂限制
自訂限制是在 YAML 檔案中定義,當中包含您要強制執行機構政策的服務所支援的資源、方法、條件和動作。自訂限制的條件是使用一般運算語言 (CEL) 定義。如要進一步瞭解如何使用 CEL 在自訂限制中建構條件,請參閱「建立及管理自訂限制」一文的 CEL 一節。
如要建立自訂限制的 YAML 檔案,請按照下列步驟操作:
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- identitytoolkit.googleapis.com/RESOURCE_NAME
methodTypes: METHOD
condition: CONDITION
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION
更改下列內容:
ORGANIZATION_ID
:您的機構 ID,例如123456789
。CONSTRAINT_NAME
:新自訂限制的名稱。自訂限制條件必須以custom.
開頭,且只能包含大寫英文字母、小寫英文字母或數字,例如 custom.allowEmailLinkLogin。這個欄位的長度上限為 70 個字元,不含前置字元,例如organizations/123456789/customConstraints/custom
。RESOURCE_NAME
:Identity Platform API REST 資源的名稱 (而非 URI),其中包含您要限制的物件和欄位。例如:identitytoolkit.googleapis.com/Config
。
CONDITION
:針對支援服務資源的代表項目編寫的 CEL 條件。這個欄位的長度上限為 1000 個字元。如要進一步瞭解可編寫條件的資源,請參閱「支援的資源」。例如:"resource.signIn.email.passwordRequired == true"
。METHOD
:建立設定或租戶建立限制時,請指定CREATE
。建立設定或房客UPDATE
限制時,請一併指定兩者,如下所示:methodTypes: - CREATE - UPDATE
ACTION
:如果符合condition
,則要採取的動作。可以是ALLOW
或DENY
。DISPLAY_NAME
:限制條件的易記名稱。這個欄位的長度上限為 200 個字元。DESCRIPTION
:違反政策時,要以錯誤訊息形式顯示的限制說明。這個欄位的長度上限為 2000 個字元。
如要進一步瞭解如何建立自訂限制,請參閱「定義自訂限制」。
設定自訂限制
為新的自訂限制建立 YAML 檔案後,您必須進行設定,才能在貴機構的機構政策中使用該檔案。如要設定自訂限制,請使用gcloud org-policies set-custom-constraint
指令:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
CONSTRAINT_PATH
替換為自訂限制檔案的完整路徑。例如:/home/user/customconstraint.yaml
。
完成後,自訂限制就會顯示在 Google Cloud 機構政策清單中,做為機構政策使用。如要確認自訂限制存在,請使用 gcloud org-policies list-custom-constraints
指令:gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
ORGANIZATION_ID
替換為機構資源的 ID。
詳情請參閱「查看機構政策」。強制執行自訂機構政策
如要強制執行限制,請建立參照該限制的機構政策,然後將該政策套用至 Google Cloud 資源。控制台
- 前往 Google Cloud 控制台的「Organization policies」(組織政策) 頁面。
- 在專案選擇工具中,選取要設定機構政策的專案。
- 在「Organization policies」(機構政策) 頁面上的清單中選取限制條件,即可查看該限制條件的「Policy details」(政策詳情) 頁面。
- 如要設定這項資源的機構政策,請按一下「管理政策」。
- 在「編輯政策」頁面中,選取「覆寫上層政策」。
- 按一下「新增規則」。
- 在「Enforcement」(強制執行) 區段中,選取是否要強制執行這項機構政策。
- 選用:如要根據標記設定機構政策條件,請按一下「新增條件」。請注意,如果將條件式規則新增至組織政策,您必須新增至少一項無條件規則,否則無法儲存政策。詳情請參閱「使用標記設定組織政策」。
- 按一下「測試變更」,模擬機構政策的影響。舊版受管理限制不支援政策模擬。詳情請參閱「 使用 Policy Simulator 測試組織政策變更」。
- 如要完成並套用機構政策,請按一下「設定政策」。這項政策最多需要 15 分鐘才會生效。
gcloud
如要建立含有布林值規則的機構政策,請建立參照限制的政策 YAML 檔案:
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME spec: rules: - enforce: true
取代下列項目:
-
PROJECT_ID
:要強制執行限制的專案。 -
CONSTRAINT_NAME
:您為自訂限制定義的名稱。例如:custom.allowEmailLinkLogin
。
如要強制執行包含限制的機構政策,請執行下列指令:
gcloud org-policies set-policy POLICY_PATH
將 POLICY_PATH
替換為機構政策 YAML 檔案的完整路徑。這項政策最多需要 15 分鐘才會生效。
測試自訂機構政策
如要測試自訂機構政策,請嘗試為專案啟用多重租戶:
curl -i -X PATCH \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-d '
{
"sign_in": {"email": {"password_required": false}}
}' https://autopush-identitytoolkit.sandbox.googleapis.com/admin/v2/projects/shimingz-playground-1/config\?update_mask\=sign_in.email.password_required
輸出內容應如下所示:
Operation denied by custom org policies: ["customConstraints/custom.allowEmailLinkLogin": "Cannot disable email link login."]
Identity Platform 支援的資源和作業
Identity Platform 支援下列自訂機構政策資源:
- identitytoolkit.googleapis.com/Config
- identitytoolkit.googleapis.com/DefaultSupportedIdpConfig
- identitytoolkit.googleapis.com/InboundSamlConfig
- identitytoolkit.googleapis.com/OauthIdpConfig
- identitytoolkit.googleapis.com/Tenant
不支援的欄位
下列欄位與資源安全性相關,因此不支援:
- identitytoolkit.googleapis.com/Config:
resource.notification.send_email.smtp.password
- identitytoolkit.googleapis.com/DefaultSupportedIdpConfig:
resource.client_secret
- identitytoolkit.googleapis.com/OauthIdpConfig:
resource.client_secret
常見用途的自訂機構政策範例
下表提供一些實用的自訂機構政策語法:
說明 | 限制語法 |
---|---|
請勿停用應用程式的電子郵件登入功能 |
name: organizations/ORGANIZATION_ID/customConstraints/custom.enableEmailLogin resourceTypes: - identitytoolkit.googleapis.com/Config methodTypes: - CREATE - UPDATE condition: "resource.sign_in.email.enabled == true" actionType: ALLOW displayName: Enable email login description: All applications must have email login enabled. |
僅允許使用特定 Google 用戶端 ID 登入 Google 帳戶 |
name: organizations/ORGANIZATION_ID/customConstraints/custom.denyUnexpectedGoogleClientId resourceTypes: - identitytoolkit.googleapis.com/DefaultSupportedIdpConfig methodTypes: - CREATE - UPDATE condition: "resource.name.contains('google.com') && !resource.client_id == 'my-client-id'" actionType: DENY displayName: Only allow login with Google with specific Google client ID description: Only allow login with Google with specific Google client ID for all applications. |
只允許特定 SAML 實體 |
name: organizations/ORGANIZATION_ID/customConstraints/custom.allowSpecificSamlEntity resourceTypes: - identitytoolkit.googleapis.com/InboundSamlConfig methodTypes: - CREATE - UPDATE condition: "resource.idp_config.idp_entity_id == 'my-saml-entity-id'" actionType: ALLOW displayName: Only allow a specific SAML entity description: Only allow a specific SAML entity for applications in this organization. |
允許使用程式碼流程的 OIDC IdP |
name: organizations/ORGANIZATION_ID/customConstraints/custom.allowOauthIdpWithCodeFlow resourceTypes: - identitytoolkit.googleapis.com/OauthIdpConfig methodTypes: - CREATE - UPDATE condition: "resource.response_type.code == true" actionType: ALLOW displayName: Allow OIDC IdP with code flow description: All OIDC IdP must use code flow. |
允許在美國境內傳送簡訊 |
name: organizations/ORGANIZATION_ID/customConstraints/custom.allowSmsRegion resourceTypes: - identitytoolkit.googleapis.com/Tenant methodTypes: - CREATE - UPDATE condition: "resource.sms_region_config.allow_by_default.disallowed_regions.exists(disallowed_region, disallowed_region != 'US')" actionType: DENY displayName: Allow SMS region in US description: Only allow SMS to be operated in the US for all applications. |