AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . payment-cryptography-data ]

generate-as2805-kek-validation

Description

Generates a KekValidationRequest or a KekValidationResponse for node-to-node initialization between payment processing nodes 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.

To use GenerateAs2805KekValidation to generate a KEK validation request, set KekValidationType to KekValidationRequest . This operation returns both RandomKeySend (KRs) and RandomKeyReceive (KRr) as response values. The partnering node receives the KRs, uses its KEKr to decrypt it, and generates a KRr which is an inverted value of KRs. The node receiving the KRr validates it against its own KRr generated during KEK validation request outside of Amazon Web Services Payment Cryptography.

You can also use this operation to generate a KEK validation response, by setting KekValidationType to KekValidationResponse and providing the incoming KRs. This operation then calculates a KRr. To learn more about more about node-to-node initialization, see Validation of KEK in the Amazon Web Services Payment Cryptography User Guide .

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see Resource-based policies .

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 <value>]
[--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>]
[--v2-debug]

Options

--key-identifier (string)

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

--kek-validation-type (tagged union structure)

Defines whether to generate a KEK validation request or KEK validation response for 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)

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

RandomKeyMaxLength -> (string)

The maximum length of the random key to generate for a KEK validation request.

KekValidationResponse -> (structure)

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

RandomKeySend -> (string)

The random key send value received from the initiating node to generate a KEK validation response.

Shorthand Syntax:

KekValidationRequest={DeriveKeyAlgorithm=string,RandomKeyMaxLength=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",
    "RandomKeyMaxLength": "BYTES_8"|"BYTES_16"|"BYTES_24"
  },
  "KekValidationResponse": {
    "RandomKeySend": "string"
  }
}

--random-key-send-variant-mask (string)

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

KeyArn -> (string)

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

KeyCheckValue -> (string)

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

RandomKeySend -> (string)

The random key generated for sending KEK validation.

RandomKeyReceive -> (string)

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