本页面介绍了如何使用组织政策服务自定义限制条件来限制对以下 Google Cloud 资源执行的特定操作：
secretmanager.googleapis.com/Secret
如需详细了解组织政策，请参阅自定义组织政策。
组织政策和限制条件简介
借助 Google Cloud 组织政策服务，您可以对组织的资源进行程序化集中控制。作为组织政策管理员，您可以定义组织政策，这是一组称为限制条件的限制，会应用于 Google Cloud 资源层次结构中的Google Cloud 资源及其后代。您可以在组织、文件夹或项目级强制执行组织政策。
组织政策为各种 Google Cloud 服务提供内置的托管式限制。但是，如果您想要更精细地控制和自定义组织政策中受限的特定字段，还可以创建自定义限制条件并在组织政策中使用这些自定义限制条件。
政策继承
如果您对资源强制执行政策，默认情况下，该资源的后代会继承组织政策。例如，如果您对某个文件夹强制执行一项政策， Google Cloud 会对该文件夹中的所有项目强制执行该政策。如需详细了解此行为及其更改方式，请参阅层次结构评估规则。
优势
使用自定义组织政策可执行以下操作：
- 强制要求用户向密文添加注释、为密文设置过期日期或设置密文版本的延迟销毁，从而强制执行严格的安全要求。
- 要求特定项目或文件夹中的所有 Secret 都设置轮换时间表，以支持特定的轮换要求。
- 验证注释和版本别名是否与自动化脚本中所选的表达式一致。
- 通过限制组织内允许的 Secret 类型来控制云费用。
限制
- 您可以使用
expire_time（特定时间点）或ttl（时长）来定义 Secret 的到期时间。在自定义组织政策中，您只能使用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.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
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.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
-
Install the Google Cloud CLI.
-
如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。
-
如需初始化 gcloud CLI，请运行以下命令：
gcloud init - 请确保您知道您的组织 ID。
-
组织资源的 Organization Policy Administrator (
roles/orgpolicy.policyAdmin) -
如要创建或更新 Secret，则需要以下角色：
项目的 Secret Manager Admin (
roles/secretmanager.admin) 角色 -
组织资源的
orgpolicy.* -
如需创建或更新 Secret Manager Secret，请执行以下操作：
-
项目资源的
secretmanager.secrets.create -
项目资源的
secretmanager.secrets.get -
项目资源的
secretmanager.secrets.list -
项目资源的
secretmanager.secrets.update
-
项目资源的
- 在 Google Cloud 控制台中，转到组织政策页面。
- 在项目选择器中，选择要为其设置组织政策的项目。
- 点击 自定义限制条件。
- 在显示名称框中，为限制条件输入一个人类可读名称。此名称会在错误消息中使用，并可用于识别和调试用途。请勿在显示名称中使用个人身份信息或敏感数据，因为此名称可能会在错误消息中公开。此字段最多可包含 200 个字符。
-
在限制条件 ID 框中，为新的自定义限制条件输入所需的名称。自定义限制条件只能包含字母（包括大写和小写）或数字，例如
custom.disableGkeAutoUpgrade。此字段最多可包含 70 个字符，不计算前缀 (custom.)，例如organizations/123456789/customConstraints/custom。请勿在限制条件 ID 中包含个人身份信息或敏感数据，因为该 ID 可能会在错误消息中公开。 - 在说明框中，输入人类可读的限制条件说明。当违反政策时，此说明将用作错误消息。请包含有关发生违规的原因以及如何解决违规问题的详细信息。请勿在说明中包含个人身份信息或敏感数据，因为该说明可能会在错误消息中公开。 此字段最多可包含 2000 个字符。
-
在资源类型框中，选择包含要限制的对象和字段的 Google Cloud REST 资源的名称，例如
container.googleapis.com/NodePool。大多数资源类型最多支持 20 个自定义限制条件。如果您尝试创建更多自定义限制条件，操作将会失败。 - 在强制执行方法下，选择是对 REST CREATE 方法强制执行限制条件，还是同时对 CREATE 和 UPDATE 方法强制执行限制条件。如果您对违反限制条件的资源使用 UPDATE 方法强制执行限制条件，除非更改解决了违规问题，否则组织政策会阻止对该资源的更改。
- 如需定义条件，请点击 修改条件。
-
在添加条件面板中，创建一个引用受支持服务资源的 CEL 条件，例如
resource.management.autoUpgrade == false。此字段最多可包含 1,000 个字符。如需详细了解 CEL 用法，请参阅通用表达式语言。 如需详细了解可在自定义限制条件中使用的服务资源，请参阅自定义限制条件支持的服务。 - 点击保存。
- 在操作下，选择在满足条件时是允许还是拒绝评估的方法。
- 点击创建限制条件。
- 如需创建自定义限制条件，请使用以下格式创建 YAML 文件：
ORGANIZATION_ID：您的组织 ID，例如123456789。-
CONSTRAINT_NAME：新的自定义限制条件的名称。自定义限制条件只能包含字母（包括大写和小写）或数字，例如custom.ensureVersionDestroyTTL。此字段最多可包含 70 个字符。 -
RESOURCE_NAME：包含要限制的对象和字段的 Google Cloud资源的完全限定名称。例如secretmanager.googleapis.com/Secret。 -
CONDITION：针对受支持服务资源的表示形式编写的 CEL 条件。此字段最多可包含 1,000 个字符。例如"resource.versionDestroyTtl < duration('30h')"。 -
ACTION：满足condition时要执行的操作。 可能的值包括ALLOW和DENY。 -
DISPLAY_NAME：限制条件的直观易记名称。此字段最多可包含 200 个字符。 -
DESCRIPTION：直观易懂的限制条件说明，当违反政策时会作为错误消息显示。此字段最多可包含 2000 个字符。 -
为新的自定义限制条件创建 YAML 文件后，您必须对其进行设置，以使其可用于组织中的组织政策。如需设置自定义限制条件，请使用
gcloud org-policies set-custom-constraint命令： - 如需验证自定义限制条件是否存在，请使用
gcloud org-policies list-custom-constraints命令： - 在 Google Cloud 控制台中，前往组织政策页面。
- 在项目选择器中，选择要为其设置组织政策的项目。
- 从组织政策页面上的列表中选择您的限制条件，以查看该限制条件的政策详情页面。
- 如需为该资源配置组织政策，请点击管理政策。
- 在修改政策页面，选择覆盖父级政策。
- 点击添加规则。
- 在强制执行部分中，选择是否强制执行此组织政策。
- （可选）如需使组织政策成为基于某个标记的条件性政策，请点击添加条件。请注意，如果您向组织政策添加条件规则，则必须至少添加一个无条件规则，否则无法保存政策。如需了解详情，请参阅设置带有标记的组织政策。
- 点击测试更改以模拟组织政策的效果。如需了解详情，请参阅使用 Policy Simulator 测试组织政策更改。
- 如需在试运行模式下强制执行组织政策，请点击设置试运行政策。如需了解详情，请参阅在试运行模式下创建组织政策。
- 验证试运行模式下的组织政策按预期运行后，点击设置政策来设置现行政策。
- 如需创建包含布尔值规则的组织政策，请创建引用该限制条件的 YAML 政策文件：
-
PROJECT_ID：要对其强制执行您的限制条件的项目。 -
CONSTRAINT_NAME：您为自定义限制条件定义的名称。例如，custom.ensureVersionDestroyTTL。 -
如需在试运行模式下强制执行组织政策，请运行以下带有
dryRunSpec标志的命令： -
验证试运行模式下的组织政策按预期运行后，使用
org-policies set-policy命令和spec标志设置现行政策： - 为每个项目启用一次 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=
所需的角色
如需获得管理组织政策所需的权限，请让您的管理员为您授予以下 IAM 角色：
如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。
这些预定义角色包含管理组织政策所需的权限。如需查看所需的确切权限，请展开所需权限部分：
所需权限
管理组织政策需要以下权限：
设置自定义限制条件
自定义限制条件是在 YAML 文件中，由实施组织政策的服务所支持的资源、方法、条件和操作定义的。自定义限制条件的条件使用通用表达式语言 (CEL) 进行定义。如需详细了解如何使用 CEL 构建自定义限制条件中的条件，请参阅创建和管理自定义限制条件的 CEL 部分。
控制台
如需创建自定义限制条件，请执行以下操作：
并非所有 Google Cloud 服务都支持这两种方法。如需查看每种服务支持的方法，请在支持的服务中找到相应服务。
拒绝操作意味着，如果条件计算结果为 true，则创建或更新资源的操作会被阻止。
允许操作意味着，仅当条件计算结果为 true 时，才允许执行创建或更新资源的操作。除了条件中明确列出的情况之外，其他所有情况都会被阻止。
在每个字段中输入值后，右侧将显示此自定义限制条件的等效 YAML 配置。
gcloud
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME resourceTypes: - RESOURCE_NAME methodTypes: - CREATE
- UPDATE condition: "CONDITION" actionType: ACTION displayName: DISPLAY_NAME description: DESCRIPTION
请替换以下内容：
如需详细了解可针对其编写条件的资源，请参阅支持的资源。
允许操作意味着，如果条件计算结果为 true，则允许执行创建或更新资源的操作。这也意味着，除了条件中明确列出的情况之外，其他所有情况都会被阻止。
拒绝操作意味着，如果条件计算结果为 true，则创建或更新资源的操作会被阻止。
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
将 CONSTRAINT_PATH 替换为自定义限制条件文件的完整路径。例如 /home/user/customconstraint.yaml。
此操作完成后，您的自定义限制条件将作为组织政策显示在您的 Google Cloud 组织政策列表中。
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
将 ORGANIZATION_ID 替换为您的组织资源的 ID。
如需了解详情，请参阅查看组织政策。
强制执行自定义组织政策
如需强制执行限制条件，您可以创建引用该限制条件的组织政策，并将该组织政策应用于 Google Cloud 资源。控制台
gcloud
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME spec: rules: - enforce: true dryRunSpec: rules: - enforce: true
请替换以下内容：
gcloud org-policies set-policy POLICY_PATH \ --update-mask=dryRunSpec
将 POLICY_PATH 替换为组织政策 YAML 文件的完整路径。该政策最长需要 15 分钟才能生效。
gcloud org-policies set-policy POLICY_PATH \ --update-mask=spec
将 POLICY_PATH 替换为组织政策 YAML 文件的完整路径。该政策最长需要 15 分钟才能生效。
测试自定义组织政策
以下示例展示了如何配置自定义限制条件和政策，以确保在给定项目中创建的所有新密钥的销毁延迟时长 (version_destroy_ttl) 至少为 30 小时。
在开始之前，请确保满足以下条件：
创建限制条件
创建政策
应用政策后，请等待大约两分钟，以便 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"]
常见用例的自定义组织政策示例
下表提供了一些常见自定义限制条件的语法示例。
| 说明 | 限制条件语法 |
|---|---|
| 必须将版本销毁 TTL 设置为两天以上 |
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
|