From d71408e7d4db38ac460a2fd49ea7ba16bfd99b2c Mon Sep 17 00:00:00 2001 From: Jon Koops Date: Tue, 31 Jan 2023 12:55:41 +0100 Subject: [PATCH] Remove legacy cookies (ending in `_LEGACY`) --- .../keycloak/services/util/CookieHelper.java | 28 +------------------ .../oidc/endpoints/login-status-iframe.html | 6 +--- .../lb/SimpleUndertowLoadBalancer.java | 3 +- .../broker/KcOidcBrokerLogoutTest.java | 4 +-- ...henticationSessionFailoverClusterTest.java | 3 -- .../testsuite/cookies/CookieTest.java | 27 ------------------ .../federation/storage/UserStorageTest.java | 6 ---- 7 files changed, 4 insertions(+), 73 deletions(-) diff --git a/services/src/main/java/org/keycloak/services/util/CookieHelper.java b/services/src/main/java/org/keycloak/services/util/CookieHelper.java index f6a6743cb7a9..e0d8cf0f28f7 100755 --- a/services/src/main/java/org/keycloak/services/util/CookieHelper.java +++ b/services/src/main/java/org/keycloak/services/util/CookieHelper.java @@ -40,8 +40,6 @@ */ public class CookieHelper { - public static final String LEGACY_COOKIE = "_LEGACY"; - private static final Logger logger = Logger.getLogger(CookieHelper.class); /** @@ -71,11 +69,6 @@ public static void addCookie(String name, String value, String path, String doma ServerCookie.appendCookieValue(cookieBuf, 1, name, value, path, domain, comment, maxAge, secure_sameSite, httpOnly, sameSite); String cookie = cookieBuf.toString(); response.addHeader(HttpHeaders.SET_COOKIE, cookie); - - // a workaround for browser in older Apple OSs – browsers ignore cookies with SameSite=None - if (sameSiteParam == SameSiteAttributeValue.NONE) { - addCookie(name + LEGACY_COOKIE, value, path, domain, comment, maxAge, secure, httpOnly, null, session); - } } /** @@ -95,16 +88,6 @@ public static void addCookie(String name, String value, String path, String doma public static Set getCookieValue(KeycloakSession session, String name) { - Set ret = getInternalCookieValue(session, name); - if (ret.size() == 0) { - String legacy = name + LEGACY_COOKIE; - logger.debugv("Could not find any cookies with name '{0}', trying '{1}'", name, legacy); - ret = getInternalCookieValue(session, legacy); - } - return ret; - } - - private static Set getInternalCookieValue(KeycloakSession session, String name) { HttpHeaders headers = session.getContext().getHttpRequest().getHttpHeaders(); Set cookiesVal = new HashSet<>(); @@ -122,7 +105,6 @@ private static Set getInternalCookieValue(KeycloakSession session, Strin return cookiesVal; } - public static Set parseCookie(String header, String name) { if (header == null || name == null) { return Collections.emptySet(); @@ -141,14 +123,6 @@ public static Set parseCookie(String header, String name) { } public static Cookie getCookie(Map cookies, String name) { - Cookie cookie = cookies.get(name); - if (cookie != null) { - return cookie; - } - else { - String legacy = name + LEGACY_COOKIE; - logger.debugv("Could not find cookie {0}, trying {1}", name, legacy); - return cookies.get(legacy); - } + return cookies.get(name); } } diff --git a/services/src/main/resources/org/keycloak/protocol/oidc/endpoints/login-status-iframe.html b/services/src/main/resources/org/keycloak/protocol/oidc/endpoints/login-status-iframe.html index f1abfc2e418d..72ea13a5a08e 100755 --- a/services/src/main/resources/org/keycloak/protocol/oidc/endpoints/login-status-iframe.html +++ b/services/src/main/resources/org/keycloak/protocol/oidc/endpoints/login-status-iframe.html @@ -67,11 +67,7 @@ } function getCookie() { - var cookie = getCookieByName("KEYCLOAK_SESSION"); - if (cookie === null) { - return getCookieByName("KEYCLOAK_SESSION_LEGACY"); - } - return cookie; + return getCookieByName("KEYCLOAK_SESSION"); } function getCookieByName(name) { diff --git a/testsuite/integration-arquillian/servers/auth-server/undertow/src/main/java/org/keycloak/testsuite/arquillian/undertow/lb/SimpleUndertowLoadBalancer.java b/testsuite/integration-arquillian/servers/auth-server/undertow/src/main/java/org/keycloak/testsuite/arquillian/undertow/lb/SimpleUndertowLoadBalancer.java index 52d4774cdfc1..fd1b620f862f 100644 --- a/testsuite/integration-arquillian/servers/auth-server/undertow/src/main/java/org/keycloak/testsuite/arquillian/undertow/lb/SimpleUndertowLoadBalancer.java +++ b/testsuite/integration-arquillian/servers/auth-server/undertow/src/main/java/org/keycloak/testsuite/arquillian/undertow/lb/SimpleUndertowLoadBalancer.java @@ -52,7 +52,6 @@ import java.util.StringTokenizer; import static org.keycloak.services.managers.AuthenticationSessionManager.AUTH_SESSION_ID; -import static org.keycloak.services.util.CookieHelper.LEGACY_COOKIE; /** * Loadbalancer on embedded undertow. Supports sticky session over "AUTH_SESSION_ID" cookie and failover to different node when sticky node not available. @@ -177,7 +176,7 @@ static Map parseNodes(String nodes) { private HttpHandler createHandler() throws Exception { // TODO: configurable options if needed - String[] sessionIds = {AUTH_SESSION_ID, AUTH_SESSION_ID + LEGACY_COOKIE}; + String[] sessionIds = {AUTH_SESSION_ID}; int connectionsPerThread = 20; int problemServerRetry = 5; // In case of unavailable node, we will try to ping him every 5 seconds to check if it's back int maxTime = 3600000; // 1 hour for proxy request timeout, so we can debug the backend keycloak servers diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerLogoutTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerLogoutTest.java index f1ea10f0075a..338c95b5f3ab 100644 --- a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerLogoutTest.java +++ b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerLogoutTest.java @@ -107,10 +107,8 @@ public void logoutAfterBrowserRestart() { String idToken = response.getIdToken(); // simulate browser restart by deleting an identity cookie - log.debugf("Deleting %s and %s cookies", AuthenticationManager.KEYCLOAK_IDENTITY_COOKIE, - AuthenticationManager.KEYCLOAK_IDENTITY_COOKIE + CookieHelper.LEGACY_COOKIE); + log.debugf("Deleting %s cookie", AuthenticationManager.KEYCLOAK_IDENTITY_COOKIE); driver.manage().deleteCookieNamed(AuthenticationManager.KEYCLOAK_IDENTITY_COOKIE); - driver.manage().deleteCookieNamed(AuthenticationManager.KEYCLOAK_IDENTITY_COOKIE + CookieHelper.LEGACY_COOKIE); logoutFromRealm(getConsumerRoot(), bc.consumerRealmName(), null, idToken); driver.navigate().to(getAccountUrl(getProviderRoot(), REALM_PROV_NAME)); diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cluster/AuthenticationSessionFailoverClusterTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cluster/AuthenticationSessionFailoverClusterTest.java index 2dd2508c1fd9..8effaff1f5a9 100644 --- a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cluster/AuthenticationSessionFailoverClusterTest.java +++ b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cluster/AuthenticationSessionFailoverClusterTest.java @@ -114,9 +114,6 @@ protected void failoverTest(boolean expectSuccessfulFailover) throws IOException public static String getAuthSessionCookieValue(WebDriver driver) { Cookie authSessionCookie = driver.manage().getCookieNamed(AuthenticationSessionManager.AUTH_SESSION_ID); - if (authSessionCookie == null) { - authSessionCookie = driver.manage().getCookieNamed(AuthenticationSessionManager.AUTH_SESSION_ID + CookieHelper.LEGACY_COOKIE); - } Assert.assertNotNull(authSessionCookie); return authSessionCookie.getValue(); } diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cookies/CookieTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cookies/CookieTest.java index a7435e01ff6b..eabd190e1ae0 100644 --- a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cookies/CookieTest.java +++ b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cookies/CookieTest.java @@ -52,7 +52,6 @@ import static org.keycloak.services.managers.AuthenticationManager.KEYCLOAK_IDENTITY_COOKIE; import static org.keycloak.services.managers.AuthenticationManager.KEYCLOAK_SESSION_COOKIE; import static org.keycloak.services.managers.AuthenticationSessionManager.AUTH_SESSION_ID; -import static org.keycloak.services.util.CookieHelper.LEGACY_COOKIE; import static org.keycloak.testsuite.admin.AbstractAdminTest.loadJson; import static org.keycloak.testsuite.util.URLAssert.assertCurrentUrlStartsWithLoginUrlOf; @@ -86,11 +85,6 @@ public void testCookieValue() throws Exception { testCookieValue(KEYCLOAK_IDENTITY_COOKIE); } - @Test - public void testLegacyCookieValue() throws Exception { - testCookieValue(KEYCLOAK_IDENTITY_COOKIE + LEGACY_COOKIE); - } - private void testCookieValue(String cookieName) throws Exception { final String accountClientId = realmsResouce().realm("test").clients().findByClientId("account").get(0).getId(); final String clientSecret = realmsResouce().realm("test").clients().get(accountClientId).getSecret().getValue(); @@ -165,27 +159,6 @@ public void testCookieValueLoggedOut() throws Exception { } } - @Test - public void legacyCookiesTest() { - ContainerAssume.assumeAuthServerSSL(); - - accountPage.navigateTo(); - assertCurrentUrlStartsWithLoginUrlOf(accountPage); - - loginPage.login("test-user@localhost", "password"); - - Cookie sameSiteIdentityCookie = driver.manage().getCookieNamed(KEYCLOAK_IDENTITY_COOKIE); - Cookie legacyIdentityCookie = driver.manage().getCookieNamed(KEYCLOAK_IDENTITY_COOKIE + LEGACY_COOKIE); - Cookie sameSiteSessionCookie = driver.manage().getCookieNamed(KEYCLOAK_SESSION_COOKIE); - Cookie legacySessionCookie = driver.manage().getCookieNamed(KEYCLOAK_SESSION_COOKIE + LEGACY_COOKIE); - Cookie sameSiteAuthSessionIdCookie = driver.manage().getCookieNamed(AUTH_SESSION_ID); - Cookie legacyAuthSessionIdCookie = driver.manage().getCookieNamed(AUTH_SESSION_ID + LEGACY_COOKIE); - - assertSameSiteCookies(sameSiteIdentityCookie, legacyIdentityCookie); - assertSameSiteCookies(sameSiteSessionCookie, legacySessionCookie); - assertSameSiteCookies(sameSiteAuthSessionIdCookie, legacyAuthSessionIdCookie); - } - private void assertSameSiteCookies(Cookie sameSiteCookie, Cookie legacyCookie) { assertNotNull("SameSite cookie shouldn't be null", sameSiteCookie); assertNotNull("Legacy cookie shouldn't be null", legacyCookie); diff --git a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/federation/storage/UserStorageTest.java b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/federation/storage/UserStorageTest.java index 85d727187cdc..b0e48277c037 100644 --- a/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/federation/storage/UserStorageTest.java +++ b/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/federation/storage/UserStorageTest.java @@ -84,7 +84,6 @@ import static org.junit.Assert.fail; import static org.keycloak.models.UserModel.RequiredAction.UPDATE_PROFILE; import static org.keycloak.services.managers.AuthenticationManager.KEYCLOAK_SESSION_COOKIE; -import static org.keycloak.services.util.CookieHelper.LEGACY_COOKIE; import static org.keycloak.storage.UserStorageProviderModel.CACHE_POLICY; import static org.keycloak.storage.UserStorageProviderModel.EVICTION_DAY; import static org.keycloak.storage.UserStorageProviderModel.EVICTION_HOUR; @@ -254,16 +253,11 @@ public void testLoginSuccessWithSpecialCharacter() { assertCurrentUrlStartsWith(testRealmAccountPage); Cookie sameSiteSessionCookie = driver.manage().getCookieNamed(KEYCLOAK_SESSION_COOKIE); - Cookie legacySessionCookie = driver.manage().getCookieNamed(KEYCLOAK_SESSION_COOKIE + LEGACY_COOKIE); String cookieValue = sameSiteSessionCookie.getValue(); Assert.assertThat(cookieValue.contains("spécial"), is(false)); Assert.assertThat(cookieValue.contains("sp%C3%A9cial"), is(true)); - String legacyCookieValue = legacySessionCookie.getValue(); - Assert.assertThat(legacyCookieValue.contains("spécial"), is(false)); - Assert.assertThat(legacyCookieValue.contains("sp%C3%A9cial"), is(true)); - testRealmAccountPage.logOut(); }