Trait AeadCipher

pub trait AeadCipher {
    type Algorithm: AeadAlgorithm;
    type Key: AsRef<[u8]> + AsMut<[u8]> + Clone + Zeroize;

    // Required methods
    fn new(key: &Self::Key) -> Result<Self>
       where Self: Sized;
    fn encrypt(&self) -> impl AeadEncryptOperation<'_, Self::Algorithm>;
    fn decrypt(&self) -> impl AeadDecryptOperation<'_, Self::Algorithm>;
    fn generate_key<R: RngCore + CryptoRng>(rng: &mut R) -> Result<Self::Key>;
    fn generate_nonce<R: RngCore + CryptoRng>(rng: &mut R) -> Result<Nonce<12>>;

    // Provided methods
    fn name() -> &'static str { ... }
    fn key_size() -> usize { ... }
    fn tag_size() -> usize { ... }
}

Trait for AEAD ciphers with improved type safety

Required Associated Types

type Algorithm: AeadAlgorithm

The algorithm this cipher implements

type Key: AsRef<[u8]> + AsMut<[u8]> + Clone + Zeroize

Key type with appropriate size guarantee

Required Methods

fn new(key: &Self::Key) -> Result<Self>

where Self: Sized,

Creates a new AEAD cipher instance

fn encrypt(&self) -> impl AeadEncryptOperation<'_, Self::Algorithm>

Begin encryption operation with operation pattern

fn decrypt(&self) -> impl AeadDecryptOperation<'_, Self::Algorithm>

Begin decryption operation with operation pattern

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

Generate a random key

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

Generate a random nonce for ChaCha20Poly1305

Provided Methods

fn name() -> &'static str

Returns the cipher name

fn key_size() -> usize

Returns the key size in bytes

fn tag_size() -> usize

Returns the tag size in bytes

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl AeadCipher for ChaCha20Poly1305Cipher

type Algorithm = ChaCha20Poly1305Algorithm

type Key = SecretBytes<32>