generate_mac¶
Operation¶
async
¶
generate_mac(input: GenerateMacInput, plugins: list[Plugin] | None = None) -> GenerateMacOutput
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 .
Note
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GenerateMacInput
|
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 |
|---|---|
GenerateMacOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GenerateMacInput 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 HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.
To identify an HMAC KMS key, use the DescribeKey operation and see the
KeySpec field in the response.
class-attribute
instance-attribute
¶
mac_algorithm: str | None = ...
The MAC algorithm used in the operation.
The algorithm must be compatible with the HMAC KMS key that you specify.
To find the MAC algorithms that your HMAC KMS key supports, use the
DescribeKey operation and see the MacAlgorithms field in the
DescribeKey response.
class-attribute
instance-attribute
¶
message: bytes | None = ...
The message to be hashed. Specify a message of up to 4,096 bytes.
GenerateMac and VerifyMac do not provide special handling for message
digests. If you generate an HMAC for a hash digest of a message, you
must verify the HMAC of the same hash digest.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GenerateMacOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
key_id: str | None = ...
The HMAC KMS key used in the operation.
class-attribute
instance-attribute
¶
mac: bytes | None = ...
The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.
This is the standard, raw HMAC defined in RFC 2104.
class-attribute
instance-attribute
¶
mac_algorithm: str | None = ...
The MAC algorithm that was used to generate the HMAC.
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.