100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
CORS update (CORS servlet filter now added to all deployments in dev mode)
Rich Turner5dd93ff6cc5d
diff --git a/container/src/main/java/org/openremote/container/security/CORSFilter.java b/container/src/main/java/org/openremote/container/security/CORSFilter.javaindex b27753bb0..cf44699b5 100644--- a/container/src/main/java/org/openremote/container/security/CORSFilter.java+++ b/container/src/main/java/org/openremote/container/security/CORSFilter.java@@ -1,25 +1,151 @@package org.openremote.container.security;+import io.undertow.util.StatusCodes;+import org.jboss.resteasy.spi.CorsHeaders;+import org.openremote.container.web.file.HttpFilter;+import org.openremote.model.util.TextUtil;++import javax.servlet.FilterChain;+import javax.servlet.FilterConfig;+import javax.servlet.ServletException;+import javax.servlet.http.HttpServletRequest;+import javax.servlet.http.HttpServletResponse;+import javax.servlet.http.HttpServletResponseWrapper;+import javax.servlet.http.HttpSession;+import javax.ws.rs.HttpMethod;import java.io.IOException;+import java.util.HashSet;+import java.util.Set;import java.util.logging.Logger;-import javax.ws.rs.container.ContainerRequestContext;-import javax.ws.rs.container.ContainerResponseContext;-import javax.ws.rs.container.ContainerResponseFilter;-import javax.ws.rs.ext.Provider;--// TODO: use built-in resteasy CORS Filter, correctly configure origin-@Provider-public class CORSFilter implements ContainerResponseFilter {+public class CORSFilter extends HttpFilter {private static final Logger LOG = Logger.getLogger(CORSFilter.class.getName());+ protected boolean allowCredentials = true;+ protected String allowedMethods;+ protected String allowedHeaders;+ protected String exposedHeaders;+ protected int corsMaxAge = -1;+ protected Set<String> allowedOrigins = new HashSet<String>();++ public boolean isAllowCredentials() {+ return allowCredentials;+ }++ public void setAllowCredentials(boolean allowCredentials) {+ this.allowCredentials = allowCredentials;+ }++ public String getAllowedMethods() {+ return allowedMethods;+ }++ public void setAllowedMethods(String allowedMethods) {+ this.allowedMethods = allowedMethods;+ }++ public String getAllowedHeaders() {+ return allowedHeaders;+ }++ public void setAllowedHeaders(String allowedHeaders) {+ this.allowedHeaders = allowedHeaders;+ }++ public String getExposedHeaders() {+ return exposedHeaders;+ }++ public void setExposedHeaders(String exposedHeaders) {+ this.exposedHeaders = exposedHeaders;+ }++ public int getCorsMaxAge() {+ return corsMaxAge;+ }++ public void setCorsMaxAge(int corsMaxAge) {+ this.corsMaxAge = corsMaxAge;+ }++ public Set<String> getAllowedOrigins() {+ return allowedOrigins;+ }++ public void setAllowedOrigins(Set<String> allowedOrigins) {+ this.allowedOrigins = allowedOrigins;+ }++ @Override+ public void init(FilterConfig filterConfig) throws ServletException {++ }+@Override- public void filter(final ContainerRequestContext requestContext,- final ContainerResponseContext cres) throws IOException {- cres.getHeaders().add("Access-Control-Allow-Origin", "*");- cres.getHeaders().add("Access-Control-Allow-Headers", "origin, content-type, accept, authorization");- cres.getHeaders().add("Access-Control-Allow-Credentials", "true");- cres.getHeaders().add("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS, HEAD");- cres.getHeaders().add("Access-Control-Max-Age", "1209600");+ public void doFilter(HttpServletRequest request, HttpServletResponse response, HttpSession session, FilterChain chain) throws ServletException, IOException {+ String origin = request.getHeader(CorsHeaders.ORIGIN);+ boolean isOptions = request.getMethod().equals(HttpMethod.OPTIONS);++ if (origin == null) {+ chain.doFilter(request, response);+ return;+ }++ if (!originOk(origin)) {+ response.sendError(StatusCodes.FORBIDDEN, "Origin not allowed");+ return;+ }++ if (isOptions) {+ response.setStatus(StatusCodes.OK);+ response.setHeader(CorsHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, origin);+ if (allowCredentials) {+ response.setHeader(CorsHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS, "true");+ }++ String requestMethods = request.getHeader(CorsHeaders.ACCESS_CONTROL_REQUEST_METHOD);+ if (!TextUtil.isNullOrEmpty(requestMethods)) {+ if (allowedMethods != null)+ {+ requestMethods = this.allowedMethods;+ }+ response.setHeader(CorsHeaders.ACCESS_CONTROL_ALLOW_METHODS, requestMethods);+ }++ String requestHeaders = request.getHeader(CorsHeaders.ACCESS_CONTROL_REQUEST_HEADERS);+ if (!TextUtil.isNullOrEmpty(requestHeaders)) {+ if (allowedHeaders != null)+ {+ requestHeaders = this.allowedHeaders;+ }+ response.setHeader(CorsHeaders.ACCESS_CONTROL_ALLOW_HEADERS, requestHeaders);+ }++ if (corsMaxAge > -1)+ {+ response.setHeader(CorsHeaders.ACCESS_CONTROL_MAX_AGE, Integer.toString(corsMaxAge));+ }+ } else {+ response.setHeader(CorsHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, origin);++ if (allowCredentials) {+ response.setHeader(CorsHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS, "true");+ }++ if (exposedHeaders != null) {+ response.setHeader(CorsHeaders.ACCESS_CONTROL_EXPOSE_HEADERS, exposedHeaders);+ }++ chain.doFilter(request, response);+ }+ }++ @Override+ public void destroy() {++ }++ protected boolean originOk(String origin) {+ return allowedOrigins.contains("*") || allowedOrigins.contains(origin);}}\ No newline at end of filediff --git a/container/src/main/java/org/openremote/container/web/DefaultWebsocketComponent.java b/container/src/main/java/org/openremote/container/web/DefaultWebsocketComponent.javaindex 8551fdebd..e5283b82b 100644--- a/container/src/main/java/org/openremote/container/web/DefaultWebsocketComponent.java+++ b/container/src/main/java/org/openremote/container/web/DefaultWebsocketComponent.java@@ -170,19 +170,4 @@ public class DefaultWebsocketComponent extends WebsocketComponent {webService.getRequestHandlers().remove(websocketHttpHandler);websocketHttpHandler = null;}-- /* TODO: Security - fix/use this! */- protected void addCORSFilter() {- if (allowedOrigin == null)- return;- WebsocketCORSFilter websocketCORSFilter = new WebsocketCORSFilter();- FilterInfo filterInfo = new FilterInfo(- "WebSocket CORS Filter",- WebsocketCORSFilter.class,- () -> new ImmediateInstanceHandle<Filter>(websocketCORSFilter)- ).addInitParam(WebsocketCORSFilter.ALLOWED_ORIGIN, allowedOrigin);- deploymentInfo.addFilter(filterInfo);- deploymentInfo.addFilterUrlMapping(filterInfo.getName(), "/*", DispatcherType.REQUEST);- }-}diff --git a/container/src/main/java/org/openremote/container/web/WebService.java b/container/src/main/java/org/openremote/container/web/WebService.javaindex 77311ed1c..72c81f1e9 100644--- a/container/src/main/java/org/openremote/container/web/WebService.java+++ b/container/src/main/java/org/openremote/container/web/WebService.java@@ -26,15 +26,18 @@ import io.undertow.server.handlers.RequestDumpingHandler;import io.undertow.servlet.Servlets;import io.undertow.servlet.api.DeploymentInfo;import io.undertow.servlet.api.DeploymentManager;-import org.jboss.resteasy.plugins.interceptors.CorsFilter;+import io.undertow.servlet.api.FilterInfo;+import io.undertow.servlet.util.ImmediateInstanceHandle;import org.jboss.resteasy.spi.ResteasyDeployment;import org.openremote.container.Container;import org.openremote.container.ContainerService;import org.openremote.container.json.JacksonConfig;import org.openremote.container.json.ModelValueMessageBodyConverter;+import org.openremote.container.security.CORSFilter;import org.openremote.container.security.IdentityService;import org.xnio.Options;+import javax.servlet.DispatcherType;import javax.ws.rs.core.UriBuilder;import java.net.Inet4Address;import java.net.URI;@@ -90,9 +93,9 @@ public abstract class WebService implements ContainerService {protected String host;protected int port;protected Undertow undertow;-protected List<RequestHandler> httpHandlers = new ArrayList<>();protected URI containerHostUri;+ protected FilterInfo corsFilter;protected static String getLocalIpAddress() throws Exception {return Inet4Address.getLocalHost().getHostAddress();@@ -111,13 +114,14 @@ public abstract class WebService implements ContainerService {? getLocalIpAddress(): host;+ corsFilter = createCorsFilter();+containerHostUri =UriBuilder.fromPath("/").scheme("http").host(containerHost).port(port).build();-undertow = build(container,Undertow.builder()@@ -167,6 +171,13 @@ public abstract class WebService implements ContainerService {// This will catch anything not handled by Resteasy/Servlets, such as IOExceptions "at the wrong time"deploymentInfo.setExceptionHandler(new WebServiceExceptions.ServletUndertowExceptionHandler(devMode));++ if (corsFilter != null) {+ deploymentInfo.addFilter(corsFilter);+ deploymentInfo.addFilterUrlMapping(corsFilter.getName(), "*", DispatcherType.REQUEST);+ deploymentInfo.addFilterUrlMapping(corsFilter.getName(), "*", DispatcherType.FORWARD);+ }+DeploymentManager manager = Servlets.defaultContainer().addDeployment(deploymentInfo);manager.deploy();return manager.start();@@ -249,18 +260,6 @@ public abstract class WebService implements ContainerService {resteasyDeployment.getProviders().add(new WebServiceExceptions.ForbiddenResteasyExceptionMapper(devMode));resteasyDeployment.getProviders().add(new JacksonConfig());- // Configure CORS - RT Replaced custom CORS filter with standard rest easy one due to:- // https://github.com/openremote/openremote/issues/32-- // resteasyDeployment.getProviders().add(new CORSFilter());- CorsFilter corsFilter = new CorsFilter();- corsFilter.getAllowedOrigins().add("*");- corsFilter.setAllowedHeaders("origin, content-type, accept, authorization");- corsFilter.setAllowCredentials(true);- corsFilter.setAllowedMethods("GET, POST, PUT, DELETE, OPTIONS, HEAD");- corsFilter.setCorsMaxAge(1209600);-- resteasyDeployment.getProviders().add(corsFilter);resteasyDeployment.getProviders().add(new GZIPEncodingInterceptor(!container.isDevMode()));resteasyDeployment.getActualProviderClasses().add(ModelValueMessageBodyConverter.class);resteasyDeployment.getActualProviderClasses().add(AlreadyGzippedWriterInterceptor.class);@@ -270,4 +269,19 @@ public abstract class WebService implements ContainerService {return resteasyDeployment;}++ protected FilterInfo createCorsFilter() {+ if (!devMode) {+ return null;+ }++ CORSFilter corsFilter = new CORSFilter();+ corsFilter.getAllowedOrigins().add("*");+ corsFilter.setAllowedHeaders("origin, content-type, accept, authorization");+ corsFilter.setAllowCredentials(true);+ corsFilter.setAllowedMethods("GET, POST, PUT, DELETE, OPTIONS, HEAD");+ corsFilter.setCorsMaxAge(1209600);++ return Servlets.filter("CORS Filter", CORSFilter.class, () -> new ImmediateInstanceHandle<>(corsFilter));+ }}diff --git a/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.java b/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.javaindex d6fe4c275..f2d367534 100644--- a/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.java+++ b/container/src/main/java/org/openremote/container/web/file/AbstractFileServlet.java@@ -138,7 +138,6 @@ public abstract class AbstractFileServlet extends HttpServlet {}private void doRequest(HttpServletRequest request, HttpServletResponse response, boolean head) throws IOException {- response.reset();Resource resource;try {diff --git a/manager/src/main/java/org/openremote/manager/map/MapService.java b/manager/src/main/java/org/openremote/manager/map/MapService.javaindex 62289eac3..e14fb7cf9 100644--- a/manager/src/main/java/org/openremote/manager/map/MapService.java+++ b/manager/src/main/java/org/openremote/manager/map/MapService.java@@ -265,6 +265,13 @@ public class MapService implements ContainerService {mapSettings.put("glyphs", glyphsUri);});+ if (!mapSettings.hasKey("maxZoom")) {+ mapSettings.put("maxZoom", metadata.maxZoom);+ }+ if (!mapSettings.hasKey("minZoom")) {+ mapSettings.put("minZoom", metadata.minZoom);+ }+return mapSettings;}@@ -295,8 +302,6 @@ public class MapService implements ContainerService {mapSource.put("center", centerArray);}));- mapSource.getArray("maxBounds").ifPresent(maxBounds -> mapSettingsJs.put("bounds", maxBounds.deepCopy()));-ArrayValue tilesArray = Values.createArray();String tileUrl = baseUriBuilder.clone().replacePath(API_PATH).path(realm).path("map/tile").build().toString() + "/{z}/{x}/{y}";tilesArray.set(0, tileUrl);@@ -321,8 +326,11 @@ public class MapService implements ContainerService {}mapSettingsJs.put("attribution", metadata.attribution);- mapSettingsJs.put("maxzoom", metadata.maxZoom);- mapSettingsJs.put("minzoom", metadata.minZoom);+ mapSettingsJs.put("maxzoom", mapConfig.getNumber("maxZoom").map(Double::intValue).orElse(metadata.maxZoom));+ mapSettingsJs.put("minzoom", mapConfig.getNumber("minZoom").map(Double::intValue).orElse(metadata.minZoom));+ if (mapConfig.hasKey("zoom")) {+ mapSettingsJs.put("zoom", mapConfig.getNumber("zoom").orElse(0d));+ }mapSettingsJs.put("format", "png");mapSettingsJs.put("type", "baselayer");diff --git a/manager/src/main/java/org/openremote/manager/web/ManagerWebService.java b/manager/src/main/java/org/openremote/manager/web/ManagerWebService.javaindex c0645619a..da13cb87f 100644--- a/manager/src/main/java/org/openremote/manager/web/ManagerWebService.java+++ b/manager/src/main/java/org/openremote/manager/web/ManagerWebService.java@@ -84,6 +84,8 @@ public class ManagerWebService extends WebService {@Overridepublic void init(Container container) throws Exception {+ super.init(container);+boolean devMode = container.isDevMode();IdentityService identityService = container.getService(IdentityService.class);String defaultApp = getString(container.getConfig(), APP_DEFAULT, APP_DEFAULT_DEFAULT);@@ -232,8 +234,6 @@ public class ManagerWebService extends WebService {deploymentHandler));-- super.init(container);}/**