import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { VerifyMacRequest, VerifyMacResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link VerifyMacCommand}. */ export interface VerifyMacCommandInput extends VerifyMacRequest { } /** * @public * * The output of {@link VerifyMacCommand}. */ export interface VerifyMacCommandOutput extends VerifyMacResponse, __MetadataBearer { } declare const VerifyMacCommand_base: { new (input: VerifyMacCommandInput): import("@smithy/core/client").CommandImpl; new (input: VerifyMacCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KMSClient, VerifyMacCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, VerifyMacCommand } = 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 = { // VerifyMacRequest * 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 * Mac: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required * GrantTokens: [ // GrantTokenList * "STRING_VALUE", * ], * DryRun: true || false, * }; * const command = new VerifyMacCommand(input); * const response = await client.send(command); * // { // VerifyMacResponse * // KeyId: "STRING_VALUE", * // MacValid: true || false, * // MacAlgorithm: "HMAC_SHA_224" || "HMAC_SHA_256" || "HMAC_SHA_384" || "HMAC_SHA_512", * // }; * * ``` * * @param VerifyMacCommandInput - {@link VerifyMacCommandInput} * @returns {@link VerifyMacCommandOutput} * @see {@link VerifyMacCommandInput} for command's `input` shape. * @see {@link VerifyMacCommandOutput} 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 KMSInvalidMacException} (client fault) *

The request was rejected because the HMAC verification failed. HMAC verification fails * when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does * not match the HMAC specified in the request.

* * @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 verify an HMAC * ```javascript * // 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. * const input = { * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", * Mac: "", * MacAlgorithm: "HMAC_SHA_384", * Message: "Hello World" * }; * const command = new VerifyMacCommand(input); * const response = await client.send(command); * /* response is * { * KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", * MacAlgorithm: "HMAC_SHA_384", * MacValid: true * } * *\/ * ``` * * @public */ export declare class VerifyMacCommand extends VerifyMacCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: VerifyMacRequest; output: VerifyMacResponse; }; sdk: { input: VerifyMacCommandInput; output: VerifyMacCommandOutput; }; }; }