Class: Aws::PaymentCryptographyData::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-paymentcryptographydata/client.rb

Overview

An API client for PaymentCryptographyData. To construct a client, you need to configure a :region and :credentials.

client = Aws::PaymentCryptographyData::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ‘~/.aws/config`.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from ‘aws login`.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ‘ENV` to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]

    • ‘ENV`

    • ‘ENV`

    • ‘ENV`

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ‘ENV` or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.

    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.

    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]

    • ‘ENV`

    • ‘~/.aws/config`

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from ‘aws login`.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PaymentCryptographyData::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where parameters is a Struct similar to Aws::PaymentCryptographyData::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2451
2452
2453
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2451

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2454
2455
2456
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2454

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2424

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PaymentCryptographyData')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-paymentcryptographydata'
  context[:gem_version] = '1.49.0'
  Seahorse::Client::Request.new(handlers, context)
end

#decrypt_data(params = {}) ⇒ Types::DecryptDataOutput

Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see [Decrypt data][1] in the *Amazon Web Services Payment Cryptography User Guide*.

You can use an decryption key generated within Amazon Web Services Payment Cryptography, or you can import your own decryption key by calling [ImportKey][2]. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling [GetPublicCertificate][3].

This operation also supports dynamic keys, allowing you to pass a dynamic decryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To decrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped decryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see [Using Dynamic Keys][4] in the *Amazon Web Services Payment Cryptography User Guide*.

For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.

When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

For information about valid keys for this operation, see

