| 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.GenerateDataKeyPair
Description
Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the private key.
You can use the public key that GenerateDataKeyPair returns to encrypt
data or verify a signature outside of KMS. Then, store the encrypted
private key with the data. When you are ready to decrypt data or sign a
message, you can use the Decrypt operation to decrypt the encrypted
private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC)
data key pair. In China Regions, you can also choose an SM2 data key
pair. KMS recommends that you use ECC key pairs for signing, and use RSA
and SM2 key pairs for either encryption or signing, but not both.
However, KMS cannot enforce any restrictions on the use of data key
pairs outside of KMS.
If you are using the data key pair to encrypt data, or for any operation
where you don't immediately need a private key, consider using the
GenerateDataKeyPairWithoutPlaintext operation.
GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and
an encrypted private key, but omits the plaintext private key that you
need only to decrypt ciphertext or sign a message. Later, when you need
to decrypt the data or sign a message, use the Decrypt operation to
decrypt the encrypted private key in the data key pair.
GenerateDataKeyPair returns a unique data key pair for each request.
The bytes in the keys are random; they are not related to the caller or
the KMS key that is used to encrypt the private key. The public key is a
DER-encoded X.509 SubjectPublicKeyInfo, as specified in
RFC 5280. The private key is a
DER-encoded PKCS8 PrivateKeyInfo, as specified in
RFC 5958.
You can use an optional encryption context to add additional security to
the encryption operation. If you specify an EncryptionContext, you
must specify the same encryption context (a case-sensitive exact match)
when decrypting the encrypted data key. Otherwise, the request to
decrypt fails with an InvalidCiphertextException. For more
information, see
Encryption Context
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:GenerateDataKeyPair (key policy)
Related operations:
- Decrypt
- Encrypt
- GenerateDataKey
- GenerateDataKeyPairWithoutPlaintext
- GenerateDataKeyWithoutPlaintext
Synopsis
- data GenerateDataKeyPair = GenerateDataKeyPair' {
- encryptionContext :: Maybe (HashMap Text Text)
- grantTokens :: Maybe [Text]
- keyId :: Text
- keyPairSpec :: DataKeyPairSpec
- newGenerateDataKeyPair :: Text -> DataKeyPairSpec -> GenerateDataKeyPair
- generateDataKeyPair_encryptionContext :: Lens' GenerateDataKeyPair (Maybe (HashMap Text Text))
- generateDataKeyPair_grantTokens :: Lens' GenerateDataKeyPair (Maybe [Text])
- generateDataKeyPair_keyId :: Lens' GenerateDataKeyPair Text
- generateDataKeyPair_keyPairSpec :: Lens' GenerateDataKeyPair DataKeyPairSpec
- data GenerateDataKeyPairResponse = GenerateDataKeyPairResponse' {}
- newGenerateDataKeyPairResponse :: Int -> GenerateDataKeyPairResponse
- generateDataKeyPairResponse_keyId :: Lens' GenerateDataKeyPairResponse (Maybe Text)
- generateDataKeyPairResponse_keyPairSpec :: Lens' GenerateDataKeyPairResponse (Maybe DataKeyPairSpec)
- generateDataKeyPairResponse_privateKeyCiphertextBlob :: Lens' GenerateDataKeyPairResponse (Maybe ByteString)
- generateDataKeyPairResponse_privateKeyPlaintext :: Lens' GenerateDataKeyPairResponse (Maybe ByteString)
- generateDataKeyPairResponse_publicKey :: Lens' GenerateDataKeyPairResponse (Maybe ByteString)
- generateDataKeyPairResponse_httpStatus :: Lens' GenerateDataKeyPairResponse Int
Creating a Request
data GenerateDataKeyPair Source #
See: newGenerateDataKeyPair smart constructor.
Constructors
| GenerateDataKeyPair' | |
Fields
| |
Instances
newGenerateDataKeyPair Source #
Create a value of GenerateDataKeyPair 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:encryptionContext:GenerateDataKeyPair', generateDataKeyPair_encryptionContext - Specifies the encryption context that will be used when encrypting the
private key in the data key pair.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
$sel:grantTokens:GenerateDataKeyPair', generateDataKeyPair_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.
GenerateDataKeyPair, generateDataKeyPair_keyId - Specifies the symmetric encryption KMS key that encrypts the private key
in the data key pair. You cannot specify an asymmetric KMS key or a KMS
key in a custom key store. To get the type and origin of your 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.
GenerateDataKeyPair, generateDataKeyPair_keyPairSpec - Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.
Request Lenses
generateDataKeyPair_encryptionContext :: Lens' GenerateDataKeyPair (Maybe (HashMap Text Text)) Source #
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
generateDataKeyPair_grantTokens :: Lens' GenerateDataKeyPair (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.
generateDataKeyPair_keyId :: Lens' GenerateDataKeyPair Text Source #
Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your 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.
generateDataKeyPair_keyPairSpec :: Lens' GenerateDataKeyPair DataKeyPairSpec Source #
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.
Destructuring the Response
data GenerateDataKeyPairResponse Source #
See: newGenerateDataKeyPairResponse smart constructor.
Constructors
| GenerateDataKeyPairResponse' | |
Fields
| |
Instances
newGenerateDataKeyPairResponse Source #
Create a value of GenerateDataKeyPairResponse 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:
GenerateDataKeyPair, generateDataKeyPairResponse_keyId - The Amazon Resource Name
(key ARN)
of the KMS key that encrypted the private key.
GenerateDataKeyPair, generateDataKeyPairResponse_keyPairSpec - The type of data key pair that was generated.
$sel:privateKeyCiphertextBlob:GenerateDataKeyPairResponse', generateDataKeyPairResponse_privateKeyCiphertextBlob - The encrypted copy of the private key. 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:privateKeyPlaintext:GenerateDataKeyPairResponse', generateDataKeyPairResponse_privateKeyPlaintext - The plaintext copy of the private key. 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:publicKey:GenerateDataKeyPairResponse', generateDataKeyPairResponse_publicKey - The public key (in plaintext). 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:httpStatus:GenerateDataKeyPairResponse', generateDataKeyPairResponse_httpStatus - The response's http status code.
Response Lenses
generateDataKeyPairResponse_keyId :: Lens' GenerateDataKeyPairResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
generateDataKeyPairResponse_keyPairSpec :: Lens' GenerateDataKeyPairResponse (Maybe DataKeyPairSpec) Source #
The type of data key pair that was generated.
generateDataKeyPairResponse_privateKeyCiphertextBlob :: Lens' GenerateDataKeyPairResponse (Maybe ByteString) Source #
The encrypted copy of the private key. 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.
generateDataKeyPairResponse_privateKeyPlaintext :: Lens' GenerateDataKeyPairResponse (Maybe ByteString) Source #
The plaintext copy of the private key. 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.
generateDataKeyPairResponse_publicKey :: Lens' GenerateDataKeyPairResponse (Maybe ByteString) Source #
The public key (in plaintext). 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.
generateDataKeyPairResponse_httpStatus :: Lens' GenerateDataKeyPairResponse Int Source #
The response's http status code.