使用客户管理的加密密钥配置加密

Cloud Composer 1 | Cloud Composer 2

本页面介绍如何使用客户管理的加密密钥 (CMEK) 保护 Cloud Composer 环境。客户管理的加密密钥用于加密/解密环境中的用户数据。

准备工作

• 您只能在创建环境时配置 CMEK。无法为现有环境启用 CMEK。

• Cloud Composer 支持使用存储在外部密钥管理器中的密钥进行 CMEK 加密。

• 您必须在环境所在的区域中创建 CMEK 密钥。您无法使用多区域密钥或全局密钥。

• 如果您希望环境在 VPC Service Controls 边界内运行，则必须将 Cloud Key Management Service API 和 Artifact Registry API 添加到该边界中。

• 启用 Artifact Registry API。

  控制台

  启用 Artifact Registry API。

  启用 API

  gcloud

  Enable the Artifact Registry API:

  gcloud services enable artifactregistry.googleapis.com

用户信息不受 CMEK 加密保护

Cloud Monitoring 不支持 CMEK 加密。您的环境名称和 DAG 名称会以加密形式使用 Google 管理的加密密钥存储在 Monitoring 数据库中。

Cloud Composer 会存储使用 Google 管理的密钥（而非客户管理的密钥）保护的以下信息：

• 环境名称
• Airflow 配置替换
• 环境变量
• 允许的 IP 范围的说明
• IP 范围
• 标签
• Cloud Composer 存储的某些参数的名称可以包含环境名称的子字符串。

警告 ：如果您使用自定义环境的存储桶，则 Cloud Composer 不会更改您指定的存储桶的加密设置，因此也不会使用 CMEK 密钥对其进行加密（即使项目的政策要求加密也是如此）。具体而言，如果您的环境使用 CMEK 加密，则自定义存储桶的加密不会发生变化。自定义存储桶遵循其所属项目的政策。在创建环境之前，您可以使用 CMEK 密钥手动加密环境的存储桶。

为您的环境使用客户管理的加密密钥

警告 ：如果您创建了一个具有客户管理的加密密钥的环境，但随后停用或删除密钥，则该环境将变得不可用。如果环境的加密密钥被删除或停用，则无法恢复该环境。

第 1 步：创建客户管理的加密密钥

按照创建对称加密密钥中列出的步骤，在您的环境所在的区域中创建密钥。

第 2 步：向服务代理授予角色

重要提示 ：如果您的项目的网域限定共享政策排除了 google.com 网域中的地址，您必须关闭（或展开）此政策才能向服务代理授予所需的角色。授予这些角色后，您可以还原政策更改。此政策不会影响环境的创建。

控制台

跳过此步骤。为您的环境指定密钥时，您可以向服务代理授予权限。

gcloud

以下服务代理必须对您用于环境的密钥具有 Cloud KMS CryptoKey Encrypter/Decrypter 角色。

将 PROJECT_NUMBER 替换为您的项目编号。

服务代理名称	服务账号电子邮件地址	API 服务名称
Cloud Composer Service Agent	[e-mail]	composer.googleapis.com
Artifact Registry Service Agent	[e-mail]	artifactregistry.googleapis.com
Kubernetes Engine Service Agent	[e-mail]	container.googleapis.com
Pub/Sub 服务代理	[e-mail]	pubsub.googleapis.com
Compute Engine Service Agent	[e-mail]	compute.googleapis.com
Cloud Storage 服务代理	[e-mail]	使用 gsutil kms authorize 授予加密/解密权限

1. （如果需要）如果您的项目中不存在其中某些服务帐号，则表示尚未创建此服务的身份。例如，如果您尚未在项目中创建任何 Cloud Composer 环境，则可能会发生这种情况。

   如需添加这些服务帐号，请使用以下命令为列出的服务创建身份：

   gcloud beta services identity create \
     --service=API_SERVICE_NAME
   

   将 API_SERVICE_NAME 替换为项目中没有服务帐号的服务的 API 服务名称。

   示例：

   gcloud beta services identity create \
     --service=composer.googleapis.com
   

