CmdID

CmdID / aws / aws kms

aws kms verify-mac

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. AWS CLI reference

1 example 6 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

Example 1: To verify an HMAC

The following verify-mac 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.

In AWS CLI v2, the value of the message parameter must be Base64-encoded. Or, you can save the message in a file and use the fileb:// prefix, which tells the AWS CLI to read binary data from the file.

The MAC that you specify cannot be base64-encoded. For help decoding the MAC that the generate-mac command returns, see the generate-mac command examples.

Before running this command, replace the example key ID with a valid key ID from your AWS account. The key ID must represent a HMAC KMS key with a key usage of GENERATE_VERIFY_MAC.

msg=(echo 'Hello World' | base64)

aws kms verify-mac \
    --key-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --message fileb://Message \
    --mac-algorithm HMAC_SHA_384 \
    --mac fileb://ExampleMac
Its output
{
    "KeyId": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "MacValid": true,
    "MacAlgorithm": "HMAC_SHA_384"
}

For more information about using HMAC KMS keys in AWS KMS, see HMAC keys in AWS KMS in the AWS Key Management Service Developer Guide.

Options

6 in the AWS CLI reference
--dry-runChecks if your request will succeed.
--grant-tokensA list of grant tokens.
--key-idThe KMS key that will be used in the verification.
--mac-algorithmThe MAC algorithm that will be used in the verification.
--macThe HMAC to verify.
--messageThe message that will be used in the verification.