SEC-1544: Added CookieClearingLogoutHandler and 'delete-cookies' attribute to the 'logout' namespace element.

When the user logs out, the handler will attempt to delete the named cookies (which it is constructor-injected with) by expiring them in the response.

Also added documentation on the feature and a suggestion for deleting JSESSIONID through an Apache proxy server, if the servlet container doesn't allow clearing the session cookie.

web/src/main/java/org/springframework/security/web/authentication/logout/CookieClearingLogoutHandler.java

@@ -1,7 +1,34 @@
 package org.springframework.security.web.authentication.logout;
 
+import java.util.*;
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.springframework.security.core.Authentication;
+import org.springframework.util.Assert;
+
 /**
+ * A logout handler which clears a defined list of cookies, using the context path as the
+ * cookie path.
+ *
  * @author Luke Taylor
+ * @since 3.1
  */
-public class CookieClearingLogoutHandler {
+public final class CookieClearingLogoutHandler implements LogoutHandler {
+    private final List<String> cookiesToClear;
+
+    public CookieClearingLogoutHandler(String... cookiesToClear) {
+        Assert.notNull(cookiesToClear, "List of cookies cannot be null");
+        this.cookiesToClear = Arrays.asList(cookiesToClear);
+    }
+
+    public void logout(HttpServletRequest request, HttpServletResponse response, Authentication authentication) {
+        for (String cookieName : cookiesToClear) {
+            Cookie cookie = new Cookie(cookieName, null);
+            cookie.setPath(request.getContextPath());
+            cookie.setMaxAge(0);
+            response.addCookie(cookie);
+        }
+    }
 }

web/src/test/java/org/springframework/security/web/authentication/logout/CookieClearingLogoutHandlerTests.java

@@ -1,7 +1,30 @@
 package org.springframework.security.web.authentication.logout;
 
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.mock;
+
+import javax.servlet.http.Cookie;
+
+import org.junit.Test;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.mock.web.MockHttpServletResponse;
+import org.springframework.security.core.Authentication;
+
 /**
  * @author Luke Taylor
  */
 public class CookieClearingLogoutHandlerTests {
+    @Test
+    public void configuredCookiesAreCleared() {
+        MockHttpServletResponse response = new MockHttpServletResponse();
+        MockHttpServletRequest request = new MockHttpServletRequest();
+        request.setContextPath("/app");
+        CookieClearingLogoutHandler handler = new CookieClearingLogoutHandler("my_cookie", "my_cookie_too");
+        handler.logout(request, response, mock(Authentication.class));
+        assertEquals(2, response.getCookies().length);
+        for (Cookie c : response.getCookies()) {
+            assertEquals("/app", c.getPath());
+            assertEquals(0, c.getMaxAge());
+        }
+    }
 }