Struct biscuit_auth::token::verifier::Verifier

pub struct Verifier { /* fields omitted */ }

used to check authorization policies on a token

can be created from Biscuit::verify or Verifier::new

Implementations

impl Verifier

pub fn new() -> Result<Self, Logic>

creates a new empty verifier

this can be used to check policies when:

• there is no token (unauthenticated case)
• there is a lot of data to load in the verifier on each check

In the latter case, we can create an empty verifier, load it with the facts, rules and checks, and each time a token must be checked, clone the verifier and load the token with Verifier::add_token

pub fn from(slice: &[u8]) -> Result<Self, Token>

pub fn save(&self) -> Result<Vec<u8>, Token>

pub fn add_token(
    &mut self,
    token: &Biscuit,
    root: PublicKey
) -> Result<(), Token>

Loads a token’s facts, rules and checks in a verifier

pub fn add_fact<F: TryInto<Fact>>(&mut self, fact: F) -> Result<(), Token>

add a fact to the verifier

pub fn add_rule<R: TryInto<Rule>>(&mut self, rule: R) -> Result<(), Token>

add a rule to the verifier

pub fn query<R: TryInto<Rule>, T: TryFrom<Fact, Error = E>, E: Into<Token>>(
    &mut self,
    rule: R
) -> Result<Vec<T>, Token>

run a query over the verifier’s Datalog engine to gather data

pub fn query_with_limits<R: TryInto<Rule>, T: TryFrom<Fact, Error = E>, E: Into<Token>>(
    &mut self,
    rule: R,
    limits: VerifierLimits
) -> Result<Vec<T>, Token>

run a query over the verifier’s Datalog engine to gather data

this method can specify custom runtime limits

pub fn add_check<R: TryInto<Check>>(&mut self, check: R) -> Result<(), Token>

add a check to the verifier

pub fn add_resource(&mut self, resource: &str)

pub fn add_operation(&mut self, operation: &str)

pub fn set_time(&mut self)

adds a fact with the current time

pub fn revocation_check(&mut self, ids: &[i64])

pub fn add_policy<R: TryInto<Policy>>(&mut self, policy: R) -> Result<(), Token>

add a policy to the verifier

pub fn allow(&mut self) -> Result<(), Token>

pub fn deny(&mut self) -> Result<(), Token>

pub fn verify(&mut self) -> Result<usize, Token>

checks all the checks

on error, this can return a list of all the failed checks on success, it returns the index of the policy that matched

pub fn verify_with_limits(
    &mut self,
    limits: VerifierLimits
) -> Result<usize, Token>

checks all the checks

on error, this can return a list of all the failed checks

this method can specify custom runtime limits

pub fn print_world(&self) -> String

prints the content of the verifier

pub fn dump(&self) -> (Vec<Fact>, Vec<Rule>, Vec<Check>)

returns all of the data loaded in the verifier

Trait Implementations

impl Clone for Verifier

fn clone(&self) -> Verifier

Returns a copy of the value.

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

Performs copy-assignment from source.