spring-security-config/org.springframework.security.config.web.server/ServerHttpSecurityDsl

ServerHttpSecurityDsl

class ServerHttpSecurityDsl(http: ServerHttpSecurity, init: ServerHttpSecurityDsl.() -> Unit)

A ServerHttpSecurity Kotlin DSL created by http { } in order to configure ServerHttpSecurity using idiomatic Kotlin code.

Author

Eleftheria Stein

Since

5.4

Parameters

init

the configurations to apply to the provided ServerHttpSecurity

Constructors

ServerHttpSecurityDsl

constructor(http: ServerHttpSecurity, init: ServerHttpSecurityDsl.() -> Unit)

Properties

authenticationManager

var authenticationManager: ReactiveAuthenticationManager?

the default ReactiveAuthenticationManager to use

securityContextRepository

var securityContextRepository: ServerSecurityContextRepository?

Functions

fun addFilterAfter(webFilter: WebFilter, order: SecurityWebFiltersOrder)

Adds a WebFilter after specific position.

fun addFilterAt(webFilter: WebFilter, order: SecurityWebFiltersOrder)

Adds a WebFilter at a specific position.

addFilterBefore

fun addFilterBefore(webFilter: WebFilter, order: SecurityWebFiltersOrder)

Adds a WebFilter before specific position.

fun anonymous(anonymousConfiguration: ServerAnonymousDsl.() -> Unit)

Enables and configures anonymous authentication.

authorizeExchange

fun authorizeExchange(authorizeExchangeConfiguration: AuthorizeExchangeDsl.() -> Unit)

Allows restricting access based upon the ServerWebExchange

fun cors(corsConfiguration: ServerCorsDsl.() -> Unit)

Allows configuring CORS.

fun csrf(csrfConfiguration: ServerCsrfDsl.() -> Unit)

Enables CSRF protection.

exceptionHandling

fun exceptionHandling(exceptionHandlingConfiguration: ServerExceptionHandlingDsl.() -> Unit)

Allows configuring exception handling.

fun formLogin(formLoginConfiguration: ServerFormLoginDsl.() -> Unit)

Enables form based authentication.

fun headers(headersConfiguration: ServerHeadersDsl.() -> Unit)

Allows configuring response headers.

fun httpBasic(httpBasicConfiguration: ServerHttpBasicDsl.() -> Unit)

Enables HTTP basic authentication.

fun logout(logoutConfiguration: ServerLogoutDsl.() -> Unit)

Provides logout support.

fun oauth2Client(oauth2ClientConfiguration: ServerOAuth2ClientDsl.() -> Unit)

Configures OAuth2 client support.

fun oauth2Login(oauth2LoginConfiguration: ServerOAuth2LoginDsl.() -> Unit)

Configures authentication support using an OAuth 2.0 and/or OpenID Connect 1.0 Provider. A ReactiveClientRegistrationRepository is required and must be registered as a Bean or configured via ServerOAuth2LoginDsl.clientRegistrationRepository.

oauth2ResourceServer

fun oauth2ResourceServer(oauth2ResourceServerConfiguration: ServerOAuth2ResourceServerDsl.() -> Unit)

Configures OAuth2 resource server support.

fun oidcLogout(oidcLogoutConfiguration: ServerOidcLogoutDsl.() -> Unit)

Configures logout support using an OpenID Connect 1.0 Provider. A ReactiveClientRegistrationRepository is required and must be registered as a Bean or configured via ServerOidcLogoutDsl.clientRegistrationRepository.

oneTimeTokenLogin

fun oneTimeTokenLogin(oneTimeTokenLoginConfiguration: ServerOneTimeTokenLoginDsl.() -> Unit)

Configures One-Time Token Login support.

passwordManagement

fun passwordManagement(passwordManagementConfiguration: ServerPasswordManagementDsl.() -> Unit)

Enables password management.

redirectToHttps

fun redirectToHttps(httpsRedirectConfiguration: ServerHttpsRedirectDsl.() -> Unit)

Allows configuring HTTPS redirection rules.

fun requestCache(requestCacheConfiguration: ServerRequestCacheDsl.() -> Unit)

Allows configuring request cache which is used when a flow is interrupted (i.e. due to requesting credentials) so that the request can be replayed after authentication.

securityMatcher

fun securityMatcher(securityMatcher: ServerWebExchangeMatcher)

Allows configuring the ServerHttpSecurity to only be invoked when matching the provided ServerWebExchangeMatcher.

sessionManagement

fun sessionManagement(sessionManagementConfig: ServerSessionManagementDsl.() -> Unit)

Configures Session Management support.

fun x509(x509Configuration: ServerX509Dsl.() -> Unit)

Adds X509 based pre authentication to an application using a certificate provided by a client.