2. 向服务代理授予权限：

   1. 将角色授予 Cloud Composer 服务代理：

      gcloud kms keys add-iam-policy-binding KEY_NAME \
        --location KEY_LOCATION \
        --keyring KEY_RING_NAME \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project KEY_PROJECT_ID
      

   2. 向 Artifact Registry Service Agent 授予角色：

      gcloud kms keys add-iam-policy-binding KEY_NAME \
        --location KEY_LOCATION \
        --keyring KEY_RING_NAME \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project KEY_PROJECT_ID
      

   3. 将角色授予 GKE 服务代理：

      gcloud kms keys add-iam-policy-binding KEY_NAME \
        --location KEY_LOCATION \
        --keyring KEY_RING_NAME \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project KEY_PROJECT_ID
      

   4. 向 Pub/Sub 服务代理授予角色：

      gcloud kms keys add-iam-policy-binding KEY_NAME \
        --location KEY_LOCATION \
        --keyring KEY_RING_NAME \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project KEY_PROJECT_ID
      

   5. 将角色授予 Compute Engine 服务代理：

      gcloud kms keys add-iam-policy-binding KEY_NAME \
        --location KEY_LOCATION \
        --keyring KEY_RING_NAME \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project KEY_PROJECT_ID
      

   6. 向 Cloud Storage Service Agent 授予加密/解密权限。如果您使用的是自定义环境的存储桶，则可以跳过此步骤。

      gsutil kms authorize -k \
        projects/KEY_PROJECT_ID/locations/KEY_LOCATION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
      

   您需要将其中的：

   • 将 PROJECT_ID 替换为您的项目 ID。
   • 将 KEY_PROJECT_ID 替换为存储客户管理的密钥的项目的 ID。如果您使用其他项目的密钥，则此值与项目的 ID 不同。如果您使用同一项目中的密钥，则此值为项目的 ID。
   • 将 PROJECT_NUMBER 替换为您的项目编号。
   • 将 KEY_LOCATION 替换为您的客户管理的密钥位置。此位置必须与您环境的位置相同。
   • 将 KEY_NAME 替换为您的客户管理的密钥名称。
   • 将 KEY_RING_NAME 替换为用于存储客户管理的密钥的密钥环。

   如需获取这些值，您可以运行 gcloud projects describe、gcloud kms keyrings list 和 gcloud kms keys describe 命令。

第 3 步：使用 CMEK 创建环境

创建客户管理的加密密钥后，您可以使用该密钥创建 Cloud Composer 环境。

控制台

当您创建环境时：

1. 在数据加密部分中，选择客户管理的加密密钥 (CMEK)。

2. 在选择客户管理的密钥下拉列表中，选择您的密钥。

3. 如果需要进行额外设置，系统会显示一条消息来通知您。在这种情况下：

   1. 点击打开向导。

   2. 在准备 CMEK 密钥以在 Cloud Composer 中使用对话框中，查看必须对密钥具有 Cloud KMS CryptoKey Encrypter/Decrypter 角色的服务代理的列表。

   3. 如需授予所需的角色和权限，请点击授予。

   重要提示 ：如果您的项目的网域限定共享政策排除了 google.com 网域中的地址，您必须关闭（或展开）此政策才能向服务代理授予所需的角色。授予这些角色后，您可以还原政策更改。此政策不会影响环境的创建。

gcloud

--kms-key 参数为您的环境指定客户管理的加密密钥。

如需详细了解如何创建环境，请参阅创建环境。例如，您可能需要为自己的环境指定其他参数。

gcloud composer environments create ENVIRONMENT_NAME \
  --location LOCATION \
  --image-version IMAGE_VERSION \
  --kms-key projects/KEY_PROJECT_ID/locations/KEY_LOCATION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

您需要将其中的：

• ENVIRONMENT_NAME 替换为环境的名称。
• 将 IMAGE_VERSION 替换为 Cloud Composer 映像的名称。
• 将 KEY_PROJECT_ID 替换为密钥所在项目的 ID。如果您使用其他项目的密钥，则此值与项目的 ID 不同。如果您使用同一项目中的密钥，则此值为项目的 ID。
• LOCATION 替换为环境所在的区域。
• 将 KEY_LOCATION 替换为您的客户管理的密钥的位置。此位置必须与您的环境的位置相同。
• 将 KEY_NAME 替换为您的客户管理的密钥名称。
• 将 KEY_RING_NAME 替换为用于存储客户管理的密钥的密钥环。

