Struct TlsRecordOpeningKey

pub struct TlsRecordOpeningKey { /* private fields */ }

AEAD Encryption key used for TLS protocol record encryption.

This type encapsulates decryption operations for TLS AEAD algorithms.

The following algorithms are supported:

• AES_128_GCM
• AES_256_GCM

Prefer this type in place of LessSafeKey, OpeningKey, SealingKey for TLS protocol implementations.

Implementations

impl TlsRecordOpeningKey

pub fn new( algorithm: &'static Algorithm, protocol: TlsProtocolId, key_bytes: &[u8], ) -> Result<TlsRecordOpeningKey, Unspecified>

New TLS record opening key. Only supports AES_128_GCM and AES_256_GCM Algorithms.

Errors

• Unspecified: Returned if the length of key_bytes does not match the chosen algorithm, or if an unsupported algorithm is provided.

pub fn open_in_place<'in_out, A>( &self, nonce: Nonce, aad: Aad<A>, in_out: &'in_out mut [u8], ) -> Result<&'in_out mut [u8], Unspecified>

where A: AsRef<[u8]>,

See super::OpeningKey::open_in_place() for details.

Errors

error::Unspecified when ciphertext is invalid.

pub fn open_within<'in_out, A>( &self, nonce: Nonce, aad: Aad<A>, in_out: &'in_out mut [u8], ciphertext_and_tag: RangeFrom<usize>, ) -> Result<&'in_out mut [u8], Unspecified>

where A: AsRef<[u8]>,

See super::OpeningKey::open_within() for details.

Errors

error::Unspecified when ciphertext is invalid.

pub fn algorithm(&self) -> &'static Algorithm

The key’s AEAD algorithm.

pub fn tls_protocol_id(&self) -> TlsProtocolId

The key’s associated TlsProtocolId.

Trait Implementations

impl Debug for TlsRecordOpeningKey

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

Formats the value using the given formatter.