ktor-server-auth/io.ktor.server.auth/DigestCredential

DigestCredential

data class DigestCredential(val realm: String, val userName: String, val digestUri: String, val nonce: String, val opaque: String?, val nonceCount: String?, val algorithm: String?, val response: String, val cnonce: String?, val qop: String?) : Credential

Digest credentials.

See also

Constructors

DigestCredential

constructor(realm: String, userName: String, digestUri: String, nonce: String, opaque: String?, nonceCount: String?, algorithm: String?, response: String, cnonce: String?, qop: String?)

Properties

val algorithm: String?

a digest algorithm name

val cnonce: String?

must be sent if qop is specified and must be null otherwise. Should be passed through unchanged.

val digestUri: String

may be an absolute URI or *

val nonce: String

val nonceCount: String?

must be sent if qop is specified and must be null otherwise

val opaque: String?

a string of data which should be returned by the client unchanged

val qop: String?

a quality of protection sign

val realm: String

a digest authentication realm

val response: String

consist of 32 hex digits (digested password and other fields as per RFC)

val userName: String

Functions

fun DigestCredential.expectedDigest(method: HttpMethod, digester: MessageDigest, userNameRealmPasswordDigest: ByteArray): ByteArray

Calculates the expected digest bytes for this DigestCredential.

suspend fun DigestCredential.verifier(method: HttpMethod, digester: MessageDigest, userNameRealmPasswordDigest: suspend (String, String) -> ByteArray?): Boolean

Verifies that credentials are valid for a given method, digester, and userNameRealmPasswordDigest.