public sealed class DecapsulateResponse : IMessage<DecapsulateResponse>, IEquatable<DecapsulateResponse>, IDeepCloneable<DecapsulateResponse>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Key Management Service v1 API class DecapsulateResponse.
Response message for [KeyManagementService.Decapsulate][google.cloud.kms.v1.KeyManagementService.Decapsulate].
Implements
IMessageDecapsulateResponse, IEquatableDecapsulateResponse, IDeepCloneableDecapsulateResponse, IBufferMessage, IMessageNamespace
Google.Cloud.Kms.V1Assembly
Google.Cloud.Kms.V1.dll
Constructors
DecapsulateResponse()
public DecapsulateResponse()DecapsulateResponse(DecapsulateResponse)
public DecapsulateResponse(DecapsulateResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
DecapsulateResponse |
Properties
HasSharedSecretCrc32C
public bool HasSharedSecretCrc32C { get; }Gets whether the "shared_secret_crc32c" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Name
public string Name { get; set; }The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ProtectionLevel
public ProtectionLevel ProtectionLevel { get; set; }The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decapsulation.
| Property Value | |
|---|---|
| Type | Description |
ProtectionLevel |
|
SharedSecret
public ByteString SharedSecret { get; set; }The decapsulated shared_secret originally encapsulated with the matching public key.
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
SharedSecretCrc32C
public long SharedSecretCrc32C { get; set; }Integrity verification field. A CRC32C checksum of the returned [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]. An integrity check of [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret] can be performed by computing the CRC32C checksum of [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret] 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][google.cloud.kms.v1.KeyManagementService] is able to successfully decrypt the [ciphertext][google.cloud.kms.v1.DecapsulateRequest.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.
| Property Value | |
|---|---|
| Type | Description |
long |
|
VerifiedCiphertextCrc32C
public bool VerifiedCiphertextCrc32C { get; set; }Integrity verification field. A flag indicating whether [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c] was received by [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used for the integrity verification of the [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. A false value of this field indicates either that [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c] was left unset or that it was not delivered to [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've set [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.ciphertext_crc32c] but this field is still false, discard the response and perform a limited number of retries.
| Property Value | |
|---|---|
| Type | Description |
bool |
|