Reference documentation and code samples for the KMS Inventory V1 API module Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose.
CryptoKeyPurpose describes the cryptographic capabilities of a CryptoKey. A given key can only be used for the operations allowed by its purpose. For more information, see Key purposes.
Constants
CRYPTO_KEY_PURPOSE_UNSPECIFIED
value: 0
Not specified.
ENCRYPT_DECRYPT
value: 1
CryptoKeys with this purpose may be used with [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
ASYMMETRIC_SIGN
value: 5
CryptoKeys with this purpose may be used with [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign] and [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
ASYMMETRIC_DECRYPT
value: 6
CryptoKeys with this purpose may be used with [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt] and [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
RAW_ENCRYPT_DECRYPT
value: 7
CryptoKeys with this purpose may be used with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt] and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt]. This purpose is meant to be used for interoperable symmetric encryption and does not support automatic CryptoKey rotation.
MAC
value: 9
CryptoKeys with this purpose may be used with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
KEY_ENCAPSULATION
value: 10
CryptoKeys with this purpose may be used with [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] and [Decapsulate][google.cloud.kms.v1.KeyManagementService.Decapsulate].