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
Added ability to configure identity client roles by client name and removed account client roles for demo users relates to #192
Rich Turner57c354c14b0d
diff --git a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java b/manager/src/main/java/org/openremote/manager/event/ClientEventService.javaindex 79cb9f27e..43854c2d1 100644--- a/manager/src/main/java/org/openremote/manager/event/ClientEventService.java+++ b/manager/src/main/java/org/openremote/manager/event/ClientEventService.java@@ -35,6 +35,7 @@ import org.openremote.manager.security.ManagerKeycloakIdentityProvider;import org.openremote.manager.web.ManagerWebService;import org.openremote.model.Constants;import org.openremote.model.event.shared.*;+import org.openremote.model.security.ClientRole;import org.openremote.model.security.User;import org.openremote.model.syslog.SyslogEvent;import org.openremote.model.util.TextUtil;@@ -50,6 +51,8 @@ import java.util.logging.Logger;import static org.apache.camel.builder.PredicateBuilder.or;import static org.openremote.container.web.ConnectionConstants.SESSION;import static org.openremote.agent.protocol.ProtocolClientEventService.getSessionKey;+import static org.openremote.model.Constants.KEYCLOAK_CLIENT_ID;+/*** Receives and publishes messages, handles the client/server event bus.* <p>@@ -350,7 +353,7 @@ public class ClientEventService implements ProtocolClientEventService {User serviceUser = keycloakIdentityProvider.getClientServiceUser(clientCredentials.getRealm(), clientCredentials.getClientId());if (clientCredentials.getRoles() != null && clientCredentials.getRoles().length > 0) {- keycloakIdentityProvider.updateRoles(clientCredentials.getRealm(), serviceUser.getId(), clientCredentials.getRoles());+ keycloakIdentityProvider.updateRoles(clientCredentials.getRealm(), serviceUser.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(clientCredentials.getRoles()).map(ClientRole::getValue).toArray(String[]::new));}}diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.javaindex ce161f651..22c640128 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerBasicIdentityProvider.java@@ -171,7 +171,7 @@ public class ManagerBasicIdentityProvider extends BasicIdentityProvider implemen}@Override- public void updateRoles(String realm, String username, ClientRole[] roles) {+ public void updateRoles(String realm, String username, String client, String... roles) {throw new UnsupportedOperationException("This provider does not support updating roles");}diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.javaindex c9b779ff1..fff272e90 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityProvider.java@@ -61,7 +61,7 @@ public interface ManagerIdentityProvider extends IdentityProvider {Role[] getRoles(String realm, String userId);- void updateRoles(String realm, String username, ClientRole[] roles);+ void updateRoles(String realm, String username, String client, String...roles);boolean isMasterRealmAdmin(String userId);diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.javaindex 1d519b68c..e7f1b6dc8 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerKeycloakIdentityProvider.java@@ -240,7 +240,7 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im}@Override- public void updateRoles(String realm, String userId, ClientRole[] roles) {+ public void updateRoles(String realm, String userId, String client, String... roles) {RealmResource realmResource = getRealms().realm(realm);UserRepresentation user = realmResource.users().get(userId).toRepresentation();@@ -249,28 +249,28 @@ public class ManagerKeycloakIdentityProvider extends KeycloakIdentityProvider im}RoleMappingResource roleMappingResource = realmResource.users().get(user.getId()).roles();- ClientRepresentation client = getClient(realm, KEYCLOAK_CLIENT_ID);+ ClientRepresentation clientRepresentation = getClient(realm, client);// Get all role mappings for user on this client and remove any no longer in the roles- List<RoleRepresentation> clientMappedRoles = roleMappingResource.clientLevel(client.getId()).listAll();- List<RoleRepresentation> availableRoles = roleMappingResource.clientLevel(client.getId()).listAvailable();+ List<RoleRepresentation> clientMappedRoles = roleMappingResource.clientLevel(clientRepresentation.getId()).listAll();+ List<RoleRepresentation> availableRoles = roleMappingResource.clientLevel(clientRepresentation.getId()).listAvailable();// Get newly defined rolesList<RoleRepresentation> addRoles = roles == null ? Collections.emptyList() : Arrays.stream(roles)- .filter(cr -> clientMappedRoles.stream().noneMatch(r -> r.getName().equals(cr.getValue())))- .map(cr -> availableRoles.stream().filter(r -> r.getName().equals(cr.getValue())).findFirst().orElse(null))+ .filter(cr -> clientMappedRoles.stream().noneMatch(r -> r.getName().equals(cr)))+ .map(cr -> availableRoles.stream().filter(r -> r.getName().equals(cr)).findFirst().orElse(null)).collect(Collectors.toList());// Remove obsolete rolesList<RoleRepresentation> removeRoles = roles == null ? clientMappedRoles : clientMappedRoles.stream()- .filter(r -> Arrays.stream(roles).noneMatch(cr -> cr.getValue().equals(r.getName())))+ .filter(r -> Arrays.stream(roles).noneMatch(cr -> cr.equals(r.getName()))).collect(Collectors.toList());if (!removeRoles.isEmpty()) {- roleMappingResource.clientLevel(client.getId()).remove(removeRoles);+ roleMappingResource.clientLevel(clientRepresentation.getId()).remove(removeRoles);}if (!addRoles.isEmpty()) {- roleMappingResource.clientLevel(client.getId()).add(addRoles);+ roleMappingResource.clientLevel(clientRepresentation.getId()).add(addRoles);}}diff --git a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.javaindex 8263e4037..17406b0cf 100644--- a/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/security/UserResourceImpl.java@@ -36,6 +36,7 @@ import javax.ws.rs.core.Response;import java.util.*;import static javax.ws.rs.core.Response.Status.BAD_REQUEST;+import static org.openremote.model.Constants.KEYCLOAK_CLIENT_ID;import static org.openremote.model.Constants.MASTER_REALM;import static org.openremote.model.http.BadRequestError.VIOLATION_EXCEPTION_HEADER;@@ -208,11 +209,11 @@ public class UserResourceImpl extends ManagerWebResource implements UserResourceidentityService.getIdentityProvider().updateRoles(realm,userId,+ KEYCLOAK_CLIENT_ID,Arrays.stream(roles).filter(Role::isAssigned)- .map(r -> Arrays.stream(ClientRole.values()).filter(cr -> cr.getValue().equals(r.getName())).findFirst().orElse(null))- .toArray(ClientRole[]::new)- );+ .map(Role::getName)+ .toArray(String[]::new));} catch (ClientErrorException ex) {ex.printStackTrace(System.out);throw new WebApplicationException(ex.getCause(), ex.getResponse().getStatus());diff --git a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.javaindex d4a105fc6..ea49a3f15 100644--- a/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/AbstractKeycloakSetup.java@@ -26,6 +26,10 @@ import org.openremote.model.security.ClientRole;import org.openremote.model.security.Tenant;import org.openremote.model.security.User;+import java.util.Arrays;++import static org.openremote.model.Constants.KEYCLOAK_CLIENT_ID;+public abstract class AbstractKeycloakSetup implements Setup {public static final String SETUP_EMAIL_FROM_KEYCLOAK = "SETUP_EMAIL_FROM_KEYCLOAK";@@ -86,7 +90,7 @@ public abstract class AbstractKeycloakSetup implements Setup {return null;}if (roles != null && roles.length > 0) {- keycloakProvider.updateRoles(realm, user.getId(), roles);+ keycloakProvider.updateRoles(realm, user.getId(), KEYCLOAK_CLIENT_ID, Arrays.stream(roles).map(ClientRole::getValue).toArray(String[]::new));}return user;}diff --git a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.java b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.javaindex 1ccb786d7..e8ee12786 100644--- a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakDemoSetup.java@@ -31,6 +31,7 @@ import org.openremote.model.security.User;import java.util.logging.Logger;+import static org.openremote.model.Constants.KEYCLOAK_CLIENT_ID;import static org.openremote.model.Constants.MASTER_REALM;/**@@ -74,18 +75,23 @@ public class KeycloakDemoSetup extends AbstractKeycloakSetup {// UsersUser testuser1 = createUser(MASTER_REALM, "testuser1", "testuser1", "DemoMaster", "DemoLast", null, true, REGULAR_USER_ROLES);this.testuser1Id = testuser1.getId();+ keycloakProvider.updateRoles(MASTER_REALM, testuser1Id, "account"); // Remove all roles for account clientUser testuser2 = createUser(tenantBuilding.getRealm(), "testuser2", "testuser2", "DemoA2", "DemoLast", "[email protected]", true, new ClientRole[] {ClientRole.WRITE_USER,ClientRole.READ_MAP,ClientRole.READ_ASSETS});this.testuser2Id = testuser2.getId();+ keycloakProvider.updateRoles(tenantBuilding.getRealm(), testuser2Id, "account"); // Remove all roles for account clientUser testuser3 = createUser(tenantBuilding.getRealm(), "testuser3", "testuser3", "DemoA3", "DemoLast", "[email protected]", true, REGULAR_USER_ROLES);this.testuser3Id = testuser3.getId();+ keycloakProvider.updateRoles(tenantBuilding.getRealm(), testuser3Id, "account"); // Remove all roles for account clientUser buildingUser = createUser(tenantBuilding.getRealm(), "building", "building", "Building", "User", "[email protected]", true, REGULAR_USER_ROLES);this.buildingUserId = buildingUser.getId();+ keycloakProvider.updateRoles(tenantBuilding.getRealm(), buildingUserId, "account"); // Remove all roles for account clientUser smartCityUser = createUser(tenantCity.getRealm(), "smartcity", "smartcity", "Smart", "City", null, true, REGULAR_USER_ROLES);this.smartCityUserId = smartCityUser.getId();+ keycloakProvider.updateRoles(tenantCity.getRealm(), smartCityUserId, "account"); // Remove all roles for account client/** MQTT Client@@ -103,6 +109,6 @@ public class KeycloakDemoSetup extends AbstractKeycloakSetup {// Add asset RW roles to service userUser serviceUser = keycloakProvider.getClientServiceUser(tenantBuilding.getRealm(), mqttClient.getClientId());- keycloakProvider.updateRoles(tenantBuilding.getRealm(), serviceUser.getId(), new ClientRole[] {ClientRole.READ_ASSETS, ClientRole.WRITE_ASSETS});+ keycloakProvider.updateRoles(tenantBuilding.getRealm(), serviceUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ_ASSETS.getValue(), ClientRole.WRITE_ASSETS.getValue());}}diff --git a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.java b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.javaindex d344eaab9..afefa908d 100644--- a/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.java+++ b/manager/src/main/java/org/openremote/manager/setup/builtin/KeycloakInitSetup.java@@ -27,8 +27,7 @@ import org.openremote.model.security.User;import java.util.logging.Logger;-import static org.openremote.model.Constants.MASTER_REALM;-import static org.openremote.model.Constants.MASTER_REALM_ADMIN_USER;+import static org.openremote.model.Constants.*;public class KeycloakInitSetup extends AbstractKeycloakSetup {@@ -59,6 +58,6 @@ public class KeycloakInitSetup extends AbstractKeycloakSetup {keycloakProvider.updateUser(MASTER_REALM, adminUser);// Give admin all roles on application client level- keycloakProvider.updateRoles(MASTER_REALM, adminUser.getId(), new ClientRole[] {ClientRole.READ, ClientRole.WRITE});+ keycloakProvider.updateRoles(MASTER_REALM, adminUser.getId(), KEYCLOAK_CLIENT_ID, ClientRole.READ.getValue(), ClientRole.WRITE.getValue());}}diff --git a/ui/app/or-app/src/index.ts b/ui/app/or-app/src/index.tsindex ae0c728bf..3784ce103 100644--- a/ui/app/or-app/src/index.ts+++ b/ui/app/or-app/src/index.ts@@ -181,7 +181,10 @@ export function headerItemAccount<S extends AppStateKeyed, A extends AnyAction>(icon: "account",value: "account",href: "#!account",- text: "account"+ text: "account",+ roles: {+ account: ["manage-account"]+ }};}@@ -307,25 +310,6 @@ export class OrApp<S extends AppStateKeyed> extends LitElement {return;}- Object.entries(this.appConfig.pages).map(([pageName, provider]) => {- if (provider.routes) {- provider.routes.forEach((route) => {- router.on(- route, (params, query) => {- this._store.dispatch(updatePage(pageName));- this._store.dispatch(updateParams(params));- }- )- });- }- });-- if (this.appConfig.pages.default) {- router.on("*", (params, query) => {- this._store.dispatch(updatePage("default"));- })- }-const realm = getRealmQueryParameter();const config = this._getConfig(realm);@@ -344,6 +328,26 @@ export class OrApp<S extends AppStateKeyed> extends LitElement {manager.init(managerConfig).then((success) => {if (success) {this._initialised = true;++ Object.entries(this.appConfig.pages).map(([pageName, provider]) => {+ if (provider.routes) {+ provider.routes.forEach((route) => {+ router.on(+ route, (params, query) => {+ this._store.dispatch(updatePage(pageName));+ this._store.dispatch(updateParams(params));+ }+ )+ });+ }+ });++ if (this.appConfig.pages.default) {+ router.on("*", (params, query) => {+ this._store.dispatch(updatePage("default"));+ })+ }+router.resolve();} else {this.showErrorModal(manager.isError ? "managerError." + manager.error : "");diff --git a/ui/app/or-app/src/or-header.ts b/ui/app/or-app/src/or-header.tsindex 7756da519..483a19525 100644--- a/ui/app/or-app/src/or-header.ts+++ b/ui/app/or-app/src/or-header.ts@@ -13,6 +13,7 @@ import "@openremote/or-mwc-components/dist/or-mwc-dialog";import "@openremote/or-icon";import {getContentWithMenuTemplate, MenuItem} from "@openremote/or-mwc-components/dist/or-mwc-menu";import {Tenant} from "@openremote/model";+import {router} from "./index";export interface HeaderConfig {mainMenu: HeaderItem[];@@ -26,7 +27,7 @@ export interface HeaderItem {href?: string;action?: () => void;hideMobile?: boolean;- roles?: string[];+ roles?: string[] | {[client: string]: string[]};}export interface Languages {@@ -42,7 +43,7 @@ export const DEFAULT_LANGUAGES: Languages = {};function getHeaderMenuItems(items: HeaderItem[]): MenuItem[] {- return items.filter((option) => !option.roles || option.roles.some((r) => manager.hasRole(r))).map((option) => {+ return items.filter(hasRequiredRole).map((option) => {return {text: option.text,value: option.value ? option.value : "",@@ -52,6 +53,17 @@ function getHeaderMenuItems(items: HeaderItem[]): MenuItem[] {});}+function hasRequiredRole(option: HeaderItem): boolean {+ if (!option.roles) {+ return true;+ }+ if (Array.isArray(option.roles)) {+ return option.roles.some((r) => manager.hasRole(r));+ }++ return Object.entries(option.roles).some(([client, roles]) => roles.some((r) => manager.hasRole(r, client)));+}+@customElement("or-header")class OrHeader extends LitElement {@@ -333,7 +345,7 @@ class OrHeader extends LitElement {<!-- This gets hidden on a small screen--><nav id="toolbar-list"><div id="desktop-left">- ${mainItems ? mainItems.filter((option) => !option.roles || option.roles.some((r) => manager.hasRole(r))).map((headerItem) => {+ ${mainItems ? mainItems.filter(hasRequiredRole).map((headerItem) => {return html`<a class="menu-item" href="${headerItem.href}" @click="${(e: MouseEvent) => this._onHeaderItemSelect(headerItem)}" ?selected="${this.activeMenu === headerItem.href}"><or-icon icon="${headerItem.icon}"></or-icon><or-translate value="${headerItem.text}"></or-translate></a>`;@@ -358,7 +370,7 @@ class OrHeader extends LitElement {<div><div id="mobile-top"><nav id="drawer-list">- ${mainItems ? mainItems.filter((option) => !option.hideMobile && (!option.roles || option.roles.some((r) => manager.hasRole(r)))).map((headerItem) => {+ ${mainItems ? mainItems.filter((option) => !option.hideMobile && hasRequiredRole(option)).map((headerItem) => {return html`<a class="menu-item" href="${headerItem.href}" @click="${(e: MouseEvent) => this._onHeaderItemSelect(headerItem)}" ?selected="${this.activeMenu === headerItem.href}"><or-icon icon="${headerItem.icon}"></or-icon><or-translate value="${headerItem.text}"></or-translate></a>`;@@ -368,7 +380,7 @@ class OrHeader extends LitElement {${secondaryItems ? html`<div id="mobile-bottom">- ${secondaryItems.filter((option) => !option.hideMobile && (!option.roles || option.roles.some((r) => manager.hasRole(r)))).map((headerItem) => {+ ${secondaryItems.filter((option) => !option.hideMobile && hasRequiredRole(option)).map((headerItem) => {return html`<a class="menu-item" href="${ifDefined(headerItem.href)}" @click="${(e: MouseEvent) => this._onHeaderItemSelect(headerItem)}" ?selected="${this.activeMenu === headerItem.href}"><or-icon icon="${headerItem.icon}"></or-icon><or-translate value="${headerItem.text}"></or-translate></a>`;diff --git a/ui/app/or-app/src/pages/page-account.ts b/ui/app/or-app/src/pages/page-account.tsindex 083259035..8feb71ab5 100644--- a/ui/app/or-app/src/pages/page-account.ts+++ b/ui/app/or-app/src/pages/page-account.ts@@ -23,7 +23,8 @@ class PageAccount<S extends AppStateKeyed> extends Page<S> {// language=CSSreturn css`iframe {- width: 100%;+ width: 100%;+ border: none;}`;}diff --git a/ui/component/core/src/index.ts b/ui/component/core/src/index.tsindex 9450c5465..e554db502 100644--- a/ui/component/core/src/index.ts+++ b/ui/component/core/src/index.ts@@ -374,22 +374,23 @@ export class Manager implements EventProviderFactory {return this._config;}- get roles(): string[] {+ get roles(): Map<string, string[]> {+ const roleMap = new Map<string, string[]>();+if (this._keycloak) {if (this._keycloak.resourceAccess) {- let roles: string[];- if (this._config.clientId && this._keycloak!.resourceAccess.hasOwnProperty(this._config.clientId)) {- roles = this._keycloak!.resourceAccess[this._config.clientId].roles;- } else {- roles = this._keycloak!.resourceAccess.account.roles;+ if (this._config.clientId && this._keycloak!.resourceAccess) {+ Object.entries(this._keycloak!.resourceAccess).forEach(([client, resourceObj]) => {+ const roles = (resourceObj as any).roles as string[];+ roleMap.set(client, roles);+ })}- return roles || [];}} else if (this._basicIdentity && this._basicIdentity.roles) {- return this._basicIdentity.roles.map((r) => r.name!);+ roleMap.set(this._config.clientId!, this._basicIdentity.roles.map((r) => r.name!));}- return [];+ return roleMap;}get managerVersion() {@@ -963,8 +964,9 @@ export class Manager implements EventProviderFactory {return this._keycloak && this._keycloak.hasRealmRole(role);}- public hasRole(role: string) {- return this.roles && this.roles.indexOf(role) >= 0;+ public hasRole(role: string, client: string = this._config.clientId!) {+ const roles = this.roles;+ return roles && roles.has(client) && roles.get(client)!.indexOf(role) >= 0;}public getAuthorizationHeader(): string | undefined {