Skip to content

Return content-type from saved request #13440

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
Aug 7, 2023
Merged

Return content-type from saved request #13440

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
4aad744
Return content-type from saved request
Jun 30, 2023
0ed0a6c
Clean up SavedRequestAwareWrapper and related test
Jun 30, 2023
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
29 changes: 13 additions & 16 deletions ...src/main/java/org/springframework/security/web/savedrequest/SavedRequestAwareWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import jakarta.servlet.http.HttpServletRequestWrapper;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.http.HttpHeaders;

/**
* Provides request parameters, headers and cookies from either an original request or a
Expand All @@ -57,10 +58,7 @@ class SavedRequestAwareWrapper extends HttpServletRequestWrapper {

protected static final TimeZone GMT_ZONE = TimeZone.getTimeZone("GMT");

/** The default Locale if none are specified. */
protected static Locale defaultLocale = Locale.getDefault();

protected SavedRequest savedRequest = null;
protected SavedRequest savedRequest;

/**
* The set of SimpleDateFormat formats to use in getDateHeader(). Notice that because
Expand Down Expand Up @@ -101,14 +99,12 @@ public String getHeader(String name) {
}

@Override
@SuppressWarnings("unchecked")
public Enumeration getHeaderNames() {
public Enumeration<String> getHeaderNames() {
return new Enumerator<>(this.savedRequest.getHeaderNames());
}

@Override
@SuppressWarnings("unchecked")
public Enumeration getHeaders(String name) {
public Enumeration<String> getHeaders(String name) {
return new Enumerator<>(this.savedRequest.getHeaderValues(name));
}

Expand All @@ -125,8 +121,7 @@ public Locale getLocale() {
}

@Override
@SuppressWarnings("unchecked")
public Enumeration getLocales() {
public Enumeration<Locale> getLocales() {
List<Locale> locales = this.savedRequest.getLocales();
if (locales.isEmpty()) {
// Fall back to default locale
Expand All @@ -141,6 +136,11 @@ public String getMethod() {
return this.savedRequest.getMethod();
}

@Override
public String getContentType() {
return getHeader(HttpHeaders.CONTENT_TYPE);
}

/**
* If the parameter is available from the wrapped request then the request has been
* forwarded/included to a URL with parameters, either supplementing or overriding the
Expand All @@ -165,8 +165,7 @@ public String getParameter(String name) {
}

@Override
@SuppressWarnings("unchecked")
public Map getParameterMap() {
public Map<String, String[]> getParameterMap() {
Set<String> names = getCombinedParameterNames();
Map<String, String[]> parameterMap = new HashMap<>(names.size());
for (String name : names) {
Expand All @@ -175,7 +174,6 @@ public Map getParameterMap() {
return parameterMap;
}

@SuppressWarnings("unchecked")
private Set<String> getCombinedParameterNames() {
Set<String> names = new HashSet<>();
names.addAll(super.getParameterMap().keySet());
Expand All @@ -184,9 +182,8 @@ private Set<String> getCombinedParameterNames() {
}

@Override
@SuppressWarnings("unchecked")
public Enumeration getParameterNames() {
return new Enumerator(getCombinedParameterNames());
public Enumeration<String> getParameterNames() {
return new Enumerator<>(getCombinedParameterNames());
}

@Override
Expand Down
21 changes: 15 additions & 6 deletions ...est/java/org/springframework/security/web/savedrequest/SavedRequestAwareWrapperTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import jakarta.servlet.http.Cookie;
import org.junit.jupiter.api.Test;

import org.springframework.http.MediaType;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.security.web.PortResolverImpl;

Expand All @@ -42,22 +43,21 @@ private SavedRequestAwareWrapper createWrapper(MockHttpServletRequest requestToS
@Test
public void savedRequestCookiesAreIgnored() {
MockHttpServletRequest newRequest = new MockHttpServletRequest();
newRequest.setCookies(new Cookie[] { new Cookie("cookie", "fromnew") });
newRequest.setCookies(new Cookie("cookie", "fromnew"));
MockHttpServletRequest savedRequest = new MockHttpServletRequest();
savedRequest.setCookies(new Cookie[] { new Cookie("cookie", "fromsaved") });
savedRequest.setCookies(new Cookie("cookie", "fromsaved"));
SavedRequestAwareWrapper wrapper = createWrapper(savedRequest, newRequest);
assertThat(wrapper.getCookies()).hasSize(1);
assertThat(wrapper.getCookies()[0].getValue()).isEqualTo("fromnew");
}

@Test
@SuppressWarnings("unchecked")
public void savedRequesthHeaderIsReturnedIfSavedRequestIsSet() {
MockHttpServletRequest savedRequest = new MockHttpServletRequest();
savedRequest.addHeader("header", "savedheader");
SavedRequestAwareWrapper wrapper = createWrapper(savedRequest, new MockHttpServletRequest());
assertThat(wrapper.getHeader("nonexistent")).isNull();
Enumeration headers = wrapper.getHeaders("nonexistent");
Enumeration<String> headers = wrapper.getHeaders("nonexistent");
assertThat(headers.hasMoreElements()).isFalse();
assertThat(wrapper.getHeader("Header")).isEqualTo("savedheader");
headers = wrapper.getHeaders("heaDer");
Expand Down Expand Up @@ -97,7 +97,7 @@ public void savedRequestDoesntCreateDuplicateParams() {
SavedRequestAwareWrapper wrapper = createWrapper(savedRequest, wrappedRequest);
assertThat(wrapper.getParameterValues("action")).hasSize(1);
assertThat(wrapper.getParameterMap()).hasSize(1);
assertThat(((String[]) wrapper.getParameterMap().get("action"))).hasSize(1);
assertThat(wrapper.getParameterMap().get("action")).hasSize(1);
}

@Test
Expand Down Expand Up @@ -127,7 +127,7 @@ public void getParameterValuesReturnsCombinedSavedAndWrappedRequestValues() {
wrappedRequest.setParameter("action", "bar");
assertThat(wrapper.getParameterValues("action")).isEqualTo(new Object[] { "bar", "foo" });
// Check map is consistent
String[] valuesFromMap = (String[]) wrapper.getParameterMap().get("action");
String[] valuesFromMap = wrapper.getParameterMap().get("action");
assertThat(valuesFromMap).hasSize(2);
assertThat(valuesFromMap[0]).isEqualTo("bar");
}
Expand Down Expand Up @@ -169,4 +169,13 @@ public void correctIntHeaderIsReturned() {
assertThat(wrapper.getIntHeader("nonexistent")).isEqualTo(-1);
}

@Test
public void correctContentTypeIsReturned() {
MockHttpServletRequest request = new MockHttpServletRequest("PUT", "/notused");
request.setContentType(MediaType.APPLICATION_FORM_URLENCODED_VALUE);

SavedRequestAwareWrapper wrapper = createWrapper(request, new MockHttpServletRequest("GET", "/notused"));
assertThat(wrapper.getContentType()).isEqualTo(MediaType.APPLICATION_FORM_URLENCODED_VALUE);
}

}