KMS.Client.generate_data_key(**kwargs)¶Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.
To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.
You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.
To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec value of AES_128 or a NumberOfBytes value of 16 . The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
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 .
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS 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 .
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of KMS:
GenerateDataKey operation to get a data key.Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.CiphertextBlob field of the response) with the encrypted data.To decrypt data outside of KMS:
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
KeyIdparameter.Required permissions : kms:GenerateDataKey (key policy)
Related operations:
See also: AWS API Documentation
Request Syntax
response = client.generate_data_key(
KeyId='string',
EncryptionContext={
'string': 'string'
},
NumberOfBytes=123,
KeySpec='AES_256'|'AES_128',
GrantTokens=[
'string',
]
)
[REQUIRED]
Specifies the symmetric encryption KMS key that encrypts the data key. 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:
1234abcd-12ab-34cd-56ef-1234567890abarn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890abalias/ExampleAliasarn:aws:kms:us-east-2:111122223333:alias/ExampleAliasTo 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.
Specifies the encryption context that will be used when encrypting the data key.
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 .
Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.
Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.
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 .
dict
Response Syntax
{
'CiphertextBlob': b'bytes',
'Plaintext': b'bytes',
'KeyId': 'string'
}
Response Structure
(dict) --
CiphertextBlob (bytes) --
The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
Plaintext (bytes) --
The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
KeyId (string) --
The Amazon Resource Name ( key ARN ) of the KMS key that encrypted the data key.
Exceptions
KMS.Client.exceptions.NotFoundExceptionKMS.Client.exceptions.DisabledExceptionKMS.Client.exceptions.KeyUnavailableExceptionKMS.Client.exceptions.DependencyTimeoutExceptionKMS.Client.exceptions.InvalidKeyUsageExceptionKMS.Client.exceptions.InvalidGrantTokenExceptionKMS.Client.exceptions.KMSInternalExceptionKMS.Client.exceptions.KMSInvalidStateExceptionExamples
The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key.
response = client.generate_data_key(
# The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
KeyId='alias/ExampleAlias',
# Specifies the type of data key to return.
KeySpec='AES_256',
)
print(response)
Expected Output:
{
# The encrypted data key.
'CiphertextBlob': '<binary data>',
# The ARN of the KMS key that was used to encrypt the data key.
'KeyId': 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
# The unencrypted (plaintext) data key.
'Plaintext': '<binary data>',
'ResponseMetadata': {
'...': '...',
},
}