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
Re-use existing regex for the asset id validation (#2588)
Eric Bariauxb351fc0a6a5d
diff --git a/manager/src/main/java/org/openremote/manager/datapoint/AssetDatapointService.java b/manager/src/main/java/org/openremote/manager/datapoint/AssetDatapointService.javaindex 21572721b..6e003c7f3 100644--- a/manager/src/main/java/org/openremote/manager/datapoint/AssetDatapointService.java+++ b/manager/src/main/java/org/openremote/manager/datapoint/AssetDatapointService.java@@ -11,6 +11,7 @@ import org.openremote.manager.asset.AssetStorageService;import org.openremote.manager.event.ClientEventService;import org.openremote.manager.security.ManagerIdentityService;import org.openremote.manager.web.ManagerWebService;+import org.openremote.model.Constants;import org.openremote.model.Container;import org.openremote.model.asset.Asset;import org.openremote.model.attribute.Attribute;@@ -40,6 +41,7 @@ import java.util.Map;import java.util.concurrent.TimeUnit;import java.util.logging.Level;import java.util.logging.Logger;+import java.util.regex.Pattern;import java.util.stream.Collectors;import java.util.Set;import java.util.TreeSet;@@ -65,6 +67,7 @@ public class AssetDatapointService extends AbstractDatapointService<AssetDatapoipublic static final int OR_DATA_POINTS_EXPORT_LIMIT_DEFAULT = 1000000;private static final Logger LOG = Logger.getLogger(AssetDatapointService.class.getName());private static final Logger DATA_EXPORT_LOG = SyslogCategory.getLogger(DATA, AssetDatapointResourceImpl.class);+protected int maxDatapointAgeDays;protected int datapointExportLimit;@@ -435,18 +438,9 @@ public class AssetDatapointService extends AbstractDatapointService<AssetDatapoi}private static String validateAssetId(String assetId) {- if (assetId == null || assetId.length() != 22) {+ if (assetId == null || !Asset.matchesAssetIdPattern(assetId)) {throw new IllegalArgumentException("Invalid asset id");}- for (int i = 0; i < assetId.length(); i++) {- char c = assetId.charAt(i);- boolean isBase62 = (c >= '0' && c <= '9')- || (c >= 'A' && c <= 'Z')- || (c >= 'a' && c <= 'z');- if (!isBase62) {- throw new IllegalArgumentException("Invalid asset id");- }- }return assetId;}}diff --git a/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java b/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.javaindex 28c95f0d0..a89f245dd 100644--- a/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java+++ b/manager/src/main/java/org/openremote/manager/mqtt/DefaultMQTTHandler.java@@ -30,6 +30,7 @@ import org.keycloak.KeycloakSecurityContext;import org.openremote.container.security.AuthContext;import org.openremote.manager.event.ClientEventService;import org.openremote.model.PersistenceEvent;+import org.openremote.model.asset.Asset;import org.openremote.model.asset.AssetEvent;import org.openremote.model.asset.AssetFilter;import org.openremote.model.asset.UserAssetLink;@@ -41,19 +42,20 @@ import org.openremote.model.syslog.SyslogCategory;import org.openremote.model.util.ValueUtil;import java.nio.charset.StandardCharsets;-import java.util.*;+import java.util.ArrayList;+import java.util.List;+import java.util.Map;+import java.util.Set;import java.util.concurrent.ConcurrentHashMap;import java.util.concurrent.TimeUnit;import java.util.function.Consumer;import java.util.function.Function;import java.util.logging.Level;import java.util.logging.Logger;-import java.util.regex.Pattern;import static org.openremote.manager.asset.AssetProcessingService.ATTRIBUTE_EVENT_PROCESSOR;import static org.openremote.manager.mqtt.MQTTBrokerService.connectionToString;import static org.openremote.manager.mqtt.MQTTBrokerService.getConnectionIDString;-import static org.openremote.model.Constants.ASSET_ID_REGEXP;import static org.openremote.model.syslog.SyslogCategory.API;/**@@ -158,14 +160,14 @@ public class DefaultMQTTHandler extends MQTTHandler {return false;}if (topic.getTokens().length == 4) {- if (!Pattern.matches(ASSET_ID_REGEXP, topicTokenIndexToString(topic, 3))+ if (!Asset.matchesAssetIdPattern(topicTokenIndexToString(topic, 3))&& !TOKEN_MULTI_LEVEL_WILDCARD.equals(topicTokenIndexToString(topic, 3))&& !TOKEN_SINGLE_LEVEL_WILDCARD.equals(topicTokenIndexToString(topic, 3))) {LOG.fine("Asset subscribe forth token must be an asset ID or wildcard: topic=" + topic + ", " + mqttBrokerService.connectionToString(connection));return false;}} else if (topic.getTokens().length == 5) {- if (!Pattern.matches(ASSET_ID_REGEXP, topicTokenIndexToString(topic, 3))) {+ if (!Asset.matchesAssetIdPattern(topicTokenIndexToString(topic, 3))) {LOG.fine("Asset subscribe forth token must be an asset ID: topic=" + topic + ", " + mqttBrokerService.connectionToString(connection));return false;}@@ -186,14 +188,14 @@ public class DefaultMQTTHandler extends MQTTHandler {LOG.fine("Attribute subscribe multi level wildcard must be last token: topic=" + topic + ", " + mqttBrokerService.connectionToString(connection));return false;}- if (!Pattern.matches(ASSET_ID_REGEXP, topicTokenIndexToString(topic, 4))+ if (!Asset.matchesAssetIdPattern(topicTokenIndexToString(topic, 4))&& !TOKEN_MULTI_LEVEL_WILDCARD.equals(topicTokenIndexToString(topic, 4))&& !TOKEN_SINGLE_LEVEL_WILDCARD.equals(topicTokenIndexToString(topic, 4))) {LOG.fine("Attribute subscribe fifth token must be an asset ID or a wildcard: topic=" + topic + ", " + mqttBrokerService.connectionToString(connection));return false;}} else if (topic.getTokens().length == 6) {- if (!Pattern.matches(ASSET_ID_REGEXP, topicTokenIndexToString(topic, 4))) {+ if (!Asset.matchesAssetIdPattern(topicTokenIndexToString(topic, 4))) {LOG.fine("Attribute subscribe fifth token must be an asset ID: topic=" + topic + ", " + mqttBrokerService.connectionToString(connection));return false;}@@ -247,7 +249,7 @@ public class DefaultMQTTHandler extends MQTTHandler {}if (isAttributeValueWriteTopic(topic) || isAttributeWriteTopic(topic)) {- if (topic.getTokens().length != 5 || !Pattern.matches(ASSET_ID_REGEXP, topicTokenIndexToString(topic, 4))) {+ if (topic.getTokens().length != 5 || !Asset.matchesAssetIdPattern(topicTokenIndexToString(topic, 4))) {LOG.finer("Invalid publish topic: topic=" + topic + ", connection=" + connectionToString(connection));return false;}diff --git a/model/src/main/java/org/openremote/model/asset/Asset.java b/model/src/main/java/org/openremote/model/asset/Asset.javaindex 3554fdd0b..6815a9ee5 100644--- a/model/src/main/java/org/openremote/model/asset/Asset.java+++ b/model/src/main/java/org/openremote/model/asset/Asset.java@@ -234,6 +234,8 @@ import static jakarta.persistence.DiscriminatorType.STRING;@SuppressWarnings("unchecked")public abstract class Asset<T extends Asset<?>> implements IdentifiableEntity<T>, AssetInfo {+ private static final java.util.regex.Pattern ASSET_ID_PATTERN = java.util.regex.Pattern.compile(Constants.ASSET_ID_REGEXP);+/*** The purpose of this is to provide {@link org.openremote.model.attribute.Attribute.AttributeDeserializer} access* to the asset type so the {@link AttributeDescriptor} can be looked up to control value deserialization; this@@ -632,4 +634,14 @@ public abstract class Asset<T extends Asset<?>> implements IdentifiableEntity<T>public int hashCode() {return Objects.hash(id, version, createdOn, name, accessPublicRead, parentId, realm, type, Arrays.hashCode(path), attributes);}++ /**+ * Indicates if the given string matches the pattern for an Asset id.+ *+ * @param assetId String to validate. Must not be null or will throw a NullPointerException+ * @return true if matches Asset id pattern, false otherwise.+ */+ public static boolean matchesAssetIdPattern(String assetId) {+ return ASSET_ID_PATTERN.matcher(assetId).matches();+ }}