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

Config

class Config(source)

A configuration for the digest authentication provider.

Report a problem

Properties

algorithmName

var algorithmName: String

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

nonceManager

var nonceManager: NonceManager

NonceManager to be used to generate nonce values.

realm

var realm: String

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

Functions

digestProvider

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

validate

fun validate(body: <Error class: unknown class><DigestCredential>)

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