Struct jsonwebtokens::VerifierBuilder

pub struct VerifierBuilder { /* private fields */ }

Configures the requirements for checking token claims with a builder-pattern API

Implementations

impl VerifierBuilder

pub fn new() -> VerifierBuilder

Examples found in repository

src/verifier.rs (line 106)

    pub fn create() -> VerifierBuilder {
        VerifierBuilder::new()
    }

pub fn issuer(&mut self, issuer: impl Into<String>) -> &mut Self

Convenience for string_equals(“iss”, “value”)

pub fn audience(&mut self, aud: impl Into<String>) -> &mut Self

Convenience for string_or_array_contains(“aud”, “value”)

pub fn subject(&mut self, sub: impl Into<String>) -> &mut Self

Convenience for string_equals(“sub”, “value”)

pub fn nonce(&mut self, nonce: impl Into<String>) -> &mut Self

Convenience for string_equals(“nonce”, “value”)

pub fn string_equals(
    &mut self,
    claim: impl Into<String>,
    value: impl Into<String>
) -> &mut Self

Check that a claim has a specific string value

Examples found in repository

src/verifier.rs (line 421)

    pub fn issuer(&mut self, issuer: impl Into<String>) -> &mut Self {
        self.string_equals("iss", issuer)
    }

    /// Convenience for string_or_array_contains("aud", "value")
    pub fn audience(&mut self, aud: impl Into<String>) -> &mut Self {
        self.string_or_array_contains("aud", aud)
    }

    /// Convenience for string_equals("sub", "value")
    pub fn subject(&mut self, sub: impl Into<String>) -> &mut Self {
        self.string_equals("sub", sub)
    }

    /// Convenience for string_equals("nonce", "value")
    pub fn nonce(&mut self, nonce: impl Into<String>) -> &mut Self {
        self.string_equals("nonce", nonce)
    }

pub fn string_equals_one_of(
    &mut self,
    claim: impl Into<String>,
    values: &[&str]
) -> &mut Self

Check that a claim equals one of the given string values

pub fn string_matches(
    &mut self,
    claim: impl Into<String>,
    value: impl Into<Regex>
) -> &mut Self

Check that the claim matches the given regular expression

pub fn string_matches_one_of(
    &mut self,
    claim: impl Into<String>,
    values: &[Regex]
) -> &mut Self

Check that the claim matches one of the given regular expressions

pub fn string_or_array_contains(
    &mut self,
    claim: impl Into<String>,
    value: impl Into<String>
) -> &mut Self

Examples found in repository

src/verifier.rs (line 426)

    pub fn audience(&mut self, aud: impl Into<String>) -> &mut Self {
        self.string_or_array_contains("aud", aud)
    }

pub fn leeway(&mut self, leeway: u32) -> &mut Self

Sets a leeway (in seconds) should be allowed when checking exp, nbf and iat claims

pub fn ignore_exp(&mut self) -> &mut Self

Don’t check the ‘exp’ expiry claim

pub fn ignore_nbf(&mut self) -> &mut Self

Don’t check the ‘nbf’ not before claim

pub fn ignore_iat(&mut self) -> &mut Self

Don’t check the ‘iat’ issued at claim

pub fn claim_callback(
    &mut self,
    claim: impl Into<String>,
    func: impl Send + Sync + Fn(&Value) -> bool + 'static
) -> &mut Self

Check a claim Value manually, returning true if ok, else false

pub fn build(&self) -> Result<Verifier, Error>

Build the final Verifier

Trait Implementations

impl Debug for VerifierBuilder

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

Formats the value using the given formatter.

impl Default for VerifierBuilder

fn default() -> VerifierBuilder

Returns the “default value” for a type.