Add reactive RedirectStrategy

Fixes gh-4529

webflux/src/main/java/org/springframework/security/web/server/DefaultRedirectStrategy.java

@@ -0,0 +1,73 @@
+/*
+ *
+ *  * 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;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.server.reactive.ServerHttpResponse;
+import org.springframework.util.Assert;
+import org.springframework.web.server.ServerWebExchange;
+import reactor.core.publisher.Mono;
+
+import java.net.URI;
+
+/**
+ * @author Rob Winch
+ * @since 5.0
+ */
+public class DefaultRedirectStrategy implements RedirectStrategy {
+	private HttpStatus httpStatus = HttpStatus.FOUND;
+
+	private boolean contextRelative = true;
+
+	public Mono<Void> sendRedirect(ServerWebExchange exchange, URI location) {
+		Assert.notNull(exchange, "exchange cannot be null");
+		Assert.notNull(location, "location cannot be null");
+		return Mono.fromRunnable(() -> {
+			ServerHttpResponse response = exchange.getResponse();
+			response.setStatusCode(this.httpStatus);
+			response.getHeaders().setLocation(createLocation(exchange, location));
+		});
+	}
+
+	private URI createLocation(ServerWebExchange exchange, URI location) {
+		if(!this.contextRelative) {
+			return location;
+		}
+		String url = location.toASCIIString();
+		if(url.startsWith("/")) {
+			String context = exchange.getRequest().getPath().contextPath().value();
+			return URI.create(context + url);
+		}
+		return location;
+	}
+
+	public void setHttpStatus(HttpStatus httpStatus) {
+		Assert.notNull(httpStatus, "httpStatus cannot be null");
+		this.httpStatus = httpStatus;
+	}
+
+	/**
+	 * Sets if the location is relative to the context.
+	 * @param contextRelative if redirects should be relative to the context.
+	   Default is true.
+	 */
+	public void setContextRelative(boolean contextRelative) {
+		this.contextRelative = contextRelative;
+	}
+}

webflux/src/main/java/org/springframework/security/web/server/RedirectStrategy.java

@@ -0,0 +1,34 @@
+/*
+ *
+ *  * 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;
+
+import java.net.URI;
+
+import reactor.core.publisher.Mono;
+
+import org.springframework.web.server.ServerWebExchange;
+
+/**
+ * @author Rob Winch
+ * @since 5.0
+ */
+public interface RedirectStrategy {
+
+	Mono<Void> sendRedirect(ServerWebExchange exchange, URI location);
+}

webflux/src/test/java/org/springframework/security/web/server/DefaultRedirectStrategyTests.java

@@ -0,0 +1,130 @@
+/*
+ *
+ *  * 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;
+
+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.security.web.server.authentication.RedirectAuthenticationEntryPoint;
+import org.springframework.web.server.ServerWebExchange;
+
+import java.net.URI;
+
+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 DefaultRedirectStrategyTests {
+
+	@Mock
+	private ServerWebExchange exchange;
+
+	private URI location = URI.create("/login");
+
+	private DefaultRedirectStrategy strategy =
+		new DefaultRedirectStrategy();
+
+	private AuthenticationException exception = new AuthenticationCredentialsNotFoundException("Authentication Required");
+
+	@Test(expected = IllegalArgumentException.class)
+	public void sendRedirectWhenLocationNullThenException() {
+		this.strategy.sendRedirect(this.exchange, (URI) null);
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void sendRedirectWhenExchangeNullThenException() {
+		this.strategy.sendRedirect((ServerWebExchange) null, this.location);
+	}
+
+	@Test
+	public void sendRedirectWhenNoSubscribersThenNoActions() {
+		this.strategy.sendRedirect(this.exchange, this.location);
+
+		verifyZeroInteractions(this.exchange);
+	}
+
+	@Test
+	public void sendRedirectWhenNoContextThenStatusAndLocationSet() {
+		this.exchange = MockServerHttpRequest.get("/").toExchange();
+
+		this.strategy.sendRedirect(this.exchange, this.location).block();
+
+		assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo(
+			HttpStatus.FOUND);
+		assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath(this.location.getPath());
+	}
+
+	@Test
+	public void sendRedirectWhenContextPathSetThenStatusAndLocationSet() {
+		this.exchange = MockServerHttpRequest.get("/context/foo").contextPath("/context").toExchange();
+
+		this.strategy.sendRedirect(this.exchange, this.location).block();
+
+		assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo(HttpStatus.FOUND);
+		assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath("/context" + this.location.getPath());
+	}
+
+	@Test
+	public void sendRedirectWhenContextPathSetAndAbsoluteURLThenStatusAndLocationSet() {
+		this.location = URI.create("https://example.com/foo/bar");
+		this.exchange = MockServerHttpRequest.get("/context/foo").contextPath("/context").toExchange();
+
+		this.strategy.sendRedirect(this.exchange, this.location).block();
+
+		assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo(HttpStatus.FOUND);
+		assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath(this.location.getPath());
+	}
+
+	@Test
+	public void sendRedirectWhenContextPathSetAndDisabledThenStatusAndLocationSet() {
+		this.strategy.setContextRelative(false);
+		this.exchange = MockServerHttpRequest.get("/context/foo").contextPath("/context").toExchange();
+
+		this.strategy.sendRedirect(this.exchange, this.location).block();
+
+		assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo(HttpStatus.FOUND);
+		assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath(this.location.getPath());
+	}
+
+	@Test
+	public void sendRedirectWhenCustomStatusThenStatusSet() {
+		HttpStatus status = HttpStatus.MOVED_PERMANENTLY;
+		this.strategy.setHttpStatus(status);
+		this.exchange = MockServerHttpRequest.get("/").toExchange();
+
+		this.strategy.sendRedirect(this.exchange, this.location).block();
+
+		assertThat(this.exchange.getResponse().getStatusCode()).isEqualTo(status);
+		assertThat(this.exchange.getResponse().getHeaders().getLocation()).hasPath(this.location.getPath());
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void setHttpStatusWhenNullLocationThenException() {
+		this.strategy.setHttpStatus(null);
+	}
+}