Skip to main content

SiwxProof

Struct SiwxProof 

Source
pub struct SiwxProof {
Show 15 fields pub address: CompactString, pub signature: CompactString, pub domain: CompactString, pub uri: CompactString, pub version: CompactString, pub nonce: CompactString, pub issued_at: CompactString, pub expiration_time: Option<CompactString>, pub not_before: Option<CompactString>, pub statement: Option<CompactString>, pub request_id: Option<CompactString>, pub resources: Vec<CompactString>, pub chain_id: CompactString, pub signature_type: CompactString, pub signature_scheme: Option<CompactString>,
}
Available on crate features server and siwx only.
Expand description

Client proof carried on SIGN-IN-WITH-X (base64 JSON).

Fields§

§address: CompactString

Wallet address that signed the message.

§signature: CompactString

Cryptographic signature (hex for EVM, Base58 for Solana).

§domain: CompactString

CAIP-122 domain.

§uri: CompactString

Resource URI.

§version: CompactString

CAIP-122 version (always "1").

§nonce: CompactString

Challenge nonce (32 hex).

§issued_at: CompactString

ISO 8601 issuedAt as sent by the client (signing-string form).

§expiration_time: Option<CompactString>

Optional ISO 8601 expiry, original string.

§not_before: Option<CompactString>

Optional ISO 8601 not-before, original string.

§statement: Option<CompactString>

Optional CAIP-122 statement.

§request_id: Option<CompactString>

Optional request id.

§resources: Vec<CompactString>

Optional resource URIs.

§chain_id: CompactString

CAIP-2 chain identifier.

§signature_type: CompactString

Signature algorithm (eip191 / ed25519).

§signature_scheme: Option<CompactString>

Spec signatureScheme hint, if the client sent one.

Implementations§

Source§

impl SiwxProof

Source

pub fn parse_header(value: &str) -> Result<SiwxProof, SiwxProofError>

Decodes a SIGN-IN-WITH-X header value.

§Errors

SiwxProofError when the header is not base64 JSON with the required string fields, or version is not "1".

Source

pub fn bind_origin( &self, origin: &SiwxOrigin, path: &str, ) -> Result<(), SiwxError>

Checks domain / uri against the configured origin. Never uses Host.

§Errors

SiwxError::DomainMismatch or SiwxError::UriMismatch.

Source

pub fn validate_at( &self, origin: &SiwxOrigin, path: &str, now: OffsetDateTime, ) -> Result<(), SiwxError>

Origin, URI, and temporal checks. now is injectable for tests.

§Errors

Spec invalid_siwx_* field codes.

Source

pub fn signing_message(&self) -> Result<String, SiwxError>

Canonical CAIP-122 signing string for this proof’s fields.

Renders via EvmVerifier::format_message / Ed25519Verifier::format_message. Timestamp fields are passed through *_raw so the original RFC 3339 bytes are hashed.

§Errors

SiwxError::ChainId, SiwxError::UnsupportedChain, or a field error when the proof cannot be turned into a SiwxMessage.

Source

pub async fn verify_at( &self, origin: &SiwxOrigin, path: &str, now: OffsetDateTime, evm: &EvmVerifier, ) -> Result<(), SiwxError>

Field validation plus CAIP-122 signature verification at now.

§Errors

Spec invalid_siwx_* codes.

Source

pub async fn verify( &self, origin: &SiwxOrigin, path: &str, ) -> Result<(), SiwxError>

Self::verify_at with the current UTC time and EvmVerifier::new.

§Errors

Spec invalid_siwx_* codes.

Source

pub fn encode_header(&self) -> Result<String, SiwxProofError>

Encodes this proof as a SIGN-IN-WITH-X header value (base64 JSON).

§Errors

SiwxProofError::InvalidJson when the proof cannot be serialized.

Trait Implementations§

Source§

impl Clone for SiwxProof

Source§

fn clone(&self) -> SiwxProof

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SiwxProof

Source§

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

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

impl Eq for SiwxProof

Source§

impl PartialEq for SiwxProof

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SiwxProof

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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