示例：

gcloud composer environments create example-environment \
  --location us-central1 \
  --image-version composer-2.5.1-airflow-2.6.3 \
  --kms-key projects/example-project/locations/us-central1/keyRings/example-key-ring/cryptoKeys/example-key

查看环境的加密配置

您可以查看现有环境的加密配置：

控制台

1. 在 Google Cloud 控制台中，转到环境页面。

   转到“环境”

2. 在环境列表中，点击您的环境名称。环境详情页面会打开。

3. 转到环境配置标签页。

4. 数据加密密钥项中列出了有关加密的详细信息。

gcloud

运行以下 gcloud 命令以查看加密配置

gcloud composer environments describe \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --format="value(config.encryptionConfig)"

您需要将其中的：

• ENVIRONMENT_NAME 替换为环境的名称。
• LOCATION 替换为环境所在的区域。

示例：

gcloud composer environments describe \
  example-environment \
  --location us-central1 \
  --format="value(config.encryptionConfig)"

将 CMEK 用于 Cloud Composer 日志

Cloud Logging 支持使用 CMEK 密钥加密日志存储。我们建议使用标准 CMEK 过程来加密具有 CMEK 密钥的日志。

如需使用 CMEK 密钥加密日志，请按照管理保护 Logging 存储数据的密钥中所述的说明操作。

已弃用 ：以下关于将 Cloud Composer 日志重定向到由 CMEK 加密的 Cloud Storage 存储桶的说明已弃用。如果您在项目中使用此方法，请考虑改用 CMEK 密钥加密日志存储。

将 Cloud Composer 日志重定向到由 CMEK 加密的 Cloud Storage 存储桶

如果您预计日志包含敏感数据，则可能需要使用日志路由器将 Cloud Composer 日志重定向到由 CMEK 加密的 Cloud Storage 存储桶。这样做可以防止将日志发送到 Monitoring。

如果您需要 Cloud Customer Care 的支持，可能需要向 Google 支持工程师授予对 Cloud Storage 中存储的 Cloud Composer 日志的访问权限。

注意：审核日志不能排除。它们始终会发送到默认存储空间。

gcloud

1. 创建新的 Cloud Storage 存储桶来存储日志。

   gsutil mb -l LOCATION gs://BUCKET_NAME
   

   您需要将其中的：

   • LOCATION 替换为环境所在的区域。
   • 将 BUCKET_NAME 替换为存储桶的名称。

   示例：

   gsutil mb -l us-central1 gs://composer-logs-us-central1-example-environment
   

2. 使用 CMEK 密钥加密存储桶。

   gsutil kms encryption \
     -k projects/KEY_PROJECT_ID/locations/KEY_LOCATION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME \
     gs://BUCKET_NAME
   

   您需要将其中的：

   • 将 KEY_PROJECT_ID 替换为密钥所在项目的 ID。如果您使用其他项目的密钥，则此值与项目的 ID 不同。如果您使用同一项目中的密钥，则此值为项目的 ID。
   • 将 KEY_LOCATION 替换为您的客户管理的密钥的位置。此位置必须与您的环境的位置相同。
   • 将 KEY_RING_NAME 替换为用于存储客户管理的密钥的密钥环。
   • 将 KEY_NAME 替换为您的客户管理的密钥名称。
   • BUCKET_NAME 替换为存储桶的名称。

   示例：

   gsutil kms encryption \
     -k projects/example-project/locations/us-central1/keyRings/example-key-ring/cryptoKeys/example-key \
     gs://composer-logs-us-central1-example-environment
   

