Struct ApiKeyProvider 

pub struct ApiKeyProvider { /* private fields */ }

Validates X-Api-Key: <key> header credentials (or ?api_key= query param, which the transport layer normalises into the same Credentials::ApiKey variant).

Examples

Static key list:

use mcp_kit::auth::ApiKeyProvider;

let provider = ApiKeyProvider::new(["key-abc-123", "key-def-456"]);

Custom async validator:

use mcp_kit::auth::{ApiKeyProvider, AuthenticatedIdentity};

let provider = ApiKeyProvider::with_validator(|key| async move {
    // look up the key in a database, etc.
    Ok(AuthenticatedIdentity::new("service-a").with_scopes(["read"]))
});

Implementations

impl ApiKeyProvider

pub fn new(keys: impl IntoIterator<Item = impl Into<String>>) -> Self

Accept any API key in the given iterator. The identity subject is set to the key value itself.

pub fn with_validator<F, Fut>(f: F) -> Self

where F: Fn(String) -> Fut + Send + Sync + 'static, Fut: Future<Output = McpResult<AuthenticatedIdentity>> + Send + 'static,

Use a custom async validator.

Trait Implementations

impl AuthProvider for ApiKeyProvider

fn authenticate<'a>(&'a self, credentials: &'a Credentials) -> AuthFuture<'a>

Validate credentials and return the authenticated identity, or an error.

fn accepts(&self, credentials: &Credentials) -> bool

Returns true if this provider knows how to handle the given credential variant. Used by CompositeAuthProvider to select the right delegate without unnecessarily calling authenticate.