ktor-server-auth/io.ktor.server.auth/DigestAuthenticationProvider/Config

Config

class Config : AuthenticationProvider.Config

A configuration for the digest authentication provider.

Properties

Link copied to clipboard
var algorithmName: String

A message digest algorithm to be used. Usually only MD5 is supported by clients.

Link copied to clipboard
val name: String?

is the name of the provider, or null for a default provider.

Link copied to clipboard
var nonceManager: NonceManager

NonceManager to be used to generate nonce values.

Link copied to clipboard
var realm: String

Specifies a realm to be passed in the WWW-Authenticate header.

Functions

Link copied to clipboard
fun digestProvider(digest: DigestProviderFunction)

Configures a digest provider function that should fetch or compute message digest for the specified userName and realm. A message digest is usually computed based on username, realm and password concatenated with the colon character ':'. For example, "$userName:$realm:$password".

Link copied to clipboard
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).

Link copied to clipboard
fun validate(body: AuthenticationFunction<DigestCredential>)

Sets a validation function that checks a specified DigestCredential instance and returns Principal in a case of successful authentication or null if authentication fails.