Struct Secret 

pub struct Secret<S: Suite> { /* private fields */ }

Secret key for VRF operations.

Contains the private scalar and cached public key. Implements automatic zeroization on drop. The Debug output redacts the scalar, and equality is evaluated in constant time.

Implementations

impl<S: Suite> Secret<S>

pub fn from_scalar(scalar: ScalarField<S>) -> Self

Construct a Secret from the given scalar.

pub fn from_seed(seed: [u8; 32]) -> Self

Derives a Secret scalar deterministically from a seed.

The seed is hashed using the suite’s transcript, and the output is reduced modulo the curve’s order to produce a valid scalar in the range [1, n - 1]. No clamping or multiplication by the cofactor is performed, regardless of the curve.

The caller is responsible for ensuring that the resulting scalar is used safely with respect to the target curve’s cofactor and subgroup properties.

pub fn from_rand(rng: &mut impl RngCore) -> Self

Construct an ephemeral Secret using the provided randomness source.

pub fn scalar(&self) -> &ScalarField<S>

Get the secret scalar.

pub fn public(&self) -> Public<S>

Get the associated public key.

pub fn output(&self, input: Input<S>) -> Output<S>

Get the VRF output point relative to input.

pub fn vrf_io(&self, input: Input<S>) -> VrfIo<S>

Get the VRF input-output pair relative to input.

Trait Implementations

impl<S: Suite> CanonicalDeserialize for Secret<S>

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

The general deserialize method that takes in customization flags.

fn deserialize_compressed<R>(reader: R) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the compressed form if applicable. Performs validation if applicable.

fn deserialize_compressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the compressed form if applicable, without validating the deserialized value.

fn deserialize_uncompressed<R>(reader: R) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the uncompressed form. Performs validation if applicable.

fn deserialize_uncompressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>

where R: Read,

Reads Self from reader using the uncompressed form, without validating the deserialized value.

impl<S: Suite> CanonicalSerialize for Secret<S>

fn serialize_with_mode<W: Write>( &self, writer: W, compress: Compress, ) -> Result<(), SerializationError>

The general serialize method that takes in customization flags.

fn serialized_size(&self, compress: Compress) -> usize

Returns the size in bytes of the serialized version of self with the given compression mode.

fn serialize_compressed<W>(&self, writer: W) -> Result<(), SerializationError>

where W: Write,

Serializes self into writer using the compressed form if applicable.

fn compressed_size(&self) -> usize

Returns the size in bytes of the compressed serialized version of self.

fn serialize_uncompressed<W>(&self, writer: W) -> Result<(), SerializationError>

where W: Write,

Serializes self into writer using the uncompressed form.

fn uncompressed_size(&self) -> usize

Returns the size in bytes of the uncompressed serialized version of self.

impl<S: Clone + Suite> Clone for Secret<S>

fn clone(&self) -> Secret<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Suite> Debug for Secret<S>

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

Formats the value using the given formatter.

impl<S: Suite> Drop for Secret<S>

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<S: Suite> PartialEq for Secret<S>

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

Timing does not depend on the scalars content or on where they differ.

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

Inequality operator !=.

impl<S: PedersenSuite> Prover<S> for Secret<S>

fn prove( &self, ios: impl AsRef<[VrfIo<S>]>, ad: impl AsRef<[u8]>, ) -> (Proof<S>, ScalarField<S>)

Generate a proof for the given VRF I/O pairs and additional data.

impl<S: ThinSuite> Prover<S> for Secret<S>

fn prove(&self, ios: impl AsRef<[VrfIo<S>]>, ad: impl AsRef<[u8]>) -> Proof<S>

Generate a proof for the given VRF I/O pairs and additional data.

impl<S: TinySuite> Prover<S> for Secret<S>

fn prove(&self, ios: impl AsRef<[VrfIo<S>]>, ad: impl AsRef<[u8]>) -> Proof<S>

Tiny VRF proving algorithm.

Prepends the Schnorr pair (G, Y) to the I/O list and proves a single DLEQ on the delinearized merged pair:

1. Generate a deterministic nonce k
2. Compute nonce commitment R = k * I_m
3. Compute the challenge c
4. Compute the response s = k + c * x

impl<S: RingSuite> Prover<S> for Secret<S>

fn prove( &self, ios: impl AsRef<[VrfIo<S>]>, ad: impl AsRef<[u8]>, ring_prover: &RingProver<S>, ) -> Proof<S>

Generate a proof for the given VRF I/O pairs and additional data.

impl<S: Suite> Valid for Secret<S>

fn check(&self) -> Result<(), SerializationError>

Checks whether self is valid. If self is valid, returns Ok(()). Otherwise, returns an error describing the failure. This method is called by deserialize_with_mode if validate is Validate::Yes.

const TRIVIAL_CHECK: bool = false

Whether the check method is trivial (i.e. always returns Ok(())). If this is true, the batch_check method will skip all checks and return Ok(()). This should be set to true for types where check is trivial, e.g. integers, field elements, etc. This is false by default. This is primarily an optimization to skip unnecessary checks in batch_check.

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

Checks whether all items in batch are valid. If all items are valid, returns Ok(()). Otherwise, returns an error describing the first failure.