Struct eax::Eax[−][src]

pub struct Eax<Cipher, M = U16> where
    Cipher: BlockCipher<BlockSize = U16> + BlockEncrypt + NewBlockCipher + Clone,
    Cipher::ParBlocks: ArrayLength<Block<Cipher>>,
    M: TagSize,  { /* fields omitted */ }

Expand description

EAX: generic over an underlying block cipher implementation.

This type is generic to support substituting alternative cipher implementations.

If in doubt, use the built-in [Aes128Eax] and [Aes256Eax] type aliases.

Type parameters:

Cipher: block cipher.
M: size of MAC tag, valid values: up to U16.

Trait Implementations

[src]

impl<Cipher, M> AeadCore for Eax<Cipher, M> where
    Cipher: BlockCipher<BlockSize = U16> + BlockEncrypt + NewBlockCipher + Clone,
    Cipher::ParBlocks: ArrayLength<Block<Cipher>>,
    M: TagSize,

type NonceSize = Cipher::BlockSize

The length of a nonce.

type TagSize = M

The maximum length of the nonce.

type CiphertextOverhead = U0

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

[src]

impl<Cipher, M> AeadInPlace for Eax<Cipher, M> where
    Cipher: BlockCipher<BlockSize = U16> + BlockEncrypt + NewBlockCipher + Clone,
    Cipher::ParBlocks: ArrayLength<Block<Cipher>>,
    M: TagSize,

[src]

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

Encrypt the data in-place, returning the authentication tag

[src]

fn decrypt_in_place_detached(
    &self, 
    nonce: &Nonce<Self::NonceSize>, 
    associated_data: &[u8], 
    buffer: &mut [u8], 
    tag: &Tag<M>
) -> 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) Read more

[src]

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. Read more

[src]

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. Read more

[src]

impl<Cipher: Clone, M: Clone> Clone for Eax<Cipher, M> where
    Cipher: BlockCipher<BlockSize = U16> + BlockEncrypt + NewBlockCipher + Clone,
    Cipher::ParBlocks: ArrayLength<Block<Cipher>>,
    M: TagSize,

[src]

fn clone(&self) -> Eax<Cipher, M>

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl<Cipher, M> NewAead for Eax<Cipher, M> where
    Cipher: BlockCipher<BlockSize = U16> + BlockEncrypt + NewBlockCipher + Clone,
    Cipher::ParBlocks: ArrayLength<Block<Cipher>>,
    M: TagSize,

type KeySize = Cipher::KeySize

The size of the key array required by this algorithm.

[src]

fn new(key: &BlockCipherKey<Cipher>) -> Self

Create a new AEAD instance with the given key.

[src]

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

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

[src]

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

Generate a random key for this AEAD using the provided CryptoRng.

Auto Trait Implementations

impl<Cipher, M> RefUnwindSafe for Eax<Cipher, M> where
    M: RefUnwindSafe,
    <<Cipher as NewBlockCipher>::KeySize as ArrayLength<u8>>::ArrayType: RefUnwindSafe,

impl<Cipher, M> Send for Eax<Cipher, M> where
    M: Send,

impl<Cipher, M> Sync for Eax<Cipher, M> where
    M: Sync,

impl<Cipher, M> Unpin for Eax<Cipher, M> where
    M: Unpin,
    <<Cipher as NewBlockCipher>::KeySize as ArrayLength<u8>>::ArrayType: Unpin,

impl<Cipher, M> UnwindSafe for Eax<Cipher, M> where
    M: UnwindSafe,
    <<Cipher as NewBlockCipher>::KeySize as ArrayLength<u8>>::ArrayType: UnwindSafe,

Blanket Implementations

[src]

impl<Alg> Aead for Alg where
    Alg: AeadInPlace,

[src]

pub fn encrypt<'msg, 'aad>(
    &self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Encrypt the given plaintext payload, and return the resulting ciphertext as a vector of bytes. Read more

[src]

pub fn decrypt<'msg, 'aad>(
    &self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Decrypt the given ciphertext slice, and return the resulting plaintext as a vector of bytes. Read more

[src]

impl<Alg> AeadMut for Alg where
    Alg: AeadMutInPlace,

[src]

pub fn encrypt<'msg, 'aad>(
    &mut self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Encrypt the given plaintext slice, and return the resulting ciphertext as a vector of bytes. Read more

[src]

pub fn decrypt<'msg, 'aad>(
    &mut self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Decrypt the given ciphertext slice, and return the resulting plaintext as a vector of bytes. Read more

[src]

impl<Alg> AeadMutInPlace for Alg where
    Alg: AeadInPlace,

[src]

pub fn encrypt_in_place(
    &mut self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    associated_data: &[u8], 
    buffer: &mut impl Buffer
) -> Result<(), Error>

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

[src]

pub fn encrypt_in_place_detached(
    &mut self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    associated_data: &[u8], 
    buffer: &mut [u8]
) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

Encrypt the data in-place, returning the authentication tag

[src]

pub fn decrypt_in_place(
    &mut self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    associated_data: &[u8], 
    buffer: &mut impl Buffer
) -> Result<(), Error>

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

[src]

pub fn decrypt_in_place_detached(
    &mut self, 
    nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, 
    associated_data: &[u8], 
    buffer: &mut [u8], 
    tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>
) -> Result<(), Error>

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

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.