Skip to main content

TokenOperations

Struct TokenOperations 

Source
pub struct TokenOperations<'a> { /* private fields */ }
Expand description

Focused token-management operations exposed from AuthFramework::tokens.

§Example

// Issue a JWT token
let token = auth.tokens().create("user-123", &["read"], "jwt", None).await?;

// Validate
assert!(auth.tokens().validate(&token).await?);

// Refresh
let new_token = auth.tokens().refresh(&token).await?;

// Revoke
auth.tokens().revoke(&new_token).await?;

Implementations§

Source§

impl TokenOperations<'_>

Source

pub async fn create<I, S>( &self, user_id: impl Into<String>, scopes: I, method_name: impl Into<String>, lifetime: Option<Duration>, ) -> Result<AuthToken>
where I: IntoIterator<Item = S>, S: AsRef<str>,

Create a new authentication token for a user.

scopes accepts any iterator of string-like values, so all of these work:

// Vec<String>
tokens.create("uid", vec!["read".into()], "jwt", None).await?;
// Slice of &str
tokens.create("uid", &["read", "write"], "jwt", None).await?;
// Empty
tokens.create("uid", std::iter::empty::<&str>(), "jwt", None).await?;
§Arguments
  • user_id — the user to issue a token for
  • scopes — permission scopes to embed in the token
  • method_name — the auth method that authenticated the user (e.g. "jwt")
  • lifetime — custom lifetime, or None for the configured default
Source

pub async fn create_token(&self, req: TokenCreateRequest) -> Result<AuthToken>

Create a token from a TokenCreateRequest.

This is the preferred entry point — it replaces positional Option parameters with a self-documenting builder.

§Example
let token = auth.tokens().create_token(
    TokenCreateRequest::new("user-123", "jwt")
        .scope("read")
        .scope("write")
).await?;
Source

pub async fn validate(&self, token: &AuthToken) -> Result<bool>

Validate an authentication token.

Source

pub async fn refresh(&self, token: &AuthToken) -> Result<AuthToken>

Refresh an authentication token.

Source

pub async fn revoke(&self, token: &AuthToken) -> Result<()>

Revoke an authentication token.

Source

pub async fn list_for_user(&self, user_id: &str) -> Result<Vec<AuthToken>>

List all tokens belonging to a user.

Source

pub async fn create_api_key( &self, user_id: &str, expires_in: Option<Duration>, ) -> Result<String>

Create an API key for a user.

Source

pub async fn validate_api_key(&self, api_key: &str) -> Result<UserInfo>

Validate an API key and return the associated user info.

Source

pub async fn revoke_api_key(&self, api_key: &str) -> Result<()>

Revoke an API key.

Auto Trait Implementations§

§

impl<'a> Freeze for TokenOperations<'a>

§

impl<'a> !RefUnwindSafe for TokenOperations<'a>

§

impl<'a> Send for TokenOperations<'a>

§

impl<'a> Sync for TokenOperations<'a>

§

impl<'a> Unpin for TokenOperations<'a>

§

impl<'a> UnsafeUnpin for TokenOperations<'a>

§

impl<'a> !UnwindSafe for TokenOperations<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more