Skip to main content

RecvCipher

Struct RecvCipher 

Source
pub struct RecvCipher { /* private fields */ }
Expand description

Decrypts incoming messages with an auto-incrementing nonce.

Implementations§

Source§

impl RecvCipher

Source

pub fn new(rng: impl CryptoRngCore) -> Self

Creates a new receiving cipher with a random key.

Source

pub fn recv_in_place( &mut self, encrypted_data: &mut [u8], ) -> Result<usize, Error>

Decrypts encrypted_data in-place and returns the plaintext length.

The buffer must contain ciphertext with the authentication tag appended (last TAG_SIZE bytes). After decryption, the plaintext is in encrypted_data[..returned_len].

§Errors

Returns an error if:

  • encrypted_data.len() < TAG_SIZE
  • Too many messages have been received with this cipher
  • The ciphertext was corrupted or tampered with

In the last two cases, the RecvCipher will no longer be able to return valid ciphertexts, and will always return an error on subsequent calls to Self::recv. Terminating (and optionally reestablishing) the connection is a simple (and safe) way to handle this scenario.

Source

pub fn recv(&mut self, encrypted_data: &[u8]) -> Result<Vec<u8>, Error>

Decrypts ciphertext and returns the original data.

§Errors

This function will return an error in the following situations:

  • Too many messages have been received with this cipher.
  • The ciphertext was corrupted in some way.

In both cases, the RecvCipher will no longer be able to return valid ciphertexts, and will always return an error on subsequent calls to Self::recv. Terminating (and optionally reestablishing) the connection is a simple (and safe) way to handle this scenario.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V