AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the GetParametersForImport operation. Returns the public key and an import token you need to import or reimport key material for a KMS key.
By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
Before calling GetParametersForImport
, use the CreateKey operation with
an Origin
value of EXTERNAL
to create a KMS key with no key material.
You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric
encryption KMS key, or asymmetric signing KMS key. You can also import key material
into a multi-Region
key of any supported type. However, you can't import key material into a KMS key
in a custom
key store. You can also use GetParametersForImport
to get a public key
and import token to reimport
the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport
returns the items that you need to import your key
material.
The public key (or "wrapping key") of an RSA key pair that KMS generates.
You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together.
Each public key and import token set is valid for 24 hours. The expiration date and
time appear in the ParametersValidTo
field in the GetParametersForImport
response. You cannot use an expired public key or import token in an ImportKeyMaterial
request. If your key and token expire, send another GetParametersForImport
request.
GetParametersForImport
requires the following information:
The key ID of the KMS key for which you are importing the key material.
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
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: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public class GetParametersForImportRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The GetParametersForImportRequest type exposes the following members
Name | Description | |
---|---|---|
GetParametersForImportRequest() |
Name | Type | Description | |
---|---|---|---|
KeyId | System.String |
Gets and sets the property KeyId.
The identifier of the KMS key that will be associated with the imported key material.
The All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS key in a custom key store. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
WrappingAlgorithm | Amazon.KeyManagementService.AlgorithmSpec |
Gets and sets the property WrappingAlgorithm.
The algorithm you will use with the RSA public key ( For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS. The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.
|
|
WrappingKeySpec | Amazon.KeyManagementService.WrappingKeySpec |
Gets and sets the property WrappingKeySpec. The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import. Use the longest RSA wrapping key that is practical. You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key. |
The following example downloads a public key and import token to import symmetric encryption key material. It uses the default wrapping key spec and the RSAES_OAEP_SHA_256 wrapping algorithm.
var client = new AmazonKeyManagementServiceClient(); var response = client.GetParametersForImport(new GetParametersForImportRequest { KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. WrappingAlgorithm = "RSAES_OAEP_SHA_1", // The algorithm that you will use to encrypt the key material before importing it. WrappingKeySpec = "RSA_2048" // The type of wrapping key (public key) to return in the response. }); MemoryStream importToken = response.ImportToken; // The import token to send with a subsequent ImportKeyMaterial request. string keyId = response.KeyId; // The ARN of the KMS key that will be associated with the imported key material. DateTime parametersValidTo = response.ParametersValidTo; // The date and time when the import token and public key expire. After this time, call GetParametersForImport again. MemoryStream publicKey = response.PublicKey; // The public key to use to encrypt the key material before importing it.
The following example downloads a public key and import token to import an RSA private key. It uses a required RSA_AES wrapping algorithm and the largest supported private key.
var client = new AmazonKeyManagementServiceClient(); var response = client.GetParametersForImport(new GetParametersForImportRequest { KeyId = "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. WrappingAlgorithm = "RSA_AES_KEY_WRAP_SHA_256", // The algorithm that you will use to encrypt the key material before importing it. WrappingKeySpec = "RSA_4096" // The type of wrapping key (public key) to return in the response. }); MemoryStream importToken = response.ImportToken; // The import token to send with a subsequent ImportKeyMaterial request. string keyId = response.KeyId; // The ARN of the KMS key that will be associated with the imported key material. DateTime parametersValidTo = response.ParametersValidTo; // The date and time when the import token and public key expire. After this time, call GetParametersForImport again. MemoryStream publicKey = response.PublicKey; // The public key to use to encrypt the key material before importing it.
The following example downloads a public key and import token to import an ECC_NIST_P521 (secp521r1) private key. You cannot directly wrap this ECC key under an RSA_2048 public key, although you can use an RSA_2048 public key with an RSA_AES wrapping algorithm to wrap any supported key material. This example requests an RSA_3072 public key for use with the RSAES_OAEP_SHA_256.
var client = new AmazonKeyManagementServiceClient(); var response = client.GetParametersForImport(new GetParametersForImportRequest { KeyId = "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. WrappingAlgorithm = "RSAES_OAEP_SHA_256", // The algorithm that you will use to encrypt the key material before importing it. WrappingKeySpec = "RSA_3072" // The type of wrapping key (public key) to return in the response. }); MemoryStream importToken = response.ImportToken; // The import token to send with a subsequent ImportKeyMaterial request. string keyId = response.KeyId; // The ARN of the KMS key that will be associated with the imported key material. DateTime parametersValidTo = response.ParametersValidTo; // The date and time when the import token and public key expire. After this time, call GetParametersForImport again. MemoryStream publicKey = response.PublicKey; // The public key to use to encrypt the key material before importing it.
The following example downloads a public key and import token to import an HMAC key. It uses the RSAES_OAEP_SHA_256 wrapping algorithm and an RSA_4096 private key.
var client = new AmazonKeyManagementServiceClient(); var response = client.GetParametersForImport(new GetParametersForImportRequest { KeyId = "2468abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. WrappingAlgorithm = "RSAES_OAEP_SHA_256", // The algorithm that you will use to encrypt the key material before importing it. WrappingKeySpec = "RSA_4096" // The type of wrapping key (public key) to return in the response. }); MemoryStream importToken = response.ImportToken; // The import token to send with a subsequent ImportKeyMaterial request. string keyId = response.KeyId; // The ARN of the KMS key that will be associated with the imported key material. DateTime parametersValidTo = response.ParametersValidTo; // The date and time when the import token and public key expire. After this time, call GetParametersForImport again. MemoryStream publicKey = response.PublicKey; // The public key to use to encrypt the key material before importing it.
.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