SEC-1498: Allow use of absolute URL fopr login form in LoginUrlAuthenticationEntryPoint.

This commit is contained in:
Luke Taylor 2010-08-05 21:09:34 +01:00
parent e2ba500c3c
commit a2bd1bc9af
2 changed files with 65 additions and 38 deletions

View File

@ -15,8 +15,6 @@
package org.springframework.security.web.authentication; package org.springframework.security.web.authentication;
import java.io.IOException; import java.io.IOException;
import javax.servlet.RequestDispatcher; import javax.servlet.RequestDispatcher;
@ -43,17 +41,20 @@ import org.springframework.util.StringUtils;
/** /**
* Used by the {@link ExceptionTranslationFilter} to commence a form login * Used by the {@link ExceptionTranslationFilter} to commence a form login
* authentication via the {@link UsernamePasswordAuthenticationFilter}. This object * authentication via the {@link UsernamePasswordAuthenticationFilter}.
* holds the location of the login form, relative to the web app context path,
* and is used to commence a redirect to that form.
* <p> * <p>
* By setting the <em>forceHttps</em> property to true, you may configure the * Holds the location of the login form in the {@code loginFormUrl} property, and
* class to force the protocol used for the login form to be <code>HTTPS</code>, * uses that to build a redirect URL to the login page. Alternatively, an absolute URL
* can be set in this property and that will be used exclusively.
* <p>
* When using a relative URL, you can set the {@code forceHttps} property to true,
* to force the protocol used for the login form to be {@code HTTPS},
* even if the original intercepted request for a resource used the * even if the original intercepted request for a resource used the
* <code>HTTP</code> protocol. When this happens, after a successful login * {@code HTTP} protocol. When this happens, after a successful login
* (via HTTPS), the original resource will still be accessed as HTTP, via the * (via HTTPS), the original resource will still be accessed as HTTP, via the
* original request URL. For the forced HTTPS feature to work, the {@link * original request URL. For the forced HTTPS feature to work, the {@link
* PortMapper} is consulted to determine the HTTP:HTTPS pairs. * PortMapper} is consulted to determine the HTTP:HTTPS pairs. The value of
* {@code forceHttps} will have no effect if an absolute URL is used.
* *
* @author Ben Alex * @author Ben Alex
* @author colin sampaleanu * @author colin sampaleanu
@ -85,6 +86,9 @@ public class LoginUrlAuthenticationEntryPoint implements AuthenticationEntryPoin
public void afterPropertiesSet() throws Exception { public void afterPropertiesSet() throws Exception {
Assert.isTrue(StringUtils.hasText(loginFormUrl) && UrlUtils.isValidRedirectUrl(loginFormUrl), Assert.isTrue(StringUtils.hasText(loginFormUrl) && UrlUtils.isValidRedirectUrl(loginFormUrl),
"loginFormUrl must be specified and must be a valid redirect URL"); "loginFormUrl must be specified and must be a valid redirect URL");
if (useForward && UrlUtils.isAbsoluteUrl(loginFormUrl)) {
throw new IllegalArgumentException("useForward must be false if using an absolute loginFormURL");
}
Assert.notNull(portMapper, "portMapper must be specified"); Assert.notNull(portMapper, "portMapper must be specified");
Assert.notNull(portResolver, "portResolver must be specified"); Assert.notNull(portResolver, "portResolver must be specified");
} }
@ -146,6 +150,11 @@ public class LoginUrlAuthenticationEntryPoint implements AuthenticationEntryPoin
AuthenticationException authException) { AuthenticationException authException) {
String loginForm = determineUrlToUseForThisRequest(request, response, authException); String loginForm = determineUrlToUseForThisRequest(request, response, authException);
if (UrlUtils.isAbsoluteUrl(loginForm)) {
return loginForm;
}
int serverPort = portResolver.getServerPort(request); int serverPort = portResolver.getServerPort(request);
String scheme = request.getScheme(); String scheme = request.getScheme();
@ -217,8 +226,8 @@ public class LoginUrlAuthenticationEntryPoint implements AuthenticationEntryPoin
/** /**
* The URL where the <code>UsernamePasswordAuthenticationFilter</code> login * The URL where the <code>UsernamePasswordAuthenticationFilter</code> login
* page can be found. Should be relative to the web-app context path, and * page can be found. Should either be relative to the web-app context path
* include a leading <code>/</code> * (include a leading {@code /}) or an absolute URL.
*/ */
public void setLoginFormUrl(String loginFormUrl) { public void setLoginFormUrl(String loginFormUrl) {
this.loginFormUrl = loginFormUrl; this.loginFormUrl = loginFormUrl;
@ -245,10 +254,11 @@ public class LoginUrlAuthenticationEntryPoint implements AuthenticationEntryPoin
} }
/** /**
* Tells if we are to do a forward to the <code>loginFormUrl</code> using the <tt>RequestDispatcher</tt>, * Tells if we are to do a forward to the {@code loginFormUrl} using the {@code RequestDispatcher},
* instead of a 302 redirect. * instead of a 302 redirect.
* *
* @param useForward * @param useForward true if a forward to the login page should be used. Must be false (the default) if
* {@code loginFormUrl} is set to an absolute value.
*/ */
public void setUseForward(boolean useForward) { public void setUseForward(boolean useForward) {
this.useForward = useForward; this.useForward = useForward;

View File

@ -15,18 +15,15 @@
package org.springframework.security.web.authentication; package org.springframework.security.web.authentication;
import junit.framework.TestCase; import static org.junit.Assert.*;
import org.springframework.security.MockPortResolver; import java.util.*;
import org.springframework.security.web.PortMapperImpl;
import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
import org.junit.Test;
import org.springframework.mock.web.MockHttpServletRequest; import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse; import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.security.MockPortResolver;
import java.util.HashMap; import org.springframework.security.web.PortMapperImpl;
import java.util.Map;
/** /**
@ -35,45 +32,36 @@ import java.util.Map;
* @author Ben Alex * @author Ben Alex
* @author colin sampaleanu * @author colin sampaleanu
*/ */
public class LoginUrlAuthenticationEntryPointTests extends TestCase { public class LoginUrlAuthenticationEntryPointTests {
//~ Methods ======================================================================================================== //~ Methods ========================================================================================================
@Test(expected=IllegalArgumentException.class)
public void testDetectsMissingLoginFormUrl() throws Exception { public void testDetectsMissingLoginFormUrl() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setPortMapper(new PortMapperImpl()); ep.setPortMapper(new PortMapperImpl());
ep.setPortResolver(new MockPortResolver(80, 443)); ep.setPortResolver(new MockPortResolver(80, 443));
ep.afterPropertiesSet();
try {
ep.afterPropertiesSet();
fail("Should have thrown IllegalArgumentException");
} catch (IllegalArgumentException expected) {
}
} }
@Test(expected=IllegalArgumentException.class)
public void testDetectsMissingPortMapper() throws Exception { public void testDetectsMissingPortMapper() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("xxx"); ep.setLoginFormUrl("xxx");
ep.setPortMapper(null); ep.setPortMapper(null);
try { ep.afterPropertiesSet();
ep.afterPropertiesSet();
fail("Should have thrown IllegalArgumentException");
} catch (IllegalArgumentException expected) {
}
} }
@Test(expected=IllegalArgumentException.class)
public void testDetectsMissingPortResolver() throws Exception { public void testDetectsMissingPortResolver() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("xxx"); ep.setLoginFormUrl("xxx");
ep.setPortResolver(null); ep.setPortResolver(null);
try { ep.afterPropertiesSet();
ep.afterPropertiesSet();
fail("Should have thrown IllegalArgumentException");
} catch (IllegalArgumentException expected) {
}
} }
@Test
public void testGettersSetters() { public void testGettersSetters() {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("/hello"); ep.setLoginFormUrl("/hello");
@ -87,8 +75,12 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertFalse(ep.isForceHttps()); assertFalse(ep.isForceHttps());
ep.setForceHttps(true); ep.setForceHttps(true);
assertTrue(ep.isForceHttps()); assertTrue(ep.isForceHttps());
assertFalse(ep.isUseForward());
ep.setUseForward(true);
assertTrue(ep.isUseForward());
} }
@Test
public void testHttpsOperationFromOriginalHttpUrl() throws Exception { public void testHttpsOperationFromOriginalHttpUrl() throws Exception {
MockHttpServletRequest request = new MockHttpServletRequest(); MockHttpServletRequest request = new MockHttpServletRequest();
request.setRequestURI("/some_path"); request.setRequestURI("/some_path");
@ -140,6 +132,7 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertEquals("https://www.example.com:9999/bigWebApp/hello", response.getRedirectedUrl()); assertEquals("https://www.example.com:9999/bigWebApp/hello", response.getRedirectedUrl());
} }
@Test
public void testHttpsOperationFromOriginalHttpsUrl() throws Exception { public void testHttpsOperationFromOriginalHttpsUrl() throws Exception {
MockHttpServletRequest request = new MockHttpServletRequest(); MockHttpServletRequest request = new MockHttpServletRequest();
request.setRequestURI("/some_path"); request.setRequestURI("/some_path");
@ -168,6 +161,7 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertEquals("https://www.example.com:8443/bigWebApp/hello", response.getRedirectedUrl()); assertEquals("https://www.example.com:8443/bigWebApp/hello", response.getRedirectedUrl());
} }
@Test
public void testNormalOperation() throws Exception { public void testNormalOperation() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("/hello"); ep.setLoginFormUrl("/hello");
@ -189,6 +183,7 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertEquals("http://www.example.com/bigWebApp/hello", response.getRedirectedUrl()); assertEquals("http://www.example.com/bigWebApp/hello", response.getRedirectedUrl());
} }
@Test
public void testOperationWhenHttpsRequestsButHttpsPortUnknown() throws Exception { public void testOperationWhenHttpsRequestsButHttpsPortUnknown() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("/hello"); ep.setLoginFormUrl("/hello");
@ -212,6 +207,7 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertEquals("http://www.example.com:8888/bigWebApp/hello", response.getRedirectedUrl()); assertEquals("http://www.example.com:8888/bigWebApp/hello", response.getRedirectedUrl());
} }
@Test
public void testServerSideRedirectWithoutForceHttpsForwardsToLoginPage() throws Exception { public void testServerSideRedirectWithoutForceHttpsForwardsToLoginPage() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("/hello"); ep.setLoginFormUrl("/hello");
@ -232,6 +228,7 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertEquals("/hello", response.getForwardedUrl()); assertEquals("/hello", response.getForwardedUrl());
} }
@Test
public void testServerSideRedirectWithForceHttpsRedirectsCurrentRequest() throws Exception { public void testServerSideRedirectWithForceHttpsRedirectsCurrentRequest() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint(); LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
ep.setLoginFormUrl("/hello"); ep.setLoginFormUrl("/hello");
@ -253,4 +250,24 @@ public class LoginUrlAuthenticationEntryPointTests extends TestCase {
assertEquals("https://www.example.com/bigWebApp/some_path", response.getRedirectedUrl()); assertEquals("https://www.example.com/bigWebApp/some_path", response.getRedirectedUrl());
} }
// SEC-1498
@Test
public void absoluteLoginFormUrlIsSupported() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
final String loginFormUrl = "http://somesite.com/login";
ep.setLoginFormUrl(loginFormUrl);
ep.afterPropertiesSet();
MockHttpServletResponse response = new MockHttpServletResponse();
ep.commence(new MockHttpServletRequest("GET", "/someUrl"), response, null);
assertEquals(loginFormUrl, response.getRedirectedUrl());
}
@Test(expected=IllegalArgumentException.class)
public void absoluteLoginFormUrlCantBeUsedWithForwarding() throws Exception {
LoginUrlAuthenticationEntryPoint ep = new LoginUrlAuthenticationEntryPoint();
final String loginFormUrl = "http://somesite.com/login";
ep.setLoginFormUrl(loginFormUrl);
ep.setUseForward(true);
ep.afterPropertiesSet();
}
} }