Refac: gh-16889 - Remove deprecated cookie comment and verison methods

M-Faheem-Khan · M-Faheem-Khan · commit e68c63c3f094 · 2025-04-27T23:53:19.000-04:00
Signed-off-by: M-Faheem-Khan &lt;faheem5948@gmail.com&gt;
diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServices.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServices.java
@@ -372,9 +372,6 @@ protected void setCookie(String[] tokens, int maxAge, HttpServletRequest request
 		if (this.cookieDomain != null) {
 			cookie.setDomain(this.cookieDomain);
 		}
-		if (maxAge < 1) {
-			cookie.setVersion(1);
-		}
 		cookie.setSecure((this.useSecureCookie != null) ? this.useSecureCookie : request.isSecure());
 		cookie.setHttpOnly(true);
 
diff --git a/web/src/main/java/org/springframework/security/web/firewall/FirewalledResponse.java b/web/src/main/java/org/springframework/security/web/firewall/FirewalledResponse.java
@@ -67,7 +67,6 @@ public void addCookie(Cookie cookie) {
 			validateCrlf(SET_COOKIE_HEADER, cookie.getValue());
 			validateCrlf(SET_COOKIE_HEADER, cookie.getPath());
 			validateCrlf(SET_COOKIE_HEADER, cookie.getDomain());
-			validateCrlf(SET_COOKIE_HEADER, cookie.getComment());
 		}
 		super.addCookie(cookie);
 	}
diff --git a/web/src/main/java/org/springframework/security/web/jackson2/CookieDeserializer.java b/web/src/main/java/org/springframework/security/web/jackson2/CookieDeserializer.java
@@ -45,11 +45,9 @@ public Cookie deserialize(JsonParser jp, DeserializationContext ctxt) throws IOE
 		ObjectMapper mapper = (ObjectMapper) jp.getCodec();
 		JsonNode jsonNode = mapper.readTree(jp);
 		Cookie cookie = new Cookie(readJsonNode(jsonNode, "name").asText(), readJsonNode(jsonNode, "value").asText());
-		cookie.setComment(readJsonNode(jsonNode, "comment").asText());
 		cookie.setDomain(readJsonNode(jsonNode, "domain").asText());
 		cookie.setMaxAge(readJsonNode(jsonNode, "maxAge").asInt(-1));
 		cookie.setSecure(readJsonNode(jsonNode, "secure").asBoolean());
-		cookie.setVersion(readJsonNode(jsonNode, "version").asInt());
 		cookie.setPath(readJsonNode(jsonNode, "path").asText());
 		JsonNode attributes = readJsonNode(jsonNode, "attributes");
 		cookie.setHttpOnly(readJsonNode(attributes, "HttpOnly").asBoolean());
diff --git a/web/src/main/java/org/springframework/security/web/jackson2/SavedCookieMixin.java b/web/src/main/java/org/springframework/security/web/jackson2/SavedCookieMixin.java
@@ -44,10 +44,8 @@ abstract class SavedCookieMixin {
 
 	@JsonCreator
 	SavedCookieMixin(@JsonProperty("name") String name, @JsonProperty("value") String value,
-			@JsonProperty("comment") String comment, @JsonProperty("domain") String domain,
-			@JsonProperty("maxAge") int maxAge, @JsonProperty("path") String path,
-			@JsonProperty("secure") boolean secure, @JsonProperty("version") int version) {
-
+			@JsonProperty("domain") String domain, @JsonProperty("maxAge") int maxAge,
+			@JsonProperty("path") String path, @JsonProperty("secure") boolean secure) {
 	}
 
 }
diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/SavedCookie.java b/web/src/main/java/org/springframework/security/web/savedrequest/SavedCookie.java
@@ -35,8 +35,6 @@ public class SavedCookie implements Serializable {
 
 	private final String value;
 
-	private final String comment;
-
 	private final String domain;
 
 	private final int maxAge;
@@ -45,28 +43,13 @@ public class SavedCookie implements Serializable {
 
 	private final boolean secure;
 
-	private final int version;
-
-	/**
-	 * @deprecated use
-	 * {@link org.springframework.security.web.savedrequest.SavedCookie#SavedCookie(String, String, String, int, String, boolean)}
-	 * instead
-	 */
-	@Deprecated(forRemoval = true, since = "6.1")
-	public SavedCookie(String name, String value, String comment, String domain, int maxAge, String path,
-			boolean secure, int version) {
+	public SavedCookie(String name, String value, String domain, int maxAge, String path, boolean secure) {
 		this.name = name;
 		this.value = value;
-		this.comment = comment;
 		this.domain = domain;
 		this.maxAge = maxAge;
 		this.path = path;
 		this.secure = secure;
-		this.version = version;
-	}
-
-	public SavedCookie(String name, String value, String domain, int maxAge, String path, boolean secure) {
-		this(name, value, null, domain, maxAge, path, secure, 0);
 	}
 
 	public SavedCookie(Cookie cookie) {
@@ -82,11 +65,6 @@ public String getValue() {
 		return this.value;
 	}
 
-	@Deprecated(forRemoval = true, since = "6.1")
-	public String getComment() {
-		return this.comment;
-	}
-
 	public String getDomain() {
 		return this.domain;
 	}
@@ -103,23 +81,14 @@ public boolean isSecure() {
 		return this.secure;
 	}
 
-	@Deprecated(forRemoval = true, since = "6.1")
-	public int getVersion() {
-		return this.version;
-	}
-
 	public Cookie getCookie() {
 		Cookie cookie = new Cookie(getName(), getValue());
-		if (getComment() != null) {
-			cookie.setComment(getComment());
-		}
 		if (getDomain() != null) {
 			cookie.setDomain(getDomain());
 		}
 		if (getPath() != null) {
 			cookie.setPath(getPath());
 		}
-		cookie.setVersion(getVersion());
 		cookie.setMaxAge(getMaxAge());
 		cookie.setSecure(isSecure());
 		return cookie;
diff --git a/web/src/test/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServicesTests.java b/web/src/test/java/org/springframework/security/web/authentication/rememberme/AbstractRememberMeServicesTests.java
@@ -362,17 +362,6 @@ public void setCookieSetsIsHttpOnlyFlagByDefault() {
 		assertThat(cookie.isHttpOnly()).isTrue();
 	}
 
-	// SEC-2791
-	@Test
-	public void setCookieMaxAge1VersionSet() {
-		MockRememberMeServices services = new MockRememberMeServices();
-		MockHttpServletRequest request = new MockHttpServletRequest();
-		MockHttpServletResponse response = new MockHttpServletResponse();
-		services.setCookie(new String[] { "value" }, 1, request, response);
-		Cookie cookie = response.getCookie(AbstractRememberMeServices.SPRING_SECURITY_REMEMBER_ME_COOKIE_KEY);
-		assertThat(cookie.getVersion()).isZero();
-	}
-
 	@Test
 	public void setCookieDomainValue() {
 		MockRememberMeServices services = new MockRememberMeServices();
diff --git a/web/src/test/java/org/springframework/security/web/firewall/FirewalledResponseTests.java b/web/src/test/java/org/springframework/security/web/firewall/FirewalledResponseTests.java
@@ -93,7 +93,6 @@ public void addCookieWhenValidThenDelegateInvoked() {
 		Cookie cookie = new Cookie("foo", "bar");
 		cookie.setPath("/foobar");
 		cookie.setDomain("foobar");
-		cookie.setComment("foobar");
 		this.fwResponse.addCookie(cookie);
 		verify(this.response).addCookie(cookie);
 	}
diff --git a/web/src/test/java/org/springframework/security/web/jackson2/CookieMixinTests.java b/web/src/test/java/org/springframework/security/web/jackson2/CookieMixinTests.java
@@ -38,11 +38,11 @@ public class CookieMixinTests extends AbstractMixinTests {
 		"	\"name\": \"demo\"," +
 		"	\"value\": \"cookie1\"," +
 		"	\"attributes\":{\"@class\":\"java.util.Collections$EmptyMap\"}," +
-		"	\"comment\": null," +
+		"   \"comment\": null," +
 		"	\"maxAge\": -1," +
 		"	\"path\": null," +
 		"	\"secure\": false," +
-		"	\"version\": 0," +
+		"   \"version\": 0," +
 		"	\"domain\": null" +
 		"}";
 	// @formatter:on
@@ -53,11 +53,11 @@ public class CookieMixinTests extends AbstractMixinTests {
 		"	\"name\": \"demo\"," +
 		"	\"value\": \"cookie1\"," +
 		"	\"attributes\":{\"@class\":\"java.util.Collections$UnmodifiableMap\", \"HttpOnly\": \"true\"}," +
-		"	\"comment\": null," +
+		"   \"comment\": null," +
 		"	\"maxAge\": -1," +
 		"	\"path\": null," +
 		"	\"secure\": false," +
-		"	\"version\": 0," +
+		"   \"version\": 0," +
 		"	\"domain\": null" +
 		"}";
 	// @formatter:on
diff --git a/web/src/test/java/org/springframework/security/web/jackson2/DefaultSavedRequestMixinTests.java b/web/src/test/java/org/springframework/security/web/jackson2/DefaultSavedRequestMixinTests.java
@@ -45,11 +45,9 @@ public class DefaultSavedRequestMixinTests extends AbstractMixinTests {
 		+ "\"@class\": \"org.springframework.security.web.savedrequest.SavedCookie\", "
 		+ "\"name\": \"SESSION\", "
 		+ "\"value\": \"123456789\", "
-		+ "\"comment\": null, "
 		+ "\"maxAge\": -1, "
 		+ "\"path\": null, "
 		+ "\"secure\":false, "
-		+ "\"version\": 0, "
 		+ "\"domain\": null"
 	+ "}]]";
 	// @formatter:on
diff --git a/web/src/test/java/org/springframework/security/web/jackson2/SavedCookieMixinTests.java b/web/src/test/java/org/springframework/security/web/jackson2/SavedCookieMixinTests.java
@@ -42,12 +42,10 @@ public class SavedCookieMixinTests extends AbstractMixinTests {
 		+ "\"@class\": \"org.springframework.security.web.savedrequest.SavedCookie\", "
 		+ "\"name\": \"SESSION\", "
 		+ "\"value\": \"123456789\", "
-		+ "\"comment\": null, "
+		+ "\"domain\": null, "
 		+ "\"maxAge\": -1, "
 		+ "\"path\": null, "
-		+ "\"secure\":false, "
-		+ "\"version\": 0, "
-		+ "\"domain\": null"
+		+ "\"secure\":false "
 	+ "}";
 	// @formatter:on
 	// @formatter:off
@@ -90,13 +88,11 @@ public void deserializeSavedCookieWithList() throws IOException {
 
 	@Test
 	public void deserializeSavedCookieJsonTest() throws IOException {
-		SavedCookie savedCookie = (SavedCookie) this.mapper.readValue(COOKIE_JSON, Object.class);
+		SavedCookie savedCookie = this.mapper.readValue(COOKIE_JSON, SavedCookie.class);
 		assertThat(savedCookie).isNotNull();
 		assertThat(savedCookie.getName()).isEqualTo("SESSION");
 		assertThat(savedCookie.getValue()).isEqualTo("123456789");
 		assertThat(savedCookie.isSecure()).isEqualTo(false);
-		assertThat(savedCookie.getVersion()).isZero();
-		assertThat(savedCookie.getComment()).isNull();
 	}
 
 }
diff --git a/web/src/test/java/org/springframework/security/web/savedrequest/SavedCookieTests.java b/web/src/test/java/org/springframework/security/web/savedrequest/SavedCookieTests.java
@@ -33,12 +33,10 @@ public class SavedCookieTests {
 	@BeforeEach
 	public void setUp() {
 		this.cookie = new Cookie("name", "value");
-		this.cookie.setComment("comment");
 		this.cookie.setDomain("domain");
 		this.cookie.setMaxAge(100);
 		this.cookie.setPath("path");
 		this.cookie.setSecure(true);
-		this.cookie.setVersion(11);
 		this.savedCookie = new SavedCookie(this.cookie);
 	}
 
@@ -52,11 +50,6 @@ public void testGetValue() {
 		assertThat(this.savedCookie.getValue()).isEqualTo(this.cookie.getValue());
 	}
 
-	@Test
-	public void testGetComment() {
-		assertThat(this.savedCookie.getComment()).isEqualTo(this.cookie.getComment());
-	}
-
 	@Test
 	public void testGetDomain() {
 		assertThat(this.savedCookie.getDomain()).isEqualTo(this.cookie.getDomain());
@@ -72,22 +65,15 @@ public void testGetPath() {
 		assertThat(this.savedCookie.getPath()).isEqualTo(this.cookie.getPath());
 	}
 
-	@Test
-	public void testGetVersion() {
-		assertThat(this.savedCookie.getVersion()).isEqualTo(this.cookie.getVersion());
-	}
-
 	@Test
 	public void testGetCookie() {
 		Cookie other = this.savedCookie.getCookie();
-		assertThat(other.getComment()).isEqualTo(this.cookie.getComment());
 		assertThat(other.getDomain()).isEqualTo(this.cookie.getDomain());
 		assertThat(other.getMaxAge()).isEqualTo(this.cookie.getMaxAge());
 		assertThat(other.getName()).isEqualTo(this.cookie.getName());
 		assertThat(other.getPath()).isEqualTo(this.cookie.getPath());
 		assertThat(other.getSecure()).isEqualTo(this.cookie.getSecure());
 		assertThat(other.getValue()).isEqualTo(this.cookie.getValue());
-		assertThat(other.getVersion()).isEqualTo(this.cookie.getVersion());
 	}
 
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -372,9 +372,6 @@ protected void setCookie(String[] tokens, int maxAge, HttpServletRequest request`
`372`	`372`	`if (this.cookieDomain != null) {`
`373`	`373`	`cookie.setDomain(this.cookieDomain);`
`374`	`374`	`}`
`375`		`- if (maxAge < 1) {`
`376`		`- cookie.setVersion(1);`
`377`		`- }`
`378`	`375`	`cookie.setSecure((this.useSecureCookie != null) ? this.useSecureCookie : request.isSecure());`
`379`	`376`	`cookie.setHttpOnly(true);`
`380`	`377`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,6 @@ public void addCookie(Cookie cookie) {`
`67`	`67`	`validateCrlf(SET_COOKIE_HEADER, cookie.getValue());`
`68`	`68`	`validateCrlf(SET_COOKIE_HEADER, cookie.getPath());`
`69`	`69`	`validateCrlf(SET_COOKIE_HEADER, cookie.getDomain());`
`70`		`- validateCrlf(SET_COOKIE_HEADER, cookie.getComment());`
`71`	`70`	`}`
`72`	`71`	`super.addCookie(cookie);`
`73`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,8 @@ abstract class SavedCookieMixin {`
`44`	`44`
`45`	`45`	`@JsonCreator`
`46`	`46`	`SavedCookieMixin(@JsonProperty("name") String name, @JsonProperty("value") String value,`
`47`		`- @JsonProperty("comment") String comment, @JsonProperty("domain") String domain,`
`48`		`- @JsonProperty("maxAge") int maxAge, @JsonProperty("path") String path,`
`49`		`- @JsonProperty("secure") boolean secure, @JsonProperty("version") int version) {`
`50`		`-`
	`47`	`+ @JsonProperty("domain") String domain, @JsonProperty("maxAge") int maxAge,`
	`48`	`+ @JsonProperty("path") String path, @JsonProperty("secure") boolean secure) {`
`51`	`49`	`}`
`52`	`50`
`53`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,6 @@ public void addCookieWhenValidThenDelegateInvoked() {`
`93`	`93`	`Cookie cookie = new Cookie("foo", "bar");`
`94`	`94`	`cookie.setPath("/foobar");`
`95`	`95`	`cookie.setDomain("foobar");`
`96`		`- cookie.setComment("foobar");`
`97`	`96`	`this.fwResponse.addCookie(cookie);`
`98`	`97`	`verify(this.response).addCookie(cookie);`
`99`	`98`	`}`