public sealed class RawDecryptRequest : IMessage<RawDecryptRequest>, IEquatable<RawDecryptRequest>, IDeepCloneable<RawDecryptRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Key Management Service v1 API class RawDecryptRequest.
Request message for [KeyManagementService.RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
Implements
IMessageRawDecryptRequest, IEquatableRawDecryptRequest, IDeepCloneableRawDecryptRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Kms.V1Assembly
Google.Cloud.Kms.V1.dll
Constructors
RawDecryptRequest()
public RawDecryptRequest()RawDecryptRequest(RawDecryptRequest)
public RawDecryptRequest(RawDecryptRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
RawDecryptRequest |
Properties
AdditionalAuthenticatedData
public ByteString AdditionalAuthenticatedData { get; set; }Optional. Optional data that must match the data originally supplied in [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data].
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
AdditionalAuthenticatedDataCrc32C
public long? AdditionalAuthenticatedDataCrc32C { get; set; }Optional. An optional CRC32C checksum of the [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received additional_authenticated_data using this checksum. [KeyManagementService][google.cloud.kms.v1.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.
| Property Value | |
|---|---|
| Type | Description |
System.Int64 |
|
Ciphertext
public ByteString Ciphertext { get; set; }Required. The encrypted data originally returned in [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
CiphertextCrc32C
public long? CiphertextCrc32C { get; set; }Optional. An optional CRC32C checksum of the [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received ciphertext using this checksum. [KeyManagementService][google.cloud.kms.v1.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.
| Property Value | |
|---|---|
| Type | Description |
System.Int64 |
|
InitializationVector
public ByteString InitializationVector { get; set; }Required. The initialization vector (IV) used during encryption, which must match the data originally provided in [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
InitializationVectorCrc32C
public long? InitializationVectorCrc32C { get; set; }Optional. An optional CRC32C checksum of the [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received initialization_vector using this checksum. [KeyManagementService][google.cloud.kms.v1.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.
| Property Value | |
|---|---|
| Type | Description |
System.Int64 |
|
Name
public string Name { get; set; }Required. The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for decryption.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TagLength
public int TagLength { get; set; }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).
| Property Value | |
|---|---|
| Type | Description |
int |
|