org.http4k.security.digest.DigestCredential.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http4k-security-digest Show documentation

Http4k Security Digest support

There is a newer version: 5.31.1.0

Show newest version

package org.http4k.security.digest

import org.http4k.appendIfPresent
import org.http4k.security.Nonce
import org.http4k.util.Hex

/**
 * The digest Authorization to pass to the server as a header
 */
data class DigestCredential(
    val realm: String,
    val username: String,
    val digestUri: String,
    val nonce: Nonce,
    val response: String,
    val opaque: String?,
    val nonceCount: Long?,
    val algorithm: String?,
    val cnonce: Nonce?,
    val qop: Qop?
) {
    fun toHeaderValue() = StringBuilder("Digest realm=\"$realm\", username=\"$username\", uri=\"$digestUri\", nonce=\"$nonce\", response=\"$response\"")
        .appendIfPresent(opaque, ", opaque=\"$opaque\"")
        .appendIfPresent(nonceCount, ", nc=${nonceCount?.toString(16)?.padStart(8, '0')}")
        .appendIfPresent(algorithm, ", algorithm=$algorithm")
        .appendIfPresent(cnonce, ", cnonce=\"$cnonce\"")
        .appendIfPresent(qop, ", qop=\"${qop?.value}\"")
        .toString()

    companion object {

        fun fromHeader(headerValue: String): DigestCredential? {
            val (prefix, parameters) = ParameterizedHeader.parse(headerValue)
            if (!prefix.equals("digest", ignoreCase = true)) return null

            return DigestCredential(
                realm = parameters["realm"] ?: return null,
                username = parameters["username"] ?: return null,
                digestUri = parameters["uri"] ?: return null,
                nonce = parameters["nonce"]?.let(::Nonce) ?: return null,
                opaque = parameters["opaque"],
                nonceCount = parameters["nc"]?.toLong(16),
                algorithm = parameters["algorithm"],
                response = parameters["response"] ?: return null,
                cnonce = parameters["cnonce"]?.let(::Nonce),
                qop = parameters["qop"]?.let { Qop.from(it) }
            )
        }
    }

    fun responseBytes(): ByteArray? = try {
        Hex.unhex(response)
    } catch (e: NumberFormatException) {
        null
    }
}