Skip to main content

AuthConfig

Struct AuthConfig 

Source
pub struct AuthConfig {
    pub basic: Option<BasicCredential>,
    pub authorizer: Authorizer,
    /* private fields */
}
Expand description

Which credentials the server accepts. An empty config (the default) means the server is open — no interceptor is installed.

Fields§

§basic: Option<BasicCredential>

Accepted Basic username/password, if any.

§authorizer: Authorizer

Per-query authorization policy, consulted after a query resolves. The default Authorizer::AllowAll is a no-op (no behavior change).

Implementations§

Source§

impl AuthConfig

Source

pub fn with_bearer_token(self, token: impl Into<String>) -> Self

A single accepted bearer token (back-compat shape). Equivalent to with_bearer_tokens with one element; the token names itself.

Source

pub fn with_bearer_tokens<I, S>(self, tokens: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

A set of accepted bearer tokens for zero-downtime rotation. Any listed token authenticates; the first is issued by the handshake. Each token names itself as its Identity (use with_named_bearer_tokens to map tokens to authz identities).

Source

pub fn with_named_bearer_tokens<I, S1, S2>(self, tokens: I) -> Self
where I: IntoIterator<Item = (S1, S2)>, S1: Into<String>, S2: Into<String>,

A set of accepted bearer tokens mapped to authz identity names, so several tokens can share one identity (e.g. an old and a new token for the same analyst role rotate transparently). Pairs are (token, identity_name); the first pair’s token is issued by the handshake.

Source

pub fn add_bearer_token(&mut self, token: impl Into<String>) -> &mut Self

Add one accepted bearer token (self-named). Keeps any already added — the building block for rotation. Returns &mut Self for chaining.

Source

pub fn add_named_bearer_token( &mut self, token: impl Into<String>, name: impl Into<String>, ) -> &mut Self

Add one accepted bearer token mapped to an authz identity name.

Source

pub fn with_basic( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

Accept Basic username / password.

Source

pub fn with_authorizer(self, authorizer: Authorizer) -> Self

Attach a per-query Authorizer. Default is Authorizer::AllowAll.

Source

pub fn authorize( &self, identity: &Identity, query_name: &str, ) -> Result<(), Status>

Authorize an already-resolved query for an identity (delegates to the configured Authorizer). Denial → permission_denied.

Source

pub fn bearer_tokens(&self) -> impl Iterator<Item = &str>

All accepted bearer token values, in insertion order.

Source

pub fn is_enabled(&self) -> bool

Any credential method configured? When false, the server requires no authentication and the interceptor is skipped entirely.

Source

pub fn issued_token(&self) -> Option<&str>

The token issued to a client after a successful handshake — the first configured bearer token, which the client then replays on each call.

Source

pub fn check_header(&self, header: Option<&str>) -> Result<(), Status>

Validate an authorization header value against every configured method. Open servers accept anything (including a missing header).

A thin wrapper over authenticate that discards the resolved Identity; kept for call sites that only gate access.

Source

pub fn authenticate(&self, header: Option<&str>) -> Result<Identity, Status>

Validate an authorization header and return the resolved Identity.

Open servers (no method configured) authenticate anything as Identity::Anonymous. Otherwise a valid Bearer token resolves to its mapped Identity::Token and valid Basic creds to Identity::Basic; anything else is unauthenticated.

Source

pub fn check_basic(&self, b64: &str) -> Option<String>

Validate a base64-encoded user:pass Basic payload, returning the username on success.

Trait Implementations§

Source§

impl Clone for AuthConfig

Source§

fn clone(&self) -> AuthConfig

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 AuthConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AuthConfig

Source§

fn default() -> AuthConfig

Returns the “default value” for a type. 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<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> 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> 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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> 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<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