Struct oxide_auth::primitives::generator::Assertion

pub struct Assertion { /* fields omitted */ }

Generates tokens by signing its specifics with a private key.

Tokens produced by the generator include a serialized version of the grant followed by an HMAC signature. Since data is not encrypted, this token generator will ERROR if any private extension is present in the grant.

The actual generator is given by a TaggedAssertion from Assertion::tag which enables signing the same grant for different uses, i.e. separating authorization from bearer grants and refresh tokens.

Methods

impl Assertion

pub fn new<S: Into<Self>>(secret: S) -> Self

Construct an assertion from one of the possible secrets.

Conversion is done via the Into trait so that new secrets can be added in a backwards compatible way while outdated secrets can be removed with as few breakage as possible. This will hopefully allow us to partially transition to an upgraded version of ring at some point in the nearer future.

pub fn ephermal() -> Assertion

Construct an assertion instance whose tokens are only valid for the program execution.

pub fn tag<'a>(&'a self, tag: &'a str) -> TaggedAssertion<'a>

Get a reference to generator for the given tag.

Trait Implementations

impl TagGrant for Assertion

fn tag(&mut self, counter: u64, grant: &Grant) -> Result<String, ()>

For example sign the input parameters or generate a random token.

impl<'a> TagGrant for &'a Assertion

fn tag(&mut self, counter: u64, grant: &Grant) -> Result<String, ()>

For example sign the input parameters or generate a random token.

impl From<SigningKey> for Assertion

fn from(secret: SigningKey) -> Self

Convert to an Assertion from a secret signing key.