org.http4k.contract.security.OAuthSecurity.kt Maven / Gradle / Ivy

Go to download

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

http4k typesafe HTTP contracts and OpenApi support

There is a newer version: 5.31.0.0

package org.http4k.contract.security

import org.http4k.core.Filter
import org.http4k.core.NoOp
import org.http4k.core.Uri
import org.http4k.filter.ServerFilters
import org.http4k.lens.RequestContextLens
import org.http4k.security.OAuthProvider

sealed class OAuthSecurity(
    override val filter: Filter,
    val name: String,
    val scopes: List,
    val refreshUrl: Uri?,
    val extraFields: Map = emptyMap()
) : Security {
    companion object
}

class AuthCodeOAuthSecurity(
    val authorizationUrl: Uri,
    val tokenUrl: Uri,
    scopes: List = emptyList(),
    filter: Filter,
    name: String = "oauthSecurityAuthCode",
    refreshUrl: Uri? = null,
    extraFields: Map = emptyMap()
) :
    OAuthSecurity(filter, name, scopes, refreshUrl, extraFields) {

    companion object {
        operator fun invoke(
            oAuthProvider: OAuthProvider,
            customScopes: List? = null
        ) = AuthCodeOAuthSecurity(
            oAuthProvider.providerConfig.authUri,
            oAuthProvider.providerConfig.tokenUri,
            customScopes ?: oAuthProvider.scopes.map { OAuthScope(it, "") },
            oAuthProvider.authFilter
        )
    }
}

class ImplicitOAuthSecurity(
    val authorizationUrl: Uri,
    scopes: List = emptyList(),
    filter: Filter,
    name: String = "oauthSecurityImplicit",
    refreshUrl: Uri? = null,
    extraFields: Map = emptyMap()
) :
    OAuthSecurity(filter, name, scopes, refreshUrl, extraFields) {

    companion object
}

class UserCredentialsOAuthSecurity(
    val tokenUrl: Uri,
    scopes: List = emptyList(),
    filter: Filter = Filter.NoOp,
    name: String = "oauthSecurityUserCredentials",
    refreshUrl: Uri? = null,
    extraFields: Map = emptyMap()
) : OAuthSecurity(filter, name, scopes, refreshUrl, extraFields) {
    companion object {
        operator fun  invoke(
            tokenUrl: Uri,
            key: RequestContextLens,
            lookup: (String) -> T?,
            refreshUrl: Uri? = null,
            scopes: List = emptyList()
        ) = UserCredentialsOAuthSecurity(
            tokenUrl = tokenUrl,
            scopes = scopes,
            filter = ServerFilters.BearerAuth(key, lookup),
            refreshUrl = refreshUrl,
        )
    }
}

data class OAuthScope(val name: String, val description: String = name)