Struct ApiKeyAuth 

pub struct ApiKeyAuth { /* private fields */ }

Authenticate callers by a secret in a request header

Several keys can be active at once (one per caller, or old and new during a rotation); the matching entry’s name becomes the Principal.

Implementations

impl ApiKeyAuth

pub fn new() -> Self

Reads the key from X-API-Key

pub fn header(self, name: &str) -> Self

Header carrying the key

pub fn allow_bearer(self) -> Self

Also accept the key as Authorization: Bearer <key>

pub fn key(self, name: &str, secret: &str) -> Self

Accept secret and report its owner as name

pub fn except_paths<I, S>(self, paths: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Paths served without a key (health checks)

Trait Implementations

impl Clone for ApiKeyAuth

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ApiKeyAuth

fn default() -> Self

Returns the “default value” for a type.

impl Middleware for ApiKeyAuth

fn handle<'life0, 'async_trait>( &'life0 self, req: Request, next: Next, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,