Skip to main content

ProofRequest

Struct ProofRequest 

Source
pub struct ProofRequest {
    pub id: String,
    pub version: RequestVersion,
    pub created_at: u64,
    pub expires_at: u64,
    pub rp_id: RpId,
    pub oprf_key_id: OprfKeyId,
    pub session_id: Option<FieldElement>,
    pub action: Option<FieldElement>,
    pub signature: Signature,
    pub nonce: FieldElement,
    pub requests: Vec<RequestItem>,
    pub constraints: Option<ConstraintExpr<'static>>,
}
Expand description

A proof request from a Relying Party (RP) for an Authenticator.

Fields§

§id: String

Unique identifier for this request.

§version: RequestVersion

Version of the request.

§created_at: u64

Unix timestamp (seconds) when the request was created.

§expires_at: u64

Unix timestamp (seconds) when the request expires.

§rp_id: RpId

Registered RP identifier from the RpRegistry.

§oprf_key_id: OprfKeyId

OprfKeyId of the RP.

§session_id: Option<FieldElement>

Session identifier that links proofs for the same user/RP pair across requests.

If provided, a Session Proof will be generated instead of a Uniqueness Proof. The proof will only be valid if the session ID is meant for this context and this particular World ID holder.

§action: Option<FieldElement>

An RP-defined context that scopes what the user is proving uniqueness on.

This parameter expects a field element. When dealing with strings or bytes, hash with a byte-friendly hash function like keccak256 or SHA256 and reduce to the field.

§signature: Signature

The RP’s ECDSA signature over the request.

§nonce: FieldElement

Unique nonce for this request provided by the RP.

§requests: Vec<RequestItem>

Specific credential requests. This defines which credentials to ask for.

§constraints: Option<ConstraintExpr<'static>>

Constraint expression (all/any/enumerate) optional.

Implementations§

Source§

impl ProofRequest

Source

pub fn credentials_to_prove( &self, available: &HashSet<u64>, ) -> Option<Vec<&RequestItem>>

Determine which requested credentials to prove given available credentials.

Returns None if constraints (or lack thereof) cannot be satisfied with the available set.

§Panics

Panics if constraints are present but invalid according to the type invariants (this should not occur as constraints are provided by trusted request issuer).

Source

pub fn find_request_by_issuer_schema_id( &self, issuer_schema_id: u64, ) -> Option<&RequestItem>

Find a request item by issuer schema ID if available

Source

pub const fn is_expired(&self, now: u64) -> bool

Returns true if the request is expired relative to now (unix timestamp in seconds)

Source

pub fn digest_hash(&self) -> Result<[u8; 32], PrimitiveError>

Compute the digest hash of this request that should be signed by the RP, which right now includes the nonce and the timestamp of the request.

§Returns

A 32-byte hash that represents this request and should be signed by the RP.

§Errors

Returns a PrimitiveError if FieldElement serialization fails (which should never occur in practice).

The digest is computed as: SHA256(nonce || action || created_at || expires_at). This mirrors the RP signature message format from rp::compute_rp_signature_msg. Note: the timestamp is encoded as big-endian to mirror the RP-side signing performed in test fixtures and the OPRF stub.

Source

pub fn computed_action<R: CryptoRng + RngCore>( &self, rng: &mut R, ) -> FieldElement

Gets the action value to use in the proof.

  • When an explicit action is provided, it is returned directly.
  • For session proofs (action is None), a random action is generated.

Callers should cache the action during proof generation to ensure consistency across proof steps.

Source

pub fn validate_response( &self, response: &ProofResponse, ) -> Result<(), ValidationError>

Validate that a response satisfies this request: id match and constraints semantics.

§Errors

Returns a ValidationError if the response does not correspond to this request or does not satisfy the declared constraints.

Source

pub fn from_json(json: &str) -> Result<Self, Error>

Parse from JSON

§Errors

Returns an error if the JSON is invalid or contains duplicate issuer schema ids.

Source

pub fn to_json(&self) -> Result<String, Error>

Serialize to JSON

§Errors

Returns an error if serialization unexpectedly fails.

Source

pub fn to_json_pretty(&self) -> Result<String, Error>

Serialize to pretty JSON

§Errors

Returns an error if serialization unexpectedly fails.

Trait Implementations§

Source§

impl Clone for ProofRequest

Source§

fn clone(&self) -> ProofRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProofRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ProofRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ProofRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ProofRequest

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ProofRequest

Source§

impl StructuralPartialEq for ProofRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

Source§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

Source§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

Source§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,