Class: Aws::KMS::Types::EncapsulateResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:shared_secret]

Instance Attribute Summary collapse

Instance Attribute Details

#encapsulation_algorithm ⇒ String

The key encapsulation algorithm used to generate the shared secret.

Returns:

  • (String) 


2670
2671
2672
2673
2674
2675
2676
2677
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2670

class EncapsulateResponse < Struct.new(
  :key_id,
  :shared_secret,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#key_id ⇒ String

The identifier of the ML-KEM KMS key used to encapsulate the shared secret.

Returns:

  • (String) 


2670
2671
2672
2673
2674
2675
2676
2677
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2670

class EncapsulateResponse < Struct.new(
  :key_id,
  :shared_secret,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#shared_secret ⇒ String

The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Returns:

  • (String) 


2670
2671
2672
2673
2674
2675
2676
2677
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2670

class EncapsulateResponse < Struct.new(
  :key_id,
  :shared_secret,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#shared_secret_ciphertext_blob ⇒ String

The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.

Returns:

  • (String) 


2670
2671
2672
2673
2674
2675
2676
2677
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2670

class EncapsulateResponse < Struct.new(
  :key_id,
  :shared_secret,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end