Trait Cipher 

pub trait Cipher<'c> {
    const BLOCK_SIZE: usize;
    const REQUIRES_PADDING: bool = false;

    // Required methods
    fn key(&self) -> &[u8];
    fn iv(&self) -> &[u8];
    fn set_algomode(&self, p: Cryp);

    // Provided methods
    fn prepare_key(&self, _p: Cryp, _dir: Direction) { ... }
    fn init_phase_blocking<T: Instance, M: Mode>(
        &self,
        _p: Cryp,
        _cryp: &Cryp<'_, T, M>,
    ) { ... }
    async fn init_phase<T: Instance>(
        &self,
        _p: Cryp,
        _cryp: &mut Cryp<'_, T, Async>,
    ) { ... }
    fn pre_final(
        &self,
        _p: Cryp,
        _dir: Direction,
        _padding_len: usize,
    ) -> [u32; 4] { ... }
    fn post_final_blocking<T: Instance, M: Mode>(
        &self,
        _p: Cryp,
        _cryp: &Cryp<'_, T, M>,
        _dir: Direction,
        _int_data: &mut [u8; 16],
        _temp1: [u32; 4],
        _padding_mask: [u8; 16],
    ) { ... }
    async fn post_final<T: Instance>(
        &self,
        _p: Cryp,
        _cryp: &mut Cryp<'_, T, Async>,
        _dir: Direction,
        _int_data: &mut [u8; 16],
        _temp1: [u32; 4],
        _padding_mask: [u8; 16],
    ) { ... }
    fn get_header_block(&self) -> ([u8; 10], usize) { ... }
    fn ccm_ctr0(&self) -> Option<[u8; 16]> { ... }
}

This trait encapsulates all cipher-specific behavior/

Required Associated Constants

const BLOCK_SIZE: usize

Processing block size. Determined by the processor and the algorithm.

Provided Associated Constants

const REQUIRES_PADDING: bool = false

Indicates whether the cipher requires the application to provide padding. If true, no partial blocks will be accepted (a panic will occur).

Required Methods

fn key(&self) -> &[u8]

Returns the symmetric key.

fn iv(&self) -> &[u8]

Returns the initialization vector.

fn set_algomode(&self, p: Cryp)

Sets the processor algorithm mode according to the associated cipher.

Provided Methods

fn prepare_key(&self, _p: Cryp, _dir: Direction)

Performs any key preparation within the processor, if necessary.

fn init_phase_blocking<T: Instance, M: Mode>( &self, _p: Cryp, _cryp: &Cryp<'_, T, M>, )

Performs any cipher-specific initialization.

async fn init_phase<T: Instance>( &self, _p: Cryp, _cryp: &mut Cryp<'_, T, Async>, )

Performs any cipher-specific initialization.

fn pre_final(&self, _p: Cryp, _dir: Direction, _padding_len: usize) -> [u32; 4]

Called prior to processing the last data block for cipher-specific operations.

fn post_final_blocking<T: Instance, M: Mode>( &self, _p: Cryp, _cryp: &Cryp<'_, T, M>, _dir: Direction, _int_data: &mut [u8; 16], _temp1: [u32; 4], _padding_mask: [u8; 16], )

Called after processing the last data block for cipher-specific operations.

async fn post_final<T: Instance>( &self, _p: Cryp, _cryp: &mut Cryp<'_, T, Async>, _dir: Direction, _int_data: &mut [u8; 16], _temp1: [u32; 4], _padding_mask: [u8; 16], )

Called after processing the last data block for cipher-specific operations.

fn get_header_block(&self) -> ([u8; 10], usize)

Returns the AAD header block as required by the cipher.

fn ccm_ctr0(&self) -> Option<[u8; 16]>

CCM only: the counter block with the counter at zero, which the final phase feeds to the core instead of the GCM lengths block.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<'c, C: Cipher<'c>> Cipher<'c> for C

Cipher hooks for the shared AES cipher types, derived from the register-agnostic [crate::crypto::Cipher] description.

Each hook is a pure function of the cipher mode (chmod_bits), direction and IV, so this single blanket implementation serves every AES cipher; the DES/TDES ciphers keep their own implementations above.

const BLOCK_SIZE: usize

const REQUIRES_PADDING: bool

impl<'c, const KEY_SIZE: usize> Cipher<'c> for DesCbc<'c, KEY_SIZE>

const BLOCK_SIZE: usize = DES_BLOCK_SIZE

const REQUIRES_PADDING: bool = true

impl<'c, const KEY_SIZE: usize> Cipher<'c> for DesEcb<'c, KEY_SIZE>

const BLOCK_SIZE: usize = DES_BLOCK_SIZE

const REQUIRES_PADDING: bool = true

impl<'c, const KEY_SIZE: usize> Cipher<'c> for TdesCbc<'c, KEY_SIZE>

const BLOCK_SIZE: usize = DES_BLOCK_SIZE

const REQUIRES_PADDING: bool = true

impl<'c, const KEY_SIZE: usize> Cipher<'c> for TdesEcb<'c, KEY_SIZE>

const BLOCK_SIZE: usize = DES_BLOCK_SIZE

const REQUIRES_PADDING: bool = true