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
MQTT auto provisioning improvements (auth cache disabled) (#879)
Rich Turner569add03eb24
diff --git a/.ci_cd/aws/provision_account.sh b/.ci_cd/aws/provision_account.shindex b8e2e724d..df7bfcfbe 100644--- a/.ci_cd/aws/provision_account.sh+++ b/.ci_cd/aws/provision_account.sh@@ -174,7 +174,7 @@ if [ "$VPCID" == 'None' ]; thenfi# Create standard stack resources in specified account- STACK_ID=$(aws cloudformation create-stack --capabilities CAPABILITY_NAMED_IAM --stack-name $STACK_NAME --template-body file://$TEMPLATE_PATH --parameters $PARAMS --output text)+ STACK_ID=$(aws cloudformation create-stack --capabilities CAPABILITY_NAMED_IAM --stack-name $STACK_NAME --template-body file://$TEMPLATE_PATH --parameters $PARAMS --output text $ACCOUNT_PROFILE)# Wait for cloud formation stack status to be CREATE_*echo "Waiting for stack to be created"diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.ymlindex 311e72902..c3a61004d 100644--- a/.github/workflows/ci_cd.yml+++ b/.github/workflows/ci_cd.yml@@ -142,7 +142,7 @@ jobs:value=value.replace('%','%25')value=value.replace('\n','%0A')value=value.replace('\r','%0D')- os.system(f"echo '::set-output name={key}::{value}'")+ os.system(f"echo '{key}={value}' >> $GITHUB_OUTPUT")if inputs is not None and inputs != 'null':for key, value in inputs.items():@@ -150,7 +150,7 @@ jobs:value=value.replace('%','%25')value=value.replace('\n','%0A')value=value.replace('\r','%0D')- os.system(f"echo '::set-output name={key}::{value}'")+ os.system(f"echo '{key}={value}' >> $GITHUB_OUTPUT")env:CALLER_INPUTS: ${{ toJSON(inputs) }}@@ -201,12 +201,12 @@ jobs:- name: Set skip backend manager testsid: skip-backend-testsif: steps.backend-files-changed.outputs.any_modified != 'true'- run: echo "::set-output name=value::true"+ run: echo "value=true" >> $GITHUB_OUTPUT- name: Set skip UI testsid: skip-ui-testsif: steps.ui-files-changed.outputs.any_modified != 'true'- run: echo "::set-output name=value::true"+ run: echo "value=true" >> $GITHUB_OUTPUT- name: Make cache dirs and set file permissionsrun: |@@ -218,7 +218,7 @@ jobs:id: is_main_reporun: |if [ $REPO_NAME == 'openremote/openremote' ]; then- echo "::set-output name=value::true"+ echo "value=true" >> $GITHUB_OUTPUTfienv:REPO_NAME: ${{ github.repository }}@@ -382,15 +382,15 @@ jobs:if dockerPublishTags is not None and isMainRepo == 'true':dockerPublishTags = dockerPublishTags.replace("$version", refName)firstDockerTag = dockerPublishTags.split(",")[0]- os.system(f"echo ::set-output name=firstDockerTag::{firstDockerTag}")+ os.system(f"echo 'firstDockerTag={firstDockerTag}' >> $GITHUB_OUTPUT")os.system(f" echo 'Manager tags to push to docker: {dockerPublishTags}'")dockerPublishTags = " ".join(map(lambda t: f"-t openremote/manager:{t.strip()}", dockerPublishTags.split(",")))- os.system(f"echo ::set-output name=dockerTags::{dockerPublishTags}")+ os.system(f"echo 'dockerTags={dockerPublishTags}' >> $GITHUB_OUTPUT")if mavenPublishTag is not None and isMainRepo == 'true':mavenPublishTag = mavenPublishTag.replace("$version", refName)os.system(f" echo 'Maven publish version: {mavenPublishTag}'")- os.system(f"echo ::set-output name=mavenTag::{mavenPublishTag}")+ os.system(f"echo 'mavenTag={mavenPublishTag}' >> $GITHUB_OUTPUT")deployStr = Noneif deploys is not None:@@ -415,7 +415,7 @@ jobs:if deployStr is not None and len(deployStr) > 0:print(f"Deployments to deploy: {deployStr}")- os.system(f"echo ::set-output name=deploys::{deployStr}")+ os.system(f"echo 'deploys={deployStr}' >> $GITHUB_OUTPUT")env:IS_MAIN_REPO: ${{ steps.is_main_repo.outputs.value }}EVENT_NAME: ${{ github.event_name }}@@ -439,7 +439,7 @@ jobs:fideployments="$INPUT_ENVIRONMENT:$tag"fi- echo "::set-output name=value::$deployments"+ echo "value=$deployments" >> $GITHUB_OUTPUTenv:EVENT_NAME: ${{ github.event_name }}DEPLOYMENTS: ${{ steps.ci-cd-output.outputs.deploys }}@@ -449,7 +449,7 @@ jobs:- name: Define backend test commandid: test-backend-commandif: ${{ steps.skip-backend-tests.outputs.value != 'true' }}- run: echo "::set-output name=value::./gradlew -p test test"+ run: echo "value=./gradlew -p test test" >> $GITHUB_OUTPUT- name: Define UI test commandid: test-ui-command@@ -474,14 +474,14 @@ jobs:if [ -n "$MANAGER_TAGS" ]; thencommand="docker build --push --build-arg GIT_COMMIT=$commitSha --platform linux/amd64,linux/aarch64 $MANAGER_TAGS $buildPath"- echo "::set-output name=pushRequired::true"+ echo "pushRequired=true" >> $GITHUB_OUTPUTelsecommand="docker build --build-arg GIT_COMMIT=$commitSha --platform linux/amd64,linux/aarch64 -t openremote/manager:$commitShaShort $buildPath"fi- echo "::set-output name=value::$command"+ echo "value=$command" >> $GITHUB_OUTPUTfi- echo "::set-output name=buildPath::$buildPath"- echo "::set-output name=refTag::$commitShaShort"+ echo "buildPath=$buildPath" >> $GITHUB_OUTPUT+ echo "refTag=$commitShaShort" >> $GITHUB_OUTPUTenv:FIRST_MANAGER_TAG: ${{ steps.ci-cd-output.outputs.firstDockerTag }}MANAGER_TAGS: ${{ steps.ci-cd-output.outputs.dockerTags }}@@ -495,7 +495,7 @@ jobs:shell: bashrun: |command="./gradlew publish -PopenremoteVersion=$MAVEN_TAG -PsigningKey=$SIGNING_KEY -PsigningPassword=$SIGNING_PASSWORD -PpublishUsername=$MAVEN_USERNAME -P$MAVEN_PASSWORD"- echo "::set-output name=value::$command"+ echo "value=$command" >> $GITHUB_OUTPUTenv:MAVEN_TAG: ${{ steps.ci-cd-output.outputs.mavenTag }}SIGNING_PASSWORD: ${{ steps.inputs-and-secrets.outputs._TEMP_SIGNING_PASSWORD }}@@ -516,12 +516,12 @@ jobs:buildPath="deployment/build"commitSha=$(git rev-parse HEAD)commitShaShort=$(git rev-parse --short HEAD)- echo "::set-output name=buildPath::$buildPath"- echo "::set-output name=refTag::$commitShaShort"+ echo "buildPath=$buildPath" >> $GITHUB_OUTPUT+ echo "refTag=$commitShaShort" >> $GITHUB_OUTPUTif [ -n "$DEPLOYMENTS" ]; thencommand="docker build --build-arg GIT_COMMIT=$commitSha --platform linux/amd64,linux/aarch64 -t openremote/deployment:$commitShaShort $buildPath"- echo "::set-output name=value::$command"+ echo "value=$command" >> $GITHUB_OUTPUTfifienv:@@ -535,9 +535,9 @@ jobs:run: |REF_NAME=${REF_NAME//\//_}if [ -n "$MANAGER_DOCKER_CMD" ]; then- echo "::set-output name=value::./gradlew installDist -PopenremoteVersion=$REF_NAME"+ echo "value=./gradlew installDist -PopenremoteVersion=$REF_NAME" >> $GITHUB_OUTPUTelif [ -n "$DEPLOYMENT_DOCKER_CMD" ]; then- echo "::set-output name=value::./gradlew -p deployment installDist"+ echo "value=./gradlew -p deployment installDist" >> $GITHUB_OUTPUTfienv:MANAGER_DOCKER_CMD: ${{ steps.manager-docker-command.outputs.value }}@@ -576,7 +576,7 @@ jobs:- name: Get yarn cache directory pathid: yarn-cache-dir-path- run: echo "::set-output name=dir::$(yarn config get cacheFolder)"+ run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT- name: Yarn cacheuses: actions/cache@v3@@ -653,7 +653,7 @@ jobs:fi# Define cleanup command- echo "::set-output name=cleanup::docker-compose -f $composeProfile down"+ echo "cleanup=docker-compose -f $composeProfile down" >> $GITHUB_OUTPUT# Start the stackecho "docker-compose -f ${composeProfile} up -d --no-build"diff --git a/manager/src/main/java/org/openremote/manager/mqtt/ActiveMQORSecurityManager.java b/manager/src/main/java/org/openremote/manager/mqtt/ActiveMQORSecurityManager.javaindex 0c3640507..f0c936e9e 100644--- a/manager/src/main/java/org/openremote/manager/mqtt/ActiveMQORSecurityManager.java+++ b/manager/src/main/java/org/openremote/manager/mqtt/ActiveMQORSecurityManager.java@@ -96,7 +96,7 @@ public class ActiveMQORSecurityManager extends ActiveMQJAASSecurityManager {if (user == null) {Triple<String, String, String> transientCredentials = brokerService.transientCredentials.get(remotingConnection.getID());if (transientCredentials != null) {- LOG.finer("Using transient credentials connection: " + remotingConnection.getID() + ", user=" + transientCredentials.getMiddle());+ LOG.finer("Using transient credentials (user=" + transientCredentials.getMiddle() + ") for connection: " + brokerService.connectionToString(remotingConnection));user = transientCredentials.getMiddle();password = transientCredentials.getRight();}@@ -188,18 +188,16 @@ public class ActiveMQORSecurityManager extends ActiveMQJAASSecurityManager {} else {result = handler.checkCanSubscribe(connection, securityContext, topic);}- if (LOG.isLoggable(Level.FINE)) {- if (result) {- LOG.fine("Handler has authorised " + (isWrite ? "pub" : "sub") + ": topic=" + topic + ", " + brokerService.connectionToString(connection));- } else {- LOG.fine("Handler has not authorised " + (isWrite ? "pub" : "sub") + ": topic=" + topic + ", " + brokerService.connectionToString(connection));- }+ if (result) {+ LOG.info("Handler '" + handler.getName() + "' has authorised " + (isWrite ? "pub" : "sub") + ": topic=" + topic + ", " + brokerService.connectionToString(connection));+ } else {+ LOG.info("Handler '" + handler.getName() + "' has not authorised " + (isWrite ? "pub" : "sub") + ": topic=" + topic + ", " + brokerService.connectionToString(connection));}return result;}}- LOG.fine("No handler has allowed " + (isWrite ? "pub" : "sub") + ": topic=" + topic + ", " + brokerService.connectionToString(connection));+ LOG.info("No handler has allowed " + (isWrite ? "pub" : "sub") + ": topic=" + topic + ", " + brokerService.connectionToString(connection));return false;}diff --git a/manager/src/main/java/org/openremote/manager/mqtt/MQTTBrokerService.java b/manager/src/main/java/org/openremote/manager/mqtt/MQTTBrokerService.javaindex 1feda1afd..ed0af0335 100644--- a/manager/src/main/java/org/openremote/manager/mqtt/MQTTBrokerService.java+++ b/manager/src/main/java/org/openremote/manager/mqtt/MQTTBrokerService.java@@ -111,8 +111,6 @@ public class MQTTBrokerService extends RouteBuilder implements ContainerService,protected List<MQTTHandler> customHandlers = new ArrayList<>();protected ConcurrentMap<String, RemotingConnection> clientIDConnectionMap = new ConcurrentHashMap<>();protected ConcurrentMap<String, RemotingConnection> connectionIDConnectionMap = new ConcurrentHashMap<>();- // TODO: Make auto provisioning clients disconnect and reconnect with credentials- // Temp to prevent breaking existing auto provisioning APIprotected ConcurrentMap<Object, Triple<String, String, String>> transientCredentials = new ConcurrentHashMap<>();protected Debouncer<String> userAssetDisconnectDebouncer;// Stores disconnected connections for a short period to allow last will publishes to be processed@@ -194,6 +192,12 @@ public class MQTTBrokerService extends RouteBuilder implements ContainerService,config.setWildCardConfiguration(wildcardConfiguration);config.setPersistenceEnabled(false);+ // TODO: Make auto provisioning clients disconnect and reconnect with credentials or pass through X.509 certificates for auth+ // Temp to prevent breaking existing auto provisioning API+ // Disable caching so we can support auto provisioning sessions without having to reconnect - we need to re-evaluate this and clients should probably send X.509 through to the broker+ config.setAuthenticationCacheSize(0);+ config.setAuthorizationCacheSize(0);+server = new EmbeddedActiveMQ();server.setConfiguration(config);server.setSecurityManager(new ActiveMQORSecurityManager(authorisationService, this, realm -> identityProvider.getKeycloakDeployment(realm, KEYCLOAK_CLIENT_ID), "", new SecurityConfiguration() {@@ -319,8 +323,6 @@ public class MQTTBrokerService extends RouteBuilder implements ContainerService,@Overridepublic void afterCreateConnection(RemotingConnection connection) throws ActiveMQException {- LOG.info("Client connection created: " + connectionToString(connection));-// MQTT seems to only use failure callback even if closed gracefully (need to look at the exception for details)connection.addFailureListener(new FailureListener() {@Override@@ -373,6 +375,7 @@ public class MQTTBrokerService extends RouteBuilder implements ContainerService,clientIDConnectionMap.put(remotingConnection.getClientID(), remotingConnection);if (!connectionIDConnectionMap.containsKey(connectionID)) {+ LOG.info("Client connection created: " + connectionToString(remotingConnection ));connectionIDConnectionMap.put(connectionID, remotingConnection);for (MQTTHandler handler : getCustomHandlers()) {handler.onConnect(remotingConnection);@@ -555,7 +558,7 @@ public class MQTTBrokerService extends RouteBuilder implements ContainerService,return null;}- return server.getActiveMQServer().getRemotingService().getConnections().stream().filter(connection ->+ return connectionIDConnectionMap.values().stream().filter(connection ->connection.getSubject() == subject && Objects.equals(clientID, connection.getClientID())).findFirst()diff --git a/manager/src/main/java/org/openremote/manager/mqtt/MQTTHandler.java b/manager/src/main/java/org/openremote/manager/mqtt/MQTTHandler.javaindex 0ae2a95ca..d9eb42918 100644--- a/manager/src/main/java/org/openremote/manager/mqtt/MQTTHandler.java+++ b/manager/src/main/java/org/openremote/manager/mqtt/MQTTHandler.java@@ -120,6 +120,7 @@ public abstract class MQTTHandler {return;}+ getLogger().info("Client published to '" + publishTopic + "': " + mqttBrokerService.connectionToString(connection));onPublish(connection, publishTopic, message.getReadOnlyBodyBuffer().byteBuf());getLogger().info("Client published '" + topic + "': " + mqttBrokerService.connectionToString(connection));});diff --git a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.javaindex bcbd7a283..d9bccfd3d 100644--- a/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java+++ b/manager/src/main/java/org/openremote/manager/provisioning/UserAssetProvisioningMQTTHandler.java@@ -218,7 +218,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {ProvisioningMessage provisioningMessage = ValueUtil.parse(payloadContent, ProvisioningMessage.class).orElseGet(() -> {- LOG.fine("Failed to parse message from client: topic=" + topic+ mqttBrokerService.connectionToString(connection));+ LOG.info("Failed to parse message from client: topic=" + topic+ mqttBrokerService.connectionToString(connection));mqttBrokerService.publishMessage(getResponseTopic(topic), new ErrorResponseMessage(ErrorResponseMessage.Error.MESSAGE_INVALID), MqttQoS.AT_MOST_ONCE);return null;});@@ -283,7 +283,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {X509ProvisioningConfig matchingConfig = getMatchingX509ProvisioningConfig(connection, clientCertificate);if (matchingConfig == null) {- LOG.fine("No matching provisioning config found for client certificate: topic=" + topic+ mqttBrokerService.connectionToString(connection));+ LOG.info("No matching provisioning config found for client certificate: topic=" + topic+ mqttBrokerService.connectionToString(connection));mqttBrokerService.publishMessage(getResponseTopic(topic), new ErrorResponseMessage(ErrorResponseMessage.Error.UNAUTHORIZED), MqttQoS.AT_MOST_ONCE);return;}@@ -368,7 +368,7 @@ public class UserAssetProvisioningMQTTHandler extends MQTTHandler {LOG.fine("Client successfully initialised: topic=" + topic+ mqttBrokerService.connectionToString(connection) + ", config=" + matchingConfig);- // Update connection with service user credentials+ // Store transient service user credentials (this is used by the custom ActiveMQSecurityManager)mqttBrokerService.addTransientCredentials(connection, new ImmutableTriple<>(serviceUser.getId(), realm + ":" + serviceUser.getUsername(), serviceUser.getSecret()));provisioningConfigAuthenticatedConnectionMap.compute(matchingConfig.getId(), (id, connections) -> {if (connections == null) {diff --git a/manager/src/main/resources/logging-dev.properties b/manager/src/main/resources/logging-dev.propertiesindex 98a8ae769..772fb962c 100644--- a/manager/src/main/resources/logging-dev.properties+++ b/manager/src/main/resources/logging-dev.properties@@ -103,3 +103,4 @@ org.apache.camel.impl.converter.DefaultTypeConverter.level=WARNINGorg.apache.camel.impl.DefaultShutdownStrategy.level=SEVEREorg.jeasy.rules.level=WARNINGorg.postgresql.jdbc.level=INFO+org.apache.activemq.audit.level=WARNINGdiff --git a/manager/src/main/resources/logging.properties b/manager/src/main/resources/logging.propertiesindex 4cef6ba20..496c541f0 100644--- a/manager/src/main/resources/logging.properties+++ b/manager/src/main/resources/logging.properties@@ -79,5 +79,4 @@ org.apache.camel.impl.converter.DefaultTypeConverter.level=WARNINGorg.apache.camel.impl.DefaultShutdownStrategy.level=SEVEREorg.jeasy.rules.level=WARNINGorg.postgresql.jdbc.level=INFO-org.apache.activemq.audit.resource.level=INFO-org.apache.activemq.audit.level=INFO+org.apache.activemq.audit.level=WARNINGdiff --git a/setup/src/load1/resources/org/openremote/setup/load1/ca.srl b/setup/src/load1/resources/org/openremote/setup/load1/ca.srlindex 6dc742638..bd7e3e0e8 100644--- a/setup/src/load1/resources/org/openremote/setup/load1/ca.srl+++ b/setup/src/load1/resources/org/openremote/setup/load1/ca.srl@@ -1 +1 @@-542AE76EF6F52D185F1EF1332339AD042EDA348D+542AE76EF6F52D185F1EF1332339AD042EDA3588diff --git a/test/load1/device_generator.sh b/test/load1/device_generator.shindex 4ee1ece57..1e6870878 100644--- a/test/load1/device_generator.sh+++ b/test/load1/device_generator.sh@@ -30,8 +30,8 @@ echo "Generating CSV file '$CSV_NAME' for $COUNT devices..."i=1while [ $i -le $COUNT ]; doecho "Generating $DEVICE_PREFIX$i..."- openssl req -nodes --newkey rsa:4096 -keyout $TEMP_CERT_DIR/$DEVICE_PREFIX$i.key -subj "/C=NL/ST=North Brabant/O=OpenRemote/CN=$DEVICE_PREFIX$i" -out $TEMP_CERT_DIR/$DEVICE_PREFIX$i.csr- openssl x509 -req -in $TEMP_CERT_DIR/$DEVICE_PREFIX$i.csr -CA $CA_PEM_PATH -CAkey $CA_KEY_PATH -CAcreateserial -out $TEMP_CERT_DIR/$DEVICE_PREFIX$i.pem -days 500 -sha256+ MSYS_NO_PATHCONV=1 openssl req -nodes --newkey rsa:4096 -keyout $TEMP_CERT_DIR/$DEVICE_PREFIX$i.key -subj '/C=NL/ST=North Brabant/O=OpenRemote/CN='$DEVICE_PREFIX$i -out $TEMP_CERT_DIR/$DEVICE_PREFIX$i.csr+ MSYS_NO_PATHCONV=1 openssl x509 -req -in $TEMP_CERT_DIR/$DEVICE_PREFIX$i.csr -CA $CA_PEM_PATH -CAkey $CA_KEY_PATH -CAcreateserial -out $TEMP_CERT_DIR/$DEVICE_PREFIX$i.pem -days 500 -sha256if [ $? -ne 0 ]; thenecho "Failed to sign device certificate"diff --git a/test/load1/mqtt_auto_provision.yml b/test/load1/mqtt_auto_provision.ymlindex b7c7f67a5..0b63289a2 100644--- a/test/load1/mqtt_auto_provision.yml+++ b/test/load1/mqtt_auto_provision.yml@@ -7,8 +7,8 @@ modules:logfile: ./output/jmeter.logexecution:-- concurrency: 20- ramp-up: 40s+- concurrency: 50+ ramp-up: 5siterations: 1scenario: mqtt-client-auto-provision-pub@@ -25,9 +25,9 @@ scenarios:message: "{\"type\":\"x509\",\"cert\":\"${cert}\"}"- cmd: subscribetopic: master/${id}/attributevalue/+/#- time: 10s- min-count: 1- think-time: 10s+ time: 30s+ min-count: 4+ think-time: 2s- cmd: disconnectdata-sources:diff --git a/test/src/logging-test.properties b/test/src/logging-test.propertiesindex 5c0642207..73301f676 100644--- a/test/src/logging-test.properties+++ b/test/src/logging-test.properties@@ -8,7 +8,7 @@handlers=java.util.logging.ConsoleHandler, \org.openremote.manager.syslog.SyslogService-# Log on STDOUT, to a file, and internal syslog service (monitoring in Manager UI)+# Log extra data to file for debug purposes#handlers=java.util.logging.ConsoleHandler, \# java.util.logging.FileHandler \# org.openremote.manager.syslog.SyslogService@@ -29,23 +29,6 @@ java.util.logging.ConsoleHandler.level=FINEST#java.util.logging.ConsoleHandler.formatter=org.openremote.container.util.LogFormatter-###############################################################################-# File handler-###############################################################################--# Set to FINEST to get all enabled log categories on file handler-java.util.logging.FileLogger.level=FINEST--# Output file and format-java.util.logging.FileHandler.pattern=/deployment/openremote.log-java.util.logging.FileHandler.formatter=org.openremote.container.util.LogFormatter-# Rotate between 10 log files-java.util.logging.FileHandler.count=10-# 10 mb per file-java.util.logging.FileHandler.limit=10000000-# Set to false to clear log on restart-java.util.logging.FileHandler.append=false-################################################################################ Categories###############################################################################@@ -99,7 +82,10 @@ org.hibernate.cfg.beanvalidation.TypeSafeActivator.level=SEVEREcom.zaxxer.hikari.level=WARNINGjavax.management.level=WARNINGorg.xnio.level=WARNING+org.apache.camel.level=WARNINGorg.apache.camel.management.level=WARNINGorg.apache.camel.impl.converter.DefaultTypeConverter.level=WARNINGorg.apache.camel.impl.DefaultShutdownStrategy.level=SEVEREorg.jeasy.rules.level=WARNING+org.postgresql.jdbc.level=INFO+org.apache.activemq.audit.level=WARNING