Skip to content

Retain CORS default permit values in combine() #37624

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

Open
b84330808 wants to merge 1 commit into
base: main
Choose a base branch
from
+52 −2
Open

Retain CORS default permit values in combine() #37624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 17 additions & 2 deletions spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,8 +603,23 @@ public CorsConfiguration combine(@Nullable CorsConfiguration other) {
List<OriginPattern> patterns = combinePatterns(this.allowedOriginPatterns, other.allowedOriginPatterns);
config.allowedOrigins = (origins == DEFAULT_PERMIT_ALL && !CollectionUtils.isEmpty(patterns) ? null : origins);
config.allowedOriginPatterns = patterns;
config.setAllowedMethods(combine(getAllowedMethods(), other.getAllowedMethods()));
config.setAllowedHeaders(combine(getAllowedHeaders(), other.getAllowedHeaders()));
// Bypass setAllowedMethods and setAllowedHeaders to retain default permit values
List<String> methods = combine(getAllowedMethods(), other.getAllowedMethods());
if (methods == DEFAULT_PERMIT_METHODS) {
config.allowedMethods = methods;
config.resolvedMethods = (this.allowedMethods == methods ?
this.resolvedMethods : other.resolvedMethods);
}
else {
config.setAllowedMethods(methods);
}
List<String> headers = combine(getAllowedHeaders(), other.getAllowedHeaders());
if (headers == DEFAULT_PERMIT_ALL) {
config.allowedHeaders = headers;
}
else {
config.setAllowedHeaders(headers);
}
config.setExposedHeaders(combine(getExposedHeaders(), other.getExposedHeaders()));
Boolean allowCredentials = other.getAllowCredentials();
if (allowCredentials != null) {
Expand Down
35 changes: 35 additions & 0 deletions spring-web/src/test/java/org/springframework/web/cors/CorsConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,41 @@ void combineWithDefaultPermitValues() {
assertThat(combinedConfig.getExposedHeaders()).isEmpty();
}

@Test
void combineWithDefaultPermitValuesOfCombinedConfig() {
CorsConfiguration config = new CorsConfiguration().applyPermitDefaultValues();
CorsConfiguration other = new CorsConfiguration();
other.addAllowedOrigin("https://domain.com");
other.addAllowedHeader("header1");
other.addAllowedMethod(HttpMethod.PUT.name());

CorsConfiguration combinedConfig = config.combine(new CorsConfiguration()).combine(other);
assertThat(combinedConfig.getAllowedOrigins()).containsExactly("https://domain.com");
assertThat(combinedConfig.getAllowedHeaders()).containsExactly("header1");
assertThat(combinedConfig.getAllowedMethods()).containsExactly(HttpMethod.PUT.name());
assertThat(combinedConfig.checkHttpMethod(HttpMethod.POST)).isNull();

combinedConfig = other.combine(config.combine(new CorsConfiguration()));
assertThat(combinedConfig.getAllowedOrigins()).containsExactly("https://domain.com");
assertThat(combinedConfig.getAllowedHeaders()).containsExactly("header1");
assertThat(combinedConfig.getAllowedMethods()).containsExactly(HttpMethod.PUT.name());
assertThat(combinedConfig.checkHttpMethod(HttpMethod.POST)).isNull();

combinedConfig = new CorsConfiguration().combine(config).combine(other);
assertThat(combinedConfig.getAllowedOrigins()).containsExactly("https://domain.com");
assertThat(combinedConfig.getAllowedHeaders()).containsExactly("header1");
assertThat(combinedConfig.getAllowedMethods()).containsExactly(HttpMethod.PUT.name());
assertThat(combinedConfig.checkHttpMethod(HttpMethod.POST)).isNull();

combinedConfig = new CorsConfiguration().combine(config);
assertThat(combinedConfig.checkHttpMethod(HttpMethod.POST))
.containsExactly(HttpMethod.GET, HttpMethod.HEAD, HttpMethod.POST);
combinedConfig.addAllowedHeader("header1");
combinedConfig.addAllowedMethod("PATCH");
assertThat(combinedConfig.getAllowedHeaders()).containsExactly("*", "header1");
assertThat(combinedConfig.getAllowedMethods()).containsExactly("GET", "HEAD", "POST", "PATCH");
}

@Test
void combinePatternWithDefaultPermitValues() {
CorsConfiguration config = new CorsConfiguration().applyPermitDefaultValues();
Expand Down