io.ktor.auth / DigestAuthenticationProvider / Configuration

Configuration

class Configuration : Configuration

Digest auth configuration

Properties

algorithmName	`var algorithmName: String` Message digest algorithm to be used. Usually only `MD5` is supported by clients.
digester	`var digester: MessageDigest` Message digest algorithm to be used
nonceManager	`var nonceManager: NonceManager` NonceManager to be used to generate nonce values
realm	`var realm: String` Specifies realm to be passed in `WWW-Authenticate` header
userNameRealmPasswordDigestProvider	`var userNameRealmPasswordDigestProvider: DigestProviderFunction` username and password digest function

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

digestProvider

fun digestProvider(
    digest: suspend (userName: String, realm: String) -> ByteArray?
): Unit

Configures digest provider function that should fetch or compute message digest for the specified userName and realm. A message digest is usually computed based on user name (login), realm and password concatenated with colon character ‘:’. For example "$userName:$realm:$password".

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