Verify Mac

kms_verify_mac

R Documentation

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

Description¶

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, verify_mac 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: generate_mac

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Usage¶

kms_verify_mac(Message, KeyId, MacAlgorithm, Mac, GrantTokens, DryRun)

Arguments¶

Message

[required] The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

generate_mac and verify_mac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.

KeyId

[required] 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 verify_mac operation fails.

MacAlgorithm

[required] 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 KeyId parameter.

Mac

[required] The HMAC to verify. Enter the HMAC that was generated by the generate_mac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

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.

DryRun

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

Value¶

A list with the following syntax:

list(
  KeyId = "string",
  MacValid = TRUE|FALSE,
  MacAlgorithm = "HMAC_SHA_224"|"HMAC_SHA_256"|"HMAC_SHA_384"|"HMAC_SHA_512"
)

Request syntax¶

svc$verify_mac(
  Message = raw,
  KeyId = "string",
  MacAlgorithm = "HMAC_SHA_224"|"HMAC_SHA_256"|"HMAC_SHA_384"|"HMAC_SHA_512",
  Mac = raw,
  GrantTokens = list(
    "string"
  ),
  DryRun = TRUE|FALSE
)

Examples¶

## Not run: 
# 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.
svc$verify_mac(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
  Mac = "<HMAC_TAG>",
  MacAlgorithm = "HMAC_SHA_384",
  Message = "Hello World"
)

## End(Not run)