Skip to main content

OAuthConfigBuilder

Struct OAuthConfigBuilder 

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

Builder for OAuthConfig.

Obtain via OAuthConfig::builder. All setters consume self and return a new builder, so they compose fluently. Call OAuthConfigBuilder::build to produce the final OAuthConfig.

Implementations§

Source§

impl OAuthConfigBuilder

Source

pub fn scopes(self, scopes: Vec<ScopeMapping>) -> Self

Replace the scope-to-role mappings.

Source

pub fn scope(self, scope: impl Into<String>, role: impl Into<String>) -> Self

Append a single scope-to-role mapping.

Source

pub fn role_claim(self, claim: impl Into<String>) -> Self

Set the JWT claim path used to extract roles directly (without going through scope mappings).

Source

pub fn role_mappings(self, mappings: Vec<RoleMapping>) -> Self

Replace the claim-value-to-role mappings.

Source

pub fn role_mapping( self, claim_value: impl Into<String>, role: impl Into<String>, ) -> Self

Append a single claim-value-to-role mapping (used with Self::role_claim).

Source

pub fn jwks_cache_ttl(self, ttl: impl Into<String>) -> Self

Override the JWKS cache TTL (humantime string, e.g. "5m"). Defaults to "10m".

Source

pub fn proxy(self, proxy: OAuthProxyConfig) -> Self

Attach an OAuth proxy configuration. When set, the server exposes /authorize, /token, and /register endpoints.

Source

pub fn token_exchange(self, token_exchange: TokenExchangeConfig) -> Self

Attach an RFC 8693 token exchange configuration.

Source

pub fn ca_cert_path(self, path: impl Into<PathBuf>) -> Self

Provide a PEM CA bundle path used for all OAuth-bound HTTPS traffic originated by this crate (JWKS fetches and the optional OAuth proxy /authorize, /token, /register, /introspect, /revoke, /.well-known/oauth-authorization-server upstream calls).

Source

pub const fn allow_http_oauth_urls(self, allow: bool) -> Self

Allow plain-HTTP (non-TLS) URLs for OAuth endpoints.

Default: false. See the field-level documentation on OAuthConfig::allow_http_oauth_urls for the security caveats before enabling this.

Source

pub const fn strict_audience_validation(self, strict: bool) -> Self

Toggle strict audience validation so only the JWT aud claim is considered and the compatibility fallback to azp is disabled.

Source

pub const fn jwks_max_response_bytes(self, bytes: u64) -> Self

Override the maximum JWKS response body size in bytes.

Source

pub fn build(self) -> OAuthConfig

Finalise the builder and return the OAuthConfig.

Trait Implementations§

Source§

impl Clone for OAuthConfigBuilder

Source§

fn clone(&self) -> OAuthConfigBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OAuthConfigBuilder

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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> 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 = 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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,