Struct Ctr

Source
pub struct Ctr<B: BlockCipher + Zeroize> { /* private fields */ }
Expand description

Counter mode implementation with secure memory handling

Implementations§

Source§

impl<B: BlockCipher + Zeroize> Ctr<B>

Source

pub fn new<const N: usize>(cipher: B, nonce: &Nonce<N>) -> Result<Self>

Creates a new CTR mode instance with the default configuration

  • cipher - The block cipher to use
  • nonce - The nonce (must be compatible with CTR mode)

This creates a standard CTR mode with the counter in the last 4 bytes and the nonce filling the beginning of the counter block.

Source

pub fn with_counter_params<const N: usize>( cipher: B, nonce: &Nonce<N>, counter_pos: CounterPosition, counter_size: usize, ) -> Result<Self>

Creates a new CTR mode instance with custom counter parameters

  • cipher - The block cipher to use
  • nonce - The nonce (must be compatible with CTR mode)
  • counter_pos - Position of the counter within the counter block
  • counter_size - Size of the counter in bytes (1-8)

This allows for flexible counter block layouts to match different standards and implementations.

Source

pub fn encrypt(&mut self, plaintext: &[u8]) -> Result<Vec<u8>>

Encrypts a message using CTR mode

Source

pub fn decrypt(&mut self, ciphertext: &[u8]) -> Result<Vec<u8>>

Decrypts a message using CTR mode In CTR mode, encryption and decryption are the same operation

Source

pub fn process(&mut self, data: &mut [u8]) -> Result<()>

Process data in place (encrypt or decrypt)

Source

pub fn keystream(&mut self, output: &mut [u8]) -> Result<()>

Generate keystream directly into an output buffer

Source

pub fn seek(&mut self, block_offset: u32)

Seek to a specific block position

block_offset is the number of full blocks that have been consumed; after seeking, the next generated block will be at block_offset + 1.

Source

pub fn set_counter(&mut self, counter: u32)

Set the counter value directly

This allows for manual control of the counter, which can be useful for seeking to specific positions in the stream.

§Arguments
  • counter - The new counter value
Source

pub fn reset<const N: usize>( &mut self, nonce: Option<&Nonce<N>>, counter: u32, ) -> Result<()>

Reset to initial state with the same key and nonce

This resets the counter to 0 and clears any buffered keystream.

§Arguments
  • nonce - Optional new nonce to use (if not provided, keeps the current nonce)
  • counter - Optional initial counter value (defaults to 0)

Trait Implementations§

Source§

impl<B: Clone + BlockCipher + Zeroize> Clone for Ctr<B>

Source§

fn clone(&self) -> Ctr<B>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<B: BlockCipher + Zeroize> Drop for Ctr<B>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<B> Zeroize for Ctr<B>
where B: Zeroize + BlockCipher,

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

Auto Trait Implementations§

§

impl<B> Freeze for Ctr<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for Ctr<B>
where B: RefUnwindSafe,

§

impl<B> Send for Ctr<B>
where B: Send,

§

impl<B> Sync for Ctr<B>
where B: Sync,

§

impl<B> Unpin for Ctr<B>
where B: Unpin,

§

impl<B> UnwindSafe for Ctr<B>
where B: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V