import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GenerateMacRequest, GenerateMacResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GenerateMacCommand}. */ export interface GenerateMacCommandInput extends GenerateMacRequest { } /** * @public * * The output of {@link GenerateMacCommand}. */ export interface GenerateMacCommandOutput extends GenerateMacResponse, __MetadataBearer { } declare const GenerateMacCommand_base: { new (input: GenerateMacCommandInput): import("@smithy/core/client").CommandImpl; new (input: GenerateMacCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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 *

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KMSClient, GenerateMacCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, GenerateMacCommand } = require("@aws-sdk/client-kms"); // CommonJS import * // import type { KMSClientConfig } from "@aws-sdk/client-kms"; * const config = {}; // type is KMSClientConfig * const client = new KMSClient(config); * const input = { // GenerateMacRequest * Message: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required * KeyId: "STRING_VALUE", // required * MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", // required * GrantTokens: [ // GrantTokenList * "STRING_VALUE", * ], * DryRun: true || false, * }; * const command = new GenerateMacCommand(input); * const response = await client.send(command); * // { // GenerateMacResponse * // Mac: new Uint8Array(), * // MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", * // KeyId: "STRING_VALUE", * // }; * * ``` * * @param GenerateMacCommandInput - {@link GenerateMacCommandInput} * @returns {@link GenerateMacCommandOutput} * @see {@link GenerateMacCommandInput} for command's `input` shape. * @see {@link GenerateMacCommandOutput} for command's `response` shape. * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape. * * @throws {@link DisabledException} (client fault) *

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

* * @throws {@link DryRunOperationException} (client fault) *

The request was rejected because the DryRun parameter was specified.

* * @throws {@link InvalidGrantTokenException} (client fault) *

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

* * @throws {@link InvalidKeyUsageException} (client fault) *

The request was rejected for one of the following reasons:

* *

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. For deriving key agreement secrets, the * KeyUsage must be KEY_AGREEMENT. For encapsulating and decapsulating * shared secrets, the KeyUsage must be ENCAPSULATE_DECAPSULATE. 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 {@link KeyUnavailableException} (server fault) *

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

* * @throws {@link KMSInternalException} (server fault) *

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

* * @throws {@link 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:

* * * @throws {@link NotFoundException} (client fault) *

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

* * @throws {@link KMSServiceException} *

Base exception class for all service exceptions from KMS service.

* * * @example To generate an HMAC for a message * ```javascript * // 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 is * { * KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", * Mac: "", * MacAlgorithm: "HMAC_SHA_384" * } * *\/ * ``` * * @public */ export declare class GenerateMacCommand extends GenerateMacCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GenerateMacRequest; output: GenerateMacResponse; }; sdk: { input: GenerateMacCommandInput; output: GenerateMacCommandOutput; }; }; }