- Knowledge Base
- Google Cloud Platform
- GCP Cloud Run
- Use Customer-Managed Encryption Keys for Services Encryption
Ensure that your Cloud Run services use Customer-Managed Encryption Keys (CMEK) instead of Google-managed encryption keys to encrypt data at rest. CMEKs provide greater control over the encryption and decryption process, enabling you to meet stringent compliance requirements.
By default, Google Cloud Platform (GCP) encrypts all data at rest using Google-managed encryption keys. This type of encryption is handled by GCP without any additional effort from you or your application. However, if you prefer to have full control over data encryption, you can use your own Customer-Managed Encryption Key (CMEK). To create and manage your own CMEKs, utilize Cloud Key Management Service (Cloud KMS). Cloud KMS offers secure and efficient encryption key management, including controlled key rotation and revocation mechanisms.
Audit
To determine if your Cloud Run services are protected with Customer-Managed Encryption Keys (CMEKs), perform the following operations:
Using GCP Console
01 Sign in to the Google Cloud Management Console.
02 Select the Google Cloud Platform (GCP) project that you want to examine from the console top navigation bar.
03 Navigate to Cloud Run console available at https://console.cloud.google.com/run/.
04 Select the SERVICES tab to view the Cloud Run services deployed for the selected GCP project.
05 Click on the name (link) of the service that you want to examine, listed in the Name column.
06 Select the REVISIONS tab, choose the active revision used by the selected service (the revision with the green check mark icon), select the SECURITY tab, and check the Encryption Key attribute value, listed under Identity & Encryption. If the Encryption Key value is set to Google-managed, the selected Cloud Run service is not encrypted at rest using a Cloud KMS Customer-Managed Encryption Key (CMEK).
07 Repeat steps no. 5 and 6 for each Cloud Run service created for the selected GCP project.
08 Repeat steps no. 2 - 7 for each project deployed within your Google Cloud account.
Using GCP CLI
01 Run projects list command (Windows/macOS/Linux) with custom output filters to list the ID of each project available in your Google Cloud Platform (GCP) account:
gcloud projects list --format="value(projectId)"
02 The command output should return the requested GCP project ID(s):
cc-bigdata-project-123123 cc-iot-app-project-112233
03 Run services list command (Windows/macOS/Linux) with the ID of the GCP project that you want to examine as the identifier parameter and custom output filters to describe the name and the region of each Cloud Run service deployed within the selected project:
gcloud run services list --project cc-bigdata-project-123123 --format="(NAME,REGION)"
04 The command output should return the requested service names and the associated regions:
NAME: cc-project5-service REGION: us-central1 NAME: tm-stream-service REGION: us-central1 NAME: tm-vertex-service REGION: us-central1
05 Run services describe command (Windows/macOS/Linux) with the name of the Cloud Run service that you want to examine as the identifier parameter, to describe the ID of the Customer-Managed Encryption Key (CMEK) used to encrypt your service data:
gcloud run services describe cc-project5-service --region=us-central1 --format="json(spec.template.metadata.annotations.'run.googleapis.com/encryption-key')"
06 The command output should return the full ID of the requested Customer-Managed Encryption Key:
null
If the services describe command output returns null, as shown in the example above, the resource is using a Google-managed encryption key, therefore, the selected Cloud Run service is not encrypted at rest using a Customer-Managed Encryption Key (CMEK).
07 Repeat steps no. 5 and 6 for each Cloud Run service created for the selected GCP project.
08 Repeat steps no. 3 – 7 for each GCP project deployed in your Google Cloud account.
Remediation / Resolution
To enable encryption at rest with Cloud KMS Customer-Managed Encryption Keys (CMEKs) for your Cloud Run services and related data, perform the following operations:
Using GCP Console
01 Sign in to the Google Cloud Management Console.
02 Select the Google Cloud Platform (GCP) project that you want to access from the console top navigation bar.
03 To create and configure your new Customer-Managed Encryption Key (CMEK), perform the following actions:
- Navigate to Key management console available at https://console.cloud.google.com/security/kms.
- Before you can set up and configure your Customer-Managed Encryption Key (CMEK), you must create a key ring. A Cloud KMS key ring is a grouping of cryptographic keys made available for organizational purposes in a specific location. To get started, choose CREATE KEY RING to set up the required key ring.
- A key ring requires a name and location. On the Create key ring setup page, provide a unique name in the Key ring name box, select the key location type from the Location type list, then choose the appropriate key location from the Region/Multi-region dropdown list. The location can be either multi-region or associated with a particular region. If the CMEKs created later within this key ring will be used to encrypt/decrypt data in a particular region, select that region as the key ring location. Choose CREATE to deploy the new key ring.
- On the Create key setup page, provide the following information:
- For Name and protection level, provide a unique name for your new KMS key in the Key name box and choose the protection level that you want to use from the Protection Level dropdown list. Choose CONTINUE to continue the setup process.
- For Key material, choose Generated key to generate the key material for you (recommended). Choose CONTINUE.
- For Purpose and algorithm, choose Symmetric encrypt/decrypt to define the types of operations that your cryptographic key can perform. Choose CONTINUE to continue the setup.
- For Versions, configure the key rotation period as necessary. Choose CONTINUE.
- For Additional settings (optional), set the duration for the scheduled for destruction (i.e., soft deleted) state before the key is removed from the system. Choose ADD LABEL and use the Key and Value text fields to create labels in order to organize the identity of the new key.
- Choose CREATE to deploy your new Cloud KMS Customer-Managed Encryption Key (CMEK).
04 Navigate to Cloud Run console available at https://console.cloud.google.com/run/.
05 Select the SERVICES tab to access the Cloud Run services deployed for the selected GCP project.
06 Click on the name (link) of the service that you want to configure, listed in the Name column.
07 Choose EDIT & DEPLOY NEW REVISION, select the SECURITY tab, and perform the following actions to enable encryption at rest using Cloud KMS Customer-Managed Encryption Keys (CMEKs):
- For Encryption, choose Cloud KMS key.
- For Key type, select Cloud KMS.
- Choose the name of your Cloud KMS Customer-Managed Encryption Key (CMEK) from the Select a Cloud KMS key dropdown list.
- Inside the \
service account does not have the "cloudkms.cryptoKeyEncrypterDecrypter" role. Verify the service account has permission to encrypt/decrypt with the selected key box, choose GRANT to grant the associated service account access to your key using the Cloud KMS CryptoKey Encrypter/Decrypter role. - Choose the preferred key revocation action from the Key Revocation Action dropdown list.
- Choose DEPLOY to apply the changes and deploy a new revision for the selected service.
08 Repeat steps no. 6 and 7 for each Cloud Run service that you want to configure, available within the selected project.
09 Repeat steps no. 2 – 8 for each project deployed in your Google Cloud account.
Using GCP CLI
01 Before you can create your own Customer-Managed Encryption Key (CMEK), you have to provision a key ring. A Cloud KMS key ring is a grouping of cryptographic keys made available for organizational purposes in a specific Google Cloud location. Run kms keyrings create command (Windows/macOS/Linux) to create a new Cloud KMS key ring in the specified location. If the keys deployed later within this key ring will be used to encrypt resources in a given region, select that region as the key ring location:
gcloud kms keyrings create tm-cloud-run-key-ring --location=us --project=cc-bigdata-project-123123 --format="table(name)"
02 The command output should return the resource name of the newly created key ring:
NAME projects/cc-bigdata-project-123123/locations/us/keyRings/tm-cloud-run-key-ring
03 Run kms keys create command (Windows/macOS/Linux) to create a new Customer-Managed Encryption Key (CMEK) within the Cloud KMS key ring created at the previous steps:
gcloud kms keys create tm-cloud-service-kms-key --location=us --keyring=tm-cloud-run-key-ring --purpose=encryption --protection-level=software --rotation-period=90d --next-rotation-time=2024-11-25T10:00:00.0000Z --format="table(name)"
04 The command output should return the resource name of the new Customer-Managed Encryption Key:
NAME projects/cc-bigdata-project-123123/locations/us/keyRings/tm-cloud-run-key-ring/cryptoKeys/tm-cloud-service-kms-key
05 Run kms keys add-iam-policy-binding command (Windows/macOS/Linux) to assign the Cloud KMS CryptoKey Encrypter/Decrypter role to the required service accounts:
gcloud kms keys add-iam-policy-binding tm-cloud-service-kms-key --keyring tm-cloud-run-key-ring --location us-central1 --member='serviceAccount:<project-number>-compute@developer.gserviceaccount.com' --role roles/cloudkms.cryptoKeyEncrypterDecrypter
06 The command output should return the updated IAM policy (YAML format):
Updated IAM policy for key [tm-new-service-kms-key]. bindings: - members: - serviceAccount:<project-number>-compute@developer.gserviceaccount.com - serviceAccount:service-<project-number>@gcf-admin-robot.iam.gserviceaccount.com - serviceAccount:service-<project-number>@gs-project-accounts.iam.gserviceaccount.com - serviceAccount:service-<project-number>@serverless-robot-prod.iam.gserviceaccount.com role: roles/cloudkms.cryptoKeyEncrypterDecrypter etag: ABCD1234ABCD1234 version: 1
07 Run the deploy command (Windows/macOS/Linux) with the name of the Cloud Run service that you want to configure as the identifier parameter, to enable encryption at rest using Cloud KMS Customer-Managed Encryption Keys (CMEKs). Use the --key parameter to specify your own Customer-Managed Encryption Key:
gcloud run deploy cc-project5-service --region=us-central1 --image=gcr.io/serverless-runtimes/google-22/runtimes/nodejs20 --key=projects/cc-bigdata-project-123123/locations/us/keyRings/tm-cloud-run-key-ring/cryptoKeys/tm-cloud-service-kms-key --post-key-revocation-action-type prevent-new
08 The command output should return the build information available for the redeployed service:
Building using Buildpacks and deploying container to Cloud Run service [cc-project5-service] in project [cc-bigdata-project-123123] region [us-central1] OK Building and deploying... Done. OK Uploading sources... OK Building Container... Logs are available at [https://console.cloud.google.com/cloud-build/builds...]. OK Creating Revision... Done. Service [cc-project5-service] revision [cc-project5-service-00003-abc] has been deployed and is serving 100 percent of traffic.
09 Repeat steps no. 1 - 8 for each Cloud Run service that you want to configure, available in the selected project.
10 Repeat steps no. 1 – 9 for each GCP project deployed in your Google Cloud account.
References
- Google Cloud Platform (GCP) Documentation
- Cloud Key Management
- Create a key
- Customer-managed encryption keys (CMEK)
- Security design overview
- Using customer managed encryption keys
- GCP Command Line Interface (CLI) Documentation
- gcloud projects list
- gcloud run services list
- gcloud run services describe
- gcloud beta run deploy
- gcloud kms keyrings create
- gcloud kms keys create
- gcloud kms keys add-iam-policy-binding
Related CloudRun rules
- Enable Automatic Runtime Security Updates (Security, reliability, performance-efficiency, operational-excellence)
- Enable Binary Authorization (Security, cost-optimisation, operational-excellence)
- Use Customer-Managed Encryption Keys for Services Encryption (Security)
- Check for Publicly Accessible Cloud Run Services (Security, reliability, cost-optimisation, performance-efficiency, operational-excellence)