Understanding key attributes][5

and [Key types for specific data

operations][6] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • EncryptData

  • GetPublicCertificate][3
  • ImportKey][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/decrypt-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/use-cases-acquirers-dynamickeys.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [6]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.decrypt_data({
  key_identifier: "KeyArnOrKeyAliasType", # required
  cipher_text: "CipherTextType", # required
  decryption_attributes: { # required
    symmetric: {
      mode: "ECB", # required, accepts ECB, CBC, CFB, CFB1, CFB8, CFB64, CFB128, OFB
      initialization_vector: "InitializationVectorType",
      padding_type: "PKCS1", # accepts PKCS1, OAEP_SHA1, OAEP_SHA256, OAEP_SHA512
    },
    asymmetric: {
      padding_type: "PKCS1", # accepts PKCS1, OAEP_SHA1, OAEP_SHA256, OAEP_SHA512
    },
    dukpt: {
      key_serial_number: "HexLength16Or20Or24", # required
      mode: "ECB", # accepts ECB, CBC
      dukpt_key_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
      dukpt_key_variant: "BIDIRECTIONAL", # accepts BIDIRECTIONAL, REQUEST, RESPONSE
      initialization_vector: "InitializationVectorType",
    },
    emv: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      session_derivation_data: "SessionDerivationDataType", # required
      mode: "ECB", # accepts ECB, CBC
      initialization_vector: "InitializationVectorType",
    },
  },
  wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.plain_text #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.

    When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

  • :cipher_text (required, String) —

    The ciphertext to decrypt.

  • :decryption_attributes (required, Types::EncryptionDecryptionAttributes) —

    The encryption key type and attributes for ciphertext decryption.

  • :wrapped_key (Types::WrappedKey) —

    The WrappedKeyBlock containing the encryption key for ciphertext decryption.

Returns:

See Also:



621
622
623
624
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 621

def decrypt_data(params = {}, options = {})
  req = build_request(:decrypt_data, params)
  req.send_request(options)
end

#encrypt_data(params = {}) ⇒ Types::EncryptDataOutput

Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see [Encrypt data][1] in the *Amazon Web Services Payment Cryptography User Guide*.

You can generate an encryption key within Amazon Web Services Payment Cryptography by calling [CreateKey][2]. You can import your own encryption key by calling [ImportKey][3].

For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling [ImportKey][3].

This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see [Using Dynamic Keys][4] in the *Amazon Web Services Payment Cryptography User Guide*.

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.

When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling [CreateKey][2]. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.

For information about valid keys for this operation, see

Understanding key attributes][5

and [Key types for specific data

operations][6] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • DecryptData

  • GetPublicCertificate][7
  • ImportKey][3

  • ReEncryptData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/use-cases-acquirers-dynamickeys.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [6]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html [7]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html

Examples:

Request syntax with placeholder values


resp = client.encrypt_data({
  key_identifier: "KeyArnOrKeyAliasType", # required
  plain_text: "PlainTextType", # required
  encryption_attributes: { # required
    symmetric: {
      mode: "ECB", # required, accepts ECB, CBC, CFB, CFB1, CFB8, CFB64, CFB128, OFB
      initialization_vector: "InitializationVectorType",
      padding_type: "PKCS1", # accepts PKCS1, OAEP_SHA1, OAEP_SHA256, OAEP_SHA512
    },
    asymmetric: {
      padding_type: "PKCS1", # accepts PKCS1, OAEP_SHA1, OAEP_SHA256, OAEP_SHA512
    },
    dukpt: {
      key_serial_number: "HexLength16Or20Or24", # required
      mode: "ECB", # accepts ECB, CBC
      dukpt_key_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
      dukpt_key_variant: "BIDIRECTIONAL", # accepts BIDIRECTIONAL, REQUEST, RESPONSE
      initialization_vector: "InitializationVectorType",
    },
    emv: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      session_derivation_data: "SessionDerivationDataType", # required
      mode: "ECB", # accepts ECB, CBC
      initialization_vector: "InitializationVectorType",
    },
  },
  wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.cipher_text #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

    When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

  • :plain_text (required, String) —

    The plaintext to be encrypted.

    <note markdown=“1”> For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see [Encrypt data][1] in the *Amazon Web Services Payment Cryptography User Guide*.

    </note>

    [1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html

  • :encryption_attributes (required, Types::EncryptionDecryptionAttributes) —

    The encryption key type and attributes for plaintext encryption.

  • :wrapped_key (Types::WrappedKey) —

    The WrappedKeyBlock containing the encryption key for plaintext encryption.

Returns:

See Also:



789
790
791
792
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 789

def encrypt_data(params = {}, options = {})
  req = build_request(:encrypt_data, params)
  req.send_request(options)
end

#generate_as_2805_kek_validation(params = {}) ⇒ Types::GenerateAs2805KekValidationOutput

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][1

or [ImportKey][2] 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][3

and [Key types for specific data

operations][4] in the *Amazon Web Services Payment Cryptography User Guide*.

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

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.generate_as_2805_kek_validation({
  key_identifier: "KeyArnOrKeyAliasType", # required
  kek_validation_type: { # required
    kek_validation_request: {
      derive_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
    },
    kek_validation_response: {
      random_key_send: "As2805RandomKeyMaterial", # required
    },
  },
  random_key_send_variant_mask: "VARIANT_MASK_82C0", # required, accepts VARIANT_MASK_82C0, VARIANT_MASK_82
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.random_key_send #=> String
resp.random_key_receive #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

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

  • :kek_validation_type (required, Types::As2805KekValidationType) —

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

  • :random_key_send_variant_mask (required, String) —

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

Returns:

See Also:



875
876
877
878
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 875

def generate_as_2805_kek_validation(params = {}, options = {})
  req = build_request(:generate_as_2805_kek_validation, params)
  req.send_request(options)
end

#generate_card_validation_data(params = {}) ⇒ Types::GenerateCardValidationDataOutput

Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC). For more information, see

Generate card data][1

in the *Amazon Web Services Payment

Cryptography User Guide*.

This operation generates a CVV or CSC value that is printed on a payment credit or debit card during card production. The CVV or CSC, PAN (Primary Account Number) and expiration date of the card are required to check its validity during transaction processing. To begin this operation, a CVK (Card Verification Key) encryption key is required. You can use [CreateKey][2] or [ImportKey][3] to establish a CVK within Amazon Web Services Payment Cryptography. The KeyModesOfUse should be set to Generate and Verify for a CVK encryption key.

For information about valid keys for this operation, see

Understanding key attributes][4

and [Key types for specific data

operations][5] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • ImportKey][3

  • VerifyCardValidationData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.generate_card_validation_data({
  key_identifier: "KeyArnOrKeyAliasType", # required
  primary_account_number: "PrimaryAccountNumberType", # required
  generation_attributes: { # required
    amex_card_security_code_version_1: {
      card_expiry_date: "CardExpiryDateType", # required
    },
    amex_card_security_code_version_2: {
      card_expiry_date: "CardExpiryDateType", # required
      service_code: "ServiceCodeType", # required
    },
    card_verification_value_1: {
      card_expiry_date: "CardExpiryDateType", # required
      service_code: "ServiceCodeType", # required
    },
    card_verification_value_2: {
      card_expiry_date: "CardExpiryDateType", # required
    },
    card_holder_verification_value: {
      unpredictable_number: "HexLengthBetween2And8", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
    },
    dynamic_card_verification_code: {
      unpredictable_number: "HexLengthBetween2And8", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
      track_data: "TrackDataType", # required
    },
    dynamic_card_verification_value: {
      pan_sequence_number: "NumberLengthEquals2", # required
      card_expiry_date: "CardExpiryDateType", # required
      service_code: "ServiceCodeType", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
    },
  },
  validation_data_length: 1,
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.validation_data #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.

  • :primary_account_number (required, String) —

    The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.

  • :generation_attributes (required, Types::CardGenerationAttributes) —

    The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.

  • :validation_data_length (Integer) —

    The length of the CVV or CSC to be generated. The default value is 3.

Returns:

See Also:



991
992
993
994
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 991

def generate_card_validation_data(params = {}, options = {})
  req = build_request(:generate_card_validation_data, params)
  req.send_request(options)
end

#generate_mac(params = {}) ⇒ Types::GenerateMacOutput

Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.

You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.

You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and the key must have KeyModesOfUse set to Generate.

For information about valid keys for this operation, see

Understanding key attributes][1

and [Key types for specific data

operations][2] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • VerifyMac

^

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.generate_mac({
  key_identifier: "KeyArnOrKeyAliasType", # required
  message_data: "MessageDataType", # required
  generation_attributes: { # required
    algorithm: "ISO9797_ALGORITHM1", # accepts ISO9797_ALGORITHM1, ISO9797_ALGORITHM3, CMAC, HMAC, HMAC_SHA224, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, AS2805_4_1
    emv_mac: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      session_key_derivation_mode: "EMV_COMMON_SESSION_KEY", # required, accepts EMV_COMMON_SESSION_KEY, EMV2000, AMEX, MASTERCARD_SESSION_KEY, VISA
      session_key_derivation_value: { # required
        application_cryptogram: "ApplicationCryptogramType",
        application_transaction_counter: "HexLengthEquals4",
      },
    },
    dukpt_iso_9797_algorithm_1: {
      key_serial_number: "HexLength16Or20Or24", # required
      dukpt_key_variant: "BIDIRECTIONAL", # required, accepts BIDIRECTIONAL, REQUEST, RESPONSE
      dukpt_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    },
    dukpt_iso_9797_algorithm_3: {
      key_serial_number: "HexLength16Or20Or24", # required
      dukpt_key_variant: "BIDIRECTIONAL", # required, accepts BIDIRECTIONAL, REQUEST, RESPONSE
      dukpt_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    },
    dukpt_cmac: {
      key_serial_number: "HexLength16Or20Or24", # required
      dukpt_key_variant: "BIDIRECTIONAL", # required, accepts BIDIRECTIONAL, REQUEST, RESPONSE
      dukpt_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    },
  },
  mac_length: 1,
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.mac #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the MAC generation encryption key.

  • :message_data (required, String) —

    The data for which a MAC is under generation. This value must be hexBinary.

  • :generation_attributes (required, Types::MacAttributes) —

    The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.

  • :mac_length (Integer) —

    The length of a MAC under generation.

Returns:

See Also:



1098
1099
1100
1101
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 1098

def generate_mac(params = {}, options = {})
  req = build_request(:generate_mac, params)
  req.send_request(options)
end

#generate_mac_emv_pin_change(params = {}) ⇒ Types::GenerateMacEmvPinChangeOutput

Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM).

This operation generates an authenticated issuer script response by appending the incoming message data (APDU command) with the target encrypted PIN block in ISO2 format. The command structure and method to send the issuer script update to the card is not defined by this operation and is typically determined by the applicable payment card scheme.

The primary inputs to this operation include the incoming new encrypted pinblock, PIN encryption key (PEK), issuer master key (IMK), primary account number (PAN), and the payment card derivation method.

The operation uses two issuer master keys - secure messaging for confidentiality (IMK-SMC) and secure messaging for integrity (IMK-SMI). The SMC key is used to internally derive a key to secure the pin, while SMI key is used to internally derive a key to authenticate the script reponse as per the [EMV 4.4 - Book 2 - Security and Key Management][1] specification.

This operation supports Amex, EMV2000, EMVCommon, Mastercard and Visa derivation methods, each requiring specific input parameters. Users must follow the specific derivation method and input parameters defined by the respective payment card scheme.

<note markdown=“1”> Use GenerateMac operation when sending a script update to an EMV card that does not involve PIN change. When assigning IAM permissions, it is important to understand that EncryptData using EMV keys and GenerateMac perform similar functions to this command.

</note>

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

**Related operations:**

  • EncryptData

  • GenerateMac

[1]: www.emvco.com/specifications/

Examples:

Request syntax with placeholder values


resp = client.generate_mac_emv_pin_change({
  new_pin_pek_identifier: "KeyArnOrKeyAliasType", # required
  new_encrypted_pin_block: "PinBlockLengthEquals16", # required
  pin_block_format: "ISO_FORMAT_0", # required, accepts ISO_FORMAT_0, ISO_FORMAT_1, ISO_FORMAT_3
  secure_messaging_integrity_key_identifier: "KeyArnOrKeyAliasType", # required
  secure_messaging_confidentiality_key_identifier: "KeyArnOrKeyAliasType", # required
  message_data: "CommandMessageDataType", # required
  derivation_method_attributes: { # required
    emv_common: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_cryptogram: "ApplicationCryptogramType", # required
      mode: "ECB", # required, accepts ECB, CBC
      pin_block_padding_type: "NO_PADDING", # required, accepts NO_PADDING, ISO_IEC_7816_4
      pin_block_length_position: "NONE", # required, accepts NONE, FRONT_OF_PIN_BLOCK
    },
    amex: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthEquals4", # required
      authorization_request_key_identifier: "KeyArnOrKeyAliasType", # required
      current_pin_attributes: {
        current_pin_pek_identifier: "KeyArnOrKeyAliasType", # required
        current_encrypted_pin_block: "PinBlockLengthEquals16", # required
      },
    },
    visa: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthEquals4", # required
      authorization_request_key_identifier: "KeyArnOrKeyAliasType", # required
      current_pin_attributes: {
        current_pin_pek_identifier: "KeyArnOrKeyAliasType", # required
        current_encrypted_pin_block: "PinBlockLengthEquals16", # required
      },
    },
    emv_2000: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthEquals4", # required
    },
    mastercard: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_cryptogram: "ApplicationCryptogramType", # required
    },
  },
})

Response structure


resp.new_pin_pek_arn #=> String
resp.secure_messaging_integrity_key_arn #=> String
resp.secure_messaging_confidentiality_key_arn #=> String
resp.mac #=> String
resp.encrypted_pin_block #=> String
resp.new_pin_pek_key_check_value #=> String
resp.secure_messaging_integrity_key_check_value #=> String
resp.secure_messaging_confidentiality_key_check_value #=> String
resp.visa_amex_derivation_outputs.authorization_request_key_arn #=> String
resp.visa_amex_derivation_outputs.authorization_request_key_check_value #=> String
resp.visa_amex_derivation_outputs.current_pin_pek_arn #=> String
resp.visa_amex_derivation_outputs.current_pin_pek_key_check_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :new_pin_pek_identifier (required, String) —

    The keyARN of the PEK protecting the incoming new encrypted PIN block.

  • :new_encrypted_pin_block (required, String) —

    The incoming new encrypted PIN block data for offline pin change on an EMV card.

  • :pin_block_format (required, String) —

    The PIN encoding format of the incoming new encrypted PIN block as specified in ISO 9564.

  • :secure_messaging_integrity_key_identifier (required, String) —

    The keyARN of the issuer master key (IMK-SMI) used to authenticate the issuer script response.

  • :secure_messaging_confidentiality_key_identifier (required, String) —

    The keyARN of the issuer master key (IMK-SMC) used to protect the PIN block data in the issuer script response.

  • :message_data (required, String) —

    The message data is the APDU command from the card reader or terminal. The target encrypted PIN block, after translation to ISO2 format, is appended to this message data to generate an issuer script response.

  • :derivation_method_attributes (required, Types::DerivationMethodAttributes) —

    The attributes and data values to derive payment card specific confidentiality and integrity keys.

Returns:

See Also:



1265
1266
1267
1268
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 1265

def generate_mac_emv_pin_change(params = {}, options = {})
  req = build_request(:generate_mac_emv_pin_change, params)
  req.send_request(options)
end

#generate_pin_data(params = {}) ⇒ Types::GeneratePinDataOutput

Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see [Generate PIN data][1] in the *Amazon Web Services Payment Cryptography User Guide*.

PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation.

Using ECDH key exchange, you can receive cardholder selectable PINs into Amazon Web Services Payment Cryptography. The ECDH derived key protects the incoming PIN block. You can also use it for reveal PIN, wherein the generated PIN block is protected by the ECDH derived key before transmission from Amazon Web Services Payment Cryptography. For more information on establishing ECDH derived keys, see the

Generating keys][2

in the *Amazon Web Services Payment Cryptography

User Guide*.

For information about valid keys for this operation, see

Understanding key attributes][3

and [Key types for specific data

operations][4] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • GenerateCardValidationData

  • TranslatePinData

  • VerifyPinData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-pin-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/create-keys.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.generate_pin_data({
  generation_key_identifier: "KeyArnOrKeyAliasType", # required
  encryption_key_identifier: "KeyArnOrKeyAliasType", # required
  generation_attributes: { # required
    visa_pin: {
      pin_verification_key_index: 1, # required
    },
    visa_pin_verification_value: {
      encrypted_pin_block: "EncryptedPinBlockType", # required
      pin_verification_key_index: 1, # required
    },
    ibm_3624_pin_offset: {
      encrypted_pin_block: "EncryptedPinBlockType", # required
      decimalization_table: "DecimalizationTableType", # required
      pin_validation_data_pad_character: "HexLengthEquals1", # required
      pin_validation_data: "PinValidationDataType", # required
    },
    ibm_3624_natural_pin: {
      decimalization_table: "DecimalizationTableType", # required
      pin_validation_data_pad_character: "HexLengthEquals1", # required
      pin_validation_data: "PinValidationDataType", # required
    },
    ibm_3624_random_pin: {
      decimalization_table: "DecimalizationTableType", # required
      pin_validation_data_pad_character: "HexLengthEquals1", # required
      pin_validation_data: "PinValidationDataType", # required
    },
    ibm_3624_pin_from_offset: {
      decimalization_table: "DecimalizationTableType", # required
      pin_validation_data_pad_character: "HexLengthEquals1", # required
      pin_validation_data: "PinValidationDataType", # required
      pin_offset: "PinOffsetType", # required
    },
  },
  pin_data_length: 1,
  primary_account_number: "PrimaryAccountNumberType",
  pin_block_format: "ISO_FORMAT_0", # required, accepts ISO_FORMAT_0, ISO_FORMAT_1, ISO_FORMAT_3, ISO_FORMAT_4
  encryption_wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
})

Response structure


resp.generation_key_arn #=> String
resp.generation_key_check_value #=> String
resp.encryption_key_arn #=> String
resp.encryption_key_check_value #=> String
resp.encrypted_pin_block #=> String
resp.pin_data.pin_offset #=> String
resp.pin_data.verification_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :generation_key_identifier (required, String) —

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.

  • :encryption_key_identifier (required, String) —

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block. For ECDH, it is the keyARN of the asymmetric ECC key.

  • :generation_attributes (required, Types::PinGenerationAttributes) —

    The attributes and values to use for PIN, PVV, or PIN Offset generation.

  • :pin_data_length (Integer) —

    The length of PIN under generation.

  • :primary_account_number (String) —

    The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.

  • :pin_block_format (required, String) —

    The PIN encoding format for pin data generation as specified in ISO

    1. Amazon Web Services Payment Cryptography supports

    ISO_Format_0, ISO_Format_3 and ISO_Format_4.

    The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

    The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.

    The ISO_Format_4 PIN block format is the only one supporting AES encryption.

  • :encryption_wrapped_key (Types::WrappedKey) —

    Parameter information of a WrappedKeyBlock for encryption key exchange.

Returns:

See Also:



1432
1433
1434
1435
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 1432

def generate_pin_data(params = {}, options = {})
  req = build_request(:generate_pin_data, params)
  req.send_request(options)
end

#re_encrypt_data(params = {}) ⇒ Types::ReEncryptDataOutput

Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.

You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling [CreateKey][1] or import your own encryption key by calling [ImportKey][2]. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt.

This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To re-encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see [Using Dynamic Keys][3] in the *Amazon Web Services Payment Cryptography User Guide*.

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling [CreateKey][1].

For information about valid keys for this operation, see

Understanding key attributes][4

and [Key types for specific data

operations][5] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • DecryptData

  • EncryptData

  • GetPublicCertificate][6
  • ImportKey][2

[1]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/use-cases-acquirers-dynamickeys.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html [6]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html

Examples:

Request syntax with placeholder values


resp = client.re_encrypt_data({
  incoming_key_identifier: "KeyArnOrKeyAliasType", # required
  outgoing_key_identifier: "KeyArnOrKeyAliasType", # required
  cipher_text: "CipherTextType", # required
  incoming_encryption_attributes: { # required
    symmetric: {
      mode: "ECB", # required, accepts ECB, CBC, CFB, CFB1, CFB8, CFB64, CFB128, OFB
      initialization_vector: "InitializationVectorType",
      padding_type: "PKCS1", # accepts PKCS1, OAEP_SHA1, OAEP_SHA256, OAEP_SHA512
    },
    dukpt: {
      key_serial_number: "HexLength16Or20Or24", # required
      mode: "ECB", # accepts ECB, CBC
      dukpt_key_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
      dukpt_key_variant: "BIDIRECTIONAL", # accepts BIDIRECTIONAL, REQUEST, RESPONSE
      initialization_vector: "InitializationVectorType",
    },
  },
  outgoing_encryption_attributes: { # required
    symmetric: {
      mode: "ECB", # required, accepts ECB, CBC, CFB, CFB1, CFB8, CFB64, CFB128, OFB
      initialization_vector: "InitializationVectorType",
      padding_type: "PKCS1", # accepts PKCS1, OAEP_SHA1, OAEP_SHA256, OAEP_SHA512
    },
    dukpt: {
      key_serial_number: "HexLength16Or20Or24", # required
      mode: "ECB", # accepts ECB, CBC
      dukpt_key_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
      dukpt_key_variant: "BIDIRECTIONAL", # accepts BIDIRECTIONAL, REQUEST, RESPONSE
      initialization_vector: "InitializationVectorType",
    },
  },
  incoming_wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
  outgoing_wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.cipher_text #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :incoming_key_identifier (required, String) —

    The keyARN of the encryption key of incoming ciphertext data.

    When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

  • :outgoing_key_identifier (required, String) —

    The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

  • :cipher_text (required, String) —

    Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.

  • :incoming_encryption_attributes (required, Types::ReEncryptionAttributes) —

    The attributes and values for incoming ciphertext.

  • :outgoing_encryption_attributes (required, Types::ReEncryptionAttributes) —

    The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

  • :incoming_wrapped_key (Types::WrappedKey) —

    The WrappedKeyBlock containing the encryption key of incoming ciphertext data.

  • :outgoing_wrapped_key (Types::WrappedKey) —

    The WrappedKeyBlock containing the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

Returns:

See Also:



1600
1601
1602
1603
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 1600

def re_encrypt_data(params = {}, options = {})
  req = build_request(:re_encrypt_data, params)
  req.send_request(options)
end

#translate_key_material(params = {}) ⇒ Types::TranslateKeyMaterialOutput

Translates an cryptographic key between different wrapping keys without importing the key into Amazon Web Services 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 Amazon Web Services Payment Cryptography. It translates short-lived transaction keys such as

PEK][1

generated for each transaction and wrapped with an [ECDH][2]

derived wrapping key to another [KEK][3] wrapping key.

Before using this operation, you must first request the public key certificate of the ECC key pair generated within Amazon Web Services 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][4

and [Key types for specific data

operations][5] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • CreateKey][6
  • GetPublicCertificate][7
  • ImportKey][8

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/terminology.html#terms.pek [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/terminology.html#terms.ecdh [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/terminology.html#terms.kek [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html [6]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [7]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html [8]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html

Examples:

Request syntax with placeholder values


resp = client.translate_key_material({
  incoming_key_material: { # required
    diffie_hellman_tr_31_key_block: {
      private_key_identifier: "KeyArnOrKeyAliasType", # required
      certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
      public_key_certificate: "CertificateType", # required
      derive_key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
      key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
      key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
      derivation_data: { # required
        shared_information: "SharedInformation",
      },
      wrapped_key_block: "Tr31WrappedKeyBlock", # required
    },
  },
  outgoing_key_material: { # required
    tr_31_key_block: {
      wrapping_key_identifier: "KeyArnOrKeyAliasType", # required
    },
  },
  key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
})

Response structure


resp.wrapped_key.wrapped_key_material #=> String
resp.wrapped_key.key_check_value #=> String
resp.wrapped_key.wrapped_key_material_format #=> String, one of "KEY_CRYPTOGRAM", "TR31_KEY_BLOCK", "TR34_KEY_BLOCK"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :incoming_key_material (required, Types::IncomingKeyMaterial) —

    Parameter information of the TR31WrappedKeyBlock containing the transaction key.

  • :outgoing_key_material (required, Types::OutgoingKeyMaterial) —

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

  • :key_check_value_algorithm (String) —

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

Returns:

See Also:



1704
1705
1706
1707
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 1704

def translate_key_material(params = {}, options = {})
  req = build_request(:translate_key_material, params)
  req.send_request(options)
end

#translate_pin_data(params = {}) ⇒ Types::TranslatePinDataOutput

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see [Translate PIN data][1] in the *Amazon Web Services Payment Cryptography User Guide*.

PIN block translation involves changing a PIN block from one encryption key to another and optionally change its format. PIN block translation occurs entirely within the HSM boundary and PIN data never enters or leaves Amazon Web Services Payment Cryptography in clear text. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK.

Amazon Web Services Payment Cryptography also supports use of dynamic keys and ECDH (Elliptic Curve Diffie-Hellman) based key exchange for this operation.

Dynamic keys allow you to pass a PEK as a TR-31 WrappedKeyBlock. They can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To translate PIN block using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped PEK. The incoming wrapped key shall have a key purpose of P0 with a mode of use of B or D. For more information, see [Using Dynamic Keys][2] in the *Amazon Web Services Payment Cryptography User Guide*.

Using ECDH key exchange, you can receive cardholder selectable PINs into Amazon Web Services Payment Cryptography. The ECDH derived key protects the incoming PIN block, which is translated to a PEK encrypted PIN block for use within the service. You can also use ECDH for reveal PIN, wherein the service translates the PIN block from PEK to a ECDH derived encryption key. For more information on establishing ECDH derived keys, see the [Creating keys][3] in the *Amazon Web Services Payment Cryptography User Guide*.

The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.

For information about valid keys for this operation, see

Understanding key attributes][4

and [Key types for specific data

operations][5] in the *Amazon Web Services Payment Cryptography User Guide*.

<note markdown=“1”> Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

</note>

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

**Related operations:**

  • GeneratePinData

  • VerifyPinData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/translate-pin-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/use-cases-acquirers-dynamickeys.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/create-keys.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.translate_pin_data({
  incoming_key_identifier: "KeyArnOrKeyAliasType", # required
  outgoing_key_identifier: "KeyArnOrKeyAliasType", # required
  incoming_translation_attributes: { # required
    iso_format_0: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
    iso_format_1: {
    },
    iso_format_3: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
    iso_format_4: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
    as_2805_format_0: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
  },
  outgoing_translation_attributes: { # required
    iso_format_0: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
    iso_format_1: {
    },
    iso_format_3: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
    iso_format_4: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
    as_2805_format_0: {
      primary_account_number: "PrimaryAccountNumberType", # required
    },
  },
  encrypted_pin_block: "HexEvenLengthBetween16And32", # required
  incoming_dukpt_attributes: {
    key_serial_number: "HexLength16Or20Or24", # required
    dukpt_key_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    dukpt_key_variant: "BIDIRECTIONAL", # accepts BIDIRECTIONAL, REQUEST, RESPONSE
  },
  outgoing_dukpt_attributes: {
    key_serial_number: "HexLength16Or20Or24", # required
    dukpt_key_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    dukpt_key_variant: "BIDIRECTIONAL", # accepts BIDIRECTIONAL, REQUEST, RESPONSE
  },
  incoming_wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
  outgoing_wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
  incoming_as_2805_attributes: {
    system_trace_audit_number: "SystemTraceAuditNumberType", # required
    transaction_amount: "TransactionAmountType", # required
  },
})

Response structure


resp.pin_block #=> String
resp.key_arn #=> String
resp.key_check_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :incoming_key_identifier (required, String) —

    The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.

    For dynamic keys, it is the keyARN of KEK of the TR-31 wrapped PEK. For ECDH, it is the keyARN of the asymmetric ECC key.

  • :outgoing_key_identifier (required, String) —

    The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.

    For ECDH, it is the keyARN of the asymmetric ECC key.

  • :incoming_translation_attributes (required, Types::TranslationIsoFormats) —

    The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.

  • :outgoing_translation_attributes (required, Types::TranslationIsoFormats) —

    The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.

  • :encrypted_pin_block (required, String) —

    The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.

  • :incoming_dukpt_attributes (Types::DukptDerivationAttributes) —

    The attributes and values to use for incoming DUKPT encryption key for PIN block translation.

  • :outgoing_dukpt_attributes (Types::DukptDerivationAttributes) —

    The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.

  • :incoming_wrapped_key (Types::WrappedKey) —

    The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted.

  • :outgoing_wrapped_key (Types::WrappedKey) —

    The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.

  • :incoming_as_2805_attributes (Types::As2805PekDerivationAttributes) —

    The attributes and values to use for incoming AS2805 encryption key for PIN block translation.

Returns:

See Also:



1922
1923
1924
1925
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 1922

def translate_pin_data(params = {}, options = {})
  req = build_request(:translate_pin_data, params)
  req.send_request(options)
end

#verify_auth_request_cryptogram(params = {}) ⇒ Types::VerifyAuthRequestCryptogramOutput

Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see [Verify auth request cryptogram][1] in the *Amazon Web Services Payment Cryptography User Guide*.

ARQC generation is done outside of Amazon Web Services Payment Cryptography and is typically generated on a point of sale terminal for an EMV chip card to obtain payment authorization during transaction time. For ARQC verification, you must first import the ARQC generated outside of Amazon Web Services Payment Cryptography by calling [ImportKey][2]. This operation uses the imported ARQC and an major encryption key (DUKPT) created by calling [CreateKey][3] to either provide a boolean ARQC verification result or provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method

  1. The ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and

ARPC_METHOD_2 uses CardStatusUpdate to generate ARPC.

For information about valid keys for this operation, see

Understanding key attributes][4

and [Key types for specific data

operations][5] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • VerifyCardValidationData

  • VerifyPinData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.verifyauthrequestcryptogram.html [2]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html [3]: docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html [4]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [5]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.verify_auth_request_cryptogram({
  key_identifier: "KeyArnOrKeyAliasType", # required
  transaction_data: "TransactionDataType", # required
  auth_request_cryptogram: "AuthRequestCryptogramType", # required
  major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
  session_key_derivation_attributes: { # required
    emv_common: {
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthEquals4", # required
    },
    mastercard: {
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthEquals4", # required
      unpredictable_number: "HexLengthBetween2And8", # required
    },
    emv_2000: {
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthEquals4", # required
    },
    amex: {
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
    },
    visa: {
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
    },
  },
  auth_response_attributes: {
    arpc_method_1: {
      auth_response_code: "HexLengthEquals4", # required
    },
    arpc_method_2: {
      card_status_update: "HexLengthEquals8", # required
      proprietary_authentication_data: "ProprietaryAuthenticationDataType",
    },
  },
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String
resp.auth_response_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.

  • :transaction_data (required, String) —

    The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.

  • :auth_request_cryptogram (required, String) —

    The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.

  • :major_key_derivation_mode (required, String) —

    The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.

  • :session_key_derivation_attributes (required, Types::SessionKeyDerivation) —

    The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.

  • :auth_response_attributes (Types::CryptogramAuthResponse) —

    The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.

Returns:

See Also:



2057
2058
2059
2060
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2057

def verify_auth_request_cryptogram(params = {}, options = {})
  req = build_request(:verify_auth_request_cryptogram, params)
  req.send_request(options)
end

#verify_card_validation_data(params = {}) ⇒ Types::VerifyCardValidationDataOutput

Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC). For more information, see

Verify card data][1

in the *Amazon Web Services Payment Cryptography

User Guide*.

This operation validates the CVV or CSC codes that is printed on a payment credit or debit card during card payment transaction. The input values are typically provided as part of an inbound transaction to an issuer or supporting platform partner. Amazon Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) and expiration date of the card to check its validity during transaction processing. In this operation, the CVK (Card Verification Key) encryption key for use with card data verification is same as the one in used for GenerateCardValidationData.

For information about valid keys for this operation, see

Understanding key attributes][2

and [Key types for specific data

operations][3] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • GenerateCardValidationData

  • VerifyAuthRequestCryptogram

  • VerifyPinData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-card-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.verify_card_validation_data({
  key_identifier: "KeyArnOrKeyAliasType", # required
  primary_account_number: "PrimaryAccountNumberType", # required
  verification_attributes: { # required
    amex_card_security_code_version_1: {
      card_expiry_date: "CardExpiryDateType", # required
    },
    amex_card_security_code_version_2: {
      card_expiry_date: "CardExpiryDateType", # required
      service_code: "ServiceCodeType", # required
    },
    card_verification_value_1: {
      card_expiry_date: "CardExpiryDateType", # required
      service_code: "ServiceCodeType", # required
    },
    card_verification_value_2: {
      card_expiry_date: "CardExpiryDateType", # required
    },
    card_holder_verification_value: {
      unpredictable_number: "HexLengthBetween2And8", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
    },
    dynamic_card_verification_code: {
      unpredictable_number: "HexLengthBetween2And8", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
      track_data: "TrackDataType", # required
    },
    dynamic_card_verification_value: {
      pan_sequence_number: "NumberLengthEquals2", # required
      card_expiry_date: "CardExpiryDateType", # required
      service_code: "ServiceCodeType", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
    },
    discover_dynamic_card_verification_code: {
      card_expiry_date: "CardExpiryDateType", # required
      unpredictable_number: "HexLengthBetween2And8", # required
      application_transaction_counter: "HexLengthBetween2And4", # required
    },
  },
  validation_data: "ValidationDataType", # required
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.

  • :primary_account_number (required, String) —

    The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.

  • :verification_attributes (required, Types::CardVerificationAttributes) —

    The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.

  • :validation_data (required, String) —

    The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.

Returns:

See Also:



2177
2178
2179
2180
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2177

def verify_card_validation_data(params = {}, options = {})
  req = build_request(:verify_card_validation_data, params)
  req.send_request(options)
end

#verify_mac(params = {}) ⇒ Types::VerifyMacOutput

Verifies a Message Authentication Code (MAC).

You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.

For information about valid keys for this operation, see

Understanding key attributes][1

and [Key types for specific data

operations][2] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • GenerateMac

^

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.verify_mac({
  key_identifier: "KeyArnOrKeyAliasType", # required
  message_data: "MessageDataType", # required
  mac: "MacType", # required
  verification_attributes: { # required
    algorithm: "ISO9797_ALGORITHM1", # accepts ISO9797_ALGORITHM1, ISO9797_ALGORITHM3, CMAC, HMAC, HMAC_SHA224, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, AS2805_4_1
    emv_mac: {
      major_key_derivation_mode: "EMV_OPTION_A", # required, accepts EMV_OPTION_A, EMV_OPTION_B
      primary_account_number: "PrimaryAccountNumberType", # required
      pan_sequence_number: "NumberLengthEquals2", # required
      session_key_derivation_mode: "EMV_COMMON_SESSION_KEY", # required, accepts EMV_COMMON_SESSION_KEY, EMV2000, AMEX, MASTERCARD_SESSION_KEY, VISA
      session_key_derivation_value: { # required
        application_cryptogram: "ApplicationCryptogramType",
        application_transaction_counter: "HexLengthEquals4",
      },
    },
    dukpt_iso_9797_algorithm_1: {
      key_serial_number: "HexLength16Or20Or24", # required
      dukpt_key_variant: "BIDIRECTIONAL", # required, accepts BIDIRECTIONAL, REQUEST, RESPONSE
      dukpt_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    },
    dukpt_iso_9797_algorithm_3: {
      key_serial_number: "HexLength16Or20Or24", # required
      dukpt_key_variant: "BIDIRECTIONAL", # required, accepts BIDIRECTIONAL, REQUEST, RESPONSE
      dukpt_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    },
    dukpt_cmac: {
      key_serial_number: "HexLength16Or20Or24", # required
      dukpt_key_variant: "BIDIRECTIONAL", # required, accepts BIDIRECTIONAL, REQUEST, RESPONSE
      dukpt_derivation_type: "TDES_2KEY", # accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
    },
  },
  mac_length: 1,
})

Response structure


resp.key_arn #=> String
resp.key_check_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :key_identifier (required, String) —

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.

  • :message_data (required, String) —

    The data on for which MAC is under verification. This value must be hexBinary.

  • :mac (required, String) —

    The MAC being verified.

  • :verification_attributes (required, Types::MacAttributes) —

    The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.

  • :mac_length (Integer) —

    The length of the MAC.

Returns:

See Also:



2279
2280
2281
2282
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2279

def verify_mac(params = {}, options = {})
  req = build_request(:verify_mac, params)
  req.send_request(options)
end

#verify_pin_data(params = {}) ⇒ Types::VerifyPinDataOutput

Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see [Verify PIN data][1] in the *Amazon Web Services Payment Cryptography User Guide*.

This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.

For information about valid keys for this operation, see

Understanding key attributes][2

and [Key types for specific data

operations][3] in the *Amazon Web Services Payment Cryptography User Guide*.

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

**Related operations:**

  • GeneratePinData

  • TranslatePinData

[1]: docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html [2]: docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html [3]: docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html

Examples:

Request syntax with placeholder values


resp = client.verify_pin_data({
  verification_key_identifier: "KeyArnOrKeyAliasType", # required
  encryption_key_identifier: "KeyArnOrKeyAliasType", # required
  verification_attributes: { # required
    visa_pin: {
      pin_verification_key_index: 1, # required
      verification_value: "VerificationValueType", # required
    },
    ibm_3624_pin: {
      decimalization_table: "DecimalizationTableType", # required
      pin_validation_data_pad_character: "HexLengthEquals1", # required
      pin_validation_data: "PinValidationDataType", # required
      pin_offset: "PinOffsetType", # required
    },
  },
  encrypted_pin_block: "EncryptedPinBlockType", # required
  primary_account_number: "PrimaryAccountNumberType",
  pin_block_format: "ISO_FORMAT_0", # required, accepts ISO_FORMAT_0, ISO_FORMAT_1, ISO_FORMAT_3, ISO_FORMAT_4
  pin_data_length: 1,
  dukpt_attributes: {
    key_serial_number: "HexLength16Or20Or24", # required
    dukpt_derivation_type: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256
  },
  encryption_wrapped_key: {
    wrapped_key_material: { # required
      tr_31_key_block: "Tr31WrappedKeyBlock",
      diffie_hellman_symmetric_key: {
        certificate_authority_public_key_identifier: "KeyArnOrKeyAliasType", # required
        public_key_certificate: "CertificateType", # required
        key_algorithm: "TDES_2KEY", # required, accepts TDES_2KEY, TDES_3KEY, AES_128, AES_192, AES_256, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_SHA224
        key_derivation_function: "NIST_SP800", # required, accepts NIST_SP800, ANSI_X963
        key_derivation_hash_algorithm: "SHA_256", # required, accepts SHA_256, SHA_384, SHA_512
        shared_information: "SharedInformation", # required
      },
    },
    key_check_value_algorithm: "CMAC", # accepts CMAC, ANSI_X9_24, HMAC, SHA_1
  },
})

Response structure


resp.verification_key_arn #=> String
resp.verification_key_check_value #=> String
resp.encryption_key_arn #=> String
resp.encryption_key_check_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :verification_key_identifier (required, String) —

    The keyARN of the PIN verification key.

  • :encryption_key_identifier (required, String) —

    The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.

  • :verification_attributes (required, Types::PinVerificationAttributes) —

    The attributes and values for PIN data verification.

  • :encrypted_pin_block (required, String) —

    The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.

  • :primary_account_number (String) —

    The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.

  • :pin_block_format (required, String) —

    The PIN encoding format for pin data generation as specified in ISO

    1. Amazon Web Services Payment Cryptography supports ISO_Format_0

    and ISO_Format_3.

    The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

    The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.

  • :pin_data_length (Integer) —

    The length of PIN being verified.

  • :dukpt_attributes (Types::DukptAttributes) —

    The attributes and values for the DUKPT encrypted PIN block data.

  • :encryption_wrapped_key (Types::WrappedKey) —

    Parameter information of a WrappedKeyBlock for encryption key exchange.

Returns:

See Also:



2415
2416
2417
2418
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2415

def verify_pin_data(params = {}, options = {})
  req = build_request(:verify_pin_data, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2444
2445
2446
 
# File 'lib/aws-sdk-paymentcryptographydata/client.rb', line 2444

def waiter_names
  []
end