spring-security-config/org.springframework.security.config.annotation.web/OAuth2LoginDsl

OAuth2LoginDsl

class OAuth2LoginDsl

A Kotlin DSL to configure HttpSecurity OAuth 2.0 login using idiomatic Kotlin code.

Author

Eleftheria Stein

Since

5.3

Constructors

constructor()

Properties

authenticationDetailsSource

var authenticationDetailsSource: AuthenticationDetailsSource<HttpServletRequest, *>?

authenticationFailureHandler

var authenticationFailureHandler: AuthenticationFailureHandler?

the AuthenticationFailureHandler used after authentication success

authenticationSuccessHandler

var authenticationSuccessHandler: AuthenticationSuccessHandler?

the AuthenticationSuccessHandler used after authentication success

authorizedClientRepository

var authorizedClientRepository: OAuth2AuthorizedClientRepository?

the repository for authorized client(s).

authorizedClientService

var authorizedClientService: OAuth2AuthorizedClientService?

the service for authorized client(s).

clientRegistrationRepository

var clientRegistrationRepository: ClientRegistrationRepository?

the repository of client registrations.

var failureUrl: String?

the URL to send users if authentication fails

var loginPage: String?

the login page to redirect to if authentication is required (i.e. "/login")

loginProcessingUrl

var loginProcessingUrl: String?

the URL to validate the credentials

oidcSessionRegistry

var oidcSessionRegistry: OidcSessionRegistry?

var permitAll: Boolean?

whether to grant access to the urls for failureUrl as well as for the HttpSecurityBuilder, the loginPage and loginProcessingUrl for every user

Functions

authorizationEndpoint

fun authorizationEndpoint(authorizationEndpointConfig: AuthorizationEndpointDsl.() -> Unit)

Configures the Authorization Server's Authorization Endpoint.

defaultSuccessUrl

fun defaultSuccessUrl(defaultSuccessUrl: String, alwaysUse: Boolean)

Specifies where users will be redirected after authenticating successfully if they have not visited a secured page prior to authenticating or alwaysUse is true.

fun permitAll()

Grants access to the urls for failureUrl as well as for the HttpSecurityBuilder, the loginPage and loginProcessingUrl for every user.

redirectionEndpoint

fun redirectionEndpoint(redirectionEndpointConfig: RedirectionEndpointDsl.() -> Unit)

Configures the Authorization Server's Redirection Endpoint.

fun tokenEndpoint(tokenEndpointConfig: TokenEndpointDsl.() -> Unit)

Configures the Authorization Server's Token Endpoint.

userInfoEndpoint

fun userInfoEndpoint(userInfoEndpointConfig: UserInfoEndpointDsl.() -> Unit)

Configures the Authorization Server's UserInfo Endpoint.