Container for the parameters to the GenerateRandom operation. Returns a random byte string that is cryptographically secure.
You must use the NumberOfBytes parameter to specify the length of the random
byte string. There is no default value for string length.
By default, the random byte string is generated in KMS. To generate the byte string
in the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId
parameter.
GenerateRandom also supports Amazon
Web Services Nitro Enclaves, which provide an isolated compute environment in
Amazon EC2. To call GenerateRandom for a 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. Instead of plaintext
bytes, the response includes the plaintext bytes 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.
For more information about entropy and random number generation, see Key Management Service Cryptographic Details.
Cross-account use: Not applicable. GenerateRandom does not use any
account-specific resources, such as KMS keys.
Required permissions: kms:GenerateRandom (IAM policy)
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.GenerateRandomRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class GenerateRandomRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The GenerateRandomRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GenerateRandomRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CustomKeyStoreId | System.String |
Gets and sets the property CustomKeyStoreId. Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
External key store IDs are not valid for this parameter. If you specify the ID of
an external key store, |
|
|
NumberOfBytes | System.Int32 |
Gets and sets the property NumberOfBytes. The length of the random byte string. This parameter is required. |
|
|
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 plaintext bytes, KMS encrypts the
plaintext bytes 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
The following example generates 32 bytes of random data.
To generate random data
var client = new AmazonKeyManagementServiceClient();
var response = client.GenerateRandom(new GenerateRandomRequest
{
NumberOfBytes = 32 // The length of the random data, specified in number of bytes.
});
MemoryStream plaintext = response.Plaintext; // The random data.
The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext (unencrypted) byte string, GenerateRandom returns the byte string encrypted by the public key from the enclave's attestation document.
To generate random data
var client = new AmazonKeyManagementServiceClient();
var response = client.GenerateRandom(new GenerateRandomRequest
{
NumberOfBytes = 1024, // The length of the random byte string
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 random data encrypted under the public key from the attestation document
MemoryStream plaintext = response.Plaintext; // This field is null or empty
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5