ChaCha20Poly1305

Struct ChaCha20Poly1305 

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

ChaCha20-Poly1305 AEAD

Implementations§

Source§

impl ChaCha20Poly1305

Source

pub fn new(key: &[u8; 32]) -> Self

Create a new instance from a 256-bit key.

Source

pub fn encrypt_with_nonce( &self, nonce: &[u8; 12], plaintext: &[u8], aad: Option<&[u8]>, ) -> Result<Vec<u8>>

Encrypt plaintext with a raw nonce array

This method performs ChaCha20-Poly1305 encryption using a raw nonce array instead of a type-safe Nonce object. It is primarily used internally.

§Arguments
  • nonce - A 12-byte array to use as the nonce
  • plaintext - The data to encrypt
  • aad - Optional associated data to authenticate but not encrypt
§Returns

A vector containing the ciphertext followed by the 16-byte Poly1305 authentication tag

Source

pub fn decrypt_with_nonce( &self, nonce: &[u8; 12], ciphertext: &[u8], aad: Option<&[u8]>, ) -> Result<Vec<u8>>

Decrypt ciphertext with a raw nonce array

This method performs ChaCha20-Poly1305 decryption using a raw nonce array instead of a type-safe Nonce object. It is primarily used internally.

§Arguments
  • nonce - A 12-byte array to use as the nonce
  • ciphertext - The ciphertext with appended authentication tag
  • aad - Optional associated data that was authenticated
§Returns

The decrypted plaintext if authentication succeeds

§Errors

Returns an authentication error if the tag verification fails

Source

pub fn encrypt<const N: usize>( &self, nonce: &Nonce<N>, plaintext: &[u8], aad: Option<&[u8]>, ) -> Result<Vec<u8>>

Encrypt data

Source

pub fn decrypt<const N: usize>( &self, nonce: &Nonce<N>, ciphertext: &[u8], aad: Option<&[u8]>, ) -> Result<Vec<u8>>

Decrypt data

Trait Implementations§

Source§

impl AuthenticatedCipher for ChaCha20Poly1305

Source§

const TAG_SIZE: usize = 16usize

Authentication tag size in bytes
Source§

const ALGORITHM_ID: &'static str = "ChaCha20Poly1305"

Static algorithm identifier for compile-time checking
Source§

fn name() -> String

Returns the authenticated cipher algorithm name
Source§

impl Clone for ChaCha20Poly1305

Source§

fn clone(&self) -> ChaCha20Poly1305

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> DecryptOperation<'a, ChaCha20Poly1305> for ChaCha20Poly1305DecryptOperation<'a>

Source§

fn with_nonce( self, nonce: &'a <ChaCha20Poly1305 as SymmetricCipher>::Nonce, ) -> Self

Set the nonce for decryption
Source§

fn with_aad(self, aad: &'a [u8]) -> Self

Set associated data for authenticated decryption
Source§

fn decrypt( self, ciphertext: &'a <ChaCha20Poly1305 as SymmetricCipher>::Ciphertext, ) -> Result<Vec<u8>, CoreError>

Set ciphertext and execute decryption
Source§

impl Drop for ChaCha20Poly1305

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'a> EncryptOperation<'a, ChaCha20Poly1305> for ChaCha20Poly1305EncryptOperation<'a>

Source§

fn with_nonce( self, nonce: &'a <ChaCha20Poly1305 as SymmetricCipher>::Nonce, ) -> Self

Set the nonce for encryption
Source§

fn with_aad(self, aad: &'a [u8]) -> Self

Set associated data for authenticated encryption
Source§

fn encrypt(self, plaintext: &'a [u8]) -> Result<Ciphertext, CoreError>

Set plaintext and execute encryption
Source§

impl SymmetricCipher for ChaCha20Poly1305

Source§

type Key = SecretBytes<CHACHA20POLY1305_KEY_SIZE>

Key type with appropriate algorithm binding
Source§

type Nonce = Nonce<CHACHA20POLY1305_NONCE_SIZE>

Nonce type with appropriate size constraint
Source§

type Ciphertext = Ciphertext

Ciphertext output type
Source§

type EncryptOperation<'a> = ChaCha20Poly1305EncryptOperation<'a> where Self: 'a

Operation type for encryption operations
Source§

type DecryptOperation<'a> = ChaCha20Poly1305DecryptOperation<'a> where Self: 'a

Operation type for decryption operations
Source§

fn name() -> &'static str

Returns the symmetric cipher algorithm name
Source§

fn encrypt(&self) -> Self::EncryptOperation<'_>

Begin encryption operation
Source§

fn decrypt(&self) -> Self::DecryptOperation<'_>

Begin decryption operation
Source§

fn generate_key<R: RngCore + CryptoRng>( rng: &mut R, ) -> Result<Self::Key, CoreError>

Generate a new random key
Source§

fn generate_nonce<R: RngCore + CryptoRng>( rng: &mut R, ) -> Result<Self::Nonce, CoreError>

Generate a new random nonce
Source§

fn derive_key_from_bytes(bytes: &[u8]) -> Result<Self::Key, CoreError>

Derive a key from arbitrary bytes
Source§

impl Zeroize for ChaCha20Poly1305

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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