commonMain.dev.programadorthi.routing.auth.AuthenticationProvider.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-2019 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

/**
 * A predicate function that accepts an application call and returns `true` or `false`.
 */
public typealias ApplicationCallPredicate = (ApplicationCall) -> Boolean

/**
 * An authentication function that accepts and verifies credentials and returns a principal when verification is successful.
 */
public typealias AuthenticationFunction = suspend ApplicationCall.(credentials: C) -> Principal?

/**
 * An authentication provider with the specified name.
 */
public abstract class AuthenticationProvider(config: Config) {
    /**
     * A provider name or `null` for a default provider.
     */
    public val name: String? = config.name

    /**
     * Authenticates a request based on [AuthenticationContext].
     * Implementations should either add a new [AuthenticationContext.principal] for successful authentication
     * or register [AuthenticationContext.challenge] for failed ones.
     */
    public abstract suspend fun onAuthenticate(context: AuthenticationContext)

    /**
     * Authentication filters specifying if authentication is required for a particular [ApplicationCall].
     *
     * If there is no filters, authentication is required. If any filter returns `true`, authentication is not required.
     */
    public val skipWhen: List = config.filterPredicates ?: emptyList()

    /**
     * Serves as the base class for authentication providers.
     * @property name is the name of the provider, or `null` for a default provider.
     */
    public open class Config protected constructor(public val name: String?) {
        /**
         * Authentication filters specifying if authentication is required for a particular [ApplicationCall].
         *
         * If there is no filters, authentication is required. If any filter returns `true`, authentication is not required.
         */
        internal var filterPredicates: MutableList? = null

        /**
         * Adds an authentication filter to the list.
         * For every application call the specified [predicate] is applied and if it returns `true` then the
         * authentication provider is skipped (no auth required for this call with this provider).
         */
        public fun skipWhen(predicate: (ApplicationCall) -> Boolean) {
            val list = filterPredicates ?: mutableListOf()
            list.add(predicate)
            filterPredicates = list
        }
    }
}