Skip to main content

Auth

Struct Auth 

Source
pub struct Auth(pub AuthenticatedIdentity);
Expand description

Extracts the AuthenticatedIdentity for the current request.

Available inside #[tool], #[resource], and #[prompt] handlers when the auth feature is enabled and the server is configured with an auth provider.

Returns McpError::Unauthorized if the request is unauthenticated.

§Example

use mcp_kit::prelude::*;
use mcp_kit::Auth;

#[mcp_kit::tool(description = "A protected tool")]
async fn my_tool(input: String, auth: Auth) -> McpResult<CallToolResult> {
    if !auth.has_scope("tools:execute") {
        return Err(McpError::Unauthorized("missing scope".into()));
    }
    Ok(CallToolResult::text(format!("Hello, {}!", auth.subject)))
}

Tuple Fields§

§0: AuthenticatedIdentity

Implementations§

Source§

impl Auth

Source

pub fn from_context() -> McpResult<Self>

Pull the current identity from the task-local auth context. Returns Err(McpError::Unauthorized) if no identity is present.

Methods from Deref<Target = AuthenticatedIdentity>§

Source

pub fn has_scope(&self, scope: &str) -> bool

Returns true if this identity has the given scope.

Source

pub fn has_all_scopes(&self, scopes: &[&str]) -> bool

Returns true if this identity has all of the given scopes.

Trait Implementations§

Source§

impl Deref for Auth

Available on crate feature auth only.
Source§

type Target = AuthenticatedIdentity

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl Freeze for Auth

§

impl RefUnwindSafe for Auth

§

impl Send for Auth

§

impl Sync for Auth

§

impl Unpin for Auth

§

impl UnsafeUnpin for Auth

§

impl UnwindSafe for Auth

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> 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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
Source§

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