| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KMS.Sign
Description
Creates a digital signature for a message or message digest by using the private key in an asymmetric KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed.
To use the Sign operation, provide the following information:
- Use the
KeyIdparameter to identify an asymmetric KMS key with aKeyUsagevalue ofSIGN_VERIFY. To get theKeyUsagevalue of a KMS key, use the DescribeKey operation. The caller must havekms:Signpermission on the KMS key. - Use the
Messageparameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in theMessageparameter. To indicate whether the message is a full message or a digest, use theMessageTypeparameter. - Choose a signing algorithm that is compatible with the KMS key.
When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature.
To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of KMS.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key 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:Sign (key policy)
Related operations: Verify
Synopsis
- data Sign = Sign' {}
- newSign :: Text -> ByteString -> SigningAlgorithmSpec -> Sign
- sign_messageType :: Lens' Sign (Maybe MessageType)
- sign_grantTokens :: Lens' Sign (Maybe [Text])
- sign_keyId :: Lens' Sign Text
- sign_message :: Lens' Sign ByteString
- sign_signingAlgorithm :: Lens' Sign SigningAlgorithmSpec
- data SignResponse = SignResponse' {}
- newSignResponse :: Int -> SignResponse
- signResponse_signingAlgorithm :: Lens' SignResponse (Maybe SigningAlgorithmSpec)
- signResponse_signature :: Lens' SignResponse (Maybe ByteString)
- signResponse_keyId :: Lens' SignResponse (Maybe Text)
- signResponse_httpStatus :: Lens' SignResponse Int
Creating a Request
See: newSign smart constructor.
Constructors
| Sign' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ByteString | |
| -> SigningAlgorithmSpec | |
| -> Sign |
Create a value of Sign 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:messageType:Sign', sign_messageType - Tells KMS whether the value of the Message parameter is a message or
message digest. The default value, RAW, indicates a message. To indicate
a message digest, enter DIGEST.
$sel:grantTokens:Sign', sign_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:keyId:Sign', sign_keyId - Identifies an asymmetric KMS key. KMS uses the private key in the
asymmetric KMS key to sign the message. The KeyUsage type of the KMS
key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the
DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/". To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - Alias name:
alias/ExampleAlias - Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
$sel:message:Sign', sign_message - Specifies the message or message digest to sign. Messages can be 0-4096
bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and
then signs it.--
-- 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.
$sel:signingAlgorithm:Sign', sign_signingAlgorithm - Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
Request Lenses
sign_messageType :: Lens' Sign (Maybe MessageType) Source #
Tells KMS whether the value of the Message parameter is a message or
message digest. The default value, RAW, indicates a message. To indicate
a message digest, enter DIGEST.
sign_grantTokens :: Lens' Sign (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.
sign_keyId :: Lens' Sign Text Source #
Identifies an asymmetric KMS key. KMS uses the private key in the
asymmetric KMS key to sign the message. The KeyUsage type of the KMS
key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the
DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/". To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - Alias name:
alias/ExampleAlias - Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
sign_message :: Lens' Sign ByteString Source #
Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and
then signs it.--
-- 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.
sign_signingAlgorithm :: Lens' Sign SigningAlgorithmSpec Source #
Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
Destructuring the Response
data SignResponse Source #
See: newSignResponse smart constructor.
Constructors
| SignResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> SignResponse |
Create a value of SignResponse 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:signingAlgorithm:Sign', signResponse_signingAlgorithm - The signing algorithm that was used to sign the message.
$sel:signature:SignResponse', signResponse_signature - The cryptographic signature that was generated for the message.
- When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
- When used with the
ECDSA_SHA_256,ECDSA_SHA_384, orECDSA_SHA_512signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is
Base64-encoded. Otherwise, it is not Base64-encoded.--
-- 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.
$sel:keyId:Sign', signResponse_keyId - The Amazon Resource Name
(key ARN)
of the asymmetric KMS key that was used to sign the message.
$sel:httpStatus:SignResponse', signResponse_httpStatus - The response's http status code.
Response Lenses
signResponse_signingAlgorithm :: Lens' SignResponse (Maybe SigningAlgorithmSpec) Source #
The signing algorithm that was used to sign the message.
signResponse_signature :: Lens' SignResponse (Maybe ByteString) Source #
The cryptographic signature that was generated for the message.
- When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
- When used with the
ECDSA_SHA_256,ECDSA_SHA_384, orECDSA_SHA_512signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is
Base64-encoded. Otherwise, it is not Base64-encoded.--
-- 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.
signResponse_keyId :: Lens' SignResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.
signResponse_httpStatus :: Lens' SignResponse Int Source #
The response's http status code.