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
Further restrictions on auto created gateway service users (#1569)
Rich Turnerd13572271385
diff --git a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java b/manager/src/main/java/org/openremote/manager/event/ClientEventService.javaindex d8c9032a8..83cd173c7 100644--- a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java+++ b/manager/src/main/java/org/openremote/manager/event/ClientEventService.java@@ -119,7 +119,7 @@ public class ClientEventService extends RouteBuilder implements ContainerServiceprotected ManagerIdentityService identityService;protected GatewayService gatewayService;protected boolean started;- protected Consumer<Exchange> websocketInterceptor;+ protected Consumer<Exchange> gatewayInterceptor;public static String getSessionKey(Exchange exchange) {return exchange.getIn().getHeader(UndertowConstants.CONNECTION_KEY, String.class);@@ -249,8 +249,8 @@ public class ClientEventService extends RouteBuilder implements ContainerService}// Pass to gateway- if (websocketInterceptor != null) {- websocketInterceptor.accept(exchange);+ if (gatewayInterceptor != null) {+ gatewayInterceptor.accept(exchange);}}).stop()@@ -281,8 +281,8 @@ public class ClientEventService extends RouteBuilder implements ContainerService}// Pass to gateway- if (websocketInterceptor != null) {- websocketInterceptor.accept(exchange);+ if (gatewayInterceptor != null) {+ gatewayInterceptor.accept(exchange);}}).process(exchange -> {@@ -485,8 +485,12 @@ public class ClientEventService extends RouteBuilder implements ContainerService.asyncSend();}- public void setWebsocketInterceptor(Consumer<Exchange> consumer) {- this.websocketInterceptor = consumer;+ /**+ * This allows gateway connectors to intercept exchanges from gateway clients; it by-passes the standard processing+ * including authorization so the interceptor provides its own authorization checks.+ */+ public void setGatewayInterceptor(Consumer<Exchange> consumer) {+ this.gatewayInterceptor = consumer;}protected void onWebsocketSubscriptionTriggered(String sessionKey, EventSubscription<?> subscription, SharedEvent event) {diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.javaindex 3b2972976..a33780d32 100644--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayConnector.java@@ -65,7 +65,6 @@ public class GatewayConnector {protected final ScheduledExecutorService scheduledExecutorService;protected final AssetProcessingService assetProcessingService;protected final GatewayService gatewayService;- protected final Map<String, Asset<?>> pendingAssetMerges = new HashMap<>();protected List<AssetEvent> cachedAssetEvents;protected List<AttributeEvent> cachedAttributeEvents;protected Consumer<Object> gatewayMessageConsumer;@@ -182,7 +181,6 @@ public class GatewayConnector {}initialSyncInProgress = false;- pendingAssetMerges.clear();publishAttributeEvent(new AttributeEvent(gatewayId, GatewayAsset.STATUS, ConnectionStatus.DISCONNECTED));}@@ -653,20 +651,10 @@ public class GatewayConnector {switch (e.getCause()) {case CREATE, READ, UPDATE -> {- String assetId = e.getId();- Asset<?> mergedAsset = saveAssetLocally(e.getAsset());- synchronized (pendingAssetMerges) {- if (pendingAssetMerges.containsKey(assetId)) {- @SuppressWarnings("OptionalGetWithoutIsPresent")- Map.Entry<String, Asset<?>> pendingAssetMergeEntry = pendingAssetMerges.entrySet().stream().filter(entry -> entry.getKey().equals(assetId)).findFirst().get();- String id = pendingAssetMergeEntry.getKey();- pendingAssetMergeEntry.setValue(mergedAsset);-- synchronized (id) {- // Notify the waiting merge thread- id.notify();- }- }+ try {+ saveAssetLocally(e.getAsset());+ } catch (Exception ex) {+ LOG.log(Level.SEVERE, "Updating/creating asset failed: " + e.getId() + ": " + this, ex);}}case DELETE -> {diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.javaindex d19e6e0c2..a3e99668b 100644--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java@@ -35,7 +35,6 @@ import org.openremote.manager.rules.RulesetStorageService;import org.openremote.manager.security.ManagerIdentityService;import org.openremote.manager.security.ManagerKeycloakIdentityProvider;import org.openremote.manager.web.ManagerWebService;-import org.openremote.model.Constants;import org.openremote.model.Container;import org.openremote.model.ContainerService;import org.openremote.model.PersistenceEvent;@@ -49,7 +48,6 @@ import org.openremote.model.gateway.GatewayDisconnectEvent;import org.openremote.model.gateway.GatewayTunnelInfo;import org.openremote.model.query.AssetQuery;import org.openremote.model.rules.Ruleset;-import org.openremote.model.security.ClientRole;import org.openremote.model.security.Realm;import org.openremote.model.security.User;import org.openremote.model.syslog.SyslogCategory;@@ -201,20 +199,7 @@ public class GatewayService extends RouteBuilder implements ContainerService {active = true;identityProvider = (ManagerKeycloakIdentityProvider) identityService.getIdentityProvider();container.getService(MessageBrokerService.class).getContext().addRoutes(this);- clientEventService.setWebsocketInterceptor(this::onMessageIntercept);-- // Gateways can send AssetsEvents into this central manager so we need to authorize those- clientEventService.addEventAuthorizer((requestRealm, authContext, event) -> {-- if (authContext == null) {- return false;- }-- String clientId = authContext.getClientId();-- // TODO: Introduce gateway realm role- return isGatewayClientId(clientId);- });+ clientEventService.setGatewayInterceptor(this::onGatewayMessageIntercept);assetProcessingService.addEventInterceptor(new AttributeEventInterceptor() {@Override@@ -341,7 +326,11 @@ public class GatewayService extends RouteBuilder implements ContainerService {}}- protected void onMessageIntercept(Exchange exchange) {+ /**+ * This method by-passes the standard client event authorization so all consumers within the GatewayConnector+ * must handle authorization and/or ensure operations can only be conducted on gateway descendants.+ */+ protected void onGatewayMessageIntercept(Exchange exchange) {String clientId = ClientEventService.getClientId(exchange);if (!isGatewayClientId(clientId)) {@@ -818,14 +807,13 @@ public class GatewayService extends RouteBuilder implements ContainerService {}if (!userExists && gatewayUser != null) {- // Configure roles for this gateway user- identityProvider.updateUserRoles(- gateway.getRealm(),- gatewayUser.getId(),- Constants.KEYCLOAK_CLIENT_ID,- ClientRole.READ_ASSETS.getValue(),- ClientRole.WRITE_ASSETS.getValue(),- ClientRole.WRITE_ATTRIBUTES.getValue());+ // Make the user restricted with no permissions+ // Gateway events are handled directly by the GatewayConnector+ identityProvider.updateUserRealmRoles(+ gateway.getRealm(),+ gatewayUser.getId(),+ identityProvider+ .addRealmRoles(gateway.getRealm(), gatewayUser.getId(), RESTRICTED_USER_REALM_ROLE));}if (!clientId.equals(gateway.getClientId().orElse(null)) || !secret.equals(gateway.getClientSecret().orElse(null))) {