Class SecurityMockServerConfigurers
java.lang.Object
org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers
Test utilities for working with Spring Security and
WebTestClient.Builder.apply(WebTestClientConfigurer)
.- Since:
- 5.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static final class
Updates the WebServerExchange using{@link SecurityMockServerConfigurers#mockAuthentication(Authentication)}
.static final class
static final class
static final class
static final class
static final class
Updates the WebServerExchange using{@link SecurityMockServerConfigurers#mockUser(UserDetails)}
. -
Method Summary
Modifier and TypeMethodDescriptioncsrf()
static <T extends org.springframework.test.web.reactive.server.WebTestClientConfigurer & org.springframework.test.web.reactive.server.MockServerConfigurer>
TmockAuthentication
(Authentication authentication) Updates the ServerWebExchange to use the provided Authentication as the PrincipalmockJwt()
Updates the ServerWebExchange to establish aSecurityContext
that has aJwtAuthenticationToken
for theAuthentication
and aJwt
for theAuthentication.getPrincipal()
.Updates the ServerWebExchange to establish aOAuth2AuthorizedClient
in the session.mockOAuth2Client
(String registrationId) Updates the ServerWebExchange to establish aOAuth2AuthorizedClient
in the session.Updates the ServerWebExchange to establish aSecurityContext
that has aOAuth2AuthenticationToken
for theAuthentication
.Updates the ServerWebExchange to establish aSecurityContext
that has aOAuth2AuthenticationToken
for theAuthentication
.Updates the ServerWebExchange to establish aSecurityContext
that has aBearerTokenAuthentication
for theAuthentication
and anOAuth2AuthenticatedPrincipal
for theAuthentication.getPrincipal()
.mockUser()
Updates the ServerWebExchange to use a UserDetails to create a UsernamePasswordAuthenticationToken as the Principal.Updates the ServerWebExchange to use a UserDetails to create a UsernamePasswordAuthenticationToken as the Principal.static <T extends org.springframework.test.web.reactive.server.WebTestClientConfigurer & org.springframework.test.web.reactive.server.MockServerConfigurer>
TmockUser
(UserDetails userDetails) Updates the ServerWebExchange to use the provided UserDetails to create a UsernamePasswordAuthenticationToken as the Principalstatic org.springframework.test.web.reactive.server.MockServerConfigurer
Sets up Spring Security'sWebTestClient
test support
-
Method Details
-
springSecurity
public static org.springframework.test.web.reactive.server.MockServerConfigurer springSecurity()Sets up Spring Security'sWebTestClient
test support- Returns:
- the MockServerConfigurer to use
-
mockAuthentication
public static <T extends org.springframework.test.web.reactive.server.WebTestClientConfigurer & org.springframework.test.web.reactive.server.MockServerConfigurer> T mockAuthentication(Authentication authentication) Updates the ServerWebExchange to use the provided Authentication as the Principal- Parameters:
authentication
- the Authentication to use.- Returns:
- the configurer to use
-
mockUser
public static <T extends org.springframework.test.web.reactive.server.WebTestClientConfigurer & org.springframework.test.web.reactive.server.MockServerConfigurer> T mockUser(UserDetails userDetails) Updates the ServerWebExchange to use the provided UserDetails to create a UsernamePasswordAuthenticationToken as the Principal- Parameters:
userDetails
- the UserDetails to use.- Returns:
- the configurer to use
-
mockUser
Updates the ServerWebExchange to use a UserDetails to create a UsernamePasswordAuthenticationToken as the Principal. This uses a default username of "user", password of "password", and granted authorities of "ROLE_USER".- Returns:
- the
SecurityMockServerConfigurers.UserExchangeMutator
to use
-
mockUser
Updates the ServerWebExchange to use a UserDetails to create a UsernamePasswordAuthenticationToken as the Principal. This uses a default password of "password" and granted authorities of "ROLE_USER".- Returns:
- the
WebTestClientConfigurer
to use
-
mockJwt
Updates the ServerWebExchange to establish aSecurityContext
that has aJwtAuthenticationToken
for theAuthentication
and aJwt
for theAuthentication.getPrincipal()
. All details are declarative and do not require the JWT to be valid.- Returns:
- the
SecurityMockServerConfigurers.JwtMutator
to further configure or use - Since:
- 5.2
-
mockOpaqueToken
Updates the ServerWebExchange to establish aSecurityContext
that has aBearerTokenAuthentication
for theAuthentication
and anOAuth2AuthenticatedPrincipal
for theAuthentication.getPrincipal()
. All details are declarative and do not require the token to be valid.- Returns:
- the
SecurityMockServerConfigurers.OpaqueTokenMutator
to further configure or use - Since:
- 5.3
-
mockOAuth2Login
Updates the ServerWebExchange to establish aSecurityContext
that has aOAuth2AuthenticationToken
for theAuthentication
. All details are declarative and do not require the corresponding OAuth 2.0 tokens to be valid.- Returns:
- the
SecurityMockServerConfigurers.OAuth2LoginMutator
to further configure or use - Since:
- 5.3
-
mockOidcLogin
Updates the ServerWebExchange to establish aSecurityContext
that has aOAuth2AuthenticationToken
for theAuthentication
. All details are declarative and do not require the corresponding OAuth 2.0 tokens to be valid.- Returns:
- the
SecurityMockServerConfigurers.OidcLoginMutator
to further configure or use - Since:
- 5.3
-
mockOAuth2Client
Updates the ServerWebExchange to establish aOAuth2AuthorizedClient
in the session. All details are declarative and do not require the corresponding OAuth 2.0 tokens to be valid.The support works by associating the authorized client to the ServerWebExchange using a
ServerOAuth2AuthorizedClientRepository
- Returns:
- the
SecurityMockServerConfigurers.OAuth2ClientMutator
to further configure or use - Since:
- 5.3
-
mockOAuth2Client
public static SecurityMockServerConfigurers.OAuth2ClientMutator mockOAuth2Client(String registrationId) Updates the ServerWebExchange to establish aOAuth2AuthorizedClient
in the session. All details are declarative and do not require the corresponding OAuth 2.0 tokens to be valid.The support works by associating the authorized client to the ServerWebExchange using a
ServerOAuth2AuthorizedClientRepository
- Parameters:
registrationId
- The registration id associated with theOAuth2AuthorizedClient
- Returns:
- the
SecurityMockServerConfigurers.OAuth2ClientMutator
to further configure or use - Since:
- 5.3
-
csrf
-