Container for the parameters to the GenerateDataKeyPair operation. 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 are 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.
GenerateDataKeyPair also supports Amazon
Web Services Nitro Enclaves, which provide an isolated compute environment in
Amazon EC2. To call GenerateDataKeyPair for an Amazon Web Services Nitro enclave,
use the Amazon
Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient
parameter to provide the attestation document for the enclave. GenerateDataKeyPair
returns the public data key and a copy of the private data key encrypted under the
specified KMS key, as usual. But instead of a plaintext copy of the private data key
(PrivateKeyPlaintext), the response includes a copy of the private data key
encrypted under the public key from the attestation document (CiphertextForRecipient).
For information about the interaction between KMS and Amazon Web Services Nitro Enclaves,
see How
Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer
Guide..
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:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.GenerateDataKeyPairRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class GenerateDataKeyPairRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The GenerateDataKeyPairRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GenerateDataKeyPairRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DryRun | System.Boolean |
Gets and sets the property DryRun.
Checks if your request will succeed. To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide. |
|
|
EncryptionContext | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property EncryptionContext. Specifies the encryption context that will be used when encrypting the private key in the data key pair. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. 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. |
|
|
GrantTokens | System.Collections.Generic.List<System.String> |
Gets and sets the property 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. |
|
|
KeyId | System.String |
Gets and sets the property 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 For example:
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. |
|
|
KeyPairSpec | Amazon.KeyManagementService.DataKeyPairSpec |
Gets and sets the property 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. |
|
|
Recipient | Amazon.KeyManagementService.Model.RecipientInfo |
Gets and sets the property Recipient.
A signed attestation
document from an Amazon Web Services Nitro enclave and the encryption algorithm
to use with the enclave's public key. The only valid encryption algorithm is This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.
When you use this parameter, instead of returning a plaintext copy of the private
data key, KMS encrypts the plaintext private data key under the public key in the
attestation document, and returns the resulting ciphertext in the For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide. |
Examples
This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify.
To generate an RSA key pair for encryption and decryption
var client = new AmazonKeyManagementServiceClient();
var response = client.GenerateDataKeyPair(new GenerateDataKeyPairRequest
{
KeyId = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
KeyPairSpec = "RSA_3072" // The requested key spec of the RSA data key pair.
});
string keyId = response.KeyId; // The key ARN of the symmetric encryption KMS key that was used to encrypt the private key.
string keyPairSpec = response.KeyPairSpec; // The actual key spec of the RSA data key pair.
MemoryStream privateKeyCiphertextBlob = response.PrivateKeyCiphertextBlob; // The encrypted private key of the RSA data key pair.
MemoryStream privateKeyPlaintext = response.PrivateKeyPlaintext; // The plaintext private key of the RSA data key pair.
MemoryStream publicKey = response.PublicKey; // The public key (plaintext) of the RSA data key pair.
The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext copy of the private data key, GenerateDataKeyPair returns a copy of the private data key encrypted by the public key from the attestation document (CiphertextForRecipient). It returns the public data key (PublicKey) and a copy of private data key encrypted under the specified KMS key (PrivateKeyCiphertextBlob), as usual, but plaintext private data key field (PrivateKeyPlaintext) is null or empty.
To generate a data key pair for a Nitro enclave
var client = new AmazonKeyManagementServiceClient();
var response = client.GenerateDataKeyPair(new GenerateDataKeyPairRequest
{
KeyId = "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
KeyPairSpec = "RSA_3072", // The requested key spec of the RSA data key pair.
Recipient = new RecipientInfo {
AttestationDocument = new MemoryStream(<attestation document>),
KeyEncryptionAlgorithm = "RSAES_OAEP_SHA_256"
} // Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document.
});
MemoryStream ciphertextForRecipient = response.CiphertextForRecipient; // The private key of the RSA data key pair encrypted by the public key from the attestation document
string keyId = response.KeyId; // The key ARN of the symmetric encryption KMS key that was used to encrypt the PrivateKeyCiphertextBlob.
string keyPairSpec = response.KeyPairSpec; // The actual key spec of the RSA data key pair.
MemoryStream privateKeyCiphertextBlob = response.PrivateKeyCiphertextBlob; // The private key of the RSA data key pair encrypted by the KMS key.
MemoryStream privateKeyPlaintext = response.PrivateKeyPlaintext; // This field is null or empty
MemoryStream publicKey = response.PublicKey; // The public key (plaintext) of the RSA data key pair.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5