api

http4k / org.http4k.security.oauth.server / OAuthServer

OAuthServer

class OAuthServer

Provide help creating OAuth Authorization Server with Authorization Code Flow

References:

Authorization Code Grant flow spec: https://tools.ietf.org/html/rfc6749#page-23
OAuth 2 Security Best Current Practices: https://tools.ietf.org/html/draft-ietf-oauth-security-topics-11

Constructors

Name Summary

<init> OAuthServer(tokenPath: String, authRequestTracking: AuthRequestTracking, clientValidator: ClientValidator, authorizationCodes: AuthorizationCodes, accessTokens: AccessTokens, json: AutoMarshallingJson<*>, clock: Clock, authRequestExtractor: AuthRequestExtractor = AuthRequestFromQueryParameters, grantTypes: GrantTypesConfiguration = GrantTypesConfiguration.default(ClientSecretAccessTokenRequestAuthentication(clientValidator)), idTokens: IdTokens = IdTokens.Unsupported, refreshTokens: RefreshTokens = RefreshTokens.unsupported, requestJWTValidator: RequestJWTValidator = RequestJWTValidator.Unsupported, documentationUri: String? = null)
Provide help creating OAuth Authorization Server with Authorization Code FlowOAuthServer(tokenPath: String, authRequestTracking: AuthRequestTracking, authoriseRequestValidator: AuthoriseRequestValidator, accessTokenRequestAuthentication: AccessTokenRequestAuthentication, authorizationCodes: AuthorizationCodes, accessTokens: AccessTokens, json: AutoMarshallingJson<*>, clock: Clock, authRequestExtractor: AuthRequestExtractor = AuthRequestFromQueryParameters, grantTypes: GrantTypesConfiguration = GrantTypesConfiguration.default(accessTokenRequestAuthentication), idTokens: IdTokens = IdTokens.Unsupported, refreshTokens: RefreshTokens = RefreshTokens.unsupported, requestJWTValidator: RequestJWTValidator = RequestJWTValidator.Unsupported, documentationUri: String? = null)

Name	Summary
<init>	`OAuthServer(tokenPath:` `String, authRequestTracking:` `AuthRequestTracking, clientValidator:` `ClientValidator, authorizationCodes:` `AuthorizationCodes, accessTokens:` `AccessTokens, json:` `AutoMarshallingJson<>, clock:` `Clock, authRequestExtractor:` `AuthRequestExtractor` `= AuthRequestFromQueryParameters, grantTypes:` `GrantTypesConfiguration` `= GrantTypesConfiguration.default(ClientSecretAccessTokenRequestAuthentication(clientValidator)), idTokens:` `IdTokens` `= IdTokens.Unsupported, refreshTokens:` `RefreshTokens` `= RefreshTokens.unsupported, requestJWTValidator:` `RequestJWTValidator` `= RequestJWTValidator.Unsupported, documentationUri:` `String? = null)` Provide help creating OAuth Authorization Server with Authorization Code Flow`OAuthServer(tokenPath:` `String, authRequestTracking:` `AuthRequestTracking, authoriseRequestValidator:` `AuthoriseRequestValidator, accessTokenRequestAuthentication:` `AccessTokenRequestAuthentication, authorizationCodes:` `AuthorizationCodes, accessTokens:` `AccessTokens, json:` `AutoMarshallingJson<>, clock:` `Clock, authRequestExtractor:` `AuthRequestExtractor` `= AuthRequestFromQueryParameters, grantTypes:` `GrantTypesConfiguration` `= GrantTypesConfiguration.default(accessTokenRequestAuthentication), idTokens:` `IdTokens` `= IdTokens.Unsupported, refreshTokens:` `RefreshTokens` `= RefreshTokens.unsupported, requestJWTValidator:` `RequestJWTValidator` `= RequestJWTValidator.Unsupported, documentationUri:` `String? = null)`

Properties

Name	Summary
authenticationComplete	`val authenticationComplete:` `AuthenticationComplete`
authenticationStart	`val authenticationStart:` `Filter`
tokenRoute	`val tokenRoute:` `RoutingHttpHandler`

Companion Object Properties

Name	Summary
clientAssertion	`val clientAssertion:` `BiDiLens<WebForm,` `String?>`
clientAssertionType	`val clientAssertionType:` `BiDiLens<WebForm,` `Uri?>`
clientIdForm	`val clientIdForm:` `BiDiLens<WebForm,` `ClientId?>`
clientIdQueryParameter	`val clientIdQueryParameter:` `BiDiLens<Request,` `ClientId>`
clientSecret	`val clientSecret:` `BiDiLens<WebForm,` `String?>`
code	`val code:` `BiDiLens<WebForm,` `String?>`
nonce	`val nonce:` `BiDiLens<Request,` `Nonce?>`
redirectUriForm	`val redirectUriForm:` `BiDiLens<WebForm,` `Uri?>`
redirectUriQueryParameter	`val redirectUriQueryParameter:` `BiDiLens<Request,` `Uri?>`
refreshToken	`val refreshToken:` `BiDiLens<WebForm,` `String?>`
request	`val request:` `BiDiLens<Request,` `RequestJwtContainer?>`
responseMode	`val responseMode:` `BiDiLens<Request,` `ResponseMode?>`
responseType	`val responseType:` `BiDiLens<Request,` `ResponseType>`
scopesForm	`val scopesForm:` `BiDiLens<WebForm,` `List<String>?>`
scopesQueryParameter	`val scopesQueryParameter:` `BiDiLens<Request,` `List<String>?>`
state	`val state:` `BiDiLens<Request,` `State?>`
tokenRequestWebForm	`val tokenRequestWebForm:` `BiDiBodyLens<WebForm>`