Class: Aws::PaymentCryptography::Types::WrappedKey

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb

Overview

Parameter information for generating a WrappedKeyBlock for key exchange.

See Also:

Constant Summary collapse

SENSITIVE = 
[:key_material]

Instance Attribute Summary collapse

Instance Attribute Details

#key_check_value ⇒ String

The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

Returns:

  • (String) 


2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 2367

class WrappedKey < Struct.new(
  :wrapping_key_arn,
  :wrapped_key_material_format,
  :key_material,
  :key_check_value,
  :key_check_value_algorithm)
  SENSITIVE = [:key_material]
  include Aws::Structure
end

#key_check_value_algorithm ⇒ String

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Returns:

  • (String) 


2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 2367

class WrappedKey < Struct.new(
  :wrapping_key_arn,
  :wrapped_key_material_format,
  :key_material,
  :key_check_value,
  :key_check_value_algorithm)
  SENSITIVE = [:key_material]
  include Aws::Structure
end

#key_material ⇒ String

Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

Returns:

  • (String) 


2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 2367

class WrappedKey < Struct.new(
  :wrapping_key_arn,
  :wrapped_key_material_format,
  :key_material,
  :key_check_value,
  :key_check_value_algorithm)
  SENSITIVE = [:key_material]
  include Aws::Structure
end

#wrapped_key_material_format ⇒ String

The key block format of a wrapped key.

Returns:

  • (String) 


2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 2367

class WrappedKey < Struct.new(
  :wrapping_key_arn,
  :wrapped_key_material_format,
  :key_material,
  :key_check_value,
  :key_check_value_algorithm)
  SENSITIVE = [:key_material]
  include Aws::Structure
end

#wrapping_key_arn ⇒ String

The KeyARN of the wrapped key.

Returns:

  • (String) 


2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 2367

class WrappedKey < Struct.new(
  :wrapping_key_arn,
  :wrapped_key_material_format,
  :key_material,
  :key_check_value,
  :key_check_value_algorithm)
  SENSITIVE = [:key_material]
  include Aws::Structure
end