Container for the parameters to the VerifyMac operation.
Verifies the hash-based message authentication code (HMAC) for a specified message,
HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an
HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares
the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification
succeeds; otherwise, it fails. Verification indicates that the message hasn't changed
since the HMAC was calculated, and the specified key was used to generate and verify
the HMAC.
HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.
This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN in the value of the
KeyId parameter.
Required permissions: kms:VerifyMac (key policy)
Related operations: GenerateMac
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.VerifyMacRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class VerifyMacRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The VerifyMacRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
VerifyMacRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DryRun | System.Boolean |
Gets and sets the property DryRun.
Checks if your request will succeed. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide. |
|
|
GrantTokens | System.Collections.Generic.List<System.String> |
Gets and sets the property GrantTokens. A list of grant tokens. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide. |
|
|
KeyId | System.String |
Gets and sets the property KeyId. The KMS key that will be used in the verification.
Enter a key ID of the KMS key that was used to generate the HMAC. If you identify
a different KMS key, the |
|
|
Mac | System.IO.MemoryStream |
Gets and sets the property Mac. The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request. |
|
|
MacAlgorithm | Amazon.KeyManagementService.MacAlgorithmSpec |
Gets and sets the property MacAlgorithm.
The MAC algorithm that will be used in the verification. Enter the same MAC algorithm
that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS
key identified by the |
|
|
Message | System.IO.MemoryStream |
Gets and sets the property Message. The message that will be used in the verification. Enter the same message that was used to generate the HMAC. GenerateMac and |
Examples
This example verifies an HMAC for a particular message, HMAC KMS keys, and MAC algorithm. A value of 'true' in the MacValid value in the response indicates that the HMAC is valid.
To verify an HMAC
var client = new AmazonKeyManagementServiceClient();
var response = client.VerifyMac(new VerifyMacRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The HMAC KMS key input to the HMAC algorithm.
Mac = new MemoryStream(<HMAC_TAG>), // The HMAC to be verified.
MacAlgorithm = "HMAC_SHA_384", // The HMAC algorithm requested for the operation.
Message = new MemoryStream(Hello World) // The message input to the HMAC algorithm.
});
string keyId = response.KeyId; // The key ARN of the HMAC key used in the operation.
string macAlgorithm = response.MacAlgorithm; // The HMAC algorithm used in the operation.
bool macValid = response.MacValid; // A value of 'true' indicates that verification succeeded. If verification fails, the call to VerifyMac fails.
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5