Reference documentation and code samples for the Cloud KMS V1 Client class 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.
Protobuf type google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose
Methods
name
Parameter | |
---|---|
Name | Description |
value |
mixed
|
value
Parameter | |
---|---|
Name | Description |
name |
mixed
|
Constants
CRYPTO_KEY_PURPOSE_UNSPECIFIED
Value: 0
Not specified.
Generated from protobuf enum CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0;
ENCRYPT_DECRYPT
Value: 1
CryptoKeys with this purpose may be used with Encrypt and Decrypt.
Generated from protobuf enum ENCRYPT_DECRYPT = 1;
ASYMMETRIC_SIGN
Value: 5
CryptoKeys with this purpose may be used with AsymmetricSign and GetPublicKey.
Generated from protobuf enum ASYMMETRIC_SIGN = 5;
ASYMMETRIC_DECRYPT
Value: 6
CryptoKeys with this purpose may be used with AsymmetricDecrypt and GetPublicKey.
Generated from protobuf enum ASYMMETRIC_DECRYPT = 6;
MAC
Value: 9
CryptoKeys with this purpose may be used with MacSign.
Generated from protobuf enum MAC = 9;