本頁面由 Cloud Translation API 翻譯而成。

使用自訂機構政策

本頁說明如何使用 Organization Policy Service 自訂限制，限制對下列 Google Cloud 資源執行的特定作業：

secretmanager.googleapis.com/Secret

如要進一步瞭解機構政策，請參閱「自訂機構政策」。

關於機構政策和限制

Google Cloud 機構政策服務可讓您透過程式以集中方式控管機構的資源。身為機構政策管理員，您可以定義機構政策，也就是一組稱為「限制」的限制，適用於Google Cloud 資源和Google Cloud 資源階層中這些資源的子系。您可以在機構、資料夾或專案層級強制執行機構政策。

機構政策提供各種 Google Cloud 服務的內建代管限制。不過，如要更精細地自訂機構政策中受限的特定欄位，也可以建立自訂限制，並在機構政策中使用這些自訂限制。

政策繼承

根據預設，機構政策會由您強制執行政策的資源子系繼承。舉例來說，如果您對資料夾強制執行政策， Google Cloud 系統會對該資料夾中的所有專案強制執行政策。如要進一步瞭解這項行為及如何變更，請參閱「階層評估規則」。

優點

您可以透過自訂機構政策執行下列操作：

強制規定使用者為密鑰新增註解、設定密鑰到期日，或設定延遲銷毀密鑰版本，以落實嚴格的安全防護措施。
支援特定輪替需求：要求特定專案或資料夾中的所有密鑰都設定輪替排程。
確認註解和版本別名與自動指令碼中選取的運算式相符。
限制機構內允許的密鑰類型，控管雲端費用。

限制

您可以使用 expire_time (特定時間點) 或 ttl (時間長度) 定義密鑰的到期時間。在自訂機構政策中，您只能使用 expire_time 判斷密鑰何時到期。如果您為密鑰設定 ttl，Secret Manager 會將其轉換為 expire_time 值，以處理及評估政策。

事前準備

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

如果您使用外部識別資訊提供者 (IdP)，請先使用聯合身分登入 gcloud CLI。

如要初始化 gcloud CLI，請執行下列指令：

gcloud init

請確認您知道機構 ID。

必要的角色

如要取得管理機構政策所需的權限，請要求管理員授予下列 IAM 角色：

機構政策管理員 (roles/orgpolicy.policyAdmin) 機構資源
如要建立或更新密鑰：專案的 Secret Manager 管理員 (roles/secretmanager.admin)

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

這些預先定義角色具備管理機構政策所需的權限。如要查看確切的必要權限，請展開「必要權限」部分：

所需權限

如要管理組織政策，您必須具備下列權限：

orgpolicy.* 機構資源
如要建立或更新 Secret Manager 密鑰：
- 專案資源的 secretmanager.secrets.create
- 專案資源的 secretmanager.secrets.get
- 專案資源的 secretmanager.secrets.list
- 專案資源的 secretmanager.secrets.update

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

建立自訂限制

自訂限制是在 YAML 檔案中定義，其中包含您要強制執行機構政策的服務所支援的資源、方法、條件和動作。自訂限制的條件是使用一般運算語言 (CEL) 定義。如要進一步瞭解如何使用 CEL 在自訂限制中建構條件，請參閱「建立及管理自訂限制」一文的 CEL 一節。

如要建立自訂限制，請使用下列格式建立 YAML 檔案：

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

更改下列內容：

ORGANIZATION_ID：您的機構 ID，例如 123456789。
CONSTRAINT_NAME：新自訂限制的名稱。自訂限制條件必須以 custom. 開頭，且只能包含大寫英文字母、小寫英文字母或數字。例如，custom.ensureVersionDestroyTTL。這個欄位的長度上限為 70 個字元。
RESOURCE_NAME：包含要限制物件和欄位的Google Cloud 資源完整名稱。例如：secretmanager.googleapis.com/Secret。
CONDITION：針對支援服務資源的代表項目編寫的 CEL 條件。這個欄位的長度上限為 1000 個字元。如要進一步瞭解可編寫條件的資源，請參閱「支援的資源」。例如："resource.versionDestroyTtl < duration('30h')"。
ACTION：如果符合 condition，應採取的動作。可能的值為 ALLOW 和 DENY。
DISPLAY_NAME：限制條件的易記名稱。這個欄位的長度上限為 200 個字元。
DESCRIPTION：違反政策時，要以錯誤訊息形式顯示的限制說明。這個欄位的長度上限為 2000 個字元。

