[ aws . payment-cryptography-data ]

generate-as2805-kek-validation

Description

Establishes node-to-node initialization between payment processing nodes such as an acquirer, issuer or payment network using Australian Standard 2805 (AS2805).

During node-to-node initialization, both communicating nodes must validate that they possess the correct Key Encrypting Keys (KEKs) before proceeding with session key exchange. In AS2805, the sending KEK (KEKs) of one node corresponds to the receiving KEK (KEKr) of its partner node. Each node uses its KEK to encrypt and decrypt session keys exchanged between the nodes. A KEK can be created or imported into Amazon Web Services Payment Cryptography using either the CreateKey or ImportKey operations.

The node initiating communication can use GenerateAS2805KekValidation to generate a combined KEK validation request and KEK validation response to send to the partnering node for validation. When invoked, the API internally generates a random sending key encrypted under KEKs and provides a receiving key encrypted under KEKr as response. The initiating node sends the response returned by this API to its partner for validation.

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

Cross-account use : This operation can’t be used across different Amazon Web Services accounts.

See also: AWS API Documentation

Synopsis

  generate-as2805-kek-validation
--key-identifier <value>
--kek-validation-type <value>
--random-key-send-variant-mask <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--key-identifier (string) [required]

The keyARN of sending KEK that Amazon Web Services Payment Cryptography uses for node-to-node initialization

Constraints:

• min: 7
• max: 322
• pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+

--kek-validation-type (tagged union structure) [required]

Parameter information for generating a random key for KEK validation to perform node-to-node initialization.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: KekValidationRequest, KekValidationResponse.

KekValidationRequest -> (structure)

Parameter information for generating a KEK validation request during node-to-node initialization.

DeriveKeyAlgorithm -> (string) [required]

The key derivation algorithm to use for generating a KEK validation request.

Possible values:

• TDES_2KEY
• TDES_3KEY
• AES_128
• AES_192
• AES_256
• HMAC_SHA256
• HMAC_SHA384
• HMAC_SHA512
• HMAC_SHA224

KekValidationResponse -> (structure)

Parameter information for generating a KEK validation response during node-to-node initialization.

RandomKeySend -> (string) [required]

The random key for generating a KEK validation response.

Constraints:

• min: 32
• max: 48
• pattern: (?:[0-9a-fA-F]{32}|[0-9a-fA-F]{48})

Shorthand Syntax:

KekValidationRequest={DeriveKeyAlgorithm=string},KekValidationResponse={RandomKeySend=string}

JSON Syntax:

{
  "KekValidationRequest": {
    "DeriveKeyAlgorithm": "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"HMAC_SHA256"|"HMAC_SHA384"|"HMAC_SHA512"|"HMAC_SHA224"
  },
  "KekValidationResponse": {
    "RandomKeySend": "string"
  }
}

--random-key-send-variant-mask (string) [required]

The key variant to use for generating a random key for KEK validation during node-to-node initialization.

Possible values:

• VARIANT_MASK_82C0
• VARIANT_MASK_82

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

KeyArn -> (string)

The keyARN of sending KEK that Amazon Web Services Payment Cryptography validates for node-to-node initialization

Constraints:

• min: 70
• max: 150
• pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}

KeyCheckValue -> (string)

The key check value (KCV) of the sending KEK that Amazon Web Services Payment Cryptography validates for node-to-node initialization.

Constraints:

• min: 4
• max: 16
• pattern: [0-9a-fA-F]+

RandomKeySend -> (string)

The random key generated for sending KEK validation.

Constraints:

• min: 32
• max: 48
• pattern: (?:[0-9a-fA-F]{32}|[0-9a-fA-F]{48})

RandomKeyReceive -> (string)

The random key generated for receiving KEK validation. The initiating node sends this key to its partner node for validation.

Constraints:

• min: 32
• max: 48
• pattern: (?:[0-9a-fA-F]{32}|[0-9a-fA-F]{48})