class Amazonite::Kms::DeriveSharedSecretResponse

Included Modules

Defined in:

kms/derive_shared_secret_response.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(key_id : String | Nil = nil, shared_secret : Bytes | Nil = nil, ciphertext_for_recipient : Bytes | Nil = nil, key_agreement_algorithm : KeyAgreementAlgorithmSpec | Nil = nil, key_origin : OriginType | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def ciphertext_for_recipient : Bytes | Nil #

The plaintext shared secret encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.


[View source]
def ciphertext_for_recipient=(ciphertext_for_recipient : Bytes | Nil) #

The plaintext shared secret encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def key_agreement_algorithm : KeyAgreementAlgorithmSpec | Nil #

Identifies the key agreement algorithm used to derive the shared secret.


[View source]
def key_agreement_algorithm=(key_agreement_algorithm : KeyAgreementAlgorithmSpec | Nil) #

Identifies the key agreement algorithm used to derive the shared secret.


[View source]
def key_id : String | Nil #

Identifies the KMS key used to derive the shared secret.


[View source]
def key_id=(key_id : String | Nil) #

Identifies the KMS key used to derive the shared secret.


[View source]
def key_origin : OriginType | Nil #

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.


[View source]
def key_origin=(key_origin : OriginType | Nil) #

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.


[View source]
def shared_secret : Bytes | Nil #

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.


[View source]
def shared_secret=(shared_secret : Bytes | Nil) #

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.


[View source]
def validate! : Nil #

[View source]