Skip to main content

AuthMiddleware

Struct AuthMiddleware 

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

The authentication middleware.

Checks all configured authentication methods in order: mTLS → JWT → API key. First success wins.

Implementations§

Source§

impl AuthMiddleware

Source

pub fn new(config: AuthConfig) -> Result<Self, AuthError>

Create a new authentication middleware from configuration.

§Errors

Returns AuthError::Config if the JWT configuration contains an unrecognized algorithm string.

Source

pub fn is_exempt(&self, path: &str) -> bool

Check if a path is exempt from authentication.

Uses segment-boundary matching instead of raw prefix matching to prevent bypass via path manipulation (e.g., /healthz, /health/../api/v1/write, /health%2F..).

**** Percent-decodes the path before normalization to prevent bypass via %2F (/) and %2E (.) encoded characters.

A path matches an exempt entry if it is either an exact match or the exempt path is a proper directory prefix (path starts with exempt + "/").

Source

pub fn authenticate( &self, bearer_token: Option<&str>, client_cert_cn: Option<&str>, ) -> Result<AuthContext, AuthError>

Authenticate a request.

Parameters:

  • bearer_token: The value from Authorization: Bearer <token> header
  • client_cert_cn: The client certificate CN (from mTLS handshake)

Returns the authentication context on success.

Source

pub async fn authenticate_async( &self, bearer_token: Option<&str>, client_cert_cn: Option<&str>, ) -> Result<AuthContext, AuthError>

Authenticate a request, consulting a JWKS endpoint when one is configured.

Identical to authenticate except that the JWT step can fetch and cache the issuer’s published keys. The two share every decision — which method wins, when a failure may fall through to a weaker one — so they cannot drift apart; only the JWT call differs, because fetching keys needs to await.

§Errors

As authenticate.

Source

pub fn jwt_validator(&self) -> Option<&JwtValidator>

The JWT validator, when one is configured.

Source

pub fn set_jwks_cache(&mut self, cache: Arc<JwksCache>)

Attach a JWKS cache to the JWT validator.

Called at startup once the issuer’s keys have been fetched.

Source

pub fn is_configured(&self) -> bool

Check whether any authentication method is configured.

Trait Implementations§

Source§

impl Clone for AuthMiddleware

Source§

fn clone(&self) -> AuthMiddleware

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AuthMiddleware

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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