Class GenerateMacCommandProtected

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.

You can use value that GenerateMac returns in the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. You can also use the raw result to implement HMAC-based algorithms such as key derivation functions. 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 .

Best practices recommend that you limit the time during which any signing mechanism, including an HMAC, is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the token or message to help you detect when its time to refresh the HMAC.

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:GenerateMac (key policy)

Related operations: VerifyMac

Example

Use a bare-bones client and the command you need to make an API call.

import { KMSClient, GenerateMacCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, GenerateMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // GenerateMacRequest
  Message: "BLOB_VALUE", // required
  KeyId: "STRING_VALUE", // required
  MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", // required
  GrantTokens: [ // GrantTokenList
    "STRING_VALUE",
  ],
};
const command = new GenerateMacCommand(input);
const response = await client.send(command);
// { // GenerateMacResponse
//   Mac: "BLOB_VALUE",
//   MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512",
//   KeyId: "STRING_VALUE",
// };

Param

GenerateMacCommandInput

Returns

GenerateMacCommandOutput

See

• GenerateMacCommandInput for command's input shape.
• GenerateMacCommandOutput for command's response shape.
• config for KMSClient's config shape.

Throws

DisabledException (client fault)

The request was rejected because the specified KMS key is not enabled.

Throws

InvalidGrantTokenException (client fault)

The request was rejected because the specified grant token is not valid.

Throws

InvalidKeyUsageException (client fault)

The request was rejected for one of the following reasons:

• The KeyUsage value of the KMS key is incompatible with the API operation.

• The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying messages, the KeyUsage must be SIGN_VERIFY. For generating and verifying message authentication codes (MACs), the KeyUsage must be GENERATE_VERIFY_MAC. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.

Throws

KeyUnavailableException (server fault)

The request was rejected because the specified KMS key was not available. You can retry the request.

Throws

KMSInternalException (server fault)

The request was rejected because an internal exception occurred. The request can be retried.

Throws

KMSInvalidStateException (client fault)

The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:

• The key state of the KMS key is not compatible with the operation.

  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .

• For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

Throws

NotFoundException (client fault)

The request was rejected because the specified entity or resource could not be found.

Throws

KMSServiceException

Base exception class for all service exceptions from KMS service.

Example

To generate an HMAC for a message

// This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by the specified HMAC KMS key.
const input = {
  "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
  "MacAlgorithm": "HMAC_SHA_384",
  "Message": "Hello World"
};
const command = new GenerateMacCommand(input);
const response = await client.send(command);
/* response ==
{
  "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
  "Mac": "<HMAC_TAG>",
  "MacAlgorithm": "HMAC_SHA_384"
}
*/
// example id: to-generate-an-hmac-for-a-message-1631570135665