verify_mac¶
Operation¶
async
¶
verify_mac(input: VerifyMacInput, plugins: list[Plugin] | None = None) -> VerifyMacOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
VerifyMacInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
VerifyMacOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for VerifyMacInput structure.
Attributes¶
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks if your request will succeed. DryRun is an optional parameter.
To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
key_id: str | None = ...
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 VerifyMac operation fails.
class-attribute
instance-attribute
¶
mac: bytes | None = ...
The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
class-attribute
instance-attribute
¶
mac_algorithm: str | None = ...
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.
class-attribute
instance-attribute
¶
message: bytes | None = ...
The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
GenerateMac and VerifyMac 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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for VerifyMacOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
key_id: str | None = ...
The HMAC KMS key used in the verification.
class-attribute
instance-attribute
¶
mac_algorithm: str | None = ...
The MAC algorithm used in the verification.
class-attribute
instance-attribute
¶
mac_valid: bool = ...
A Boolean value that indicates whether the HMAC was verified. A value of
True indicates that the HMAC (Mac) was generated with the specified
Message, HMAC KMS key (KeyID) and MacAlgorithm..
If the HMAC is not verified, the VerifyMac operation fails with a
KMSInvalidMacException exception. This exception indicates that one or
more of the inputs changed since the HMAC was computed.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.