diff --git a/webflux/src/main/java/org/springframework/security/web/server/authentication/RedirectAuthenticationEntryPoint.java b/webflux/src/main/java/org/springframework/security/web/server/authentication/RedirectAuthenticationEntryPoint.java new file mode 100644 index 0000000000..823494cd37 --- /dev/null +++ b/webflux/src/main/java/org/springframework/security/web/server/authentication/RedirectAuthenticationEntryPoint.java @@ -0,0 +1,66 @@ +/* + * + * * Copyright 2002-2017 the original author or authors. + * * + * * Licensed under the Apache License, Version 2.0 (the "License"); + * * you may not use this file except in compliance with the License. + * * You may obtain a copy of the License at + * * + * * http://www.apache.org/licenses/LICENSE-2.0 + * * + * * Unless required by applicable law or agreed to in writing, software + * * distributed under the License is distributed on an "AS IS" BASIS, + * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * * See the License for the specific language governing permissions and + * * limitations under the License. + * + */ + +package org.springframework.security.web.server.authentication; + +import java.net.URI; + +import reactor.core.publisher.Mono; + +import org.springframework.http.HttpStatus; +import org.springframework.http.server.reactive.ServerHttpResponse; +import org.springframework.security.core.AuthenticationException; +import org.springframework.security.web.server.AuthenticationEntryPoint; +import org.springframework.util.Assert; +import org.springframework.web.server.ServerWebExchange; + +/** + * Performs a redirect to a specified location. + * + * @author Rob Winch + * @since 5.0 + */ +public class RedirectAuthenticationEntryPoint implements AuthenticationEntryPoint { + private final URI location; + + private HttpStatus httpStatus = HttpStatus.FOUND; + + public RedirectAuthenticationEntryPoint(String location) { + Assert.notNull(location, "location cannot be null"); + this.location = URI.create(location); + } + + @Override + public Mono commence(ServerWebExchange exchange, AuthenticationException e) { + return Mono.fromRunnable(() -> { + ServerHttpResponse response = exchange.getResponse(); + response.setStatusCode(this.httpStatus); + response.getHeaders().setLocation(this.location); + }); + } + + /** + * Sets the {@link HttpStatus}. + * + * @param httpStatus the status to use. The default is {@code HttpStatus.FOUND} + */ + public void setHttpStatus(HttpStatus httpStatus) { + Assert.notNull(httpStatus, "httpStatus cannot be null"); + this.httpStatus = httpStatus; + } +} diff --git a/webflux/src/test/java/org/springframework/security/web/server/authentication/RedirectAuthenticationEntryPointTests.java b/webflux/src/test/java/org/springframework/security/web/server/authentication/RedirectAuthenticationEntryPointTests.java new file mode 100644 index 0000000000..d408a76669 --- /dev/null +++ b/webflux/src/test/java/org/springframework/security/web/server/authentication/RedirectAuthenticationEntryPointTests.java @@ -0,0 +1,93 @@ +/* + * + * * Copyright 2002-2017 the original author or authors. + * * + * * Licensed under the Apache License, Version 2.0 (the "License"); + * * you may not use this file except in compliance with the License. + * * You may obtain a copy of the License at + * * + * * http://www.apache.org/licenses/LICENSE-2.0 + * * + * * Unless required by applicable law or agreed to in writing, software + * * distributed under the License is distributed on an "AS IS" BASIS, + * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * * See the License for the specific language governing permissions and + * * limitations under the License. + * + */ + +package org.springframework.security.web.server.authentication; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; + +import org.springframework.http.HttpStatus; +import org.springframework.mock.http.server.reactive.MockServerHttpRequest; +import org.springframework.security.authentication.AuthenticationCredentialsNotFoundException; +import org.springframework.security.core.AuthenticationException; +import org.springframework.web.server.ServerWebExchange; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.verifyZeroInteractions; + +/** + * @author Rob Winch + * @since 5.0 + */ +@RunWith(MockitoJUnitRunner.class) +public class RedirectAuthenticationEntryPointTests { + + @Mock + private ServerWebExchange exchange; + + private String location = "/login"; + + private RedirectAuthenticationEntryPoint entryPoint = + new RedirectAuthenticationEntryPoint("/login"); + + private AuthenticationException exception = new AuthenticationCredentialsNotFoundException("Authentication Required"); + + + @Test(expected = IllegalArgumentException.class) + public void constructorStringWhenNullLocationThenException() { + new RedirectAuthenticationEntryPoint((String) null); + } + + @Test + public void commenceWhenNoSubscribersThenNoActions() { + this.entryPoint.commence(this.exchange, + this.exception); + + verifyZeroInteractions(this.exchange); + } + + @Test + public void commenceWhenSubscribeThenStatusAndLocationSet() { + this.exchange = MockServerHttpRequest.get("/").toExchange(); + + this.entryPoint.commence(this.exchange, this.exception).block(); + + assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo( + HttpStatus.FOUND); + assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath(this.location); + } + + @Test + public void commenceWhenCustomStatusThenStatusSet() { + HttpStatus status = HttpStatus.MOVED_PERMANENTLY; + this.entryPoint.setHttpStatus(status); + this.exchange = MockServerHttpRequest.get("/").toExchange(); + + this.entryPoint.commence(this.exchange, this.exception).block(); + + assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo(status); + assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath(this.location); + } + + @Test(expected = IllegalArgumentException.class) + public void setHttpStatusWhenNullLocationThenException() { + this.entryPoint.setHttpStatus(null); + } +}