Struct PoprfClient 

pub struct PoprfClient<CS: CipherSuite> { /* private fields */ }

A client which engages with a PoprfServer in verifiable mode, meaning that the OPRF outputs can be checked against a server public key.

Implementations

impl<CS: CipherSuite> PoprfClient<CS>

pub fn blind<R: TryRng + TryCryptoRng>( input: &[u8], blinding_factor_rng: &mut R, ) -> Result<PoprfClientBlindResult<CS>>

Computes the first step for the multiplicative blinding version of DH-OPRF.

Errors

• Error::Input if the input is empty or longer than u16::MAX.
• Error::Rng if the random number generator fails.

pub fn deterministic_blind_unchecked( input: &[u8], blind: <CS::Group as Group>::Scalar, ) -> Result<PoprfClientBlindResult<CS>>

Available on crate features danger only.

Computes the first step for the multiplicative blinding version of DH-OPRF, taking a blinding factor scalar as input instead of sampling from an RNG.

Caution

This should be used with caution, since it does not perform any checks on the validity of the blinding factor! In particular, a zero blind has no multiplicative inverse: a later finalize will then panic on prime-order curves and produce a degenerate (identity) output on Ristretto255. Only pass a blind known to be a non-zero scalar.

Errors

Error::Input if the input is empty or longer than u16::MAX.

pub fn finalize( &self, input: &[u8], evaluation_element: &EvaluationElement<CS>, proof: &Proof<CS>, pk: <CS::Group as Group>::Elem, info: Option<&[u8]>, ) -> Result<Output<CS::Hash>>

where <<CS as CipherSuite>::Hash as OutputSizeUser>::OutputSize: ArrayLength,

Computes the third step for the multiplicative blinding version of DH-OPRF, in which the client unblinds the server’s message.

Errors

• Error::Info if the info is longer than u16::MAX.
• Error::Input if the input is empty or longer than u16::MAX.
• Error::Protocol if the protocol fails and can’t be completed.
• Error::ProofVerification if the proof failed to verify.

pub fn batch_finalize<'a, II: 'a + Iterator<Item = &'a [u8]> + ExactSizeIterator, IC, IM>( inputs: II, clients: &'a IC, messages: &'a IM, proof: &Proof<CS>, pk: <CS::Group as Group>::Elem, info: Option<&'a [u8]>, ) -> Result<PoprfClientBatchFinalizeResult<'a, CS, II, IC, IM>>

where CS: 'a, &'a IC: 'a + IntoIterator<Item = &'a PoprfClient<CS>>, <&'a IC as IntoIterator>::IntoIter: ExactSizeIterator, &'a IM: 'a + IntoIterator<Item = &'a EvaluationElement<CS>>, <&'a IM as IntoIterator>::IntoIter: ExactSizeIterator, <<CS as CipherSuite>::Hash as OutputSizeUser>::OutputSize: ArrayLength,

Allows for batching of the finalization of multiple PoprfClient and EvaluationElement pairs

Errors

• Error::Info if the info is longer than u16::MAX.
• Error::Protocol if the protocol fails and can’t be completed.
• Error::Batch if the number of inputs, clients and messages don’t match or is longer than u16::MAX.
• Error::ProofVerification if the proof failed to verify.

The resulting messages can each fail individually with Error::Input if the input is empty or longer than u16::MAX.

impl<CS: CipherSuite> PoprfClient<CS>

pub fn serialize(&self) -> GenericArray<u8, PoprfClientLen<CS>>

Serialization into bytes

pub fn deserialize(input: &[u8]) -> Result<Self>

Deserialization from bytes

Errors

Error::Deserialization if failed to deserialize input.

Trait Implementations

impl<CS: CipherSuite> Clone for PoprfClient<CS>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<CS: CipherSuite> Debug for PoprfClient<CS>

where <CS::Group as Group>::Scalar: Debug, <CS::Group as Group>::Elem: Debug,

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

Formats the value using the given formatter.

impl<'de, CS: CipherSuite> Deserialize<'de> for PoprfClient<CS>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<CS: CipherSuite> Drop for PoprfClient<CS>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<CS: CipherSuite> Eq for PoprfClient<CS>

where <CS::Group as Group>::Scalar: Eq, <CS::Group as Group>::Elem: Eq,

impl<CS: CipherSuite> Hash for PoprfClient<CS>

where <CS::Group as Group>::Scalar: Hash, <CS::Group as Group>::Elem: Hash,

fn hash<__H: Hasher>(&self, __state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<CS: CipherSuite> Ord for PoprfClient<CS>

where <CS::Group as Group>::Scalar: Ord, <CS::Group as Group>::Elem: Ord,

fn cmp(&self, __other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<CS: CipherSuite> PartialEq for PoprfClient<CS>

where <CS::Group as Group>::Scalar: PartialEq, <CS::Group as Group>::Elem: PartialEq,

fn eq(&self, __other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<CS: CipherSuite> PartialOrd for PoprfClient<CS>

where <CS::Group as Group>::Scalar: PartialOrd, <CS::Group as Group>::Elem: PartialOrd,

fn partial_cmp(&self, __other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<CS: CipherSuite> Serialize for PoprfClient<CS>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<CS: CipherSuite> ZeroizeOnDrop for PoprfClient<CS>