Struct WrappedKey

#[non_exhaustive]
pub struct WrappedKey {
    pub wrapping_key_arn: String,
    pub wrapped_key_material_format: WrappedKeyMaterialFormat,
    pub key_material: String,
    pub key_check_value: Option<String>,
    pub key_check_value_algorithm: Option<KeyCheckValueAlgorithm>,
}

Parameter information for generating a WrappedKeyBlock for key exchange.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

wrapping_key_arn: String

The KeyARN of the wrapped key.

wrapped_key_material_format: WrappedKeyMaterialFormat

The key block format of a wrapped key.

key_material: String

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

key_check_value: Option<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.

key_check_value_algorithm: Option<KeyCheckValueAlgorithm>

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.

Implementations

impl WrappedKey

pub fn wrapping_key_arn(&self) -> &str

The KeyARN of the wrapped key.

pub fn wrapped_key_material_format(&self) -> &WrappedKeyMaterialFormat

The key block format of a wrapped key.

pub fn key_material(&self) -> &str

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

pub fn key_check_value(&self) -> Option<&str>

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.

pub fn key_check_value_algorithm(&self) -> Option<&KeyCheckValueAlgorithm>

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.

impl WrappedKey

pub fn builder() -> WrappedKeyBuilder

Creates a new builder-style object to manufacture WrappedKey.

Trait Implementations

impl Clone for WrappedKey

fn clone(&self) -> WrappedKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WrappedKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WrappedKey

fn eq(&self, other: &WrappedKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WrappedKey