io.ktor.auth / BasicAuthenticationProvider / Configuration

Configuration

class Configuration : Configuration

Basic auth configuration

Properties

charset	`var charset: Charset?` Specifies the charset to be used. It can be either UTF_8 or null. Setting `null` turns legacy mode on that actually means that ISO-8859-1 is used.
realm	`var realm: String` Specifies realm to be passed in `WWW-Authenticate` header

Inherited Properties

name	`val name: String?` is the name of the provider, or `null` for a default provider.
pipeline	`val pipeline: AuthenticationPipeline` Authentication pipeline for this provider.

Functions

validate

fun validate(
    body: suspend ApplicationCall.(UserPasswordCredential) -> Principal?
): Unit

Sets a validation function that will check given UserPasswordCredential instance and return Principal, or null if credential does not correspond to an authenticated principal

Inherited Functions

skipWhen

fun skipWhen(predicate: (ApplicationCall) -> Boolean): Unit

Adds an authentication filter to the list. For every application call the specified predicate is applied and if it returns true then the authentication provider is skipped (no auth required for this call with this provider).