Cloud KMS V1 Client - Class RawDecryptResponse (2.3.1)

Reference documentation and code samples for the Cloud KMS V1 Client class RawDecryptResponse.

Response message for KeyManagementService.RawDecrypt .

Generated from protobuf message google.cloud.kms.v1.RawDecryptResponse

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ plaintext
string

The decrypted data.

↳ plaintext_crc32c
Google\Protobuf\Int64Value

Integrity verification field. A CRC32C checksum of the returned RawDecryptResponse.plaintext . An integrity check of plaintext can be performed by computing the CRC32C checksum of plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

↳ protection_level
int

The ProtectionLevel of the CryptoKeyVersion used in decryption.

↳ verified_ciphertext_crc32c
bool

Integrity verification field. A flag indicating whether RawDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that RawDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.

↳ verified_additional_authenticated_data_crc32c
bool

Integrity verification field. A flag indicating whether RawDecryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawDecryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

↳ verified_initialization_vector_crc32c
bool

Integrity verification field. A flag indicating whether RawDecryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawDecryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.

getPlaintext

The decrypted data.

Returns
Type
Description
string

setPlaintext

The decrypted data.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPlaintextCrc32C

Integrity verification field. A CRC32C checksum of the returned RawDecryptResponse.plaintext .

An integrity check of plaintext can be performed by computing the CRC32C checksum of plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

Returns
Type
Description

hasPlaintextCrc32C

clearPlaintextCrc32C

getPlaintextCrc32CUnwrapped

Returns the unboxed value from getPlaintextCrc32C()

Integrity verification field. A CRC32C checksum of the returned RawDecryptResponse.plaintext . An integrity check of plaintext can be performed by computing the CRC32C checksum of plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

Returns
Type
Description
int|string|null

setPlaintextCrc32C

Integrity verification field. A CRC32C checksum of the returned RawDecryptResponse.plaintext .

An integrity check of plaintext can be performed by computing the CRC32C checksum of plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

Parameter
Name
Description
Returns
Type
Description
$this

setPlaintextCrc32CUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

Integrity verification field. A CRC32C checksum of the returned RawDecryptResponse.plaintext . An integrity check of plaintext can be performed by computing the CRC32C checksum of plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

Parameter
Name
Description
var
int|string|null
Returns
Type
Description
$this

getProtectionLevel

The ProtectionLevel of the CryptoKeyVersion used in decryption.

Returns
Type
Description
int
Enum of type ProtectionLevel .

setProtectionLevel

The ProtectionLevel of the CryptoKeyVersion used in decryption.

Parameter
Name
Description
var
int

Enum of type ProtectionLevel .

Returns
Type
Description
$this

getVerifiedCiphertextCrc32C

Integrity verification field. A flag indicating whether RawDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that RawDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns
Type
Description
bool

setVerifiedCiphertextCrc32C

Integrity verification field. A flag indicating whether RawDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that RawDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getVerifiedAdditionalAuthenticatedDataCrc32C

Integrity verification field. A flag indicating whether RawDecryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawDecryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns
Type
Description
bool

setVerifiedAdditionalAuthenticatedDataCrc32C

Integrity verification field. A flag indicating whether RawDecryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawDecryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getVerifiedInitializationVectorCrc32C

Integrity verification field. A flag indicating whether RawDecryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawDecryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns
Type
Description
bool

setVerifiedInitializationVectorCrc32C

Integrity verification field. A flag indicating whether RawDecryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawDecryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set RawDecryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: