Use customer-managed encryption keys

Standard

By default, Eventarc encrypts customer content at rest. Eventarc handles encryption for you without any additional actions on your part. This option is called Google default encryption.

If you want to control your encryption keys, then you can use customer-managed encryption keys (CMEKs) in Cloud KMS with CMEK-integrated services including Eventarc. Using Cloud KMS keys gives you control over their protection level, location, rotation schedule, usage and access permissions, and cryptographic boundaries. Using Cloud KMS also lets you view audit logs and control key life cycles. Instead of Google owning and managing the symmetric key encryption keys (KEKs) that protect your data, you control and manage these keys in Cloud KMS.

After you set up your resources with CMEKs, the experience of accessing your Eventarc resources is similar to using Google default encryption. For more information about your encryption options, see Customer-managed encryption keys (CMEK).

Customer-managed encryption keys are stored as software keys, in a Cloud HSM cluster, or externally using Cloud External Key Manager.

Cloud KMS produces audit logs when keys are enabled, disabled, or used by Eventarc Advanced resources to encrypt and decrypt messages. For more information, see the Cloud KMS audit logging information.

What is protected with CMEK

You can configure CMEK for a channel that Eventarc uses and encrypt the events that pass through the channel.

Enabling a channel with CMEK protects the data associated with it (for example, the Pub/Sub topic used as a transport layer) by using an encryption key that only you can access.

Note that when you enable CMEK for the Google channel in a Google Cloud project, all Eventarc triggers for Google event types in that project and region are fully encrypted with that CMEK key. CMEK keys can't be applied on a per-trigger basis.

Before you begin

Before using this feature in Eventarc, you should:

Console

1. Enable the Cloud KMS and Eventarc APIs.

   Enable the APIs

2. Create a key ring.
3. Create a key for a specified key ring.

gcloud

1. Update gcloud components.

   gcloud components update
   

2. Enable the Cloud KMS and Eventarc APIs for the project that will store your encryption keys.

   gcloud services enable cloudkms.googleapis.com eventarc.googleapis.com
   

3. Create a key ring.
4. Create a key for a specified key ring.

For information on all flags and possible values, run the command with the --help flag.

Note that Cloud KMS and Eventarc are regionalized services. The region for the Cloud KMS key and the protected Eventarc channel must be the same.

Grant the Eventarc service account access to a key

To grant the Eventarc service account access to the Cloud KMS key, add the service account as a principal of the key, and grant the service account the Cloud KMS CryptoKey Encrypter/Decrypter role:

Console

When you enable CMEK for a Google or third-party channel through the console, you are prompted to grant the Cloud KMS CryptoKey Encrypter/Decrypter role to the service account. For more information, in this document, see Enable CMEK for Google event types or Enable CMEK for a third-party event channel.

gcloud

 gcloud kms keys add-iam-policy-binding KEY_NAME \
    --keyring KEY_RING \
    --location LOCATION \
    --member serviceAccount:SERVICE_AGENT_EMAIL \
    --role roles/cloudkms.cryptoKeyEncrypterDecrypter

Replace the following:

• KEY_NAME: the name of the key. For example, my-key.
• KEY_RING: the name of the key ring. For example, my-keyring.
• LOCATION: the location of the key. For example, us-central1.

• SERVICE_AGENT_EMAIL: the email address of the service account with the eventarc.serviceAgentrole.

  For example, [e-mail]. For more information, see Service agents.

Enable CMEK for Google event types

Eventarc triggers that route Google event types publish events to a virtual channel referred to as a Google channel that is project and regional-specific. This virtual channel is available in all Eventarc regions.

When you enable CMEK for the Google channel in a Google Cloud project, all Eventarc triggers for Google event types in that project and region are fully encrypted with that CMEK key. You can add multiple CMEK keys, and associate each with a specific region for the Google channel. CMEK keys can't be applied on a per-trigger basis.

Console

1. In the Google Cloud console, go to the Eventarc > Channels page.

   Go to Eventarc

2. Click a channel with a Google Provider.

3. In the Edit channel page, select the Use a customer-managed encryption key (CMEK) checkbox.

4. Click Add encryption key.

5. Select a Region and, in the CMEK encryption key list, select a key ring that you have created for the region. Note that you can add only one encryption key per region for a channel.

6. Optional: To manually enter the resource name of the key, in the CMEK encryption key list, click Don't see your key? Enter key resource name, and enter the key name in the specified format.

7. If prompted, grant the cloudkms.cryptoKeyEncrypterDecrypter role to the Eventarc service account with the eventarc.serviceAgent role.

8. Optional: Click Add encryption key to add another key ring that you have created for a different region.

9. Click Save.

gcloud

 gcloud eventarc google-channels update \
    --location=LOCATION \
    --crypto-key=KEY

Replace the following:

• LOCATION: the location of the Google channel to be protected. It must match the location of the key used.
• KEY: the fully qualified Cloud KMS key name in the format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME.

Note: To protect the Google channel in the eu multi-region, you must use a Cloud KMS key from europe since Cloud KMS uses a different name to represent the same multi-region. For more information, see Cloud KMS multi-regional and Eventarc multi-regional locations.

If you are creating Pub/Sub triggers using your own existing topics, for comprehensive CMEK protection, we recommend that you also configure the KMS key on the topic. For more information, see Configuring Pub/Sub topics.

Verify Cloud KMS usage

To verify that the channel is now CMEK-compliant:

Console

1. In the Google Cloud console, go to the Eventarc > Triggers page.

   Go to Eventarc

