commonMain.dev.programadorthi.routing.auth.AuthenticationProcedureChallenge.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of auth-jvm Show documentation

An extensible and multiplatform routing system powered by Ktor

There is a newer version: 2.0.0-alpha02

/*
* Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/

package dev.programadorthi.routing.auth

import dev.programadorthi.routing.core.application.ApplicationCall

public typealias ChallengeFunction = suspend (AuthenticationProcedureChallenge, ApplicationCall) -> ChallengeStatus

/**
 * Represents an authentication challenging procedure requested by authentication mechanism.
 */
public class AuthenticationProcedureChallenge {
    internal val register = mutableListOf>()

    /**
     * List of currently installed challenges except errors.
     */
    internal val challenges: List
        get() =
            register.filter { it.first !is AuthenticationFailedCause.Error }.sortedBy {
                when (it.first) {
                    AuthenticationFailedCause.InvalidCredentials -> 1
                    AuthenticationFailedCause.NoCredentials -> 2
                    else -> throw IllegalArgumentException("Unknown Auth fail: ${it.first}")
                }
            }.map { it.second }

    /**
     * List of currently installed challenges for errors.
     */
    internal val errorChallenges: List
        get() = register.filter { it.first is AuthenticationFailedCause.Error }.map { it.second }

    override fun toString(): String = "AuthenticationProcedureChallenge"
}