http4k-security-oauth/org.http4k.security.oauth.client

Package-level declarations

Types

AccessTokens

interface AccessTokens

AuthServerDiscovery

fun interface AuthServerDiscovery

How an authentication client can get the information about the authorization server

OAuthAuthorizationServer

data class OAuthAuthorizationServer(val serverUri: Uri, val serverMetadata: ServerMetadata)

OAuthOfflineRequestAuthorizer

class OAuthOfflineRequestAuthorizer(config: OAuthProviderConfig, accessTokens: AccessTokens, backend: HttpHandler, authRequestFilter: Filter, gracePeriod: Duration = Duration.ofSeconds(10), clock: Clock = Clock.systemUTC(), accessTokenExtractor: AccessTokenExtractor = ContentTypeJsonOrForm())

TokenRequest

data class TokenRequest(val grant_type: String, val refresh_token: String?, val client_id: String?, val code: String?, val redirect_uri: Uri?)

Properties

tokenRequestLens

val tokenRequestLens: BiDiBodyLens<TokenRequest>

Functions

AutoDiscoveryOAuthToken

fun ClientFilters.AutoDiscoveryOAuthToken(authServerDiscovery: AuthServerDiscovery, credentials: Credentials, backend: HttpHandler, clock: Clock = Clock.systemUTC(), scopes: List<String> = emptyList(), resourceUri: Uri? = null, oAuthFlowFilter: Filter = ClientFilters.OAuthClientCredentials(credentials, scopes, resourceUri), gracePeriod: Duration = Duration.ofSeconds(10)): Filter

InMemory

fun AccessTokens.Companion.InMemory(): AccessTokens

None

fun AccessTokens.Companion.None(): AccessTokens

OAuthClientCredentials

fun ClientFilters.OAuthClientCredentials(clientCredentials: Credentials, scopes: List<String> = emptyList(), resource: Uri? = null): Filter

fun ClientFilters.OAuthClientCredentials(config: OAuthProviderConfig, scopes: List<String> = emptyList(), resourceUri: Uri? = null): Filter

OAuthOffline

fun ClientFilters.OAuthOffline(config: OAuthProviderConfig, refreshToken: RefreshToken, backend: HttpHandler, accessTokens: AccessTokens = AccessTokens.None(), authRequestFilter: Filter = BasicAuth(config.credentials)): Filter

OAuthRefreshToken

fun ClientFilters.OAuthRefreshToken(clientCredentials: Credentials, token: RefreshToken, scopes: List<String> = emptyList(), resource: Uri? = null): Filter

fun ClientFilters.OAuthRefreshToken(config: OAuthProviderConfig, token: RefreshToken, scopes: List<String> = emptyList(), resource: Uri? = null): Filter

OAuthUserCredentials

fun ClientFilters.OAuthUserCredentials(clientCredentials: Credentials, userCredentials: Credentials, scopes: List<String>, resource: Uri? = null): Filter

fun ClientFilters.OAuthUserCredentials(config: OAuthProviderConfig, userCredentials: Credentials, scopes: List<String>, resourceUri: Uri? = null): Filter

RefreshingOAuthToken

fun ClientFilters.RefreshingOAuthToken(config: OAuthProviderConfig, backend: HttpHandler, gracePeriod: Duration = Duration.ofSeconds(10), clock: Clock = Clock.systemUTC(), scopes: List<String> = emptyList(), resourceUri: Uri? = null, oAuthFlowFilter: Filter = ClientFilters.OAuthClientCredentials(config.credentials, scopes, resourceUri)): Filter

fun ClientFilters.RefreshingOAuthToken(oauthCredentials: Credentials, tokenUri: Uri, backend: HttpHandler, gracePeriod: Duration = Duration.ofSeconds(10), clock: Clock = Clock.systemUTC(), tokenExtractor: AccessTokenExtractor = ContentTypeJsonOrForm(), scopes: List<String> = emptyList(), resourceUri: Uri? = null, oAuthFlowFilter: Filter = ClientFilters.OAuthClientCredentials(oauthCredentials, scopes, resourceUri)): Filter

Filter to authenticate and refresh against a OAuth server. Use the correct OAuth filter for your flow. e.g. ClientFilters.ClientCredentials()