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
Adding clientId to topic to prevent receiving asset/attribute events for restricted users. WIP
Michael Rademaker1c20445bbdad
diff --git a/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java b/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.javaindex 845f63b55..513bac178 100644--- a/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java+++ b/manager/src/main/java/org/openremote/manager/mqtt/MqttBrokerService.java@@ -36,6 +36,7 @@ import org.openremote.manager.asset.AssetStorageService;import org.openremote.manager.event.ClientEventService;import org.openremote.manager.security.ManagerIdentityService;import org.openremote.manager.security.ManagerKeycloakIdentityProvider;+import org.openremote.model.Constants;import org.openremote.model.Container;import org.openremote.model.ContainerService;import org.openremote.model.asset.AssetEvent;@@ -53,6 +54,7 @@ import java.util.concurrent.CopyOnWriteArraySet;import java.util.function.Consumer;import java.util.logging.Level;import java.util.logging.Logger;+import java.util.regex.Pattern;import static org.openremote.container.util.MapAccess.getInteger;import static org.openremote.container.util.MapAccess.getString;@@ -203,7 +205,7 @@ public class MqttBrokerService implements ContainerService {List<String> paths = new ArrayList<>();List<String> attributeNames = new ArrayList<>();- String assetId = SINGLE_LEVEL_WILDCARD.equals(topicTokens.get(2)) || MULTI_LEVEL_WILDCARD.equals(topicTokens.get(2)) ? null : topicTokens.get(2);+ String assetId = Pattern.matches(Constants.ASSET_ID_REGEXP, topicTokens.get(2)) ? topicTokens.get(2) : null;int multiLevelIndex = topicTokens.indexOf(MULTI_LEVEL_WILDCARD);int singleLevelIndex = topicTokens.indexOf(SINGLE_LEVEL_WILDCARD);@@ -212,15 +214,24 @@ public class MqttBrokerService implements ContainerService {}if (topicTokens.size() == 3) {- if (multiLevelIndex == 2) {- //realm/.../#- // No asset filtering required- } else if (singleLevelIndex == 2) {- //realm/.../+- parentIds.add(null);+ if (isAssetTopic) {+ if (multiLevelIndex == 2) {+ //realm/.../#+ // No asset filtering required+ } else if (singleLevelIndex == 2) {+ //realm/.../++ parentIds.add(null);+ } else {+ //realm/.../assetId+ assetIds.add(assetId);+ }} else {- //realm/.../assetId- assetIds.add(assetId);+ //realm/attribute/attributeName+ if(assetId != null) {+ assetIds.add(assetId);+ } else {+ attributeNames.add(topicTokens.get(2));+ }}} else if (topicTokens.size() == 4) {if (isAssetTopic) {diff --git a/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java b/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.javaindex c3ac88407..f8c7912e8 100644--- a/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java+++ b/manager/src/main/java/org/openremote/manager/mqtt/ORAuthorizatorPolicy.java@@ -11,17 +11,22 @@ import org.openremote.container.security.keycloak.AccessTokenAuthContext;import org.openremote.manager.asset.AssetStorageService;import org.openremote.manager.event.ClientEventService;import org.openremote.manager.security.ManagerKeycloakIdentityProvider;+import org.openremote.model.Constants;import org.openremote.model.asset.Asset;import org.openremote.model.asset.AssetEvent;import org.openremote.model.asset.AssetFilter;+import org.openremote.model.asset.UserAsset;import org.openremote.model.attribute.AttributeEvent;import org.openremote.model.event.shared.EventSubscription;import org.openremote.model.security.ClientRole;import org.openremote.model.syslog.SyslogCategory;+import org.openremote.model.value.RegexValueFilter;import java.util.List;+import java.util.Optional;import java.util.logging.Level;import java.util.logging.Logger;+import java.util.regex.Pattern;import java.util.stream.Collectors;import static org.openremote.manager.mqtt.MqttBrokerService.*;@@ -108,9 +113,15 @@ public class ORAuthorizatorPolicy implements IAuthorizatorPolicy {if(topicTokens.size() > 2) {String assetId = topicTokens.get(2);-- if (!SINGLE_LEVEL_WILDCARD.equals(assetId) && !MULTI_LEVEL_WILDCARD.equals(assetId)) {- Asset<?> asset = assetStorageService.find(assetId);+ if (Pattern.matches(Constants.ASSET_ID_REGEXP, assetId)) {++ Asset<?> asset;+ if(identityProvider.isRestrictedUser(authContext.getUserId())) {+ Optional<UserAsset> userAsset = assetStorageService.findUserAssets(connection.realm, authContext.getUserId(), assetId).stream().findFirst();+ asset = userAsset.map(value -> assetStorageService.find(value.getId().getAssetId())).orElse(null);+ } else {+ asset = assetStorageService.find(assetId);+ }if (asset == null) {LOG.fine("Asset not found for topic '" + topic + "': " + connection);@@ -128,7 +139,7 @@ public class ORAuthorizatorPolicy implements IAuthorizatorPolicy {}}} else if(!isWrite) {- LOG.fine("Topic must contain at least two tokens '" + topic + "': " + connection);+ LOG.fine("Topic must contain at least three tokens '" + topic + "': " + connection);return false;}diff --git a/test/src/test/groovy/org/openremote/test/mqtt/MqttBrokerTest.groovy b/test/src/test/groovy/org/openremote/test/mqtt/MqttBrokerTest.groovyindex 98ace3f36..6681529d8 100644--- a/test/src/test/groovy/org/openremote/test/mqtt/MqttBrokerTest.groovy+++ b/test/src/test/groovy/org/openremote/test/mqtt/MqttBrokerTest.groovy@@ -54,7 +54,7 @@ class MqttBrokerTest extends Specification implements ManagerContainerTrait {}}- def conditions = new PollingConditions(timeout: 10, delay: 0.2)+ def conditions = new PollingConditions(timeout: 10, initialDelay: 1, delay: 0.2)def services = Lists.newArrayList(defaultServices())services.replaceAll { it instanceof MqttBrokerService ? spyMqttBrokerService : it }def container = startContainer(defaultConfig(), services)@@ -145,7 +145,7 @@ class MqttBrokerTest extends Specification implements ManagerContainerTrait {}when: "a mqtt client subscribes to an asset in another realm"- def topic = keycloakTestSetup.tenantBuilding.realm + "/attribute/" + managerTestSetup.thingId+ def topic = keycloakTestSetup.tenantCity.realm + "/attribute/" + managerTestSetup.thingIdremainingLength = 4 + topic.size() + 1 //plus one for the QoS byteclient@@ -166,7 +166,7 @@ class MqttBrokerTest extends Specification implements ManagerContainerTrait {}when: "a mqtt client subscribes to an non existing asset"- topic = keycloakTestSetup.tenantBuilding.realm + "/attribute/dhajkdasjfgh"+ topic = keycloakTestSetup.tenantBuilding.realm + "/attribute/2F6uvhLm8w110jug2caukV"remainingLength = 4 + topic.size() + 1 //plus one for the QoS byteclient@@ -515,7 +515,7 @@ class MqttBrokerTest extends Specification implements ManagerContainerTrait {}when: "a mqtt client subscribes to an non existing asset"- topic = keycloakTestSetup.tenantBuilding.realm + "/asset/dhajkdasjfgh"+ topic = keycloakTestSetup.tenantBuilding.realm + "/asset/2F6uvhLm8w110jug2caukV"remainingLength = 4 + topic.size() + 1 //plus one for the QoS byteclient