Skip to content

Get Parameters for Import

kms_get_parameters_for_import R Documentation

Returns the public key and an import token you need to import or reimport key material for a KMS key

Description

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 get_parameters_for_import, use the create_key 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 get_parameters_for_import 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.

get_parameters_for_import 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 get_parameters_for_import response. You cannot use an expired public key or import token in an import_key_material request. If your key and token expire, send another get_parameters_for_import request.

get_parameters_for_import 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:

  • import_key_material

  • delete_imported_key_material

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Usage

kms_get_parameters_for_import(KeyId, WrappingAlgorithm, WrappingKeySpec)

Arguments

KeyId

[required] The identifier of the KMS key that will be associated with the imported key material. The Origin of the KMS key must be EXTERNAL.

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:

  • Key ID: ⁠1234abcd-12ab-34cd-56ef-1234567890ab⁠

  • Key ARN: ⁠arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab⁠

To get the key ID and key ARN for a KMS key, use list_keys or describe_key.

WrappingAlgorithm

[required] The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.

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.

  • RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.

  • RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.

  • RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).

    You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.

  • RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).

    You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.

  • RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.

WrappingKeySpec

[required] 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.

Value

A list with the following syntax: 

list(
  KeyId = "string",
  ImportToken = raw,
  PublicKey = raw,
  ParametersValidTo = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_parameters_for_import(
  KeyId = "string",
  WrappingAlgorithm = "RSAES_PKCS1_V1_5"|"RSAES_OAEP_SHA_1"|"RSAES_OAEP_SHA_256"|"RSA_AES_KEY_WRAP_SHA_1"|"RSA_AES_KEY_WRAP_SHA_256"|"SM2PKE",
  WrappingKeySpec = "RSA_2048"|"RSA_3072"|"RSA_4096"|"SM2"
)

Examples

## Not run: 
# 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.
svc$get_parameters_for_import(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
  WrappingAlgorithm = "RSAES_OAEP_SHA_1",
  WrappingKeySpec = "RSA_2048"
)

# 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.
svc$get_parameters_for_import(
  KeyId = "arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab",
  WrappingAlgorithm = "RSA_AES_KEY_WRAP_SHA_256",
  WrappingKeySpec = "RSA_4096"
)

# 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.
svc$get_parameters_for_import(
  KeyId = "arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab",
  WrappingAlgorithm = "RSAES_OAEP_SHA_256",
  WrappingKeySpec = "RSA_3072"
)

# 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.
svc$get_parameters_for_import(
  KeyId = "2468abcd-12ab-34cd-56ef-1234567890ab",
  WrappingAlgorithm = "RSAES_OAEP_SHA_256",
  WrappingKeySpec = "RSA_4096"
)

## End(Not run)