3. 创建新的日志接收器。

   gcloud logging sinks create \
   composer-log-sink-ENVIRONMENT_NAME \
   storage.googleapis.com/BUCKET_NAME \
   --log-filter "resource.type=cloud_composer_environment AND resource.labels.environment_name=ENVIRONMENT_NAME AND resource.labels.location=LOCATION"
   

   您需要将其中的：

   • ENVIRONMENT_NAME 替换为环境的名称。
   • LOCATION 替换为环境所在的区域。
   • BUCKET_NAME 替换为存储桶的名称。

   示例：

   gcloud logging sinks create \
   composer-log-sink-example-environment \
   storage.googleapis.com/composer-logs-us-central1-example-environment \
   --log-filter "resource.type=cloud_composer_environment AND resource.labels.environment_name=example-environment AND resource.labels.location=us-central1"
   

4. 将 Storage Object Creator 角色授予此存储桶的服务帐号。该服务帐号会显示在上一个命令的结果中）。

   gcloud projects add-iam-policy-binding \
     PROJECT_ID \
     --member="serviceAccount:LOGGING_SERVICE_AGENT" \
     --role="roles/storage.objectCreator" \
     --condition=None
   

   您需要将其中的：

   • 将 PROJECT_ID 替换为项目 ID。
   • 将 LOGGING_SERVICE_AGENT 替换为此存储桶的 Logging 服务帐号。此帐号的名称是在上一步中获取的。

   示例：

   gcloud projects add-iam-policy-binding \
     example-project \
     --member="serviceAccount:[e-mail]" \
     --role="roles/storage.objectCreator" \
     --condition=None
   

5. 从 Monitoring 中排除新环境的日志。

   gcloud beta logging sinks update _Default \
     --add-exclusion name=ENVIRONMENT_NAME-exclusion,filter="resource.type=cloud_composer_environment AND resource.labels.environment_name=ENVIRONMENT_NAME AND resource.labels.location=LOCATION"
   

   您需要将其中的：

   • ENVIRONMENT_NAME 替换为环境的名称。
   • LOCATION 替换为环境所在的区域。

   示例：

   gcloud beta logging sinks update _Default \
     --add-exclusion name=example-environment-exclusion,filter="resource.type=cloud_composer_environment AND resource.labels.environment_name=example-environment AND resource.labels.location=us-central1"
   

6. 为日志路由器添加组织级 CMEK 加密。

   gcloud logging cmek-settings describe \
     --organization=ORGANIZATION_ID
   

   gcloud kms keys add-iam-policy-binding \
         --project=KEY_PROJECT_ID \
         --member LOGGING_SERVICE_AGENT \
         --role roles/cloudkms.cryptoKeyEncrypterDecrypter \
         --location=KEY_LOCATION \
         --keyring=KEY_RING_NAME \
         KEY_NAME
   

   gcloud logging cmek-settings update \
     --organization=ORGANIZATION_ID \
     --kms-project=KEY_PROJECT_ID \
     --kms-keyring=KEY_RING_NAME \
     --kms-location=KEY_LOCATION \
     --kms-key-name=KEY_NAME
   

   您需要将其中的：

   • 将 ORGANIZATION_ID 替换为您的组织 ID。
   • 将 KEY_PROJECT_ID 替换为密钥所在项目的 ID。如果您使用其他项目的密钥，则此值与项目的 ID 不同。如果您使用同一项目中的密钥，则此值为项目的 ID。
   • 将 KEY_RING_NAME 替换为用于存储客户管理的密钥的密钥环。
   • 将 KEY_LOCATION 替换为您的客户管理的密钥的位置。此位置必须与您的环境的位置相同。
   • 将 KEY_NAME 替换为您的客户管理的密钥名称。

Cloud Composer 的 CMEK 密钥轮替

使用 CMEK 密钥在环境中配置加密后，您还应考虑按照 KMS 文档中的说明定期轮替这些密钥。

轮替 CMEK 密钥时，使用先前密钥版本加密的数据不会自动使用新密钥版本重新加密。点击此处，详细了解如何重新加密数据。具体而言，这适用于：

• 存储在环境存储桶中的对象

• Airflow 元数据数据库中存储的数据

• 存储在 Artifact Registry 代码库中的容器映像

以及使用 CMEK 加密的所有其他数据对象。

后续步骤

• 安全概览
• 创建环境