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

DigestCredential

class DigestCredential(val realm: String, val userName: String, val digestUri: String, val nonce: String, val opaque: String?, val nonceCount: String?, val digestAlgorithm: DigestAlgorithm, val response: String, val cnonce: String?, val qop: String?, val userHash: Boolean = false, val charset: Charset = Charsets.UTF_8)(source)

Digest credentials.

Report a problem

Constructors

DigestCredential

constructor(realm: String, userName: String, digestUri: String, nonce: String, opaque: String?, nonceCount: String?, digestAlgorithm: DigestAlgorithm, response: String, cnonce: String?, qop: String?, userHash: Boolean = false, charset: Charset = Charsets.UTF_8)

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

Properties

algorithm

val ~~algorithm~~: String?

The digest algorithm name (e.g., "SHA-512-256", "SHA-256", "MD5")

charset

val charset: Charset

cnonce

val cnonce: String?

Client nonce, must be sent if qop is specified

digestAlgorithm

val digestAlgorithm: DigestAlgorithm

digestUri

val digestUri: String

The request URI (an absolute URI or *)

nonce

val nonce: String

A server-specified unique value for this authentication round

nonceCount

val nonceCount: String?

The request counter (nc); must be sent if qop is specified

opaque

val opaque: String?

A string of data that should be returned by the client unchanged

qop

val qop: String?

Quality of protection ("auth" or "auth-int")

realm

val realm: String

A digest authentication realm identifying the protection space

response

val response: String

The client's digest response, consisting of hex digits

userHash

val userHash: Boolean

Whether the userName field contains a hashed username instead of plaintext

userName

val userName: String

The username, or userHash if userHash is true

Functions

component1

operator fun ~~component1~~(): String

component10

operator fun ~~component10~~(): String?

component2

operator fun ~~component2~~(): String

component3

operator fun ~~component3~~(): String

component4

operator fun ~~component4~~(): String

component5

operator fun ~~component5~~(): String?

component6

operator fun ~~component6~~(): String?

component7

operator fun ~~component7~~(): String

component8

operator fun ~~component8~~(): String

component9

operator fun ~~component9~~(): String?

copy

fun ~~copy~~(realm: String = this.realm, userName: String = this.userName, digestUri: String = this.digestUri, nonce: String = this.nonce, opaque: String? = this.opaque, nonceCount: String? = this.nonceCount, algorithm: String? = this.digestAlgorithm.name, response: String = this.response, cnonce: String? = this.cnonce, qop: String? = this.qop): DigestCredential

fun copy(realm: String = this.realm, userName: String = this.userName, digestUri: String = this.digestUri, nonce: String = this.nonce, opaque: String? = this.opaque, nonceCount: String? = this.nonceCount, digestAlgorithm: DigestAlgorithm = this.digestAlgorithm, response: String = this.response, cnonce: String? = this.cnonce, qop: String? = this.qop, userHash: Boolean = this.userHash, charset: Charset = this.charset): DigestCredential

equals

open operator override fun equals(other: Any?): Boolean

expectedDigest

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

Calculates the expected digest bytes for this DigestCredential.

fun DigestCredential.expectedDigest(method: HttpMethod, userNameRealmPasswordDigest: ByteArray, entityBodyHash: ByteArray? = null): ByteArray

Calculates the expected digest bytes for this DigestCredential per RFC 7616.

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

verifier

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

Verifies that credentials are valid for a given method, and userNameRealmPasswordDigest. The algorithm from DigestCredential.algorithm is used to compute the HA1 value.

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.

DigestCredential

See also

Constructors

Properties

Functions