diff --git a/clients/client-kms/src/commands/GetParametersForImportCommand.ts b/clients/client-kms/src/commands/GetParametersForImportCommand.ts index 99871ce4bb2b..02660039b902 100644 --- a/clients/client-kms/src/commands/GetParametersForImportCommand.ts +++ b/clients/client-kms/src/commands/GetParametersForImportCommand.ts @@ -52,7 +52,7 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp * material.
*The public key (or "wrapping key") of an RSA key pair that KMS generates.
+ *The public key (or "wrapping key") of an asymmetric key pair that KMS generates.
*You will use this public key to encrypt ("wrap") your key material while it's in * transit to KMS.
*The algorithm you will use with the RSA public key (PublicKey
) in the
+ *
The algorithm you will use with the asymmetric 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.
+ * algorithms, you encrypt your key material directly with the RSA public key from KMS. + * For SM2PKE wrapping algorithms, you encrypt your key material directly with the SM2 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.
+ * importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm, except + * in China Regions, where you must use the SM2PKE wrapping algorithm to import an RSA private key. + *The SM2PKE wrapping algorithm is available only in China Regions. The
+ * RSA_AES_KEY_WRAP_SHA_256
and RSA_AES_KEY_WRAP_SHA_1
+ * wrapping algorithms are not supported in China Regions.
@@ -4282,17 +4290,23 @@ export interface GetParametersForImportRequest { * RSAES_PKCS1_V1_5 (Deprecated) — As of October * 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
*+ * SM2PKE (China Regions only) — supported for + * wrapping RSA, ECC, and SM2 key material.
+ *The type of RSA public key to return in the response. You will use this wrapping key with + *
The type of 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.
+ *Use the longest 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 SM2 wrapping key spec is available only in China Regions.
* @public */ WrappingKeySpec: WrappingKeySpec | undefined; diff --git a/codegen/sdk-codegen/aws-models/kms.json b/codegen/sdk-codegen/aws-models/kms.json index ec2e561e76e0..76409909d978 100644 --- a/codegen/sdk-codegen/aws-models/kms.json +++ b/codegen/sdk-codegen/aws-models/kms.json @@ -64,6 +64,12 @@ "traits": { "smithy.api#enumValue": "RSA_AES_KEY_WRAP_SHA_256" } + }, + "SM2PKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM2PKE" + } } } }, @@ -3570,7 +3576,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the public key and an import token you need to import or reimport key material for\n a KMS key.
\nBy default, KMS keys are created with key material that KMS generates. This operation\n supports Importing key\n material, an advanced feature that lets you generate and import the cryptographic\n key material for a KMS key. For more information about importing key material into KMS, see\n Importing key\n material in the Key Management Service Developer Guide.
\nBefore calling GetParametersForImport
, use the CreateKey\n operation with an Origin
value of EXTERNAL
to create a KMS key with\n no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key,\n asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material\n into a multi-Region key of any supported type. However, you can't import key material into\n a KMS key in a custom key store. You can also use GetParametersForImport
to get a\n public key and import token to reimport the original key\n material into a KMS key whose key material expired or was deleted.
\n GetParametersForImport
returns the items that you need to import your key\n material.
The public key (or \"wrapping key\") of an RSA key pair that KMS generates.
\nYou will use this public key to encrypt (\"wrap\") your key material while it's in\n transit to KMS.
\nA import token that ensures that KMS can decrypt your key material and associate it\n with the correct KMS key.
\nThe public key and its import token are permanently linked and must be used together. Each\n public key and import token set is valid for 24 hours. The expiration date and time appear in\n the ParametersValidTo
field in the GetParametersForImport
response.\n You cannot use an expired public key or import token in an ImportKeyMaterial\n request. If your key and token expire, send another GetParametersForImport
\n request.
\n GetParametersForImport
requires the following information:
The key ID of the KMS key for which you are importing the key material.
\nThe key spec of the public key (\"wrapping key\") that you will use to encrypt your key\n material during import.
\nThe wrapping algorithm that you will use with the public key to encrypt your key\n material.
\nYou can use the same or a different public key spec and wrapping algorithm each time you\n import or reimport the same key material.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:GetParametersForImport (key policy)
\n\n Related operations:\n
\n\n ImportKeyMaterial\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
" + "smithy.api#documentation": "Returns the public key and an import token you need to import or reimport key material for\n a KMS key.
\nBy default, KMS keys are created with key material that KMS generates. This operation\n supports Importing key\n material, an advanced feature that lets you generate and import the cryptographic\n key material for a KMS key. For more information about importing key material into KMS, see\n Importing key\n material in the Key Management Service Developer Guide.
\nBefore calling GetParametersForImport
, use the CreateKey\n operation with an Origin
value of EXTERNAL
to create a KMS key with\n no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key,\n asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material\n into a multi-Region key of any supported type. However, you can't import key material into\n a KMS key in a custom key store. You can also use GetParametersForImport
to get a\n public key and import token to reimport the original key\n material into a KMS key whose key material expired or was deleted.
\n GetParametersForImport
returns the items that you need to import your key\n material.
The public key (or \"wrapping key\") of an asymmetric key pair that KMS generates.
\nYou will use this public key to encrypt (\"wrap\") your key material while it's in\n transit to KMS.
\nA import token that ensures that KMS can decrypt your key material and associate it\n with the correct KMS key.
\nThe public key and its import token are permanently linked and must be used together. Each\n public key and import token set is valid for 24 hours. The expiration date and time appear in\n the ParametersValidTo
field in the GetParametersForImport
response.\n You cannot use an expired public key or import token in an ImportKeyMaterial\n request. If your key and token expire, send another GetParametersForImport
\n request.
\n GetParametersForImport
requires the following information:
The key ID of the KMS key for which you are importing the key material.
\nThe key spec of the public key (\"wrapping key\") that you will use to encrypt your key\n material during import.
\nThe wrapping algorithm that you will use with the public key to encrypt your key\n material.
\nYou can use the same or a different public key spec and wrapping algorithm each time you\n import or reimport the same key material.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n Required permissions: kms:GetParametersForImport (key policy)
\n\n Related operations:\n
\n\n ImportKeyMaterial\n
\n\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.
" } }, "com.amazonaws.kms#GetParametersForImportRequest": { @@ -3586,14 +3592,14 @@ "WrappingAlgorithm": { "target": "com.amazonaws.kms#AlgorithmSpec", "traits": { - "smithy.api#documentation": "The algorithm you will use with the RSA public key (PublicKey
) in the\n 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\n generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping\n algorithms, you encrypt your key material directly with the RSA public key from KMS.
\nThe wrapping algorithms that you can use depend on the type of key material that you are\n importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.
\n\n RSA_AES_KEY_WRAP_SHA_256 — Supported for\n wrapping RSA and ECC key material.
\n\n RSA_AES_KEY_WRAP_SHA_1 — Supported for\n wrapping RSA and ECC key material.
\n\n RSAES_OAEP_SHA_256 — Supported for all types\n of key material, except RSA key material (private key).
\nYou cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping\n key spec to wrap ECC_NIST_P521 key material.
\n\n RSAES_OAEP_SHA_1 — Supported for all types of\n key material, except RSA key material (private key).
\nYou cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key\n spec to wrap ECC_NIST_P521 key material.
\n\n RSAES_PKCS1_V1_5 (Deprecated) — As of October\n 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
\nThe algorithm you will use with the asymmetric public key (PublicKey
) in the\n 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\n generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping\n algorithms, you encrypt your key material directly with the RSA public key from KMS. \n For SM2PKE wrapping algorithms, you encrypt your key material directly with the SM2 public key \n from KMS.
\nThe wrapping algorithms that you can use depend on the type of key material that you are\n importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm, except \n in China Regions, where you must use the SM2PKE wrapping algorithm to import an RSA private key.
\nThe SM2PKE wrapping algorithm is available only in China Regions. The \n RSA_AES_KEY_WRAP_SHA_256
and RSA_AES_KEY_WRAP_SHA_1
\n wrapping algorithms are not supported in China Regions.
\n RSA_AES_KEY_WRAP_SHA_256 — Supported for\n wrapping RSA and ECC key material.
\n\n RSA_AES_KEY_WRAP_SHA_1 — Supported for\n wrapping RSA and ECC key material.
\n\n RSAES_OAEP_SHA_256 — Supported for all types\n of key material, except RSA key material (private key).
\nYou cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping\n key spec to wrap ECC_NIST_P521 key material.
\n\n RSAES_OAEP_SHA_1 — Supported for all types of\n key material, except RSA key material (private key).
\nYou cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key\n spec to wrap ECC_NIST_P521 key material.
\n\n RSAES_PKCS1_V1_5 (Deprecated) — As of October\n 10, 2023, KMS does not support the RSAES_PKCS1_V1_5 wrapping algorithm.
\n\n SM2PKE (China Regions only) — supported for \n wrapping RSA, ECC, and SM2 key material.
\nThe type of RSA public key to return in the response. You will use this wrapping key with\n the specified wrapping algorithm to protect your key material during import.
\nUse the longest RSA wrapping key that is practical.
\nYou cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key.\n Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
", + "smithy.api#documentation": "The type of public key to return in the response. You will use this wrapping key with\n the specified wrapping algorithm to protect your key material during import.
\nUse the longest wrapping key that is practical.
\nYou cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key.\n Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.
\nThe SM2 wrapping key spec is available only in China Regions.
", "smithy.api#required": {} } } @@ -9145,6 +9151,12 @@ "traits": { "smithy.api#enumValue": "RSA_4096" } + }, + "SM2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM2" + } } } },