Struct OprfClient

pub struct OprfClient<CS: CipherSuite>
where
    <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,
{ /* private fields */ }

A client which engages with a OprfServer in base mode, meaning that the OPRF outputs are not verifiable.

Implementations

impl<CS: CipherSuite> OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,

pub fn blind<R: RngCore + CryptoRng>( input: &[u8], blinding_factor_rng: &mut R, ) -> Result<OprfClientBlindResult<CS>>

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

Errors

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

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

Available on crate feature 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!

Errors

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

pub fn finalize( &self, input: &[u8], evaluation_element: &EvaluationElement<CS>, ) -> Result<Output<CS::Hash>>

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

Errors

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

pub fn get_blind(&self) -> <CS::Group as Group>::Scalar

Available on crate feature danger only.

Exposes the blind group element

impl<CS: CipherSuite> OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,

pub fn serialize(&self) -> GenericArray<u8, OprfClientLen<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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,

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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>, <CS::Group as Group>::Scalar: Debug,

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

Formats the value using the given formatter.

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

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,

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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,

fn drop(&mut self)

Executes the destructor for this type.

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

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>, <CS::Group as Group>::Scalar: 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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>, <CS::Group as Group>::Scalar: 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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>, <CS::Group as Group>::Scalar: 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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>, <CS::Group as Group>::Scalar: 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 OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,

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> Eq for OprfClient<CS>

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>, <CS::Group as Group>::Scalar: Eq,

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

where <CS::Hash as OutputSizeUser>::OutputSize: IsLess<U256> + IsLessOrEqual<<CS::Hash as BlockSizeUser>::BlockSize>,