Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

GatewayAsset updates (Closes #527)

Rich Turnerf46477048497
diff --git a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java
index fb54306b8..5a7715c6d 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/io/AbstractNettyIOClient.java
@@ -74,6 +74,10 @@ import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;
*/
public abstract class AbstractNettyIOClient<T, U extends SocketAddress> implements NettyIOClient<T> {
+ public static long RECONNECT_DELAY_INITIAL_MILLIS = 1000L;
+ public static long RECONNECT_DELAY_MAX_MILLIS = 5*60000L;
+ public static long RECONNECT_DELAY_JITTER_MILLIS = 10000L;
+
/**
* This is intended to be used at the end of a decoder chain where the previous decoder outputs a {@link ByteBuf};
* the provided {@link #decoder} should extract the messages of type &lt;T&gt; from the {@link ByteBuf} and add them
diff --git a/agent/src/main/java/org/openremote/agent/protocol/io/IOClient.java b/agent/src/main/java/org/openremote/agent/protocol/io/IOClient.java
index a98bcf262..226005be4 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/io/IOClient.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/io/IOClient.java
@@ -30,10 +30,6 @@ import java.util.function.Consumer;
*/
public interface IOClient<T> {
- long RECONNECT_DELAY_INITIAL_MILLIS = 1000L;
- long RECONNECT_DELAY_MAX_MILLIS = 5*60000L;
- long RECONNECT_DELAY_JITTER_MILLIS = 10000L;
-
/**
* Send a message over the wire
*/
diff --git a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
index de1f54206..d691d2107 100644
--- a/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
+++ b/agent/src/main/java/org/openremote/agent/protocol/mqtt/AbstractMQTT_IOClient.java
@@ -50,6 +50,8 @@ import java.util.function.Consumer;
import java.util.logging.Level;
import java.util.logging.Logger;
+import static org.openremote.agent.protocol.io.AbstractNettyIOClient.RECONNECT_DELAY_INITIAL_MILLIS;
+import static org.openremote.agent.protocol.io.AbstractNettyIOClient.RECONNECT_DELAY_MAX_MILLIS;
import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;
public abstract class AbstractMQTT_IOClient<S> implements IOClient<MQTTMessage<S>> {
diff --git a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
index e448888dc..20392fafd 100644
--- a/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
+++ b/manager/src/main/java/org/openremote/manager/gateway/GatewayService.java
@@ -198,7 +198,7 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
boolean hasClientSecret = gateway.getClientSecret().isPresent();
if (!hasClientId || !hasClientSecret) {
- createGatewayClient(gateway);
+ createUpdateGatewayServiceUser(gateway);
}
// Create connector
@@ -310,17 +310,32 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
if (GatewayAsset.DISABLED.getName().equals(attribute.getName())) {
boolean disabled = attribute.getValueAs(Boolean.class).orElse(false);
boolean isAlreadyDisabled = gatewayAsset.getDisabled().orElse(false);
+ gatewayAsset.setDisabled(disabled); // Ensure we update state
if (disabled != isAlreadyDisabled) {
+ createUpdateGatewayServiceUser(gatewayAsset);
if (disabled) {
connector.sendMessageToGateway(new GatewayDisconnectEvent(GatewayDisconnectEvent.Reason.DISABLED));
- destroyGatewayClient(gatewayAsset);
- } else {
- createGatewayClient(gatewayAsset);
}
connector.setDisabled(disabled);
}
}
+
+ if (GatewayAsset.CLIENT_SECRET.getName().equals(attribute.getName())) {
+ String newSecret = attribute.getValueAs(String.class).orElse(null);
+ if (!TextUtil.isNullOrEmpty(newSecret)) {
+ LOG.fine("Gateway client secret attribute updated so updating gateway service user secret to match: (Gateway ID=" + asset.getId() + ")");
+ User gatewayServiceUser = identityProvider.getUserByUsername(asset.getRealm(), User.SERVICE_ACCOUNT_PREFIX + ((GatewayAsset) asset).getClientId().orElse(""));
+ if (gatewayServiceUser != null) {
+ identityProvider.resetSecret(asset.getRealm(), gatewayServiceUser.getId(), newSecret);
+ } else {
+ LOG.info("Couldn't retrieve gateway service user to update secret: (Gateway ID=" + asset.getId() + ")");
+ }
+ } else {
+ // Push old secret back
+ assetProcessingService.sendAttributeEvent(new AttributeEvent(asset.getId(), GatewayAsset.CLIENT_SECRET, gatewayAsset.getClientSecret().orElseThrow(() -> new IllegalStateException("Gateway client secret is null which was not expected"))));
+ }
+ }
} else {
String gatewayId = assetIdGatewayIdMap.get(asset.getId());
@@ -465,8 +480,6 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
if (connector.isDisabled()) {
LOG.warning("Gateway is currently disabled so will be ignored: Gateway ID=" + gatewayId);
- // Should not have got passed keycloak ensure keycloak client is removed
- destroyGatewayClient(connector.gateway);
clientEventService.sendToSession(sessionId, new GatewayDisconnectEvent(GatewayDisconnectEvent.Reason.DISABLED));
clientEventService.closeSession(sessionId);
return;
@@ -496,7 +509,7 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
switch (persistenceEvent.getCause()) {
case CREATE:
- createGatewayClient(gateway);
+ createUpdateGatewayServiceUser(gateway);
synchronized (gatewayConnectorMap) {
GatewayConnector connector = new GatewayConnector(assetStorageService, assetProcessingService, executorService, gateway);
gatewayConnectorMap.put(gateway.getId().toLowerCase(Locale.ROOT), connector);
@@ -530,11 +543,7 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
boolean wasDisabled = oldAttributes.getValue(GatewayAsset.DISABLED).orElse(false);
if (wasDisabled != isNowDisabled) {
- if (isNowDisabled) {
- destroyGatewayClient(gateway);
- } else {
- createGatewayClient(gateway);
- }
+ createUpdateGatewayServiceUser(gateway);
}
}
break;
@@ -553,7 +562,7 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
}
}
- destroyGatewayClient(gateway);
+ removeGatewayServiceUser(gateway);
break;
}
}
@@ -595,14 +604,18 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
return clientId;
}
- protected void createGatewayClient(GatewayAsset gateway) {
+ protected void createUpdateGatewayServiceUser(GatewayAsset gateway) {
- LOG.info("Creating gateway keycloak client for gateway id: " + gateway.getId());
+ LOG.info("Creating/updating gateway service user for gateway id: " + gateway.getId());
String clientId = getGatewayClientId(gateway.getId());
String secret = gateway.getClientSecret().orElseGet(() -> UUID.randomUUID().toString());
try {
- identityProvider.createUpdateUser(gateway.getRealm(), new User().setServiceAccount(true).setUsername(clientId).setEnabled(true), secret);
+ identityProvider.createUpdateUser(gateway.getRealm(), new User()
+ .setServiceAccount(true)
+ .setSystemAccount(true)
+ .setUsername(clientId)
+ .setEnabled(!gateway.getDisabled().orElse(false)), secret);
if (!clientId.equals(gateway.getClientId().orElse(null)) || !secret.equals(gateway.getClientSecret().orElse(null))) {
gateway.setClientId(clientId);
@@ -620,7 +633,7 @@ public class GatewayService extends RouteBuilder implements ContainerService, As
}
}
- protected void destroyGatewayClient(GatewayAsset gateway) {
+ protected void removeGatewayServiceUser(GatewayAsset gateway) {
String id = gateway.getClientId().orElse(null);
if (TextUtil.isNullOrEmpty(id)) {
LOG.warning("Cannot find gateway keycloak client ID so cannot remove keycloak client for gateway: " + gateway.getId());
diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
index 5e2288b30..89ed0ba5c 100644
--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java
@@ -202,7 +202,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im
userRepresentation = withClientResource(realm, user.getUsername(), realmsResource, (clientRep, clientResource) -> {
UserRepresentation userRep = clientResource.getServiceAccountUser();
if (userRep == null) {
- String msg = "Attempt to update/creat service user but a regular client with same client ID as this username already exists: User=" + user;
+ String msg = "Attempt to update/create service user but a regular client with same client ID as this username already exists: User=" + user;
LOG.info(msg);
throw new NotAllowedException(msg);
}
diff --git a/model/src/main/java/org/openremote/model/asset/impl/GatewayAsset.java b/model/src/main/java/org/openremote/model/asset/impl/GatewayAsset.java
index 76d8aaf52..67f065dd4 100644
--- a/model/src/main/java/org/openremote/model/asset/impl/GatewayAsset.java
+++ b/model/src/main/java/org/openremote/model/asset/impl/GatewayAsset.java
@@ -22,7 +22,9 @@ package org.openremote.model.asset.impl;
import org.openremote.model.asset.Asset;
import org.openremote.model.asset.AssetDescriptor;
import org.openremote.model.asset.agent.ConnectionStatus;
+import org.openremote.model.attribute.MetaItem;
import org.openremote.model.value.AttributeDescriptor;
+import org.openremote.model.value.MetaItemType;
import org.openremote.model.value.ValueType;
import javax.persistence.Entity;
@@ -31,9 +33,9 @@ import java.util.Optional;
@Entity
public class GatewayAsset extends Asset<GatewayAsset> {
- public static final AttributeDescriptor<String> CLIENT_ID = new AttributeDescriptor<>("clientId", ValueType.TEXT);
+ public static final AttributeDescriptor<String> CLIENT_ID = new AttributeDescriptor<>("clientId", ValueType.TEXT, new MetaItem<>(MetaItemType.READ_ONLY));
public static final AttributeDescriptor<String> CLIENT_SECRET = new AttributeDescriptor<>("clientSecret", ValueType.UUID);
- public static final AttributeDescriptor<ConnectionStatus> STATUS = new AttributeDescriptor<>("gatewayStatus", ValueType.CONNECTION_STATUS);
+ public static final AttributeDescriptor<ConnectionStatus> STATUS = new AttributeDescriptor<>("gatewayStatus", ValueType.CONNECTION_STATUS, new MetaItem<>(MetaItemType.READ_ONLY));
public static final AttributeDescriptor<Boolean> DISABLED = new AttributeDescriptor<>("disabled", ValueType.BOOLEAN);
public static final AssetDescriptor<GatewayAsset> DESCRIPTOR = new AssetDescriptor<>("router-wireless", null, GatewayAsset.class);
diff --git a/test/src/main/java/org/openremote/test/TestFixture.java b/test/src/main/java/org/openremote/test/TestFixture.java
index 28ad7ff54..1ec217f05 100644
--- a/test/src/main/java/org/openremote/test/TestFixture.java
+++ b/test/src/main/java/org/openremote/test/TestFixture.java
@@ -19,6 +19,7 @@
*/
package org.openremote.test;
+import org.openremote.agent.protocol.io.AbstractNettyIOClient;
import org.openremote.container.Container;
import org.openremote.model.asset.Asset;
import org.openremote.model.asset.UserAssetLink;
@@ -49,6 +50,15 @@ public class TestFixture extends AbstractGlobalExtension {
public static List<UserAssetLink> userAssets;
public static List<User> users;
+ @Override
+ public void start() {
+ // Force RECONNECT times to be short to improve test run times
+ AbstractNettyIOClient.RECONNECT_DELAY_INITIAL_MILLIS = 50;
+ AbstractNettyIOClient.RECONNECT_DELAY_JITTER_MILLIS = 0;
+ AbstractNettyIOClient.RECONNECT_DELAY_MAX_MILLIS = 50;
+ super.start();
+ }
+
@Override
public void stop() {
if (container != null) {
diff --git a/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy b/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy
index ecc1d31d1..85f663884 100644
--- a/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/gateway/GatewayTest.groovy
@@ -19,6 +19,7 @@ import org.openremote.manager.gateway.GatewayService
import org.openremote.manager.security.ManagerIdentityService
import org.openremote.manager.security.ManagerKeycloakIdentityProvider
import org.openremote.manager.setup.SetupService
+import org.openremote.model.security.User
import org.openremote.test.setup.ManagerTestSetup
import org.openremote.model.asset.*
import org.openremote.model.asset.agent.ConnectionStatus
@@ -119,6 +120,7 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
[new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, gatewayClient)].toArray(new ChannelHandler[0])
})
+
and: "we add callback consumers to the client"
def connectionStatus = gatewayClient.getConnectionStatus()
List<String> clientReceivedMessages = []
@@ -577,14 +579,43 @@ class GatewayTest extends Specification implements ManagerContainerTrait {
advancePseudoClock(1, TimeUnit.SECONDS, container)
and: "the gateway is enabled again"
- assetProcessingService.sendAttributeEvent(new AttributeEvent(gateway.getId(), "disabled", false))
+ assetProcessingService.sendAttributeEvent(new AttributeEvent(gateway.getId(), GatewayAsset.DISABLED.getName(), false))
then: "the gateway connector should be enabled"
conditions.eventually {
assert !gatewayService.gatewayConnectorMap.get(gateway.getId().toLowerCase(Locale.ROOT)).disabled
}
- and: "the gateway client reconnects"
+ when: "the gateway asset client secret attribute is updated"
+ def newSecret = UniqueIdentifierGenerator.generateId()
+ assetProcessingService.sendAttributeEvent(new AttributeEvent(gateway.getId(), GatewayAsset.CLIENT_SECRET, newSecret))
+
+ then: "the service user secret should be updated"
+ conditions.eventually {
+ gateway = assetStorageService.find(gateway.getId()) as GatewayAsset
+ assert gateway.getClientSecret().orElse(null) == newSecret
+ def user = identityProvider.getUserByUsername(gateway.getRealm(), User.SERVICE_ACCOUNT_PREFIX + gateway.getClientId().orElse(""))
+ assert user != null
+ assert user.secret == newSecret
+ }
+
+ when: "the gateway client reconnects with the new secret"
+ gatewayClient = new WebsocketIOClient<String>(
+ new URIBuilder("ws://127.0.0.1:$serverPort/websocket/events?Auth-Realm=$managerTestSetup.realmBuildingTenant").build(),
+ null,
+ new OAuthClientCredentialsGrant("http://127.0.0.1:$serverPort/auth/realms/$managerTestSetup.realmBuildingTenant/protocol/openid-connect/token",
+ gateway.getClientId().orElse(""),
+ gateway.getClientSecret().orElse(""),
+ null).setBasicAuthHeader(true))
+ gatewayClient.setEncoderDecoderProvider({
+ [new AbstractNettyIOClient.MessageToMessageDecoder<String>(String.class, gatewayClient)].toArray(new ChannelHandler[0])
+ })
+ gatewayClient.addMessageConsumer({
+ message -> clientReceivedMessages.add(message)
+ })
+ gatewayClient.addConnectionStatusConsumer({
+ status -> connectionStatus = status
+ })
gatewayClient.connect()
then: "the gateway netty client status should become CONNECTED"
diff --git a/ui/app/manager/src/pages/page-users.ts b/ui/app/manager/src/pages/page-users.ts
index c788e1932..366775835 100644
--- a/ui/app/manager/src/pages/page-users.ts
+++ b/ui/app/manager/src/pages/page-users.ts
@@ -224,6 +224,7 @@ class PageUsers<S extends AppStateKeyed> extends Page<S> {
protected _realmRoles: Role[] = [];
@state()
protected _compositeRoles: Role[] = [];
+ protected _loading: boolean = false;
get name(): string {
return "user_plural";
@@ -264,6 +265,12 @@ class PageUsers<S extends AppStateKeyed> extends Page<S> {
protected async loadUsers() {
+ if (!this.realm || this._loading || !this.isConnected) {
+ return;
+ }
+
+ this._loading = true;
+
this._compositeRoles = [];
this._roles = [];
this._realmRoles = [];
@@ -275,11 +282,9 @@ class PageUsers<S extends AppStateKeyed> extends Page<S> {
return;
}
- const realm = this.getState().app.realm;
-
// After async op check that the response still matches current state and that the component is still loaded in the UI
const stateChecker = () => {
- return this.getState().app.realm === realm && this.isConnected;
+ return this.getState().app.realm === this.realm && this.isConnected;
}
const roleResponse = await manager.rest.api.UserResource.getRoles(manager.displayRealm);
@@ -305,6 +310,7 @@ class PageUsers<S extends AppStateKeyed> extends Page<S> {
this._realmRoles = realmRoleResponse.data.sort(Util.sortByString(role => role.name));
this._users = usersResponse.data.filter(user => !user.serviceAccount).sort(Util.sortByString(u => u.username));
this._serviceUsers = usersResponse.data.filter(user => user.serviceAccount).sort(Util.sortByString(u => u.username));
+ this._loading = false;
}
private async _createUpdateUser(user: UserModel) {
@@ -420,7 +426,7 @@ class PageUsers<S extends AppStateKeyed> extends Page<S> {
<div class="panel">
<p class="panel-title">${i18next.t("regularUser_plural")}</p>
<div id="table-users" class="mdc-data-table">
- <table class="mdc-data-table__table" aria-label="attribute list">
+ <table class="mdc-data-table__table" aria-label="user list">
<thead>
<tr class="mdc-data-table__header-row">
<th class="mdc-data-table__header-cell" role="columnheader" scope="col">
@@ -458,7 +464,7 @@ class PageUsers<S extends AppStateKeyed> extends Page<S> {
<div class="panel">
<p class="panel-title">${i18next.t("serviceUser_plural")}</p>
<div id="table-users" class="mdc-data-table">
- <table class="mdc-data-table__table" aria-label="attribute list">
+ <table class="mdc-data-table__table" aria-label="user list">
<thead>
<tr class="mdc-data-table__header-row">
<th class="mdc-data-table__header-cell" role="columnheader" scope="col">