Google Cloud Key Management Service v1 API - Class MacVerifyRequest (3.9.0)

public sealed class MacVerifyRequest : IMessage<MacVerifyRequest>, IEquatable<MacVerifyRequest>, IDeepCloneable<MacVerifyRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class MacVerifyRequest.

Request message for [KeyManagementService.MacVerify][google.cloud.kms.v1.KeyManagementService.MacVerify].

Inheritance

object > MacVerifyRequest

Implements

IMessage MacVerifyRequest, IEquatable MacVerifyRequest, IDeepCloneable MacVerifyRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

MacVerifyRequest()

public MacVerifyRequest()

MacVerifyRequest(MacVerifyRequest)

public MacVerifyRequest(MacVerifyRequest other)

Parameter
Name	Description
`other`	`MacVerifyRequest`

Properties

CryptoKeyVersionName

public CryptoKeyVersionName CryptoKeyVersionName { get; set; }

CryptoKeyVersionName-typed view over the Name resource name property.

Property Value
Type	Description
`CryptoKeyVersionName`

Data

public ByteString Data { get; set; }

Required. The data used previously as a [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data] to generate the MAC tag.

Property Value
Type	Description
`ByteString`

DataCrc32C

public long? DataCrc32C { get; set; }

Optional. An optional CRC32C checksum of the [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received [MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.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([MacVerifyRequest.data][google.cloud.kms.v1.MacVerifyRequest.data]) is equal to [MacVerifyRequest.data_crc32c][google.cloud.kms.v1.MacVerifyRequest.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
`long`

Mac

public ByteString Mac { get; set; }

Required. The signature to verify.

Property Value
Type	Description
`ByteString`

MacCrc32C

public long? MacCrc32C { get; set; }

Optional. An optional CRC32C checksum of the [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] 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([MacVerifyRequest.tag][]) is equal to [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_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
`long`

Name

public string Name { get; set; }

Required. The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for verification.

Property Value
Type	Description
`string`