Struct ApiKeyAuthenticator 

pub struct ApiKeyAuthenticator<R>
where
    R: ApiKeyRepository,
{ /* private fields */ }

Authenticator that validates API keys from requests.

This authenticator extracts API keys from configured locations (header, query parameter, or Authorization header) and validates them against a repository.

Example

use actix_security::http::security::api_key::{
    ApiKeyAuthenticator, ApiKeyConfig, ApiKey, InMemoryApiKeyRepository,
};

let repository = InMemoryApiKeyRepository::new()
    .with_key(ApiKey::new("sk_live_abc123")
        .roles(vec!["API_USER".into()])
        .authorities(vec!["api:read".into()]));

let authenticator = ApiKeyAuthenticator::new(repository)
    .config(ApiKeyConfig::header("X-API-Key"));

Implementations

impl<R> ApiKeyAuthenticator<R>

where R: ApiKeyRepository,

pub fn new(repository: R) -> ApiKeyAuthenticator<R>

Creates a new API key authenticator with the given repository.

pub fn with_shared_repository(repository: Arc<R>) -> ApiKeyAuthenticator<R>

Creates a new API key authenticator with a shared repository.

pub fn config(self, config: ApiKeyConfig) -> ApiKeyAuthenticator<R>

Sets the configuration for this authenticator.

Trait Implementations

impl<R> Authenticator for ApiKeyAuthenticator<R>

where R: ApiKeyRepository + 'static,

fn get_user(&self, req: &ServiceRequest) -> Option<User>

Attempts to authenticate the request and returns the user if successful.

impl<R> Clone for ApiKeyAuthenticator<R>

where R: ApiKeyRepository,

fn clone(&self) -> ApiKeyAuthenticator<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.