如要進一步瞭解如何建立自訂限制，請參閱「定義自訂限制」。

設定自訂限制

gcloud org-policies set-custom-constraint

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

CONSTRAINT_PATH

/home/user/customconstraint.yaml

gcloud org-policies list-custom-constraints

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

ORGANIZATION_ID

查看組織政策

強制執行自訂機構政策

控制台

前往 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.ensureVersionDestroyTTL。

如要強制執行包含限制的機構政策，請執行下列指令：

    gcloud org-policies set-policy POLICY_PATH

將 POLICY_PATH 替換為機構政策 YAML 檔案的完整路徑。這項政策最多需要 15 分鐘才會生效。

測試自訂機構政策

以下範例說明如何設定自訂限制和政策，確保在特定專案中建立的所有新密鑰，銷毀延遲時間 (version_destroy_ttl) 至少為 30 小時。

在開始之前，請確認下列事項：

為每個專案啟用 Secret Manager API。
瞭解機構 ID。
瞭解專案 ID。

建立限制

將下列檔案儲存為 constraint.yaml：

name: organizations/ORGANIZATION_ID/customConstraints/custom.ensureVersionDestroyTTLAtLeast30hours
resourceTypes:
- secretmanager.googleapis.com/Secret
methodTypes:
- CREATE
condition: "resource.versionDestroyTtl < duration('30h')"
actionType: DENY
displayName: Enable Secret Version Destroy TTL with at least 30 hours
description: All new secrets must have Version Destroy TTL values of at least 30 hours

這項限制定義了每個新密鑰的條件：如果未套用密鑰版本 version_destroy_ttl，或 version_destroy_ttl 小於 30 小時，系統就會拒絕作業。

套用限制：

gcloud org-policies set-custom-constraint ~/constraint.yaml

確認限制條件是否存在：

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

輸出結果會與下列內容相似：

CUSTOM_CONSTRAINT                               ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                        DISPLAY_NAME
custom.ensureVersionDestroyTTLAtLeast30hours    DENY         CREATE         secretmanager.googleapis.com/Secret   Enable Secret Version Destroy TTL with at least 30 hours
...

建立政策

將下列檔案儲存為 policy.yaml：

name: projects/PROJECT_ID/policies/custom.ensureVersionDestroyTTLAtLeast30hours
spec:
  rules:
  - enforce: true

將 PROJECT_ID 替換為您的專案 ID。

套用政策：

gcloud org-policies set-policy ~/policy.yaml

確認政策存在：

gcloud org-policies list --project=PROJECT_ID

輸出結果會與下列內容相似：

CONSTRAINT                                    LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.ensureVersionDestroyTTLAtLeast30hours  -              SET               COCsm5QGENiXi2E=

套用政策後，請等待約兩分鐘， Google Cloud 就會開始強制執行政策。

測試政策

gcloud secrets create org-policy-test-secret \
    --project=PROJECT_ID \
    --version-destroy-ttl=100000s

輸出內容如下：

Operation denied by custom org policies: ["customConstraints/custom.ensureVersionDestroyTTL": "All new secrets must have version destroy TTL values with at least 30 hours"]

常見用途的自訂機構政策範例

下表提供一些常見自訂限制的語法範例。

