Skip to content

Remove deprecated methods from CookieServerCsrfTokenRepository #14139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 7, 2025
Merged

Remove deprecated methods from CookieServerCsrfTokenRepository #14139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6eca766
Remove deprecated methods from CookieServerCsrfTokenRepository
milaneuh Nov 14, 2023
4cca612
Fix Checkstyle Errors
rwinch May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions web/src/main/java/org/springframework/security/web/csrf/CookieCsrfTokenRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,14 +169,6 @@ public void setCookieName(String cookieName) {
this.cookieName = cookieName;
}

/**
* @deprecated Use {@link #setCookieCustomizer(Consumer)} instead.
*/
@Deprecated(since = "6.1")
public void setCookieHttpOnly(boolean cookieHttpOnly) {
this.cookieHttpOnly = cookieHttpOnly;
}

private String getRequestContext(HttpServletRequest request) {
String contextPath = request.getContextPath();
return (contextPath.length() > 0) ? contextPath : "/";
Expand Down Expand Up @@ -230,32 +222,4 @@ public String getCookiePath() {
return this.cookiePath;
}

/**
* @since 5.2
* @deprecated Use {@link #setCookieCustomizer(Consumer)} instead.
*/
@Deprecated(since = "6.1")
public void setCookieDomain(String cookieDomain) {
this.cookieDomain = cookieDomain;
}

/**
* @since 5.4
* @deprecated Use {@link #setCookieCustomizer(Consumer)} instead.
*/
@Deprecated(since = "6.1")
public void setSecure(Boolean secure) {
this.secure = secure;
}

/**
* @since 5.5
* @deprecated Use {@link #setCookieCustomizer(Consumer)} instead.
*/
@Deprecated(since = "6.1")
public void setCookieMaxAge(int cookieMaxAge) {
Assert.isTrue(cookieMaxAge != 0, "cookieMaxAge cannot be zero");
this.cookieMaxAge = cookieMaxAge;
}

}
17 changes: 6 additions & 11 deletions web/src/test/java/org/springframework/security/web/csrf/CookieCsrfTokenRepositoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ void saveTokenSecure() {
@Test
void saveTokenSecureFlagTrue() {
this.request.setSecure(false);
this.repository.setSecure(Boolean.TRUE);
this.repository.setCookieCustomizer((cookie) -> cookie.secure(Boolean.TRUE));
CsrfToken token = this.repository.generateToken(this.request);
this.repository.saveToken(token, this.request, this.response);
Cookie tokenCookie = this.response.getCookie(CookieCsrfTokenRepository.DEFAULT_CSRF_COOKIE_NAME);
Expand All @@ -132,7 +132,7 @@ void saveTokenSecureFlagTrueUsingCustomizer() {
@Test
void saveTokenSecureFlagFalse() {
this.request.setSecure(true);
this.repository.setSecure(Boolean.FALSE);
this.repository.setCookieCustomizer((cookie) -> cookie.secure(Boolean.FALSE));
CsrfToken token = this.repository.generateToken(this.request);
this.repository.saveToken(token, this.request, this.response);
Cookie tokenCookie = this.response.getCookie(CookieCsrfTokenRepository.DEFAULT_CSRF_COOKIE_NAME);
Expand Down Expand Up @@ -163,7 +163,7 @@ void saveTokenNull() {

@Test
void saveTokenHttpOnlyTrue() {
this.repository.setCookieHttpOnly(true);
this.repository.setCookieCustomizer((cookie) -> cookie.httpOnly(true));
CsrfToken token = this.repository.generateToken(this.request);
this.repository.saveToken(token, this.request, this.response);
Cookie tokenCookie = this.response.getCookie(CookieCsrfTokenRepository.DEFAULT_CSRF_COOKIE_NAME);
Expand All @@ -181,7 +181,7 @@ void saveTokenHttpOnlyTrueUsingCustomizer() {

@Test
void saveTokenHttpOnlyFalse() {
this.repository.setCookieHttpOnly(false);
this.repository.setCookieCustomizer((cookie) -> cookie.httpOnly(false));
CsrfToken token = this.repository.generateToken(this.request);
this.repository.saveToken(token, this.request, this.response);
Cookie tokenCookie = this.response.getCookie(CookieCsrfTokenRepository.DEFAULT_CSRF_COOKIE_NAME);
Expand Down Expand Up @@ -239,7 +239,7 @@ void saveTokenNullCustomPath() {
@Test
void saveTokenWithCookieDomain() {
String domainName = "example.com";
this.repository.setCookieDomain(domainName);
this.repository.setCookieCustomizer((cookie) -> cookie.domain(domainName));
CsrfToken token = this.repository.generateToken(this.request);
this.repository.saveToken(token, this.request, this.response);
Cookie tokenCookie = this.response.getCookie(CookieCsrfTokenRepository.DEFAULT_CSRF_COOKIE_NAME);
Expand All @@ -259,7 +259,7 @@ void saveTokenWithCookieDomainUsingCustomizer() {
@Test
void saveTokenWithCookieMaxAge() {
int maxAge = 1200;
this.repository.setCookieMaxAge(maxAge);
this.repository.setCookieCustomizer((cookie) -> cookie.maxAge(maxAge));
CsrfToken token = this.repository.generateToken(this.request);
this.repository.saveToken(token, this.request, this.response);
Cookie tokenCookie = this.response.getCookie(CookieCsrfTokenRepository.DEFAULT_CSRF_COOKIE_NAME);
Expand Down Expand Up @@ -504,9 +504,4 @@ void setHeaderNameNullIllegalArgumentException() {
assertThatIllegalArgumentException().isThrownBy(() -> this.repository.setHeaderName(null));
}

@Test
void setCookieMaxAgeZeroIllegalArgumentException() {
assertThatIllegalArgumentException().isThrownBy(() -> this.repository.setCookieMaxAge(0));
}

}