Struct BasicAuth 

pub struct BasicAuth { /* private fields */ }

basic auth handler

Implementations

impl BasicAuth

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

build a new basic auth handler that accepts exactly this username and password

Only a digest of the credentials is retained, and it is compared in constant time.

pub fn validate_fn<F>(predicate: F) -> Self

where F: Fn(&Credentials) -> bool + Send + Sync + 'static,

build a new basic auth handler that accepts any credentials for which the provided predicate returns true

let basic_auth = BasicAuth::validate_fn(|credentials| {
    credentials.username().starts_with("admin-")
        && credentials.password() == std::env::var("ADMIN_PASSWORD").unwrap()
});

A predicate that compares secrets should do so in constant time, as BasicAuth::new does.

pub fn validate_async_fn<F, Fut>(predicate: F) -> Self

where F: Fn(Credentials) -> Fut + Send + Sync + 'static, Fut: Future<Output = bool> + Send + 'static,

build a new basic auth handler that accepts any credentials for which the provided async predicate returns true, such as a database lookup and a password hash comparison

let basic_auth = BasicAuth::validate_async_fn(|credentials| async move {
    match look_up(credentials.username()).await {
        Some(hash) => verify(credentials.password(), &hash),
        None => false,
    }
});

pub fn with_realm(self, realm: &str) -> Self

provide a realm for the www-authenticate response sent by this handler

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

the realm provided to BasicAuth::with_realm, if any

Trait Implementations

impl Debug for BasicAuth

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

Formats the value using the given formatter.

impl Handler for BasicAuth

async fn run(&self, conn: Conn) -> Conn

Executes this handler, performing any modifications to the Conn that are desired.

fn init(&mut self, info: &mut Info) -> impl Future<Output = ()> + Send

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send(&self, conn: Conn) -> impl Future<Output = Conn> + Send

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement Handler::upgrade. The first handler that responds true to this will receive ownership of the trillium::Upgrade in a subsequent call to Handler::upgrade

fn upgrade(&self, upgrade: Upgrade) -> impl Future<Output = ()> + Send

This will only be called if the handler reponds true to Handler::has_upgrade and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.