Cloud Key Management Service audit logging

Cloud Key Management Service is updating the format of the protoPayload field in its Data Access audit log entries. During the migration period, the protoPayload within Data Access audit log entries will remain backward-compatible. However, new or future code applications should use the recommended replacement fields as follows:

Recommended replacement field Deprecated field Description
protoPayload.status.details protoPayload.metadata Error detail for EXTERNAL (i.e., Cloud EKM) key operations.
protoPayload.metadata.entries.caller_provided_context protoPayload.request.caller_provided_context Context from the caller associated with this Cloud KMS operation.


This document describes audit logging for Cloud Key Management Service. Google Cloud services generate audit logs that record administrative and access activities within your Google Cloud resources. For more information about Cloud Audit Logs, see the following:

Service name

Cloud Key Management Service audit logs use the service name cloudkms.googleapis.com. Filter for this service: 

    protoPayload.serviceName="cloudkms.googleapis.com"

Methods by permission type

Each IAM permission has a type property, whose value is an enum that can be one of four values: ADMIN_READ, ADMIN_WRITE, DATA_READ, or DATA_WRITE. When you call a method, Cloud Key Management Service generates an audit log whose category is dependent on the type property of the permission required to perform the method. Methods that require an IAM permission with the type property value of DATA_READ, DATA_WRITE, or ADMIN_READ generate Data Access audit logs. Methods that require an IAM permission with the type property value of ADMIN_WRITE generate Admin Activity audit logs.

Permission type Methods
ADMIN_READ GetCryptoKey
GetCryptoKeyVersion
GetEkmConfig
GetEkmConnection
GetIamPolicy
GetImportJob
GetKeyRing
GetOperation
ListCryptoKeyVersions
ListCryptoKeys
ListEkmConnections
ListImportJobs
ListKeyRings
VerifyConnectivity
google.cloud.kms.v1.Autokey.GetKeyHandle
google.cloud.kms.v1.Autokey.ListKeyHandles
google.cloud.kms.v1.AutokeyAdmin.GetAutokeyConfig
google.cloud.kms.v1.AutokeyAdmin.ShowEffectiveAutokeyConfig
ADMIN_WRITE CreateCryptoKey
CreateCryptoKeyVersion
CreateEkmConnection
CreateImportJob
CreateKeyRing
DestroyCryptoKeyVersion
ImportCryptoKeyVersion
RestoreCryptoKeyVersion
SetIamPolicy
UpdateCryptoKey
UpdateCryptoKeyPrimaryVersion
UpdateCryptoKeyVersion
UpdateEkmConfig
UpdateEkmConnection
google.cloud.kms.v1.Autokey.CreateKeyHandle
google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig
DATA_READ AsymmetricDecrypt
AsymmetricSign
Decrypt
Encrypt
GetPublicKey
MacSign
MacVerify
RawDecrypt
RawEncrypt

API interface audit logs

For information about how and which permissions are evaluated for each method, see the Identity and Access Management documentation for Cloud Key Management Service.

google.cloud.kms.v1.Autokey

The following audit logs are associated with methods belonging to google.cloud.kms.v1.Autokey.

CreateKeyHandle

  • Method: google.cloud.kms.v1.Autokey.CreateKeyHandle
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.keyHandles.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.kms.v1.Autokey.CreateKeyHandle"

GetKeyHandle

  • Method: google.cloud.kms.v1.Autokey.GetKeyHandle
  • Audit log type: Data access
  • Permissions:
    • cloudkms.keyHandles.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.kms.v1.Autokey.GetKeyHandle"

ListKeyHandles

  • Method: google.cloud.kms.v1.Autokey.ListKeyHandles
  • Audit log type: Data access
  • Permissions:
    • cloudkms.keyHandles.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.kms.v1.Autokey.ListKeyHandles"

google.cloud.kms.v1.AutokeyAdmin

The following audit logs are associated with methods belonging to google.cloud.kms.v1.AutokeyAdmin.

GetAutokeyConfig

  • Method: google.cloud.kms.v1.AutokeyAdmin.GetAutokeyConfig
  • Audit log type: Data access
  • Permissions:
    • cloudkms.autokeyConfigs.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.kms.v1.AutokeyAdmin.GetAutokeyConfig"

ShowEffectiveAutokeyConfig

  • Method: google.cloud.kms.v1.AutokeyAdmin.ShowEffectiveAutokeyConfig
  • Audit log type: Data access
  • Permissions:
    • cloudkms.projects.showEffectiveAutokeyConfig - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.kms.v1.AutokeyAdmin.ShowEffectiveAutokeyConfig"

UpdateAutokeyConfig

  • Method: google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.autokeyConfigs.update - ADMIN_WRITE
    • cloudkms.cryptoKeys.setIamPolicy - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig"

google.cloud.kms.v1.EkmService

The following audit logs are associated with methods belonging to google.cloud.kms.v1.EkmService.

CreateEkmConnection

  • Method: CreateEkmConnection
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.ekmConnections.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="CreateEkmConnection"

GetEkmConfig

  • Method: GetEkmConfig
  • Audit log type: Data access
  • Permissions:
    • cloudkms.ekmConfigs.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetEkmConfig"

GetEkmConnection

  • Method: GetEkmConnection
  • Audit log type: Data access
  • Permissions:
    • cloudkms.ekmConnections.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetEkmConnection"

ListEkmConnections

  • Method: ListEkmConnections
  • Audit log type: Data access
  • Permissions:
    • cloudkms.ekmConnections.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="ListEkmConnections"

