Struct ChaChaPoly1305

pub struct ChaChaPoly1305<C, N: ArrayLength<u8> = U12> { /* private fields */ }

Generic ChaCha+Poly1305 Authenticated Encryption with Additional Data (AEAD) construction.

See the toplevel documentation for a usage example.

Trait Implementations

impl<C, N> AeadCore for ChaChaPoly1305<C, N>

where N: ArrayLength<u8>,

type NonceSize = N

The length of a nonce.

type TagSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

The maximum length of the nonce.

type CiphertextOverhead = UTerm

The upper bound amount of additional space required to support a ciphertext vs. a plaintext.

fn generate_nonce( rng: impl CryptoRng + RngCore, ) -> GenericArray<u8, Self::NonceSize>

where GenericArray<u8, Self::NonceSize>: Default,

Generate a random nonce for this AEAD algorithm.

impl<C, N> AeadInPlace for ChaChaPoly1305<C, N>

where C: KeyIvInit<KeySize = U32, IvSize = N> + StreamCipher + StreamCipherSeek, N: ArrayLength<u8>,

fn encrypt_in_place_detached( &self, nonce: &Nonce<Self>, associated_data: &[u8], buffer: &mut [u8], ) -> Result<Tag, Error>

Encrypt the data in-place, returning the authentication tag

fn decrypt_in_place_detached( &self, nonce: &Nonce<Self>, associated_data: &[u8], buffer: &mut [u8], tag: &Tag, ) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext (i.e. ciphertext is modified/unauthentic)

fn encrypt_in_place( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut dyn Buffer, ) -> Result<(), Error>

Encrypt the given buffer containing a plaintext message in-place.

fn decrypt_in_place( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut dyn Buffer, ) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext.

impl<C, N> Clone for ChaChaPoly1305<C, N>

where N: ArrayLength<u8>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, N> Drop for ChaChaPoly1305<C, N>

where N: ArrayLength<u8>,

fn drop(&mut self)

Executes the destructor for this type.

impl<C, N> KeyInit for ChaChaPoly1305<C, N>

where N: ArrayLength<u8>,

fn new(key: &Key) -> Self

Create new value from fixed size key.

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidLength>

Create new value from variable size key.

fn generate_key( rng: impl CryptoRng + RngCore, ) -> GenericArray<u8, Self::KeySize>

Generate random key using the provided CryptoRng.

impl<C, N> KeySizeUser for ChaChaPoly1305<C, N>

where N: ArrayLength<u8>,

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.

impl<C, N: ArrayLength<u8>> ZeroizeOnDrop for ChaChaPoly1305<C, N>