Struct ChaCha20Poly1305 

pub struct ChaCha20Poly1305 { /* private fields */ }

ChaCha20-Poly1305 AEAD

Implementations

impl ChaCha20Poly1305

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

Create a new instance from a 256-bit key.

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

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

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

Decrypt into exact-size storage that clears itself on all internal error and drop paths. Callers should use this for intermediate plaintext that has not yet crossed a public output boundary.

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

where Nonce<N>: ChaCha20Compatible,

Encrypt data

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

where Nonce<N>: ChaCha20Compatible,

Decrypt data

Trait Implementations

impl AuthenticatedCipher for ChaCha20Poly1305

const TAG_SIZE: usize = POLY1305_TAG_SIZE

Authentication tag size in bytes

const ALGORITHM_ID: &'static str = "ChaCha20Poly1305"

Static algorithm identifier for compile-time checking

fn name() -> String

Returns the authenticated cipher algorithm name

impl Clone for ChaCha20Poly1305

fn clone(&self) -> ChaCha20Poly1305

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Set the nonce for decryption

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

Set associated data for authenticated decryption

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

Set ciphertext and execute decryption

impl Drop for ChaCha20Poly1305

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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

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

Set the nonce for encryption

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

Set associated data for authenticated encryption

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

Set plaintext and execute encryption

impl SymmetricCipher for ChaCha20Poly1305

type Key = SecretBytes<CHACHA20POLY1305_KEY_SIZE>

Key type with appropriate algorithm binding

type Nonce = Nonce<CHACHA20POLY1305_NONCE_SIZE>

Nonce type with appropriate size constraint

type Ciphertext = Ciphertext

Ciphertext output type

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

Operation type for encryption operations

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

Operation type for decryption operations

fn name() -> &'static str

Returns the symmetric cipher algorithm name

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

Begin encryption operation

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

Begin decryption operation

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

Generate a new random key

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

Generate a new random nonce

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

Derive a key from arbitrary bytes

impl Zeroize for ChaCha20Poly1305

fn zeroize(&mut self)

impl ZeroizeOnDrop for ChaCha20Poly1305