Struct relay_auth::SignedRegisterState

pub struct SignedRegisterState(/* private fields */);

An encoded and signed RegisterState.

This signature can be used by the upstream server to ensure that the downstream client did not tamper with the token without keeping state between requests. For more information, see RegisterState.

The format and contents of SignedRegisterState are intentionally opaque. Downstream clients do not need to interpret it, and the upstream can change its contents at any time. Parsing and validation is only performed on the upstream.

In the current implementation, the serialized state has the format {state}:{signature}, where each component is:

• state: A URL-safe base64 encoding of the JSON serialized RegisterState.
• signature: A URL-safe base64 encoding of the SHA512 HMAC of the encoded state.

To create a signed state, use RegisterChallenge::sign. To validate the signature and read the state, use SignedRegisterChallenge::unpack. In both cases, a secret for signing has to be supplied.

Implementations

impl SignedRegisterState

pub fn as_str(&self) -> &str

Returns the string representation of the token.

pub fn unpack( &self, secret: &[u8], max_age: Option<Duration> ) -> Result<RegisterState, UnpackError>

Unpacks the encoded state and validates the signature.

If max_age is specified, then the timestamp in the state is validated against the current time stamp. If the stored timestamp is too old, UnpackError::SignatureExpired is returned.

Trait Implementations

impl Clone for SignedRegisterState

fn clone(&self) -> SignedRegisterState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedRegisterState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignedRegisterState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SignedRegisterState

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

Formats the value using the given formatter.

impl Serialize for SignedRegisterState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.