Struct strobe_rs::Strobe

pub struct Strobe { /* private fields */ }

The main Strobe object. This is currently limited to using Keccak-f[1600] as the internal permutation function. For more information on this object, the protocol specification is a great resource.

Description of method input

Most operations exposed by Strobe take the same set of inputs. The arguments are

• data - The input data to the operation.
• more - For streaming purposes. Specifies whether you’re trying to add more input / get more output to/from the previous operation. For example:

s.ad(b"hello world", false);

is equivalent to

s.ad(b"hello ", false);
s.ad(b"world", true);

NOTE: If you try to set the more flag for an operation that is not preceded by the same operation (e.g., if you try ad followed by send_enc with more=true), then the function will panic, since that is an invalid use of the more flag.

Finally, ratchet and meta_ratchet take a usize argument instead of bytes. These functions are individually commented below.

Implementations

impl Strobe

pub fn new(proto: &[u8], sec: SecParam) -> Strobe

Makes a new Strobe object with a given protocol byte string and security parameter.

pub fn version_str(&self) -> String

Returns a string of the form Strobe-Keccak-<sec>/<b>v<ver> where sec is the bits of security (128 or 256), b is the block size (in bits) of the Keccak permutation function, and ver is the protocol version.

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

Attempts to authenticate the current state against the given MAC. On failure, it returns an AuthError. It behooves the user of this library to check this return value and overreact on error.

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

Attempts to authenticate the current state against the given MAC. On failure, it returns an AuthError. It behooves the user of this library to check this return value and overreact on error.

pub fn ratchet(&mut self, num_bytes_to_zero: usize, more: bool)

Ratchets the internal state forward in an irreversible way by zeroing bytes.

Takes a usize argument specifying the number of bytes of public state to zero. If the size exceeds self.rate, Keccak-f will be called before more bytes are zeroed.

pub fn meta_ratchet(&mut self, num_bytes_to_zero: usize, more: bool)

Ratchets the internal state forward in an irreversible way by zeroing bytes.

Takes a usize argument specifying the number of bytes of public state to zero. If the size exceeds self.rate, Keccak-f will be called before more bytes are zeroed.

pub fn send_enc(&mut self, data: &mut [u8], more: bool)

Sends an encrypted message.

pub fn meta_send_enc(&mut self, data: &mut [u8], more: bool)

Sends an encrypted message.

pub fn recv_enc(&mut self, data: &mut [u8], more: bool)

Receives an encrypted message.

pub fn meta_recv_enc(&mut self, data: &mut [u8], more: bool)

Receives an encrypted message.

pub fn send_mac(&mut self, data: &mut [u8], more: bool)

Sends a MAC of the internal state. The output is independent of the initial contents of the input buffer.

pub fn meta_send_mac(&mut self, data: &mut [u8], more: bool)

Sends a MAC of the internal state. The output is independent of the initial contents of the input buffer.

pub fn prf(&mut self, data: &mut [u8], more: bool)

Extracts pseudorandom data as a function of the internal state. The output is independent of the initial contents of the input buffer.

pub fn meta_prf(&mut self, data: &mut [u8], more: bool)

Extracts pseudorandom data as a function of the internal state. The output is independent of the initial contents of the input buffer.

pub fn send_clr(&mut self, data: &[u8], more: bool)

Sends a plaintext message.

pub fn meta_send_clr(&mut self, data: &[u8], more: bool)

Sends a plaintext message.

pub fn recv_clr(&mut self, data: &[u8], more: bool)

Receives a plaintext message.

pub fn meta_recv_clr(&mut self, data: &[u8], more: bool)

Receives a plaintext message.

pub fn ad(&mut self, data: &[u8], more: bool)

Mixes associated data into the internal state.

pub fn meta_ad(&mut self, data: &[u8], more: bool)

Mixes associated data into the internal state.

pub fn key(&mut self, data: &[u8], more: bool)

Sets a symmetric cipher key.

pub fn meta_key(&mut self, data: &[u8], more: bool)

Sets a symmetric cipher key.

Trait Implementations

impl Clone for Strobe

fn clone(&self) -> Strobe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Strobe

fn drop(&mut self)

Executes the destructor for this type.

impl ZeroizeOnDrop for Strobe