Struct StackedRatchet

pub struct StackedRatchet { /* private fields */ }

A container meant to establish perfect forward secrecy AND scrambling w/ an independent key This is meant for messages, not file transfer. File transfers should use a single key throughout the entire file

Trait Implementations

impl Clone for StackedRatchet

fn clone(&self) -> StackedRatchet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackedRatchet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StackedRatchet

fn deserialize<__D>( __deserializer: __D, ) -> Result<StackedRatchet, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StackedRatchetInner> for StackedRatchet

fn from(inner: StackedRatchetInner) -> StackedRatchet

Converts to this type from the input type.

impl Ratchet for StackedRatchet

fn get_default_security_level(&self) -> SecurityLevel

Gets the default security level (will use all available keys)

type Constructor = StackedRatchetConstructor

fn get_message_pqc_and_entropy_bank_at_layer( &self, idx: Option<usize>, ) -> Result<(&PostQuantumContainer, &EntropyBank), CryptError>

Returns the message PQC and entropy_bank for the specified index

fn get_scramble_pqc_and_entropy_bank( &self, ) -> (&PostQuantumContainer, &EntropyBank)

Returns the scramble entropy_bank

fn get_next_constructor_opts(&self) -> Vec<ConstructorOpts>

Returns the next constructor options

fn message_ratchet_count(&self) -> usize

fn get_cid(&self) -> u64

Returns the client ID

fn version(&self) -> u32

Returns the version

fn has_verified_packets(&self) -> bool

Determines if any of the ratchets have verified packets

fn reset_ara(&self)

Resets the anti-replay attack counters

fn protect_message_packet<T>( &self, security_level: Option<SecurityLevel>, header_len_bytes: usize, packet: &mut T, ) -> Result<(), CryptError>

where T: EzBuffer,

Protects a message packet using the entire ratchet’s security features

fn validate_message_packet<H, T>( &self, security_level: Option<SecurityLevel>, header: H, packet: &mut T, ) -> Result<(), CryptError>

where H: AsRef<[u8]>, T: EzBuffer,

Validates a message packet using the entire ratchet’s security features

fn next_alice_constructor(&self) -> Option<Self::Constructor>

Returns the next Alice constructor

fn local_encrypt<'a, T>( &self, contents: T, security_level: SecurityLevel, ) -> Result<Vec<u8>, CryptError>

where T: Into<Cow<'a, [u8]>>,

Encrypts using a local key that is not shared with anyone. Relevant for RE-VFS

fn local_decrypt<'a, T>( &self, contents: T, security_level: SecurityLevel, ) -> Result<Vec<u8>, CryptError>

where T: Into<Cow<'a, [u8]>>,

Decrypts using a local key that is not shared with anyone. Relevant for RE-VFS

fn verify_level( &self, security_level: Option<SecurityLevel>, ) -> Result<usize, CryptError>

Verifies the target security level, returning the corresponding idx

fn validate_message_packet_in_place_split<H>( &self, security_level: Option<SecurityLevel>, header: H, packet: &mut BytesMut, ) -> Result<(), CryptError>

where H: AsRef<[u8]>,

Validates in-place when the header + payload have already been split

fn decrypt<T>(&self, contents: T) -> Result<Vec<u8>, CryptError>

where T: AsRef<[u8]>,

decrypts using a custom nonce configuration

fn encrypt<T>(&self, contents: T) -> Result<Vec<u8>, CryptError>

where T: AsRef<[u8]>,

Encrypts the data into a Vec

impl Serialize for StackedRatchet

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<StackedRatchetConstructor> for StackedRatchet

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: StackedRatchetConstructor, ) -> Result<StackedRatchet, <StackedRatchet as TryFrom<StackedRatchetConstructor>>::Error>

Performs the conversion.