| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KMS.GenerateMac
Description
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
Synopsis
- data GenerateMac = GenerateMac' {
- grantTokens :: Maybe [Text]
- message :: Sensitive Base64
- keyId :: Text
- macAlgorithm :: MacAlgorithmSpec
- newGenerateMac :: ByteString -> Text -> MacAlgorithmSpec -> GenerateMac
- generateMac_grantTokens :: Lens' GenerateMac (Maybe [Text])
- generateMac_message :: Lens' GenerateMac ByteString
- generateMac_keyId :: Lens' GenerateMac Text
- generateMac_macAlgorithm :: Lens' GenerateMac MacAlgorithmSpec
- data GenerateMacResponse = GenerateMacResponse' {
- keyId :: Maybe Text
- mac :: Maybe Base64
- macAlgorithm :: Maybe MacAlgorithmSpec
- httpStatus :: Int
- newGenerateMacResponse :: Int -> GenerateMacResponse
- generateMacResponse_keyId :: Lens' GenerateMacResponse (Maybe Text)
- generateMacResponse_mac :: Lens' GenerateMacResponse (Maybe ByteString)
- generateMacResponse_macAlgorithm :: Lens' GenerateMacResponse (Maybe MacAlgorithmSpec)
- generateMacResponse_httpStatus :: Lens' GenerateMacResponse Int
Creating a Request
data GenerateMac Source #
See: newGenerateMac smart constructor.
Constructors
| GenerateMac' | |
Fields
| |
Instances
Arguments
| :: ByteString | |
| -> Text | |
| -> MacAlgorithmSpec | |
| -> GenerateMac |
Create a value of GenerateMac with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantTokens:GenerateMac', generateMac_grantTokens - 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.
$sel:message:GenerateMac', generateMac_message - 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.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
GenerateMac, generateMac_keyId - 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.
GenerateMac, generateMac_macAlgorithm - 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.
Request Lenses
generateMac_grantTokens :: Lens' GenerateMac (Maybe [Text]) Source #
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.
generateMac_message :: Lens' GenerateMac ByteString Source #
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.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
generateMac_keyId :: Lens' GenerateMac Text Source #
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.
generateMac_macAlgorithm :: Lens' GenerateMac MacAlgorithmSpec Source #
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.
Destructuring the Response
data GenerateMacResponse Source #
See: newGenerateMacResponse smart constructor.
Constructors
| GenerateMacResponse' | |
Fields
| |
Instances
newGenerateMacResponse Source #
Arguments
| :: Int | |
| -> GenerateMacResponse |
Create a value of GenerateMacResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GenerateMac, generateMacResponse_keyId - The HMAC KMS key used in the operation.
$sel:mac:GenerateMacResponse', generateMacResponse_mac - 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.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
GenerateMac, generateMacResponse_macAlgorithm - The MAC algorithm that was used to generate the HMAC.
$sel:httpStatus:GenerateMacResponse', generateMacResponse_httpStatus - The response's http status code.
Response Lenses
generateMacResponse_keyId :: Lens' GenerateMacResponse (Maybe Text) Source #
The HMAC KMS key used in the operation.
generateMacResponse_mac :: Lens' GenerateMacResponse (Maybe ByteString) Source #
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.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
generateMacResponse_macAlgorithm :: Lens' GenerateMacResponse (Maybe MacAlgorithmSpec) Source #
The MAC algorithm that was used to generate the HMAC.
generateMacResponse_httpStatus :: Lens' GenerateMacResponse Int Source #
The response's http status code.