Struct nimue::IOPattern

pub struct IOPattern<H = DefaultHash, U = u8>
where
    U: Unit,
    H: DuplexHash<U>,
{ /* private fields */ }

The IO Pattern of an interactive protocol.

An IO pattern is a string that specifies the protocol in a simple, non-ambiguous, human-readable format. A typical example is the following:

    domain-separator A32generator A32public-key R A32commitment S32challenge A32response

The domain-separator is a user-specified string uniquely identifying the end-user application (to avoid cross-protocol attacks). The letter A indicates the absorption of a public input (an ABSORB), while the letter S indicates the squeezing (a SQUEEZE) of a challenge. The letter R indicates a ratcheting operation: ratcheting means invoking the hash function even on an incomplete block. It provides forward secrecy and allows it to start from a clean rate. After the operation type, is the number of elements in base 10 that are being absorbed/squeezed. Then, follows the label associated with the element being absorbed/squeezed. This often comes from the underlying description of the protocol. The label cannot start with a digit or contain the NULL byte.

Guarantees

The struct IOPattern guarantees the creation of a valid IO Pattern string, whose lengths are coherent with the types described in the protocol. No information about the types themselves is stored in an IO Pattern. This means that Arthur or Merlin instances can generate successfully a protocol transcript respecting the length constraint but not the types. See issue #6 for a discussion on the topic.

Implementations

impl<H: DuplexHash<U>, U: Unit> IOPattern<H, U>

pub fn new(domsep: &str) -> Self

Create a new IOPattern with the domain separator.

pub fn absorb(self, count: usize, label: &str) -> Self

Absorb count native elements.

pub fn squeeze(self, count: usize, label: &str) -> Self

Squeeze count native elements.

pub fn ratchet(self) -> Self

Ratchet the state.

pub fn as_bytes(&self) -> &[u8]

Return the IO Pattern as bytes.

pub fn to_arthur(&self) -> Arthur<H, U, DefaultRng>

Create an crate::Arthur instance from the IO Pattern.

pub fn to_merlin<'a>(&self, transcript: &'a [u8]) -> Merlin<'a, H, U>

Create a crate::Merlin instance from the IO Pattern and the protocol transcript (bytes).

Trait Implementations

impl<H: DuplexHash> ByteIOPattern for IOPattern<H>

fn add_bytes(self, count: usize, label: &str) -> Self

fn challenge_bytes(self, count: usize, label: &str) -> Self

impl<C, H, const N: usize> ByteIOPattern for IOPattern<H, Fp<C, N>>

where C: FpConfig<N>, H: DuplexHash<Fp<C, N>>,

fn add_bytes(self, count: usize, label: &str) -> Self

fn challenge_bytes(self, count: usize, label: &str) -> Self

impl<H, U> Clone for IOPattern<H, U>

where U: Unit + Clone, H: DuplexHash<U> + Clone,

fn clone(&self) -> IOPattern<H, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U: Unit, H: DuplexHash<U>> Debug for IOPattern<H, U>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F, H> FieldIOPattern<F> for IOPattern<H>

where F: PrimeField, H: DuplexHash,

fn add_scalars(self, count: usize, label: &str) -> Self

fn challenge_scalars(self, count: usize, label: &str) -> Self

impl<F, H> FieldIOPattern<F> for IOPattern<H>

where F: PrimeField, H: DuplexHash,

fn add_scalars(self, count: usize, label: &str) -> Self

fn challenge_scalars(self, count: usize, label: &str) -> Self

impl<C, H, const N: usize> FieldIOPattern<Fp<C, N>> for IOPattern<H, Fp<C, N>>

where C: FpConfig<N>, H: DuplexHash<Fp<C, N>>,

fn add_scalars(self, count: usize, label: &str) -> Self

fn challenge_scalars(self, count: usize, label: &str) -> Self

impl<G, H> GroupIOPattern<G> for IOPattern<H>

where G: Group + GroupEncoding, G::Repr: AsRef<[u8]>, H: DuplexHash,

fn add_points(self, count: usize, label: &str) -> Self

impl<G, H> GroupIOPattern<G> for IOPattern<H>

where G: CurveGroup, H: DuplexHash,

fn add_points(self, count: usize, label: &str) -> Self

impl<G, H, C, const N: usize> GroupIOPattern<G> for IOPattern<H, Fp<C, N>>

where G: CurveGroup<BaseField = Fp<C, N>>, H: DuplexHash<Fp<C, N>>, C: FpConfig<N>, IOPattern<H, Fp<C, N>>: FieldIOPattern<Fp<C, N>>,

fn add_points(self, count: usize, label: &str) -> Self