View Source GoogleApi.CloudKMS.V1.Model.RawDecryptRequest (google_api_cloud_kms v0.39.1)
Request message for KeyManagementService.RawDecrypt.
Attributes
-
additionalAuthenticatedData
(type:String.t
, default:nil
) - Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data. -
additionalAuthenticatedDataCrc32c
(type:String.t
, default:nil
) - Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. 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. -
ciphertext
(type:String.t
, default:nil
) - Required. The encrypted data originally returned in RawEncryptResponse.ciphertext. -
ciphertextCrc32c
(type:String.t
, default:nil
) - Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. 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. -
initializationVector
(type:String.t
, default:nil
) - Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector. -
initializationVectorCrc32c
(type:String.t
, default:nil
) - Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. 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. -
tagLength
(type:integer()
, default:nil
) - The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.CloudKMS.V1.Model.RawDecryptRequest{ additionalAuthenticatedData: String.t() | nil, additionalAuthenticatedDataCrc32c: String.t() | nil, ciphertext: String.t() | nil, ciphertextCrc32c: String.t() | nil, initializationVector: String.t() | nil, initializationVectorCrc32c: String.t() | nil, tagLength: integer() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.