說明	限制語法
必須將版本銷毀存留時間設為兩天以上	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.secretManagerEnableTTL resourceTypes: - secretmanager.googleapis.com/Secret methodTypes: - CREATE condition: "has(resource.versionDestroyTtl) && resource.versionDestroyTtl.getSeconds() > 172800" actionType: ALLOW displayName: Must set version destroy TTL more than one hour description: All new secrets must set version destroy TTL and version destroy TTL seconds should be more than two days
設定 Pub/Sub 主題	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.secretsWithPubSubTopic resourceTypes: - secretmanager.googleapis.com/Secret methodTypes: - CREATE - UPDATE condition: "has(resource.topics) && size(resource.topics) > 0 && resource.topics[0].name.matches('projects/a_test_project/topics/a_topic_name')" actionType: ALLOW displayName: Set secret first topic as a_topic_name description: All secret must use a_topic_name Pub/Sub topic as the first topic for notifications.
拒絕含有前置字串的註解	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.secretManagerAnnotationPrefixes resourceTypes: - secretmanager.googleapis.com/Secret methodTypes: - CREATE condition: "has(resource.annotations) && resource.annotations['key1'].startsWith('some-prefix-')" actionType: DENY displayName: Deny annotation of 'key1' with prefix 'some-prefix-' description: All new secrets should not have 'key1' annotations set with prefix 'some-prefix-'.

說明

限制語法

必須將版本銷毀存留時間設為兩天以上

  name: organizations/ORGANIZATION_ID/customConstraints/custom.secretManagerEnableTTL
  resourceTypes:
  - secretmanager.googleapis.com/Secret
  methodTypes:
  - CREATE
  condition: "has(resource.versionDestroyTtl) && resource.versionDestroyTtl.getSeconds() > 172800"
  actionType: ALLOW
  displayName: Must set version destroy TTL more than one hour
  description: All new secrets must set version destroy TTL and version destroy TTL seconds should be more than two days

設定 Pub/Sub 主題

  name: organizations/ORGANIZATION_ID/customConstraints/custom.secretsWithPubSubTopic
  resourceTypes:
  - secretmanager.googleapis.com/Secret
  methodTypes:
  - CREATE
  - UPDATE
  condition: "has(resource.topics) && size(resource.topics) > 0 && resource.topics[0].name.matches('projects/a_test_project/topics/a_topic_name')"
  actionType: ALLOW
  displayName: Set secret first topic as a_topic_name
  description: All secret must use a_topic_name Pub/Sub topic as the first topic for notifications.

拒絕含有前置字串的註解

    name: organizations/ORGANIZATION_ID/customConstraints/custom.secretManagerAnnotationPrefixes
    resourceTypes:
    - secretmanager.googleapis.com/Secret
    methodTypes:
    - CREATE
    condition: "has(resource.annotations) && resource.annotations['key1'].startsWith('some-prefix-')"
    actionType: DENY
    displayName: Deny annotation of 'key1' with prefix 'some-prefix-'
    description: All new secrets should not have 'key1' annotations set with prefix 'some-prefix-'.

Secret Manager 支援的資源

本節的表格列出可在自訂限制中參照的 Secret Manager 資源。

如要設定資源位置限制，請使用資源位置機構政策。同樣地，如要設定 CMEK 用量限制，建議您使用 CMEK 組織政策。

資源	欄位
secretmanager.googleapis.com/Secret	`resource.annotations`
	`resource.expireTime`
	`resource.rotation.nextRotationTime`
	`resource.rotation.rotationPeriod`
	`resource.topics.name`
	`resource.versionAliases`
	`resource.versionDestroyTtl`

後續步驟

進一步瞭解機構政策服務。
進一步瞭解如何建立及管理機構政策。
請參閱受管理機構政策限制的完整清單。

使用自訂機構政策 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

關於機構政策和限制

政策繼承

優點

限制

事前準備

必要的角色

所需權限

建立自訂限制

設定自訂限制

強制執行自訂機構政策

控制台

gcloud

測試自訂機構政策

建立限制

建立政策

測試政策

常見用途的自訂機構政策範例

Secret Manager 支援的資源

後續步驟

使用自訂機構政策