Skip to main content

AuthState

Struct AuthState 

Source
pub struct AuthState { /* private fields */ }
Expand description

The authorization server’s state, shared by its routes and every service’s bearer guard.

Implementations§

Source§

impl AuthState

Source

pub fn new( settings: OAuthSettings, services: &[&str], verifier: Arc<dyn CredentialVerifier>, ) -> Arc<Self> ⓘ

services are the enabled service names; each is the protected resource PUBLIC_URL/<name>. Tokens the authorization server keeps for itself (client, CSRF, code, refresh) use the public URL as audience; access tokens use their resource. verifier decides who may sign in.

§Panics

If settings.static_token is set while verifier carries credentials or accepts them as bearer tokens (requests made with it would lack the credential tools expect, and wrong tokens could be tried as credentials without limit), or when the static token has the shape of a JWT. Server::load reports these as configuration errors.

Source

pub fn sign_in_version(&self) -> &str

The ver every code, access and refresh token must carry: a keyed hash of the sign-in mode, the verifier’s label and its generation. Changing the owner’s password, switching sign-in mode or verifier, or rotating OAUTH_SIGNING_KEY changes it and so ends every earlier grant.

Source

pub fn subject_of(&self, credential: &str) -> String

Who signed in with credential: what the verifier names (CredentialVerifier::subject), else key: and 16 hex digits of a keyed hash of the credential when credentials are carried, and owner otherwise.

Source

pub fn settings(&self) -> &OAuthSettings

The settings this server was built with.

Source

pub fn jwt(&self) -> &Jwt

Issues and verifies this server’s tokens, e.g. to mint one in a test.

Source

pub fn sealer(&self) -> &Sealer

Seals and opens the credentials carried in tokens.

Source

pub fn verifier(&self) -> &dyn CredentialVerifier

Who may sign in.

Source

pub fn services(&self) -> &[String]

The enabled service names, each a protected resource.

Source

pub fn has_service(&self, service: &str) -> bool

Whether service is one of them.

Source

pub fn callback_url(&self) -> String

Where an upstream provider sends people back: PUBLIC_URL/callback. Register it with the provider as a redirect URI.

Source

pub fn resource(&self, service: &str) -> String

The resource URL of service: PUBLIC_URL/<service>.

Source

pub fn resource_metadata_url(&self, service: &str) -> String

Where service’s protected-resource metadata is served.

Source

pub fn service_for_resource(&self, resource: &str) -> Option<&str>

The enabled service whose resource URL is exactly resource.

Auto Trait Implementations§

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<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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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