org.bremersee.security.CorsProperties Maven / Gradle / Ivy
/*
* Copyright 2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.bremersee.security;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.http.HttpMethod;
import org.springframework.util.StringUtils;
/**
* CORS configuration properties.
*
* Can be used with {@code WebFlux} like this:
*
* import org.bremersee.security.CorsProperties;
* import org.springframework.boot.context.properties.EnableConfigurationProperties;
* import org.springframework.context.annotation.Configuration;
* import org.springframework.web.reactive.config.CorsRegistry;
* import org.springframework.web.reactive.config.WebFluxConfigurer;
*
* @EnableConfigurationProperties(CorsProperties.class)
* @Configuration
* public class CorsGlobalConfiguration implements WebFluxConfigurer {
*
* private CorsProperties corsProperties;
*
* public CorsGlobalConfiguration(CorsProperties corsProperties) {
* this.corsProperties = corsProperties;
* }
*
* @Override
* public void addCorsMappings(CorsRegistry corsRegistry) {
* for (CorsProperties.CorsConfiguration config : corsProperties.getConfigs()) {
* corsRegistry.addMapping(config.getPathPattern())
* .allowedOrigins(config.getAllowedOrigins().toArray(new String[0]))
* .allowedMethods(config.getAllowedMethods().toArray(new String[0]))
* .allowedHeaders(config.getAllowedHeaders().toArray(new String[0]))
* .maxAge(config.getMaxAge())
* .allowCredentials(config.isAllowCredentials());
* }
* }
* }
*
*
* @author Christian Bremer
*/
@SuppressWarnings("ConfigurationProperties")
@ConfigurationProperties(prefix = "bremersee.security.cors")
@Setter
@ToString
@EqualsAndHashCode
public class CorsProperties {
@Getter
private boolean allowAll;
private List configs = new ArrayList<>();
/**
* Allow all configuration.
*
* @return the allow all configuration
*/
@SuppressWarnings("WeakerAccess")
public static List allowAllConfiguration() {
return Collections.singletonList(CorsConfiguration.allowAllConfiguration());
}
/**
* Gets configs.
*
* @return the configs
*/
public List getConfigs() {
if (allowAll) {
return allowAllConfiguration();
}
if (configs == null) {
configs = new ArrayList<>();
}
return configs.stream()
.filter(config -> StringUtils.hasText(config.getPathPattern()))
.collect(Collectors.toList());
}
/**
* The cors configuration.
*/
@Setter
@ToString
@EqualsAndHashCode
public static class CorsConfiguration {
@Getter
private String pathPattern;
private List allowedOrigins = new ArrayList<>();
private List allowedMethods = new ArrayList<>();
private List allowedHeaders = new ArrayList<>();
@Getter
private boolean allowCredentials;
@Getter
private long maxAge = 1800L;
/**
* Allow all configuration.
*
* @return the allow all configuration
*/
static CorsConfiguration allowAllConfiguration() {
CorsConfiguration configuration = new CorsConfiguration();
configuration.pathPattern = "/**";
configuration.allowedOrigins = Collections.singletonList("*");
configuration.allowedMethods = Collections.singletonList("*");
configuration.allowedHeaders = Collections.singletonList("*");
return configuration;
}
/**
* Gets allowed origins.
*
* @return the allowed origins
*/
public List getAllowedOrigins() {
if (allowedOrigins == null) {
allowedOrigins = new ArrayList<>();
}
if (allowedOrigins.isEmpty()) {
allowedOrigins.add("*");
}
return allowedOrigins;
}
/**
* Gets allowed methods.
*
* @return the allowed methods
*/
public List getAllowedMethods() {
if (allowedMethods == null) {
allowedMethods = new ArrayList<>();
}
if (allowedMethods.isEmpty()) {
allowedMethods.add(HttpMethod.GET.name());
allowedMethods.add(HttpMethod.POST.name());
allowedMethods.add(HttpMethod.HEAD.name());
}
return allowedMethods;
}
/**
* Gets allowed headers.
*
* @return the allowed headers
*/
public List getAllowedHeaders() {
if (allowedHeaders == null) {
allowedHeaders = new ArrayList<>();
}
if (allowedHeaders.isEmpty()) {
allowedHeaders.add("*");
}
return allowedHeaders;
}
}
}