Struct orizentic::OrizenticCtx

pub struct OrizenticCtx(_, _);

The Orizentic Context encapsulates a set of claims and an associated secret. This provides the overall convenience of easily creating and validating tokens. Generated claimsets are stored here on the theory that, even with validation, only those claims actually stored in the database should be considered valid.

Methods

impl OrizenticCtx

pub fn new(secret: Secret, claims_lst: Vec<ClaimSet>) -> OrizenticCtx

Create a new Orizentic Context with an initial set of claims.

pub fn validate_token(
    &self,
    token: &UnverifiedToken
) -> Result<VerifiedToken, Error>

Validate a token by checking its signature, that it is not expired, and that it is still present in the database. Return an error if any check fails, but return a VerifiedToken if it all succeeds.

pub fn decode_and_validate_text(
    &self,
    text: &String
) -> Result<VerifiedToken, Error>

Given a text string, as from a web application's Authorization header, decode the string and then validate the token.

pub fn add_claimset(&mut self, claimset: ClaimSet)

Add a claimset to the database.

pub fn revoke_claimset(&mut self, claim: &ClaimSet)

Remove a claims set from the database so that all additional validation checks fail.

pub fn revoke_by_uuid(&mut self, claim_id: &String)

Revoke a ClaimsSet given its ID, which is set in the jti claim of a JWT or the id field of a ClaimSet.

pub fn replace_claimsets(&mut self, _claims_lst: Vec<ClaimSet>)

NOT IMPLEMENTED

pub fn list_claimsets(&self) -> Vec<&ClaimSet>

List all of the ClaimSet IDs in the database.

pub fn find_claimset(&self, claims_id: &String) -> Option<&ClaimSet>

Find a ClaimSet by ID.

pub fn encode_claimset(&self, claims: &ClaimSet) -> Result<VerifiedToken, Error>

Encode and sign a claimset, returning the result as a VerifiedToken.