Generates a unique asymmetric data key pair. The
generate_data_key_pair operation returns
a plaintext public key, a plaintext private key, and a copy of the
private key that is encrypted under the symmetric CMK you specify. You
can use the data key pair to perform asymmetric cryptography outside of
AWS KMS.
generate_data_key_pair returns a unique
data key pair for each request. The bytes in the keys are not related to
the caller or the CMK that is used to encrypt the private key.
You can use the public key that
generate_data_key_pair returns to
encrypt data or verify a signature outside of AWS 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 customer
master key (CMK) to encrypt the private key in a data key pair. You
cannot use an asymmetric CMK or a CMK in a custom key store. To get the
type and origin of your CMK, use the describe_key
operation.
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
generate_data_key_pair_without_plaintext
operation.
generate_data_key_pair_without_plaintext
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.
You can use the 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 AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a
different AWS 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
generate_data_key
generate_data_key_pair_without_plaintext
generate_data_key_without_plaintext
kms_generate_data_key_pair(EncryptionContext, KeyId, KeyPairSpec,
GrantTokens)A list with the following syntax:
list(
PrivateKeyCiphertextBlob = raw,
PrivateKeyPlaintext = raw,
PublicKey = raw,
KeyId = "string",
KeyPairSpec = "RSA_2048"|"RSA_3072"|"RSA_4096"|"ECC_NIST_P256"|"ECC_NIST_P384"|"ECC_NIST_P521"|"ECC_SECG_P256K1"
)
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 represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
[required] Specifies the symmetric CMK that encrypts the private key in the data
key pair. You cannot specify an asymmetric CMK or a CMK in a custom key
store. To get the type and origin of your CMK, use the
describe_key operation.
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias
name, or alias ARN. When using an alias name, prefix it with "alias/".
To specify a CMK in a different AWS 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 CMK, use
list_keys or describe_key. To
get the alias name and alias ARN, use
list_aliases.
[required] Determines the type of data key pair that is generated.
The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
svc$generate_data_key_pair(
EncryptionContext = list(
"string"
),
KeyId = "string",
KeyPairSpec = "RSA_2048"|"RSA_3072"|"RSA_4096"|"ECC_NIST_P256"|"ECC_NIST_P384"|"ECC_NIST_P521"|"ECC_SECG_P256K1",
GrantTokens = list(
"string"
)
)