设置默认 Key Access Justifications 政策
本页面介绍了如何为 Assured Workloads 配置默认 Key Access Justifications 政策。您可以为组织、文件夹或项目设置默认 Key Access Justifications 政策。默认 Key Access Justifications 政策会自动应用于在该资源中创建的新密钥,除非在创建密钥时为其设置了 Key Access Justifications 政策。默认 Key Access Justifications 政策不会应用于现有密钥。
准备工作
- 您只能为 Assured Workloads 中已加入日本数据边界的文件夹中的 Cloud KMS 密钥设置默认 Key Access Justifications 政策。
必需的 IAM 权限
如需获得创建和管理默认 Key Access Justifications 政策所需的权限,请让您的管理员为您授予包含密钥的组织、文件夹或项目的 Key Access Justifications Policy Config Admin (roles/cloudkms.keyAccessJustificationsPolicyConfigAdmin) IAM 角色。
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
此预定义角色包含创建和管理默认 Key Access Justifications 政策所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
您需要具备以下权限才能创建和管理默认 Key Access Justifications 政策:
-
cloudkms.keyAccessJustificationsConfig.getKeyAccessJustificationsPolicyConfig -
cloudkms.keyAccessJustificationsConfig.updateKeyAccessJustificationsPolicyConfig -
cloudkms.keyAccessJustificationsConfig.showEffectiveKeyAccessJustificationsPolicyConfig
设置或更改默认 Key Access Justifications 政策
控制台
在 Google Cloud 控制台中,前往密钥管理页面。
点击 KMS 控制,然后点击 Key Access Justifications (KAJ)。
点击修改。
选择设置 Key Access Justifications 政策,然后选择允许使用特定理由代码。
对于理由,请选择客户发起的访问、Google 发起的系统操作以及您要允许的任何其他原因代码。客户发起的访问和 Google 发起的系统操作对于正常运行都至关重要。
点击创建。
gcloud
为组织设置默认政策
使用带有 --organization 标志的 kms kaj-config update 命令在文件夹上创建或更新默认 Key Access Justifications 政策:
gcloud beta kms kaj-config update
--organization=ORGANIZATION_NUMBER
--allowed-access-reasons="ALLOWED_ACCESS_REASONS"
替换以下内容:
ORGANIZATION_NUMBER:您要为其设置默认 Key Access Justifications 政策的组织的编号。ALLOWED_ACCESS_REASONS:Key Access Justifications 政策,其中列出了允许的访问原因,格式为英文逗号分隔列表,例如CUSTOMER_INITIATED_ACCESS,GOOGLE_INITIATED_SYSTEM_OPERATION。如需查看可能的理由原因列表,请参阅理由代码。
为文件夹设置默认政策
使用带有 --folder 标志的 kms kaj-config update 命令在文件夹上创建或更新默认 Key Access Justifications 政策:
gcloud beta kms kaj-config update
--folder=FOLDER_ID
--allowed-access-reasons="ALLOWED_ACCESS_REASONS"
替换以下内容:
FOLDER_ID:您要为其设置默认 Key Access Justifications 政策的文件夹的 ID。ALLOWED_ACCESS_REASONS:Key Access Justifications 政策,其中列出了允许的访问原因,格式为英文逗号分隔列表,例如CUSTOMER_INITIATED_ACCESS,GOOGLE_INITIATED_SYSTEM_OPERATION。如需查看可能的理由原因列表,请参阅理由代码。
在项目上设置默认政策
使用带有 --project 标志的 kms kaj-config update 命令在项目上创建或更新默认 Key Access Justifications 政策:
gcloud beta kms kaj-config update
--project=PROJECT_ID
--allowed-access-reasons="ALLOWED_ACCESS_REASONS"
替换以下内容:
PROJECT_ID:要为其设置默认 Key Access Justifications 政策的项目的 ID。ALLOWED_ACCESS_REASONS:Key Access Justifications 政策,其中列出了允许的访问原因,格式为英文逗号分隔列表,例如CUSTOMER_INITIATED_ACCESS,GOOGLE_INITIATED_SYSTEM_OPERATION。如需查看可能的理由原因列表,请参阅理由代码。
REST
为组织设置默认政策
使用 organizations.updateKeyAccessJustificationsPolicyConfig 方法在组织上创建或更新默认 Key Access Justifications 政策:
curl "https://cloudkms.googleapis.com/v1/organizations/ORGANIZATION_ID/kajPolicyConfig?updateMask=defaultKeyAccessJustificationPolicy" \
--request "PATCH" \
--header "authorization: Bearer TOKEN" \
--header "content-type: application/json" \
--data '{"name": "organizations/ORGANIZATION_ID/kajPolicyConfig", "defaultKeyAccessJustificationPolicy": POLICY}'
替换以下内容:
ORGANIZATION_ID:您要为其设置默认 Key Access Justifications 政策的组织的 ID。POLICY:列出允许的allowedAccessReasons的 Key Access Justifications 政策,格式为 JSON 对象,例如{"allowedAccessReasons": ["CUSTOMER_INITIATED_ACCESS", "GOOGLE_INITIATED_SYSTEM_OPERATION"]}。如需查看可能的理由原因列表,请参阅理由代码。
为文件夹设置默认政策
使用 folders.updateKeyAccessJustificationsPolicyConfig 方法在文件夹上创建或更新默认 Key Access Justifications 政策:
curl "https://cloudkms.googleapis.com/v1/folders/FOLDER_ID/kajPolicyConfig?updateMask=defaultKeyAccessJustificationPolicy" \
--request "PATCH" \
--header "authorization: Bearer TOKEN" \
--header "content-type: application/json" \
--data '{"name": "folders/FOLDER_ID/kajPolicyConfig", "defaultKeyAccessJustificationPolicy": POLICY}'
替换以下内容:
FOLDER_ID:要为其设置默认 Key Access Justifications 政策的文件夹的 ID。POLICY:列出允许的allowedAccessReasons的 Key Access Justifications 政策,格式为 JSON 对象,例如{"allowedAccessReasons": ["CUSTOMER_INITIATED_ACCESS", "GOOGLE_INITIATED_SYSTEM_OPERATION"]}。如需查看可能的理由原因列表,请参阅理由代码。
在项目上设置默认政策
使用 projects.updateKeyAccessJustificationsPolicyConfig 方法在项目上创建或更新默认 Key Access Justifications 政策:
curl "https://cloudkms.googleapis.com/v1/projects/PROJECT_ID/kajPolicyConfig?updateMask=defaultKeyAccessJustificationPolicy" \
--request "PATCH" \
--header "authorization: Bearer TOKEN" \
--header "content-type: application/json" \
--data '{"name": "projects/PROJECT_ID/kajPolicyConfig", "defaultKeyAccessJustificationPolicy": POLICY}'
替换以下内容:
PROJECT_ID:要为其设置默认 Key Access Justifications 政策的项目的 ID。POLICY:列出允许的allowedAccessReasons的 Key Access Justifications 政策,格式为 JSON 对象,例如{"allowedAccessReasons": ["CUSTOMER_INITIATED_ACCESS", "GOOGLE_INITIATED_SYSTEM_OPERATION"]}。如需查看可能的理由原因列表,请参阅理由代码。
查看默认 Key Access Justifications 政策
控制台
在 Google Cloud 控制台中,前往密钥管理页面。
点击 KMS 控制,然后点击 Key Access Justifications (KAJ)。系统会显示所选组织、文件夹或项目的默认政策。
gcloud
查看组织的默认政策
如需查看针对组织设置的默认政策,请运行带有 --organization 标志的 kms kaj-config
describe 命令:
gcloud beta kms kaj-config describe --organization=ORGANIZATION_NUMBER
将 ORGANIZATION_NUMBER 替换为组织的编号。
响应类似于以下示例:
defaultKeyAccessJustificationPolicy:
defaultPolicyAvailable: true
allowedAccessReasons:
- CUSTOMER_INITIATED_ACCESS
- GOOGLE_INITIATED_SYSTEM_OPERATION
name: organizations/ORGANIZATION_NUMBER/kajPolicyConfig
查看文件夹的默认政策
如需查看针对文件夹设置的默认政策,请运行带有 --folder 标志的 kms kaj-config
describe 命令:
gcloud beta kms kaj-config describe --folder=FOLDER_ID
将 FOLDER_ID 替换为文件夹的 ID。
响应类似于以下示例:
defaultKeyAccessJustificationPolicy:
defaultPolicyAvailable: true
allowedAccessReasons:
- CUSTOMER_INITIATED_ACCESS
- GOOGLE_INITIATED_SYSTEM_OPERATION
name: folders/FOLDER_ID/kajPolicyConfig
查看项目的默认政策
如需查看对项目设置的默认政策,请运行带有 --project 标志的 kms kaj-config
describe 命令:
gcloud beta kms kaj-config describe --project=PROJECT_ID
将 PROJECT_ID 替换为相应项目的 ID。
响应类似于以下示例:
defaultKeyAccessJustificationPolicy:
defaultPolicyAvailable: true
allowedAccessReasons:
- CUSTOMER_INITIATED_ACCESS
- GOOGLE_INITIATED_SYSTEM_OPERATION
name: projects/PROJECT_ID/kajPolicyConfig
此命令会返回在项目上设置的默认政策(如果存在)。如果未在项目上设置默认政策,则此命令不会返回任何政策,即使项目从父级文件夹或组织继承了默认政策也是如此。如需查看项目的有效默认政策,请参阅本页面上的查看项目的有效默认 Key Access Justifications 政策。
REST
使用 organizations.getKajPolicyConfig 方法获取组织中现有默认 Key Access Justifications 政策的相关元数据:
curl "https://cloudkms.googleapis.com/v1/organizations/ORGANIZATION_ID/kajPolicyConfig"
将 ORGANIZATION_ID 替换为您要获取其默认 Key Access Justifications 政策的组织的 ID。
响应类似于以下示例:
{
"name" : "organizations/ORGANIZATION_ID/kajPolicyConfig"
"defaultKeyAccessJustificationPolicy": {
"defaultPolicyAvailable": true,
"allowedAccessReasons": [
"CUSTOMER_INITIATED_ACCESS",
"GOOGLE_INITIATED_SYSTEM_OPERATION"
]
}
}
使用 folders.getKajPolicyConfig 方法获取文件夹中现有默认 Key Access Justifications 政策的相关元数据:
curl "https://cloudkms.googleapis.com/v1/folders/FOLDER_ID/kajPolicyConfig"
将 FOLDER_ID 替换为您要获取其默认 Key Access Justifications 政策的文件夹的 ID。
响应类似于以下示例:
{
"name" : "folders/FOLDER_ID/kajPolicyConfig"
"defaultKeyAccessJustificationPolicy": {
"defaultPolicyAvailable": true,
"allowedAccessReasons": [
"CUSTOMER_INITIATED_ACCESS",
"GOOGLE_INITIATED_SYSTEM_OPERATION"
]
}
}
使用 projects.getKajPolicyConfig 方法获取有关项目上现有默认 Key Access Justifications 政策的元数据:
curl "https://cloudkms.googleapis.com/v1/projects/PROJECT_ID/kajPolicyConfig"
将 PROJECT_ID 替换为您要获取其默认 Key Access Justifications 政策的项目的 ID。
响应类似于以下示例:
{
"name" : "project/PROJECT_ID/kajPolicyConfig"
"defaultKeyAccessJustificationPolicy": {
"defaultPolicyAvailable": true,
"allowedAccessReasons": [
"CUSTOMER_INITIATED_ACCESS",
"GOOGLE_INITIATED_SYSTEM_OPERATION"
]
}
}
查看项目的有效默认 Key Access Justifications 政策
项目会从其最近的父级文件夹或组织继承默认政策。如果对单个项目的祖先设置了多个默认政策,您可以获取项目的有效政策,以查看应用于在该项目中创建的新 Cloud KMS 密钥的政策。
在 Google Cloud 控制台中,当您在项目中创建密钥时,系统会显示项目上有效的默认 Key Access Justifications 政策。在密钥创建期间,您可以选择是沿用有效的默认政策,还是创建新的密钥和政策。
gcloud
如需查看项目上有效的默认 Key Access Justifications 政策的相关元数据,请调用 projects.showEffectiveKeyAccessJustificationsPolicyConfig 方法:
gcloud beta kms kaj-config show-effective-config --project=PROJECT_ID
将 PROJECT_ID 替换为您要获取其有效默认 Key Access Justifications 政策的项目的 ID。
响应类似于以下示例:
effectiveKajPolicy:
defaultKeyAccessJustificationPolicy:
defaultPolicyAvailable: true
allowedAccessReasons:
- CUSTOMER_INITIATED_ACCESS
- GOOGLE_INITIATED_SYSTEM_OPERATION
name: folders/FOLDER_ID/kajPolicyConfig
REST
如需查看项目上有效的默认 Key Access Justifications 政策的相关元数据,请调用 projects.showEffectiveKeyAccessJustificationsPolicyConfig 方法:
curl "https://cloudkms.googleapis.com/v1/projects/PROJECT_ID:showEffectiveKeyAccessJustificationsPolicyConfig"
将 PROJECT_ID 替换为您要获取其有效默认 Key Access Justifications 政策的项目的 ID。
响应类似于以下示例:
{
"effectiveKajPolicy" : {
"name" : "folders/FOLDER_ID/kajPolicyConfig"
"defaultKeyAccessJustificationPolicy": {
"defaultPolicyAvailable": true,
"allowedAccessReasons": [
"CUSTOMER_INITIATED_ACCESS",
"GOOGLE_INITIATED_SYSTEM_OPERATION"
]
}
}
}