http4k-security-oauth/org.http4k.security

Package-level declarations

Types

Base interface for AccessToken. Implement this in concert with AccessTokenExtractor to provide a custom implementation

data class AccessTokenDetails(val accessToken: AccessToken, val idToken: IdToken? = null)

fun interface AccessTokenExtractor : Function1<Response, Result<AccessTokenDetails, OAuthCallbackError.CouldNotFetchAccessToken>>

AccessTokenFetcher

class AccessTokenFetcher(api: HttpHandler, callbackUri: Uri, providerConfig: OAuthProviderConfig, accessTokenFetcherAuthenticator: AccessTokenFetcherAuthenticator, accessTokenExtractor: AccessTokenExtractor = ContentTypeJsonOrForm())

AccessTokenFetcherAuthenticator

fun interface AccessTokenFetcherAuthenticator

AccessTokenResponse

data class AccessTokenResponse(val access_token: String, val token_type: String? = null, val expires_in: Long? = null, val id_token: String? = null, val scope: String? = null, val refresh_token: String? = null)

BasicAuthAccessTokenFetcherAuthenticator

class BasicAuthAccessTokenFetcherAuthenticator(providerConfig: OAuthProviderConfig) : AccessTokenFetcherAuthenticator

ClientSecretAccessTokenFetcherAuthenticator

class ClientSecretAccessTokenFetcherAuthenticator(credentials: Credentials) : AccessTokenFetcherAuthenticator

ContentTypeJsonOrForm

class ContentTypeJsonOrForm(autoMarshallingJson: AutoMarshallingJson<*> = OAuthMoshi) : AccessTokenExtractor

Extracts a standard OAuth access token from JSON or Form encoded response.

CrossSiteRequestForgeryToken

data class CrossSiteRequestForgeryToken(val value: String)

CsrfGenerator

typealias CsrfGenerator = (Request) -> CrossSiteRequestForgeryToken

InsecureCookieBasedOAuthPersistence

class InsecureCookieBasedOAuthPersistence(cookieNamePrefix: String, cookieValidity: Duration = Duration.ofDays(1), clock: Clock = Clock.systemUTC()) : OAuthPersistence

This is an example implementation which stores CSRF and AccessToken values in an INSECURE client-side cookie. Access-tokens for end-services are fully available to the browser so do not use this in production!

OAuthCallback

class OAuthCallback(oAuthPersistence: OAuthPersistence, idTokenConsumer: IdTokenConsumer, accessTokenFetcher: AccessTokenFetcher) : Function1<request: Request, Response>

OAuthCallbackError

sealed class OAuthCallbackError

OAuthPersistence

interface OAuthPersistence

Provides persistence for OAuth lifecycle values:

OAuthProvider

class OAuthProvider(val providerConfig: OAuthProviderConfig, client: HttpHandler, callbackUri: Uri, val scopes: List<String>, oAuthPersistence: OAuthPersistence, modifyAuthState: (Uri) -> Uri = { it }, generateCrsf: CsrfGenerator = SECURE_CSRF, nonceGenerator: NonceGenerator = SECURE_NONCE, pkceGenerator: PkceGenerator? = null, responseType: ResponseType = Code, idTokenConsumer: IdTokenConsumer = NoOp, accessTokenFetcherAuthenticator: AccessTokenFetcherAuthenticator = ClientSecretAccessTokenFetcherAuthenticator(providerConfig), jwtRedirectionUriBuilder: (RequestJwts) -> RedirectionUriBuilder = ::uriBuilderWithRequestJwt, redirectionUrlBuilder: RedirectionUriBuilder = defaultUriBuilder, accessTokenExtractor: AccessTokenExtractor = ContentTypeJsonOrForm(), responseMode: ResponseMode? = null, originalUri: (Request) -> Uri = Request::uri)

Provides a configured set of objects for use with an OAuth2 provider.

OAuthProviderConfig

data class OAuthProviderConfig(authBase: Uri, val authPath: String, val tokenPath: String, val credentials: Credentials, val apiBase: Uri = authBase, val authUri: Uri = authBase.extend(Uri.of(authPath)), val tokenUri: Uri = authBase.extend(Uri.of(tokenPath)))

OAuthRedirectionFilter

class OAuthRedirectionFilter(providerConfig: OAuthProviderConfig, callbackUri: Uri, scopes: List<String>, generateCrsf: CsrfGenerator = SECURE_CSRF, nonceGenerator: NonceGenerator = SECURE_NONCE, pkceGenerator: PkceGenerator? = null, modifyState: (Uri) -> Uri, oAuthPersistence: OAuthPersistence, responseType: ResponseType, redirectionBuilder: RedirectionUriBuilder = defaultUriBuilder, originalUri: (Request) -> Uri = Request::uri, responseMode: ResponseMode? = null) : Filter

OAuthWebForms

object OAuthWebForms

PkceChallengeAndVerifier

data class PkceChallengeAndVerifier(val challenge: String, val verifier: String)

PkceGenerator

typealias PkceGenerator = () -> PkceChallengeAndVerifier

RedirectionUriBuilder

typealias RedirectionUriBuilder = (Uri, AuthRequest, state: State, nonce: Nonce?) -> Uri

ResponseMode

enum ResponseMode : Enum<ResponseMode>

ResponseType

enum ResponseType : Enum<ResponseType>

State

data class State(val value: String)

Properties

accessTokenResponseBody

val accessTokenResponseBody: BiDiBodyLens<AccessTokenResponse>

defaultUriBuilder

val defaultUriBuilder: RedirectionUriBuilder

Functions

auth0

fun OAuthProvider.Companion.auth0(auth0Uri: Uri, client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence): OAuthProvider

Preconfigured OAuthProviders go here...

discord

fun OAuthProvider.Companion.discord(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence, scopes: List<String> = listOf()): OAuthProvider

dropbox

fun OAuthProvider.Companion.dropbox(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence): OAuthProvider

facebook

fun OAuthProvider.Companion.facebook(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence, scopes: List<String> = listOf("email")): OAuthProvider

fragmentParameter

fun Request.fragmentParameter(name: String): String?

Retrieves the first fragment parameter value with this name.

fun Request.fragmentParameter(name: String, value: String?): Request

(Copy &) Adds a query value with this name.

fun Uri.fragmentParameter(name: String, value: String?): Uri

fragmentParameters

fun Uri.fragmentParameters(): Parameters

fun Request.fragmentParameters(name: String): List<String?>

Retrieves all fragment parameters with this name.

gitHub

fun OAuthProvider.Companion.gitHub(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence, scopes: List<String> = listOf()): OAuthProvider

gitLab

fun OAuthProvider.Companion.gitLab(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence, scopes: List<String> = listOf()): OAuthProvider

google

fun OAuthProvider.Companion.google(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence, scopes: List<String> = listOf("openid")): OAuthProvider

removeFragmentParameter

fun Uri.removeFragmentParameter(name: String): Uri

soundCloud

fun OAuthProvider.Companion.soundCloud(client: HttpHandler, credentials: Credentials, callbackUri: Uri, oAuthPersistence: OAuthPersistence): OAuthProvider

uriBuilderWithRequestJwt

fun uriBuilderWithRequestJwt(requestJwts: RequestJwts): RedirectionUriBuilder