data class AuthorizationCodeDetails(val clientId: ClientId, val redirectUri: Uri, val expiresAt: Instant, val state: State?, val isOIDC: Boolean, val responseType: ResponseType = Code, val nonce: Nonce? = null)

AuthorizationCodeExpired

data object AuthorizationCodeExpired : AccessTokenError

AuthorizationCodes

interface AuthorizationCodes

Provides a consistent way to manage authorization codes

AuthorizationError

sealed class AuthorizationError : OAuthError

AuthRequest

data class AuthRequest(val client: ClientId, val scopes: List<String>, val redirectUri: Uri?, val state: State?, val responseType: ResponseType = Code, val nonce: Nonce? = null, val responseMode: ResponseMode? = null, val request: RequestJwtContainer? = null, val requestObject: RequestObject? = null, val additionalProperties: Map<String, Any> = emptyMap(), val codeChallenge: String? = null)

AuthRequestExtractor

fun interface AuthRequestExtractor

AuthRequestFromQueryParameters

object AuthRequestFromQueryParameters : AuthRequestExtractor

AuthRequestTracking

interface AuthRequestTracking

Provides a mechanism to track OAuth authorization parameters to be used later (i.e. can be used later to generate code and/or tokens)

AuthRequestTrackingFilter

class AuthRequestTrackingFilter(tracking: AuthRequestTracking, extractor: AuthRequestExtractor, authoriseRequestErrorRender: AuthoriseRequestErrorRender) : Filter

AuthRequestWithRequestAuthRequestExtractor

class AuthRequestWithRequestAuthRequestExtractor(requestJWTValidator: RequestJWTValidator, combineAuthRequestRequestStrategy: AuthRequestWithRequestAuthRequestExtractor.CombineAuthRequestRequestStrategy) : AuthRequestExtractor

ClientId

data class ClientId(val value: String)

ClientIdMismatch

data object ClientIdMismatch : AccessTokenError

ClientValidationFilter

class ClientValidationFilter(authoriseRequestValidator: AuthoriseRequestValidator, errorRenderer: AuthoriseRequestErrorRender, extractor: AuthRequestExtractor) : Filter

ClientValidator

interface ClientValidator

Provides a consistent way to retrieve clients attempting to use an authorization code flow

DefaultAccessTokenResponseRenderer

object DefaultAccessTokenResponseRenderer : AccessTokenResponseRenderer

ErrorResponse

data class ErrorResponse(val error: String, val error_description: String, val error_uri: String?)

FragmentResponseRender

class FragmentResponseRender(uri: Uri) : ResponseRender

GenerateAccessToken

class GenerateAccessToken(authorizationCodes: AuthorizationCodes, accessTokens: AccessTokens, clock: Clock, idTokens: IdTokens, refreshTokens: RefreshTokens, errorRenderer: JsonResponseErrorRenderer, grantTypes: GrantTypesConfiguration, tokenResponseRenderer: AccessTokenResponseRenderer = DefaultAccessTokenResponseRenderer) : Function1<request: Request, Response>

IdTokens

interface IdTokens

InsecureCookieBasedAuthRequestTracking

class InsecureCookieBasedAuthRequestTracking : AuthRequestTracking

InvalidAuthorizationRequest

data class InvalidAuthorizationRequest(val reason: String) : AuthorizationError

InvalidClientAssertion

data object InvalidClientAssertion : AccessTokenError

InvalidClientAssertionType

data object InvalidClientAssertionType : AccessTokenError

InvalidClientCredentials

data object InvalidClientCredentials : AccessTokenError

InvalidClientId

data object InvalidClientId : AuthorizationError

InvalidRedirectUri

data object InvalidRedirectUri : AuthorizationError

InvalidRequest

data class InvalidRequest(val message: String) : AccessTokenError

InvalidRequestObject

data object InvalidRequestObject : AuthorizationError

InvalidScopes

data object InvalidScopes : AuthorizationError

JsonResponseErrorRenderer

class JsonResponseErrorRenderer(json: AutoMarshalling, documentationUri: String? = null)

MissingAuthorizationCode

data object MissingAuthorizationCode : AccessTokenError

MissingRedirectUri

data object MissingRedirectUri : AccessTokenError

MustHaveRedirectUri

class MustHaveRedirectUri(delegate: AuthoriseRequestValidator) : AuthoriseRequestValidator

OAuthError

abstract class OAuthError(val rfcError: RfcError, val description: String)

OAuthServer

class OAuthServer(tokenPath: String, authRequestTracking: AuthRequestTracking, authoriseRequestValidator: AuthoriseRequestValidator, accessTokenRequestAuthentication: AccessTokenRequestAuthentication, authorizationCodes: AuthorizationCodes, accessTokens: AccessTokens, clock: Clock, json: AutoMarshalling = OAuthMoshi, authRequestExtractor: AuthRequestExtractor = AuthRequestFromQueryParameters, grantTypes: GrantTypesConfiguration = GrantTypesConfiguration.default(accessTokenRequestAuthentication), idTokens: IdTokens = IdTokens.Unsupported, refreshTokens: RefreshTokens = RefreshTokens.Unsupported, requestJWTValidator: RequestJWTValidator = RequestJWTValidator.Unsupported, documentationUri: String? = null, tokenResponseRenderer: AccessTokenResponseRenderer = DefaultAccessTokenResponseRenderer)

Provide help creating OAuth Authorization Server with Authorization Code Flow

OAuthServerMoshi

typealias ~~OAuthServerMoshi~~ = OAuthMoshi

QueryResponseRender

class QueryResponseRender(uri: Uri) : ResponseRender

RedirectUriMismatch

data object RedirectUriMismatch : AccessTokenError

ResponseRender

interface ResponseRender

RfcError

enum RfcError : Enum<RfcError>

SimpleAuthoriseRequestValidator

class SimpleAuthoriseRequestValidator(clientValidator: ClientValidator) : AuthoriseRequestValidator

TokenRequest

data class TokenRequest(val grantType: GrantType, val clientId: ClientId?, val clientSecret: String?, val code: String?, val redirectUri: Uri?, val scopes: List<String>, val clientAssertionType: Uri?, val clientAssertion: String?, val refreshToken: RefreshToken?)

UnsupportedGrantType

data class UnsupportedGrantType(val requestedGrantType: String) : AccessTokenError

UnsupportedResponseType

data class UnsupportedResponseType(val requestedResponseType: String) : AuthorizationError

UserRejectedRequest

data object UserRejectedRequest : AuthorizationError

Functions

authorizationRequest

fun Request.authorizationRequest(): AuthRequest