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

DigestAuthenticationProvider

class DigestAuthenticationProvider : AuthenticationProvider(source)

A digest Authentication provider.

This provider supports:

Multiple hash algorithms: MD5, SHA-256, SHA-512-256 (and their session variants)
Quality of Protection (qop): auth and auth-int
User hash for privacy protection
UTF-8 charset support

Security Note: SHA-512-256 is the recommended hash algorithm for new implementations. While MD5 is supported for backward compatibility, it is deprecated and should be avoided in production. Consider enabling Config.strictRfc7616Mode to enforce stronger algorithms.

Report a problem

Types

Config

class Config : AuthenticationProvider.Config

A configuration for the digest authentication provider.

Properties

description

val description: String?

A description of the provider that can be used for API documentation.

name

val name: String?

A provider name or null for a default provider.

skipWhen

val skipWhen: List<ApplicationCallPredicate>

Authentication filters specifying if authentication is required for a particular ApplicationCall.

Functions

onAuthenticate

open suspend override fun onAuthenticate(context: AuthenticationContext)

Authenticates a request based on AuthenticationContext. Implementations should either add a new AuthenticationContext.principal for successful authentication or register AuthenticationContext.challenge for failed ones.