Show / Hide Table of Contents

Class RawEncryptResponse

Response message for KeyManagementService.RawEncrypt.

Inheritance
object
RawEncryptResponse
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudKMS.v1.Data
Assembly: Google.Apis.CloudKMS.v1.dll
Syntax
public class RawEncryptResponse : IDirectResponseSchema

Properties

Ciphertext

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

Declaration
[JsonProperty("ciphertext")]
public virtual string Ciphertext { get; set; }
Property Value
Type Description
string

CiphertextCrc32c

Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of ciphertext 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: 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.

Declaration
[JsonProperty("ciphertextCrc32c")]
public virtual long? CiphertextCrc32c { get; set; }
Property Value
Type Description
long?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

InitializationVector

The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.

Declaration
[JsonProperty("initializationVector")]
public virtual string InitializationVector { get; set; }
Property Value
Type Description
string

InitializationVectorCrc32c

Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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: 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.

Declaration
[JsonProperty("initializationVectorCrc32c")]
public virtual long? InitializationVectorCrc32c { get; set; }
Property Value
Type Description
long?

Name

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ProtectionLevel

The ProtectionLevel of the CryptoKeyVersion used in encryption.

Declaration
[JsonProperty("protectionLevel")]
public virtual string ProtectionLevel { get; set; }
Property Value
Type Description
string

TagLength

The length of the authentication tag that is appended to the end of the ciphertext.

Declaration
[JsonProperty("tagLength")]
public virtual int? TagLength { get; set; }
Property Value
Type Description
int?

VerifiedAdditionalAuthenticatedDataCrc32c

Integrity verification field. A flag indicating whether RawEncryptRequest.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 // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Declaration
[JsonProperty("verifiedAdditionalAuthenticatedDataCrc32c")]
public virtual bool? VerifiedAdditionalAuthenticatedDataCrc32c { get; set; }
Property Value
Type Description
bool?

VerifiedInitializationVectorCrc32c

Integrity verification field. A flag indicating whether RawEncryptRequest.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 RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.

Declaration
[JsonProperty("verifiedInitializationVectorCrc32c")]
public virtual bool? VerifiedInitializationVectorCrc32c { get; set; }
Property Value
Type Description
bool?

VerifiedPlaintextCrc32c

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

Declaration
[JsonProperty("verifiedPlaintextCrc32c")]
public virtual bool? VerifiedPlaintextCrc32c { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX