Struct biscuit::ValidationOptions

pub struct ValidationOptions {
    pub claim_presence_options: ClaimPresenceOptions,
    pub temporal_options: TemporalOptions,
    pub issued_at: Validation<Duration>,
    pub not_before: Validation<()>,
    pub expiry: Validation<()>,
    pub issuer: Validation<StringOrUri>,
    pub audience: Validation<StringOrUri>,
}

Options for claims validation

If a claim is missing, it passes validation unless the claim is marked as required within the claim_presence_options.

By default, no claims are required. If there are present, only expiry-related claims are validated (namely exp, nbf, iat) with zero epsilon and maximum age duration.

Should any temporal claims be required, set the appropriate fields.

To deal with clock drifts, you might want to provide an epsilon error margin in the form of a std::time::Duration to allow time comparisons to fall within the margin.

Fields

claim_presence_options: ClaimPresenceOptions

Claims marked as required will trigger a validation failure if they are missing

temporal_options: TemporalOptions

Define how to validate temporal claims

issued_at: Validation<Duration>

Validation options for iat or Issued At claim if present Parameter shows the maximum age of a token to be accepted, use Duration::max_value() if you do not want to skip validating the age of the token, and only validate it was not issued in the future

not_before: Validation<()>

Validation options for nbf or Not Before claim if present

expiry: Validation<()>

Validation options for exp or Expiry claim if present

issuer: Validation<StringOrUri>

Validation options for iss or Issuer claim if present Parameter must match the issuer in the token exactly.

audience: Validation<StringOrUri>

Validation options for aud or Audience claim if present Token must include an audience with the value of the parameter

Trait Implementations

impl Clone for ValidationOptions

fn clone(&self) -> ValidationOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ValidationOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<ValidationOptions> for ValidationOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ValidationOptions

impl StructuralEq for ValidationOptions

impl StructuralPartialEq for ValidationOptions