Struct chacha20poly1305::ChaChaPoly1305

pub struct ChaChaPoly1305<C, N: ArrayLength<u8> = U12>where
    C: NewCipher<KeySize = U32, NonceSize = N> + StreamCipher + StreamCipherSeek,{ /* 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
    C: NewCipher<KeySize = U32, NonceSize = N> + StreamCipher + StreamCipherSeek,
    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.

impl<C, N> AeadInPlace for ChaChaPoly1305<C, N>where
    C: NewCipher<KeySize = U32, NonceSize = 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
    C: NewCipher<KeySize = U32, NonceSize = N> + StreamCipher + StreamCipherSeek,
    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
    C: NewCipher<KeySize = U32, NonceSize = N> + StreamCipher + StreamCipherSeek,
    N: ArrayLength<u8>,

fn drop(&mut self)

Executes the destructor for this type.

impl<C, N> NewAead for ChaChaPoly1305<C, N>where
    C: NewCipher<KeySize = U32, NonceSize = N> + StreamCipher + StreamCipherSeek,
    N: ArrayLength<u8>,

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

The size of the key array required by this algorithm.

fn new(key: &Key) -> Self

Create a new AEAD instance with the given key.

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

Create new AEAD instance from key given as a byte slice..