TranslateKeyMaterial - AWS Payment Cryptography Data Plane

TranslateKeyMaterial

Translates an cryptographic key between different wrapping keys without importing the key into AWS Payment Cryptography.

This operation can be used when key material is frequently rotated, such as during every card transaction, and there is a need to avoid importing short-lived keys into AWS Payment Cryptography. It translates short-lived transaction keys such as PEK generated for each transaction and wrapped with an ECDH derived wrapping key to another KEK wrapping key.

Before using this operation, you must first request the public key certificate of the ECC key pair generated within AWS Payment Cryptography to establish an ECDH key agreement. In TranslateKeyData, the service uses its own ECC key pair, public certificate of receiving ECC key pair, and the key derivation parameters to generate a derived key. The service uses this derived key to unwrap the incoming transaction key received as a TR31WrappedKeyBlock and re-wrap using a user provided KEK to generate an outgoing Tr31WrappedKeyBlock.

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the AWS Payment Cryptography User Guide.

Cross-account use: This operation can't be used across different AWS accounts.

Related operations:

Request Syntax

POST /keymaterial/translate HTTP/1.1 Content-type: application/json { "IncomingKeyMaterial": { ... }, "KeyCheckValueAlgorithm": "string", "OutgoingKeyMaterial": { ... } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

IncomingKeyMaterial

Parameter information of the TR31WrappedKeyBlock containing the transaction key.

Type: IncomingKeyMaterial object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

KeyCheckValueAlgorithm

The key check value (KCV) algorithm used for calculating the KCV of the derived key.

Type: String

Valid Values: CMAC | ANSI_X9_24 | HMAC | SHA_1

Required: No

OutgoingKeyMaterial

Parameter information of the wrapping key used to wrap the transaction key in the outgoing TR31WrappedKeyBlock.

Type: OutgoingKeyMaterial object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "WrappedKey": { "KeyCheckValue": "string", "WrappedKeyMaterial": "string", "WrappedKeyMaterialFormat": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

WrappedKey

The outgoing KEK wrapped TR31WrappedKeyBlock.

Type: WrappedWorkingKey object

Errors

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The request was denied due to an invalid resource error.

ResourceId

The resource that is missing.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request was denied due to an invalid request error.

fieldList

The request was denied due to an invalid request error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: