aws-sdk-paymentcryptographydata 1.14.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-paymentcryptographydata/client.rb +352 -280
- data/lib/aws-sdk-paymentcryptographydata/client_api.rb +125 -104
- data/lib/aws-sdk-paymentcryptographydata/errors.rb +8 -8
- data/lib/aws-sdk-paymentcryptographydata/types.rb +582 -477
- data/lib/aws-sdk-paymentcryptographydata/waiters.rb +15 -0
- data/lib/aws-sdk-paymentcryptographydata.rb +2 -1
- data/sig/client.rbs +233 -197
- data/sig/errors.rbs +2 -2
- data/sig/types.rbs +131 -108
- metadata +5 -4
@@ -89,11 +89,6 @@ module Aws::PaymentCryptographyData
|
|
89
89
|
# Code (CSC2) for an AMEX payment card.
|
90
90
|
# @return [Types::AmexCardSecurityCodeVersion2]
|
91
91
|
#
|
92
|
-
# @!attribute [rw] card_holder_verification_value
|
93
|
-
# Card data parameters that are required to generate a cardholder
|
94
|
-
# verification value for the payment card.
|
95
|
-
# @return [Types::CardHolderVerificationValue]
|
96
|
-
#
|
97
92
|
# @!attribute [rw] card_verification_value_1
|
98
93
|
# Card data parameters that are required to generate Card Verification
|
99
94
|
# Value (CVV) for the payment card.
|
@@ -104,6 +99,11 @@ module Aws::PaymentCryptographyData
|
|
104
99
|
# Value (CVV2) for the payment card.
|
105
100
|
# @return [Types::CardVerificationValue2]
|
106
101
|
#
|
102
|
+
# @!attribute [rw] card_holder_verification_value
|
103
|
+
# Card data parameters that are required to generate a cardholder
|
104
|
+
# verification value for the payment card.
|
105
|
+
# @return [Types::CardHolderVerificationValue]
|
106
|
+
#
|
107
107
|
# @!attribute [rw] dynamic_card_verification_code
|
108
108
|
# Card data parameters that are required to generate CDynamic Card
|
109
109
|
# Verification Code (dCVC) for the payment card.
|
@@ -119,9 +119,9 @@ module Aws::PaymentCryptographyData
|
|
119
119
|
class CardGenerationAttributes < Struct.new(
|
120
120
|
:amex_card_security_code_version_1,
|
121
121
|
:amex_card_security_code_version_2,
|
122
|
-
:card_holder_verification_value,
|
123
122
|
:card_verification_value_1,
|
124
123
|
:card_verification_value_2,
|
124
|
+
:card_holder_verification_value,
|
125
125
|
:dynamic_card_verification_code,
|
126
126
|
:dynamic_card_verification_value,
|
127
127
|
:unknown)
|
@@ -131,9 +131,9 @@ module Aws::PaymentCryptographyData
|
|
131
131
|
|
132
132
|
class AmexCardSecurityCodeVersion1 < CardGenerationAttributes; end
|
133
133
|
class AmexCardSecurityCodeVersion2 < CardGenerationAttributes; end
|
134
|
-
class CardHolderVerificationValue < CardGenerationAttributes; end
|
135
134
|
class CardVerificationValue1 < CardGenerationAttributes; end
|
136
135
|
class CardVerificationValue2 < CardGenerationAttributes; end
|
136
|
+
class CardHolderVerificationValue < CardGenerationAttributes; end
|
137
137
|
class DynamicCardVerificationCode < CardGenerationAttributes; end
|
138
138
|
class DynamicCardVerificationValue < CardGenerationAttributes; end
|
139
139
|
class Unknown < CardGenerationAttributes; end
|
@@ -142,9 +142,8 @@ module Aws::PaymentCryptographyData
|
|
142
142
|
# Card data parameters that are required to generate a cardholder
|
143
143
|
# verification value for the payment card.
|
144
144
|
#
|
145
|
-
# @!attribute [rw]
|
146
|
-
#
|
147
|
-
# terminal.
|
145
|
+
# @!attribute [rw] unpredictable_number
|
146
|
+
# A random number generated by the issuer.
|
148
147
|
# @return [String]
|
149
148
|
#
|
150
149
|
# @!attribute [rw] pan_sequence_number
|
@@ -152,16 +151,17 @@ module Aws::PaymentCryptographyData
|
|
152
151
|
# same Primary Account Number (PAN).
|
153
152
|
# @return [String]
|
154
153
|
#
|
155
|
-
# @!attribute [rw]
|
156
|
-
#
|
154
|
+
# @!attribute [rw] application_transaction_counter
|
155
|
+
# The transaction counter value that comes from a point of sale
|
156
|
+
# terminal.
|
157
157
|
# @return [String]
|
158
158
|
#
|
159
159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/CardHolderVerificationValue AWS API Documentation
|
160
160
|
#
|
161
161
|
class CardHolderVerificationValue < Struct.new(
|
162
|
-
:
|
162
|
+
:unpredictable_number,
|
163
163
|
:pan_sequence_number,
|
164
|
-
:
|
164
|
+
:application_transaction_counter)
|
165
165
|
SENSITIVE = []
|
166
166
|
include Aws::Structure
|
167
167
|
end
|
@@ -182,11 +182,6 @@ module Aws::PaymentCryptographyData
|
|
182
182
|
# Code (CSC2) for an AMEX payment card.
|
183
183
|
# @return [Types::AmexCardSecurityCodeVersion2]
|
184
184
|
#
|
185
|
-
# @!attribute [rw] card_holder_verification_value
|
186
|
-
# Card data parameters that are required to verify a cardholder
|
187
|
-
# verification value for the payment card.
|
188
|
-
# @return [Types::CardHolderVerificationValue]
|
189
|
-
#
|
190
185
|
# @!attribute [rw] card_verification_value_1
|
191
186
|
# Card data parameters that are required to verify Card Verification
|
192
187
|
# Value (CVV) for the payment card.
|
@@ -197,10 +192,10 @@ module Aws::PaymentCryptographyData
|
|
197
192
|
# Value (CVV2) for the payment card.
|
198
193
|
# @return [Types::CardVerificationValue2]
|
199
194
|
#
|
200
|
-
# @!attribute [rw]
|
201
|
-
# Card data parameters that are required to verify
|
202
|
-
#
|
203
|
-
# @return [Types::
|
195
|
+
# @!attribute [rw] card_holder_verification_value
|
196
|
+
# Card data parameters that are required to verify a cardholder
|
197
|
+
# verification value for the payment card.
|
198
|
+
# @return [Types::CardHolderVerificationValue]
|
204
199
|
#
|
205
200
|
# @!attribute [rw] dynamic_card_verification_code
|
206
201
|
# Card data parameters that are required to verify CDynamic Card
|
@@ -212,17 +207,22 @@ module Aws::PaymentCryptographyData
|
|
212
207
|
# Verification Value (dCVV) for the payment card.
|
213
208
|
# @return [Types::DynamicCardVerificationValue]
|
214
209
|
#
|
210
|
+
# @!attribute [rw] discover_dynamic_card_verification_code
|
211
|
+
# Card data parameters that are required to verify CDynamic Card
|
212
|
+
# Verification Code (dCVC) for the payment card.
|
213
|
+
# @return [Types::DiscoverDynamicCardVerificationCode]
|
214
|
+
#
|
215
215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/CardVerificationAttributes AWS API Documentation
|
216
216
|
#
|
217
217
|
class CardVerificationAttributes < Struct.new(
|
218
218
|
:amex_card_security_code_version_1,
|
219
219
|
:amex_card_security_code_version_2,
|
220
|
-
:card_holder_verification_value,
|
221
220
|
:card_verification_value_1,
|
222
221
|
:card_verification_value_2,
|
223
|
-
:
|
222
|
+
:card_holder_verification_value,
|
224
223
|
:dynamic_card_verification_code,
|
225
224
|
:dynamic_card_verification_value,
|
225
|
+
:discover_dynamic_card_verification_code,
|
226
226
|
:unknown)
|
227
227
|
SENSITIVE = []
|
228
228
|
include Aws::Structure
|
@@ -230,12 +230,12 @@ module Aws::PaymentCryptographyData
|
|
230
230
|
|
231
231
|
class AmexCardSecurityCodeVersion1 < CardVerificationAttributes; end
|
232
232
|
class AmexCardSecurityCodeVersion2 < CardVerificationAttributes; end
|
233
|
-
class CardHolderVerificationValue < CardVerificationAttributes; end
|
234
233
|
class CardVerificationValue1 < CardVerificationAttributes; end
|
235
234
|
class CardVerificationValue2 < CardVerificationAttributes; end
|
236
|
-
class
|
235
|
+
class CardHolderVerificationValue < CardVerificationAttributes; end
|
237
236
|
class DynamicCardVerificationCode < CardVerificationAttributes; end
|
238
237
|
class DynamicCardVerificationValue < CardVerificationAttributes; end
|
238
|
+
class DiscoverDynamicCardVerificationCode < CardVerificationAttributes; end
|
239
239
|
class Unknown < CardVerificationAttributes; end
|
240
240
|
end
|
241
241
|
|
@@ -345,6 +345,15 @@ module Aws::PaymentCryptographyData
|
|
345
345
|
include Aws::Structure
|
346
346
|
end
|
347
347
|
|
348
|
+
# @!attribute [rw] key_identifier
|
349
|
+
# The `keyARN` of the encryption key that Amazon Web Services Payment
|
350
|
+
# Cryptography uses for ciphertext decryption.
|
351
|
+
#
|
352
|
+
# When a WrappedKeyBlock is provided, this value will be the
|
353
|
+
# identifier to the key wrapping key. Otherwise, it is the key
|
354
|
+
# identifier used to perform the operation.
|
355
|
+
# @return [String]
|
356
|
+
#
|
348
357
|
# @!attribute [rw] cipher_text
|
349
358
|
# The ciphertext to decrypt.
|
350
359
|
# @return [String]
|
@@ -353,17 +362,18 @@ module Aws::PaymentCryptographyData
|
|
353
362
|
# The encryption key type and attributes for ciphertext decryption.
|
354
363
|
# @return [Types::EncryptionDecryptionAttributes]
|
355
364
|
#
|
356
|
-
# @!attribute [rw]
|
357
|
-
# The
|
358
|
-
#
|
359
|
-
# @return [
|
365
|
+
# @!attribute [rw] wrapped_key
|
366
|
+
# The WrappedKeyBlock containing the encryption key for ciphertext
|
367
|
+
# decryption.
|
368
|
+
# @return [Types::WrappedKey]
|
360
369
|
#
|
361
370
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DecryptDataInput AWS API Documentation
|
362
371
|
#
|
363
372
|
class DecryptDataInput < Struct.new(
|
373
|
+
:key_identifier,
|
364
374
|
:cipher_text,
|
365
375
|
:decryption_attributes,
|
366
|
-
:
|
376
|
+
:wrapped_key)
|
367
377
|
SENSITIVE = [:cipher_text]
|
368
378
|
include Aws::Structure
|
369
379
|
end
|
@@ -399,10 +409,6 @@ module Aws::PaymentCryptographyData
|
|
399
409
|
# Parameters that are required to generate or verify dCVC (Dynamic Card
|
400
410
|
# Verification Code).
|
401
411
|
#
|
402
|
-
# @!attribute [rw] application_transaction_counter
|
403
|
-
# The transaction counter value that comes from the terminal.
|
404
|
-
# @return [String]
|
405
|
-
#
|
406
412
|
# @!attribute [rw] card_expiry_date
|
407
413
|
# The expiry date of a payment card.
|
408
414
|
# @return [String]
|
@@ -411,12 +417,16 @@ module Aws::PaymentCryptographyData
|
|
411
417
|
# A random number that is generated by the issuer.
|
412
418
|
# @return [String]
|
413
419
|
#
|
420
|
+
# @!attribute [rw] application_transaction_counter
|
421
|
+
# The transaction counter value that comes from the terminal.
|
422
|
+
# @return [String]
|
423
|
+
#
|
414
424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DiscoverDynamicCardVerificationCode AWS API Documentation
|
415
425
|
#
|
416
426
|
class DiscoverDynamicCardVerificationCode < Struct.new(
|
417
|
-
:application_transaction_counter,
|
418
427
|
:card_expiry_date,
|
419
|
-
:unpredictable_number
|
428
|
+
:unpredictable_number,
|
429
|
+
:application_transaction_counter)
|
420
430
|
SENSITIVE = []
|
421
431
|
include Aws::Structure
|
422
432
|
end
|
@@ -424,13 +434,6 @@ module Aws::PaymentCryptographyData
|
|
424
434
|
# Parameters that are used for Derived Unique Key Per Transaction
|
425
435
|
# (DUKPT) derivation algorithm.
|
426
436
|
#
|
427
|
-
# @!attribute [rw] dukpt_derivation_type
|
428
|
-
# The key type derived using DUKPT from a Base Derivation Key (BDK)
|
429
|
-
# and Key Serial Number (KSN). This must be less than or equal to the
|
430
|
-
# strength of the BDK. For example, you can't use `AES_128` as a
|
431
|
-
# derivation type for a BDK of `AES_128` or `TDES_2KEY`.
|
432
|
-
# @return [String]
|
433
|
-
#
|
434
437
|
# @!attribute [rw] key_serial_number
|
435
438
|
# The unique identifier known as Key Serial Number (KSN) that comes
|
436
439
|
# from an encrypting device using DUKPT encryption method. The KSN is
|
@@ -438,17 +441,31 @@ module Aws::PaymentCryptographyData
|
|
438
441
|
# transaction counter.
|
439
442
|
# @return [String]
|
440
443
|
#
|
444
|
+
# @!attribute [rw] dukpt_derivation_type
|
445
|
+
# The key type derived using DUKPT from a Base Derivation Key (BDK)
|
446
|
+
# and Key Serial Number (KSN). This must be less than or equal to the
|
447
|
+
# strength of the BDK. For example, you can't use `AES_128` as a
|
448
|
+
# derivation type for a BDK of `AES_128` or `TDES_2KEY`.
|
449
|
+
# @return [String]
|
450
|
+
#
|
441
451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DukptAttributes AWS API Documentation
|
442
452
|
#
|
443
453
|
class DukptAttributes < Struct.new(
|
444
|
-
:
|
445
|
-
:
|
454
|
+
:key_serial_number,
|
455
|
+
:dukpt_derivation_type)
|
446
456
|
SENSITIVE = []
|
447
457
|
include Aws::Structure
|
448
458
|
end
|
449
459
|
|
450
460
|
# Parameters required for encryption or decryption of data using DUKPT.
|
451
461
|
#
|
462
|
+
# @!attribute [rw] key_serial_number
|
463
|
+
# The unique identifier known as Key Serial Number (KSN) that comes
|
464
|
+
# from an encrypting device using DUKPT encryption method. The KSN is
|
465
|
+
# derived from the encrypting device unique identifier and an internal
|
466
|
+
# transaction counter.
|
467
|
+
# @return [String]
|
468
|
+
#
|
452
469
|
# @!attribute [rw] dukpt_key_derivation_type
|
453
470
|
# The key type derived using DUKPT from a Base Derivation Key (BDK)
|
454
471
|
# and Key Serial Number (KSN). This must be less than or equal to the
|
@@ -461,25 +478,31 @@ module Aws::PaymentCryptographyData
|
|
461
478
|
# outgoing data encryption, or both.
|
462
479
|
# @return [String]
|
463
480
|
#
|
464
|
-
# @!attribute [rw] key_serial_number
|
465
|
-
# The unique identifier known as Key Serial Number (KSN) that comes
|
466
|
-
# from an encrypting device using DUKPT encryption method. The KSN is
|
467
|
-
# derived from the encrypting device unique identifier and an internal
|
468
|
-
# transaction counter.
|
469
|
-
# @return [String]
|
470
|
-
#
|
471
481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DukptDerivationAttributes AWS API Documentation
|
472
482
|
#
|
473
483
|
class DukptDerivationAttributes < Struct.new(
|
484
|
+
:key_serial_number,
|
474
485
|
:dukpt_key_derivation_type,
|
475
|
-
:dukpt_key_variant
|
476
|
-
:key_serial_number)
|
486
|
+
:dukpt_key_variant)
|
477
487
|
SENSITIVE = []
|
478
488
|
include Aws::Structure
|
479
489
|
end
|
480
490
|
|
481
491
|
# Parameters that are required to encrypt plaintext data using DUKPT.
|
482
492
|
#
|
493
|
+
# @!attribute [rw] key_serial_number
|
494
|
+
# The unique identifier known as Key Serial Number (KSN) that comes
|
495
|
+
# from an encrypting device using DUKPT encryption method. The KSN is
|
496
|
+
# derived from the encrypting device unique identifier and an internal
|
497
|
+
# transaction counter.
|
498
|
+
# @return [String]
|
499
|
+
#
|
500
|
+
# @!attribute [rw] mode
|
501
|
+
# The block cipher method to use for encryption.
|
502
|
+
#
|
503
|
+
# The default is CBC.
|
504
|
+
# @return [String]
|
505
|
+
#
|
483
506
|
# @!attribute [rw] dukpt_key_derivation_type
|
484
507
|
# The key type encrypted using DUKPT from a Base Derivation Key (BDK)
|
485
508
|
# and Key Serial Number (KSN). This must be less than or equal to the
|
@@ -497,27 +520,14 @@ module Aws::PaymentCryptographyData
|
|
497
520
|
# Amazon Web Services Payment Cryptography defaults it to zero.
|
498
521
|
# @return [String]
|
499
522
|
#
|
500
|
-
# @!attribute [rw] key_serial_number
|
501
|
-
# The unique identifier known as Key Serial Number (KSN) that comes
|
502
|
-
# from an encrypting device using DUKPT encryption method. The KSN is
|
503
|
-
# derived from the encrypting device unique identifier and an internal
|
504
|
-
# transaction counter.
|
505
|
-
# @return [String]
|
506
|
-
#
|
507
|
-
# @!attribute [rw] mode
|
508
|
-
# The block cipher method to use for encryption.
|
509
|
-
#
|
510
|
-
# The default is CBC.
|
511
|
-
# @return [String]
|
512
|
-
#
|
513
523
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DukptEncryptionAttributes AWS API Documentation
|
514
524
|
#
|
515
525
|
class DukptEncryptionAttributes < Struct.new(
|
526
|
+
:key_serial_number,
|
527
|
+
:mode,
|
516
528
|
:dukpt_key_derivation_type,
|
517
529
|
:dukpt_key_variant,
|
518
|
-
:initialization_vector
|
519
|
-
:key_serial_number,
|
520
|
-
:mode)
|
530
|
+
:initialization_vector)
|
521
531
|
SENSITIVE = [:initialization_vector]
|
522
532
|
include Aws::Structure
|
523
533
|
end
|
@@ -525,8 +535,8 @@ module Aws::PaymentCryptographyData
|
|
525
535
|
# Parameters that are required to generate or verify Dynamic Card
|
526
536
|
# Verification Value (dCVV).
|
527
537
|
#
|
528
|
-
# @!attribute [rw]
|
529
|
-
#
|
538
|
+
# @!attribute [rw] unpredictable_number
|
539
|
+
# A random number generated by the issuer.
|
530
540
|
# @return [String]
|
531
541
|
#
|
532
542
|
# @!attribute [rw] pan_sequence_number
|
@@ -534,6 +544,10 @@ module Aws::PaymentCryptographyData
|
|
534
544
|
# same Primary Account Number (PAN).
|
535
545
|
# @return [String]
|
536
546
|
#
|
547
|
+
# @!attribute [rw] application_transaction_counter
|
548
|
+
# The transaction counter value that comes from the terminal.
|
549
|
+
# @return [String]
|
550
|
+
#
|
537
551
|
# @!attribute [rw] track_data
|
538
552
|
# The data on the two tracks of magnetic cards used for financial
|
539
553
|
# transactions. This includes the cardholder name, PAN, expiration
|
@@ -541,17 +555,13 @@ module Aws::PaymentCryptographyData
|
|
541
555
|
# to validate the data received.
|
542
556
|
# @return [String]
|
543
557
|
#
|
544
|
-
# @!attribute [rw] unpredictable_number
|
545
|
-
# A random number generated by the issuer.
|
546
|
-
# @return [String]
|
547
|
-
#
|
548
558
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DynamicCardVerificationCode AWS API Documentation
|
549
559
|
#
|
550
560
|
class DynamicCardVerificationCode < Struct.new(
|
551
|
-
:
|
561
|
+
:unpredictable_number,
|
552
562
|
:pan_sequence_number,
|
553
|
-
:
|
554
|
-
:
|
563
|
+
:application_transaction_counter,
|
564
|
+
:track_data)
|
555
565
|
SENSITIVE = []
|
556
566
|
include Aws::Structure
|
557
567
|
end
|
@@ -559,49 +569,46 @@ module Aws::PaymentCryptographyData
|
|
559
569
|
# Parameters that are required to generate or verify Dynamic Card
|
560
570
|
# Verification Value (dCVV).
|
561
571
|
#
|
562
|
-
# @!attribute [rw]
|
563
|
-
#
|
572
|
+
# @!attribute [rw] pan_sequence_number
|
573
|
+
# A number that identifies and differentiates payment cards with the
|
574
|
+
# same Primary Account Number (PAN).
|
564
575
|
# @return [String]
|
565
576
|
#
|
566
577
|
# @!attribute [rw] card_expiry_date
|
567
578
|
# The expiry date of a payment card.
|
568
579
|
# @return [String]
|
569
580
|
#
|
570
|
-
# @!attribute [rw] pan_sequence_number
|
571
|
-
# A number that identifies and differentiates payment cards with the
|
572
|
-
# same Primary Account Number (PAN).
|
573
|
-
# @return [String]
|
574
|
-
#
|
575
581
|
# @!attribute [rw] service_code
|
576
582
|
# The service code of the payment card. This is different from Card
|
577
583
|
# Security Code (CSC).
|
578
584
|
# @return [String]
|
579
585
|
#
|
586
|
+
# @!attribute [rw] application_transaction_counter
|
587
|
+
# The transaction counter value that comes from the terminal.
|
588
|
+
# @return [String]
|
589
|
+
#
|
580
590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/DynamicCardVerificationValue AWS API Documentation
|
581
591
|
#
|
582
592
|
class DynamicCardVerificationValue < Struct.new(
|
583
|
-
:application_transaction_counter,
|
584
|
-
:card_expiry_date,
|
585
593
|
:pan_sequence_number,
|
586
|
-
:
|
594
|
+
:card_expiry_date,
|
595
|
+
:service_code,
|
596
|
+
:application_transaction_counter)
|
587
597
|
SENSITIVE = []
|
588
598
|
include Aws::Structure
|
589
599
|
end
|
590
600
|
|
591
601
|
# Parameters for plaintext encryption using EMV keys.
|
592
602
|
#
|
593
|
-
# @!attribute [rw] initialization_vector
|
594
|
-
# An input used to provide the intial state. If no value is provided,
|
595
|
-
# Amazon Web Services Payment Cryptography defaults it to zero.
|
596
|
-
# @return [String]
|
597
|
-
#
|
598
603
|
# @!attribute [rw] major_key_derivation_mode
|
599
604
|
# The EMV derivation mode to use for ICC master key derivation as per
|
600
605
|
# EMV version 4.3 book 2.
|
601
606
|
# @return [String]
|
602
607
|
#
|
603
|
-
# @!attribute [rw]
|
604
|
-
# The
|
608
|
+
# @!attribute [rw] primary_account_number
|
609
|
+
# The Primary Account Number (PAN), a unique identifier for a payment
|
610
|
+
# credit or debit card and associates the card to a specific account
|
611
|
+
# holder.
|
605
612
|
# @return [String]
|
606
613
|
#
|
607
614
|
# @!attribute [rw] pan_sequence_number
|
@@ -609,12 +616,6 @@ module Aws::PaymentCryptographyData
|
|
609
616
|
# same Primary Account Number (PAN).
|
610
617
|
# @return [String]
|
611
618
|
#
|
612
|
-
# @!attribute [rw] primary_account_number
|
613
|
-
# The Primary Account Number (PAN), a unique identifier for a payment
|
614
|
-
# credit or debit card and associates the card to a specific account
|
615
|
-
# holder.
|
616
|
-
# @return [String]
|
617
|
-
#
|
618
619
|
# @!attribute [rw] session_derivation_data
|
619
620
|
# The derivation value used to derive the ICC session key. It is
|
620
621
|
# typically the application transaction counter value padded with
|
@@ -622,26 +623,35 @@ module Aws::PaymentCryptographyData
|
|
622
623
|
# 4.3 book 2.
|
623
624
|
# @return [String]
|
624
625
|
#
|
626
|
+
# @!attribute [rw] mode
|
627
|
+
# The block cipher method to use for encryption.
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] initialization_vector
|
631
|
+
# An input used to provide the intial state. If no value is provided,
|
632
|
+
# Amazon Web Services Payment Cryptography defaults it to zero.
|
633
|
+
# @return [String]
|
634
|
+
#
|
625
635
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/EmvEncryptionAttributes AWS API Documentation
|
626
636
|
#
|
627
637
|
class EmvEncryptionAttributes < Struct.new(
|
628
|
-
:initialization_vector,
|
629
638
|
:major_key_derivation_mode,
|
630
|
-
:mode,
|
631
|
-
:pan_sequence_number,
|
632
639
|
:primary_account_number,
|
633
|
-
:
|
634
|
-
|
640
|
+
:pan_sequence_number,
|
641
|
+
:session_derivation_data,
|
642
|
+
:mode,
|
643
|
+
:initialization_vector)
|
644
|
+
SENSITIVE = [:primary_account_number, :initialization_vector]
|
635
645
|
include Aws::Structure
|
636
646
|
end
|
637
647
|
|
638
|
-
# @!attribute [rw] encryption_attributes
|
639
|
-
# The encryption key type and attributes for plaintext encryption.
|
640
|
-
# @return [Types::EncryptionDecryptionAttributes]
|
641
|
-
#
|
642
648
|
# @!attribute [rw] key_identifier
|
643
649
|
# The `keyARN` of the encryption key that Amazon Web Services Payment
|
644
650
|
# Cryptography uses for plaintext encryption.
|
651
|
+
#
|
652
|
+
# When a WrappedKeyBlock is provided, this value will be the
|
653
|
+
# identifier to the key wrapping key. Otherwise, it is the key
|
654
|
+
# identifier used to perform the operation.
|
645
655
|
# @return [String]
|
646
656
|
#
|
647
657
|
# @!attribute [rw] plain_text
|
@@ -661,20 +671,26 @@ module Aws::PaymentCryptographyData
|
|
661
671
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html
|
662
672
|
# @return [String]
|
663
673
|
#
|
674
|
+
# @!attribute [rw] encryption_attributes
|
675
|
+
# The encryption key type and attributes for plaintext encryption.
|
676
|
+
# @return [Types::EncryptionDecryptionAttributes]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] wrapped_key
|
679
|
+
# The WrappedKeyBlock containing the encryption key for plaintext
|
680
|
+
# encryption.
|
681
|
+
# @return [Types::WrappedKey]
|
682
|
+
#
|
664
683
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/EncryptDataInput AWS API Documentation
|
665
684
|
#
|
666
685
|
class EncryptDataInput < Struct.new(
|
667
|
-
:encryption_attributes,
|
668
686
|
:key_identifier,
|
669
|
-
:plain_text
|
687
|
+
:plain_text,
|
688
|
+
:encryption_attributes,
|
689
|
+
:wrapped_key)
|
670
690
|
SENSITIVE = [:plain_text]
|
671
691
|
include Aws::Structure
|
672
692
|
end
|
673
693
|
|
674
|
-
# @!attribute [rw] cipher_text
|
675
|
-
# The encrypted ciphertext.
|
676
|
-
# @return [String]
|
677
|
-
#
|
678
694
|
# @!attribute [rw] key_arn
|
679
695
|
# The `keyARN` of the encryption key that Amazon Web Services Payment
|
680
696
|
# Cryptography uses for plaintext encryption.
|
@@ -689,12 +705,16 @@ module Aws::PaymentCryptographyData
|
|
689
705
|
# to the CMAC specification.
|
690
706
|
# @return [String]
|
691
707
|
#
|
708
|
+
# @!attribute [rw] cipher_text
|
709
|
+
# The encrypted ciphertext.
|
710
|
+
# @return [String]
|
711
|
+
#
|
692
712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/EncryptDataOutput AWS API Documentation
|
693
713
|
#
|
694
714
|
class EncryptDataOutput < Struct.new(
|
695
|
-
:cipher_text,
|
696
715
|
:key_arn,
|
697
|
-
:key_check_value
|
716
|
+
:key_check_value,
|
717
|
+
:cipher_text)
|
698
718
|
SENSITIVE = [:cipher_text]
|
699
719
|
include Aws::Structure
|
700
720
|
end
|
@@ -704,6 +724,11 @@ module Aws::PaymentCryptographyData
|
|
704
724
|
#
|
705
725
|
# @note EncryptionDecryptionAttributes is a union - when making an API calls you must set exactly one of the members.
|
706
726
|
#
|
727
|
+
# @!attribute [rw] symmetric
|
728
|
+
# Parameters that are required to perform encryption and decryption
|
729
|
+
# using symmetric keys.
|
730
|
+
# @return [Types::SymmetricEncryptionAttributes]
|
731
|
+
#
|
707
732
|
# @!attribute [rw] asymmetric
|
708
733
|
# Parameters for plaintext encryption using asymmetric keys.
|
709
734
|
# @return [Types::AsymmetricEncryptionAttributes]
|
@@ -716,35 +741,25 @@ module Aws::PaymentCryptographyData
|
|
716
741
|
# Parameters for plaintext encryption using EMV keys.
|
717
742
|
# @return [Types::EmvEncryptionAttributes]
|
718
743
|
#
|
719
|
-
# @!attribute [rw] symmetric
|
720
|
-
# Parameters that are required to perform encryption and decryption
|
721
|
-
# using symmetric keys.
|
722
|
-
# @return [Types::SymmetricEncryptionAttributes]
|
723
|
-
#
|
724
744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/EncryptionDecryptionAttributes AWS API Documentation
|
725
745
|
#
|
726
746
|
class EncryptionDecryptionAttributes < Struct.new(
|
747
|
+
:symmetric,
|
727
748
|
:asymmetric,
|
728
749
|
:dukpt,
|
729
750
|
:emv,
|
730
|
-
:symmetric,
|
731
751
|
:unknown)
|
732
752
|
SENSITIVE = []
|
733
753
|
include Aws::Structure
|
734
754
|
include Aws::Structure::Union
|
735
755
|
|
756
|
+
class Symmetric < EncryptionDecryptionAttributes; end
|
736
757
|
class Asymmetric < EncryptionDecryptionAttributes; end
|
737
758
|
class Dukpt < EncryptionDecryptionAttributes; end
|
738
759
|
class Emv < EncryptionDecryptionAttributes; end
|
739
|
-
class Symmetric < EncryptionDecryptionAttributes; end
|
740
760
|
class Unknown < EncryptionDecryptionAttributes; end
|
741
761
|
end
|
742
762
|
|
743
|
-
# @!attribute [rw] generation_attributes
|
744
|
-
# The algorithm for generating CVV or CSC values for the card within
|
745
|
-
# Amazon Web Services Payment Cryptography.
|
746
|
-
# @return [Types::CardGenerationAttributes]
|
747
|
-
#
|
748
763
|
# @!attribute [rw] key_identifier
|
749
764
|
# The `keyARN` of the CVK encryption key that Amazon Web Services
|
750
765
|
# Payment Cryptography uses to generate card data.
|
@@ -756,6 +771,11 @@ module Aws::PaymentCryptographyData
|
|
756
771
|
# account holder.
|
757
772
|
# @return [String]
|
758
773
|
#
|
774
|
+
# @!attribute [rw] generation_attributes
|
775
|
+
# The algorithm for generating CVV or CSC values for the card within
|
776
|
+
# Amazon Web Services Payment Cryptography.
|
777
|
+
# @return [Types::CardGenerationAttributes]
|
778
|
+
#
|
759
779
|
# @!attribute [rw] validation_data_length
|
760
780
|
# The length of the CVV or CSC to be generated. The default value is
|
761
781
|
# 3.
|
@@ -764,9 +784,9 @@ module Aws::PaymentCryptographyData
|
|
764
784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/GenerateCardValidationDataInput AWS API Documentation
|
765
785
|
#
|
766
786
|
class GenerateCardValidationDataInput < Struct.new(
|
767
|
-
:generation_attributes,
|
768
787
|
:key_identifier,
|
769
788
|
:primary_account_number,
|
789
|
+
:generation_attributes,
|
770
790
|
:validation_data_length)
|
771
791
|
SENSITIVE = [:primary_account_number]
|
772
792
|
include Aws::Structure
|
@@ -801,31 +821,31 @@ module Aws::PaymentCryptographyData
|
|
801
821
|
include Aws::Structure
|
802
822
|
end
|
803
823
|
|
804
|
-
# @!attribute [rw] generation_attributes
|
805
|
-
# The attributes and data values to use for MAC generation within
|
806
|
-
# Amazon Web Services Payment Cryptography.
|
807
|
-
# @return [Types::MacAttributes]
|
808
|
-
#
|
809
824
|
# @!attribute [rw] key_identifier
|
810
825
|
# The `keyARN` of the MAC generation encryption key.
|
811
826
|
# @return [String]
|
812
827
|
#
|
813
|
-
# @!attribute [rw] mac_length
|
814
|
-
# The length of a MAC under generation.
|
815
|
-
# @return [Integer]
|
816
|
-
#
|
817
828
|
# @!attribute [rw] message_data
|
818
829
|
# The data for which a MAC is under generation. This value must be
|
819
830
|
# hexBinary.
|
820
831
|
# @return [String]
|
821
832
|
#
|
833
|
+
# @!attribute [rw] generation_attributes
|
834
|
+
# The attributes and data values to use for MAC generation within
|
835
|
+
# Amazon Web Services Payment Cryptography.
|
836
|
+
# @return [Types::MacAttributes]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] mac_length
|
839
|
+
# The length of a MAC under generation.
|
840
|
+
# @return [Integer]
|
841
|
+
#
|
822
842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/GenerateMacInput AWS API Documentation
|
823
843
|
#
|
824
844
|
class GenerateMacInput < Struct.new(
|
825
|
-
:generation_attributes,
|
826
845
|
:key_identifier,
|
827
|
-
:
|
828
|
-
:
|
846
|
+
:message_data,
|
847
|
+
:generation_attributes,
|
848
|
+
:mac_length)
|
829
849
|
SENSITIVE = [:message_data]
|
830
850
|
include Aws::Structure
|
831
851
|
end
|
@@ -859,6 +879,11 @@ module Aws::PaymentCryptographyData
|
|
859
879
|
include Aws::Structure
|
860
880
|
end
|
861
881
|
|
882
|
+
# @!attribute [rw] generation_key_identifier
|
883
|
+
# The `keyARN` of the PEK that Amazon Web Services Payment
|
884
|
+
# Cryptography uses for pin data generation.
|
885
|
+
# @return [String]
|
886
|
+
#
|
862
887
|
# @!attribute [rw] encryption_key_identifier
|
863
888
|
# The `keyARN` of the PEK that Amazon Web Services Payment
|
864
889
|
# Cryptography uses to encrypt the PIN Block.
|
@@ -869,9 +894,14 @@ module Aws::PaymentCryptographyData
|
|
869
894
|
# generation.
|
870
895
|
# @return [Types::PinGenerationAttributes]
|
871
896
|
#
|
872
|
-
# @!attribute [rw]
|
873
|
-
# The
|
874
|
-
#
|
897
|
+
# @!attribute [rw] pin_data_length
|
898
|
+
# The length of PIN under generation.
|
899
|
+
# @return [Integer]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] primary_account_number
|
902
|
+
# The Primary Account Number (PAN), a unique identifier for a payment
|
903
|
+
# credit or debit card that associates the card with a specific
|
904
|
+
# account holder.
|
875
905
|
# @return [String]
|
876
906
|
#
|
877
907
|
# @!attribute [rw] pin_block_format
|
@@ -887,42 +917,25 @@ module Aws::PaymentCryptographyData
|
|
887
917
|
# except that the fill digits are random values from 10 to 15.
|
888
918
|
# @return [String]
|
889
919
|
#
|
890
|
-
# @!attribute [rw] pin_data_length
|
891
|
-
# The length of PIN under generation.
|
892
|
-
# @return [Integer]
|
893
|
-
#
|
894
|
-
# @!attribute [rw] primary_account_number
|
895
|
-
# The Primary Account Number (PAN), a unique identifier for a payment
|
896
|
-
# credit or debit card that associates the card with a specific
|
897
|
-
# account holder.
|
898
|
-
# @return [String]
|
899
|
-
#
|
900
920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/GeneratePinDataInput AWS API Documentation
|
901
921
|
#
|
902
922
|
class GeneratePinDataInput < Struct.new(
|
923
|
+
:generation_key_identifier,
|
903
924
|
:encryption_key_identifier,
|
904
925
|
:generation_attributes,
|
905
|
-
:generation_key_identifier,
|
906
|
-
:pin_block_format,
|
907
926
|
:pin_data_length,
|
908
|
-
:primary_account_number
|
927
|
+
:primary_account_number,
|
928
|
+
:pin_block_format)
|
909
929
|
SENSITIVE = [:primary_account_number]
|
910
930
|
include Aws::Structure
|
911
931
|
end
|
912
932
|
|
913
|
-
# @!attribute [rw]
|
914
|
-
# The
|
915
|
-
# Cryptography
|
916
|
-
# Account Number) and PIN (Personal Identification Number), generated
|
917
|
-
# in accordance with ISO 9564 standard.
|
918
|
-
# @return [String]
|
919
|
-
#
|
920
|
-
# @!attribute [rw] encryption_key_arn
|
921
|
-
# The `keyARN` of the PEK that Amazon Web Services Payment
|
922
|
-
# Cryptography uses for encrypted pin block generation.
|
933
|
+
# @!attribute [rw] generation_key_arn
|
934
|
+
# The `keyARN` of the pin data generation key that Amazon Web Services
|
935
|
+
# Payment Cryptography uses for PIN, PVV or PIN Offset generation.
|
923
936
|
# @return [String]
|
924
937
|
#
|
925
|
-
# @!attribute [rw]
|
938
|
+
# @!attribute [rw] generation_key_check_value
|
926
939
|
# The key check value (KCV) of the encryption key. The KCV is used to
|
927
940
|
# check if all parties holding a given key have the same key or to
|
928
941
|
# detect that a key has changed.
|
@@ -931,12 +944,12 @@ module Aws::PaymentCryptographyData
|
|
931
944
|
# to the CMAC specification.
|
932
945
|
# @return [String]
|
933
946
|
#
|
934
|
-
# @!attribute [rw]
|
935
|
-
# The `keyARN` of the
|
936
|
-
#
|
947
|
+
# @!attribute [rw] encryption_key_arn
|
948
|
+
# The `keyARN` of the PEK that Amazon Web Services Payment
|
949
|
+
# Cryptography uses for encrypted pin block generation.
|
937
950
|
# @return [String]
|
938
951
|
#
|
939
|
-
# @!attribute [rw]
|
952
|
+
# @!attribute [rw] encryption_key_check_value
|
940
953
|
# The key check value (KCV) of the encryption key. The KCV is used to
|
941
954
|
# check if all parties holding a given key have the same key or to
|
942
955
|
# detect that a key has changed.
|
@@ -945,6 +958,13 @@ module Aws::PaymentCryptographyData
|
|
945
958
|
# to the CMAC specification.
|
946
959
|
# @return [String]
|
947
960
|
#
|
961
|
+
# @!attribute [rw] encrypted_pin_block
|
962
|
+
# The PIN block encrypted under PEK from Amazon Web Services Payment
|
963
|
+
# Cryptography. The encrypted PIN block is a composite of PAN (Primary
|
964
|
+
# Account Number) and PIN (Personal Identification Number), generated
|
965
|
+
# in accordance with ISO 9564 standard.
|
966
|
+
# @return [String]
|
967
|
+
#
|
948
968
|
# @!attribute [rw] pin_data
|
949
969
|
# The attributes and values Amazon Web Services Payment Cryptography
|
950
970
|
# uses for pin data generation.
|
@@ -953,11 +973,11 @@ module Aws::PaymentCryptographyData
|
|
953
973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/GeneratePinDataOutput AWS API Documentation
|
954
974
|
#
|
955
975
|
class GeneratePinDataOutput < Struct.new(
|
956
|
-
:encrypted_pin_block,
|
957
|
-
:encryption_key_arn,
|
958
|
-
:encryption_key_check_value,
|
959
976
|
:generation_key_arn,
|
960
977
|
:generation_key_check_value,
|
978
|
+
:encryption_key_arn,
|
979
|
+
:encryption_key_check_value,
|
980
|
+
:encrypted_pin_block,
|
961
981
|
:pin_data)
|
962
982
|
SENSITIVE = []
|
963
983
|
include Aws::Structure
|
@@ -972,20 +992,20 @@ module Aws::PaymentCryptographyData
|
|
972
992
|
# hexadecimal characters to decimal.
|
973
993
|
# @return [String]
|
974
994
|
#
|
975
|
-
# @!attribute [rw] pin_validation_data
|
976
|
-
# The unique data for cardholder identification.
|
977
|
-
# @return [String]
|
978
|
-
#
|
979
995
|
# @!attribute [rw] pin_validation_data_pad_character
|
980
996
|
# The padding character for validation data.
|
981
997
|
# @return [String]
|
982
998
|
#
|
999
|
+
# @!attribute [rw] pin_validation_data
|
1000
|
+
# The unique data for cardholder identification.
|
1001
|
+
# @return [String]
|
1002
|
+
#
|
983
1003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/Ibm3624NaturalPin AWS API Documentation
|
984
1004
|
#
|
985
1005
|
class Ibm3624NaturalPin < Struct.new(
|
986
1006
|
:decimalization_table,
|
987
|
-
:
|
988
|
-
:
|
1007
|
+
:pin_validation_data_pad_character,
|
1008
|
+
:pin_validation_data)
|
989
1009
|
SENSITIVE = []
|
990
1010
|
include Aws::Structure
|
991
1011
|
end
|
@@ -999,25 +1019,25 @@ module Aws::PaymentCryptographyData
|
|
999
1019
|
# hexadecimal characters to decimal.
|
1000
1020
|
# @return [String]
|
1001
1021
|
#
|
1002
|
-
# @!attribute [rw]
|
1003
|
-
# The
|
1022
|
+
# @!attribute [rw] pin_validation_data_pad_character
|
1023
|
+
# The padding character for validation data.
|
1004
1024
|
# @return [String]
|
1005
1025
|
#
|
1006
1026
|
# @!attribute [rw] pin_validation_data
|
1007
1027
|
# The unique data for cardholder identification.
|
1008
1028
|
# @return [String]
|
1009
1029
|
#
|
1010
|
-
# @!attribute [rw]
|
1011
|
-
# The
|
1030
|
+
# @!attribute [rw] pin_offset
|
1031
|
+
# The PIN offset value.
|
1012
1032
|
# @return [String]
|
1013
1033
|
#
|
1014
1034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/Ibm3624PinFromOffset AWS API Documentation
|
1015
1035
|
#
|
1016
1036
|
class Ibm3624PinFromOffset < Struct.new(
|
1017
1037
|
:decimalization_table,
|
1018
|
-
:
|
1038
|
+
:pin_validation_data_pad_character,
|
1019
1039
|
:pin_validation_data,
|
1020
|
-
:
|
1040
|
+
:pin_offset)
|
1021
1041
|
SENSITIVE = []
|
1022
1042
|
include Aws::Structure
|
1023
1043
|
end
|
@@ -1025,12 +1045,6 @@ module Aws::PaymentCryptographyData
|
|
1025
1045
|
# Pparameters that are required to generate or verify Ibm3624 PIN offset
|
1026
1046
|
# PIN.
|
1027
1047
|
#
|
1028
|
-
# @!attribute [rw] decimalization_table
|
1029
|
-
# The decimalization table to use for IBM 3624 PIN algorithm. The
|
1030
|
-
# table is used to convert the algorithm intermediate result from
|
1031
|
-
# hexadecimal characters to decimal.
|
1032
|
-
# @return [String]
|
1033
|
-
#
|
1034
1048
|
# @!attribute [rw] encrypted_pin_block
|
1035
1049
|
# The encrypted PIN block data. According to ISO 9564 standard, a PIN
|
1036
1050
|
# Block is an encoded representation of a payment card Personal
|
@@ -1038,21 +1052,27 @@ module Aws::PaymentCryptographyData
|
|
1038
1052
|
# Number (PIN).
|
1039
1053
|
# @return [String]
|
1040
1054
|
#
|
1041
|
-
# @!attribute [rw]
|
1042
|
-
# The
|
1055
|
+
# @!attribute [rw] decimalization_table
|
1056
|
+
# The decimalization table to use for IBM 3624 PIN algorithm. The
|
1057
|
+
# table is used to convert the algorithm intermediate result from
|
1058
|
+
# hexadecimal characters to decimal.
|
1043
1059
|
# @return [String]
|
1044
1060
|
#
|
1045
1061
|
# @!attribute [rw] pin_validation_data_pad_character
|
1046
1062
|
# The padding character for validation data.
|
1047
1063
|
# @return [String]
|
1048
1064
|
#
|
1065
|
+
# @!attribute [rw] pin_validation_data
|
1066
|
+
# The unique data for cardholder identification.
|
1067
|
+
# @return [String]
|
1068
|
+
#
|
1049
1069
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/Ibm3624PinOffset AWS API Documentation
|
1050
1070
|
#
|
1051
1071
|
class Ibm3624PinOffset < Struct.new(
|
1052
|
-
:decimalization_table,
|
1053
1072
|
:encrypted_pin_block,
|
1054
|
-
:
|
1055
|
-
:pin_validation_data_pad_character
|
1073
|
+
:decimalization_table,
|
1074
|
+
:pin_validation_data_pad_character,
|
1075
|
+
:pin_validation_data)
|
1056
1076
|
SENSITIVE = []
|
1057
1077
|
include Aws::Structure
|
1058
1078
|
end
|
@@ -1066,25 +1086,25 @@ module Aws::PaymentCryptographyData
|
|
1066
1086
|
# hexadecimal characters to decimal.
|
1067
1087
|
# @return [String]
|
1068
1088
|
#
|
1069
|
-
# @!attribute [rw]
|
1070
|
-
# The
|
1089
|
+
# @!attribute [rw] pin_validation_data_pad_character
|
1090
|
+
# The padding character for validation data.
|
1071
1091
|
# @return [String]
|
1072
1092
|
#
|
1073
1093
|
# @!attribute [rw] pin_validation_data
|
1074
1094
|
# The unique data for cardholder identification.
|
1075
1095
|
# @return [String]
|
1076
1096
|
#
|
1077
|
-
# @!attribute [rw]
|
1078
|
-
# The
|
1097
|
+
# @!attribute [rw] pin_offset
|
1098
|
+
# The PIN offset value.
|
1079
1099
|
# @return [String]
|
1080
1100
|
#
|
1081
1101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/Ibm3624PinVerification AWS API Documentation
|
1082
1102
|
#
|
1083
1103
|
class Ibm3624PinVerification < Struct.new(
|
1084
1104
|
:decimalization_table,
|
1085
|
-
:
|
1105
|
+
:pin_validation_data_pad_character,
|
1086
1106
|
:pin_validation_data,
|
1087
|
-
:
|
1107
|
+
:pin_offset)
|
1088
1108
|
SENSITIVE = []
|
1089
1109
|
include Aws::Structure
|
1090
1110
|
end
|
@@ -1097,20 +1117,20 @@ module Aws::PaymentCryptographyData
|
|
1097
1117
|
# hexadecimal characters to decimal.
|
1098
1118
|
# @return [String]
|
1099
1119
|
#
|
1100
|
-
# @!attribute [rw] pin_validation_data
|
1101
|
-
# The unique data for cardholder identification.
|
1102
|
-
# @return [String]
|
1103
|
-
#
|
1104
1120
|
# @!attribute [rw] pin_validation_data_pad_character
|
1105
1121
|
# The padding character for validation data.
|
1106
1122
|
# @return [String]
|
1107
1123
|
#
|
1124
|
+
# @!attribute [rw] pin_validation_data
|
1125
|
+
# The unique data for cardholder identification.
|
1126
|
+
# @return [String]
|
1127
|
+
#
|
1108
1128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/Ibm3624RandomPin AWS API Documentation
|
1109
1129
|
#
|
1110
1130
|
class Ibm3624RandomPin < Struct.new(
|
1111
1131
|
:decimalization_table,
|
1112
|
-
:
|
1113
|
-
:
|
1132
|
+
:pin_validation_data_pad_character,
|
1133
|
+
:pin_validation_data)
|
1114
1134
|
SENSITIVE = []
|
1115
1135
|
include Aws::Structure
|
1116
1136
|
end
|
@@ -1131,11 +1151,11 @@ module Aws::PaymentCryptographyData
|
|
1131
1151
|
|
1132
1152
|
# Parameters required for DUKPT MAC generation and verification.
|
1133
1153
|
#
|
1134
|
-
# @!attribute [rw]
|
1135
|
-
# The
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1154
|
+
# @!attribute [rw] key_serial_number
|
1155
|
+
# The unique identifier known as Key Serial Number (KSN) that comes
|
1156
|
+
# from an encrypting device using DUKPT encryption method. The KSN is
|
1157
|
+
# derived from the encrypting device unique identifier and an internal
|
1158
|
+
# transaction counter.
|
1139
1159
|
# @return [String]
|
1140
1160
|
#
|
1141
1161
|
# @!attribute [rw] dukpt_key_variant
|
@@ -1143,19 +1163,19 @@ module Aws::PaymentCryptographyData
|
|
1143
1163
|
# verification, or both.
|
1144
1164
|
# @return [String]
|
1145
1165
|
#
|
1146
|
-
# @!attribute [rw]
|
1147
|
-
# The
|
1148
|
-
#
|
1149
|
-
#
|
1150
|
-
#
|
1166
|
+
# @!attribute [rw] dukpt_derivation_type
|
1167
|
+
# The key type derived using DUKPT from a Base Derivation Key (BDK)
|
1168
|
+
# and Key Serial Number (KSN). This must be less than or equal to the
|
1169
|
+
# strength of the BDK. For example, you can't use `AES_128` as a
|
1170
|
+
# derivation type for a BDK of `AES_128` or `TDES_2KEY`.
|
1151
1171
|
# @return [String]
|
1152
1172
|
#
|
1153
1173
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/MacAlgorithmDukpt AWS API Documentation
|
1154
1174
|
#
|
1155
1175
|
class MacAlgorithmDukpt < Struct.new(
|
1156
|
-
:
|
1176
|
+
:key_serial_number,
|
1157
1177
|
:dukpt_key_variant,
|
1158
|
-
:
|
1178
|
+
:dukpt_derivation_type)
|
1159
1179
|
SENSITIVE = []
|
1160
1180
|
include Aws::Structure
|
1161
1181
|
end
|
@@ -1167,17 +1187,17 @@ module Aws::PaymentCryptographyData
|
|
1167
1187
|
# generation or verification.
|
1168
1188
|
# @return [String]
|
1169
1189
|
#
|
1170
|
-
# @!attribute [rw] pan_sequence_number
|
1171
|
-
# A number that identifies and differentiates payment cards with the
|
1172
|
-
# same Primary Account Number (PAN).
|
1173
|
-
# @return [String]
|
1174
|
-
#
|
1175
1190
|
# @!attribute [rw] primary_account_number
|
1176
1191
|
# The Primary Account Number (PAN), a unique identifier for a payment
|
1177
1192
|
# credit or debit card and associates the card to a specific account
|
1178
1193
|
# holder.
|
1179
1194
|
# @return [String]
|
1180
1195
|
#
|
1196
|
+
# @!attribute [rw] pan_sequence_number
|
1197
|
+
# A number that identifies and differentiates payment cards with the
|
1198
|
+
# same Primary Account Number (PAN).
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1181
1201
|
# @!attribute [rw] session_key_derivation_mode
|
1182
1202
|
# The method of deriving a session key for EMV MAC generation or
|
1183
1203
|
# verification.
|
@@ -1192,8 +1212,8 @@ module Aws::PaymentCryptographyData
|
|
1192
1212
|
#
|
1193
1213
|
class MacAlgorithmEmv < Struct.new(
|
1194
1214
|
:major_key_derivation_mode,
|
1195
|
-
:pan_sequence_number,
|
1196
1215
|
:primary_account_number,
|
1216
|
+
:pan_sequence_number,
|
1197
1217
|
:session_key_derivation_mode,
|
1198
1218
|
:session_key_derivation_value)
|
1199
1219
|
SENSITIVE = [:primary_account_number]
|
@@ -1209,10 +1229,10 @@ module Aws::PaymentCryptographyData
|
|
1209
1229
|
# The encryption algorithm for MAC generation or verification.
|
1210
1230
|
# @return [String]
|
1211
1231
|
#
|
1212
|
-
# @!attribute [rw]
|
1232
|
+
# @!attribute [rw] emv_mac
|
1213
1233
|
# Parameters that are required for MAC generation or verification
|
1214
|
-
# using
|
1215
|
-
# @return [Types::
|
1234
|
+
# using EMV MAC algorithm.
|
1235
|
+
# @return [Types::MacAlgorithmEmv]
|
1216
1236
|
#
|
1217
1237
|
# @!attribute [rw] dukpt_iso_9797_algorithm_1
|
1218
1238
|
# Parameters that are required for MAC generation or verification
|
@@ -1224,29 +1244,29 @@ module Aws::PaymentCryptographyData
|
|
1224
1244
|
# using DUKPT ISO 9797 algorithm3.
|
1225
1245
|
# @return [Types::MacAlgorithmDukpt]
|
1226
1246
|
#
|
1227
|
-
# @!attribute [rw]
|
1247
|
+
# @!attribute [rw] dukpt_cmac
|
1228
1248
|
# Parameters that are required for MAC generation or verification
|
1229
|
-
# using
|
1230
|
-
# @return [Types::
|
1249
|
+
# using DUKPT CMAC algorithm.
|
1250
|
+
# @return [Types::MacAlgorithmDukpt]
|
1231
1251
|
#
|
1232
1252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/MacAttributes AWS API Documentation
|
1233
1253
|
#
|
1234
1254
|
class MacAttributes < Struct.new(
|
1235
1255
|
:algorithm,
|
1236
|
-
:
|
1256
|
+
:emv_mac,
|
1237
1257
|
:dukpt_iso_9797_algorithm_1,
|
1238
1258
|
:dukpt_iso_9797_algorithm_3,
|
1239
|
-
:
|
1259
|
+
:dukpt_cmac,
|
1240
1260
|
:unknown)
|
1241
1261
|
SENSITIVE = []
|
1242
1262
|
include Aws::Structure
|
1243
1263
|
include Aws::Structure::Union
|
1244
1264
|
|
1245
1265
|
class Algorithm < MacAttributes; end
|
1246
|
-
class
|
1266
|
+
class EmvMac < MacAttributes; end
|
1247
1267
|
class DukptIso9797Algorithm1 < MacAttributes; end
|
1248
1268
|
class DukptIso9797Algorithm3 < MacAttributes; end
|
1249
|
-
class
|
1269
|
+
class DukptCmac < MacAttributes; end
|
1250
1270
|
class Unknown < MacAttributes; end
|
1251
1271
|
end
|
1252
1272
|
|
@@ -1284,55 +1304,55 @@ module Aws::PaymentCryptographyData
|
|
1284
1304
|
#
|
1285
1305
|
# @note PinGenerationAttributes is a union - when making an API calls you must set exactly one of the members.
|
1286
1306
|
#
|
1287
|
-
# @!attribute [rw]
|
1288
|
-
# Parameters that are required to generate or verify
|
1289
|
-
#
|
1290
|
-
# @return [Types::Ibm3624NaturalPin]
|
1307
|
+
# @!attribute [rw] visa_pin
|
1308
|
+
# Parameters that are required to generate or verify Visa PIN.
|
1309
|
+
# @return [Types::VisaPin]
|
1291
1310
|
#
|
1292
|
-
# @!attribute [rw]
|
1293
|
-
# Parameters that are required to generate or verify
|
1294
|
-
#
|
1295
|
-
# @return [Types::
|
1311
|
+
# @!attribute [rw] visa_pin_verification_value
|
1312
|
+
# Parameters that are required to generate or verify Visa PIN
|
1313
|
+
# Verification Value (PVV).
|
1314
|
+
# @return [Types::VisaPinVerificationValue]
|
1296
1315
|
#
|
1297
1316
|
# @!attribute [rw] ibm_3624_pin_offset
|
1298
1317
|
# Parameters that are required to generate or verify Ibm3624 PIN
|
1299
1318
|
# offset PIN.
|
1300
1319
|
# @return [Types::Ibm3624PinOffset]
|
1301
1320
|
#
|
1321
|
+
# @!attribute [rw] ibm_3624_natural_pin
|
1322
|
+
# Parameters that are required to generate or verify Ibm3624 natural
|
1323
|
+
# PIN.
|
1324
|
+
# @return [Types::Ibm3624NaturalPin]
|
1325
|
+
#
|
1302
1326
|
# @!attribute [rw] ibm_3624_random_pin
|
1303
1327
|
# Parameters that are required to generate or verify Ibm3624 random
|
1304
1328
|
# PIN.
|
1305
1329
|
# @return [Types::Ibm3624RandomPin]
|
1306
1330
|
#
|
1307
|
-
# @!attribute [rw]
|
1308
|
-
# Parameters that are required to generate or verify
|
1309
|
-
#
|
1310
|
-
#
|
1311
|
-
# @!attribute [rw] visa_pin_verification_value
|
1312
|
-
# Parameters that are required to generate or verify Visa PIN
|
1313
|
-
# Verification Value (PVV).
|
1314
|
-
# @return [Types::VisaPinVerificationValue]
|
1331
|
+
# @!attribute [rw] ibm_3624_pin_from_offset
|
1332
|
+
# Parameters that are required to generate or verify Ibm3624 PIN from
|
1333
|
+
# offset PIN.
|
1334
|
+
# @return [Types::Ibm3624PinFromOffset]
|
1315
1335
|
#
|
1316
1336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/PinGenerationAttributes AWS API Documentation
|
1317
1337
|
#
|
1318
1338
|
class PinGenerationAttributes < Struct.new(
|
1319
|
-
:ibm_3624_natural_pin,
|
1320
|
-
:ibm_3624_pin_from_offset,
|
1321
|
-
:ibm_3624_pin_offset,
|
1322
|
-
:ibm_3624_random_pin,
|
1323
1339
|
:visa_pin,
|
1324
1340
|
:visa_pin_verification_value,
|
1341
|
+
:ibm_3624_pin_offset,
|
1342
|
+
:ibm_3624_natural_pin,
|
1343
|
+
:ibm_3624_random_pin,
|
1344
|
+
:ibm_3624_pin_from_offset,
|
1325
1345
|
:unknown)
|
1326
1346
|
SENSITIVE = []
|
1327
1347
|
include Aws::Structure
|
1328
1348
|
include Aws::Structure::Union
|
1329
1349
|
|
1330
|
-
class Ibm3624NaturalPin < PinGenerationAttributes; end
|
1331
|
-
class Ibm3624PinFromOffset < PinGenerationAttributes; end
|
1332
|
-
class Ibm3624PinOffset < PinGenerationAttributes; end
|
1333
|
-
class Ibm3624RandomPin < PinGenerationAttributes; end
|
1334
1350
|
class VisaPin < PinGenerationAttributes; end
|
1335
1351
|
class VisaPinVerificationValue < PinGenerationAttributes; end
|
1352
|
+
class Ibm3624PinOffset < PinGenerationAttributes; end
|
1353
|
+
class Ibm3624NaturalPin < PinGenerationAttributes; end
|
1354
|
+
class Ibm3624RandomPin < PinGenerationAttributes; end
|
1355
|
+
class Ibm3624PinFromOffset < PinGenerationAttributes; end
|
1336
1356
|
class Unknown < PinGenerationAttributes; end
|
1337
1357
|
end
|
1338
1358
|
|
@@ -1340,29 +1360,42 @@ module Aws::PaymentCryptographyData
|
|
1340
1360
|
#
|
1341
1361
|
# @note PinVerificationAttributes is a union - when making an API calls you must set exactly one of the members.
|
1342
1362
|
#
|
1343
|
-
# @!attribute [rw] ibm_3624_pin
|
1344
|
-
# Parameters that are required to generate or verify Ibm3624 PIN.
|
1345
|
-
# @return [Types::Ibm3624PinVerification]
|
1346
|
-
#
|
1347
1363
|
# @!attribute [rw] visa_pin
|
1348
1364
|
# Parameters that are required to generate or verify Visa PIN.
|
1349
1365
|
# @return [Types::VisaPinVerification]
|
1350
1366
|
#
|
1367
|
+
# @!attribute [rw] ibm_3624_pin
|
1368
|
+
# Parameters that are required to generate or verify Ibm3624 PIN.
|
1369
|
+
# @return [Types::Ibm3624PinVerification]
|
1370
|
+
#
|
1351
1371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/PinVerificationAttributes AWS API Documentation
|
1352
1372
|
#
|
1353
1373
|
class PinVerificationAttributes < Struct.new(
|
1354
|
-
:ibm_3624_pin,
|
1355
1374
|
:visa_pin,
|
1375
|
+
:ibm_3624_pin,
|
1356
1376
|
:unknown)
|
1357
1377
|
SENSITIVE = []
|
1358
1378
|
include Aws::Structure
|
1359
1379
|
include Aws::Structure::Union
|
1360
1380
|
|
1361
|
-
class Ibm3624Pin < PinVerificationAttributes; end
|
1362
1381
|
class VisaPin < PinVerificationAttributes; end
|
1382
|
+
class Ibm3624Pin < PinVerificationAttributes; end
|
1363
1383
|
class Unknown < PinVerificationAttributes; end
|
1364
1384
|
end
|
1365
1385
|
|
1386
|
+
# @!attribute [rw] incoming_key_identifier
|
1387
|
+
# The `keyARN` of the encryption key of incoming ciphertext data.
|
1388
|
+
#
|
1389
|
+
# When a WrappedKeyBlock is provided, this value will be the
|
1390
|
+
# identifier to the key wrapping key. Otherwise, it is the key
|
1391
|
+
# identifier used to perform the operation.
|
1392
|
+
# @return [String]
|
1393
|
+
#
|
1394
|
+
# @!attribute [rw] outgoing_key_identifier
|
1395
|
+
# The `keyARN` of the encryption key of outgoing ciphertext data after
|
1396
|
+
# encryption by Amazon Web Services Payment Cryptography.
|
1397
|
+
# @return [String]
|
1398
|
+
#
|
1366
1399
|
# @!attribute [rw] cipher_text
|
1367
1400
|
# Ciphertext to be encrypted. The minimum allowed length is 16 bytes
|
1368
1401
|
# and maximum allowed length is 4096 bytes.
|
@@ -1372,36 +1405,36 @@ module Aws::PaymentCryptographyData
|
|
1372
1405
|
# The attributes and values for incoming ciphertext.
|
1373
1406
|
# @return [Types::ReEncryptionAttributes]
|
1374
1407
|
#
|
1375
|
-
# @!attribute [rw] incoming_key_identifier
|
1376
|
-
# The `keyARN` of the encryption key of incoming ciphertext data.
|
1377
|
-
# @return [String]
|
1378
|
-
#
|
1379
1408
|
# @!attribute [rw] outgoing_encryption_attributes
|
1380
1409
|
# The attributes and values for outgoing ciphertext data after
|
1381
1410
|
# encryption by Amazon Web Services Payment Cryptography.
|
1382
1411
|
# @return [Types::ReEncryptionAttributes]
|
1383
1412
|
#
|
1384
|
-
# @!attribute [rw]
|
1385
|
-
# The
|
1386
|
-
#
|
1387
|
-
# @return [
|
1413
|
+
# @!attribute [rw] incoming_wrapped_key
|
1414
|
+
# The WrappedKeyBlock containing the encryption key of incoming
|
1415
|
+
# ciphertext data.
|
1416
|
+
# @return [Types::WrappedKey]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] outgoing_wrapped_key
|
1419
|
+
# The WrappedKeyBlock containing the encryption key of outgoing
|
1420
|
+
# ciphertext data after encryption by Amazon Web Services Payment
|
1421
|
+
# Cryptography.
|
1422
|
+
# @return [Types::WrappedKey]
|
1388
1423
|
#
|
1389
1424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/ReEncryptDataInput AWS API Documentation
|
1390
1425
|
#
|
1391
1426
|
class ReEncryptDataInput < Struct.new(
|
1427
|
+
:incoming_key_identifier,
|
1428
|
+
:outgoing_key_identifier,
|
1392
1429
|
:cipher_text,
|
1393
1430
|
:incoming_encryption_attributes,
|
1394
|
-
:incoming_key_identifier,
|
1395
1431
|
:outgoing_encryption_attributes,
|
1396
|
-
:
|
1432
|
+
:incoming_wrapped_key,
|
1433
|
+
:outgoing_wrapped_key)
|
1397
1434
|
SENSITIVE = [:cipher_text]
|
1398
1435
|
include Aws::Structure
|
1399
1436
|
end
|
1400
1437
|
|
1401
|
-
# @!attribute [rw] cipher_text
|
1402
|
-
# The encrypted ciphertext.
|
1403
|
-
# @return [String]
|
1404
|
-
#
|
1405
1438
|
# @!attribute [rw] key_arn
|
1406
1439
|
# The keyARN (Amazon Resource Name) of the encryption key that Amazon
|
1407
1440
|
# Web Services Payment Cryptography uses for plaintext encryption.
|
@@ -1416,12 +1449,16 @@ module Aws::PaymentCryptographyData
|
|
1416
1449
|
# to the CMAC specification.
|
1417
1450
|
# @return [String]
|
1418
1451
|
#
|
1452
|
+
# @!attribute [rw] cipher_text
|
1453
|
+
# The encrypted ciphertext.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1419
1456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/ReEncryptDataOutput AWS API Documentation
|
1420
1457
|
#
|
1421
1458
|
class ReEncryptDataOutput < Struct.new(
|
1422
|
-
:cipher_text,
|
1423
1459
|
:key_arn,
|
1424
|
-
:key_check_value
|
1460
|
+
:key_check_value,
|
1461
|
+
:cipher_text)
|
1425
1462
|
SENSITIVE = [:cipher_text]
|
1426
1463
|
include Aws::Structure
|
1427
1464
|
end
|
@@ -1430,26 +1467,26 @@ module Aws::PaymentCryptographyData
|
|
1430
1467
|
#
|
1431
1468
|
# @note ReEncryptionAttributes is a union - when making an API calls you must set exactly one of the members.
|
1432
1469
|
#
|
1433
|
-
# @!attribute [rw] dukpt
|
1434
|
-
# Parameters that are required to encrypt plaintext data using DUKPT.
|
1435
|
-
# @return [Types::DukptEncryptionAttributes]
|
1436
|
-
#
|
1437
1470
|
# @!attribute [rw] symmetric
|
1438
1471
|
# Parameters that are required to encrypt data using symmetric keys.
|
1439
1472
|
# @return [Types::SymmetricEncryptionAttributes]
|
1440
1473
|
#
|
1474
|
+
# @!attribute [rw] dukpt
|
1475
|
+
# Parameters that are required to encrypt plaintext data using DUKPT.
|
1476
|
+
# @return [Types::DukptEncryptionAttributes]
|
1477
|
+
#
|
1441
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/ReEncryptionAttributes AWS API Documentation
|
1442
1479
|
#
|
1443
1480
|
class ReEncryptionAttributes < Struct.new(
|
1444
|
-
:dukpt,
|
1445
1481
|
:symmetric,
|
1482
|
+
:dukpt,
|
1446
1483
|
:unknown)
|
1447
1484
|
SENSITIVE = []
|
1448
1485
|
include Aws::Structure
|
1449
1486
|
include Aws::Structure::Union
|
1450
1487
|
|
1451
|
-
class Dukpt < ReEncryptionAttributes; end
|
1452
1488
|
class Symmetric < ReEncryptionAttributes; end
|
1489
|
+
class Dukpt < ReEncryptionAttributes; end
|
1453
1490
|
class Unknown < ReEncryptionAttributes; end
|
1454
1491
|
end
|
1455
1492
|
|
@@ -1469,22 +1506,22 @@ module Aws::PaymentCryptographyData
|
|
1469
1506
|
|
1470
1507
|
# Parameters to derive session key for an Amex payment card.
|
1471
1508
|
#
|
1472
|
-
# @!attribute [rw] pan_sequence_number
|
1473
|
-
# A number that identifies and differentiates payment cards with the
|
1474
|
-
# same Primary Account Number (PAN).
|
1475
|
-
# @return [String]
|
1476
|
-
#
|
1477
1509
|
# @!attribute [rw] primary_account_number
|
1478
1510
|
# The Primary Account Number (PAN) of the cardholder. A PAN is a
|
1479
1511
|
# unique identifier for a payment credit or debit card and associates
|
1480
1512
|
# the card to a specific account holder.
|
1481
1513
|
# @return [String]
|
1482
1514
|
#
|
1515
|
+
# @!attribute [rw] pan_sequence_number
|
1516
|
+
# A number that identifies and differentiates payment cards with the
|
1517
|
+
# same Primary Account Number (PAN).
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1483
1520
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SessionKeyAmex AWS API Documentation
|
1484
1521
|
#
|
1485
1522
|
class SessionKeyAmex < Struct.new(
|
1486
|
-
:
|
1487
|
-
:
|
1523
|
+
:primary_account_number,
|
1524
|
+
:pan_sequence_number)
|
1488
1525
|
SENSITIVE = [:primary_account_number]
|
1489
1526
|
include Aws::Structure
|
1490
1527
|
end
|
@@ -1494,16 +1531,6 @@ module Aws::PaymentCryptographyData
|
|
1494
1531
|
#
|
1495
1532
|
# @note SessionKeyDerivation is a union - when making an API calls you must set exactly one of the members.
|
1496
1533
|
#
|
1497
|
-
# @!attribute [rw] amex
|
1498
|
-
# Parameters to derive session key for an Amex payment card for ARQC
|
1499
|
-
# verification.
|
1500
|
-
# @return [Types::SessionKeyAmex]
|
1501
|
-
#
|
1502
|
-
# @!attribute [rw] emv_2000
|
1503
|
-
# Parameters to derive session key for an Emv2000 payment card for
|
1504
|
-
# ARQC verification.
|
1505
|
-
# @return [Types::SessionKeyEmv2000]
|
1506
|
-
#
|
1507
1534
|
# @!attribute [rw] emv_common
|
1508
1535
|
# Parameters to derive session key for an Emv common payment card for
|
1509
1536
|
# ARQC verification.
|
@@ -1514,6 +1541,16 @@ module Aws::PaymentCryptographyData
|
|
1514
1541
|
# ARQC verification.
|
1515
1542
|
# @return [Types::SessionKeyMastercard]
|
1516
1543
|
#
|
1544
|
+
# @!attribute [rw] emv_2000
|
1545
|
+
# Parameters to derive session key for an Emv2000 payment card for
|
1546
|
+
# ARQC verification.
|
1547
|
+
# @return [Types::SessionKeyEmv2000]
|
1548
|
+
#
|
1549
|
+
# @!attribute [rw] amex
|
1550
|
+
# Parameters to derive session key for an Amex payment card for ARQC
|
1551
|
+
# verification.
|
1552
|
+
# @return [Types::SessionKeyAmex]
|
1553
|
+
#
|
1517
1554
|
# @!attribute [rw] visa
|
1518
1555
|
# Parameters to derive session key for a Visa payment cardfor ARQC
|
1519
1556
|
# verification.
|
@@ -1522,20 +1559,20 @@ module Aws::PaymentCryptographyData
|
|
1522
1559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SessionKeyDerivation AWS API Documentation
|
1523
1560
|
#
|
1524
1561
|
class SessionKeyDerivation < Struct.new(
|
1525
|
-
:amex,
|
1526
|
-
:emv_2000,
|
1527
1562
|
:emv_common,
|
1528
1563
|
:mastercard,
|
1564
|
+
:emv_2000,
|
1565
|
+
:amex,
|
1529
1566
|
:visa,
|
1530
1567
|
:unknown)
|
1531
1568
|
SENSITIVE = []
|
1532
1569
|
include Aws::Structure
|
1533
1570
|
include Aws::Structure::Union
|
1534
1571
|
|
1535
|
-
class Amex < SessionKeyDerivation; end
|
1536
|
-
class Emv2000 < SessionKeyDerivation; end
|
1537
1572
|
class EmvCommon < SessionKeyDerivation; end
|
1538
1573
|
class Mastercard < SessionKeyDerivation; end
|
1574
|
+
class Emv2000 < SessionKeyDerivation; end
|
1575
|
+
class Amex < SessionKeyDerivation; end
|
1539
1576
|
class Visa < SessionKeyDerivation; end
|
1540
1577
|
class Unknown < SessionKeyDerivation; end
|
1541
1578
|
end
|
@@ -1572,9 +1609,10 @@ module Aws::PaymentCryptographyData
|
|
1572
1609
|
# Parameters to derive session key for an Emv2000 payment card for ARQC
|
1573
1610
|
# verification.
|
1574
1611
|
#
|
1575
|
-
# @!attribute [rw]
|
1576
|
-
# The
|
1577
|
-
#
|
1612
|
+
# @!attribute [rw] primary_account_number
|
1613
|
+
# The Primary Account Number (PAN) of the cardholder. A PAN is a
|
1614
|
+
# unique identifier for a payment credit or debit card and associates
|
1615
|
+
# the card to a specific account holder.
|
1578
1616
|
# @return [String]
|
1579
1617
|
#
|
1580
1618
|
# @!attribute [rw] pan_sequence_number
|
@@ -1582,18 +1620,17 @@ module Aws::PaymentCryptographyData
|
|
1582
1620
|
# same Primary Account Number (PAN).
|
1583
1621
|
# @return [String]
|
1584
1622
|
#
|
1585
|
-
# @!attribute [rw]
|
1586
|
-
# The
|
1587
|
-
#
|
1588
|
-
# the card to a specific account holder.
|
1623
|
+
# @!attribute [rw] application_transaction_counter
|
1624
|
+
# The transaction counter that is provided by the terminal during
|
1625
|
+
# transaction processing.
|
1589
1626
|
# @return [String]
|
1590
1627
|
#
|
1591
1628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SessionKeyEmv2000 AWS API Documentation
|
1592
1629
|
#
|
1593
1630
|
class SessionKeyEmv2000 < Struct.new(
|
1594
|
-
:
|
1631
|
+
:primary_account_number,
|
1595
1632
|
:pan_sequence_number,
|
1596
|
-
:
|
1633
|
+
:application_transaction_counter)
|
1597
1634
|
SENSITIVE = [:primary_account_number]
|
1598
1635
|
include Aws::Structure
|
1599
1636
|
end
|
@@ -1601,9 +1638,10 @@ module Aws::PaymentCryptographyData
|
|
1601
1638
|
# Parameters to derive session key for an Emv common payment card for
|
1602
1639
|
# ARQC verification.
|
1603
1640
|
#
|
1604
|
-
# @!attribute [rw]
|
1605
|
-
# The
|
1606
|
-
#
|
1641
|
+
# @!attribute [rw] primary_account_number
|
1642
|
+
# The Primary Account Number (PAN) of the cardholder. A PAN is a
|
1643
|
+
# unique identifier for a payment credit or debit card and associates
|
1644
|
+
# the card to a specific account holder.
|
1607
1645
|
# @return [String]
|
1608
1646
|
#
|
1609
1647
|
# @!attribute [rw] pan_sequence_number
|
@@ -1611,18 +1649,17 @@ module Aws::PaymentCryptographyData
|
|
1611
1649
|
# same Primary Account Number (PAN).
|
1612
1650
|
# @return [String]
|
1613
1651
|
#
|
1614
|
-
# @!attribute [rw]
|
1615
|
-
# The
|
1616
|
-
#
|
1617
|
-
# the card to a specific account holder.
|
1652
|
+
# @!attribute [rw] application_transaction_counter
|
1653
|
+
# The transaction counter that is provided by the terminal during
|
1654
|
+
# transaction processing.
|
1618
1655
|
# @return [String]
|
1619
1656
|
#
|
1620
1657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SessionKeyEmvCommon AWS API Documentation
|
1621
1658
|
#
|
1622
1659
|
class SessionKeyEmvCommon < Struct.new(
|
1623
|
-
:
|
1660
|
+
:primary_account_number,
|
1624
1661
|
:pan_sequence_number,
|
1625
|
-
:
|
1662
|
+
:application_transaction_counter)
|
1626
1663
|
SENSITIVE = [:primary_account_number]
|
1627
1664
|
include Aws::Structure
|
1628
1665
|
end
|
@@ -1630,9 +1667,10 @@ module Aws::PaymentCryptographyData
|
|
1630
1667
|
# Parameters to derive session key for Mastercard payment card for ARQC
|
1631
1668
|
# verification.
|
1632
1669
|
#
|
1633
|
-
# @!attribute [rw]
|
1634
|
-
# The
|
1635
|
-
#
|
1670
|
+
# @!attribute [rw] primary_account_number
|
1671
|
+
# The Primary Account Number (PAN) of the cardholder. A PAN is a
|
1672
|
+
# unique identifier for a payment credit or debit card and associates
|
1673
|
+
# the card to a specific account holder.
|
1636
1674
|
# @return [String]
|
1637
1675
|
#
|
1638
1676
|
# @!attribute [rw] pan_sequence_number
|
@@ -1640,10 +1678,9 @@ module Aws::PaymentCryptographyData
|
|
1640
1678
|
# same Primary Account Number (PAN).
|
1641
1679
|
# @return [String]
|
1642
1680
|
#
|
1643
|
-
# @!attribute [rw]
|
1644
|
-
# The
|
1645
|
-
#
|
1646
|
-
# the card to a specific account holder.
|
1681
|
+
# @!attribute [rw] application_transaction_counter
|
1682
|
+
# The transaction counter that is provided by the terminal during
|
1683
|
+
# transaction processing.
|
1647
1684
|
# @return [String]
|
1648
1685
|
#
|
1649
1686
|
# @!attribute [rw] unpredictable_number
|
@@ -1653,9 +1690,9 @@ module Aws::PaymentCryptographyData
|
|
1653
1690
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SessionKeyMastercard AWS API Documentation
|
1654
1691
|
#
|
1655
1692
|
class SessionKeyMastercard < Struct.new(
|
1656
|
-
:application_transaction_counter,
|
1657
|
-
:pan_sequence_number,
|
1658
1693
|
:primary_account_number,
|
1694
|
+
:pan_sequence_number,
|
1695
|
+
:application_transaction_counter,
|
1659
1696
|
:unpredictable_number)
|
1660
1697
|
SENSITIVE = [:primary_account_number]
|
1661
1698
|
include Aws::Structure
|
@@ -1664,37 +1701,37 @@ module Aws::PaymentCryptographyData
|
|
1664
1701
|
# Parameters to derive session key for Visa payment card for ARQC
|
1665
1702
|
# verification.
|
1666
1703
|
#
|
1667
|
-
# @!attribute [rw] pan_sequence_number
|
1668
|
-
# A number that identifies and differentiates payment cards with the
|
1669
|
-
# same Primary Account Number (PAN).
|
1670
|
-
# @return [String]
|
1671
|
-
#
|
1672
1704
|
# @!attribute [rw] primary_account_number
|
1673
1705
|
# The Primary Account Number (PAN) of the cardholder. A PAN is a
|
1674
1706
|
# unique identifier for a payment credit or debit card and associates
|
1675
1707
|
# the card to a specific account holder.
|
1676
1708
|
# @return [String]
|
1677
1709
|
#
|
1710
|
+
# @!attribute [rw] pan_sequence_number
|
1711
|
+
# A number that identifies and differentiates payment cards with the
|
1712
|
+
# same Primary Account Number (PAN).
|
1713
|
+
# @return [String]
|
1714
|
+
#
|
1678
1715
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SessionKeyVisa AWS API Documentation
|
1679
1716
|
#
|
1680
1717
|
class SessionKeyVisa < Struct.new(
|
1681
|
-
:
|
1682
|
-
:
|
1718
|
+
:primary_account_number,
|
1719
|
+
:pan_sequence_number)
|
1683
1720
|
SENSITIVE = [:primary_account_number]
|
1684
1721
|
include Aws::Structure
|
1685
1722
|
end
|
1686
1723
|
|
1687
1724
|
# Parameters requried to encrypt plaintext data using symmetric keys.
|
1688
1725
|
#
|
1726
|
+
# @!attribute [rw] mode
|
1727
|
+
# The block cipher method to use for encryption.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1689
1730
|
# @!attribute [rw] initialization_vector
|
1690
1731
|
# An input used to provide the intial state. If no value is provided,
|
1691
1732
|
# Amazon Web Services Payment Cryptography defaults it to zero.
|
1692
1733
|
# @return [String]
|
1693
1734
|
#
|
1694
|
-
# @!attribute [rw] mode
|
1695
|
-
# The block cipher method to use for encryption.
|
1696
|
-
# @return [String]
|
1697
|
-
#
|
1698
1735
|
# @!attribute [rw] padding_type
|
1699
1736
|
# The padding to be included with the data.
|
1700
1737
|
# @return [String]
|
@@ -1702,8 +1739,8 @@ module Aws::PaymentCryptographyData
|
|
1702
1739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/SymmetricEncryptionAttributes AWS API Documentation
|
1703
1740
|
#
|
1704
1741
|
class SymmetricEncryptionAttributes < Struct.new(
|
1705
|
-
:initialization_vector,
|
1706
1742
|
:mode,
|
1743
|
+
:initialization_vector,
|
1707
1744
|
:padding_type)
|
1708
1745
|
SENSITIVE = [:initialization_vector]
|
1709
1746
|
include Aws::Structure
|
@@ -1722,19 +1759,18 @@ module Aws::PaymentCryptographyData
|
|
1722
1759
|
include Aws::Structure
|
1723
1760
|
end
|
1724
1761
|
|
1725
|
-
# @!attribute [rw] encrypted_pin_block
|
1726
|
-
# The encrypted PIN block data that Amazon Web Services Payment
|
1727
|
-
# Cryptography translates.
|
1728
|
-
# @return [String]
|
1729
|
-
#
|
1730
|
-
# @!attribute [rw] incoming_dukpt_attributes
|
1731
|
-
# The attributes and values to use for incoming DUKPT encryption key
|
1732
|
-
# for PIN block translation.
|
1733
|
-
# @return [Types::DukptDerivationAttributes]
|
1734
|
-
#
|
1735
1762
|
# @!attribute [rw] incoming_key_identifier
|
1736
1763
|
# The `keyARN` of the encryption key under which incoming PIN block
|
1737
1764
|
# data is encrypted. This key type can be PEK or BDK.
|
1765
|
+
#
|
1766
|
+
# When a WrappedKeyBlock is provided, this value will be the
|
1767
|
+
# identifier to the key wrapping key for PIN block. Otherwise, it is
|
1768
|
+
# the key identifier used to perform the operation.
|
1769
|
+
# @return [String]
|
1770
|
+
#
|
1771
|
+
# @!attribute [rw] outgoing_key_identifier
|
1772
|
+
# The `keyARN` of the encryption key for encrypting outgoing PIN block
|
1773
|
+
# data. This key type can be PEK or BDK.
|
1738
1774
|
# @return [String]
|
1739
1775
|
#
|
1740
1776
|
# @!attribute [rw] incoming_translation_attributes
|
@@ -1742,35 +1778,56 @@ module Aws::PaymentCryptographyData
|
|
1742
1778
|
# Amazon Web Services Payment Cryptography.
|
1743
1779
|
# @return [Types::TranslationIsoFormats]
|
1744
1780
|
#
|
1781
|
+
# @!attribute [rw] outgoing_translation_attributes
|
1782
|
+
# The format of the outgoing PIN block data after translation by
|
1783
|
+
# Amazon Web Services Payment Cryptography.
|
1784
|
+
# @return [Types::TranslationIsoFormats]
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] encrypted_pin_block
|
1787
|
+
# The encrypted PIN block data that Amazon Web Services Payment
|
1788
|
+
# Cryptography translates.
|
1789
|
+
# @return [String]
|
1790
|
+
#
|
1791
|
+
# @!attribute [rw] incoming_dukpt_attributes
|
1792
|
+
# The attributes and values to use for incoming DUKPT encryption key
|
1793
|
+
# for PIN block translation.
|
1794
|
+
# @return [Types::DukptDerivationAttributes]
|
1795
|
+
#
|
1745
1796
|
# @!attribute [rw] outgoing_dukpt_attributes
|
1746
1797
|
# The attributes and values to use for outgoing DUKPT encryption key
|
1747
1798
|
# after PIN block translation.
|
1748
1799
|
# @return [Types::DukptDerivationAttributes]
|
1749
1800
|
#
|
1750
|
-
# @!attribute [rw]
|
1751
|
-
# The
|
1752
|
-
#
|
1753
|
-
# @return [
|
1801
|
+
# @!attribute [rw] incoming_wrapped_key
|
1802
|
+
# The WrappedKeyBlock containing the encryption key under which
|
1803
|
+
# incoming PIN block data is encrypted.
|
1804
|
+
# @return [Types::WrappedKey]
|
1754
1805
|
#
|
1755
|
-
# @!attribute [rw]
|
1756
|
-
# The
|
1757
|
-
#
|
1758
|
-
# @return [Types::
|
1806
|
+
# @!attribute [rw] outgoing_wrapped_key
|
1807
|
+
# The WrappedKeyBlock containing the encryption key for encrypting
|
1808
|
+
# outgoing PIN block data.
|
1809
|
+
# @return [Types::WrappedKey]
|
1759
1810
|
#
|
1760
1811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/TranslatePinDataInput AWS API Documentation
|
1761
1812
|
#
|
1762
1813
|
class TranslatePinDataInput < Struct.new(
|
1763
|
-
:encrypted_pin_block,
|
1764
|
-
:incoming_dukpt_attributes,
|
1765
1814
|
:incoming_key_identifier,
|
1815
|
+
:outgoing_key_identifier,
|
1766
1816
|
:incoming_translation_attributes,
|
1817
|
+
:outgoing_translation_attributes,
|
1818
|
+
:encrypted_pin_block,
|
1819
|
+
:incoming_dukpt_attributes,
|
1767
1820
|
:outgoing_dukpt_attributes,
|
1768
|
-
:
|
1769
|
-
:
|
1821
|
+
:incoming_wrapped_key,
|
1822
|
+
:outgoing_wrapped_key)
|
1770
1823
|
SENSITIVE = [:encrypted_pin_block]
|
1771
1824
|
include Aws::Structure
|
1772
1825
|
end
|
1773
1826
|
|
1827
|
+
# @!attribute [rw] pin_block
|
1828
|
+
# The outgoing encrypted PIN block data after translation.
|
1829
|
+
# @return [String]
|
1830
|
+
#
|
1774
1831
|
# @!attribute [rw] key_arn
|
1775
1832
|
# The `keyARN` of the encryption key that Amazon Web Services Payment
|
1776
1833
|
# Cryptography uses to encrypt outgoing PIN block data after
|
@@ -1786,16 +1843,12 @@ module Aws::PaymentCryptographyData
|
|
1786
1843
|
# to the CMAC specification.
|
1787
1844
|
# @return [String]
|
1788
1845
|
#
|
1789
|
-
# @!attribute [rw] pin_block
|
1790
|
-
# The outgoing encrypted PIN block data after translation.
|
1791
|
-
# @return [String]
|
1792
|
-
#
|
1793
1846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/TranslatePinDataOutput AWS API Documentation
|
1794
1847
|
#
|
1795
1848
|
class TranslatePinDataOutput < Struct.new(
|
1849
|
+
:pin_block,
|
1796
1850
|
:key_arn,
|
1797
|
-
:key_check_value
|
1798
|
-
:pin_block)
|
1851
|
+
:key_check_value)
|
1799
1852
|
SENSITIVE = []
|
1800
1853
|
include Aws::Structure
|
1801
1854
|
end
|
@@ -1867,76 +1920,76 @@ module Aws::PaymentCryptographyData
|
|
1867
1920
|
|
1868
1921
|
# The request was denied due to an invalid request error.
|
1869
1922
|
#
|
1923
|
+
# @!attribute [rw] message
|
1924
|
+
# @return [String]
|
1925
|
+
#
|
1870
1926
|
# @!attribute [rw] field_list
|
1871
1927
|
# The request was denied due to an invalid request error.
|
1872
1928
|
# @return [Array<Types::ValidationExceptionField>]
|
1873
1929
|
#
|
1874
|
-
# @!attribute [rw] message
|
1875
|
-
# @return [String]
|
1876
|
-
#
|
1877
1930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/ValidationException AWS API Documentation
|
1878
1931
|
#
|
1879
1932
|
class ValidationException < Struct.new(
|
1880
|
-
:
|
1881
|
-
:
|
1933
|
+
:message,
|
1934
|
+
:field_list)
|
1882
1935
|
SENSITIVE = []
|
1883
1936
|
include Aws::Structure
|
1884
1937
|
end
|
1885
1938
|
|
1886
1939
|
# The request was denied due to an invalid request error.
|
1887
1940
|
#
|
1888
|
-
# @!attribute [rw]
|
1941
|
+
# @!attribute [rw] path
|
1889
1942
|
# The request was denied due to an invalid request error.
|
1890
1943
|
# @return [String]
|
1891
1944
|
#
|
1892
|
-
# @!attribute [rw]
|
1945
|
+
# @!attribute [rw] message
|
1893
1946
|
# The request was denied due to an invalid request error.
|
1894
1947
|
# @return [String]
|
1895
1948
|
#
|
1896
1949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/ValidationExceptionField AWS API Documentation
|
1897
1950
|
#
|
1898
1951
|
class ValidationExceptionField < Struct.new(
|
1899
|
-
:
|
1900
|
-
:
|
1952
|
+
:path,
|
1953
|
+
:message)
|
1901
1954
|
SENSITIVE = []
|
1902
1955
|
include Aws::Structure
|
1903
1956
|
end
|
1904
1957
|
|
1905
1958
|
# This request failed verification.
|
1906
1959
|
#
|
1907
|
-
# @!attribute [rw] message
|
1908
|
-
# @return [String]
|
1909
|
-
#
|
1910
1960
|
# @!attribute [rw] reason
|
1911
1961
|
# The reason for the exception.
|
1912
1962
|
# @return [String]
|
1913
1963
|
#
|
1964
|
+
# @!attribute [rw] message
|
1965
|
+
# @return [String]
|
1966
|
+
#
|
1914
1967
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerificationFailedException AWS API Documentation
|
1915
1968
|
#
|
1916
1969
|
class VerificationFailedException < Struct.new(
|
1917
|
-
:
|
1918
|
-
:
|
1970
|
+
:reason,
|
1971
|
+
:message)
|
1919
1972
|
SENSITIVE = []
|
1920
1973
|
include Aws::Structure
|
1921
1974
|
end
|
1922
1975
|
|
1976
|
+
# @!attribute [rw] key_identifier
|
1977
|
+
# The `keyARN` of the major encryption key that Amazon Web Services
|
1978
|
+
# Payment Cryptography uses for ARQC verification.
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] transaction_data
|
1982
|
+
# The transaction data that Amazon Web Services Payment Cryptography
|
1983
|
+
# uses for ARQC verification. The same transaction is used for ARQC
|
1984
|
+
# generation outside of Amazon Web Services Payment Cryptography.
|
1985
|
+
# @return [String]
|
1986
|
+
#
|
1923
1987
|
# @!attribute [rw] auth_request_cryptogram
|
1924
1988
|
# The auth request cryptogram imported into Amazon Web Services
|
1925
1989
|
# Payment Cryptography for ARQC verification using a major encryption
|
1926
1990
|
# key and transaction data.
|
1927
1991
|
# @return [String]
|
1928
1992
|
#
|
1929
|
-
# @!attribute [rw] auth_response_attributes
|
1930
|
-
# The attributes and values for auth request cryptogram verification.
|
1931
|
-
# These parameters are required in case using ARPC Method 1 or Method
|
1932
|
-
# 2 for ARQC verification.
|
1933
|
-
# @return [Types::CryptogramAuthResponse]
|
1934
|
-
#
|
1935
|
-
# @!attribute [rw] key_identifier
|
1936
|
-
# The `keyARN` of the major encryption key that Amazon Web Services
|
1937
|
-
# Payment Cryptography uses for ARQC verification.
|
1938
|
-
# @return [String]
|
1939
|
-
#
|
1940
1993
|
# @!attribute [rw] major_key_derivation_mode
|
1941
1994
|
# The method to use when deriving the major encryption key for ARQC
|
1942
1995
|
# verification within Amazon Web Services Payment Cryptography. The
|
@@ -1951,30 +2004,25 @@ module Aws::PaymentCryptographyData
|
|
1951
2004
|
# Services Payment Cryptography.
|
1952
2005
|
# @return [Types::SessionKeyDerivation]
|
1953
2006
|
#
|
1954
|
-
# @!attribute [rw]
|
1955
|
-
# The
|
1956
|
-
#
|
1957
|
-
#
|
1958
|
-
# @return [
|
2007
|
+
# @!attribute [rw] auth_response_attributes
|
2008
|
+
# The attributes and values for auth request cryptogram verification.
|
2009
|
+
# These parameters are required in case using ARPC Method 1 or Method
|
2010
|
+
# 2 for ARQC verification.
|
2011
|
+
# @return [Types::CryptogramAuthResponse]
|
1959
2012
|
#
|
1960
2013
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerifyAuthRequestCryptogramInput AWS API Documentation
|
1961
2014
|
#
|
1962
2015
|
class VerifyAuthRequestCryptogramInput < Struct.new(
|
1963
|
-
:auth_request_cryptogram,
|
1964
|
-
:auth_response_attributes,
|
1965
2016
|
:key_identifier,
|
2017
|
+
:transaction_data,
|
2018
|
+
:auth_request_cryptogram,
|
1966
2019
|
:major_key_derivation_mode,
|
1967
2020
|
:session_key_derivation_attributes,
|
1968
|
-
:
|
2021
|
+
:auth_response_attributes)
|
1969
2022
|
SENSITIVE = []
|
1970
2023
|
include Aws::Structure
|
1971
2024
|
end
|
1972
2025
|
|
1973
|
-
# @!attribute [rw] auth_response_value
|
1974
|
-
# The result for ARQC verification or ARPC generation within Amazon
|
1975
|
-
# Web Services Payment Cryptography.
|
1976
|
-
# @return [String]
|
1977
|
-
#
|
1978
2026
|
# @!attribute [rw] key_arn
|
1979
2027
|
# The `keyARN` of the major encryption key that Amazon Web Services
|
1980
2028
|
# Payment Cryptography uses for ARQC verification.
|
@@ -1989,12 +2037,17 @@ module Aws::PaymentCryptographyData
|
|
1989
2037
|
# to the CMAC specification.
|
1990
2038
|
# @return [String]
|
1991
2039
|
#
|
2040
|
+
# @!attribute [rw] auth_response_value
|
2041
|
+
# The result for ARQC verification or ARPC generation within Amazon
|
2042
|
+
# Web Services Payment Cryptography.
|
2043
|
+
# @return [String]
|
2044
|
+
#
|
1992
2045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerifyAuthRequestCryptogramOutput AWS API Documentation
|
1993
2046
|
#
|
1994
2047
|
class VerifyAuthRequestCryptogramOutput < Struct.new(
|
1995
|
-
:auth_response_value,
|
1996
2048
|
:key_arn,
|
1997
|
-
:key_check_value
|
2049
|
+
:key_check_value,
|
2050
|
+
:auth_response_value)
|
1998
2051
|
SENSITIVE = []
|
1999
2052
|
include Aws::Structure
|
2000
2053
|
end
|
@@ -2010,23 +2063,23 @@ module Aws::PaymentCryptographyData
|
|
2010
2063
|
# account holder.
|
2011
2064
|
# @return [String]
|
2012
2065
|
#
|
2013
|
-
# @!attribute [rw] validation_data
|
2014
|
-
# The CVV or CSC value for use for card data verification within
|
2015
|
-
# Amazon Web Services Payment Cryptography.
|
2016
|
-
# @return [String]
|
2017
|
-
#
|
2018
2066
|
# @!attribute [rw] verification_attributes
|
2019
2067
|
# The algorithm to use for verification of card data within Amazon Web
|
2020
2068
|
# Services Payment Cryptography.
|
2021
2069
|
# @return [Types::CardVerificationAttributes]
|
2022
2070
|
#
|
2071
|
+
# @!attribute [rw] validation_data
|
2072
|
+
# The CVV or CSC value for use for card data verification within
|
2073
|
+
# Amazon Web Services Payment Cryptography.
|
2074
|
+
# @return [String]
|
2075
|
+
#
|
2023
2076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerifyCardValidationDataInput AWS API Documentation
|
2024
2077
|
#
|
2025
2078
|
class VerifyCardValidationDataInput < Struct.new(
|
2026
2079
|
:key_identifier,
|
2027
2080
|
:primary_account_number,
|
2028
|
-
:
|
2029
|
-
:
|
2081
|
+
:verification_attributes,
|
2082
|
+
:validation_data)
|
2030
2083
|
SENSITIVE = [:primary_account_number]
|
2031
2084
|
include Aws::Structure
|
2032
2085
|
end
|
@@ -2059,33 +2112,33 @@ module Aws::PaymentCryptographyData
|
|
2059
2112
|
# Cryptography uses to verify MAC data.
|
2060
2113
|
# @return [String]
|
2061
2114
|
#
|
2062
|
-
# @!attribute [rw] mac
|
2063
|
-
# The MAC being verified.
|
2064
|
-
# @return [String]
|
2065
|
-
#
|
2066
|
-
# @!attribute [rw] mac_length
|
2067
|
-
# The length of the MAC.
|
2068
|
-
# @return [Integer]
|
2069
|
-
#
|
2070
2115
|
# @!attribute [rw] message_data
|
2071
2116
|
# The data on for which MAC is under verification. This value must be
|
2072
2117
|
# hexBinary.
|
2073
2118
|
# @return [String]
|
2074
2119
|
#
|
2120
|
+
# @!attribute [rw] mac
|
2121
|
+
# The MAC being verified.
|
2122
|
+
# @return [String]
|
2123
|
+
#
|
2075
2124
|
# @!attribute [rw] verification_attributes
|
2076
2125
|
# The attributes and data values to use for MAC verification within
|
2077
2126
|
# Amazon Web Services Payment Cryptography.
|
2078
2127
|
# @return [Types::MacAttributes]
|
2079
2128
|
#
|
2129
|
+
# @!attribute [rw] mac_length
|
2130
|
+
# The length of the MAC.
|
2131
|
+
# @return [Integer]
|
2132
|
+
#
|
2080
2133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerifyMacInput AWS API Documentation
|
2081
2134
|
#
|
2082
2135
|
class VerifyMacInput < Struct.new(
|
2083
2136
|
:key_identifier,
|
2084
|
-
:mac,
|
2085
|
-
:mac_length,
|
2086
2137
|
:message_data,
|
2087
|
-
:
|
2088
|
-
|
2138
|
+
:mac,
|
2139
|
+
:verification_attributes,
|
2140
|
+
:mac_length)
|
2141
|
+
SENSITIVE = [:message_data, :mac]
|
2089
2142
|
include Aws::Structure
|
2090
2143
|
end
|
2091
2144
|
|
@@ -2112,18 +2165,28 @@ module Aws::PaymentCryptographyData
|
|
2112
2165
|
include Aws::Structure
|
2113
2166
|
end
|
2114
2167
|
|
2115
|
-
# @!attribute [rw]
|
2116
|
-
# The
|
2117
|
-
# @return [
|
2168
|
+
# @!attribute [rw] verification_key_identifier
|
2169
|
+
# The `keyARN` of the PIN verification key.
|
2170
|
+
# @return [String]
|
2171
|
+
#
|
2172
|
+
# @!attribute [rw] encryption_key_identifier
|
2173
|
+
# The `keyARN` of the encryption key under which the PIN block data is
|
2174
|
+
# encrypted. This key type can be PEK or BDK.
|
2175
|
+
# @return [String]
|
2176
|
+
#
|
2177
|
+
# @!attribute [rw] verification_attributes
|
2178
|
+
# The attributes and values for PIN data verification.
|
2179
|
+
# @return [Types::PinVerificationAttributes]
|
2118
2180
|
#
|
2119
2181
|
# @!attribute [rw] encrypted_pin_block
|
2120
2182
|
# The encrypted PIN block data that Amazon Web Services Payment
|
2121
2183
|
# Cryptography verifies.
|
2122
2184
|
# @return [String]
|
2123
2185
|
#
|
2124
|
-
# @!attribute [rw]
|
2125
|
-
# The
|
2126
|
-
#
|
2186
|
+
# @!attribute [rw] primary_account_number
|
2187
|
+
# The Primary Account Number (PAN), a unique identifier for a payment
|
2188
|
+
# credit or debit card that associates the card with a specific
|
2189
|
+
# account holder.
|
2127
2190
|
# @return [String]
|
2128
2191
|
#
|
2129
2192
|
# @!attribute [rw] pin_block_format
|
@@ -2143,41 +2206,31 @@ module Aws::PaymentCryptographyData
|
|
2143
2206
|
# The length of PIN being verified.
|
2144
2207
|
# @return [Integer]
|
2145
2208
|
#
|
2146
|
-
# @!attribute [rw]
|
2147
|
-
# The
|
2148
|
-
#
|
2149
|
-
# account holder.
|
2150
|
-
# @return [String]
|
2151
|
-
#
|
2152
|
-
# @!attribute [rw] verification_attributes
|
2153
|
-
# The attributes and values for PIN data verification.
|
2154
|
-
# @return [Types::PinVerificationAttributes]
|
2155
|
-
#
|
2156
|
-
# @!attribute [rw] verification_key_identifier
|
2157
|
-
# The `keyARN` of the PIN verification key.
|
2158
|
-
# @return [String]
|
2209
|
+
# @!attribute [rw] dukpt_attributes
|
2210
|
+
# The attributes and values for the DUKPT encrypted PIN block data.
|
2211
|
+
# @return [Types::DukptAttributes]
|
2159
2212
|
#
|
2160
2213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerifyPinDataInput AWS API Documentation
|
2161
2214
|
#
|
2162
2215
|
class VerifyPinDataInput < Struct.new(
|
2163
|
-
:
|
2164
|
-
:encrypted_pin_block,
|
2216
|
+
:verification_key_identifier,
|
2165
2217
|
:encryption_key_identifier,
|
2218
|
+
:verification_attributes,
|
2219
|
+
:encrypted_pin_block,
|
2220
|
+
:primary_account_number,
|
2166
2221
|
:pin_block_format,
|
2167
2222
|
:pin_data_length,
|
2168
|
-
:
|
2169
|
-
:verification_attributes,
|
2170
|
-
:verification_key_identifier)
|
2223
|
+
:dukpt_attributes)
|
2171
2224
|
SENSITIVE = [:primary_account_number]
|
2172
2225
|
include Aws::Structure
|
2173
2226
|
end
|
2174
2227
|
|
2175
|
-
# @!attribute [rw]
|
2176
|
-
# The `keyARN` of the
|
2177
|
-
# Cryptography uses for
|
2228
|
+
# @!attribute [rw] verification_key_arn
|
2229
|
+
# The `keyARN` of the PIN encryption key that Amazon Web Services
|
2230
|
+
# Payment Cryptography uses for PIN or PIN Offset verification.
|
2178
2231
|
# @return [String]
|
2179
2232
|
#
|
2180
|
-
# @!attribute [rw]
|
2233
|
+
# @!attribute [rw] verification_key_check_value
|
2181
2234
|
# The key check value (KCV) of the encryption key. The KCV is used to
|
2182
2235
|
# check if all parties holding a given key have the same key or to
|
2183
2236
|
# detect that a key has changed.
|
@@ -2186,12 +2239,12 @@ module Aws::PaymentCryptographyData
|
|
2186
2239
|
# to the CMAC specification.
|
2187
2240
|
# @return [String]
|
2188
2241
|
#
|
2189
|
-
# @!attribute [rw]
|
2190
|
-
# The `keyARN` of the
|
2191
|
-
#
|
2242
|
+
# @!attribute [rw] encryption_key_arn
|
2243
|
+
# The `keyARN` of the PEK that Amazon Web Services Payment
|
2244
|
+
# Cryptography uses for encrypted pin block generation.
|
2192
2245
|
# @return [String]
|
2193
2246
|
#
|
2194
|
-
# @!attribute [rw]
|
2247
|
+
# @!attribute [rw] encryption_key_check_value
|
2195
2248
|
# The key check value (KCV) of the encryption key. The KCV is used to
|
2196
2249
|
# check if all parties holding a given key have the same key or to
|
2197
2250
|
# detect that a key has changed.
|
@@ -2203,10 +2256,10 @@ module Aws::PaymentCryptographyData
|
|
2203
2256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/VerifyPinDataOutput AWS API Documentation
|
2204
2257
|
#
|
2205
2258
|
class VerifyPinDataOutput < Struct.new(
|
2206
|
-
:encryption_key_arn,
|
2207
|
-
:encryption_key_check_value,
|
2208
2259
|
:verification_key_arn,
|
2209
|
-
:verification_key_check_value
|
2260
|
+
:verification_key_check_value,
|
2261
|
+
:encryption_key_arn,
|
2262
|
+
:encryption_key_check_value)
|
2210
2263
|
SENSITIVE = []
|
2211
2264
|
include Aws::Structure
|
2212
2265
|
end
|
@@ -2268,5 +2321,57 @@ module Aws::PaymentCryptographyData
|
|
2268
2321
|
include Aws::Structure
|
2269
2322
|
end
|
2270
2323
|
|
2324
|
+
# Parameter information of a WrappedKeyBlock for encryption key
|
2325
|
+
# exchange.
|
2326
|
+
#
|
2327
|
+
# @!attribute [rw] wrapped_key_material
|
2328
|
+
# Parameter information of a WrappedKeyBlock for encryption key
|
2329
|
+
# exchange.
|
2330
|
+
# @return [Types::WrappedKeyMaterial]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] key_check_value_algorithm
|
2333
|
+
# The algorithm that Amazon Web Services Payment Cryptography uses to
|
2334
|
+
# calculate the key check value (KCV). It is used to validate the key
|
2335
|
+
# integrity.
|
2336
|
+
#
|
2337
|
+
# For TDES keys, the KCV is computed by encrypting 8 bytes, each with
|
2338
|
+
# value of zero, with the key to be checked and retaining the 3
|
2339
|
+
# highest order bytes of the encrypted result. For AES keys, the KCV
|
2340
|
+
# is computed using a CMAC algorithm where the input data is 16 bytes
|
2341
|
+
# of zero and retaining the 3 highest order bytes of the encrypted
|
2342
|
+
# result.
|
2343
|
+
# @return [String]
|
2344
|
+
#
|
2345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/WrappedKey AWS API Documentation
|
2346
|
+
#
|
2347
|
+
class WrappedKey < Struct.new(
|
2348
|
+
:wrapped_key_material,
|
2349
|
+
:key_check_value_algorithm)
|
2350
|
+
SENSITIVE = []
|
2351
|
+
include Aws::Structure
|
2352
|
+
end
|
2353
|
+
|
2354
|
+
# Parameter information of a WrappedKeyBlock for encryption key
|
2355
|
+
# exchange.
|
2356
|
+
#
|
2357
|
+
# @note WrappedKeyMaterial is a union - when making an API calls you must set exactly one of the members.
|
2358
|
+
#
|
2359
|
+
# @!attribute [rw] tr_31_key_block
|
2360
|
+
# The TR-31 wrapped key block.
|
2361
|
+
# @return [String]
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-data-2022-02-03/WrappedKeyMaterial AWS API Documentation
|
2364
|
+
#
|
2365
|
+
class WrappedKeyMaterial < Struct.new(
|
2366
|
+
:tr_31_key_block,
|
2367
|
+
:unknown)
|
2368
|
+
SENSITIVE = [:tr_31_key_block]
|
2369
|
+
include Aws::Structure
|
2370
|
+
include Aws::Structure::Union
|
2371
|
+
|
2372
|
+
class Tr31KeyBlock < WrappedKeyMaterial; end
|
2373
|
+
class Unknown < WrappedKeyMaterial; end
|
2374
|
+
end
|
2375
|
+
|
2271
2376
|
end
|
2272
2377
|
end
|