Struct VoprfServer 

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

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

Implementations

impl<CS: CipherSuite> VoprfServer<CS>

pub fn serialize(&self) -> Array<u8, VoprfServerLen<CS>>

Serialization into bytes

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

Deserialization from bytes

Errors

Error::Deserialization if failed to deserialize input.

impl<CS: CipherSuite> VoprfServer<CS>

pub fn new<R: TryRng + TryCryptoRng>(rng: &mut R) -> Result<Self>

Produces a new instance of a VoprfServer using a supplied RNG

Errors

Error::Protocol if the protocol fails and can’t be completed.

pub fn new_with_key(key: &[u8]) -> Result<Self>

Produces a new instance of a VoprfServer using a supplied set of bytes to represent the server’s private key

Errors

Error::Deserialization if the private key is not a valid point on the group or zero.

pub fn new_from_seed(seed: &[u8], info: &[u8]) -> Result<Self>

Produces a new instance of a VoprfServer using a supplied set of bytes which are used as a seed to derive the server’s private key.

Corresponds to DeriveKeyPair() function from the VOPRF specification.

Errors

• Error::DeriveKeyPair if the input and seed together are longer then u16::MAX - 3.
• Error::Protocol if the protocol fails and can’t be completed.

pub fn blind_evaluate<R: TryRng + TryCryptoRng>( &self, rng: &mut R, blinded_element: &BlindedElement<CS>, ) -> VoprfServerEvaluateResult<CS>

Computes the second step for the multiplicative blinding version of DH-OPRF. This message is sent from the server (who holds the OPRF key) to the client.

pub fn batch_blind_evaluate<'a, R: TryRng + TryCryptoRng, I>( &self, rng: &mut R, blinded_elements: &'a I, ) -> Result<VoprfServerBatchEvaluateResult<CS>>

where CS: 'a, &'a I: IntoIterator<Item = &'a BlindedElement<CS>>, <&'a I as IntoIterator>::IntoIter: ExactSizeIterator,

Available on crate feature alloc only.

Allows for batching of the evaluation of multiple BlindedElement messages from a VoprfClient

Errors

Error::Batch if the number of blinded_elements and evaluation_elements don’t match or is longer then u16::MAX

pub fn batch_blind_evaluate_prepare<'a, I: Iterator<Item = &'a BlindedElement<CS>>>( &self, blinded_elements: I, ) -> VoprfServerBatchEvaluatePreparedEvaluationElements<CS, I>

where CS: 'a,

Alternative version of batch_blind_evaluate without memory allocation. Returned PreparedEvaluationElement have to be collected and passed into batch_blind_evaluate_finish.

pub fn batch_blind_evaluate_finish<'a, 'b, R: TryRng + TryCryptoRng, IB: Iterator<Item = &'a BlindedElement<CS>> + ExactSizeIterator, IE>( &self, rng: &mut R, blinded_elements: IB, evaluation_elements: &'b IE, ) -> Result<VoprfServerBatchEvaluateFinishResult<'b, CS, IE>>

where CS: 'a + 'b, &'b IE: IntoIterator<Item = &'b PreparedEvaluationElement<CS>>, <&'b IE as IntoIterator>::IntoIter: ExactSizeIterator,

See batch_blind_evaluate_prepare for more details.

Errors

Error::Batch if the number of blinded_elements and evaluation_elements don’t match or is longer then u16::MAX

pub fn evaluate( &self, input: &[u8], ) -> Result<Output<<CS as CipherSuite>::Hash>>

Computes the output of the POPRF on the server side

Errors

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

pub fn get_public_key(&self) -> <CS::Group as Group>::Elem

Retrieves the server’s public key

Trait Implementations

impl<CS: CipherSuite> Clone for VoprfServer<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 VoprfServer<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 VoprfServer<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 VoprfServer<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 VoprfServer<CS>

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

impl<CS: CipherSuite> Hash for VoprfServer<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 VoprfServer<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 VoprfServer<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 VoprfServer<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 VoprfServer<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 VoprfServer<CS>