2. Click a trigger that lists a Google Cloud source as its Event provider and a Region that you have protected using CMEK.

3. On the Trigger details page, the Encryption status displays, the message, Events encrypted using Customer-managed encryption keys.

gcloud

 gcloud eventarc google-channels describe \
    --location=LOCATION

The output should be similar to the following:

 cryptoKeyName: projects/PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
 name: projects/PROJECT_ID/locations/LOCATION/googleChannelConfig
 updateTime: '2022-06-28T17:24:56.365866104Z'

The cryptokeyName value shows the Cloud KMS key used for the Google channel.

Enable CMEK for a third-party channel

An Eventarc channel for third parties is a resource through which non-Google Cloud entities that offer an Eventarc source can interact with destinations. This channel is specific to a region and you can add only one key per third-party channel.

To enable CMEK for a third-party channel:

Console

1. In the Google Cloud console, go to the Eventarc > Channels page.

   Go to Eventarc

2. Click a channel with a third-party Provider.

3. In the Channel details page, click Edit.

4. In the Edit channel page, select the Use a customer-managed encryption key (CMEK) checkbox.

5. In the CMEK encryption key list, select a key ring that you have created for the region. Note that you can add only one encryption key per region for a channel.

6. Optional: To manually enter the resource name of the key you want to use, in the CMEK encryption key list, click Enter key manually and enter the key name in the specified format.

7. If prompted, grant the cloudkms.cryptoKeyEncrypterDecrypter role to the Eventarc service account with the eventarc.serviceAgent role.

8. Click Save.

gcloud

 gcloud eventarc channels update CHANNEL_NAME \
    --location=LOCATION \
    --crypto-key=KEY

Replace the following:

• CHANNEL_NAME: the name of the third-party channel. To create a new third-party channel, see Create a channel.
• LOCATION: the location of the third-party channel to be protected. It must match the location of the key.
• KEY: the fully qualified Cloud KMS key name in the format projects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME.

Verify Cloud KMS usage

To verify that the channel is now CMEK-compliant:

Console

1. In the Google Cloud console, go to the Eventarc > Triggers page.

   Go to Eventarc

2. Click a trigger with a third-party source as its Event provider and a Region that you have protected using CMEK.

3. In the Trigger details page, the status of Encryption displays the message, Events encrypted using Customer-managed encryption keys.

gcloud

 gcloud eventarc channels describe CHANNEL_NAME \
    --location=LOCATION

The output should be similar to the following:

 createTime: '2022-06-28T18:05:52.403999904Z'
 cryptoKeyName: projects/PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
 name: projects/PROJECT_ID/locations/LOCATION/googleChannelConfig
 pubsubTopic: projects/PROJECT_ID/topics/PUBSUB_TOPIC_ID
 state: ACTIVE
 uid: 5ea277f9-b4b7-4e7f-a8e0-6ca9d7204fa3
 updateTime: '2022-06-28T18:09:18.650727516Z'

The cryptokeyName value shows the Cloud KMS key used for the third-party channel.

Disable CMEK

You can disable the CMEK protection associated with a channel. The events that are delivered through such channels are still protected by Google-owned and Google-managed keys. To delete the CMEK protection associated with a channel:

Console

1. In the Google Cloud console, go to the Eventarc > Channels page.

   Go to Eventarc

2. Based on the type of channel, do the following:

   Google channel

   1. Click a channel with a Google Provider.
   2. On the Edit channel page, hold the pointer over the CMEK encryption key list to see the Delete item button.
   3. Click Delete item.
   4. Click Save.

   Third-party channel

   1. Click a channel with a third-party Provider.
   2. On the Channel details page, click Edit.
   3. On the Edit channel page, clear the Use a customer-managed encryption key (CMEK) checkbox.
   4. Click Save.

gcloud

Based on the type of channel, do the following:

Google channel

gcloud eventarc google-channels \
    update --clear-crypto-key

Third-party channel

gcloud eventarc channels CHANNEL_NAME \
    update --clear-crypto-key

Disabling and enabling Cloud KMS keys

A key version stores the cryptographic key material that you use to encrypt, decrypt, sign, and verify data. You can disable this key version so that data that was encrypted with the key can't be accessed.

When Eventarc cannot access Cloud KMS keys, event publishing with channels fails with FAILED_PRECONDITION errors and event delivery stops. You can enable a key in the Disabled state so that the encrypted data can be accessed again.

Disable Cloud KMS keys

To prevent Eventarc from using the key to encrypt or decrypt your event data, do any of the following:

• We recommend disabling the key version you have configured for the channel. This affects only the Eventarc channels and triggers that are associated with the specific key.
• Optional: Revoke the cloudkms.cryptoKeyEncrypterDecrypter role from the Eventarc service account. This affects all the project's Eventarc channels and triggers that support events encrypted using CMEK.

Although neither operation guarantees instantaneous access revocation, Identity and Access Management (IAM) changes generally propagate faster. For more information, see Cloud KMS resource consistency and Access change propagation.

Re-enable Cloud KMS keys

To resume event delivery and publishing, restore access to Cloud KMS.

Pricing

This integration does not incur additional costs beyond the key operations, which are billed to your Google Cloud project. The use of CMEK for a channel incurs charges for access to the Cloud KMS service based on Pub/Sub pricing.

For more information on the most current pricing information, see Cloud KMS Pricing.

What's next

• Troubleshoot issues related to CMEK
• Best practices for using CMEKs