Struct Cipher

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

The Cipher struct provides a common interface for cryptographic operations, specifically focusing on encryption and decryption.

Implementations§

Source§

impl Cipher

Source

pub fn new(mode: CipherMode) -> Self

Constructs a new Cipher instance using the specified cipher mode.

§Arguments
  • mode - The mode of cipher (ChaCha20 or Custom) to use.
§Returns

A new instance of Cipher.

Source

pub fn init(&mut self, key: &[u8], iv: &[u8]) -> &mut Self

Initializes the cipher with a key and IV (initialization vector). Sets up the cipher’s internal state for encryption or decryption.

§Arguments
  • key - A byte slice representing the key.
  • iv - A byte slice representing the initialization vector.
§Returns

A mutable reference to the cipher instance.

Source

pub fn encrypt(&mut self, data: &[u8]) -> Vec<u8>

Encrypts the provided data.

§Arguments
  • data - A slice of data to be encrypted.
§Returns

Encrypted data as a vector of bytes (Bytes).

Source

pub fn sign(&mut self, header: &[u8], data: &[u8]) -> SignedEnvelope

Signs the provided data.

§Arguments
  • header - A slice of unencrypted data to be signed.
  • data - A slice of data to be signed.
§Returns

A signed envelope containing the data and its MAC (message authentication code).

Source

pub fn decrypt(&mut self, data: &[u8]) -> Vec<u8>

Decrypts the provided data. Note that this method does not provide any integrity checks. Most of the use cases should be covered by decrypt_and_verify() instead.

§Arguments
  • data - A slice of data to be decrypted.
§Returns

Decrypted data as a vector of bytes (Bytes).

Source

pub fn decrypt_and_verify( &mut self, envelope: &SignedEnvelope, ) -> Result<Vec<u8>, CipherError>

Decrypts the provided data and verifies the MAC.

§Arguments
  • envelope - A signed envelope containing encrypted data to be decrypted.
§Returns

Decrypted data as a vector of bytes (Bytes), or an error in case of decryption failure.

Trait Implementations§

Source§

impl Default for Cipher

Source§

fn default() -> Self

Provides a default instance of Cipher using the XChaCha20 mode.

§Returns

A new instance of Cipher with XChaCha20 mode.

Auto Trait Implementations§

§

impl Freeze for Cipher

§

impl !RefUnwindSafe for Cipher

§

impl !Send for Cipher

§

impl !Sync for Cipher

§

impl Unpin for Cipher

§

impl !UnwindSafe for Cipher

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.