UpdateEkmConfig

  • Method: UpdateEkmConfig
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.ekmConfigs.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="UpdateEkmConfig"

UpdateEkmConnection

  • Method: UpdateEkmConnection
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.ekmConnections.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="UpdateEkmConnection"

VerifyConnectivity

  • Method: VerifyConnectivity
  • Audit log type: Data access
  • Permissions:
    • cloudkms.ekmConnections.verifyConnectivity - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="VerifyConnectivity"

google.cloud.kms.v1.KeyManagementService

The following audit logs are associated with methods belonging to google.cloud.kms.v1.KeyManagementService.

AsymmetricDecrypt

  • Method: AsymmetricDecrypt
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToDecrypt - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="AsymmetricDecrypt"

AsymmetricSign

  • Method: AsymmetricSign
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToSign - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="AsymmetricSign"

CreateCryptoKey

  • Method: CreateCryptoKey
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeys.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="CreateCryptoKey"

CreateCryptoKeyVersion

  • Method: CreateCryptoKeyVersion
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeyVersions.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="CreateCryptoKeyVersion"

CreateImportJob

  • Method: CreateImportJob
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.importJobs.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="CreateImportJob"

CreateKeyRing

  • Method: CreateKeyRing
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.keyRings.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="CreateKeyRing"

Decrypt

  • Method: Decrypt
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToDecrypt - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="Decrypt"

DestroyCryptoKeyVersion

  • Method: DestroyCryptoKeyVersion
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeyVersions.destroy - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="DestroyCryptoKeyVersion"

Encrypt

  • Method: Encrypt
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToEncrypt - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="Encrypt"

GetCryptoKey

  • Method: GetCryptoKey
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeys.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetCryptoKey"

GetCryptoKeyVersion

  • Method: GetCryptoKeyVersion
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetCryptoKeyVersion"

GetImportJob

  • Method: GetImportJob
  • Audit log type: Data access
  • Permissions:
    • cloudkms.importJobs.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetImportJob"

GetKeyRing

  • Method: GetKeyRing
  • Audit log type: Data access
  • Permissions:
    • cloudkms.keyRings.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetKeyRing"

GetPublicKey

  • Method: GetPublicKey
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.viewPublicKey - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetPublicKey"

ImportCryptoKeyVersion

  • Method: ImportCryptoKeyVersion
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeyVersions.create - ADMIN_WRITE
    • cloudkms.cryptoKeyVersions.update - ADMIN_WRITE
    • cloudkms.importJobs.useToImport - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="ImportCryptoKeyVersion"

ListCryptoKeyVersions

  • Method: ListCryptoKeyVersions
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="ListCryptoKeyVersions"

ListCryptoKeys

  • Method: ListCryptoKeys
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeys.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="ListCryptoKeys"

ListImportJobs

  • Method: ListImportJobs
  • Audit log type: Data access
  • Permissions:
    • cloudkms.importJobs.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="ListImportJobs"

ListKeyRings

  • Method: ListKeyRings
  • Audit log type: Data access
  • Permissions:
    • cloudkms.keyRings.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="ListKeyRings"

MacSign

  • Method: MacSign
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToSign - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="MacSign"

MacVerify

  • Method: MacVerify
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToVerify - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="MacVerify"

RawDecrypt

  • Method: RawDecrypt
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToDecrypt - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="RawDecrypt"

RawEncrypt

  • Method: RawEncrypt
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeyVersions.useToEncrypt - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="RawEncrypt"

RestoreCryptoKeyVersion

  • Method: RestoreCryptoKeyVersion
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeyVersions.restore - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="RestoreCryptoKeyVersion"

UpdateCryptoKey

  • Method: UpdateCryptoKey
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeys.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="UpdateCryptoKey"

UpdateCryptoKeyPrimaryVersion

  • Method: UpdateCryptoKeyPrimaryVersion
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeys.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="UpdateCryptoKeyPrimaryVersion"

UpdateCryptoKeyVersion

  • Method: UpdateCryptoKeyVersion
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeyVersions.update - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="UpdateCryptoKeyVersion"

google.iam.v1.IAMPolicy

The following audit logs are associated with methods belonging to google.iam.v1.IAMPolicy.

GetIamPolicy

  • Method: GetIamPolicy
  • Audit log type: Data access
  • Permissions:
    • cloudkms.cryptoKeys.getIamPolicy - ADMIN_READ
    • cloudkms.keyRings.getIamPolicy - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetIamPolicy"

SetIamPolicy

  • Method: SetIamPolicy
  • Audit log type: Admin activity
  • Permissions:
    • cloudkms.cryptoKeys.setIamPolicy - ADMIN_WRITE
    • cloudkms.keyRings.setIamPolicy - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="SetIamPolicy"

google.longrunning.Operations

The following audit logs are associated with methods belonging to google.longrunning.Operations.

GetOperation

  • Method: GetOperation
  • Audit log type: Data access
  • Permissions:
    • cloudkms.keyHandles.create - ADMIN_WRITE
    • cloudkms.operations.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="GetOperation"

Methods that don't produce audit logs

A method might not produce audit logs for one or more of the following reasons:

  • It is a high volume method involving signifcant log generation and storage costs.
  • It has low auditing value.
  • Another audit or platform log already provides method coverage.

The following methods don't produce audit logs:

  • google.cloud.kms.v1.KeyManagementService.GenerateRandomBytes
  • google.cloud.location.Locations.GetLocation
  • google.cloud.location.Locations.ListLocations