ktor-auth/io.ktor.auth/BasicAuthenticationProvider/Configuration

Configuration

class Configuration : AuthenticationProvider.Configuration

Basic auth configuration

Functions

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

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).

validate

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

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

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.

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.

realm

var realm: String

Specifies realm to be passed in WWW-Authenticate header